]> git.lyx.org Git - features.git/blobdiff - lib/doc/UserGuide.lyx
Documentation for counter inset.
[features.git] / lib / doc / UserGuide.lyx
index 097bbfa30073167ff3d9dfb68145f2ac8aaeac54..210801622fa8fa30c7e7d9a1d0e13640d81bbe5d 100644 (file)
@@ -1,5 +1,5 @@
 #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
@@ -54,7 +54,7 @@ customHeadersFooters
 enumitem
 logicalmkup
 \end_modules
-\maintain_unincluded_children false
+\maintain_unincluded_children no
 \language english
 \language_package default
 \inputencoding utf8
@@ -77,7 +77,7 @@ logicalmkup
 \default_output_format default
 \output_sync 0
 \bibtex_command bibtex
-\index_command default
+\index_command makeindex
 \float_placement class
 \float_alignment class
 \paperfontsize 12
@@ -147,15 +147,19 @@ logicalmkup
 \papersides 2
 \paperpagestyle default
 \tablestyle default
-\tracking_changes true
+\tracking_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"
+\author -584632292 "Richard Kimberly Heck"
 \author -563046850 "Jean-Marc LASGOUTTES"
 \author 5863208 "ab"
+\author 1675569489 "Stephan Witt"
 \end_header
 
 \begin_body
@@ -18227,7 +18231,27 @@ Line breaks after unspaced dashes can be allowed via the menu
 \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
@@ -25579,7 +25603,7 @@ Math
 status collapsed
 
 \begin_layout Plain Layout
-Formulas | see
+Formulas|see
 \begin_inset ERT
 status collapsed
 
@@ -29834,6 +29858,63 @@ 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 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
@@ -29894,7 +29975,10 @@ Appendix
 
 \begin_inset CommandInset ref
 LatexCommand ref
-reference "chap:Credits"
+reference "chap:Units-available-in"
+plural "false"
+caps "false"
+noprefix "false"
 
 \end_inset
 
@@ -38197,6 +38281,8 @@ The toolbar has two buttons to handle notes because notes are often important
 \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
@@ -38225,6 +38311,8 @@ literal "true"
 
  or in the package manager of your \SpecialChar LaTeX
 -system.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Section
@@ -38823,7 +38911,7 @@ DVI
 \end_layout
 
 \begin_layout Description
-DVI DVI-format that also allows the useage of special characters or spaces
+DVI DVI-format that also allows the usage of special characters or spaces
  in files paths or file names
 \end_layout
 
@@ -43797,7 +43885,7 @@ Default
 \family sans
 \begin_inset Info
 type  "icon"
-arg   "layout Enumerate"
+arg   "layout-toggle Enumerate"
 \end_inset
 
 
@@ -43824,7 +43912,7 @@ Numbered list
 \family sans
 \begin_inset Info
 type  "icon"
-arg   "layout Itemize"
+arg   "layout-toggle Itemize"
 \end_inset
 
 
@@ -43851,7 +43939,7 @@ Itemized list
 \family sans
 \begin_inset Info
 type  "icon"
-arg   "layout List"
+arg   "layout-toggle List"
 \end_inset
 
 
@@ -43878,7 +43966,7 @@ List
 \family sans
 \begin_inset Info
 type  "icon"
-arg   "layout Description"
+arg   "layout-toggle Description"
 \end_inset
 
 
@@ -46855,6 +46943,42 @@ Objects
  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
@@ -47677,25 +47801,105 @@ reference "sec:File-Formats"
 \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
+\change_inserted -712698321 1578646679
+\change_deleted -712698321 1578646679
+
 \begin_inset space ~
 \end_inset
 
+
+\change_unchanged
 with
+\change_deleted -712698321 1578646686
+
 \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
+
+\change_unchanged
 Forward
 \begin_inset space ~
 \end_inset
 
 search
+\change_inserted -712698321 1578646752
+
 \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
@@ -47707,9 +47911,55 @@ Additional
 
 Features
 \emph default
- manual.
+ manual
+\change_inserted -712698321 1578646762
+)
+\change_unchanged
+.
+\change_inserted -712698321 1578647009
+
+\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 ~
@@ -48745,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.
+\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
@@ -49938,14 +50211,20 @@ Command
 \begin_inset space ~
 \end_inset
 
-end Counterpart to 
+end 
+\change_deleted -712698321 1563857836
+Counterpart to 
 \family sans
 Command start
 \family default
 .
  
