]> git.lyx.org Git - features.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx: revision of appendix B and some new descriptions of export file formats
[features.git] / lib / doc / UserGuide.lyx
index 3fa3aaa52f3ec7b3117de55037b635a4a27c5034..25de08286dc509871d8350fbfb95300297a23470 100644 (file)
@@ -2877,6 +2877,13 @@ Note:
 
 \begin_layout Subsubsection
 Local Layout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Local-Layout"
+
+\end_inset
+
+
 \begin_inset Index idx
 status collapsed
 
@@ -14931,7 +14938,7 @@ You can export your document as an XHTML file using the menu item
 \family sans
 File\SpecialChar \menuseparator
 Export\SpecialChar \menuseparator
-LyX-HTML
+LyXHTML
 \family default
 .
 \end_layout
@@ -14970,7 +14977,7 @@ arg   "buffer-view"
 .
  A viewing program will pop up showing the output in the defined default
  output format, which is globally set in the preferences (see sec.
-\begin_inset space ~
+\begin_inset space \thinspace{}
 \end_inset
 
 
@@ -14982,7 +14989,7 @@ reference "sec:File-Formats"
 
 ) and can also be altered for single documents in the document settings
  (see sec.
-\begin_inset space ~
+\begin_inset space \thinspace{}
 \end_inset
 
 
@@ -37579,6 +37586,24 @@ yX format of the special LyX
  Since LyX 1.5.0 CJK support is fully integrated to LyX.
 \end_layout
 
+\begin_layout Description
+DocBook text file with code in the language SGML that is used for the markup
+ language 
+\family typewriter
+DocBook
+\end_layout
+
+\begin_layout Description
+DocBook
+\begin_inset space ~
+\end_inset
+
+(XML) text file with code in the language XML that is used for the markup
+ language 
+\family typewriter
+DocBook
+\end_layout
+
 \begin_layout Description
 DraftDVI LaTeX's native DVI-format.
  This format is not suitable if you have special characters or spaces in
@@ -37618,6 +37643,20 @@ LuaTeX
 ; supports Unicode and the usage of non-TeX fonts
 \end_layout
 
+\begin_layout Description
+Graphviz
+\begin_inset space ~
+\end_inset
+
+Dot text file with code in the programming language 
+\family typewriter
+Dot
+\family default
+ that is used to draw visualizations of graphs via the program 
+\family typewriter
+Graphviz
+\end_layout
+
 \begin_layout Description
 HTML HTML-format (the HTML-converter is a third-party product and may not
  work in all cases)
@@ -37789,6 +37828,36 @@ text file with the LaTeX source that it is compilable with the program
 XeTeX
 \end_layout
 
+\begin_layout Description
+LilyPond
+\begin_inset space ~
+\end_inset
+
+book
+\begin_inset space ~
+\end_inset
+
+(La
+\family sans
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
+
+\end_inset
+
+
+\family default
+TeX) text file with the LaTeX source and also code in the syntax of the
+ music notation software 
+\family typewriter
+LilyPond
+\end_layout
+
 \begin_layout Description
 L
 \family sans
@@ -37876,6 +37945,12 @@ status collapsed
 yXHTML HTML-format using LyX's internal XHTML engine
 \end_layout
 
+\begin_layout Description
+NoWeb text file with code in the format of the literate programming language
+\family typewriter
+ NoWeb
+\end_layout
+
 \begin_layout Description
 OpenDocument OpenDocument-formatted file, to be opened with 
 \family sans
@@ -38037,6 +38112,28 @@ Postscript
 dvips
 \end_layout
 
+\begin_layout Description
+Sweave text file with the LaTeX source and also code in the statistical
+ programming language 
+\family typewriter
+R
+\family default
+.
+ Using the 
+\family typewriter
+R
+\family default
+-function 
+\family typewriter
+Sweave
+\family default
+ it is possible to use 
+\family typewriter
+R
+\family default
+-commands in LaTeX
+\end_layout
+
 \begin_layout Standard
 If one of the menu entries 
 \family sans
@@ -42765,6 +42862,25 @@ reference "sub:Modules"
 .
 \end_layout
 
+\begin_layout Section
+Local Layout
+\end_layout
+
+\begin_layout Standard
+See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Local-Layout"
+
+\end_inset
+
+ for a description.
+\end_layout
+
 \begin_layout Section
 Fonts
 \end_layout
@@ -42796,24 +42912,11 @@ You can specify if paragraphs should be separated by indentations or vertical
 \end_layout
 
 \begin_layout Standard
-Note that LyX won't show two columns or the set up line spacing on screen.
- That's impractical, often unreadable, and not part of the WYSIWYM concept.
+Note that LyX will not show two columns or the set up line spacing on screen.
+ That is impractical, often unreadable, and not part of the WYSIWYM concept.
  However, it will be as you specified it in the output.
 \end_layout
 
-\begin_layout Standard
-The listings settings are explained in the corresponding section in the
-\emph on
-Embedded
-\begin_inset space ~
-\end_inset
-
-Objects
-\emph default
- manual.
-\end_layout
-
 \begin_layout Section
 Page Layout
 \end_layout
@@ -42861,6 +42964,13 @@ reference "sub:Margins"
 
 \begin_layout Section
 Language
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Language-encodings"
+
+\end_inset
+
+
 \begin_inset Index idx
 status collapsed
 
@@ -42884,7 +42994,11 @@ The document language and quote styles are set here.
 status collapsed
 
 \begin_layout Plain Layout
-The known commands are defined in a text file.
+The known commands are defined in a text file (
+\emph on
+unicodesymbols
+\emph default
+).
  You can add commands for unknown symbols to that file yourself, see the
  
 \emph on
@@ -42974,7 +43088,7 @@ DVI
 
 (LuaTeX)
 \family default
-; see section
+, see section
 \begin_inset space ~
 \end_inset
 
@@ -42985,7 +43099,115 @@ reference "sub:Output-file-formats"
 
 \end_inset
 
-), so if the above options fail, you might try out one of these new engines.
+).
+ So if you are using many special or accented characters and 
+\family sans
+Language Default
+\family default
+ fails, you might try out one of these new engines.
+\end_layout
+
+\begin_layout Standard
+The 
+\family sans
+Language
+\begin_inset space ~
+\end_inset
+
+package
+\family default
+ determines the LaTeX-package that is used for hyphenation and the translation
+ of strings like 
+\begin_inset Quotes eld
+\end_inset
+
+Part
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The possible settings are:
+\end_layout
+
+\begin_layout Description
+Default is the package 
+\series bold
+babel
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! babel
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+Automatic 
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+TODO
+\end_layout
+
+\end_inset
+
+??
+\end_layout
+
+\begin_layout Description
+Always
+\begin_inset space ~
+\end_inset
+
+Babel uses in every case 
+\series bold
+babel
+\series default
+.
+\end_layout
+
+\begin_layout Description
+Custom allows you to specify a language package command of your choice.
+ For example, if you want to use XeTeX and therefore want to the package
+\series bold
+polyglossia
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! polyglossia
+\end_layout
+
+\end_inset
+
+ instead of 
+\series bold
+babel
+\series default
+, type in
+\series bold
+
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+usepackage{polyglossia}
+\end_layout
+
+\begin_layout Description
+None will not use a language package.
+ This necessary for some document classes for scientific articles.
 \end_layout
 
 \begin_layout Standard
