X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FUserGuide.lyx;h=43a9316095fd82260172291621b6064993173f33;hb=ef4594c71e1dc0e3006b459bc53ea964ce1cdf82;hp=49b642270aebc08d7e6d657070ea296e06628b45;hpb=360742c515fcb74e6b8b5383f2e3002edb2d00cf;p=lyx.git diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx index 49b642270a..43a9316095 100644 --- a/lib/doc/UserGuide.lyx +++ b/lib/doc/UserGuide.lyx @@ -1,5 +1,5 @@ -#LyX 2.2 created this file. For more info see http://www.lyx.org/ -\lyxformat 506 +#LyX 2.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 512 \begin_document \begin_header \save_transient_properties true @@ -68,6 +68,7 @@ enumitem \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false \graphics default \default_output_format pdf2 \output_sync 0 @@ -134,11 +135,14 @@ enumitem \papercolumns 1 \papersides 2 \paperpagestyle default -\tracking_changes false +\tracking_changes true \output_changes false \html_math_output 0 \html_css_as_file 0 \html_be_strict true +\author 274215730 "scott" +\author 424524441 "rgheck" +\author 2047637253 "Guillaume Munch" \end_header \begin_body @@ -3148,7 +3152,7 @@ IOP \begin_layout Standard If there is a document class you would like to use that is marked as -\begin_inset Quotes erd +\begin_inset Quotes eld \end_inset Unavailable @@ -4157,19 +4161,19 @@ Default \begin_layout Itemize \family sans -A0 - A6 +A0 – A6 \end_layout \begin_layout Itemize \family sans -B0 - B6 +B0 – B6 \end_layout \begin_layout Itemize \family sans -C0 - C6 +C0 – C6 \end_layout \begin_layout Itemize @@ -4181,7 +4185,7 @@ US letter, US legal, US executive \begin_layout Itemize \family sans -JIS B0 - JIS B6 +JIS B0 – JIS B6 \end_layout \begin_layout Itemize @@ -4625,7 +4629,7 @@ begin{ \emph on environment \emph default -} ... +} \SpecialChar ldots \backslash end{ @@ -6680,7 +6684,7 @@ The default numbering of numbered lists can be changed by adding an optional argument (menu \family sans Insert\SpecialChar menuseparator -Short Title +Enumerate Options \family default ) to the first item of each level in the list. There you add the command @@ -12272,8 +12276,8 @@ You shouldn't use forced line breaks to correct \SpecialChar LaTeX 's line breaking, as \SpecialChar LaTeX is very good at line breaking. - There are, however, a number of situations where it is necessaryactively - to set a line break, for example, in a poem or for an address (see sections + There are, however, a number of situations where it is necessary to set + a line break actively, for example, in a poem or for an address (see sections \begin_inset space ~ \end_inset @@ -16114,7 +16118,7 @@ reference "sec:File-Formats" \begin_inset CommandInset ref LatexCommand ref -reference "sec:Doc-Output" +reference "sec:Doc-Formats" \end_inset @@ -17049,15 +17053,7 @@ Text \family default - Use quotes like -\begin_inset Quotes sld -\end_inset - -this -\begin_inset Quotes srd -\end_inset - - + Use quotes like ”this” \end_layout \begin_layout Labeling @@ -19006,7 +19002,7 @@ C \end_layout \begin_layout Subsection -The Table dialog +Table Dialog \end_layout \begin_layout Standard @@ -19285,12 +19281,12 @@ Default \end_layout \begin_layout Subsection -Longtables +Multi-page Tables \begin_inset Index idx status collapsed \begin_layout Plain Layout -Tables ! Longtables +Tables ! Multi-page \end_layout \end_inset @@ -19300,7 +19296,7 @@ Tables ! Longtables status collapsed \begin_layout Plain Layout -Longtables +Multi-page tables \end_layout \end_inset @@ -19315,7 +19311,7 @@ Use \begin_inset space ~ \end_inset -long +multi-page \begin_inset space ~ \end_inset @@ -19323,7 +19319,11 @@ table \family default in the tab \family sans -Longtable +Multi-page +\begin_inset space ~ +\end_inset + +table \family default of the table dialog to split the table automatically over more pages. Doing this enables some check boxes and you can now define: @@ -19336,7 +19336,7 @@ Header \family default : The current row and all rows above, that don't have any special options defined, are defined to be the header rows of all pages of the longtable. - except for the first page, if + Except for the first page, if \family sans First \begin_inset space ~ @@ -19399,7 +19399,7 @@ Insert\SpecialChar menuseparator Caption \family default . - More about longtable captions can be found in the + More about multi-page table captions can be found in the \emph on Embedded \begin_inset space ~ @@ -26092,7 +26092,6 @@ arg "label-insert" A gray label box like this: \begin_inset Graphics filename clipart/label.png - scale 85 \end_inset @@ -26166,7 +26165,6 @@ arg "dialog-show-new-inset ref" A gray cross-reference box like this: \begin_inset Graphics filename clipart/reference.png - scale 85 \end_inset @@ -29747,6 +29745,7 @@ Here is an example, where only the question text appears, the answer branch \begin_layout Standard \begin_inset Branch Question +inverted 0 status open \begin_layout Standard @@ -29760,6 +29759,7 @@ Question: Who was the first physics Nobel prize winner? \begin_layout Standard \begin_inset Branch Answer +inverted 0 status collapsed \begin_layout Standard @@ -29866,6 +29866,66 @@ Exam-Question-Answer.pdf if both branches were active. This helps you to export different versions of your document easily. +\change_inserted 424524441 1468296009 + +\end_layout + +\begin_layout Standard + +\change_inserted 424524441 1468297080 +As of LyX 2.3.0, there are also +\begin_inset Quotes eld +\end_inset + +inverted +\begin_inset Quotes erd +\end_inset + + branch insets, whose content is output just in case the branch is +\emph on +not +\emph default + activated. + +\begin_inset Branch Question +inverted 1 +status open + +\begin_layout Standard + +\change_inserted 424524441 1468296217 +For example, this material will only appear when the Question branch is + deactivated. +\change_unchanged + +\end_layout + +\end_inset + + This make it easy to add alternative text for different versions of a document. + To control whether a particular inset is +\begin_inset Quotes eld +\end_inset + +inverted +\begin_inset Quotes erd +\end_inset + +, right-click on the inset button and choose +\begin_inset Quotes eld +\end_inset + + +\change_unchanged +Invert Inset +\change_inserted 424524441 1468297080 + +\begin_inset Quotes erd +\end_inset + +. +\change_deleted 424524441 1468296150 + \end_layout \begin_layout Standard @@ -29950,6 +30010,7 @@ answer}[1]{#1} \begin_layout Standard \begin_inset Branch Question +inverted 0 status open \begin_layout Standard @@ -29986,6 +30047,7 @@ answer}[1]{} \begin_layout Standard \begin_inset Branch Answer +inverted 0 status collapsed \begin_layout Standard @@ -31011,7 +31073,11 @@ Modules \begin_inset Quotes eld \end_inset + +\emph on Custom Header/Footerlines +\emph default + \begin_inset Quotes erd \end_inset @@ -31020,7 +31086,7 @@ Custom Header/Footerlines \begin_inset space ~ \end_inset -styles: +environments: \end_layout \begin_layout Description @@ -31073,6 +31139,7 @@ Footer \begin_layout Standard for the different positions in the header/footer. + These environments can be selected in the environment pull-down box. \end_layout \begin_layout Standard @@ -31320,12 +31387,13 @@ Definition \end_layout \begin_layout Standard -To define your header line, add all three header styles. - The things you add to the styles appear on odd numbered pages, the things - in the optional arguments on even numbered pages. +To define your header line, add all three header environments. + The things you add to each environment appear on odd numbered pages, the + things in the optional arguments on even numbered pages. For single-sided documents, the optional arguments will not be used and can be omitted. - If you leave a style or its argument empty, nothing appears in the output. + If you leave a header environment or its argument empty, nothing appears + in the output. Defining the footer line works similarly. \end_layout @@ -31417,8 +31485,8 @@ Appearance \begin_layout Standard The header and footer will appear on normal pages. Some pages are different. - The title page has a style of its own, and so does any page that starts - a new part or chapter in your book. + The title page has a header/footer environment of its own, and so does + any page that starts a new part or chapter in your book. Such pages will not have the custom headers/footers, but that is normal. There is for example no need to print a header with the chapter name on the chapter page where the chapter heading is in big bold letters anyway. @@ -31462,12 +31530,16 @@ headrulewidth}{thickness} \begin_layout Standard where thickness is a size in standard units like \family sans +\emph on pt \family default +\emph default or \family sans +\emph on mm \family default +\emph default . If you don't want a line, set the thickness to 0 \begin_inset space \thinspace{} @@ -31499,7 +31571,7 @@ Several header/footer lines \begin_layout Standard In case you need more than one text line as a header/footer, you can do - this by adding a normal line break in the style definition. + this by adding a ragged line break in the style definition. However, the default height of the header/footer is only the one of one text line. To expand the height, redefine the \SpecialChar LaTeX @@ -31515,7 +31587,7 @@ headheight \backslash footheight \series default - in this entry in + with this entry in \family sans Document\SpecialChar menuseparator Settings\SpecialChar menuseparator @@ -31539,14 +31611,34 @@ headheight}{height} \end_layout \begin_layout Standard -where height is a size in standard units. - If you don't know which amount of space is needed for the height, define - your header/footer and preview your document as a PDF. +where +\series bold +height +\series default + is a size in standard units (e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + + +\series bold +1cm +\series default +). + If you don't know how much space is needed for the height, define your + header/footer and preview your document as a PDF. Then open the \SpecialChar LaTeX logfile with the menu \family sans Document\SpecialChar menuseparator -LaTeX Log +LaTeX +\begin_inset space ~ +\end_inset + +Log \family default and use the button \family sans @@ -32478,10 +32570,10 @@ Find When searching for a formula, it is found both when it is alone and when it occurs in sub-formulas and nested parts of sub-formulas. For example the mentioned segments would be found in something like -\begin_inset Formula $\frac{x^{2}}{\sqrt{\frac{x^{2}}{1+x^{2}}}}.$ +\begin_inset Formula $\frac{x^{2}}{\sqrt{\frac{x^{2}}{1+x^{2}}}}$ \end_inset - +. \end_layout \begin_layout Subsubsection @@ -35557,43 +35649,33 @@ Layout \end_layout \begin_layout Subsection -Table +Table and Rows & Columns \end_layout \begin_layout Standard -This menu only appears if the cursor is inside a table. +These menus only appear if the cursor is inside a table. It allows you to create multicolumn and multirow cells, add or remove borders - of a cell and to set the vertical alignment of the cell.Table Settings and - Math + of a cell and to set the alignment of the cell. \end_layout -\begin_layout Standard -These two menus are only fully active if the cursor is inside a table or - a formula. - Here you can change the properties of tables and formulas. - The properties of tables are described in section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Tables" - -\end_inset - -, the properties of formulas in chapter -\begin_inset space ~ -\end_inset - +\begin_layout Subsection +Dissolve Inset +\end_layout -\begin_inset CommandInset ref -LatexCommand ref -reference "chap:Mathematical-Formulas" +\begin_layout Standard +This menu only appears if the cursor is inside an inset. + It will dissolve this inset. + This means that the inset is deleted and its content is left as normal + text. +\end_layout -\end_inset +\begin_layout Subsection +Settings or Math +\end_layout -. +\begin_layout Standard +This menu is only active if the cursor is inside an inset or a formula. + Here you can change the properties of the inset or the formula. \end_layout \begin_layout Subsection @@ -36957,7 +37039,7 @@ Captions status collapsed \begin_layout Plain Layout -Longtables ! Caption +Tables ! Multi-page ! Caption \end_layout \end_inset @@ -36966,7 +37048,7 @@ Longtables ! Caption \end_layout \begin_layout Standard -Inserts a caption in a float or longtable. +Inserts a caption in a float or multi-page table. Floats are described in section \begin_inset space ~ \end_inset @@ -36978,9 +37060,9 @@ reference "sec:Floats" \end_inset -; captions in longtables are described in the section +; captions in multi-page tables are described in the section \emph on -Longtable Captions +Multi-page Captions \emph default of the \emph on @@ -37571,7 +37653,7 @@ Format \begin_inset CommandInset ref LatexCommand ref -reference "sec:Doc-Output" +reference "sec:Doc-Formats" \end_inset @@ -37838,7 +37920,7 @@ Format \begin_inset CommandInset ref LatexCommand ref -reference "sec:Doc-Output" +reference "sec:Doc-Formats" \end_inset @@ -37935,7 +38017,7 @@ Format \begin_inset CommandInset ref LatexCommand ref -reference "sec:Doc-Output" +reference "sec:Doc-Formats" \end_inset @@ -42730,10 +42812,16 @@ reference "sec:Branches" \end_layout \begin_layout Section + +\change_deleted 2047637253 1472399758 Output +\change_inserted 2047637253 1472400015 +Formats +\change_unchanged + \begin_inset CommandInset label LatexCommand label -name "sec:Doc-Output" +name "sec:Doc-Formats" \end_inset @@ -42912,6 +43000,51 @@ scaling is used for the size of equations in the output. \end_layout +\begin_layout Description +LyX +\begin_inset space ~ +\end_inset + +Format The option +\family sans +Save transient properties +\family default + controls whether document settings that are frequently switched or that + are specific to the user are saved with the document. + The properties that are affected by option are currently +\change_inserted 2047637253 1472400492 +: +\change_unchanged + +\end_layout + +\begin_deeper +\begin_layout Itemize +the activation of change tracking +\change_inserted 2047637253 1472400062 +, +\change_unchanged + +\end_layout + +\begin_layout Itemize +the output of tracked changes +\change_inserted 2047637253 1472400062 +, +\change_unchanged + +\end_layout + +\begin_layout Itemize +the recording of the document directory path. +\end_layout + +\begin_layout Standard +Disabling the option can prevent issues in collaborative work and/or when + using a version control system (for instance unnecessary merge conflicts). +\end_layout + +\end_deeper \begin_layout Section La \family sans @@ -43491,6 +43624,12 @@ arg "closetab" \family default ) at the right side of the tab bar to close tabs. Otherwise every document tab has its own close button. + +\change_inserted 274215730 1469338548 + Regardless of this option, one may always close a tab by middle-clicking + it in the tab bar. +\change_unchanged + \end_layout \begin_layout Standard @@ -44684,7 +44823,7 @@ prefix The TEXINPUTS environment variable allows you to use external files Note that any non-absolute path listed in the TEXINPUTS prefix is considered to be relative to the directory of your \SpecialChar LyX file. - It is recommended that you always include ‘.' as one of the paths; otherwise + It is recommended that you always include '.' as one of the paths; otherwise compilation may fail for some documents. \end_layout @@ -45249,36 +45388,6 @@ export Setting what \SpecialChar LyX is allowed to overwrite on export. \end_layout -\begin_layout Description -Forward -\begin_inset space ~ -\end_inset - -search Commands that will be used for the menu -\family sans -Navigate\SpecialChar menuseparator -Forward -\begin_inset space ~ -\end_inset - -search -\family default -. - For a detailed description see section -\emph on -Reverse DVI/PDF search -\emph default - of the -\emph on -Additional -\begin_inset space ~ -\end_inset - -Features -\emph default - manual. -\end_layout - \begin_layout Subsection La \family sans