-\change_inserted -712698321 1563708846
-Use this if the language switch needs to be explicitly ended, as in 
+\change_inserted -712698321 1563857869
+Use this if the language switch set in 
+\family sans
+Command start
+\family default
+ needs to be explicitly ended, as in 
 \series bold
 babel
 \series default
@@ -49954,6 +50233,7 @@ babel
 
 \backslash
 begin{otherlanguage*}\SpecialChar ldots
+\SpecialChar allowbreak
 
 \backslash
 end{otherlanguage*}
@@ -49963,14 +50243,15 @@ end{otherlanguage*}
 \change_deleted -712698321 1563708866
 Some packages, like the default, don't have an end command since the start
  command toggles the package on and off
-\change_inserted -712698321 1563711115
+\change_inserted -712698321 1563858041
 Empty by default, as 
 \family typewriter
 
 \backslash
 selectlanguage{$$lang}
 \family default
- does not need to be explicitly ended (it is valid until the next 
+ does not need to be explicitly ended (the switch remains valid until the
+ next 
 \family typewriter
 
 \backslash
@@ -49980,7 +50261,7 @@ selectlanguage{$$lang}
 \change_unchanged
 .
 
-\change_inserted -712698321 1563708925
+\change_inserted -712698321 1563857868
  Note that with 
 \series bold
 polyglossia
@@ -50350,26 +50631,50 @@ RTL
 \change_inserted -712698321 1563710286
 scripts with right-to-left direction (e.g., Arabic, Hebrew or Farsi).
  
-\change_deleted -712698321 1563710294
+\change_deleted -712698321 1563857456
 , you can define if the left and right arrow keys move the cursor visually
  to the left or right, respectively, or logically.
  
-\change_unchanged
+\change_inserted -712698321 1563859701
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
 
 \family sans
 Logical
 \family default
- means that the cursor is moved to the left 
-\change_deleted -712698321 1563710342
-when
-\change_inserted -712698321 1563710342
-if
-\change_unchanged
- pressing the right arrow key 
-\change_inserted -712698321 1563712351
-(so right arrow key means: move forward), and to the right if pressing the
- left arrow key (which then means: move backward).
- This setting might be useful in texts that mix left-to-right and right-to-left
+ means that the cursor 
+\change_inserted -712698321 1563859940
+follows the logic of the text direction, and the arrows' direction relates
+ to the directionality of the main paragraph language.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in embedded right-to-left text in a left-to-right paragraph (say, Hebrew
+ embedded in English), the cursor starts at the right (that is, at the 
+\emph on
+beginning
+\emph default
+ of the embedded passage in the right-to-left logic) when coming from the
+ left.
+ The meaning of the key is thus swapped for that part; right arrow in this
+ specific case always means: move 
+\emph on
+forward
+\emph default
+ in text (even if this means: 
+\emph on
+move left
+\emph default
+).
+\change_deleted -712698321 1563857456
+is moved to the left when pressing the right arrow key 
+\change_inserted -712698321 1563859705
+This setting might be useful in texts that mix left-to-right and right-to-left
  scripts, since the cursor then follows a coherent 
 \begin_inset Quotes eld
 \end_inset
@@ -50380,16 +50685,31 @@ text logic
 
 .
  
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1563860084
+
 \family sans
 Visual
 \family default
  means: always move to the direction towards which the arrows really point.
-\change_deleted -712698321 1563710407
+ In this case, in embedded right-to-left text in a left-to-right paragraph,
+ the cursor starts at the left (in the text logic: 
+\emph on
+from the end
+\emph default
+) when coming from the left.
+ The visual meaning of the key is thus maintained in all cases, at the expense
+ of the text logic.
+\change_deleted -712698321 1563857456
 and the cursor is inside text in an RTL language.
-\change_inserted -712698321 1563710219
+\change_inserted -712698321 1563858627
 
 \end_layout
 
+\end_deeper
 \begin_layout Subsubsection
 
 \change_inserted -712698321 1563710235
@@ -52685,7 +53005,7 @@ literal "false"
  of the \SpecialChar LaTeX
  package 
 \series bold
-microtpye
+microtype
 \series default
 
 \begin_inset Index idx
@@ -52693,7 +53013,7 @@ status collapsed
 
 \begin_layout Plain Layout
 \SpecialChar LaTeX
- packages ! microtpye
+ packages ! microtype
 \end_layout
 
 \end_inset