From: Juergen Spitzmueller Date: Sun, 8 Jan 2017 11:45:56 +0000 (+0100) Subject: Documentation bit. X-Git-Tag: 2.3.0alpha1~503 X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=9c738951c747fa6245c7ede0abce73e0dcea68d4;p=features.git Documentation bit. --- diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx index abc8dbc90d..e3917882b9 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.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 528 \begin_document \begin_header \save_transient_properties true @@ -56,6 +56,7 @@ logicalmkup \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype false \graphics default \default_output_format pdf2 \output_sync 0 @@ -113,7 +114,8 @@ logicalmkup \tocdepth 3 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 \papersides 2 \paperpagestyle headings @@ -224,6 +226,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 @@ -587,6 +590,53 @@ $LANG_xxx.bind \end_inset , that will be used first. +\change_inserted -712698321 1483535138 + +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 + +\change_inserted -712698321 1483874001 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483535144 +citeengines/ +\end_layout + +\end_inset + + contains files with the extension +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483869840 +.citeengine +\change_unchanged + +\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. +\change_unchanged + \end_layout \begin_layout Labeling @@ -3519,6 +3569,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 @@ -7528,6 +7579,176 @@ LyXDir \begin_layout Standard Note that manual conversion does not affect included files, so these will have to be converted separately. +\change_inserted -712698321 1483873435 + +\end_layout + +\begin_layout Subsection + +\change_inserted -712698321 1483875083 +\begin_inset CommandInset label +LatexCommand label +name "subsec:Cite-Engine-Files" + +\end_inset + +Cite engine files +\end_layout + +\begin_layout Standard + +\change_inserted -712698321 1483874213 +A specific form of layout files are the so-called +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483873546 +*.citeengine +\end_layout + +\end_inset + + files that are located in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483873546 +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 + +\change_inserted -712698321 1483874969 +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 ldots +\SpecialChar menuseparator +Bibliography\SpecialChar menuseparator +Style engine +\family default +. +\end_layout + +\begin_layout Standard + +\change_inserted -712698321 1483875180 +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 + +\change_inserted -712698321 1483874688 +MaxCiteNames +\change_unchanged + +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483875180 +CiteFramework +\change_unchanged + +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483874477 +CiteEngine +\change_unchanged + +\end_layout + +\end_inset + + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483874482 +CiteFormat +\change_unchanged + +\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. +\change_unchanged + \end_layout \begin_layout Section @@ -8352,124 +8573,257 @@ somemodule.module \end_inset . +\change_inserted -712698321 1483873000 + \end_layout \begin_layout Subsection -Format number + +\change_inserted -712698321 1483873010 +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: + +\change_inserted -712698321 1483873022 +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 LyX-Code -\begin_layout Plain Layout -Format +\change_inserted -712698321 1483873047 +# +\backslash +DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex} \end_layout -\end_inset +\begin_layout Standard - [ -\begin_inset Flex Code +\change_inserted -712698321 1483873077 +The mandatory argument, in curly brackets, is the name of the module, as + it should appear in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -int + +\change_inserted -712698321 1483873068 +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 +\change_inserted -712698321 1483873102 +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 +\change_inserted -712698321 1483873000 +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_inset +\begin_layout LyX-Code -General text class parameters +\change_inserted -712698321 1483873128 +# DescriptionBegin \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 LyX-Code -\begin_layout Plain Layout -.layout +\change_inserted -712698321 1483873140 +# Biblatex supports many author-year and numerical styles. \end_layout -\end_inset +\begin_layout LyX-Code - files rather than in modules. - A module can contain any layout tag.) +\change_inserted -712698321 1483873152 +# It is mainly aimed at the Humanities. + It is highly \end_layout -\begin_layout Description -\begin_inset Flex Code -status collapsed +\begin_layout LyX-Code -\begin_layout Plain Layout -AddToHTMLPreamble +\change_inserted -712698321 1483873160 +# customizable, fully localized and provides many features \end_layout -\end_inset +\begin_layout LyX-Code - Adds information that will be output in the -\begin_inset Flex Code -status collapsed +\change_inserted -712698321 1483873170 +# that are not possible with BibTeX. + The use of 'biber' as +\end_layout -\begin_layout Plain Layout +\begin_layout LyX-Code + +\change_inserted -712698321 1483873174 +# bibliography processor is advised. +\end_layout + +\begin_layout LyX-Code + +\change_inserted -712698321 1483873224 +# DescriptionEnd +\end_layout + +\begin_layout Standard + +\change_inserted -712698321 1483873207 +The description is used in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483873194 +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography +\end_layout + +\end_inset + + to provide the user with information about the cite engine. +\change_unchanged + +\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 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Format +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +int +\end_layout + +\end_inset + +] 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 + +. + 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 +.layout +\end_layout + +\end_inset + + files rather than in modules. + A module can contain any layout tag.) +\end_layout + +\begin_layout Description +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +AddToHTMLPreamble +\end_layout + +\end_inset + + Adds information that will be output in the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout \end_layout @@ -8543,6 +8897,70 @@ EndPreamble \end_inset . +\change_inserted -712698321 1483872509 + +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1483874560 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483872558 +CiteEngine +\end_layout + +\end_inset + + 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 + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483872548 +End +\end_layout + +\end_inset + + +\begin_inset Quotes erd +\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_unchanged + \end_layout \begin_layout Description @@ -8583,6 +9001,86 @@ End \end_inset . + +\change_inserted -712698321 1483875199 + 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_unchanged + +\end_layout + +\begin_layout Description + +\change_inserted -712698321 1483874578 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483872820 +CiteFramework +\end_layout + +\end_inset + + [ +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483872852 + +\emph on +bibtex +\change_unchanged + +\end_layout + +\end_inset + +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\change_inserted -712698321 1483872857 +biblatex +\change_unchanged + +\end_layout + +\end_inset + +] 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 + +). +\change_unchanged + \end_layout \begin_layout Description @@ -9264,14 +9762,20 @@ MMMMM \end_inset .) +\change_inserted -712698321 1483872681 + \end_layout \begin_layout Description + +\change_inserted -712698321 1483874598 \begin_inset Flex Code status collapsed \begin_layout Plain Layout -ModifyStyle + +\change_inserted -712698321 1483872687 +MaxCiteNames \end_layout \end_inset @@ -9281,7 +9785,54 @@ ModifyStyle status collapsed \begin_layout Plain Layout -