From 520dde2038c27f71bdc5c4a70e43237986200de4 Mon Sep 17 00:00:00 2001
From: Georg Baum <baum@lyx.org>
Date: Wed, 11 Nov 2015 23:03:18 +0100
Subject: [PATCH] Better documentation of compressed (bug 9189)

The compressed/uncompressed option of LyX files was poorly documented. Now it
is a bit better.
---
 lib/doc/Additional.lyx | 24 +++++++++++++++++++--
 lib/doc/UserGuide.lyx  | 48 +++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 69 insertions(+), 3 deletions(-)

diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx
index bc45c7b720..2943caa695 100644
--- a/lib/doc/Additional.lyx
+++ b/lib/doc/Additional.lyx
@@ -137,8 +137,9 @@ End
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
-\author -712698321 "Jürgen Spitzmüller"
-\author 711066561 "Enrico Forestieri"
+\author -712698321 "Jürgen Spitzmüller" 
+\author -195340706 "Georg Baum" 
+\author 711066561 "Enrico Forestieri" 
 \end_header
 
 \begin_body
@@ -20049,6 +20050,25 @@ Control
 For introducing your own external commands consult vc-command in the manual
  of \SpecialChar LyX
  functions.
+\change_inserted -195340706 1447278952
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -195340706 1447279250
+It is strongly recommended to store documents in uncompressed format if
+ using version control (uncheck 
+\family sans
+Document\SpecialChar menuseparator
+Compressed
+\family default
+ if it is checked): Uncompressed LyX documents are text files and therefore
+ for merging two different versions by version control systems.
+ Compressed LyX documents are binary files, which cannot be merged by version
+ control systems.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index 8a67449975..787bd3beee 100644
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -141,11 +141,12 @@ enumitem
 \papercolumns 1
 \papersides 2
 \paperpagestyle default
-\tracking_changes false
+\tracking_changes true
 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
+\author -195340706 "Georg Baum" 
 \end_header
 
 \begin_body
@@ -8170,12 +8171,14 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim
+
 This is verbatim.
 \end_layout
 
 \begin_layout Verbatim
 \noindent
 \align block
+
 The following 2 lines are empty:
 \end_layout
 
@@ -8188,6 +8191,7 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
+
 Almost everything is allowed in verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -37641,10 +37645,34 @@ reference "sec:File-Formats"
 
 \begin_layout Subsection
 Compressed
+\change_inserted -195340706 1447278411
+
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Compressed"
+
+\end_inset
+
+
+\change_unchanged
+
 \end_layout
 
 \begin_layout Standard
 Un/compresses the current document.
+
+\change_inserted -195340706 1447279328
+ Use this if you want to save a compressed document in uncompressed format
+ or vice versa.
+ For documents under version control it is strongly recommended to disable
+ compression (see 
+\emph on
+Additional \SpecialChar LyX
+ Features
+\emph default
+ for details).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -43058,6 +43086,24 @@ Backup documents, every
 Save documents compressed by default
 \family default
  always saves files in a compressed format.
+
+\change_inserted -195340706 1447278517
+ This applies to newly created documents only.
+ The compression status of existing documents is not changed when saving
+ (see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Compressed"
+
+\end_inset
+
+).
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsubsection
-- 
2.39.2