@@ -43694,7 +43916,8 @@ LaTeX-packages ! jurabib
 
 \end_inset
 
-, you can enable subdivided bibliographies using the LaTeX package 
+.
+ You can enable subdivided bibliographies using the LaTeX package 
 \series bold
 bibtopic
 \series default
@@ -43783,7 +44006,7 @@ LaTeX-packages ! amsmath
 
 \end_inset
 
- and 
+, 
 \series bold
 esint
 \series default
@@ -43797,24 +44020,84 @@ LaTeX-packages ! esint
 
 \end_inset
 
- or to use them automatically when they are needed.
+, mathdots
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! mathdots
 \end_layout
 
-\begin_layout Standard
+\end_inset
 
+ und 
 \series bold
-amsmath
+mhchem
 \series default
- is needed for many constructs, so when you get LaTeX-errors in formulas,
- ensure that you have enabled AMS.
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! mhchem
 \end_layout
 
-\begin_layout Standard
+\end_inset
 
-\series bold
-esint
-\series default
- is used for special integral characters.
+ or to use them automatically when they are needed.
+\end_layout
+
+\begin_layout Description
+amsmath is needed for many constructs, so when you get LaTeX-errors in formulas,
+ ensure that you have enabled 
+\family sans
+AMS
+\begin_inset space ~
+\end_inset
+
+math
+\family default
+.
+\end_layout
+
+\begin_layout Description
+esint is used for special integral characters, see section 
+\emph on
+Big
+\begin_inset space ~
+\end_inset
+
+Operators
+\emph default
+ of the 
+\emph on
+Math
+\emph default
+ manual.
+\end_layout
+
+\begin_layout Description
+mathdots is used for special ellipses, see section 
+\emph on
+Ellipses
+\emph default
+ of the 
+\emph on
+Math
+\emph default
+ manual.
+\end_layout
+
+\begin_layout Description
+mhchem is used for chemical equations, see section 
+\emph on
+Chemical Symbols and Equations
+\emph default
+ of the 
+\emph on
+Math
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Section
@@ -43841,6 +44124,26 @@ Objects
  manual.
 \end_layout
 
