]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/UserGuide.lyx
A bit of User Guide documentation for XHTML output.
[lyx.git] / lib / doc / UserGuide.lyx
index 3ac3ca0171bd3428ce1868db1840b8cb3e9e454f..f5b09dca9d1f12b62ac4211f3357710c2a8ce61f 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 370
+\lyxformat 375
 \begin_document
 \begin_header
 \textclass scrbook
@@ -58,6 +58,7 @@
 \use_default_options false
 \language english
 \inputencoding auto
+\fontencoding global
 \font_roman default
 \font_sans default
 \font_typewriter default
@@ -92,7 +93,8 @@
 \papersize default
 \use_geometry false
 \use_amsmath 1
-\use_esint 0
+\use_esint 1
+\use_mhchem 1
 \cite_engine basic
 \use_bibtopic false
 \use_indices false
 \color #008000
 \end_index
 \secnumdepth 3
-\tocdepth 3
+\tocdepth 2
 \paragraph_separation indent
 \paragraph_indentation default
 \quotes_language english
 \paperpagestyle default
 \tracking_changes true
 \output_changes false
-\author 1 "Jürgen Spitzmüller" 
+\html_use_mathml true
+\html_be_strict true
+\author 1 "Richard Heck" 
 \end_header
 
 \begin_body
@@ -13048,6 +13052,91 @@ pdftex
 dvipdfm
 \family default
  is no longer under development and therefore a bit outdated.
