Documentation for counter inset.

[features.git] / lib / doc / UserGuide.lyx

diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index b61eb30c3e0910e2d5a0e247dcfcd6dbfc9ecabb..210801622fa8fa30c7e7d9a1d0e13640d81bbe5d 100644 (file)
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
 #LyX 2.4 created this file. For more info see https://www.lyx.org/

-\lyxformat 583
+\lyxformat 594

 \begin_document
 \begin_header
 \save_transient_properties true
 \begin_document
 \begin_header
 \save_transient_properties true


@@ -54,7 +54,7 @@ customHeadersFooters
 enumitem
 logicalmkup
 \end_modules
 enumitem
 logicalmkup
 \end_modules

-\maintain_unincluded_children false
+\maintain_unincluded_children no

 \language english
 \language_package default
 \inputencoding utf8
 \language english
 \language_package default
 \inputencoding utf8


@@ -147,15 +147,19 @@ logicalmkup
 \papersides 2
 \paperpagestyle default
 \tablestyle default
 \papersides 2
 \paperpagestyle default
 \tablestyle default

-\tracking_changes true
+\tracking_changes false

 \output_changes false
 \output_changes false

+\change_bars false
+\postpone_fragile_content false

 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
 \author -1402925745 "Günter Milde"
 \author -712698321 "Jürgen Spitzmüller"
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
 \author -1402925745 "Günter Milde"
 \author -712698321 "Jürgen Spitzmüller"

+\author -584632292 "Richard Kimberly Heck"

 \author -563046850 "Jean-Marc LASGOUTTES"
 \author 5863208 "ab"
 \author -563046850 "Jean-Marc LASGOUTTES"
 \author 5863208 "ab"

+\author 1675569489 "Stephan Witt"

 \end_header
 
 \begin_body
 \end_header
 
 \begin_body


@@ -8483,14 +8487,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
 


