]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
Minor corrections and elaborations
[lyx.git] / lib / doc / UserGuide.lyx
index 42db4c0f8696984cb2a102d31fdd635ba39e9a05..0def2b07faa14238b2ab3e70225c98e5066a4d8f 100644 (file)
@@ -1097,7 +1097,7 @@ Safety Nets:
 
 \begin_layout Standard
 
 
 \begin_layout Standard
 
-\change_inserted -712698321 1676623839
+\change_inserted -712698321 1676623979
 \SpecialChar LyX
  lays much stress on safety.
  We know how much effort you invest in your work,
 \SpecialChar LyX
  lays much stress on safety.
  We know how much effort you invest in your work,
@@ -1107,7 +1107,7 @@ Safety Nets:
  \SpecialChar LyX
  might crash (although we put in all effort that it doesn't),
  you might face a power outage while you are working on a document with unsaved changes,
  \SpecialChar LyX
  might crash (although we put in all effort that it doesn't),
  you might face a power outage while you are working on a document with unsaved changes,
- disks might get corrupt or files might get lost or damaged during synchronization.
+ disks might get corrupt or files might get lost or damaged during synchronization or simply because you deleted it by mistake.
  For such cases,
  \SpecialChar LyX
  provides a multi-layered safety net that will hopefully prevent you from major hassles.
  For such cases,
  \SpecialChar LyX
  provides a multi-layered safety net that will hopefully prevent you from major hassles.
@@ -1128,6 +1128,339 @@ reference "subsec:Backup documents"
 
 ),
  but all measures are on by default to provide you with most possible security.
 
 ),
  but all measures are on by default to provide you with most possible security.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676624009