+\change_inserted 1 1262887469
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\change_inserted 1 1262887469
+XHTML
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1 1262887469
+FileFormats! XHTML
+\end_layout
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1 1262887469
+HTML
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1262888147
+This file type has the extension 
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+.xhtml
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ It is a file suitable for viewing in web browsers.
+ It does not itself contain images and the like but only links them, and
+ when LyX produces XHTML, it also generates corresponding images in formats
+ suitable for the purpose.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1262888092
+As of this writing, LyX's `native' XHTML output remains somewhat `experimental',
+ and not all LyX features work properly.
+ It is our hope, however, that native output will solve many of the problems
+ users have encountered when using third-party LyX- or LaTeX-to-HTML converters.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1262888116
+Math is output as MathML, which renders nicely in browsers that support
+ it, but not all do.
+ Eventually, we will offer the option of instead outputing math as images.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 1 1262888178
+You can export your document as an XHTML file using the menu item 
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LyXHTML
+\family default
+.
+\change_unchanged
+
 \end_layout
 
 \begin_layout Subsection
@@ -21868,7 +21957,7 @@ sin
 \end_inset
 
  does normally mean 
-\begin_inset Formula $s·i·n$
+\begin_inset Formula $s\cdot i\cdot n$
 \end_inset
 
 .
@@ -25582,25 +25671,13 @@ Entry
 \end_inset
 
 .
- A 
-\change_deleted 1 1250501350
-gray 
-\change_unchanged
-box labeled 
+ A box labeled 
 \begin_inset Quotes eld
 \end_inset
 
 
 \family sans
-I
-\change_inserted 1 1250501353
-n
-\change_unchanged
-d
-\change_inserted 1 1250501354
-e
-\change_unchanged
-x
+Index
 \family default
 
 \begin_inset Quotes erd
@@ -25624,12 +25701,6 @@ key "latexcompanion,latexguide,latexbook"
 .
 \end_layout
 
-\begin_layout Standard
-
-\change_deleted 1 1250501388
-You can change index entries by clicking on the index box.
-\end_layout
-
 \begin_layout Standard
 The index list is inserted in the document with the menu 
 \family sans
@@ -26384,8 +26455,6 @@ key "makeindex,xindy"
 \end_inset
 
 .
-\change_inserted 1 1250502076
-
 \end_layout
 
 \begin_layout Subsection
@@ -26410,34 +26479,20 @@ name "sub:Index-Program"
 \end_layout
 
 \begin_layout Standard
-
-\change_deleted 1 1250501423
-When
-\change_inserted 1 1250501423
-If
-\change_unchanged
- the index entry program 
+If the index entry program 
 \family sans
 xindy
-\change_deleted 1 1250501596
-
 \family default
-, which is only available for Linux,
-\change_unchanged
  is installed, LyX uses it for index generation; otherwise the program 
 \family sans
 makeindex
 \family default
 , that is part of every LaTeX distribution, is used.
-\change_inserted 1 1250501973
-
 \begin_inset Foot
 status collapsed
 
 \begin_layout Plain Layout
 
-\change_inserted 1 1250502015
-
 \family sans
 Makeindex
 \family default
@@ -26451,14 +26506,10 @@ Makeindex
 xindy
 \family default
 .
-\change_unchanged
-
 \end_layout
 
 \end_inset
 
-
-\change_unchanged
  Both programs can be controlled by options that can be set in LyX's preferences
  dialog, see section
 \begin_inset space ~
@@ -26480,28 +26531,11 @@ key "makeindex,xindy"
 \end_inset
 
 .
-\change_inserted 1 1250501656
-In this dialog, 
-\change_deleted 1 1250501657
-Y
-\change_inserted 1 1250501657
-y
-\change_unchanged
-ou can also specify 
-\change_deleted 1 1250501665
-there another
-\change_inserted 1 1250501676
-an alternative
-\change_unchanged
- program to generate the index.
-\change_inserted 1 1250501450
-
+ In this dialog, you can also specify an alternative program to generate
+ the index.
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250501906
 If you need specific options or an alternative index program only for a
  given document, you can define the programm and\SpecialChar \slash{}
 or the options in 
@@ -26514,40 +26548,13 @@ Indexes
 .
  This is especially useful if you need to pass language-specific options
  to the index program or if you need a specific layout style.
-\change_deleted 1 1250501980
-
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted 1 1250501966
-
-\family sans
-makeindex
-\family default
- is very old, no longer under development and has many pitfalls, notably
- that it was developed with only the English language in mind.
- So it fails to sort anything other than a monolingual English text correctly.
- We have shown above how to fix this sorting.
- However, if you are writing in another language and using Linux, consider
- to use 
-\family sans
-xindy
-\family default
-.
-\change_inserted 1 1250502093
-
 \end_layout
 
 \begin_layout Subsection
-
-\change_inserted 1 1250502212
 Multiple Indexes
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250502759
 In many fields, it is common to have more than one index.
  For instance, you might need to set up a separate 
 \begin_inset Quotes eld
@@ -26569,8 +26576,6 @@ splitidx
 status collapsed
 
 \begin_layout Plain Layout
-
-\change_inserted 1 1250502516
 LaTeX-packages ! splitidx
 \end_layout
 
@@ -26592,8 +26597,6 @@ key "TeXCatalogue"
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250503374
 To set up LyX for the use of multiple indexes, go to 
 \family sans
 Document\SpecialChar \menuseparator
@@ -26654,8 +26657,6 @@ Alter Color\SpecialChar \ldots{}
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250503916
 Once the document changes have been applied, you can find the new index
  list in 
 \family sans
@@ -26680,15 +26681,11 @@ Insert
 \end_layout
 
 \begin_layout Itemize
-
-\change_inserted 1 1250503922
 If you want to change the attribution of a specific index entry, right-clicking
  on the entry will open a dialog where you can do that.
 \end_layout
 
 \begin_layout Itemize
-
-\change_inserted 1 1250504088
 By right-clicking on an index, you can change its type.
  Furthermore, you can specify an index list to be a 
 \begin_inset Quotes eld
@@ -28428,9 +28425,7 @@ preview
 Tools\SpecialChar \menuseparator
 Preferences 
 \family default
-dialog under 
-\family sans
-Look
+dialog under Look
 \begin_inset space ~
 \end_inset
 
@@ -28439,9 +28434,16 @@ and
 \end_inset
 
 feel\SpecialChar \menuseparator
-Graphics
+Display.
+ The 
+\family sans
+Preview
+\begin_inset space ~
+\end_inset
+
+Size
 \family default
-.
+ is the multiplication factor for the size.
 \end_layout
 
 \begin_layout Standard
@@ -34605,6 +34607,14 @@ Close
 Closes the current document.
 \end_layout
 
+\begin_layout Subsection
+Close All
+\end_layout
+
+\begin_layout Standard
+Closes all opened documents.
+\end_layout
+
 \begin_layout Subsection
 Save
 \end_layout
@@ -34710,8 +34720,9 @@ You can export your document to various file formats.
 \end_layout
 
 \begin_layout Standard
-Here is a list of all available entries; they are explained in detail in
- section
+Here is a list of all available entries
+\change_deleted 1 1262887786
+; they are explained in detail in section
 \begin_inset space ~
 \end_inset
 
@@ -34723,6 +34734,10 @@ reference "sub:Output-file-formats"
 \end_inset
 
 :
+\change_inserted 1 1262887786
+:
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34735,7 +34750,25 @@ CJK
 LyX 
 \family default
 format of the special LyX 1.4.x versions for Chinese, Japanese, and Korean
- (CJK); (Since LyX 1.5.0 CJK support is fully integrated to LyX.)
+ (CJK)
+\change_deleted 1 1262887560
+;
+\change_inserted 1 1262887561
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_unchanged
+\change_deleted 1 1262887562
+(
+\change_unchanged
+Since LyX 1.5.0 CJK support is fully integrated to LyX.
+\change_deleted 1 1262887564
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34744,11 +34777,61 @@ format of the special LyX 1.4.x versions for Chinese, Japanese, and Korean
 DVI
 \family default
  DVI-format
+\change_inserted 1 1262887797
+ (see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
-HTML HTML-format (the HTML-converter is a third-party product and doesn't
- work in all cases)
+HTML HTML-format
+\change_inserted 1 1262887568
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_deleted 1 1262887572
+ (t
+\change_inserted 1 1262887573
+T
+\change_unchanged
+he HTML
+\change_inserted 1 1262887602
+\change_deleted 1 1262887603
+-
+\change_unchanged
+conver
+\change_inserted 1 1262887606
+sion
+\change_deleted 1 1262887609
+ter
+\change_unchanged
+ is 
+\change_inserted 1 1262887612
+performed by 
+\change_unchanged
+a third-party product and 
+\change_inserted 1 1262887674
+may 
+\change_deleted 1 1262887617
+doesn't 
+\change_unchanged
+work in all cases
+\change_inserted 1 1262887618
+.
+\change_deleted 1 1262887618
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
 \end_inset
 
  is replaced by the version number)
+\change_inserted 1 1262887695
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 1 1262887844
+LyXHTML HTML-format, using LyX's internal XHTML engine (see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34859,8 +34959,46 @@ KOffice
 Abiword
 \family default
 , etc.
- (the OpenDocument-converter is a third-party product and doesn't work in
- all cases)
+\change_inserted 1 1262887646
+
+\begin_inset Newline newline
+\end_inset
+
+
+\change_deleted 1 1262887649
+ (t
+\change_inserted 1 1262887649
+T
+\change_unchanged
+he OpenDocument
+\change_inserted 1 1262887652
+\change_deleted 1 1262887652
+-
+\change_unchanged
+conver
+\change_inserted 1 1262887656
+sion
+\change_deleted 1 1262887654
+ter
+\change_unchanged
+ is 
+\change_inserted 1 1262887659
+performed by 
+\change_unchanged
+a third-party product and 
+\change_inserted 1 1262887665
+may not 
+\change_deleted 1 1262887667
+doesn't 
+\change_unchanged
+work in all cases
+\change_inserted 1 1262887669
+.
+\change_deleted 1 1262887670
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34875,6 +35013,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 dvipdfm
+\change_inserted 1 1262887911
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34889,6 +35040,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 pdflatex
+\change_inserted 1 1262887913
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34903,6 +35067,19 @@ PDF
  PDF-format using the program 
 \family typewriter
 ps2pdf
+\change_inserted 1 1262887914
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -34944,6 +35121,19 @@ Postscript
  PostScript format using the program 
 \family typewriter
 dvips
+\change_inserted 1 1262887921
+\family default
+(see 
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Output-file-formats"
+
+\end_inset
+
+)
+\change_unchanged
+
 \end_layout
 
 \begin_layout Description
@@ -35478,13 +35668,13 @@ This will split LyX's main window vertically or horizontally.
  or more documents at the same time.
  To return to an unsplit view, use the menu 
 \family sans
-Close Tab Group
+Close Current View
 \family default
 .
 \end_layout
 
 \begin_layout Subsection
-Close Tab Group
+Close Current View
 \end_layout
 
 \begin_layout Standard
@@ -40127,13 +40317,7 @@ Bibliography
 \end_layout
 
 \begin_layout Standard
-You can specify here a citation style using the LaTeX
-\change_inserted 1 1250501112
-\change_deleted 1 1250501112
--
-\change_unchanged
-packages 
+You can specify here a citation style using the LaTeX packages 
 \series bold
 natbib
 \series default
@@ -40161,8 +40345,6 @@ LaTeX-packages ! jurabib
 
 \end_inset
 
-
-\change_inserted 1 1250501161
 , you can enable subdivided bibliographies using the LaTeX package 
 \series bold
 bibtopic
@@ -40172,17 +40354,13 @@ bibtopic
 status collapsed
 
 \begin_layout Plain Layout
-
-\change_inserted 1 1250501123
 LaTeX-packages ! bibtopic
 \end_layout
 
 \end_inset
 
  and you can customize how the bibliography of the given document is being
- generated
-\change_unchanged
-.
+ generated.
  For a further description see section
 \begin_inset space ~
 \end_inset
@@ -40195,19 +40373,13 @@ reference "sec:Bibliography"
 \end_inset
 
 .
-\change_inserted 1 1250501100
-
 \end_layout
 
 \begin_layout Section
-
-\change_inserted 1 1250500845
 Indexes
 \end_layout
 
 \begin_layout Standard
-
-\change_inserted 1 1250501193
 Here, you can customize how the index of your document is being generated
  and you can define additional indexes.
  Please refer to section
@@ -40222,8 +40394,6 @@ reference "sec:Index"
 \end_inset
 
  for details.
-\change_unchanged
-
 \end_layout
 
 \begin_layout Section
@@ -40956,12 +41126,12 @@ Alter
 \end_layout
 
 \begin_layout Subsection
-Graphics
+Display
 \begin_inset Index idx
 status collapsed
 
 \begin_layout Plain Layout
-Settings ! Graphics
+Settings ! Display
 \end_layout
 
 \end_inset
@@ -40970,7 +41140,7 @@ Settings ! Graphics
 \end_layout
 
 \begin_layout Standard
-Here you can specify how graphics inside LyX are displayed.
+Here you can specify if graphics inside LyX are displayed.
 \end_layout
 
 \begin_layout Standard
@@ -40993,6 +41163,26 @@ reference "sec:Previewing-snippets-of"
 .
 \end_layout
 
+\begin_layout Standard
+The option 
+\family sans
+Mark
+\begin_inset space ~
+\end_inset
+
+end
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+
+paragraphs
+\family default
+ displays a pilcrow (¶) at the end of every paragraph.
+\end_layout
+
 \begin_layout Section
 Editing
 \begin_inset Index idx