@@ -8503,7 +8505,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
 }][{|


@@ -8527,7 +8528,6 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
 \end_layout
 
 \begin_layout Verbatim*

-

 This is Verbatim*.
 \end_layout
 
 This is Verbatim*.
 \end_layout
 


@@ -18231,7 +18231,27 @@ Line breaks after unspaced dashes can be allowed via the menu
 \family sans
 Insert\SpecialChar menuseparator
 Formatting\SpecialChar menuseparator
 \family sans
 Insert\SpecialChar menuseparator
 Formatting\SpecialChar menuseparator

-Optional line break
+Optional
+\change_deleted 1675569489 1580913043
+ 
+\change_inserted 1675569489 1580913043
+
+\begin_inset space ~
+\end_inset
+
+
+\change_unchanged
+line
+\change_deleted 1675569489 1580913068
+ 
+\change_inserted 1675569489 1580913068
+
+\begin_inset space ~
+\end_inset
+
+
+\change_unchanged
+break

 \family default
 :
 \end_layout
 \family default
 :
 \end_layout


@@ -29838,6 +29858,63 @@ to the field
 Additional options
 \family default
  in the PDF Properties dialog.
 Additional options
 \family default
  in the PDF Properties dialog.

+\change_inserted -584632292 1588303457
+
+\end_layout
+
+\begin_layout Section
+
+\change_inserted -584632292 1588303474
+Counters
+\begin_inset Index idx
+status open
+
+\begin_layout Plain Layout
+Counters
+\end_layout
+
+\end_inset
+
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1588304632
+One powerful feature of \SpecialChar LaTeX
+ is its ability to manage counters, like the one
+ for this section (
+\change_unchanged
+
+\begin_inset CommandInset counter
+LatexCommand value
+counter "section"
+value "0"
+vtype "arabic"
+lyxonly "false"
+
+\end_inset
+
+
+\change_inserted -584632292 1588304519
+).
+ Mostly, this is handled automatically, but there are times one wants to
+ modify counters directly.
+ This can be done in LyX using the counter inset, which is accessible from
+ the Insert menu.
+ This allows one to set a counter's value; to reset it (to zero); to add
+ to the value (or subtract from it, since the value added can be negative);
+ to save it; to restore the saved value; and to print the value.
+ These effects can also be limited to LyX itself.
+ And they will appear in HTML and DocBook output, as well as in LaTeX.
+ 

 \end_layout
 
 \begin_layout Section
 \end_layout
 
 \begin_layout Section


@@ -38204,6 +38281,8 @@ The toolbar has two buttons to handle notes because notes are often important
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

+
+\change_deleted -712698321 1577206802

 To show the changes made in the output you need the \SpecialChar LaTeX
  package 
 \series bold
 To show the changes made in the output you need the \SpecialChar LaTeX
  package 
 \series bold


@@ -38232,6 +38311,8 @@ literal "true"
 
  or in the package manager of your \SpecialChar LaTeX
 -system.
 
  or in the package manager of your \SpecialChar LaTeX
 -system.

+\change_unchanged
+

 \end_layout
 
 \begin_layout Section
 \end_layout
 
 \begin_layout Section


@@ -43804,7 +43885,7 @@ Default
 \family sans
 \begin_inset Info
 type  "icon"
 \family sans
 \begin_inset Info
 type  "icon"

-arg   "layout Enumerate"
+arg   "layout-toggle Enumerate"

 \end_inset
 
 
 \end_inset
 
 


@@ -43831,7 +43912,7 @@ Numbered list
 \family sans
 \begin_inset Info
 type  "icon"
 \family sans
 \begin_inset Info
 type  "icon"

-arg   "layout Itemize"
+arg   "layout-toggle Itemize"

 \end_inset
 
 
 \end_inset
 
 


@@ -43858,7 +43939,7 @@ Itemized list
 \family sans
 \begin_inset Info
 type  "icon"
 \family sans
 \begin_inset Info
 type  "icon"

-arg   "layout List"
+arg   "layout-toggle List"

 \end_inset
 
 
 \end_inset
 
 


@@ -43885,7 +43966,7 @@ List
 \family sans
 \begin_inset Info
 type  "icon"
 \family sans
 \begin_inset Info
 type  "icon"

-arg   "layout Description"
+arg   "layout-toggle Description"

 \end_inset
 
 
 \end_inset
 
 


@@ -46862,6 +46943,42 @@ Objects
  manual.
 \end_layout
 
  manual.
 \end_layout
 

+\begin_layout Section
+
+\change_inserted -712698321 1577206827
+Change Tracking
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1577206929
+Here you can do some settings related to change tracking (see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Change-Tracking"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
+ Alternatively to the menu or toolbar, you can set here whether changes
+ are being tracked and whether they are shown in the output.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1577207214
+Additionally, you can advise LyX to place a change bar in the margin of
+ the output.
+ This might be useful to make changed passages more salient.
+\end_layout
+

 \begin_layout Section
 Numbering & TOC
 \end_layout
 \begin_layout Section
 Numbering & TOC
 \end_layout


@@ -47684,25 +47801,105 @@ reference "sec:File-Formats"
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

+
+\change_inserted -712698321 1578647276
+Allow
+\begin_inset space ~
+\end_inset
+
+running
+\begin_inset space ~
+\end_inset
+
+external
+\begin_inset space ~
+\end_inset
+
+programs If this is switched on, \SpecialChar LaTeX
+ is run with the 
+\family typewriter
+-shell-escape
+\family default
+ option which is needed with some packages.
+ Note that this comes with security risks, so please use this only when
+ really necessary and if you know what you are doing.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1578647006
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Output
+\begin_inset space ~
+\end_inset
+
+Options offers settings for the 
+\family sans
+LaTeX
+\family default
+ export.
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\family sans

 Synchronize
 Synchronize

+\change_inserted -712698321 1578646679
+ 
+\change_deleted -712698321 1578646679
+

 \begin_inset space ~
 \end_inset
 
 \begin_inset space ~
 \end_inset
 

+
+\change_unchanged

 with
 with

+\change_deleted -712698321 1578646686
+

 \begin_inset space ~
 \end_inset
 
 \begin_inset space ~
 \end_inset
 

-Output settings for the menu 
+
+\change_inserted -712698321 1578646686
+ 
+\change_unchanged
+Output
+\family default
+ 
+\change_inserted -712698321 1578646719
+enables 
+\change_deleted -712698321 1578646729
+settings for the menu 

 \family sans
 Navigate\SpecialChar menuseparator
 \family sans
 Navigate\SpecialChar menuseparator

+
+\change_unchanged

 Forward
 \begin_inset space ~
 \end_inset
 
 search
 Forward
 \begin_inset space ~
 \end_inset
 
 search

+\change_inserted -712698321 1578646752
+

 \family default
 \family default

+ and allows to customize the macro used in this process
+\change_deleted -712698321 1578646757

 .
 .

- For a detailed description see section 
+
+\change_unchanged
+ 
+\change_inserted -712698321 1578646759
+(
+\change_deleted -712698321 1578646759
+F
+\change_inserted -712698321 1578646759
+f
+\change_unchanged
+or a detailed description see section 

 \emph on
 Reverse DVI/PDF search
 \emph default
 \emph on
 Reverse DVI/PDF search
 \emph default


@@ -47714,9 +47911,55 @@ Additional
 
 Features
 \emph default
 
 Features
 \emph default

- manual.
+ manual
+\change_inserted -712698321 1578646762
+)
+\change_unchanged
+.
+\change_inserted -712698321 1578647009
+

 \end_layout
 
 \end_layout
 

+\begin_layout Itemize
+
+\change_inserted -712698321 1578647929
+
+\family sans
+Put fragile content out of moving arguments
+\family default
+ determines whether so-called 
+\begin_inset Quotes els
+\end_inset
+
+fragile
+\begin_inset Quotes ers
+\end_inset
+
+ \SpecialChar LaTeX
+ constructs (such as labels or index entries) are placed outside of so-called
+ 
+\begin_inset Quotes els
+\end_inset
+
+moving arguments
+\begin_inset Quotes ers
+\end_inset
+
+ in \SpecialChar LaTeX
+ (such as sections or captions), even if the corresponding insets are
+ placed in such context in \SpecialChar LyX
+.
+ This setting is on by default, since it prevents nasty \SpecialChar LaTeX
+ errors.
+ If you rely on labels or index entries being kept inside the problematic
+ macros, you can uncheck this.
+ If you don't know what we are talking about here, worry not: just leave
+ it checked.
+\change_unchanged
+
+\end_layout
+
+\end_deeper

 \begin_layout Description
 XHTML
 \begin_inset space ~
 \begin_layout Description
 XHTML
 \begin_inset space ~


@@ -48752,6 +48995,29 @@ Ctrl+arrow key
 \family default
  the cursor jumps from the end of a word to the end of the next word.
  Normally it jumps from the beginning to the beginning.
 \family default
  the cursor jumps from the end of a word to the end of the next word.
  Normally it jumps from the beginning to the beginning.

+\change_inserted -712698321 1578924606
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1578924785
+The option 
+\family sans
+Keep change tracking markup on copy and paste
+\family default
+ is for users who don't want tracked changes to be dissolved on copy and
+ paste operations (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., inserted as new text with the deletions removed).
+ If this is checked, the change-tracked text will be copied and pasted as
+ is, independent if changes are currently tracked or not.
+ This also applies to wrapping to\SpecialChar breakableslash
+dissolving from insets.
+\change_unchanged
+

 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard