X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FCustomization.lyx;h=079b7f74d3aa688a2367cec8e27a85743731b0a1;hb=cde4537a42d0281600aabdd141d5ba91b6e4ef75;hp=b1e0fd405491999034a85f1693439f13253b67c2;hpb=dce2b4e016ccbef8ee842d643d2221d1032aea63;p=features.git diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx index b1e0fd4054..079b7f74d3 100644 --- a/lib/doc/Customization.lyx +++ b/lib/doc/Customization.lyx @@ -1,5 +1,5 @@ #LyX 2.4 created this file. For more info see https://www.lyx.org/ -\lyxformat 596 +\lyxformat 608 \begin_document \begin_header \save_transient_properties true @@ -109,7 +109,7 @@ logicalmkup \branch OutDated \selected 0 \filename_suffix 0 -\color #f5fae7 +\color #f5fae7 #0a0518 \end_branch \index Index \shortcut idx @@ -135,10 +135,17 @@ logicalmkup \html_math_output 0 \html_css_as_file 0 \html_be_strict true +\docbook_table_output 0 +\docbook_mathml_prefix 1 +\author -970929547 "Thibaut Cuvelier" \author -712698321 "Jürgen Spitzmüller" +\author -584632292 "Richard Kimberly Heck" \author -495245474 "Jean-Marc Lasgouttes" \author 5863208 "ab" +\author 34634807 "Jean-Pierre" +\author 232239728 "Owner" \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org +\author 1075283030 "Thibaut" \end_header \begin_body @@ -155,7 +162,6 @@ by the \SpecialChar LyX status collapsed \begin_layout Plain Layout -\noindent If you have comments or error corrections, please send them to the \SpecialChar LyX Documentatio n mailing list, @@ -177,7 +183,17 @@ literal "false" \end_inset in the subject header, and please cc the current maintainer of this file, - Richard Heck . + Richard +\change_inserted 5863208 1604930692 +Kimberly +\change_unchanged +Heck < +\change_inserted 5863208 1604930729 +rikiheck@lyx.org +\change_deleted 5863208 1604930668 +rikiheck@lyx.org +\change_unchanged +>. \end_layout \end_inset @@ -190,7 +206,7 @@ literal "false" \begin_inset Newline newline \end_inset -Version 2.3.x +Version 2.4.x \end_layout \begin_layout Standard @@ -333,8 +349,11 @@ LyXDir \end_inset - and its sub-directories contain a number of files and that can be used - to customize \SpecialChar LyX + and its sub-directories contain a number of files +\change_deleted 232239728 1604787780 +and +\change_unchanged + that can be used to customize \SpecialChar LyX 's behavior. You can change many of these files from within \SpecialChar LyX itself through the @@ -374,7 +393,7 @@ Automatically generated files \end_layout \begin_layout Standard -The files, which are to be found in +The files found in \begin_inset Flex Noun status collapsed @@ -384,9 +403,14 @@ UserDir \end_inset -, are generated when you configure \SpecialChar LyX + are generated when you configure \SpecialChar LyX . - They contain various default values that are guessed by inspection. + They contain various default values that are +\change_inserted 5863208 1604919565 +automatically detected during reconfiguration. +\change_deleted 232239728 1604788241 +guessed by inspection +\change_unchanged In general, it is not a good idea to modify them, since they might be overwritt en at any time. \end_layout @@ -402,7 +426,32 @@ lyxrc.defaults \end_inset - contains defaults for various commands. + +\change_deleted 5863208 1604919950 + +\begin_inset Note Note +status collapsed + +\begin_layout Plain Layout + +\change_inserted 232239728 1604853928 +I capitalized the first word in all of these lists. + To me it looks better but it really is a stylistic thing, your call. + However if you are not going to capitalize them, the english in some needs + to be modified to make it read correctly as a sentence. +\change_unchanged + +\end_layout + +\end_inset + + +\change_deleted 232239728 1604853510 +c +\change_inserted 232239728 1604853510 +C +\change_unchanged +ontains defaults for various commands. \end_layout \begin_layout Labeling @@ -416,7 +465,13 @@ packages.lst \end_inset - contains the list of packages that have been recognized by \SpecialChar LyX + +\change_deleted 232239728 1604853512 +c +\change_inserted 232239728 1604853512 +C +\change_unchanged +ontains the list of packages that have been recognized by \SpecialChar LyX . It is currently unused by the \SpecialChar LyX program itself, but the information extracted, @@ -450,7 +505,13 @@ textclass.lst \end_inset - the list of text classes that have been found in your + +\change_deleted 232239728 1604853515 +t +\change_inserted 232239728 1604853515 +T +\change_unchanged +he list of text classes that have been found in your \begin_inset Flex Code status collapsed @@ -475,7 +536,13 @@ lyxmodules.lst \end_inset - the list of layout modules found in your + +\change_deleted 232239728 1604853518 +t +\change_inserted 232239728 1604853518 +T +\change_unchanged +he list of layout modules found in your \begin_inset Flex Code status collapsed @@ -491,7 +558,7 @@ layout/ \begin_layout Labeling \labelwidthstring 00.00.0000 \begin_inset Flex Code -status collapsed +status open \begin_layout Plain Layout *files.lst @@ -499,14 +566,20 @@ status collapsed \end_inset - lists of various sorts of \SpecialChar LaTeX + +\change_deleted 232239728 1604853523 +l +\change_inserted 232239728 1604853523 +L +\change_unchanged +ists of various sorts of \SpecialChar LaTeX -related files found on your system \end_layout \begin_layout Labeling \labelwidthstring 00.00.0000 \begin_inset Flex Code -status collapsed +status open \begin_layout Plain Layout doc/\SpecialChar LaTeX @@ -536,7 +609,19 @@ Directories \end_layout \begin_layout Standard -These directories are duplicated between +The +\change_deleted 5863208 1604928729 +se +\change_unchanged + +\change_inserted 5863208 1604928636 +following +\change_unchanged +directories +\change_inserted 5863208 1604928661 +in +\change_unchanged + \begin_inset Flex Code status collapsed @@ -546,7 +631,29 @@ LyXDir \end_inset - and + +\change_inserted 5863208 1604928662 + can be +\change_deleted 5863208 1604928642 +are +\change_unchanged + duplicated +\change_deleted 5863208 1604928669 +between +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LyXDir +\end_layout + +\end_inset + + and +\change_inserted 5863208 1604928680 +in +\change_unchanged + \begin_inset Flex Code status collapsed @@ -557,7 +664,11 @@ UserDir \end_inset . - If a particular files exists in both places, the one in + If a particular file +\change_deleted 232239728 1604794430 +s +\change_unchanged + exists in both places, the one in \begin_inset Flex Code status collapsed @@ -581,7 +692,13 @@ bind/ \end_inset - this directory contains files with the extension + +\change_deleted 232239728 1604794460 +t +\change_inserted 232239728 1604794460 +T +\change_unchanged +his directory contains files with the extension \begin_inset Flex Code status collapsed @@ -617,7 +734,13 @@ citeengines/ \end_inset - contains files with the extension + +\change_deleted 232239728 1604794478 +c +\change_inserted 232239728 1604794478 +C +\change_unchanged +ontains files with the extension \begin_inset Flex Code status collapsed @@ -652,7 +775,13 @@ clipart/ \end_inset - contains graphics files that can be included in documents. + +\change_deleted 232239728 1604794483 +c +\change_inserted 232239728 1604794486 +C +\change_unchanged +ontains graphics files that can be included in documents. \end_layout @@ -667,14 +796,26 @@ doc/ \end_inset - contains \SpecialChar LyX + +\change_deleted 232239728 1604794492 +c +\change_inserted 232239728 1604794492 +C +\change_unchanged +ontains \SpecialChar LyX documentation files (including the one you are currently reading). The file \begin_inset Flex Code status collapsed \begin_layout Plain Layout + +\change_deleted 232239728 1604794660 \SpecialChar LaTeX + +\change_inserted 232239728 1604794661 +LaTex +\change_unchanged Config.lyx \end_layout @@ -721,7 +862,13 @@ examples/ \end_inset - contains example files that explain how to use some features. + +\change_deleted 232239728 1604794497 +c +\change_inserted 232239728 1604794497 +C +\change_unchanged +ontains example files that explain how to use some features. In the file browser, press the \begin_inset Flex Noun status collapsed @@ -746,7 +893,13 @@ images/ \end_inset - contains image files that are used by the + +\change_deleted 232239728 1604794500 +c +\change_inserted 232239728 1604794500 +C +\change_unchanged +ontains image files that are used by the \begin_inset Flex Noun status collapsed @@ -773,7 +926,13 @@ kbd/ \end_inset - contains keyboard keymapping files. + +\change_deleted 232239728 1604794505 +c +\change_inserted 232239728 1604794505 +C +\change_unchanged +ontains keyboard keymapping files. See \begin_inset CommandInset ref LatexCommand ref @@ -795,7 +954,13 @@ layouts/ \end_inset - contains the text class and module files described in + +\change_deleted 232239728 1604794508 +c +\change_inserted 232239728 1604794508 +C +\change_unchanged +ontains the text class and module files described in \begin_inset CommandInset ref LatexCommand ref reference "cha:Installing-New-Document" @@ -816,7 +981,13 @@ lyx2lyx \end_inset - contains the + +\change_deleted 232239728 1604794513 +c +\change_inserted 232239728 1604794513 +C +\change_unchanged +ontains the \begin_inset Flex Code status collapsed @@ -828,8 +999,11 @@ lyx2lyx Python scripts used to convert between \SpecialChar LyX versions. - These can be run from the command line if, say, you want to batch-convert - files. + These can be run from the command line if +\change_deleted 232239728 1604794749 +, say, +\change_unchanged + you want to batch-convert files. \end_layout \begin_layout Labeling @@ -843,7 +1017,13 @@ scripts/ \end_inset - contains some files that demonstrate the capabilities of the + +\change_deleted 232239728 1604794516 +c +\change_inserted 232239728 1604794516 +C +\change_unchanged +ontains some files that demonstrate the capabilities of the \begin_inset Flex Noun status collapsed @@ -873,7 +1053,13 @@ templates/ \end_inset - contains the standard \SpecialChar LyX + +\change_deleted 232239728 1604794520 +c +\change_inserted 232239728 1604794520 +C +\change_unchanged +ontains the standard \SpecialChar LyX template files described in \begin_inset CommandInset ref LatexCommand ref @@ -895,7 +1081,13 @@ ui/ \end_inset - contains files with the extension + +\change_deleted 232239728 1604794524 +c +\change_inserted 232239728 1604794524 +C +\change_unchanged +ontains files with the extension \begin_inset Flex Code status collapsed @@ -922,7 +1114,13 @@ xtemplates/ \end_inset - contains files with the extension + +\change_deleted 232239728 1604794528 +c +\change_inserted 232239728 1604794528 +C +\change_unchanged +ontains files with the extension \begin_inset Flex Code status collapsed @@ -965,7 +1163,13 @@ CREDITS \end_inset - this file contains the list of \SpecialChar LyX + +\change_deleted 232239728 1604797616 +t +\change_inserted 232239728 1604797616 +T +\change_unchanged +his file contains the list of \SpecialChar LyX developers. The contents are displayed with the menu entry \begin_inset Flex Noun @@ -996,7 +1200,13 @@ chkconfig.ltx \end_inset - this is a \SpecialChar LaTeX + +\change_deleted 232239728 1604797620 +t +\change_inserted 232239728 1604797620 +T +\change_unchanged +his is a \SpecialChar LaTeX script used during the configuration process. Do not run directly. \end_layout @@ -1012,7 +1222,13 @@ configure.py \end_inset - this is a Python script that is used to re-configure \SpecialChar LyX + +\change_deleted 232239728 1604797624 +t +\change_inserted 232239728 1604797624 +T +\change_unchanged +his is a Python script that is used to re-configure \SpecialChar LyX . It creates configuration files in the directory it was run from. \end_layout @@ -1032,7 +1248,13 @@ encodings \end_inset - this contains tables describing how different character encodings can be + +\change_deleted 232239728 1604797580 +t +\change_inserted 232239728 1604797580 +T +\change_unchanged +his contains tables describing how different character encodings can be mapped to Unicode \end_layout @@ -1047,7 +1269,13 @@ languages \end_inset - this file contains a list of all the languages currently supported by \SpecialChar LyX + +\change_deleted 232239728 1604797584 +t +\change_inserted 232239728 1604797584 +T +\change_unchanged +his file contains a list of all the languages currently supported by \SpecialChar LyX . \end_layout @@ -1062,7 +1290,13 @@ latexfonts \end_inset - contains information about the supported fonts. + +\change_deleted 232239728 1604797587 +c +\change_inserted 232239728 1604797587 +C +\change_unchanged +ontains information about the supported fonts. \end_layout \begin_layout Labeling @@ -1076,8 +1310,14 @@ layouttranslations \end_inset - this file contains translations for internationalized paragraph styles - (see + +\change_deleted 232239728 1604797591 +t +\change_inserted 232239728 1604797591 +T +\change_unchanged +his file contains translations for internationalized paragraph styles (see + \begin_inset CommandInset ref LatexCommand ref reference "subsec:I18n" @@ -1098,8 +1338,14 @@ unicodesymbols \end_inset - this file contains information about Unicode-encoded glyphs and the way - they are supported by \SpecialChar LyX + +\change_deleted 232239728 1604797594 +t +\change_inserted 232239728 1604797594 +T +\change_unchanged +his file contains information about Unicode-encoded glyphs and the way they + are supported by \SpecialChar LyX via \SpecialChar LaTeX . \end_layout @@ -1274,10 +1520,19 @@ Settings \end_layout \begin_layout Itemize -If you get some updated documentation from \SpecialChar LyX - ftp site and cannot install - it because you do not have sysadmin rights on your system, you can just - copy the files in +If you get some updated documentation from +\change_inserted 232239728 1604798171 + a +\change_unchanged + \SpecialChar LyX + ftp site and cannot install it because you do not have sysadmin rights + on your system, you can just copy the files +\change_deleted 232239728 1604798193 +in +\change_inserted 232239728 1604798193 +to +\change_unchanged + \begin_inset Flex Code status collapsed @@ -1308,8 +1563,11 @@ Running \SpecialChar LyX \begin_layout Standard The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal. - For example, you may want to be use different key bindings or printer settings - at different times. + For example, you may want to +\change_deleted 232239728 1604798238 +be +\change_unchanged +use different key bindings or printer settings at different times. You can achieve this by having several such directories. You then specify which directory to use at run-time. \end_layout @@ -1345,8 +1603,11 @@ status collapsed switch.) If the specified directory does not exist, \SpecialChar LyX offers to create it - for you, just like it does for the default directory on the first time - you run the program. + for you, just like it does for the default directory +\change_deleted 232239728 1604798318 +on +\change_unchanged + the first time you run the program. You can modify the configuration options in this additional user directory exactly as you would for the default directory. These directories are completely independent (but read on). @@ -1355,7 +1616,7 @@ status collapsed status collapsed \begin_layout Plain Layout -LYX_USERDIR_VER +LYX_USERDIR_24x \end_layout \end_inset @@ -1405,7 +1666,13 @@ Reconfigure \end_inset -) which is configuration-specific. +) which is configuration +\change_deleted 232239728 1604798083 +- +\change_inserted 232239728 1604798100 + +\change_unchanged +specific. \end_layout \begin_layout Chapter @@ -2519,6 +2786,8 @@ status open \change_inserted -712698321 1524657030 flavor +\change_unchanged + \end_layout \end_inset @@ -2532,6 +2801,8 @@ status collapsed \change_inserted -712698321 1524657047 .aux +\change_unchanged + \end_layout \end_inset @@ -2544,6 +2815,8 @@ status open \change_inserted -712698321 1524657030 latex, pdflatex, platex, xetex, luatex +\change_unchanged + \end_layout \end_inset @@ -2557,6 +2830,8 @@ status open \change_inserted -712698321 1524657030 latex +\change_unchanged + \end_layout \end_inset @@ -2648,6 +2923,8 @@ status collapsed \change_inserted -712698321 1523206193 hyperref-driver +\change_unchanged + \end_layout \end_inset @@ -5902,6 +6179,10 @@ Preferences \end_layout \begin_layout Chapter + +\change_inserted -584632292 1610232084 +Creating and +\change_unchanged Installing New Document Classes, Layouts, and Templates \begin_inset CommandInset label LatexCommand label @@ -9003,6 +9284,8 @@ status collapsed \change_inserted -712698321 1526898610 AddToCiteEngine +\change_unchanged + \end_layout \end_inset @@ -9138,6 +9421,8 @@ status collapsed \change_inserted -712698321 1562592954 BibInToc +\change_unchanged + \end_layout \end_inset @@ -9152,6 +9437,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -9168,6 +9455,8 @@ status collapsed \change_inserted -712698321 1562592950 1 +\change_unchanged + \end_layout \end_inset @@ -9653,11 +9942,17 @@ Standard \end_layout \begin_layout Description + +\change_inserted -970929547 1515112870 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -ExcludesModule + +\change_inserted -970929547 1515112782 +DocBookRoot +\change_unchanged + \end_layout \end_inset @@ -9667,88 +9962,109 @@ ExcludesModule status collapsed \begin_layout Plain Layout - -\end_layout - -\end_inset -] This tag indicates that the module (which is specified by filename without - the -\begin_inset Flex Code -status collapsed +\change_inserted -970929547 1515112766 +string +\change_unchanged -\begin_layout Plain Layout -.module \end_layout \end_inset - extension) cannot be used with this document class. - This might be used in a journal-specific layout file to prevent, say, the - use of the +] The root element (at the top of the document) to use when outputting documents + with this class in DocBook. + The default value is +\begin_inset Quotes eld +\end_inset + + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -theorems-sec + +\change_inserted -970929547 1515112845 +article +\change_unchanged + \end_layout \end_inset - module that numbers theorems by section. - This tag may -\emph on -not -\emph default - be used in a module. - Modules have their own way of excluding other modules (see -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Layout-modules" +\begin_inset Quotes erd \end_inset -). +. + +\change_deleted 1075283030 1594226862 + +\change_inserted 1075283030 1594226777 + \end_layout \begin_layout Description + +\change_inserted 1075283030 1594226859 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Float + +\change_inserted 1075283030 1594226785 +DocBookForceAbstract +\change_unchanged + \end_layout \end_inset - Defines a new float. - See -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Floats" + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted 1075283030 1594226804 +boolean +\change_unchanged + +\end_layout \end_inset - for details. - Must end with +] If \begin_inset Quotes eld \end_inset -\begin_inset Flex Code -status collapsed +\family typewriter +true +\family default -\begin_layout Plain Layout -End -\end_layout +\begin_inset Quotes erd +\end_inset +, the root element will always have an +\family typewriter + +\family default + tag. + The default value is +\begin_inset Quotes eld \end_inset +\family typewriter +false +\family default + \begin_inset Quotes erd \end_inset . +\change_unchanged + \end_layout \begin_layout Description @@ -9756,24 +10072,123 @@ End status collapsed \begin_layout Plain Layout -HTMLPreamble +ExcludesModule \end_layout \end_inset - Sets the information that will be output in the + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout - + \end_layout \end_inset - block when this document class is output to XHTML. - Note that this will completely override any prior -\begin_inset Flex Code +] This tag indicates that the module (which is specified by filename without + the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +.module +\end_layout + +\end_inset + + extension) cannot be used with this document class. + This might be used in a journal-specific layout file to prevent, say, the + use of the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +theorems-sec +\end_layout + +\end_inset + + module that numbers theorems by section. + This tag may +\emph on +not +\emph default + be used in a module. + Modules have their own way of excluding other modules (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Layout-modules" + +\end_inset + +). +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Float +\end_layout + +\end_inset + + Defines a new float. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Floats" + +\end_inset + + for details. + Must end with +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +End +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLPreamble +\end_layout + +\end_inset + + Sets the information that will be output in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + block when this document class is output to XHTML. + Note that this will completely override any prior +\begin_inset Flex Code status collapsed \begin_layout Plain Layout @@ -9962,6 +10377,131 @@ stdclass.inc \end_inset , which contains most of the basic layouts. +\change_inserted -712698321 1611646803 + +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1611646804 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646837 +InputGlobal +\change_unchanged + +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646804 + +\change_unchanged + +\end_layout + +\end_inset + +] is a variant of the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646804 +Input +\change_unchanged + +\end_layout + +\end_inset + + command which does not look for files in the user directory. + This allows to create a file +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646804 +name.layout +\change_unchanged + +\end_layout + +\end_inset + + or +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646804 +name.inc +\change_unchanged + +\end_layout + +\end_inset + + in the user directory which includes a global file with the same name via + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646853 +InputGlobal name +\change_unchanged + +\end_layout + +\end_inset + + or +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646855 +InputGlobal name.inc +\change_unchanged + +\end_layout + +\end_inset + +, respectively (with +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1611646804 +Input +\change_unchanged + +\end_layout + +\end_inset + +, the file would recursively include itself). + This way, you can modify global files without having to completely copy + them. +\change_unchanged + \end_layout \begin_layout Description @@ -10114,6 +10654,63 @@ noprefix "false" ). \end_layout +\begin_layout Description + +\change_inserted -712698321 1612018485 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018457 +ModifyInsetLayout +\change_unchanged + +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018466 + +\change_unchanged + +\end_layout + +\end_inset + +] Modifies the layout of an inset. + If the layout does not exist, this section is ignored. + Must end with +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018452 +End +\change_unchanged + +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. +\end_layout + \begin_layout Description \begin_inset Flex Code status collapsed @@ -10540,6 +11137,8 @@ status collapsed \change_inserted -712698321 1565102365 PageSize +\change_unchanged + \end_layout \end_inset @@ -10557,6 +11156,8 @@ custom \emph default , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3, b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j +\change_unchanged + \end_layout \end_inset @@ -10686,6 +11287,67 @@ EndPreamble \end_inset . +\change_inserted -712698321 1612018500 + +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1612018547 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018506 +ProvideInsetLayout +\change_unchanged + +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018509 + +\change_unchanged + +\end_layout + +\end_inset + +] Defines the layout of an inset if it does not already exist. + If the layout does exist, this section is ignored. + Must end with +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1612018500 +End +\change_unchanged + +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. +\change_unchanged + \end_layout \begin_layout Description @@ -11158,6 +11820,8 @@ status collapsed \change_inserted -712698321 1553617809 TableStyle +\change_unchanged + \end_layout \end_inset @@ -11170,6 +11834,8 @@ status collapsed \change_inserted -712698321 1553617805 +\change_unchanged + \end_layout \end_inset @@ -11218,6 +11884,8 @@ status collapsed \change_inserted -712698321 1554308042 Formal_without_Footline +\change_unchanged + \end_layout \end_inset @@ -11236,6 +11904,8 @@ status collapsed \change_inserted -712698321 1553618006 Simple_Grid +\change_unchanged + \end_layout \end_inset @@ -11253,6 +11923,8 @@ status collapsed \change_inserted -712698321 1553618031 Grid_with_Head +\change_unchanged + \end_layout \end_inset @@ -11265,11 +11937,19 @@ status collapsed \change_inserted -712698321 1553618043 Simple_Grid +\change_unchanged + \end_layout \end_inset -, but with the header column offset with a second horizontal line. +, but with the header +\change_deleted 34634807 1619712593 +column +\change_inserted 34634807 1619712594 +row +\change_inserted -712698321 1553618309 + offset with a second horizontal line. This is also the default style of \SpecialChar LyX . \end_layout @@ -11284,6 +11964,8 @@ status collapsed \change_inserted -712698321 1553618261 No_Borders +\change_unchanged + \end_layout \end_inset @@ -11572,6 +12254,8 @@ status collapsed \change_inserted -712698321 1565110199 FontSizeFormat +\change_unchanged + \end_layout \end_inset @@ -11584,6 +12268,8 @@ status collapsed \change_inserted -712698321 1565110196 string +\change_unchanged + \end_layout \end_inset @@ -11612,6 +12298,8 @@ status collapsed \change_inserted -712698321 1565110248 $$s +\change_unchanged + \end_layout \end_inset @@ -11661,6 +12349,8 @@ status collapsed \change_inserted -712698321 1565101918 PageSize +\change_unchanged + \end_layout \end_inset @@ -11704,6 +12394,8 @@ b3j|\SpecialChar allowbreak b4j|\SpecialChar allowbreak b5j|\SpecialChar allowbreak b6j" +\change_unchanged + \end_layout \end_inset @@ -11720,6 +12412,8 @@ status collapsed \change_inserted -712698321 1565101779 | +\change_unchanged + \end_layout \end_inset @@ -11743,6 +12437,8 @@ status collapsed \change_inserted -712698321 1565180605 PageSizeFormat +\change_unchanged + \end_layout \end_inset @@ -11755,6 +12451,8 @@ status collapsed \change_inserted -712698321 1565180601 string +\change_unchanged + \end_layout \end_inset @@ -11768,6 +12466,8 @@ status collapsed \change_inserted -712698321 1565180618 $$spaper +\change_unchanged + \end_layout \end_inset @@ -11781,6 +12481,8 @@ status collapsed \change_inserted -712698321 1565180601 $$s +\change_unchanged + \end_layout \end_inset @@ -12050,7 +12752,41 @@ int ] Defines argument number of a command\SpecialChar breakableslash environment associated with the current style. - This is useful for things like section headings, and only makes sense with + +\change_inserted -584632292 1615846868 + The definition must end with +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -584632292 1615846867 +EndArgument +\change_unchanged + +\end_layout + +\end_inset + +. + +\change_unchanged + +\change_inserted -584632292 1615846880 +See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Arguments" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + for more information. + +\change_deleted -584632292 1615846694 +This is useful for things like section headings, and only makes sense with \SpecialChar LaTeX . Every (optional or required) argument of a command or environment – except @@ -12074,41 +12810,55 @@ EndArgument \begin_deeper \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter Argument 1 \end_layout \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter ... \end_layout \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter EndArgument \end_layout \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter Argument 2 \end_layout \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter ... \end_layout \begin_layout Quote +\change_deleted -584632292 1615846694 + \family typewriter EndArgument \end_layout \begin_layout Standard + +\change_deleted -584632292 1615846694 Inside the \begin_inset Flex Code status collapsed @@ -12123,6 +12873,8 @@ Argument \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12193,6 +12945,8 @@ Short Title|S \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12264,6 +13018,8 @@ LabelString \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12288,6 +13044,8 @@ status collapsed \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12347,13 +13105,11 @@ status collapsed \end_inset -\change_inserted -712698321 1555579782 - \end_layout \begin_layout Itemize -\change_inserted -712698321 1555579780 +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12361,6 +13117,8 @@ status collapsed \change_inserted -712698321 1555579780 NewlineCmd +\change_unchanged + \end_layout \end_inset @@ -12373,6 +13131,8 @@ status collapsed \change_inserted -712698321 1555579780 [string] +\change_unchanged + \end_layout \end_inset @@ -12389,17 +13149,19 @@ status collapsed \backslash +\change_unchanged + \end_layout \end_inset ) to be used for line breaks. The initial backslash must not be specified. -\change_unchanged - \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12464,6 +13226,8 @@ Argument 2 \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12518,6 +13282,8 @@ status collapsed \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12572,6 +13338,8 @@ status collapsed \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12606,6 +13374,8 @@ if no argument inset has been inserted (note that also an empty argument \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12631,6 +13401,8 @@ status collapsed \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12648,13 +13420,11 @@ reference "subsec:Font-description" \end_inset . -\change_inserted -712698321 1559484228 - \end_layout \begin_layout Itemize -\change_inserted -712698321 1559484228 +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12662,6 +13432,8 @@ status collapsed \change_inserted -712698321 1559484228 FreeSpacing +\change_unchanged + \end_layout \end_inset @@ -12676,6 +13448,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -12692,6 +13466,8 @@ status collapsed \change_inserted -712698321 1559484228 1 +\change_unchanged + \end_layout \end_inset @@ -12704,11 +13480,11 @@ reference "subsec:Paragraph-Styles" \end_inset . -\change_unchanged - \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12729,6 +13505,8 @@ reference "subsec:Font-description" \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12756,6 +13534,8 @@ Classic \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12790,13 +13570,13 @@ status collapsed \change_deleted -712698321 1559484200 Currently, only one argument per style\SpecialChar breakableslash layout can be automatically inserted. -\change_unchanged +\change_deleted -584632292 1615846694 \end_layout \begin_layout Itemize -\change_inserted -712698321 1559491402 +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12804,6 +13584,8 @@ status collapsed \change_inserted -712698321 1559490711 InsertOnNewline +\change_unchanged + \end_layout \end_inset @@ -12816,6 +13598,8 @@ status collapsed \change_inserted -712698321 1559490703 [int=0] +\change_unchanged + \end_layout \end_inset @@ -12828,6 +13612,8 @@ status collapsed \change_inserted -712698321 1559490703 1 +\change_unchanged + \end_layout \end_inset @@ -12840,6 +13626,8 @@ status collapsed \change_inserted -712698321 1559491402 AutoInsert +\change_unchanged + \end_layout \end_inset @@ -12848,6 +13636,8 @@ AutoInsert \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12882,6 +13672,8 @@ status collapsed \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12923,6 +13715,8 @@ PassThru \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -12960,6 +13754,8 @@ that should be output in raw form, meaning without special translations \end_layout \begin_layout Itemize + +\change_deleted -584632292 1615846694 \begin_inset Flex Code status collapsed @@ -13001,6 +13797,8 @@ status collapsed \end_layout \begin_layout Standard + +\change_deleted -584632292 1615846694 By default, the text entered in the \SpecialChar LyX workarea in the respective layout is the last (mandatory) argument of a command if the @@ -13071,6 +13869,8 @@ Command \end_layout \begin_layout Standard + +\change_deleted -584632292 1615846694 Arguments for list \begin_inset Flex Code status collapsed @@ -13124,13 +13924,11 @@ Argument item:1 \end_inset ). -\change_inserted -712698321 1534487781 - \end_layout \begin_layout Standard -\change_inserted -712698321 1534488561 +\change_deleted -584632292 1615846694 Finally, there is a special argument type with the prefix \begin_inset Flex Code status collapsed @@ -13160,6 +13958,8 @@ status collapsed \change_inserted -712698321 1534488412 Argument listpreamble:1 +\change_unchanged + \end_layout \end_inset @@ -13797,7 +14597,11 @@ FreeSpacing Note that \change_unchanged \SpecialChar LyX - will create protected blanks for the additional blanks when in + will create protected blanks for the additional blanks when +\change_deleted 34634807 1619626461 + in +\change_unchanged + \change_inserted -495245474 1550490096 \begin_inset Flex Code @@ -13807,6 +14611,8 @@ status collapsed \change_inserted -495245474 1550490089 Passthru 1 +\change_unchanged + \end_layout \end_inset @@ -13825,6 +14631,8 @@ status collapsed \change_inserted -495245474 1550247736 FreeSpacing +\change_unchanged + \end_layout \end_inset @@ -13837,6 +14645,8 @@ status collapsed \change_inserted -495245474 1550247755 KeepEmpty +\change_unchanged + \end_layout \end_inset @@ -15816,6 +16626,8 @@ status collapsed \change_inserted -712698321 1523696950 NeedCProtect +\change_unchanged + \end_layout \end_inset @@ -15830,6 +16642,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -15846,6 +16660,8 @@ status collapsed \change_inserted -712698321 1523696950 1 +\change_unchanged + \end_layout \end_inset @@ -15860,6 +16676,8 @@ status collapsed \backslash cprotect +\change_unchanged + \end_layout \end_inset @@ -15882,6 +16700,8 @@ status collapsed \change_inserted -712698321 1552395561 NeedMBoxProtect +\change_unchanged + \end_layout \end_inset @@ -15896,6 +16716,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -15912,6 +16734,8 @@ status collapsed \change_inserted -712698321 1552395557 1 +\change_unchanged + \end_layout \end_inset @@ -17012,7 +17836,13 @@ status collapsed status collapsed \begin_layout Plain Layout -StepMasterCounter +Step +\change_deleted 731793113 1604355211 +Master +\change_inserted 731793113 1604355212 +Parent +\change_unchanged +Counter \end_layout \end_inset @@ -17039,8 +17869,13 @@ status collapsed \end_inset -] Steps the master counter of a given counter at the beginning of a new - sequence of layouts. +] Steps the +\change_deleted 731793113 1604355214 +master +\change_inserted 731793113 1604355216 +parent +\change_unchanged + counter of a given counter at the beginning of a new sequence of layouts. This is currently only useful when \begin_inset Flex Code status collapsed @@ -18446,6 +19281,8 @@ status collapsed \change_inserted -712698321 1565605014 Requires +\change_unchanged + \end_layout \end_inset @@ -18458,6 +19295,8 @@ status collapsed \change_inserted -712698321 1565605014 string +\change_unchanged + \end_layout \end_inset @@ -19108,7 +19947,7 @@ name \end_inset - may be be any valid identifier not used by a pre-existing Flex inset. + may be any valid identifier not used by a pre-existing Flex inset. The identifier may include spaces, but in that case the whole thing must be wrapped in quotes. Note that the definition of a flex inset @@ -19168,7 +20007,7 @@ name \end_inset - may be be any valid identifier of branch defined in user's document. + may be any valid identifier of branch defined in user's document. The identifier may include spaces, but in that case the whole thing must be wrapped in quotes. The main purpose of this feature is to allow \SpecialChar LaTeX @@ -19348,13 +20187,35 @@ EndArgument . See +\change_inserted -584632292 1615846847 + +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Arguments" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + +\change_deleted -584632292 1615846847 + \begin_inset CommandInset ref LatexCommand ref reference "subsec:Paragraph-Styles" \end_inset - for details. + +\change_unchanged + for +\change_deleted -584632292 1615846902 +details +\change_inserted -584632292 1615846906 +more information +\change_unchanged +. \end_layout \begin_layout Description @@ -20040,9 +20901,9 @@ status collapsed \end_inset -] Force a a line break in the \SpecialChar LaTeX - output before the inset starts and after - the inset ends. +] Force a line break in the \SpecialChar LaTeX + output before the inset starts and after the + inset ends. This assures the inset itself is output on its own lines, for parsing purposes. \end_layout @@ -20715,6 +21576,8 @@ custom \end_inset , +\change_deleted -584632292 1615846609 + \begin_inset Flex Code status collapsed @@ -20724,7 +21587,9 @@ element \end_inset - or + +\change_unchanged +or \begin_inset Flex Code status collapsed @@ -20837,6 +21702,8 @@ status collapsed \change_inserted -712698321 1555575740 MenuString +\change_unchanged + \end_layout \end_inset @@ -20849,6 +21716,8 @@ status collapsed \change_inserted -712698321 1555575740 [string] +\change_unchanged + \end_layout \end_inset @@ -20883,6 +21752,8 @@ status collapsed \change_inserted -712698321 1555575781 My Inset|M +\change_unchanged + \end_layout \end_inset @@ -21043,6 +21914,8 @@ status collapsed \change_inserted -712698321 1523633961 NeedCProtect +\change_unchanged + \end_layout \end_inset @@ -21057,6 +21930,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -21073,6 +21948,8 @@ status collapsed \change_inserted -712698321 1523633958 1 +\change_unchanged + \end_layout \end_inset @@ -21112,6 +21989,8 @@ status collapsed \change_inserted -712698321 1552395787 NeedMBoxProtect +\change_unchanged + \end_layout \end_inset @@ -21126,6 +22005,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -21142,6 +22023,8 @@ status collapsed \change_inserted -712698321 1552395787 1 +\change_unchanged + \end_layout \end_inset @@ -21156,6 +22039,8 @@ status collapsed \backslash cite +\change_unchanged + \end_layout \end_inset @@ -21170,6 +22055,8 @@ status collapsed \backslash ref +\change_unchanged + \end_layout \end_inset @@ -21184,6 +22071,8 @@ status collapsed \backslash mbox +\change_unchanged + \end_layout \end_inset @@ -21211,6 +22100,8 @@ status collapsed \change_inserted -712698321 1555579658 NewlineCmd +\change_unchanged + \end_layout \end_inset @@ -21223,6 +22114,8 @@ status collapsed \change_inserted -712698321 1555579651 [string] +\change_unchanged + \end_layout \end_inset @@ -21350,6 +22243,8 @@ status collapsed \change_inserted -712698321 1559491854 ParbreakIgnored +\change_unchanged + \end_layout \end_inset @@ -21364,6 +22259,8 @@ status collapsed \emph on 0 +\change_unchanged + \end_layout \end_inset @@ -21380,6 +22277,8 @@ status collapsed \change_inserted -712698321 1559491850 1 +\change_unchanged + \end_layout \end_inset @@ -21650,6 +22549,8 @@ ResetsFont status collapsed \begin_layout Plain Layout + +\emph on 0 \end_layout @@ -21664,167 +22565,212 @@ status collapsed status collapsed \begin_layout Plain Layout - -\emph on 1 \end_layout \end_inset -] Whether this inset should use the font of its surrounding environment - or uses its own. - Default is false: use the font of the surrounding environment. -\end_layout - -\begin_layout Description +] +\change_inserted -712698321 1597733473 +If \begin_inset Flex Code status collapsed \begin_layout Plain Layout -RightDelim + +\change_inserted -712698321 1597732178 +1 +\change_unchanged + \end_layout \end_inset - [ +, font changes are redone inside the respective inset (in the output) even + if the inset itself is in the context of this font changes (e. +\begin_inset space \thinspace{} +\end_inset + +g., \begin_inset Flex Code status collapsed \begin_layout Plain Layout -string + +\change_inserted -712698321 1597733683 + +\backslash +textbf{Sourrounding text +\backslash +myinset{ +\backslash +textbf{content}}\SpecialChar ldots +} +\change_unchanged + \end_layout \end_inset -] A string that is put at the end of the layout content. - A line break in the output can be indicated by + rather than \begin_inset Flex Code status collapsed \begin_layout Plain Layout -
+ +\change_inserted -712698321 1597733686 + +\backslash +textbf{Sourrounding text +\backslash +myinset{content}\SpecialChar ldots +} +\change_unchanged + \end_layout \end_inset . -\end_layout + Setting this makes sense for commands that internally reset font settings + (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Description +g., footnotes). + Note that wrongly setting this might lead to unwanted result (e. +\begin_inset space \thinspace{} +\end_inset + +g., with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Spellcheck + +\change_inserted -712698321 1597733688 + +\backslash +emph{Sourrounding text +\backslash +myinset{ +\backslash +emph{content}}\SpecialChar ldots +} +\change_unchanged + \end_layout \end_inset - [ +, content is upright, as \begin_inset Flex Code status collapsed \begin_layout Plain Layout -0 -\end_layout -\end_inset +\change_inserted -712698321 1597733278 + +\backslash +emph +\change_unchanged + +\end_layout -, -\begin_inset space \thinspace{} \end_inset + toggles. + +\change_deleted -712698321 1597733283 +Whether this inset should use the font of its surrounding environment or + uses its own. + +\change_unchanged +Default is +\change_deleted -712698321 1597733290 +false +\change_inserted -712698321 1597733290 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\emph on -1 -\end_layout - -\end_inset +\change_inserted -712698321 1597733292 +0 +\change_unchanged -] Allow spell-checking the contents of this inset. - Default is true. \end_layout -\begin_layout Subsection -Counters -\begin_inset CommandInset label -LatexCommand label -name "subsec:Counters" - \end_inset +\change_unchanged +: +\change_deleted -712698321 1597733327 +use the font of the surrounding environment +\change_inserted -712698321 1597733343 +font changes are not redone inside the inset +\change_unchanged +. \end_layout -\begin_layout Standard -It is necessary to define the counters ( -\begin_inset Flex Noun +\begin_layout Description +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -chapter +RightDelim \end_layout \end_inset -, -\begin_inset Flex Noun + [ +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -figure +string \end_layout \end_inset -, \SpecialChar ldots -) in the text class itself. - The standard counters are defined in the file +] A string that is put at the end of the layout content. + A line break in the output can be indicated by \begin_inset Flex Code status collapsed \begin_layout Plain Layout -stdcounters.inc +
\end_layout \end_inset -, so you may have to do no more than add +. \end_layout -\begin_layout LyX-Code -Input stdcounters.inc -\end_layout +\begin_layout Description +\begin_inset Flex Code +status collapsed -\begin_layout Standard -to your layout file to get them to work. - But if you want to define custom counters, then you can do so. - The counter declaration must begin with: +\begin_layout Plain Layout +Spellcheck \end_layout -\begin_layout LyX-Code -Counter CounterName -\end_layout +\end_inset -\begin_layout Standard -where of course ` + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -CounterName +0 \end_layout \end_inset -' is replaced by the name of the counter. - And it must end with -\begin_inset Quotes eld +, +\begin_inset space \thinspace{} \end_inset @@ -21832,138 +22778,197 @@ CounterName status collapsed \begin_layout Plain Layout -End + +\emph on +1 \end_layout \end_inset +] Allow spell-checking the contents of this inset. + Default is true. +\change_inserted -584632292 1615846659 + +\end_layout + +\begin_layout Subsection + +\change_inserted -584632292 1615846729 +Arguments +\begin_inset CommandInset label +LatexCommand label +name "subsec:Arguments" -\begin_inset Quotes erd \end_inset -. - The following parameters can also be used: + \end_layout -\begin_layout Description +\begin_layout Standard + +\change_inserted -584632292 1615846807 +Both paragraph styles and inset layouts allow for +\emph on +arguments +\emph default + as well as the main content. + This is especially useful for things like section headings and only makes + sense with \SpecialChar LaTeX +. + Each (optional or required) argument of a command or environment—except + for the required argument that is associated with the content—has a separate + definition, where the number specifies the order of the arguments. + The definition must end with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -InitialValue + +\change_inserted -584632292 1615846730 +EndArgument +\change_unchanged + \end_layout \end_inset - [ -\begin_inset Flex Code -status collapsed +. + So a command with two optional arguments looks like: +\end_layout -\begin_layout Plain Layout -int=1 +\begin_layout Quote + +\change_inserted -584632292 1615846730 + +\family typewriter +Argument 1 \end_layout -\end_inset +\begin_layout Quote -] Sets the initial value for the counter, to which it will be reset whenever - that happens. - Normally, one will want the default, 1. +\change_inserted -584632292 1615846730 + +\family typewriter +... \end_layout -\begin_layout Description -\begin_inset Flex Code -status collapsed +\begin_layout Quote -\begin_layout Plain Layout -LabelString +\change_inserted -584632292 1615846730 + +\family typewriter +EndArgument \end_layout -\end_inset +\begin_layout Quote - [ -\begin_inset Flex Code -status collapsed +\change_inserted -584632292 1615846730 -\begin_layout Plain Layout -string +\family typewriter +Argument 2 \end_layout -\end_inset +\begin_layout Quote -= -\begin_inset Quotes erd -\end_inset +\change_inserted -584632292 1615846730 +\family typewriter +... +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Quote -] When defined, this string defines how the counter is displayed. - Setting this value sets +\change_inserted -584632292 1615846730 + +\family typewriter +EndArgument +\end_layout + +\begin_layout Standard + +\change_inserted -584632292 1615846730 +Inside the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LabelStringAppendix + +\change_inserted -584632292 1615846730 +Argument +\change_unchanged + \end_layout \end_inset - to the same value. - The following special constructs can be used in the string: + definition, the following specifications are possible: \end_layout -\begin_deeper \begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\backslash -thecounter +\change_inserted -584632292 1615846730 +LabelString +\change_unchanged + \end_layout \end_inset - will be replaced by the expansion of the + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LabelString + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset - (or + The string that will appear both in the menu (to insert this argument) + and on the argument inset button (unless you also specify a separate \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LabelStringAppendix + +\change_inserted -584632292 1615846730 +MenuString +\change_unchanged + \end_layout \end_inset -) of the counter -\begin_inset Flex Code -status collapsed +). + For the menu, you can define an accelerator by appending the respective + character to the string, divided by +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -counter -\end_layout +| +\begin_inset Quotes erd +\end_inset + (e. +\begin_inset space \thinspace{} \end_inset -. - -\end_layout +g. +\begin_inset space \space{} +\end_inset -\begin_layout Itemize -counter values can be expressed using \SpecialChar LaTeX --like macros -\begin_inset Newline newline + +\begin_inset Quotes eld \end_inset @@ -21972,67 +22977,33 @@ status collapsed \begin_layout Plain Layout -\backslash +\change_inserted -584632292 1615846730 +Short Title|S +\change_unchanged -\emph on -numbertype -\emph default -{ -\emph on -counter -\emph default -} \end_layout \end_inset -, where -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\begin_inset Quotes erd +\end_inset -\emph on -numbertype +). \end_layout -\end_inset +\begin_layout Itemize - can be: -\begin_inset Foot +\change_inserted -584632292 1615846730 +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Actually, the situation is a bit more complicated: any -\family default -\series default -\shape default -\emph default -\bar default - -\size default -\emph on -\noun default -\color inherit -numbertype -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off - other than those described below will produce arabic numerals. - It would not be surprising to see this change in the future. +\change_inserted -584632292 1615846730 +MenuString +\change_unchanged + \end_layout \end_inset @@ -22042,536 +23013,599 @@ numbertype status collapsed \begin_layout Plain Layout -arabic + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -: 1, 2, 3,\SpecialChar ldots -; -\begin_inset Flex Code -status collapsed + A separate string for the menu. + You can define an accelerator by appending the respective character to + the string, divided by +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -alph -\end_layout +| +\begin_inset Quotes erd +\end_inset + (e. +\begin_inset space \thinspace{} \end_inset - for lower-case letters: a, b, c, \SpecialChar ldots -; -\begin_inset Flex Code -status collapsed +g. +\begin_inset space \space{} +\end_inset -\begin_layout Plain Layout -Alph -\end_layout +\begin_inset Quotes eld \end_inset - for upper-case letters: A, B, C, \SpecialChar ldots -; + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -roman + +\change_inserted -584632292 1615846730 +Short Title|S +\change_unchanged + \end_layout \end_inset - for lower-case roman numerals: i, ii, iii, \SpecialChar ldots -; -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -Roman -\end_layout +\begin_inset Quotes erd \end_inset - for upper-case roman numerals: I, II, III\SpecialChar ldots -; +). + This specification is optional. + If it is not given the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -hebrew + +\change_inserted -584632292 1615846730 +LabelString +\change_unchanged + \end_layout \end_inset - for hebrew numerals. + will be used instead for the menu. \end_layout -\end_deeper -\begin_layout Standard -If LabelString is not defined, a default value is constructed as follows: - if the counter has a master counter +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -master + +\change_inserted -584632292 1615846730 +Tooltip +\change_unchanged + \end_layout \end_inset - (defined via + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Within + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -), the string -\begin_inset Newline newline -\end_inset + A longer explanatory text that appears in the tooltip when hovering over + the argument inset. +\end_layout +\begin_layout Itemize +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\backslash -themaster. -\backslash -arabic{counter} +\change_inserted -584632292 1615846730 +Mandatory +\change_unchanged + \end_layout \end_inset - is used; otherwise the string + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\backslash -arabic{counter} +\change_inserted -584632292 1615846730 + +\emph on +0 +\change_unchanged + \end_layout \end_inset - is used. -\end_layout +, +\begin_inset space \thinspace{} +\end_inset + -\begin_layout Description \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LabelStringAppendix + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset - [ +] Declare if this is a mandatory (1) or an optional (0) argument. + Mandatory arguments will be output empty if not given, while optional arguments + will not be output at all. + By default, mandatory arguments are delimited by \begin_inset Flex Code status collapsed \begin_layout Plain Layout -string -\end_layout - -\end_inset -= -\begin_inset Quotes erd -\end_inset +\change_inserted -584632292 1615846730 +{...} +\change_unchanged +\end_layout -\begin_inset Quotes erd \end_inset -] Same as +, while optional arguments are delimited by \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LabelString + +\change_inserted -584632292 1615846730 +[...] +\change_unchanged + \end_layout \end_inset -, but for use in the Appendix. + \end_layout -\begin_layout Description +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -PrettyFormat + +\change_inserted -584632292 1615846730 +NewlineCmd +\change_unchanged + \end_layout \end_inset - [ + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -string + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -= -\begin_inset Quotes erd -\end_inset + Option to define a different command (from the default +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout -\begin_inset Quotes erd -\end_inset +\change_inserted -584632292 1615846730 -] A format for use with formatted references to this counter. - For example, one might want to have references to section numbers appear - as -\begin_inset Quotes eld -\end_inset +\backslash -Section 2.4 -\begin_inset Quotes erd -\end_inset +\backslash -. - The string should contain -\begin_inset Quotes eld -\end_inset +\change_unchanged + +\end_layout -## -\begin_inset Quotes erd \end_inset -. - This will be replaced by the counter number itself. - So, for sections, it would be: Section ##. +) to be used for line breaks. + The initial backslash must not be specified. \end_layout -\begin_layout Description +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Within + +\change_inserted -584632292 1615846730 +Requires +\change_unchanged + \end_layout \end_inset - [ + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -string -\end_layout -\end_inset +\change_inserted -584632292 1615846730 +[int=0] +\change_unchanged -= -\begin_inset Quotes erd -\end_inset +\end_layout +\end_inset -\begin_inset Quotes erd + defines another argument (by its number) which this argument requires to + be output if it is itself output. + E. +\begin_inset space \thinspace{} \end_inset -] If this is set to the name of another counter, the present counter will - be reset every time the other one is increased. - For example, +g., in \SpecialChar LaTeX + commands, optional arguments often require previous optional arguments + to be output (at least empty), as in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -subsection + +\change_inserted -584632292 1615846730 + +\backslash +command[][argument]{text} +\change_unchanged + \end_layout \end_inset - is numbered inside +. + This can be achieved by the statement \begin_inset Flex Code status collapsed \begin_layout Plain Layout -section -\end_layout -\end_inset +\change_inserted -584632292 1615846730 +Requires 1 +\change_unchanged -. \end_layout -\begin_layout Subsection -Font description -\begin_inset CommandInset label -LatexCommand label -name "subsec:Font-description" - \end_inset + within +\begin_inset Flex Code +status collapsed -\end_layout +\begin_layout Plain Layout -\begin_layout Standard -A font description looks like this: -\end_layout +\change_inserted -584632292 1615846730 +Argument 2 +\change_unchanged -\begin_layout LyX-Code -Font -\family roman -\emph on -or -\family default -\emph default - LabelFont -\emph on - -\family roman -or -\family default -\emph default - DefaultFont \end_layout -\begin_layout LyX-Code - ... -\end_layout +\end_inset -\begin_layout LyX-Code -EndFont +. \end_layout -\begin_layout Standard -The following commands are available: -\end_layout +\begin_layout Itemize -\begin_layout Description +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Color + +\change_inserted -584632292 1615846730 +LeftDelim +\change_unchanged + \end_layout \end_inset - [ + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\emph on -none +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -, + defines a custom left delimiter (instead of \begin_inset Flex Code status collapsed \begin_layout Plain Layout -black + +\change_inserted -584632292 1615846730 +{ +\change_unchanged + \end_layout \end_inset -, + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -white + +\change_inserted -584632292 1615846730 +[ +\change_unchanged + \end_layout \end_inset -, +). + A line break in the output can be indicated by \begin_inset Flex Code status collapsed \begin_layout Plain Layout -red + +\change_inserted -584632292 1615846730 +
+\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -green +. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -blue + +\change_inserted -584632292 1615846730 +RightDelim +\change_unchanged + \end_layout \end_inset -, + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -cyan + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -, + defines a custom right delimiter (instead of \begin_inset Flex Code status collapsed \begin_layout Plain Layout -magenta + +\change_inserted -584632292 1615846730 +} +\change_unchanged + \end_layout \end_inset -, + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -yellow + +\change_inserted -584632292 1615846730 +] +\change_unchanged + \end_layout \end_inset -, +). + A line break in the output can be indicated by \begin_inset Flex Code status collapsed \begin_layout Plain Layout -brown + +\change_inserted -584632292 1615846730 +
+\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -darkgray +. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -gray + +\change_inserted -584632292 1615846730 +DefaultArg +\change_unchanged + \end_layout \end_inset -, + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lightgray + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed + defines an argument that is inserted if and only if no user-specified arguments + were given, i. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Plain Layout -lime +e. +\begin_inset space \space{} +\end_inset + +if no argument inset has been inserted (note that also an empty argument + inset omits the DefaultArg). + Multiple arguments need to be separated by comma. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -orange + +\change_inserted -584632292 1615846730 +PresetArg +\change_unchanged + \end_layout \end_inset -, + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -olive + +\change_inserted -584632292 1615846730 +[string] +\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -pink + defines an argument that is inserted in any case (alone or in addition + to user-specified arguments). + Multiple arguments need to be separated by comma. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -purple -\end_layout - -\end_inset -, -\begin_inset Flex Code -status collapsed +\change_inserted -584632292 1615846730 +Font +\change_unchanged -\begin_layout Plain Layout -teal \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -violet -\end_layout + The font used for the argument content, see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Font-description" \end_inset -] +. \end_layout -\begin_layout Description +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Family + +\change_inserted -584632292 1615846730 +FreeSpacing +\change_unchanged + \end_layout \end_inset @@ -22582,224 +23616,275 @@ status collapsed \begin_layout Plain Layout +\change_inserted -584632292 1615846730 + \emph on -Roman +0 +\change_unchanged + \end_layout \end_inset -, +, +\begin_inset space \thinspace{} +\end_inset + + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Sans + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -Typewriter -\end_layout +] As with paragraph styles, see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Paragraph-Styles" \end_inset -] +. \end_layout -\begin_layout Description +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Misc + +\change_inserted -584632292 1615846730 +LabelFont +\change_unchanged + \end_layout \end_inset - [ -\begin_inset Flex Code -status collapsed + The font used for the label; see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Font-description" -\begin_layout Plain Layout -string +\end_inset + +. \end_layout -\end_inset +\begin_layout Itemize -] Valid arguments are: +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -emph + +\change_inserted -584632292 1615846730 +Decoration +\change_unchanged + \end_layout \end_inset -, + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -noun -\end_layout -\end_inset +\change_inserted -584632292 1615846730 -, -\begin_inset Flex Code -status collapsed +\emph on +Classic +\emph default +, Minimalistic, Conglomerate +\change_unchanged -\begin_layout Plain Layout -strikeout \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -underbar +] describes the rendering style used for the inset's frame and buttons. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -uuline + +\change_inserted -584632292 1615846730 +AutoInsert +\change_unchanged + \end_layout \end_inset -, + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -uwave + +\change_inserted -584632292 1615846730 +[int=0] +\change_unchanged + \end_layout \end_inset -, + If this is set to \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_emph + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -no_noun +, this argument is automatically inserted when the respective style is selected. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_strikeout + +\change_inserted -584632292 1615846730 +InsertOnNewline +\change_unchanged + \end_layout \end_inset -, + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_bar + +\change_inserted -584632292 1615846730 +[int=0] +\change_unchanged + \end_layout \end_inset -, + If this is set to \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_uuline + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset - and +, this argument will be inserted on a new line with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_uwave + +\change_inserted -584632292 1615846730 +AutoInsert +\change_unchanged + \end_layout \end_inset -. - Each of these turns on or off the corresponding attribute. - For example, + (only available within Flex insets). +\end_layout + +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -emph + +\change_inserted -584632292 1615846730 +InsertCotext +\change_unchanged + \end_layout \end_inset - turns on emphasis, and + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_emph -\end_layout -\end_inset +\change_inserted -584632292 1615846730 +[int=0] +\change_unchanged + +\end_layout - turns it off. - -\begin_inset Newline newline \end_inset -If the latter seems puzzling, remember that the font settings for the present - context are generally inherited from the surrounding context. - So + If this is set to \begin_inset Flex Code status collapsed \begin_layout Plain Layout -no_emph + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset - would turn off the emphasis that was anyway in effect, say, in a theorem - environment. +, this argument will be inserted with a copy of the co-text (either selected + text or the whole paragraph) as content. \end_layout -\begin_layout Description +\begin_layout Itemize + +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Series + +\change_inserted -584632292 1615846730 +PassThru +\change_unchanged + \end_layout \end_inset @@ -22810,86 +23895,98 @@ status collapsed \begin_layout Plain Layout +\change_inserted -584632292 1615846730 + \emph on -Medium +inherited +\emph default +, true, false +\change_unchanged + \end_layout \end_inset -, +] Whether the contents of this argument should be output in raw form, meaning + without special translations that \SpecialChar LaTeX + would require. + By default, the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Bold -\end_layout -\end_inset +\change_inserted -584632292 1615846730 +PassThru +\change_unchanged -] \end_layout -\begin_layout Description -\begin_inset Flex Code -status collapsed +\end_inset -\begin_layout Plain Layout -Shape + status is inherited by the inset or paragraph layout the argument belongs + to, true and false change the status for the given argument only. \end_layout -\end_inset +\begin_layout Itemize - [ +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\emph on -Up +\change_inserted -584632292 1615846730 +PassThruChars +\change_unchanged + \end_layout \end_inset -, + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Italic + +\change_inserted -584632292 1615846730 +string of characters +\change_unchanged + \end_layout \end_inset -, -\begin_inset Flex Code -status collapsed +] +\family typewriter + +\family default +Defines individual characters +\begin_inset Newline linebreak +\end_inset -\begin_layout Plain Layout -SmallCaps +that should be output in raw form, meaning without special translations + that \SpecialChar LaTeX + would require. + Note that, contrary to PassThru, this needs to be explicitly defined for + arguments. + That is, arguments do not inherit PassThruChars from their parent inset + or layout. \end_layout -\end_inset +\begin_layout Itemize -, +\change_inserted -584632292 1615846730 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Slanted -\end_layout -\end_inset - -] -\end_layout - -\begin_layout Description -\begin_inset Flex Code -status collapsed +\change_inserted -584632292 1615846730 +IsTocCaption +\change_unchanged -\begin_layout Plain Layout -Size \end_layout \end_inset @@ -22899,919 +23996,4670 @@ Size status collapsed \begin_layout Plain Layout -tiny + +\change_inserted -584632292 1615846730 + +\emph on +0 +\change_unchanged + \end_layout \end_inset -, +, +\begin_inset space \thinspace{} +\end_inset + + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -small + +\change_inserted -584632292 1615846730 +1 +\change_unchanged + \end_layout \end_inset -, +] If this is set to 1, the argument will output its content in the corresponding + item in the table of contents. + See AddToToc. +\end_layout + +\begin_layout Standard + +\change_inserted -584632292 1615846730 +By default, the text entered in the \SpecialChar LyX + workarea in the respective layout is + the last (mandatory) argument of a command if the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -\emph on -normal +\change_inserted -584632292 1615846730 +LatexType +\change_unchanged + \end_layout \end_inset -, + is \begin_inset Flex Code status collapsed \begin_layout Plain Layout -large + +\change_inserted -584632292 1615846730 +Command +\change_unchanged + \end_layout \end_inset -, +. + However, arguments with the prefix \begin_inset Flex Code status collapsed \begin_layout Plain Layout -larger + +\change_inserted -584632292 1615846730 +post: +\change_unchanged + \end_layout \end_inset -, + are output after this workarea argument. + Note that post-argument numbering restarts at 1, so the first argument + following the workarea argument is \begin_inset Flex Code status collapsed \begin_layout Plain Layout -largest + +\change_inserted -584632292 1615846730 +post:1 +\change_unchanged + \end_layout \end_inset -, +. + Post-arguments are ignored in any other \begin_inset Flex Code status collapsed \begin_layout Plain Layout -huge + +\change_inserted -584632292 1615846730 +LatexType +\change_unchanged + \end_layout \end_inset -, + than \begin_inset Flex Code status collapsed \begin_layout Plain Layout -giant -\end_layout -\end_inset +\change_inserted -584632292 1615846730 +Command +\change_unchanged -] \end_layout -\begin_layout Subsection -\begin_inset CommandInset label -LatexCommand label -name "subsec:Citation-engine-description" - \end_inset -Cite engine description +. \end_layout \begin_layout Standard -The + +\change_inserted -584632292 1615846730 +Arguments for list \begin_inset Flex Code status collapsed \begin_layout Plain Layout -CiteEngine -\end_layout - -\end_inset - blocks, as used mainly in cite engine files (see -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Cite-Engine-Files" -plural "false" -caps "false" -noprefix "false" +\change_inserted -584632292 1615846730 -\end_inset +\backslash +item +\change_unchanged -), define the citation commands provided by a specific -\begin_inset Quotes eld -\end_inset +\end_layout -cite engine -\begin_inset Quotes erd \end_inset -. - A cite engine, in \SpecialChar LyX - terms, is way specific way to format citations, using - numbers, author names and/or years. - Currently, \SpecialChar LyX - supports three such engine types, namely: -\end_layout - -\begin_layout Enumerate +s (as in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -default -\end_layout -\end_inset +\change_inserted -584632292 1615846730 -: the default Bib\SpecialChar TeX - way to format citations, a simple numeric style (e. -\begin_inset space \thinspace{} -\end_inset +\backslash +item[foo] +\change_unchanged -g., -\begin_inset Quotes eld -\end_inset +\end_layout -[1] -\begin_inset Quotes erd \end_inset -) -\end_layout - -\begin_layout Enumerate +) have the prefix \begin_inset Flex Code status collapsed \begin_layout Plain Layout -authoryear + +\change_inserted -584632292 1615846730 +item: +\change_unchanged + \end_layout \end_inset -: Harvard-styled citations using author names and publication year (e. + followed by the number (e. \begin_inset space \thinspace{} \end_inset -g., -\begin_inset Quotes eld -\end_inset - -Smith and Miller (2017b) -\begin_inset Quotes erd +g. +\begin_inset space \space{} \end_inset -) -\end_layout -\begin_layout Enumerate \begin_inset Flex Code status collapsed \begin_layout Plain Layout -numerical -\end_layout -\end_inset - -: extended numerical citations that also allow for author or title next - to the number (e. -\begin_inset space \thinspace{} -\end_inset +\change_inserted -584632292 1615846730 +Argument item:1 +\change_unchanged -g., -\begin_inset Quotes eld -\end_inset +\end_layout -Smith and Miller [1] -\begin_inset Quotes erd \end_inset -) +). \end_layout \begin_layout Standard + +\change_inserted -584632292 1615846730 +Finally, there is a special argument type with the prefix \begin_inset Flex Code status collapsed \begin_layout Plain Layout -CiteEngine -\end_layout - -\end_inset - - blocks look like this: -\end_layout - -\begin_layout LyX-Code -CiteEngine default -\end_layout - -\begin_layout LyX-Code - cite -\end_layout -\begin_layout LyX-Code - Citep*[][] -\end_layout +\change_inserted -584632292 1615846730 +listpreamble: +\change_unchanged -\begin_layout LyX-Code - citeyearpar[][]=parencite* \end_layout -\begin_layout LyX-Code - ... -\end_layout +\end_inset -\begin_layout LyX-Code -End -\end_layout +. + It is not really an argument, but uses the argument interface (thus, the + prefix is also followed by a number, e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Standard -The tag following +g. + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -CiteEngine + +\change_inserted -584632292 1615846730 +Argument listpreamble:1 +\change_unchanged + \end_layout \end_inset - denotes the engine. - The individual lines respectively define a cite command or cite command - paradigm supported by this engine. - The line can be as simple as a cite command that is used both to name the - respective \SpecialChar LyX - command and the \SpecialChar LaTeX - output or more complex in order to differentiate - things. - The full syntax is: -\end_layout - -\begin_layout LyX-Code -LyXName|alias$*[][]=latexcmd -\end_layout - -\begin_layout Itemize +). + As the name implies, it is targeted at lists such as +\family sans +Itemize +\family default +, +\family sans +Enumerate +\family default +, +\family sans +Description +\family default +, or +\family sans +Bibliography +\family default +. + Its content will be output at the list start, before the first \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LyXName + +\change_inserted -584632292 1615846730 + +\backslash +item +\change_unchanged + \end_layout \end_inset -: The name as used in the -\begin_inset Flex Code -status collapsed +, on an own line (a place that is otherwise not accessible in \SpecialChar LyX +). + This way, users can insert redefinitions (of lengths etc.) to individual + lists. + By default, these arguments do not have a delimiter. +\change_unchanged -\begin_layout Plain Layout -*.lyx \end_layout +\begin_layout Subsection +Counters +\begin_inset CommandInset label +LatexCommand label +name "subsec:Counters" + \end_inset - file. + \end_layout -\begin_deeper \begin_layout Standard -For portability reasons, we try to use the same name for same-formatted - commands in different cite packages (thus many names stem from natbib, - and thus we need to differentiate a -\begin_inset Flex Code +It is necessary to define the counters ( +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -latexcmd +chapter \end_layout \end_inset - sometimes, if the \SpecialChar LaTeX - command names differ). -\end_layout - -\end_deeper -\begin_layout Itemize -\begin_inset Flex Code +, +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -alias +figure \end_layout \end_inset -: a (comma-separated) list of commands that fall back to the given +, \SpecialChar ldots +) in the text class itself. + The standard counters are defined in the file \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LyXName +stdcounters.inc \end_layout \end_inset - in the current engine. - This eases the switch of citation packages and engines. - The -\begin_inset Flex Code -status collapsed +, so you may have to do no more than add +\end_layout -\begin_layout Plain Layout -alias +\begin_layout LyX-Code +Input stdcounters.inc \end_layout -\end_inset +\begin_layout Standard +to your layout file to get them to work. + But if you want to define custom counters, then you can do so. + The counter declaration must begin with: +\end_layout - can be compared to +\begin_layout LyX-Code +Counter CounterName +\end_layout + +\begin_layout Standard +where of course ` \begin_inset Flex Code status collapsed \begin_layout Plain Layout -ObsoletedBy +CounterName \end_layout \end_inset - in layout definitions. -\end_layout +' is replaced by the name of the counter. + And it must end with +\begin_inset Quotes eld +\end_inset + -\begin_layout Itemize \begin_inset Flex Code status collapsed \begin_layout Plain Layout -latexcmd +End \end_layout \end_inset -: The actual \SpecialChar LaTeX - command that is output. - + +\begin_inset Quotes erd +\end_inset + +. + The following parameters can also be used: \end_layout -\begin_layout Standard +\begin_layout Description \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Alias +InitialValue \end_layout \end_inset - and + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -latexcmd +int=1 \end_layout \end_inset - are optional. - If no +] Sets the initial value for the counter, to which it will be reset whenever + that happens. + Normally, one will want the default, 1. +\end_layout + +\begin_layout Description \begin_inset Flex Code status collapsed \begin_layout Plain Layout -latexcmd +LabelString \end_layout \end_inset - is given, the + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LyXName +string \end_layout \end_inset - will be output to \SpecialChar LaTeX -. -\end_layout += +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Note further: -\end_layout -\begin_layout Itemize -Capitalization indicates that the command also has a capitalized form ( +\begin_inset Quotes erd +\end_inset + +] When defined, this string defines how the counter is displayed. + Setting this value sets \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -Latexcmd +LabelStringAppendix \end_layout \end_inset - vs. - + to the same value. + The following special constructs can be used in the string: +\end_layout + +\begin_deeper +\begin_layout Itemize \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -latexcmd +thecounter \end_layout \end_inset -). - These usually enforce up-casing of name prefixes ( -\emph on -von Goethe -\emph default - -\begin_inset Formula $\Rightarrow$ -\end_inset - - -\emph on -Von Goethe -\emph default -). -\end_layout - -\begin_layout Itemize -Brackets + will be replaced by the expansion of the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -[] +LabelString \end_layout \end_inset - indicate the number of optional arguments (there can be 0–2). -\end_layout - -\begin_layout Itemize -A star + (or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -* +LabelStringAppendix \end_layout \end_inset - indicates there is a starred version of the command ( +) of the counter \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -latexcmd* +counter \end_layout \end_inset - vs. +. +\end_layout + +\begin_layout Itemize +counter values can be expressed using \SpecialChar LaTeX +-like macros +\begin_inset Newline newline +\end_inset + + \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -latexcmd -\end_layout - -\end_inset -). - +\emph on +numbertype +\emph default +{ +\emph on +counter +\emph default +} \end_layout -\begin_deeper -\begin_layout Standard -By default, the starred version means: Output all authors even if it should - be shortened with -\begin_inset Quotes eld -\end_inset - -et al. -\begin_inset Quotes erd \end_inset - due to the +, where \begin_inset Flex Code status collapsed \begin_layout Plain Layout -MaxCiteNames + +\emph on +numbertype \end_layout \end_inset - threshold. + can be: +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout + +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Actually, the situation is a bit more complicated: any +\family default +\series default +\shape default +\emph default +\bar default + +\size default +\emph on +\noun default +\color inherit +numbertype +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off + other than those described below will produce arabic numerals. + It would not be surprising to see this change in the future. +\end_layout + +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +arabic +\end_layout + +\end_inset + +: 1, 2, 3,\SpecialChar ldots +; +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +alph +\end_layout + +\end_inset + + for lower-case letters: a, b, c, \SpecialChar ldots +; +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Alph +\end_layout + +\end_inset + + for upper-case letters: A, B, C, \SpecialChar ldots +; +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +roman +\end_layout + +\end_inset + + for lower-case roman numerals: i, ii, iii, \SpecialChar ldots +; +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Roman +\end_layout + +\end_inset + + for upper-case roman numerals: I, II, III\SpecialChar ldots +; +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +hebrew +\end_layout + +\end_inset + + for hebrew numerals. \end_layout +\end_deeper \begin_layout Standard -If the star has a different meaning for a given command, it can be specified - in angle brackets: +If LabelString is not defined, a default value is constructed as follows: + if the counter has a +\change_deleted 731793113 1604355218 +master +\change_inserted 731793113 1604355221 +parent +\change_unchanged + counter +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_deleted 731793113 1604355223 +master +\change_inserted 731793113 1604355226 +parent +\change_unchanged + +\end_layout + +\end_inset + + (defined via +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Within +\end_layout + +\end_inset + +), the string +\begin_inset Newline newline +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +the +\change_inserted 731793113 1604355228 +parent +\change_deleted 731793113 1604355230 +master +\change_unchanged +. +\backslash +arabic{counter} +\end_layout + +\end_inset + + is used; otherwise the string +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +arabic{counter} +\end_layout + +\end_inset + + is used. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LabelStringAppendix +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + += +\begin_inset Quotes eld +\end_inset + + +\begin_inset Quotes erd +\end_inset + +] Same as +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LabelString +\end_layout + +\end_inset + +, but for use in the Appendix. +\change_inserted -584632292 1607202551 + +\end_layout + +\begin_layout Description + +\change_inserted -584632292 1607202682 +\begin_inset Flex Code +status open + +\begin_layout Plain Layout +LaTeXName +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -584632292 1607202576 +string +\change_unchanged + +\end_layout + +\end_inset + + = +\begin_inset Quotes eld +\end_inset + + +\begin_inset Quotes erd +\end_inset + +] The counter name as used in \SpecialChar LaTeX +. + ( +\change_inserted 34634807 1619711355 +e +\change_deleted 34634807 1619711355 +E +\change_inserted -584632292 1607202682 +.g., in \SpecialChar LyX +, there is a counter named `theorem', but it is output to \SpecialChar LaTeX + as `thm'.) +\change_unchanged + +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +PrettyFormat +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + += +\begin_inset Quotes erd +\end_inset + + +\begin_inset Quotes erd +\end_inset + +] A format for use with formatted references to this counter. + For example, one might want to have references to section numbers appear + as +\begin_inset Quotes eld +\end_inset + +Section 2.4 +\begin_inset Quotes erd +\end_inset + +. + The string should contain +\begin_inset Quotes eld +\end_inset + +## +\begin_inset Quotes erd +\end_inset + +. + This will be replaced by the counter number itself. + So, for sections, it would be: Section ##. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Within +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + += +\begin_inset Quotes erd +\end_inset + + +\begin_inset Quotes erd +\end_inset + +] If this is set to the name of another counter, the present counter will + be reset every time the other one is increased. + For example, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +subsection +\end_layout + +\end_inset + + is numbered inside +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +section +\end_layout + +\end_inset + +. +\end_layout + +\begin_layout Subsection +Font description +\begin_inset CommandInset label +LatexCommand label +name "subsec:Font-description" + +\end_inset + + +\end_layout + +\begin_layout Standard +A font description looks like this: +\end_layout + +\begin_layout LyX-Code +Font +\family roman +\emph on +or +\family default +\emph default + LabelFont +\emph on + +\family roman +or +\family default +\emph default + DefaultFont +\end_layout + +\begin_layout LyX-Code + ... +\end_layout + +\begin_layout LyX-Code +EndFont +\end_layout + +\begin_layout Standard +The following commands are available: +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Color +\end_layout + +\end_inset + + [ +\change_deleted -712698321 1607682984 + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +none +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +black +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +white +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +red +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +green +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +blue +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +cyan +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +magenta +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +yellow +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +brown +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +darkgray +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +gray +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lightgray +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lime +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +orange +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +olive +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +pink +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +purple +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +teal +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +violet +\end_layout + +\end_inset + + +\change_inserted -712698321 1607683139 + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1607683135 +string +\change_unchanged + +\end_layout + +\end_inset + +] See appendix +\begin_inset space ~ +\end_inset + + +\begin_inset CommandInset ref +LatexCommand ref +reference "chap:Names-of-colors" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + for +\change_deleted -712698321 1607683144 +] +\change_inserted -712698321 1607683146 +valid arguments. +\change_unchanged + +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Family +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +Roman +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Sans +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Typewriter +\end_layout + +\end_inset + +] +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Misc +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] Valid arguments are: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +emph +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +noun +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +strikeout +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +underbar +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +uuline +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +uwave +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_emph +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_noun +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_strikeout +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_bar +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_uuline +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_uwave +\end_layout + +\end_inset + +. + Each of these turns on or off the corresponding attribute. + For example, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +emph +\end_layout + +\end_inset + + turns on emphasis, and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_emph +\end_layout + +\end_inset + + turns it off. + +\begin_inset Newline newline +\end_inset + +If the latter seems puzzling, remember that the font settings for the present + context are generally inherited from the surrounding context. + So +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +no_emph +\end_layout + +\end_inset + + would turn off the emphasis that was anyway in effect, say, in a theorem + environment. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Series +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +Medium +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Bold +\end_layout + +\end_inset + +] +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Shape +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +Up +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Italic +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +SmallCaps +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Slanted +\end_layout + +\end_inset + +] +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Size +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +tiny +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +small +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +normal +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +large +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +larger +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +largest +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +huge +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +giant +\end_layout + +\end_inset + +] +\end_layout + +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "subsec:Citation-engine-description" + +\end_inset + +Cite engine description +\end_layout + +\begin_layout Standard +The +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteEngine +\end_layout + +\end_inset + + blocks, as used mainly in cite engine files (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +), define the citation commands provided by a specific +\begin_inset Quotes eld +\end_inset + +cite engine +\begin_inset Quotes erd +\end_inset + +. + A cite engine, in \SpecialChar LyX + terms, is way specific way to format citations, using + numbers, author names and/or years. + Currently, \SpecialChar LyX + supports three such engine types, namely: +\end_layout + +\begin_layout Enumerate +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +default +\end_layout + +\end_inset + +: the default Bib\SpecialChar TeX + way to format citations, a simple numeric style (e. +\begin_inset space \thinspace{} +\end_inset + +g., +\begin_inset Quotes eld +\end_inset + +[1] +\begin_inset Quotes erd +\end_inset + +) +\end_layout + +\begin_layout Enumerate +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +authoryear +\end_layout + +\end_inset + +: Harvard-styled citations using author names and publication year (e. +\begin_inset space \thinspace{} +\end_inset + +g., +\begin_inset Quotes eld +\end_inset + +Smith and Miller (2017b) +\begin_inset Quotes erd +\end_inset + +) +\end_layout + +\begin_layout Enumerate +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +numerical +\end_layout + +\end_inset + +: extended numerical citations that also allow for author or title next + to the number (e. +\begin_inset space \thinspace{} +\end_inset + +g., +\begin_inset Quotes eld +\end_inset + +Smith and Miller [1] +\begin_inset Quotes erd +\end_inset + +) +\end_layout + +\begin_layout Standard +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteEngine +\end_layout + +\end_inset + + blocks look like this: +\end_layout + +\begin_layout LyX-Code +CiteEngine default +\end_layout + +\begin_layout LyX-Code + cite +\end_layout + +\begin_layout LyX-Code + Citep*[][] +\end_layout + +\begin_layout LyX-Code + citeyearpar[][]=parencite* +\end_layout + +\begin_layout LyX-Code + ... +\end_layout + +\begin_layout LyX-Code +End +\end_layout + +\begin_layout Standard +The tag following +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteEngine +\end_layout + +\end_inset + + denotes the engine. + The individual lines respectively define a cite command or cite command + paradigm supported by this engine. + The line can be as simple as a cite command that is used both to name the + respective \SpecialChar LyX + command and the \SpecialChar LaTeX + output or more complex in order to differentiate + things. + The full syntax is: +\end_layout + +\begin_layout LyX-Code +LyXName|alias$*[][]=latexcmd +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LyXName +\end_layout + +\end_inset + +: The name as used in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +*.lyx +\end_layout + +\end_inset + + file. +\end_layout + +\begin_deeper +\begin_layout Standard +For portability reasons, we try to use the same name for same-formatted + commands in different cite packages (thus many names stem from natbib, + and thus we need to differentiate a +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latexcmd +\end_layout + +\end_inset + + sometimes, if the \SpecialChar LaTeX + command names differ). +\end_layout + +\end_deeper +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +alias +\end_layout + +\end_inset + +: a (comma-separated) list of commands that fall back to the given +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LyXName +\end_layout + +\end_inset + + in the current engine. + This eases the switch of citation packages and engines. + The +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +alias +\end_layout + +\end_inset + + can be compared to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +ObsoletedBy +\end_layout + +\end_inset + + in layout definitions. +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latexcmd +\end_layout + +\end_inset + +: The actual \SpecialChar LaTeX + command that is output. + +\end_layout + +\begin_layout Standard +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Alias +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latexcmd +\end_layout + +\end_inset + + are optional. + If no +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latexcmd +\end_layout + +\end_inset + + is given, the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LyXName +\end_layout + +\end_inset + + will be output to \SpecialChar LaTeX +. +\end_layout + +\begin_layout Standard +Note further: +\end_layout + +\begin_layout Itemize +Capitalization indicates that the command also has a capitalized form ( +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +Latexcmd +\end_layout + +\end_inset + + vs. + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +latexcmd +\end_layout + +\end_inset + +). + These usually enforce up-casing of name prefixes ( +\emph on +von Goethe +\emph default + +\begin_inset Formula $\Rightarrow$ +\end_inset + + +\emph on +Von Goethe +\emph default +). +\end_layout + +\begin_layout Itemize +Brackets +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +[] +\end_layout + +\end_inset + + indicate the number of optional arguments (there can be 0–2). +\end_layout + +\begin_layout Itemize +A star +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +* +\end_layout + +\end_inset + + indicates there is a starred version of the command ( +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +latexcmd* +\end_layout + +\end_inset + + vs. + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +latexcmd +\end_layout + +\end_inset + +). + +\end_layout + +\begin_deeper +\begin_layout Standard +By default, the starred version means: Output all authors even if it should + be shortened with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + + due to the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + + threshold. +\end_layout + +\begin_layout Standard +If the star has a different meaning for a given command, it can be specified + in angle brackets: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + +. + Maximal two translatable macro keywords, marked by the prefix +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +!_ +\end_layout + +\end_inset + +, can be given. + The first points to the string that replaces the +\begin_inset Quotes eld +\end_inset + +Full aut&hor list +\begin_inset Quotes erd +\end_inset + + checkbox label in the citation dialog, the second one to an optional tool + tip for this checkbox. + +\end_layout + +\begin_layout Standard +Note that these two macros have to be defined in a +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteFormat +\end_layout + +\end_inset + + (see next section), dropping the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +! +\end_layout + +\end_inset + + from the prefix, like this: +\end_layout + +\begin_layout LyX-Code +_stardesc Sta&rred command label +\end_layout + +\begin_layout LyX-Code +_stardesctooltip Tooltip for the starred command checkbox. +\end_layout + +\end_deeper +\begin_layout Itemize +A dollar sign +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$ +\end_layout + +\end_inset + + indicates that this command features +\begin_inset Quotes eld +\end_inset + +qualified citation lists +\begin_inset Quotes erd +\end_inset + +. + This is a +\family sans +Biblatex +\family default +-specific feature for multi-reference citations where an individual pre- + and postnote can be given to each reference in the list. + Please refer to the +\family sans +Biblatex +\family default + manual for details. +\change_inserted -712698321 1526898670 + +\end_layout + +\begin_layout Standard + +\change_inserted -712698321 1526899524 +If you want to add a cite command to a cite engine (e. +\begin_inset space \thinspace{} +\end_inset + +g., add a specific command provided by a class), you can use +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1526898768 +AddToCiteEngine \SpecialChar ldots + End +\change_unchanged + +\end_layout + +\end_inset + +. + Note that only cite commands that do not exist yet are added. +\change_unchanged + +\end_layout + +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "subsec:Citation-format-description" + +\end_inset + +Cite format description +\end_layout + +\begin_layout Standard +The +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteFormat +\end_layout + +\end_inset + + blocks are used to describe how bibliographic information should be displayed, + both within \SpecialChar LyX + itself (in the citation dialog and in tooltips, for example) + and in XHTML output. + Such a block might look like this: +\end_layout + +\begin_layout LyX-Code +CiteFormat +\end_layout + +\begin_layout LyX-Code + article ... +\end_layout + +\begin_layout LyX-Code + book ... +\end_layout + +\begin_layout LyX-Code +End +\end_layout + +\begin_layout Standard +or +\end_layout + +\begin_layout LyX-Code +CiteFormat +\end_layout + +\begin_layout LyX-Code + cite ... +\end_layout + +\begin_layout LyX-Code + citet*[][] ... +\end_layout + +\begin_layout LyX-Code +End +\end_layout + +\begin_layout Standard +In the first case, the individual lines define how the bibliographic information + associated with an article or book, respectively, is to be displayed, and + such a definition can be given for any +\begin_inset Quotes els +\end_inset + +entry type +\begin_inset Quotes ers +\end_inset + + that might be present in a Bib\SpecialChar TeX + file. + \SpecialChar LyX + defines a default format in the source code that will be used if no specific + definition has been given. + \SpecialChar LyX + predefines several formats in the file +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +stdciteformats.inc +\end_layout + +\end_inset + +, which is included in most of \SpecialChar LyX +'s document classes. +\end_layout + +\begin_layout Standard +In the second case, the lines define how a specific citation command (in + the example +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +cite +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +citet +\end_layout + +\end_inset + +) is to be displayed on the citation inset label, in the citation dialog, + menu or XHTML output. + \SpecialChar LyX + defines such formats for the citation style variants it supports via +\family sans +Document\SpecialChar menuseparator +Setting\SpecialChar menuseparator +Bibliography\SpecialChar ldots + +\family default + in specific +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +*.citeengine +\end_layout + +\end_inset + + files that are shipped with \SpecialChar LyX + (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +). +\end_layout + +\begin_layout Standard +The definitions use a simple language that allows Bib\SpecialChar TeX + keys to be replaced + with their values. + Keys should be enclosed in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +% +\end_layout + +\end_inset + + signs, e.g.: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%author% +\end_layout + +\end_inset + +. + So a simple definition might look like this: +\end_layout + +\begin_layout LyX-Code +misc %author%, +\begin_inset Quotes eld +\end_inset + +%title% +\begin_inset Quotes erd +\end_inset + +. +\end_layout + +\begin_layout Standard +This would print the author, followed by a comma, followed by the title, + in quotes, followed by a period. +\end_layout + +\begin_layout Standard +Of course, sometimes you may want to print a key only if it exists. + This can be done by using a conditional construction, such as: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%volume%[[vol. +\begin_inset space ~ +\end_inset + +%volume%]]} +\end_layout + +\end_inset + +. + This says: If the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +volume +\end_layout + +\end_inset + + key exists, then print +\begin_inset Quotes eld +\end_inset + +vol. +\begin_inset space ~ +\end_inset + + +\begin_inset Quotes erd +\end_inset + + followed by the volume key. + It is also possible to have an else clause in the conditional, such as: +\begin_inset Newline newline +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%author%[[%author%]][[%editor%, ed.]]} +\end_layout + +\end_inset + +. +\begin_inset Newline newline +\end_inset + +Here, the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +author +\end_layout + +\end_inset + + key is printed if it exists; otherwise, the editor key is printed, followed + by +\begin_inset Quotes eld +\end_inset + +, +\begin_inset space ~ +\end_inset + +ed. +\begin_inset Quotes erd +\end_inset + + Note that the key is again enclosed in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +% +\end_layout + +\end_inset + + signs; the entire conditional is enclosed in braces; and the if and else + clauses are enclosed in double brackets, +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +[[ +\end_layout + +\end_inset + + +\begin_inset Quotes eld +\end_inset + + and +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +]] +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. + There must be no space between any of these. +\end_layout + +\begin_layout Standard +Next to the entry keys, there are some special keys that can be used for + these conditionals: +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%dialog%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + part for dialogs and menus, the +\begin_inset Quotes eld +\end_inset + +false +\begin_inset Quotes erd +\end_inset + + part for other contexts (workarea, export) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%export%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + part for export and menus, the +\begin_inset Quotes eld +\end_inset + +false +\begin_inset Quotes erd +\end_inset + + part for other contexts (workarea, dialog) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%next%[[true]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + part if another item follows (e. +\begin_inset space \thinspace{} +\end_inset + +g., in a citation with multiple keys) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%second%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + if this is the second of multiple items, else the +\begin_inset Quotes eld +\end_inset + +false +\begin_inset Quotes erd +\end_inset + + part +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifstar%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + part for starred citation commands (such as +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +cite* +\end_layout + +\end_inset + +), the false part for unstarred +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifentrytype:%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + if the current entry type matches +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + +, else the false part (e.g., in a citation definition: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifentrytype:book%[[this is a book]][[this is no book]]} +\end_layout + +\end_inset + +) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifmultiple:%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + if the current author type (author, editor etc.) has multiple authors, else + the false part (e.g., in a bibliography definition: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifmultiple:editor%[[eds.]][[ed.]]} +\end_layout + +\end_inset + +) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{%ifqualified%[[true]][[false]]} +\end_layout + +\end_inset + +: process the +\begin_inset Quotes eld +\end_inset + +true +\begin_inset Quotes erd +\end_inset + + part if the current citation is a qualified citation list (a specific +\family sans +Biblatex +\family default + format for multi-reference citations), the false part if this is not the + case. +\end_layout + +\begin_layout Standard +We said that +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%author% +\end_layout + +\end_inset + + prints the author key as it is recorded in the bibliography file. + This might not be what you want, since it will result in a string such + as +\begin_inset Quotes eld +\end_inset + +Miller, Peter and Smith, Mary and White, Jane +\begin_inset Quotes erd +\end_inset + + (since +\begin_inset Quotes eld +\end_inset + +and +\begin_inset Quotes erd +\end_inset + + is used by Bib\SpecialChar TeX + to delimit authors). + \SpecialChar LyX + therefore provides some methods to get properly formatted name lists (which + will also get translated). + The following keys are provided: +\end_layout + +\begin_layout Enumerate +For name lists with pre- and surname, suitable for the main authors/editors + of a bibliography item. + The +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + part denotes the kind of list that is requested (e.g. + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + +): +\end_layout + +\begin_deeper +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%abbrvnames:% +\end_layout + +\end_inset + +: Provides a name list which is abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) when +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + + is reached. +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%fullnames:% +\end_layout + +\end_inset + +: Provides a full name list (never abbreviated with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +). +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%forceabbrvnames:% +\end_layout + +\end_inset + +: Provides a name list which is always abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) irrespective of +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + +. +\end_layout + +\end_deeper +\begin_layout Enumerate +Alternative name lists with pre- and surname, if the order of pre- and surname + inside the bibliography item differs (as in: +\begin_inset Quotes eld +\end_inset + +Miller, John: Some text, in: Mary Smith, ed.: A volume +\begin_inset Quotes erd +\end_inset + +): +\end_layout + +\begin_deeper +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%abbrvbynames:% +\end_layout + +\end_inset + +: Provides a name list which is abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) when +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + + is reached. +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%fullbynames:% +\end_layout + +\end_inset + +: Provides a full name list (never abbreviated with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +). +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%forceabbrvbynames:% +\end_layout + +\end_inset + +: Provides a name list which is always abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) irrespective of +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + +. +\end_layout + +\end_deeper +\begin_layout Enumerate +And finally name lists which consist of family names only, as used in author-yea +r citation labels. + These do not take a +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + part, but always return either an author list or, if this does not exist, + an editor list (as common in author-year labels): +\end_layout + +\begin_deeper +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%abbrvciteauthor% +\end_layout + +\end_inset + +: Provides a name list which is abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) when +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + + is reached. +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%fullciteauthor% +\end_layout + +\end_inset + +: Provides a full name list (never abbreviated with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +). +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%forceabbrvciteauthor% +\end_layout + +\end_inset + +: Provides a name list which is always abbreviated (with +\begin_inset Quotes eld +\end_inset + +et al. +\begin_inset Quotes erd +\end_inset + +) irrespective of +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + +. +\end_layout + +\end_deeper +\begin_layout Standard +The order of pre- and surname in the former two lists can be adjusted by + these macros: +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +!firstnameform %surname%, %prename% +\end_layout + +\end_inset + + (first author in lists of type 1) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +!othernameform %surname%, %prename% +\end_layout + +\end_inset + + (other authors in lists of type 1) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +!firstbynameform %prename% %surname% +\end_layout + +\end_inset + + (first author in lists of type 2) +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +!otherbynameform %prename% %surname% +\end_layout + +\end_inset + + (other authors in lists of type 2) +\end_layout + +\begin_layout Standard +This allows you to configure namings like +\begin_inset Quotes eld +\end_inset + +Miller, Peter and Mary Smith: \SpecialChar ldots +, in: John Doe and Pat Green, eds.:\SpecialChar ldots + +\begin_inset Quotes erd +\end_inset + +. +\end_layout + +\begin_layout Standard +There is one other piece of syntax available in definitions, which looks + like this: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +{!!} +\end_layout + +\end_inset + +. + This defines a piece of formatting information that is to be used when + creating +\begin_inset Quotes eld +\end_inset + +rich text +\begin_inset Quotes erd +\end_inset + +. + Obviously, we do not want to output HTML tags when writing plain text, + so they should be wrapped in +\begin_inset Quotes eld +\end_inset + +{! +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +!} +\begin_inset Quotes erd +\end_inset + +. +\end_layout + +\begin_layout Standard +Two special sorts of definitions are also possible in a +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteFormat +\end_layout + +\end_inset + + block. + An example of the first would be: +\end_layout + +\begin_layout LyX-Code +!quotetitle +\begin_inset Quotes eld +\end_inset + +%title% +\begin_inset Quotes erd +\end_inset + + +\end_layout + +\begin_layout Standard +This is an abbreviation, or macro, and it can be used by treating it as + if it were a key: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%!quotetitle% +\end_layout + +\end_inset + +. + \SpecialChar LyX + will treat +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%!quotetitle% +\end_layout + +\end_inset + + exactly as it would treat its definition. + So, let us issue the obvious +\emph on +warning +\emph default +. + Do not do this: +\end_layout + +\begin_layout LyX-Code +!funfun %funfun% +\end_layout + +\begin_layout Standard +or anything like it. + \SpecialChar LyX + shouldn't go into an infinite loop, but it may go into a long one before + it gives up. +\end_layout + +\begin_layout Standard +The second sort of special definition might look like this: +\end_layout + +\begin_layout LyX-Code +B_pptext pp. +\end_layout + +\begin_layout Standard +This defines a translatable piece of text, which allows relevant parts of + the bibliography or citation to be translated. + It can be included in a definition by treating it as a key: +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +%B_pptext% +\end_layout + +\end_inset + +. + Note that there are two different translation paths: All definitions starting + with +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +B_ +\end_layout + +\end_inset + +, such as in the example above, will be translated to the currently active + buffer language (so the translation will match the generated document). + All definitions starting with underscore only will be translated to the + GUI language. + This is the proper translation for strings that only occur in the dialogs + or on buttons, such as this one: +\end_layout + +\begin_layout LyX-Code +_addtobib Add to bibliography only. +\end_layout + +\begin_layout Standard +Several of these translatable strings are predefined in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +stdciteformats.inc +\end_layout + +\end_inset + + and the diverse +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +*.citeengine +\end_layout + +\end_inset + + files. + Note that these are not macros, in the sense just defined. + They will not be expanded. +\end_layout + +\begin_layout Standard +So here then is an example that uses several of these features: +\begin_inset VSpace defskip +\end_inset + + +\end_layout + +\begin_layout Standard +\noindent + +\family sans +!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]} +\end_layout + +\begin_layout Standard +\begin_inset VSpace defskip +\end_inset + +This defines a macro that prints the author, followed by a comma, if the + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +author +\end_layout + +\end_inset + + key is defined, or else prints the name of the editor, followed by the + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +B_edtext +\end_layout + +\end_inset + + or its translation (it is by default +\begin_inset Quotes eld +\end_inset + +ed. +\begin_inset Quotes erd +\end_inset + +), if the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +editor +\end_layout + +\end_inset + + key is defined. + Note that this is in fact defined in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +stdciteformats.inc +\end_layout + +\end_inset + +, so you can use it in your own definitions, or re-definitions, if you load + that file first. +\end_layout + +\begin_layout Section +\begin_inset CommandInset label +LatexCommand label +name "sec:Tags-for-XHTML" + +\end_inset + +Tags for XHTML output +\end_layout + +\begin_layout Standard +As with \SpecialChar LaTeX + or DocBook, the format of \SpecialChar LyX +'s XHTML output is also controlled by + layout information. + In general, \SpecialChar LyX + provides sensible defaults and, as mentioned earlier, it will + even construct default CSS style rules from the other layout tags. + For example, \SpecialChar LyX + will attempt to use the information provided in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Font +\end_layout + +\end_inset + + declaration for the Chapter style to write CSS that will appropriately + format chapter headings. +\end_layout + +\begin_layout Standard +In many cases, then, you may not have to do anything at all to get acceptable + XHTML output for your own environments, custom insets, and so forth. + But in some cases you will, and so \SpecialChar LyX + provides a number of layout tags that + can be used to customize the XHTML and CSS that are generated. +\end_layout + +\begin_layout Standard +Note that there are two tags, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLPreamble +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +AddToHTMLPreamble +\end_layout + +\end_inset + + that may appear outside style and inset declarations. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:General-text-class" + +\end_inset + + for details on these. +\end_layout + +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "subsec:Paragraph-Style-XHTML" + +\end_inset + +Paragraph styles +\end_layout + +\begin_layout Standard +The sort of XHTML \SpecialChar LyX + outputs for a paragraph depends upon whether we are dealing + with a normal paragraph, a command, or an environment, where this is itself + determined by the contents of the corresponding +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +\SpecialChar LaTeX +Type +\end_layout + +\end_inset + + tag. + +\end_layout + +\begin_layout Standard +For a command or normal paragraph, the output XHTML has the following form: +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout LyX-Code + +\family sans +Label +\end_layout + +\begin_layout LyX-Code + +\family sans +Contents of the paragraph. +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout Standard +The label tags are of course omitted if the paragraph does not have a label. +\end_layout + +\begin_layout Standard +For an environment that is not some sort of list, the XHTML takes this form: +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout LyX-Code + +\family sans +Environment LabelFirst paragraph. +\end_layout + +\begin_layout LyX-Code + +\family sans +Second paragraph. +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout Standard +Note that the label is output only for the first paragraph, as it should + be for a theorem, for example. + +\end_layout + +\begin_layout Standard +For a list, we have one of these forms: +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout LyX-Code + +\family sans +List LabelFirst item. +\end_layout + +\begin_layout LyX-Code + +\family sans +List LabelSecond item. +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout LyX-Code + +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout LyX-Code + +\family sans +List LabelFirst item. +\end_layout + +\begin_layout LyX-Code + +\family sans +List LabelSecond item. +\end_layout + +\begin_layout LyX-Code + +\family sans + +\end_layout + +\begin_layout Standard +Note the different orders of +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +labeltag +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +itemtag +\end_layout + +\end_inset + +. + Which order we get depends upon the setting of +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLLabelFirst +\end_layout + +\end_inset + +: If +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLLabelFirst +\end_layout + +\end_inset + + is false (the default), you get the first of these, with the label within + the item; if true, you get the second, with the label outside the item. +\end_layout + +\begin_layout Standard +The specific tags and attributes output for each paragraph type can be controlle +d by means of the layout tags we are about to describe. + As mentioned earlier, however, \SpecialChar LyX + uses sensible defaults for many of these, + so you often may not need to do very much to get good XHTML output. + Think of the available tags as there so you can tweak things to your liking. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLAttr +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] Specifies attribute information to be output with the main tag. + For example, +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +class=`mydiv' +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. + By default, \SpecialChar LyX + will output +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +class=`layoutname' +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +, where +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +layoutname +\end_layout + +\end_inset + + is the \SpecialChar LyX + name of the layout, made lowercase, for example: chapter. + This should +\emph on +not +\emph default + contain any style information. + Use +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLStyle +\end_layout + +\end_inset + + for that purpose. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLForceCSS +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +0 +\emph default +,1 +\end_layout + +\end_inset + +] Whether to output the default CSS information \SpecialChar LyX + generates for this layout, + even if additional information is explicitly provided via +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLStyle +\end_layout + +\end_inset + +. + Setting this to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +1 +\end_layout + +\end_inset + + allows you to alter or augment the generated CSS, rather than to override + it completely. + Default is +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +0 +\end_layout + +\end_inset + +. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLItem +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] The tag to be used for individual paragraphs of environments, replacing + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +itemtag +\end_layout + +\end_inset + + in the examples above. + Defaults to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +div +\end_layout + +\end_inset + +. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLItemAttr +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] Attributes for the item tag. + Defaults to +\begin_inset Newline newline +\end_inset + + +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +class=`layoutname_item' +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. + This should +\emph on +not +\emph default + contain any style information. + Use +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLStyle +\end_layout + +\end_inset + + for that purpose. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLLabel +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] The tag to be used for paragraph and item labels, replacing +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +labeltag +\end_layout + +\end_inset + + in the examples above. + Defaults to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +span +\end_layout + +\end_inset + +, unless +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +LabelType +\end_layout + +\end_inset + + is either +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Top_Environment +\end_layout + +\end_inset + + or +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Centered_Top_Environment +\end_layout + +\end_inset + +, in which case it defaults to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +div +\end_layout + +\end_inset + +. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLLabelAttr +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +string +\end_layout + +\end_inset + +] Attributes for the label tag. + Defaults to +\begin_inset Newline newline +\end_inset + + +\begin_inset Quotes eld +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +class=`layoutname_label' +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\end_inset + +. + This should +\emph on +not +\emph default + contain any style information. + Use +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLStyle +\end_layout + +\end_inset + + for that purpose. +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +HTMLLabelFirst +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\emph on +0 +\emph default +,1 +\end_layout + +\end_inset + +] Meaningful only for list-like environments, this tag controls whether + the label tag is output before or inside the item tag. + This is used, for example, in the description environment, where we want + ` \begin_inset Flex Code status collapsed \begin_layout Plain Layout - +
\SpecialChar ldots +
\SpecialChar ldots +
\end_layout \end_inset . - Maximal two translatable macro keywords, marked by the prefix + Default is \begin_inset Flex Code status collapsed \begin_layout Plain Layout -!_ +0 \end_layout \end_inset -, can be given. - The first points to the string that replaces the -\begin_inset Quotes eld -\end_inset +: The label tag is output inside the item tag. +\end_layout -Full aut&hor list -\begin_inset Quotes erd -\end_inset +\begin_layout Description +\begin_inset Flex Code +status collapsed - checkbox label in the citation dialog, the second one to an optional tool - tip for this checkbox. - +\begin_layout Plain Layout +HTMLPreamble \end_layout -\begin_layout Standard -Note that these two macros have to be defined in a +\end_inset + + Information to be output in the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -CiteFormat + \end_layout \end_inset - (see next section), dropping the + section when this style is used. + This might, for example, be used to include a \begin_inset Flex Code status collapsed \begin_layout Plain Layout -! +