X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FUserGuide.lyx;h=210801622fa8fa30c7e7d9a1d0e13640d81bbe5d;hb=a08621ebce05d54645dc7d9d735a33d72079827d;hp=fd9c622aef9b972c32d279d0195af16f56034835;hpb=88460b2398a396128cd435033af8b1ebb67728ba;p=features.git diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx index fd9c622aef..210801622f 100644 --- 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 580 +\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 @@ -66,7 +66,9 @@ logicalmkup \font_default_family default \use_non_tex_fonts false \font_sc false -\font_osf false +\font_roman_osf false +\font_sans_osf false +\font_typewriter_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 \use_microtype false @@ -75,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 @@ -145,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 @@ -18225,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 @@ -25577,7 +25603,7 @@ Math status collapsed \begin_layout Plain Layout -Formulas | see +Formulas|see \begin_inset ERT status collapsed @@ -29832,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 @@ -29892,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 @@ -38195,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 @@ -38223,6 +38311,8 @@ literal "true" or in the package manager of your \SpecialChar LaTeX -system. +\change_unchanged + \end_layout \begin_layout Section @@ -38821,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 @@ -43795,7 +43885,7 @@ Default \family sans \begin_inset Info type "icon" -arg "layout Enumerate" +arg "layout-toggle Enumerate" \end_inset @@ -43822,7 +43912,7 @@ Numbered list \family sans \begin_inset Info type "icon" -arg "layout Itemize" +arg "layout-toggle Itemize" \end_inset @@ -43849,7 +43939,7 @@ Itemized list \family sans \begin_inset Info type "icon" -arg "layout List" +arg "layout-toggle List" \end_inset @@ -43876,7 +43966,7 @@ List \family sans \begin_inset Info type "icon" -arg "layout Description" +arg "layout-toggle Description" \end_inset @@ -46853,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 @@ -47675,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 @@ -47705,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 ~ @@ -48743,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 @@ -49727,6 +50002,16 @@ literal "false" \end_inset +\change_inserted -712698321 1563708959 + +\end_layout + +\begin_layout Subsubsection + +\change_inserted -712698321 1563708986 +LaTeX Language Support +\change_unchanged + \end_layout \begin_layout Description @@ -49815,14 +50100,63 @@ Command \begin_inset space ~ \end_inset -start If a special \SpecialChar LaTeX +start +\change_deleted -712698321 1563708374 +If a special \SpecialChar LaTeX -package is needed to write in a certain document language, - you can here specify the command to start the package. - An example is the start command + you can h +\change_inserted -712698321 1563708374 +H +\change_unchanged +ere +\change_inserted -712698321 1563708377 + you +\change_unchanged + +\change_deleted -712698321 1563708382 +specify +\change_inserted -712698321 1563708384 +customize +\change_unchanged + the command +\change_inserted -712698321 1563708639 +that is used to switch to a different language +\change_deleted -712698321 1563708410 +to start the package +\change_unchanged +. + +\change_inserted -712698321 1563708611 +This might be useful if you want to use a different command with +\series bold +babel +\series default + (which provides several alternative commands with different behavior), + or if you use a custom language package with specific commands, such as + +\series bold +Arab\SpecialChar TeX + +\series default + +\begin_inset CommandInset citation +LatexCommand cite +key "Arabic" +literal "true" + +\end_inset + +, which needs +\change_deleted -712698321 1563708616 +An example is +\change_unchanged +the start command \family sans \backslash begin{arabtext} +\change_deleted -712698321 1563708621 + \family default that is needed to write Arabic using the package \series bold @@ -49837,18 +50171,39 @@ literal "true" \end_inset + +\change_unchanged . The default is the \series bold babel \series default command -\family sans +\family typewriter \backslash selectlanguage{$$lang} +\change_inserted -712698321 1563708571 + +\family default +, whereby +\family sans +$$lang \family default + is a placeholder that is substituted with the respective language name + in the \SpecialChar LaTeX + output +\change_unchanged . + +\change_inserted -712698321 1563708571 + Note that with +\series bold +polyglossia +\series default +, this setting is ignored. +\change_unchanged + \end_layout \begin_layout Description @@ -49856,16 +50211,69 @@ Command \begin_inset space ~ \end_inset -end Counterpart to +end +\change_deleted -712698321 1563857836 +Counterpart to \family sans Command start \family default . - Some packages, like the default, don't have an end command since the start - command toggles the package on and off. + +\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 +'s alternative command +\family typewriter + +\backslash +begin{otherlanguage*}\SpecialChar ldots +\SpecialChar allowbreak + +\backslash +end{otherlanguage*} +\family default +. + +\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 1563858041 +Empty by default, as +\family typewriter + +\backslash +selectlanguage{$$lang} +\family default + does not need to be explicitly ended (the switch remains valid until the + next +\family typewriter + +\backslash +selectlanguage{$$lang} +\family default +) +\change_unchanged +. + +\change_inserted -712698321 1563857868 + Note that with +\series bold +polyglossia +\series default +, this setting is ignored. +\change_unchanged + \end_layout \begin_layout Description + +\change_deleted -712698321 1563708996 Default \begin_inset space ~ \end_inset @@ -49879,6 +50287,8 @@ separator Defines the default decimal point for use in tables (decimal point \end_layout \begin_layout Description + +\change_deleted -712698321 1563708996 Default \begin_inset space ~ \end_inset @@ -49889,6 +50299,8 @@ length unit Defines the unit that is used as default for lengths in \SpecialChar LyX 's dialogs. +\change_unchanged + \end_layout \begin_layout Description @@ -49900,24 +50312,99 @@ languages \begin_inset space ~ \end_inset -globally When this option is set, the languages used in the document will - be added as options to the document class options, so that they can be - used by all \SpecialChar LaTeX --packages. - Otherwise they will only be used as options for the +globally +\change_deleted -712698321 1563709051 +When +\change_inserted -712698321 1563709052 +If +\change_unchanged + this option is set, the languages used in the document will be added +\change_deleted -712698321 1563709127 +as options +\change_unchanged +to the document class options +\change_inserted -712698321 1563709259 + rather than the language package options. +\change_deleted -712698321 1563709186 +, +\change_unchanged + +\change_deleted -712698321 1563709191 +so that they can be used by all \SpecialChar LaTeX +-packages +\change_inserted -712698321 1563709305 +Since the document class passes all options in gets to all loaded \SpecialChar LaTeX +-packages, + all language-aware packages will be informed about the used languages this + way +\change_unchanged +. + +\change_deleted -712698321 1563709264 +Otherwise they will only be used as options for the \series bold babel \series default package. +\change_unchanged + \end_layout \begin_layout Description + +\change_deleted -712698321 1563709314 Auto \begin_inset space ~ \end_inset -begin When this option is set, documents start with the chosen document - language. +begin +\change_inserted -712698321 1563709328 +Set +\begin_inset space ~ +\end_inset + +document +\begin_inset space ~ +\end_inset + +language +\begin_inset space ~ +\end_inset + +explicitly +\change_unchanged + +\change_deleted -712698321 1563709331 +When +\change_inserted -712698321 1563709331 +If +\change_unchanged + this option is set, +\change_inserted -712698321 1563709808 +the language switch defined in +\family sans +Command +\begin_inset space ~ +\end_inset + +start +\family default + is output at the beginning of the document, thereby explicitly switching + to the document language. + This assures that the correct language is used in any case. + This might be needed if you use a non-default +\family sans +Command +\begin_inset space ~ +\end_inset + +start +\family default + or if a package resets the document language. + If not set, the language that is active at document start is used (this + usually should be the document language). +\change_deleted -712698321 1563709548 +documents start with the chosen document language. When this option is not set, the \family sans Command @@ -49937,23 +50424,55 @@ Command start \family default than the default. +\change_unchanged + \end_layout \begin_layout Description + +\change_deleted -712698321 1563709354 Auto \begin_inset space ~ \end_inset -end Counterpart to +end +\change_inserted -712698321 1563709358 +Unset +\begin_inset space ~ +\end_inset + +document +\begin_inset space ~ +\end_inset + +language +\begin_inset space ~ +\end_inset + +explicitly +\change_unchanged + Counterpart to +\change_deleted -712698321 1563709361 + \family sans Auto \begin_inset space ~ \end_inset begin +\change_inserted -712698321 1563709392 +Set document language explicitly +\change_unchanged + \family default . - When it is not set, the + +\change_deleted -712698321 1563709618 +When it is not +\change_inserted -712698321 1563709618 +If +\change_unchanged + set, the \family sans Command \begin_inset space ~ @@ -49961,7 +50480,30 @@ Command end \family default - is set to the end of the document. + is +\change_deleted -712698321 1563709625 +set +\change_inserted -712698321 1563709626 +output +\change_unchanged + +\change_inserted -712698321 1563709628 +at +\change_deleted -712698321 1563709628 +to +\change_unchanged + the end of the document. +\change_inserted -712698321 1563709816 + +\end_layout + +\begin_layout Subsubsection +\paragraph_spacing single + +\change_inserted -712698321 1563709833 +Editor Settings +\change_unchanged + \end_layout \begin_layout Description @@ -49969,15 +50511,81 @@ Mark \begin_inset space ~ \end_inset + +\change_inserted -712698321 1563709847 +additional +\change_deleted -712698321 1563709845 foreign +\change_unchanged + +\begin_inset space ~ +\end_inset + +languages +\change_inserted -712698321 1563709877 +If set, all +\change_deleted -712698321 1563709877 +T +\change_inserted -712698321 1563709878 +t +\change_unchanged +ext +\change_deleted -712698321 1563709882 +marked formatted +\change_unchanged +in a language different +\change_deleted -712698321 1563709886 +from +\change_inserted -712698321 1563709886 +to +\change_unchanged + the document language will be +\change_inserted -712698321 1563709907 +marked (by default with a blue +\change_unchanged +underline +\change_deleted -712698321 1563709911 +d in blue +\change_inserted -712698321 1563709911 +) +\change_unchanged +. +\change_inserted -712698321 1563709927 + +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1563711969 +Respect +\begin_inset space ~ +\end_inset + +OS +\begin_inset space ~ +\end_inset + +keyboard \begin_inset space ~ \end_inset -languages Text marked formatted in a language different from the document - language will be underlined in blue. +language If set, \SpecialChar LyX + will switch the input language if the keyboard map is + switched via the operating system. + This is particularly useful if you switch between languages with different + scripts (e. +\begin_inset space \thinspace{} +\end_inset + +g., English and Hebrew: in this case, switching the keyboard to Hebrew will + automatically switch the input language to Hebrew as well, and vice versa). +\change_unchanged + \end_layout \begin_layout Description + +\change_deleted -712698321 1563709926 Enable \begin_inset space ~ \end_inset @@ -49988,17 +50596,163 @@ RTL support Enables the use of languages, written from right to left (RTL), like Arabic, Hebrew or Farsi. +\change_unchanged + \end_layout \begin_layout Description -Cursor + +\change_inserted -712698321 1563710132 +Right-to-left \begin_inset space ~ \end_inset -movement When writing RTL, you can define if the left and right arrow keys - move the cursor visually to the left or right, respectively, or logically. - Logical means that the cursor is moved to the left when pressing the right - arrow key and the cursor is inside text in an RTL language. + +\change_deleted -712698321 1563710132 +C +\change_inserted -712698321 1563710132 +c +\change_unchanged +ursor +\begin_inset space ~ +\end_inset + +movement +\change_inserted -712698321 1563710265 +Here you can define how cursor movement (with the arrow keys) behaves +\change_deleted -712698321 1563710266 +W +\change_inserted -712698321 1563710267 +w +\change_unchanged +hen writing +\change_deleted -712698321 1563710171 +RTL +\change_inserted -712698321 1563710286 +scripts with right-to-left direction (e.g., Arabic, Hebrew or Farsi). + +\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_inserted -712698321 1563859701 + +\end_layout + +\begin_deeper +\begin_layout Standard + +\family sans +Logical +\family default + 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 + +text logic +\begin_inset Quotes erd +\end_inset + +. + +\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. + 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 1563858627 + +\end_layout + +\end_deeper +\begin_layout Subsubsection + +\change_inserted -712698321 1563710235 +Local Preferences +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1563776004 +Default +\begin_inset space ~ +\end_inset + +decimal +\begin_inset space ~ +\end_inset + +separator Defines the default decimal separator for use in tables (decimal + separator alignment). + By default, the appropriate character for the current language is selected + (e. +\begin_inset space \thinspace{} +\end_inset + +g., dot for English, comma for German), but you can also specify a specific + (static) custom character here. +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1563709001 +Default +\begin_inset space ~ +\end_inset + +length +\begin_inset space ~ +\end_inset + +unit Defines the unit that is used as default for lengths in \SpecialChar LyX +'s dialogs. +\change_unchanged + \end_layout \begin_layout Subsection @@ -52251,7 +53005,7 @@ literal "false" of the \SpecialChar LaTeX package \series bold -microtpye +microtype \series default \begin_inset Index idx @@ -52259,7 +53013,7 @@ status collapsed \begin_layout Plain Layout \SpecialChar LaTeX - packages ! microtpye + packages ! microtype \end_layout \end_inset