]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Customization.lyx
EmbeddedObjects.lyx: fix typo
[lyx.git] / lib / doc / Customization.lyx
index baecb3b8f83a2e767d0de8250c23f27eea8589e1..483f97dccd7e10ad21304a2b071e1810c2d4e35a 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 375
+\lyxformat 378
 \begin_document
 \begin_header
 \textclass scrbook
@@ -45,6 +45,7 @@
 \begin_modules
 logicalmkup
 \end_modules
+\maintain_unincluded_children false
 \begin_local_layout
 Format 7
 InsetLayout CharStyle:MenuItem
@@ -5305,8 +5306,9 @@ article.cls
 
 \end_inset
 
-, is contained in layout files.
+, is contained in `layout files'.
  Similarly, LyX itself does not know much about DocBook or XHTML.
+ What it knows is contained in layout files.
 \end_layout
 
 \begin_layout Standard
@@ -6415,7 +6417,7 @@ DeclareLyXModule{My Package}
 \end_layout
 
 \begin_layout LyX-Code
-Format 20
+Format 21
 \begin_inset Newline newline
 \end_inset
 
@@ -7505,12 +7507,12 @@ int
 This tag was introduced with LyX 1.4.0.
  Layout files from LyX 1.3.x and earlier don't have an explicit file format
  and are considered to be of format 1.
- The format for the present version of LyX is format 20.
+ The format for the present version of LyX is format 21.
  But each version of LyX is capable of reading earlier versions' layout
  files, just as they are capable of reading files produced by earlier versions
  of LyX.
  There is, however, no provision for converting to earlier formats.
- So LyX 1.6.x will not read layout files in format 20 but only files in format
+ So LyX 1.6.x will not read layout files in format 21 but only files in format
  11 or earlier.
 \end_layout
 
@@ -8081,6 +8083,33 @@ EndPreamble
 \begin_inset Flex CharStyle:Code
 status collapsed
 
+\begin_layout Plain Layout
+HTMLTOCSection
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The layout to use for the table of contents, bibliography, and so forth,
+ when the document is output to HTML.
+ For articles, this should normally be Section; for books, Chapter.
+ If it is not given, then LyX will attempt to figure out which layout to
+ use.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
 \begin_layout Plain Layout
 IfCounter
 \end_layout
@@ -8387,8 +8416,6 @@ PageStyle
 \end_inset
 
  [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -8400,8 +8427,6 @@ plain
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -8772,8 +8797,6 @@ Sides
 \end_inset
 
  [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -8785,8 +8808,6 @@ status collapsed
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -9923,8 +9944,6 @@ name "des:FreeSpacing"
 \end_inset
 
 [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -9936,8 +9955,6 @@ status collapsed
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -10152,8 +10169,6 @@ name "des:KeepEmpty"
 \end_inset
 
 [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -10165,8 +10180,6 @@ status collapsed
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -12022,8 +12035,6 @@ name "des:PathThru"
 \end_inset
 
 [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -12035,8 +12046,6 @@ status collapsed
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -12285,6 +12294,42 @@ setspace.sty
 \begin_inset Flex CharStyle:Code
 status collapsed
 
+\begin_layout Plain Layout
+Spellcheck
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Spellcheck paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
 \begin_layout Plain Layout
 TextFont
 \end_layout
@@ -12494,6 +12539,13 @@ HTML*
 
  These are used for XHTML output.
  See 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -12501,7 +12553,7 @@ HTML*
 status collapsed
 
 \begin_layout Plain Layout
-LaTeXBuiltin
+ListCommand
 \end_layout
 
 \end_inset
@@ -12511,55 +12563,84 @@ LaTeXBuiltin
 status collapsed
 
 \begin_layout Plain Layout
-
-\emph on
-0
+string
 \end_layout
 
 \end_inset
 
-, 
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' should be omitted.
+ This 
+\emph on
+must
+\emph default
+ be given if 
 \begin_inset Flex CharStyle:Code
 status collapsed
 
 \begin_layout Plain Layout
-1
+NeedsFloatPkg
 \end_layout
 
 \end_inset
 
-] Set to 
+ is false, since there is no standard way to generate this command.
+ It is ignored if 
 \begin_inset Flex CharStyle:Code
 status collapsed
 
 \begin_layout Plain Layout
-1
+NeedsFloatPkg
 \end_layout
 
 \end_inset
 
- if the float is already defined by the LaTeX document class.
- If this is set to 
+ is true, since in that case there is a standard way.
+\end_layout
+
+\begin_layout Description
 \begin_inset Flex CharStyle:Code
 status collapsed
 
 \begin_layout Plain Layout
-0
+ListName
 \end_layout
 
 \end_inset
 
-, the float will be defined using the LaTeX package 
+ [
 \begin_inset Flex CharStyle:Code
 status collapsed
 
 \begin_layout Plain Layout
-float
+string
 \end_layout
 
 \end_inset
 
-.
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within LyX; it is passed to LaTeX for use
+ as the title there; and it is used as the title in XHTML output.
+ It will be translated to the document language.
 \end_layout
 
 \begin_layout Description
@@ -12567,31 +12648,77 @@ float
 status collapsed
 
 \begin_layout Plain Layout
-ListName
+NeedsFloatPkg
 \end_layout
 
 \end_inset
 
  [
 \begin_inset Flex CharStyle:Code
+status open
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+, 
+\begin_inset Flex CharStyle:Code
 status collapsed
 
 \begin_layout Plain Layout
-string
+
+\emph on
+1
 \end_layout
 
 \end_inset
 
-=
-\begin_inset Quotes erd
+] Indicates whether the float is already defined in the document class or
+ if we instead need to load 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
 \end_inset
 
+ and use what it provides.
+ The default is 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+, which means: use 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
+\end_inset
+
+.
+ It should be set to 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
 
-\begin_inset Quotes erd
 \end_inset
 
-] The heading used for the list of floats.
- This is translated to the document language.
+ if the float is already defined by the LaTeX document class.
 \end_layout
 
 \begin_layout Description
@@ -13892,7 +14019,7 @@ reference "des:LatexType"
 status collapsed
 
 \begin_layout Plain Layout
-LyxType 
+LyxType
 \end_layout
 
 \end_inset
@@ -13940,6 +14067,62 @@ end
  (indicating a dummy definition ending definitions of charstyles, etc).
  This entry is required in and is only meaningful for Flex insets.
  Among other things, it determines on which menu this inset will appear.
+ Setting 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+ to 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+ will set 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ to false.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ can be set to true for charstyle insets, if you wish, by setting it 
+\emph on
+after
+\emph default
+ you set the 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+.
 \end_layout
 
 \begin_layout Description
@@ -14134,7 +14317,7 @@ reference "des:Preamble"
 status collapsed
 
 \begin_layout Plain Layout
-Requires 
+Requires
 \end_layout
 
 \end_inset
@@ -14159,6 +14342,42 @@ reference "des:Requires"
 ).
 \end_layout
 
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Spellcheck
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Spellcheck the contents of this inset.
+ Default is true.
+\end_layout
+
 \begin_layout Subsection
 Counters
 \begin_inset CommandInset label
@@ -14260,12 +14479,30 @@ End
 status collapsed
 
 \begin_layout Plain Layout
-LabelString [string=""]
+LabelString
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
 \end_layout
 
 \end_inset
 
- when this is defined, this string defines how the counter is displayed.
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] When defined, this string defines how the counter is displayed.
  Setting this value sets 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -14524,12 +14761,30 @@ arabic{counter}
 status collapsed
 
 \begin_layout Plain Layout
-LabelStringAppendix [string=""]
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
 \end_layout
 
 \end_inset
 
- Same as 
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] Same as 
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -14546,6 +14801,58 @@ LabelString
 \begin_inset Flex CharStyle:Code
 status collapsed
 
+\begin_layout Plain Layout
+PrettyFormat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle: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 CharStyle:Code
+status collapsed
+
 \begin_layout Plain Layout
 Within
 \end_layout
@@ -14748,8 +15055,6 @@ Family
 \end_inset
 
  [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -14761,8 +15066,6 @@ Roman
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -14920,8 +15223,6 @@ Series
 \end_inset
 
  [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -14933,8 +15234,6 @@ Medium
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -14959,8 +15258,6 @@ Shape
 \end_inset
 
  [
-\emph on
-
 \begin_inset Flex CharStyle:Code
 status collapsed
 
@@ -14972,8 +15269,6 @@ Up
 
 \end_inset
 
-
-\emph default
 , 
 \begin_inset Flex CharStyle:Code
 status collapsed
@@ -15547,7 +15842,11 @@ HTMLForceCSS
 status collapsed
 
 \begin_layout Plain Layout
-0,1
+
+\emph on
+0
+\emph default
+,1
 \end_layout
 
 \end_inset
@@ -15777,7 +16076,11 @@ HTMLLabelFirst
 status collapsed
 
 \begin_layout Plain Layout
-0,1
+
+\emph on
+0
+\emph default
+,1
 \end_layout
 
 \end_inset
@@ -15923,6 +16226,66 @@ div
 .
 \end_layout
 
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTitle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Marks this style as the one to be used to generate the 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<title>
+\end_layout
+
+\end_inset
+
+ tag for the XHTML file.
+ By default, it is false.
+ The 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+stdtitle.inc
+\end_layout
+
+\end_inset
+
+ file sets it to true for the 
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+title
+\end_layout
+
+\end_inset
+
+ environment.
+\end_layout
+
 \begin_layout Subsection
 InsetLayout XHTML
 \end_layout