Polish the counter UI a bit and add some to the documentation.

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

diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index cc33d3d1fc7df0a7a50a694fb112af2e96712426..ca92802ba4643ad7b3b8a012e5762183681f2537 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/
-\lyxformat 592
+\lyxformat 594
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -54,7 +54,7 @@ customHeadersFooters
 enumitem
 logicalmkup
 \end_modules
-\maintain_unincluded_children false
+\maintain_unincluded_children no
 \language english
 \language_package default
 \inputencoding utf8
@@ -156,6 +156,7 @@ logicalmkup
 \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 1675569489 "Stephan Witt"
@@ -29857,6 +29858,116 @@ to the field
 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 1588374084
+).
+ 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 Standard
+
+\change_inserted -584632292 1588374095
+There are six commands you can use:
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374116
+Set Counter: Allows you to assign a specific value to a counter
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374135
+Add to Counter: Allows you to add some specified amount to a counter (or
+ to subtract, if you choose a negative number)
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374149
+Reset to 0: Sets the value of the counter to 0.
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374169
+Save Value of Counter: Saves the value of the counter so that it can later
+ be restored.
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374185
+Restore Value of Counter: Restores the previously saved value.
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -584632292 1588374203
+Display Value of Counter: Shows the value of the counter (in the output).
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -584632292 1588374230
+The dialog allows you to choose which counter you wish to modify from all
+ those that are available in the current document class.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section