+\begin_layout Section
+Listings
+\end_layout
+
+\begin_layout Standard
+The listings settings are explained in chapter 
+\emph on
+Program Code Listings
+\emph default
+ of the 
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual.
+\end_layout
+
 \begin_layout Section
 Bullets
 \end_layout
@@ -43947,7 +44250,11 @@ Tools\SpecialChar \menuseparator
 Preferences\SpecialChar \menuseparator
 File Formats
 \family default
-, see 
+, see sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
 \begin_inset CommandInset ref
 LatexCommand formatted
 reference "sec:File-Formats"
@@ -43966,17 +44273,29 @@ with
 \begin_inset space ~
 \end_inset
 
-Output
-\begin_inset Note Note
-status open
-
-\begin_layout Plain Layout
-TODO!
-\end_layout
-
+Output settings for the menu 
+\family sans
+Navigate\SpecialChar \menuseparator
+Forward
+\begin_inset space ~
 \end_inset
 
+search
+\family default
+.
+ For a detailed description see section 
+\emph on
+Reverse DVI/PDF search
+\emph default
+ of the 
+\emph on
+Additional
+\begin_inset space ~
+\end_inset
 
+Features
+\emph default
+ manual.
 \end_layout
 
 \begin_layout Description
@@ -43988,17 +44307,46 @@ Output
 \begin_inset space ~
 \end_inset
 
-Options
-\begin_inset Note Note
-status open
+Options settings for the export format 
+\family sans
+LyXHTML
+\family default
+.
+\family sans
+Strict XHTML
+\begin_inset space ~
+\end_inset
 
-\begin_layout Plain Layout
-TODO!
-\end_layout
+1.1
+\family default
+ will assure that the output follows exactly version
+\begin_inset space ~
+\end_inset
 
+1.1 of the XHTML standard.
+ The different 
+\family sans
+Math
+\begin_inset space ~
 \end_inset
 
+output
+\family default
+ settings are described in detail in section 
+\emph on
+Math Output in XHTML
+\emph default
+ of the 
+\emph on
+Additional
+\begin_inset space ~
+\end_inset
 
+Features
+\emph default
+ manual.
+ The scaling is used for the size of equations in the output.
 \end_layout
 
 \begin_layout Section
@@ -45284,7 +45632,7 @@ Example
 \family typewriter
 JabRef
 \family default
- bearbeiten.
+.
  In 
 \family typewriter
 JabRef
@@ -45478,76 +45826,49 @@ Table
 \series bold
 babel
 \series default
-, it's the default language package in classic LaTeX.
- However, more recent typesetting engines such as XeTeX and LuaTeX come
- with an alternative language package (
-\series bold
-polyglossia
-\series default
-) that is more suited for the multi-script support of these engines.
- Furthermore, there are also specific language packages for languages not
- covered by babel.
-\begin_inset Newline newline
-\end_inset
 
-The available selections are:
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! babel
 \end_layout
 
-\begin_deeper
-\begin_layout Itemize
-\noindent
+\end_inset
 
+, it is the default language package in classic LaTeX.
+ However, more recent typesetting engines such as XeTeX and LuaTeX come
+ with the alternative language package 
 \series bold
-Automatic
-\series default
-:
-\series bold
+polyglossia
 \series default
-Selects the most appropriate language package for the current typesetting
- engine (default)
-\end_layout
 
-\begin_layout Itemize
-\noindent
+\begin_inset Index idx
+status collapsed
 
-\series bold
-Always babel: 
-\series default
-Uses always babel, even if another package (such as polyglossia) would have
- been preferred by automatic setting; this essentially allows to select
- babel instead of polyglossia with XeTeX and LuaTeX
+\begin_layout Plain Layout
+LaTeX-packages ! polyglossia
 \end_layout
 
-\begin_layout Itemize
-\noindent
+\end_inset
 
-\series bold
-Custom: 
-\series default
-Lets you load some other language package (via 
-\family typewriter
+ that is more suited for the multi-script support of these engines.
+ Furthermore, there are also specific language packages for languages not
+ covered by babel.
+ The available selections are described in sec.
+\begin_inset space \thinspace{}
+\end_inset
 
-\backslash
-usepackage
-\series bold
-{
-\series default
-packagename}
-\family default
-)
-\end_layout
 
-\begin_layout Itemize
-\noindent
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Language-encodings"
 
-\series bold
-None: 
-\series default
-Loads no language package at all
+\end_inset
+
+.
 \end_layout
 
-\end_deeper
 \begin_layout Description
 Default
 \begin_inset space ~