+In what follows,
+ we elaborate on the diverse files and when they might become useful.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1676624109
+Backup Files
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676629660
+By default,
+ \SpecialChar LyX
+ makes backup copies of files when they are saved.
+ Normally,
+ these files are stored in the same directory than the original file and with the same file name but the extension 
+\family typewriter
+.lyx~
+\family default
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\family typewriter
+myfile.lyx~
+\family default
+).
+ If you prefer to have all backups in a central place (and maybe on a separate disk),
+ you can specify a 
+\family sans
+Backup Path
+\family default
+ in preferences (see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Paths"
+plural "false"
+caps "false"
+noprefix "false"
+nolink "false"
+
+\end_inset
+
+),
+ then all backups are stored there.
+ In order to prevent file name clashes,
+ the files then do not simply have the original file name,
+ but also the path in their name,
+ separated by 
+\begin_inset Quotes eld
+\end_inset
+
+!
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\family typewriter
+!home!paula!work!myfile.lyx~
+\family default
+).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676624464
+Note that some file managers hide backup files by default,
+ and you need to enable 
+\begin_inset Quotes eld
+\end_inset
+
+Show hidden files
+\begin_inset Quotes erd
+\end_inset
+
+ in order to see them.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676624516
+Backup files provide the latest saved version of a document.
+ They are never deleted by \SpecialChar LyX
+,
+ but overwritten if new changes are saved in the original file.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1676633415
+Auto-Save Snapshots
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676624657
+By default,
+ \SpecialChar LyX
+ also makes automatic snapshots of all opened documents that have unsaved changes in a regular time interval (which can be adjusted in preferences,
+ see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Backup documents"
+
+\end_inset
+
+).
+ As opposed to the backup files,
+ these also contain unsaved changes and thus might be newer than the backups.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676624841
+These files are always stored in the same directory than the original file and with the same name,
+ but embraced by 
+\begin_inset Quotes eld
+\end_inset
+
+#
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\family typewriter
+#myfile.lyx#
+\family default
+).
+ Auto-save snapshots are deleted when a document is closed normally,
+ i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.,
+ with all changes saved.
+ They are left on disk in case of non-normal termination (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+ program crash or power outage),
+ and this is when they might become useful.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1676633419
+Emergency Files
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676629567
+If \SpecialChar LyX
+ crashes and documents have unsaved changes,
+ the program furthermore tries to write an emergency file,
+ which is a version of the document containing all unsaved changes,
+ even those that have been made after the latest snapshot.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676625158
+These files are always stored in the same directory than the original file and with the same name but the extension 
+\family typewriter
+.lyx.emergency
+\family default
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\family typewriter
+myfile.lyx.emergency
+\family default
+).
+ When the respective document is reopened with \SpecialChar LyX
+ next time,
+ the application recognizes the emergency file and asks you whether it should try to recover your file to that last state.
+ If you agree,
+ it will do so,
+ and if this succeeds it will ask you next whether the emergency file can be deleted.
+ Agree on this only after you checked that everything has been correctly recovered!
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1676633427
+Backup Files from Old \SpecialChar LyX
+ Versions
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676625452
+If you open a \SpecialChar LyX
+ document for the first time with a new major version of \SpecialChar LyX
+,
+ it gets converted to the new file format (allowing for new features).
+ In such cases,
+ \SpecialChar LyX
+ keeps a copy of the old version,
+ named as 
+\family typewriter
+<filename>-lyxformat-<n>.lyx
+\family default
+,
+ where <n> is the old format (e.
+\begin_inset space ~
+\end_inset
+
+g.,
+\family typewriter
+myfile-lyxformat-474.lyx
+\family default
+).
+ Those files are stored at the same location than the backup files,
+ that is alongside the original document or,
+ if specified,
+ in the backup directory.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676625483
+As with backup files,
+ these files are never deleted by \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted -712698321 1676625510
+When to Use Which File?
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676625539
+Now why all these files?
+ Because they have different purposes.
+ Generally spoken:
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676625820
+If \SpecialChar LyX
+ terminates unexpectedly,
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -712698321 1676625790
+first try to restore from the emergency file (by reopening the document in \SpecialChar LyX
+).
+ This file has the latest changes,
+ even changes you made after the last auto-save snapshot has been made.
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -712698321 1676634256
+If the rescue file way did not work because there is no rescue file (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+ after a power outage) or the rescue file is damaged (it might happen in mean cases that the rescue files contains just that latest addition that makes \SpecialChar LyX
+ crash!),
+ look if there is an auto-save snapshot.
+ If so,
+ remove the trailing # so that the file can be opened with \SpecialChar LyX
+ (not the first # in order to keep the original file until you checked the snapshot) and see if that works for you.
+ If so,
+ you will have lost five minutes of work in the worst case (with the default settings at least).
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -712698321 1676626178
+If there is no auto-save snapshot or this one is garbled as well,
+ use the backup file.
+ It does not have all the unsaved changes,
+ but it might still be the most recent you can get.
+ This is particularly the case if the original file itself got lost or is damaged.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676626301
+The fourth type of file,
+ the backup file from old versions,
+ is useful if the conversion process did not work and results in a non-working document (although we put in all efforts to prevent this) or if you mistakenly opened and saved a document with a newer version (such as a development version) and actually want to keep on using the old version.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1676629641
+So much for the safety net.
+ We hope you will not need it,
+ but if so,
+ that it catches you as high up as possible.
+ Now let us return to the actual writing process.
 \change_unchanged
 
 \end_layout
 \change_unchanged
 
 \end_layout
@@ -9889,14 +10222,12 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim
 \end_layout
 
 \begin_layout Verbatim
-
 This is Verbatim.
 \end_layout
 
 \begin_layout Verbatim
 \noindent
 \align block
 This is Verbatim.
 \end_layout
 
 \begin_layout Verbatim
 \noindent
 \align block
-
 The following 2 lines are empty:
 \end_layout
 
 The following 2 lines are empty:
 \end_layout
 
@@ -9909,7 +10240,6 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
 \end_layout
 
 \begin_layout Verbatim
-
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -9933,7 +10263,6 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
 \end_layout
 
 \begin_layout Verbatim*
-
 This is Verbatim*.
 \end_layout
 
 This is Verbatim*.
 \end_layout
 
@@ -36468,7 +36797,82 @@ localfile
 \change_inserted -712698321 1598526494
 In addition to that,
  \SpecialChar LyX
 \change_inserted -712698321 1598526494
 In addition to that,
  \SpecialChar LyX
- also searches your disk for matching files if you enable 
+ also searches
+\change_inserted 5863208 1676821714
+
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1676822207
+By default we provide python script 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1676822064
+lyxpaperview.py
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ for the search,
+ but you can use any modified script by setting 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1676822135
+
+\backslash
+citation_search_view
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ variable in 
+\change_deleted -712698321 1676971997
+your RC
+\change_inserted -712698321 1676971998
+the
+\change_inserted 5863208 1676822207
+ file
+\change_inserted -712698321 1676972080
+\family typewriter
+preferences
+\family default
+ in your local configuration directory (please refer to the respective section at 
+\family sans
+Help\SpecialChar menuseparator
+Customization
+\family default
+)
+\change_inserted 5863208 1676822207
+.
+
+\change_inserted -712698321 1676972139
+ The default setting is to be found in the file 
+\family typewriter
+lyxrc.defaults
+\family default
+ in the same directory and can be copied and modified for this purpose.
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted -712698321 1598526494
+ your disk for matching files if you enable 
 \family sans
 Search drive for cited files
 \family default
 \family sans
 Search drive for cited files
 \family default
@@ -36486,7 +36890,78 @@ Control
 Pattern
 \family default
  in the same preferences section (by default:
 Pattern
 \family default
  in the same preferences section (by default:
- year and authors).
+ year and authors
+\change_inserted 5863208 1676968851
+
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1676969379
+Provided by token
+\change_inserted -712698321 1676972365
+ sequence
+\change_deleted -712698321 1676972365
+s
+\change_inserted 5863208 1676969379
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1676968931
+%year% %abbrvciteauthor%
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ Note that some 
+\change_deleted -712698321 1676972344
+strings
+\change_inserted -712698321 1676972349
+constituents
+\change_inserted 5863208 1676969379
+ (
+\begin_inset Quotes eld
+\end_inset
+
+and
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+
+\change_inserted -712698321 1676972338
+,
+ commas)
+\change_inserted 5863208 1676969379
+ are automatically stripped from the result.
+\change_deleted -712698321 1676972332
+)
+\change_inserted 5863208 1676969379
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted -712698321 1598526494
+).
  Any of the tokens in the pattern must occur in the 
 \change_deleted 630872221 1621608311
 title
  Any of the tokens in the pattern must occur in the 
 \change_deleted 630872221 1621608311
 title