]> git.lyx.org Git - features.git/blobdiff - lib/doc/Customization.lyx
Add basic support for cprotect
[features.git] / lib / doc / Customization.lyx
index d2f07789851acc387760800d6819baf800c7bc7c..ab1092e8cb120d14edf5af46d4deb2afccba20ec 100644 (file)
@@ -124,11 +124,12 @@ logicalmkup
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
-\tracking_changes false
+\tracking_changes true
 \output_changes false
 \html_math_output 0
 \html_css_as_file 0
 \html_be_strict true
+\author -712698321 "Jürgen Spitzmüller"
 \end_header
 
 \begin_body
@@ -2515,6 +2516,35 @@ value
  format:
 \end_layout
 
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1523206314
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523206193
+hyperref-driver
+\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
@@ -2622,8 +2652,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
@@ -2999,7 +3055,7 @@ 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
@@ -3430,8 +3486,8 @@ 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
@@ -3526,7 +3582,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/HowToUseGIT
+https://www.lyx.org/HowToUseGIT
 \end_layout
 
 \end_inset
@@ -3545,8 +3601,8 @@ 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
@@ -6565,7 +6621,7 @@ 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
@@ -7453,7 +7509,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
 
@@ -11976,8 +12035,12 @@ string of characters
 \family typewriter
  
 \family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+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.
@@ -12157,6 +12220,51 @@ Argument item:1
 \begin_inset Flex Code
 status collapsed
 
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts that should be nested in and
+ after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAutoNests
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
 \begin_layout Plain Layout
 BabelPreamble
 \end_layout
@@ -12888,6 +12996,51 @@ TitleLatexName
 \begin_inset Flex Code
 status collapsed
 
+\begin_layout Plain Layout
+IsAutoNestedBy
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts after which this one should
+ be nested.
+ Only makes sense with regard to nestable layouts (such as environments).
+ Must be ended by 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndIsAutoNestedBy
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See also 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
 \begin_layout Plain Layout
 IsTocCaption
 \end_layout
@@ -13727,8 +13880,18 @@ Enumerate
 \end_inset
 
  produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
+ The number type needs to be set in the 
+\family sans
+Counter
+\family default
+, see 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -13742,7 +13905,19 @@ Itemize
 \end_inset
 
  produces various bullets at the different levels.
- It is also hardcoded.
+ The bullet types displayed can be set via 
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bullets
+\end_layout
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -17814,7 +17989,11 @@ Multilingual
 \begin_inset space ~
 \end_inset
 
-Captions 
+Captions
+\begin_inset Newline linebreak
+\end_inset
+
+
 \family default
 (
 \begin_inset Flex Code
@@ -19484,6 +19663,79 @@ protect
 not
 \emph default
  whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1523634088
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633958
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523633958
+1
+\end_layout
+
+\end_inset
+
+] This causes macros that contain this inset to be protected with 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523634038
+
+\backslash
+cprotect
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ (cf.
+ package 
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -22827,7 +23079,7 @@ The second sort of special definition might look like this:
 \end_layout
 
 \begin_layout LyX-Code
-_pptext pp.
+B_pptext pp.
 \end_layout
 
 \begin_layout Standard
@@ -22838,13 +23090,37 @@ This defines a translatable piece of text, which allows relevant parts of
 status collapsed
 
 \begin_layout Plain Layout
-%_pptext%
+%B_pptext%
 \end_layout
 
 \end_inset
 
 .
- Several of these are predefined in 
+ 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
 
@@ -22870,7 +23146,7 @@ status collapsed
 \end_layout
 
 \begin_layout Standard
-So here then is an example that use all these features:
+So here then is an example that uses several of these features:
 \begin_inset VSpace defskip
 \end_inset
 
@@ -22880,8 +23156,8 @@ So here then is an example that use all these features:
 \begin_layout Standard
 \noindent
 
-\family typewriter
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\family sans
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
 \end_layout
 
 \begin_layout Standard
@@ -22905,7 +23181,7 @@ author
 status collapsed
 
 \begin_layout Plain Layout
-_edtext
+B_edtext
 \end_layout
 
 \end_inset
@@ -23050,6 +23326,8 @@ For a command or normal paragraph, the output XHTML has the following form:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23062,6 +23340,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23074,10 +23354,14 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 Contents of the paragraph.
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23090,6 +23374,8 @@ For an environment that is not some sort of list, the XHTML takes this form:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23102,6 +23388,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23122,10 +23410,14 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag>Second paragraph.</itemtag>
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23140,6 +23432,8 @@ For a list, we have one of these forms:
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23152,6 +23446,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23172,6 +23468,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <itemtag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23192,6 +23490,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23200,6 +23500,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <tag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23212,6 +23514,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23232,6 +23536,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 <labeltag attr=
 \begin_inset Quotes erd
 \end_inset
@@ -23252,6 +23558,8 @@ value
 \end_layout
 
 \begin_layout LyX-Code
+
+\family sans
 </tag>
 \end_layout
 
@@ -23527,7 +23835,11 @@ string
 \end_inset
 
 ] Attributes for the item tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -23669,7 +23981,11 @@ string
 \end_inset
 
 ] Attributes for the label tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -24199,7 +24515,11 @@ string
 \end_inset
 
 ] Attributes for the inner tag.
- Defaults to 
+ Defaults to
+\begin_inset Newline newline
+\end_inset
+
+
 \begin_inset Quotes eld
 \end_inset
 
@@ -27798,11 +28118,11 @@ commandframe Frame color for command insets
 \end_layout
 
 \begin_layout Description
-commentbg Background color of comments
+comment Label color for comments
 \end_layout
 
 \begin_layout Description
-commentlabel Label color for comments
+commentbg Background color of comments
 \end_layout
 
 \begin_layout Description
@@ -27944,11 +28264,11 @@ nonunique_inlinecompletion Inline completion color for the non-unique part
 \end_layout
 
 \begin_layout Description
-notebg Background color of notes
+note Label color for notes
 \end_layout
 
 \begin_layout Description
-notelabel Label color for notes
+notebg Background color of notes
 \end_layout
 
 \begin_layout Description