X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FCustomization.lyx;h=079b7f74d3aa688a2367cec8e27a85743731b0a1;hb=cde4537a42d0281600aabdd141d5ba91b6e4ef75;hp=6987fef85bbfad6421d4dcc66bb72a4f91a6bf3b;hpb=c1e698fd8688bd64194631b5223a22f341a0fd7a;p=features.git diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx index 6987fef85b..079b7f74d3 100644 --- a/lib/doc/Customization.lyx +++ b/lib/doc/Customization.lyx @@ -1,5 +1,5 @@ -#LyX 2.2 created this file. For more info see http://www.lyx.org/ -\lyxformat 508 +#LyX 2.4 created this file. For more info see https://www.lyx.org/ +\lyxformat 608 \begin_document \begin_header \save_transient_properties true @@ -36,16 +36,16 @@ } }{} \end_preamble -\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading +\options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading \use_default_options false \begin_modules logicalmkup \end_modules -\maintain_unincluded_children false +\maintain_unincluded_children no \language english \language_package default -\inputencoding auto -\fontencoding global +\inputencoding utf8 +\fontencoding auto \font_roman "lmodern" "default" \font_sans "lmss" "default" \font_typewriter "lmtt" "default" @@ -53,9 +53,13 @@ logicalmkup \font_default_family default \use_non_tex_fonts false \font_sc false -\font_osf false +\font_roman_osf false +\font_sans_osf false +\font_typewriter_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false +\use_dash_ligatures true \graphics default \default_output_format pdf2 \output_sync 0 @@ -80,16 +84,16 @@ logicalmkup \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false" \papersize default \use_geometry false -\use_package amsmath 0 -\use_package amssymb 0 -\use_package cancel 0 -\use_package esint 0 +\use_package amsmath 1 +\use_package amssymb 1 +\use_package cancel 1 +\use_package esint 1 \use_package mathdots 1 -\use_package mathtools 0 -\use_package mhchem 0 -\use_package stackrel 0 -\use_package stmaryrd 0 -\use_package undertilde 0 +\use_package mathtools 1 +\use_package mhchem 1 +\use_package stackrel 1 +\use_package stmaryrd 1 +\use_package undertilde 1 \cite_engine basic \cite_engine_type default \biblio_style plain @@ -99,11 +103,13 @@ logicalmkup \suppress_date false \justification true \use_refstyle 0 +\use_minted 0 +\use_lineno 0 \notefontcolor #0000ff \branch OutDated \selected 0 \filename_suffix 0 -\color #f5fae7 +\color #f5fae7 #0a0518 \end_branch \index Index \shortcut idx @@ -113,15 +119,33 @@ logicalmkup \tocdepth 3 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\is_math_indent 1 +\math_indentation default +\math_numbering_side default +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 \papersides 2 \paperpagestyle headings -\tracking_changes false +\tablestyle default +\tracking_changes true \output_changes false +\change_bars false +\postpone_fragile_content false \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 @@ -138,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, @@ -146,6 +169,7 @@ n mailing list, LatexCommand href target "lyx-docs@lists.lyx.org" type "mailto:" +literal "false" \end_inset @@ -159,7 +183,17 @@ type "mailto:" \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 @@ -172,7 +206,7 @@ type "mailto:" \begin_inset Newline newline \end_inset -Version 2.2.x +Version 2.4.x \end_layout \begin_layout Standard @@ -222,6 +256,7 @@ This manual covers the customization features present in \SpecialChar LyX \begin_layout Standard \begin_inset Branch OutDated +inverted 0 status collapsed \begin_layout Standard @@ -314,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 @@ -355,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 @@ -365,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 @@ -383,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 @@ -397,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, @@ -431,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 @@ -456,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 @@ -472,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 @@ -480,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 @@ -517,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 @@ -527,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 @@ -538,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 @@ -562,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 @@ -592,13 +728,60 @@ $LANG_xxx.bind \begin_inset Flex Code status collapsed +\begin_layout Plain Layout +citeengines/ +\end_layout + +\end_inset + + +\change_deleted 232239728 1604794478 +c +\change_inserted 232239728 1604794478 +C +\change_unchanged +ontains files with the extension +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +.citeengine +\end_layout + +\end_inset + + which define the diverse citation possibilities (natbib, biblatex etc.). + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + for details. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + \begin_layout Plain Layout clipart/ \end_layout \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 @@ -613,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 @@ -667,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 @@ -692,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 @@ -719,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 @@ -741,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" @@ -762,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 @@ -774,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 @@ -789,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 @@ -819,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 @@ -841,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 @@ -857,6 +1103,45 @@ status collapsed appearing on the toolbar. \end_layout +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +xtemplates/ +\end_layout + +\end_inset + + +\change_deleted 232239728 1604794528 +c +\change_inserted 232239728 1604794528 +C +\change_unchanged +ontains files with the extension +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +.xtemplate +\end_layout + +\end_inset + + which define the templates for the insertion of external material to a + \SpecialChar LyX + document; see +\begin_inset CommandInset ref +LatexCommand ref +reference "chap:Including-External-Material" + +\end_inset + +. +\end_layout + \begin_layout Subsection Files you don't want to modify \end_layout @@ -878,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 @@ -909,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 @@ -925,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 @@ -945,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 @@ -954,48 +1263,19 @@ encodings \begin_inset Flex Code status collapsed -\begin_layout Plain Layout -external_templates -\end_layout - -\end_inset - - this file contains the templates available to the new -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -External -\begin_inset space ~ -\end_inset - -Template -\end_layout - -\end_inset - - feature, see -\begin_inset CommandInset ref -LatexCommand ref -reference "chap:Including-External-Material" - -\end_inset - -. -\end_layout - -\begin_layout Labeling -\labelwidthstring 00.00.0000 -\begin_inset Flex Code -status collapsed - \begin_layout Plain Layout languages \end_layout \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 @@ -1010,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 @@ -1024,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" @@ -1046,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 @@ -1222,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 @@ -1256,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 @@ -1293,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). @@ -1303,7 +1616,7 @@ status collapsed status collapsed \begin_layout Plain Layout -LYX_USERDIR_VER +LYX_USERDIR_24x \end_layout \end_inset @@ -1353,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 @@ -1564,6 +1883,7 @@ MIME LatexCommand href name "IANA" target "http://www.iana.org/assignments/media-types/" +literal "false" \end_inset @@ -1574,6 +1894,7 @@ target "http://www.iana.org/assignments/media-types/" LatexCommand href name "freedesktop.org" target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec" +literal "false" \end_inset @@ -2364,6 +2685,10 @@ status collapsed \begin_layout Plain Layout latex +\change_inserted -712698321 1524656940 +=flavor +\change_unchanged + \end_layout \end_inset @@ -2373,6 +2698,55 @@ latex This will make \SpecialChar LyX 's \SpecialChar LaTeX error logs available. + +\change_inserted -712698321 1524657018 + The optional +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657012 +flavor +\change_unchanged + +\end_layout + +\end_inset + + value specifies the form of \SpecialChar LaTeX + that is run ( +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657005 +latex, pdflatex, platex, xetex, luatex +\change_unchanged + +\end_layout + +\end_inset + +). + If no value is specified, +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657018 +latex +\change_unchanged + +\end_layout + +\end_inset + + is used. +\change_unchanged + \end_layout \begin_layout Labeling @@ -2382,6 +2756,10 @@ status collapsed \begin_layout Plain Layout needaux +\change_inserted -712698321 1524656935 +=flavor +\change_unchanged + \end_layout \end_inset @@ -2398,6 +2776,69 @@ status collapsed \end_inset file for the conversion. + +\change_inserted -712698321 1524657047 + The optional +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657030 +flavor +\change_unchanged + +\end_layout + +\end_inset + + value specifies the form of \SpecialChar LaTeX + that is run in order to generate the +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657047 +.aux +\change_unchanged + +\end_layout + +\end_inset + + file ( +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657030 +latex, pdflatex, platex, xetex, luatex +\change_unchanged + +\end_layout + +\end_inset + +). + If no value is specified, +\begin_inset Flex Code +status open + +\begin_layout Plain Layout + +\change_inserted -712698321 1524657030 +latex +\change_unchanged + +\end_layout + +\end_inset + + is used. +\change_unchanged + \end_layout \begin_layout Labeling @@ -2473,11 +2914,42 @@ value \begin_layout Labeling \labelwidthstring 00.00.0000 + +\change_inserted -712698321 1523206314 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -parselog + +\change_inserted -712698321 1523206193 +hyperref-driver +\change_unchanged + +\end_layout + +\end_inset + + The name of the driver that needs to be loaded with the +\family sans +hyperref +\family default + package for this converter. + The loading of the correct driver is necessary to get some PDF-specific + features. + See the +\family sans +hyperref +\family default + manual for details. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +parselog \end_layout \end_inset @@ -2578,8 +3050,34 @@ $$b \end_layout \begin_layout Standard -None of these last three are presently used in any of the converters that - are installed with \SpecialChar LyX + +\change_inserted -712698321 1523206384 +A suitable hyperref-driver is set for some converters that are installed + with \SpecialChar LyX +. + +\change_deleted -712698321 1523206388 +None of these +\change_inserted -712698321 1523206389 +The +\change_unchanged + last three +\change_inserted -712698321 1523206400 + flags, however, +\change_unchanged + are presently +\change_inserted -712698321 1523206407 +not +\change_unchanged +used in any of the +\change_inserted -712698321 1523206437 +pre-installed +\change_unchanged +converters +\change_deleted -712698321 1523206442 + that are installed with \SpecialChar LyX + +\change_unchanged . \end_layout @@ -2955,7 +3453,8 @@ Check out the \SpecialChar LyX \begin_inset CommandInset href LatexCommand href name "information on the web" -target "http://www.lyx.org/HowToUseGIT" +target "https://www.lyx.org/HowToUseGIT" +literal "false" \end_inset @@ -3066,9 +3565,7 @@ status open \begin_layout Plain Layout -https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html -\backslash -#PO-Mode +https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode \end_layout \end_inset @@ -3385,8 +3882,9 @@ DocName Check out the documentation translation web page at \begin_inset CommandInset href LatexCommand href -name "http://www.lyx.org/Translation" -target "http://www.lyx.org/Translation" +name "https://www.lyx.org/Translation" +target "https://www.lyx.org/Translation" +literal "false" \end_inset @@ -3480,7 +3978,7 @@ status collapsed \begin_layout Plain Layout -http://www.lyx.org/HowToUseGIT +https://www.lyx.org/HowToUseGIT \end_layout \end_inset @@ -3499,8 +3997,9 @@ Sometimes the original document (from the \SpecialChar LyX Use the source viewer at \begin_inset CommandInset href LatexCommand href -name "http://www.lyx.org/trac/timeline" -target "http://www.lyx.org/trac/timeline" +name "https://www.lyx.org/trac/timeline" +target "https://www.lyx.org/trac/timeline" +literal "false" \end_inset @@ -3517,6 +4016,7 @@ If you ever find an error in the original document, fix it and notify the \begin_layout Standard \begin_inset Branch OutDated +inverted 0 status collapsed \begin_layout Section @@ -5679,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 @@ -5979,6 +6483,7 @@ Get the package from LatexCommand href name "CTAN" target "http://www.ctan.org/" +literal "false" \end_inset @@ -6128,7 +6633,6 @@ status collapsed \begin_layout Plain Layout \family sans -\lang french $HOME/.texliveXXXX \end_layout @@ -6428,11 +6932,7 @@ Now the package is installed. status collapsed \begin_layout Plain Layout -Slides -\begin_inset space ~ -\end_inset - -(FoilTex) +FoilTex \end_layout \end_inset @@ -6449,7 +6949,15 @@ Document Class \end_inset -. + (in the +\begin_inset Quotes eld +\end_inset + +Presentations +\begin_inset Quotes erd +\end_inset + + category). \end_layout @@ -6513,7 +7021,8 @@ As you prepare to write a new layout, it is extremely helpful to look at \begin_inset CommandInset href LatexCommand href name "layout section on the LyX wiki" -target "http://wiki.lyx.org/Layouts/Layouts" +target "https://wiki.lyx.org/Layouts/Layouts" +literal "false" \end_inset @@ -6755,7 +7264,19 @@ Format Any format is acceptable, but one would normally use the format current at the time. (In \SpecialChar LyX - 2.2, the current layout format is 60.) + +\begin_inset Info +type "lyxinfo" +arg "version" +\end_inset + +, the current layout format is +\begin_inset Info +type "lyxinfo" +arg "layoutformat" +\end_inset + +.) \end_layout \begin_layout Standard @@ -6841,8 +7362,11 @@ status collapsed Supporting a style file is usually fairly easy. Supporting a new class file is a bit harder. We'll discuss the former in this section and the latter in the next. - Similar remarks apply, of course, if you want to support a new DocBook - DTD. + +\change_deleted 5863208 1594239023 +Similar remarks apply, of course, if you want to support a new DocBook DTD. +\change_unchanged + \end_layout \begin_layout Standard @@ -6922,7 +7446,7 @@ myclass.layout \begin_layout LyX-Code \backslash -DeclareLaTeXClass{report} +DeclareLaTeXClass{Report (Standard Class)} \end_layout \begin_layout Standard @@ -6932,7 +7456,7 @@ to read \begin_layout LyX-Code \backslash -DeclareLaTeXClass[report, myclass.sty]{report (myclass)} +DeclareLaTeXClass[report, myclass.sty]{Report (My Class)} \end_layout \begin_layout Standard @@ -6978,7 +7502,7 @@ Reconfigure status collapsed \begin_layout Plain Layout -report (myclass) +Report (My Class) \end_layout \end_inset @@ -7105,7 +7629,7 @@ myclass.sty \begin_layout LyX-Code # \backslash -DeclareLyXModule{My Package} +DeclareLyXModule{My Class} \end_layout \begin_layout LyX-Code @@ -7113,7 +7637,7 @@ DeclareLyXModule{My Package} \end_layout \begin_layout LyX-Code -#Support for mypkg.sty. +#Support for myclass.sty. \end_layout \begin_layout LyX-Code @@ -7125,7 +7649,13 @@ DeclareLyXModule{My Package} \end_layout \begin_layout LyX-Code -Format 60 +Format +\begin_inset Info +type "lyxinfo" +arg "layoutformat" +\end_inset + + \begin_inset Newline newline \end_inset @@ -7139,7 +7669,7 @@ Preamble \backslash -usepackage{mypkg} +usepackage{myclass} \begin_inset Newline newline \end_inset @@ -7400,7 +7930,10 @@ Paths \begin_layout Standard Note, by the way, that there is a template which has a particular meaning: - +\begin_inset Newline linebreak +\end_inset + + \begin_inset Flex Code status collapsed @@ -7528,6 +8061,143 @@ Note that manual conversion does not affect included files, so these will have to be converted separately. \end_layout +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "subsec:Cite-Engine-Files" + +\end_inset + +Cite engine files +\end_layout + +\begin_layout Standard +A specific form of layout files are the so-called +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +*.citeengine +\end_layout + +\end_inset + + files that are located in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +citeengines/ +\end_layout + +\end_inset + + sub-directory. + Their purpose is to define the specifics of \SpecialChar LaTeX + packages aimed at bibliography + generation, such as +\family sans +natbib +\family default +, +\family sans + jurabib +\family default + or +\family sans +biblatex +\family default +, but also the way how normal Bib\SpecialChar TeX + citations (without additional packages) + are handled in \SpecialChar LyX + is defined in such a file. + +\end_layout + +\begin_layout Standard +More specifically, it is defined which packages \SpecialChar LyX + needs to load, which citation + commands are available, how these are to be displayed in \SpecialChar LyX + (in the workarea, + the dialogs, the context menus) as well as in the XHTML and plain text + output. + Furthermore, the files specify available style variants (author-year, numerical +, etc.) and their specifics. + The cite engine files are also used to generate the options that are available + in +\family sans +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography\SpecialChar menuseparator +Style engine +\family default +. +\end_layout + +\begin_layout Standard +Even though a cite engine file is essentially a normal layout file that + could theoretically include any layout information, it usually primarily + includes some specific parameters such as +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +MaxCiteNames +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteFramework +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteEngine +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +CiteFormat +\end_layout + +\end_inset + + blocks. + The syntax of the latter two is described in +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Citation-engine-description" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + and +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Citation-format-description" + +\end_inset + +, as well as in the files themselves. +\end_layout + \begin_layout Section \begin_inset CommandInset label LatexCommand label @@ -7954,18 +8624,24 @@ foo.sty \end_inset package. - Finally, it is also possible to declare classes for DocBook code. + +\change_deleted 5863208 1594239179 +Finally, it is also possible to declare classes for DocBook code. Typical declarations will look like: \end_layout \begin_layout LyX-Code +\change_deleted 5863208 1594239179 + \size small #% Do not delete the line below; configure depends on this \end_layout \begin_layout LyX-Code +\change_deleted 5863208 1594239179 + \size small # \backslash @@ -7974,10 +8650,14 @@ DeclareDocBookClass[article]{SGML (DocBook Article)} \begin_layout LyX-Code +\change_deleted 5863208 1594239179 + \size small # \backslash DeclareCategory{Articles (DocBook)} +\change_unchanged + \end_layout \begin_layout Standard @@ -8056,7 +8736,6 @@ Reconfigure Once the layout file is installed, you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX . - \begin_inset Foot status collapsed @@ -8166,12 +8845,39 @@ A module must begin with a line like the following: \begin_layout LyX-Code # \backslash -DeclareLyXModule[endnotes.sty]{Endnotes} +DeclareLyXModule[endnotes.sty]{Endnotes} +\change_inserted -712698321 1554395911 + +\end_layout + +\begin_layout LyX-Code + +\change_inserted -712698321 1554395924 + +\size small +# +\backslash +DeclareCategory{Foot- and Endnotes} +\change_deleted -712698321 1554395911 + +\size default + +\change_unchanged + \end_layout \begin_layout Standard -The mandatory argument, in curly brackets, is the name of the module, as - it should appear in +The mandatory argument +\change_inserted -712698321 1554395956 + of +\family typewriter + +\backslash +DeclareLyXModule +\change_unchanged + +\family default +, in curly brackets, is the name of the module, as it should appear in \begin_inset Flex Noun status collapsed @@ -8219,10 +8925,28 @@ to \end_inset '. + +\change_inserted -712698321 1554396133 + The +\family typewriter + +\backslash +DeclareCategory +\family default + declaration is not strictly mandatory, but you should add it, since it + is helpful to find the module. + Please have a look at the existing module categories and if appropriate, + use one of those. +\change_unchanged + \end_layout \begin_layout Standard -The module declaration should then be followed by lines like the following +The module +\change_inserted -712698321 1554395988 +and category +\change_unchanged +declaration should then be followed by lines like the following: \begin_inset Foot status collapsed @@ -8235,7 +8959,7 @@ Preferably in English if the module should be published with \SpecialChar LyX \end_inset -: + \end_layout \begin_layout LyX-Code @@ -8353,104 +9077,113 @@ somemodule.module \end_layout \begin_layout Subsection -Format number +The CiteEngine file declaration \end_layout \begin_layout Standard -The first non-comment line of any layout file, included file, or module - -\emph on -must -\emph default - contain the file format number: +A cite engine file must begin with a line like the following: \end_layout -\begin_layout Description -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -Format +\begin_layout LyX-Code +# +\backslash +DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex} \end_layout -\end_inset - - [ -\begin_inset Flex Code +\begin_layout Standard +The mandatory argument, in curly brackets, is the name of the cite style, + as it should appear in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -int +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography \end_layout \end_inset -] The format number of the layout file. +. + The argument in square brackets is optional: It declares any \SpecialChar LaTeX + packages + on which the cite engine depends. \end_layout \begin_layout Standard -This tag was introduced with \SpecialChar LyX - -\begin_inset space ~ -\end_inset - -1.4.0. - Layout files from older \SpecialChar LyX - versions do not have an explicit file format and - are considered to have -\begin_inset Flex Code +The cite engine declaration should then be followed by lines like the following: +\begin_inset Foot status collapsed \begin_layout Plain Layout -Format -\begin_inset space ~ -\end_inset - -1 +Preferably in English if the module should be published with \SpecialChar LyX +. + This description will appear in the list of messages to be translated and + will be thus translated with the next interface update. \end_layout \end_inset -. - The format for the present version of \SpecialChar LyX - is format 60. - But each version of \SpecialChar LyX - is capable of reading earlier versions' layout files, - just as they are capable of reading files produced by earlier versions - of \SpecialChar LyX -. - There is, however, no provision for converting to earlier formats. -\end_layout -\begin_layout Subsection -\begin_inset CommandInset label -LatexCommand label -name "subsec:General-text-class" +\end_layout -\end_inset +\begin_layout LyX-Code +# DescriptionBegin +\end_layout -General text class parameters +\begin_layout LyX-Code +# Biblatex supports many author-year and numerical styles. +\end_layout + +\begin_layout LyX-Code +# It is mainly aimed at the Humanities. + It is highly +\end_layout + +\begin_layout LyX-Code +# customizable, fully localized and provides many features +\end_layout + +\begin_layout LyX-Code +# that are not possible with BibTeX. + The use of 'biber' as +\end_layout + +\begin_layout LyX-Code +# bibliography processor is advised. +\end_layout + +\begin_layout LyX-Code +# DescriptionEnd \end_layout \begin_layout Standard -These are general parameters that govern the behavior of an entire document - class. - (This does -\emph on -not -\emph default - mean that they must appear in -\begin_inset Flex Code +The description is used in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -.layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography \end_layout \end_inset - files rather than in modules. - A module can contain any layout tag.) + to provide the user with information about the cite engine. +\end_layout + +\begin_layout Subsection +Format number +\end_layout + +\begin_layout Standard +The first non-comment line of any layout file, included file, or module + +\emph on +must +\emph default + contain the file format number: \end_layout \begin_layout Description @@ -8458,86 +9191,129 @@ status collapsed status collapsed \begin_layout Plain Layout -AddToHTMLPreamble +Format \end_layout \end_inset - Adds information that will be output in the + [ \begin_inset Flex Code status collapsed \begin_layout Plain Layout - +int \end_layout \end_inset - block when the document is output to XHTML. - Typically, this would be used to output CSS style information, but it can - be used for anything that can appear in +] The format number of the layout file. +\end_layout + +\begin_layout Standard +This tag was introduced with \SpecialChar LyX + +\begin_inset space ~ +\end_inset + +1.4.0. + Layout files from older \SpecialChar LyX + versions do not have an explicit file format and + are considered to have \begin_inset Flex Code status collapsed \begin_layout Plain Layout - +Format +\begin_inset space ~ +\end_inset + +1 \end_layout \end_inset . - Must end with -\begin_inset Quotes eld + The format for the present version of \SpecialChar LyX + is format 60. + But each version of \SpecialChar LyX + is capable of reading earlier versions' layout files, + just as they are capable of reading files produced by earlier versions + of \SpecialChar LyX +. + There is, however, no provision for converting to earlier formats. +\end_layout + +\begin_layout Subsection +\begin_inset CommandInset label +LatexCommand label +name "subsec:General-text-class" + \end_inset +General text class parameters +\end_layout +\begin_layout Standard +These are general parameters that govern the behavior of an entire document + class. + (This does +\emph on +not +\emph default + mean that they must appear in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -EndPreamble +.layout \end_layout \end_inset - -\begin_inset Quotes erd -\end_inset - -. + files rather than in modules. + A module can contain any layout tag.) \end_layout \begin_layout Description + +\change_inserted -712698321 1526899478 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -AddToPreamble -\end_layout -\end_inset +\change_inserted -712698321 1526898610 +AddToCiteEngine +\change_unchanged + +\end_layout - Adds information to the document preamble. - Must end with -\begin_inset Newline newline \end_inset + Extends the possibilities for displaying citation references. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Citation-engine-description" +plural "false" +caps "false" +noprefix "false" -\begin_inset Quotes eld \end_inset - + for details. + Must end with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -EndPreamble -\end_layout -\end_inset +\change_inserted -712698321 1526898823 +End +\change_unchanged +\end_layout -\begin_inset Quotes erd \end_inset . @@ -8548,20 +9324,34 @@ EndPreamble status collapsed \begin_layout Plain Layout -CiteFormat +AddToHTMLPreamble \end_layout \end_inset - Defines formats for use in the display of bibliographic information. - See -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Citation-format-description" + Adds information that will be output in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout \end_inset - for details. + block when the document is output to XHTML. + Typically, this would be used to output CSS style information, but it can + be used for anything that can appear in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\end_layout + +\end_inset + +. Must end with \begin_inset Quotes eld \end_inset @@ -8571,7 +9361,7 @@ reference "subsec:Citation-format-description" status collapsed \begin_layout Plain Layout -End +EndPreamble \end_layout \end_inset @@ -8588,21 +9378,17 @@ End status collapsed \begin_layout Plain Layout -ClassOptions +AddToPreamble \end_layout \end_inset - Describes various global options supported by the document class. - See -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:ClassOptions" - + Adds information to the document preamble. + Must end with +\begin_inset Newline newline \end_inset - for a description. - Must end with + \begin_inset Quotes eld \end_inset @@ -8611,7 +9397,7 @@ reference "subsec:ClassOptions" status collapsed \begin_layout Plain Layout -End +EndPreamble \end_layout \end_inset @@ -8621,14 +9407,22 @@ End \end_inset . +\change_inserted -712698321 1562592950 + \end_layout \begin_layout Description + +\change_inserted -712698321 1562593040 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Columns + +\change_inserted -712698321 1562592954 +BibInToc +\change_unchanged + \end_layout \end_inset @@ -8639,8 +9433,12 @@ status collapsed \begin_layout Plain Layout +\change_inserted -712698321 1562592950 + \emph on -1 +0 +\change_unchanged + \end_layout \end_inset @@ -8654,53 +9452,72 @@ status collapsed status collapsed \begin_layout Plain Layout -2 + +\change_inserted -712698321 1562592950 +1 +\change_unchanged + \end_layout \end_inset -] Whether the class should -\emph on -default -\emph default - to having one or two columns. - Can be changed in the -\begin_inset Flex Noun +] If the document class adds the bibliography to the table of contents, + add this option with value +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings -\end_layout -\end_inset +\change_inserted -712698321 1562592996 +1 +\change_unchanged - dialog. \end_layout -\begin_layout Description +\end_inset + + (or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -Counter + +\change_inserted -712698321 1562593006 +true +\change_unchanged + \end_layout \end_inset - [ +). + This prevents the bibliography from being added twice. +\change_unchanged + +\end_layout + +\begin_layout Description \begin_inset Flex Code status collapsed \begin_layout Plain Layout -string +CiteEngine \end_layout \end_inset -] This sequence defines the properties for a counter. - If the counter does not yet exist, it is created; if it does exist, it - is modified. + Defines the possibilities for displaying citation references. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Citation-engine-description" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + for details. Must end with \begin_inset Quotes eld \end_inset @@ -8720,17 +9537,38 @@ End \end_inset . -\begin_inset Newline newline -\end_inset - -See + Primarily used in cite engine files (see \begin_inset CommandInset ref LatexCommand ref -reference "subsec:Counters" +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" \end_inset - for details on counters. +). + +\change_inserted -712698321 1526898530 + Note that if you specify this in a layout file or module, any cite engine + definition will be overridden. + Also see +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1526898530 +AddToCiteEngine +\change_unchanged + +\end_layout + +\end_inset + +. +\change_unchanged + \end_layout \begin_layout Description @@ -8738,20 +9576,20 @@ reference "subsec:Counters" status collapsed \begin_layout Plain Layout -DefaultFont +CiteFormat \end_layout \end_inset - Sets the default font used to display the document. + Defines formats for use in the display of bibliographic information. See \begin_inset CommandInset ref LatexCommand ref -reference "subsec:Font-description" +reference "subsec:Citation-format-description" \end_inset - for how to declare fonts. + for details. Must end with \begin_inset Quotes eld \end_inset @@ -8761,7 +9599,7 @@ reference "subsec:Font-description" status collapsed \begin_layout Plain Layout -EndFont +End \end_layout \end_inset @@ -8771,6 +9609,23 @@ EndFont \end_inset . + Primarily used in cite engine files (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +). + +\change_inserted -712698321 1526898585 + A cite format defined in a layout or module will override the cite engine + definition. +\change_unchanged + \end_layout \begin_layout Description @@ -8778,7 +9633,7 @@ EndFont status collapsed \begin_layout Plain Layout -DefaultModule +CiteFramework \end_layout \end_inset @@ -8788,26 +9643,40 @@ DefaultModule status collapsed \begin_layout Plain Layout - + +\emph on +bibtex \end_layout \end_inset -] Specifies a module to be included by default with this document class. - The module is specified as filename without the +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -.module +biblatex \end_layout \end_inset - extension. - The user can still remove the module, but it will be active at the outset. - (This applies only when new files are created, or when this class is chosen - for an existing document.) +] Determines whether +\family sans +Biblatex +\family default + or Bib\SpecialChar TeX + is used to generate a Bibliography. + Primarily used in cite engine files (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Cite-Engine-Files" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +). \end_layout \begin_layout Description @@ -8815,34 +9684,39 @@ status collapsed status collapsed \begin_layout Plain Layout -DefaultStyle +ClassOptions \end_layout \end_inset - [ -\begin_inset Flex Code -status collapsed + Describes various global options supported by the document class. + See +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:ClassOptions" -\begin_layout Plain Layout -