]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Additional.lyx
enhance documentation of forward/reverse search
[lyx.git] / lib / doc / Additional.lyx
index 7c82d0b33c1ae6ceb3a5a3dcac95e6fed0e037ac..34280b187ade0462b4e758523c87d9e11d29fe46 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 407
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
 \begin_document
 \begin_header
 \textclass scrbook
@@ -68,13 +68,14 @@ EndPreamble
 End
 \end_local_layout
 \language english
+\language_package default
 \inputencoding latin1
 \fontencoding global
 \font_roman default
 \font_sans default
 \font_typewriter default
 \font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
 \font_sc false
 \font_osf false
 \font_sf_scale 100
@@ -126,9 +127,10 @@ End
 \papercolumns 1
 \papersides 2
 \paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
 \output_changes false
 \html_math_output 0
+\html_css_as_file 0
 \html_be_strict true
 \end_header
 
@@ -4258,8 +4260,19 @@ eLyXer
 
 \end_inset
 
- solves some of these problems.
- In particular, its rendering of math tends to look better than 
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
+
+\end_inset
+
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with 
 \begin_inset Flex Code
 status collapsed
 
@@ -4269,20 +4282,29 @@ htlatex
 
 \end_inset
 
-'s, at least in simpler cases, since it renders math using a combination
- of HTML and CSS rather than converting the formulae to images.
- But more complex formula tend to be rendered less well than with 
+; this reflects the limitations of HTML.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+That said, 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-htlatex
+eLyXer
+\end_layout
+
+\end_inset
+
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
 \end_layout
 
 \end_inset
 
-, since there is no reasonable way of scaling parentheses in HTML, for example.
- More importantly (as of version 0.39, at least), 
+ More importantly (as of version 1.1.1, at least), 
 \begin_inset Flex Code
 status collapsed
 
@@ -4292,9 +4314,8 @@ eLyXer
 
 \end_inset
 
- has no support for math macros, for user-defined paragraph or character
- styles, or for tables of contents and figures, and its treatment of cross-refer
-ences is minimal.
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
  These limitations make 
 \begin_inset Flex Code
 status collapsed
@@ -4305,11 +4326,11 @@ eLyXer
 
 \end_inset
 
- unsuitable for many of the documents more advanced LyX users would produce.
- In principle, of course, all of these problems could be solved, but the
- LyX developers have decided to follow a different path and have made LyX
- itself capable of writing XHTML, just as it is capable of writing LaTeX,
DocBook, and plaintext.
+ unsuitable for many of the documents LyX users produce.
+ In principle, of course, these problems could be solved, but the LyX developers
+ have decided to follow a different path and have made LyX itself capable
+ of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
+ plaintext.
 \end_layout
 
 \begin_layout Standard
@@ -4346,6 +4367,15 @@ target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.no
 \end_inset
 
 , usually contains up-to-date information about the state of XHTML output.
+ See also the list of XHTML bugs on 
+\begin_inset CommandInset href
+LatexCommand href
+name "the bug tracker"
+target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
+
+\end_inset
+
+.
 \end_layout
 
 \end_inset
@@ -4362,7 +4392,7 @@ These advantages are primarily due to the fact that the XHTML output routines,
 status collapsed
 
 \begin_layout Plain Layout
-Another advantege is that, since these routines are internal to LyX, they
+Another advantage is that, since these routines are internal to LyX, they
  are immune to changes in LyX's file format, or to changes in the semantics
  of existing insets.
 \end_layout
@@ -4398,7 +4428,7 @@ Kapitel
 \end_layout
 
 \begin_layout Standard
-Quite generally, the output routines know everything LyX knows about document
+Quite generally, the output routines know what LyX knows about document
  layout, that is, about how the document is to be rendered on screen.
  We use this information when we output the document as XHTML.
  In particular, LyX 
@@ -4421,10 +4451,7 @@ automatically
 \end_layout
 
 \begin_layout Standard
-The result is that XHTML output can be customized and extended in 
-\emph on
-exactly
-\emph default
+The result is that XHTML output can be customized and extended in exactly
  the same way LaTeX output can be customized and extended: through layout
  files and modules.
  See chapter five of the 
@@ -4518,7 +4545,7 @@ elyxer
 \begin_inset Newline newline
 \end_inset
 
-If Lyx is unable to render a formula as MathML---for example, if the formula
+If Lyx is unable to render a formula as HTML---for example, if the formula
  uses the 
 \begin_inset Flex Code
 status collapsed
@@ -4567,6 +4594,16 @@ have to be on for images to be output, however.
  LaTeX, so they are very accurate.
  The disadvantage, as mentioned earlier, is that these are bitmapped images,
  so they do not scale terribly well, and one cannot copy them, etc.
+ (As of this writing, there are also problems about equation numbering.
+ See 
+\begin_inset CommandInset href
+LatexCommand href
+name "bug 6894"
+target "http://www.lyx.org/trac/ticket/6894"
+
+\end_inset
+
+.)
 \begin_inset Newline newline
 \end_inset
 
@@ -4890,6 +4927,7 @@ Nomenclature and Glossary
 
 \begin_layout Standard
 There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
 \end_layout
 
 \begin_layout Chapter
@@ -5049,7 +5087,7 @@ lyxpipe"
 
 \end_inset
 
- on Windows.
+ on Windows (but any working path can be used).
  You 
 \emph on
 must
@@ -5491,7 +5529,7 @@ name "sub:rev-search"
 
 \end_inset
 
-Automatical enabling
+Automatic setup
 \end_layout
 
 \begin_layout Standard
@@ -5502,20 +5540,20 @@ status collapsed
 \begin_layout Plain Layout
 Document\SpecialChar \menuseparator
 Output\SpecialChar \menuseparator
-Output Sync
+Synchronize with Output
 \end_layout
 
 \end_inset
 
 .
- In such a case LyX will automatically insert SyncTeX macro (for PDF) or
- srcltx package (for DVI) respectively.
+ In such a case LyX will automatically insert the necessary SyncTeX macro
(for PDF) or load the srcltx package (for DVI) respectively.
  This option can be easily reached also on 
 \begin_inset Flex Code
 status collapsed
 
 \begin_layout Plain Layout
-View/update
+View/Update
 \end_layout
 
 \end_inset
@@ -5524,7 +5562,46 @@ View/update
 \end_layout
 
 \begin_layout Standard
-Plase note that including 
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below 
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Please note that including the 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+srcltx
+\end_layout
+
+\end_inset
+
+ package or 
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
+\end_layout
+
+\end_inset
+
+ sometimes has an undesired impact on the typesetting.
+ Thus, you should switch output synchronization off for the final typesetting
+ if you use the 
 \begin_inset Flex Code
 status collapsed
 
@@ -5544,18 +5621,30 @@ src-specials
 
 \end_inset
 
- sometimes have an impact on the typeset and you should switch them off
- for the final typesets.
+.
 \end_layout
 
 \begin_layout Standard
-You can also define custom macro in preferences and in case you need some
- special tweaks read the next section about manual enabling.
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:configuring-viewers"
+
+\end_inset
+
+, where the necessary configuration steps in your viewer -- needed both
+ with the automatic and the manual setup -- are described.
 \end_layout
 
 \begin_layout Subsection
-Manual enabling
+Manual setup
 \end_layout
 
 \begin_layout Standard
@@ -5921,6 +6010,13 @@ status collapsed
 
 \begin_layout Subsection
 Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:configuring-viewers"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Subsubsection*
@@ -6699,8 +6795,46 @@ Forward search
 \end_layout
 
 \begin_layout Standard
-To make forward search possible you need to provide generated output PDF/DVI
- file with additional information about TeX sources.
+Forward search is, as the name implies, in a sense the 
+\begin_inset Quotes eld
+\end_inset
+
+opposite
+\begin_inset Quotes erd
+\end_inset
+
+ to reverse search.
+ It allows you to let the viewer jump to a given position from within LyX.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your LyX document, and hit 
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Navigate\SpecialChar \menuseparator
+Forward search
+\end_layout
+
+\end_inset
+
+ (or select 
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Forward search
+\end_layout
+
+\end_inset
+
+ in the context menu via right mouse click), and then the viewer will jump
+ to that position as well.
+ This implies, of course, that your viewer supports this function.
+\end_layout
+
+\begin_layout Standard
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the TeX sources.
  This can be done via the methods described in the section 
 \begin_inset CommandInset ref
 LatexCommand ref
@@ -6712,11 +6846,12 @@ reference "sub:rev-search"
 \end_layout
 
 \begin_layout Standard
-Secondly you need to configure LyX for using your viewers in 
+Additionally, you need to configure LyX for using your viewers in 
 \begin_inset Flex MenuItem
 status collapsed
 
 \begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
 Preferences\SpecialChar \menuseparator
 Output\SpecialChar \menuseparator
 General
@@ -6725,8 +6860,59 @@ General
 \end_inset
 
 .
- Only some of the viewers allows this operation --- yap, xdvi, okular, Sumatra
- PDF
+ We provide a range of tested configurations for some viewers, which you
+ can select from the drop down list.
+ If none of these configurations suits you, you have to find out and enter
+ a suitable configuration yourself.
+ The definition syntax uses the following placeholders: 
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
+\end_layout
+
+\end_inset
+
+: row number
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$o
+\end_layout
+
+\end_inset
+
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
+\end_layout
+
+\begin_layout Standard
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular and Sumatra PDF
 \begin_inset Foot
 status collapsed
 
@@ -6738,10 +6924,36 @@ ip
 \end_inset
 
 .
- Some other viewers allow at least reloading and positioning to particular
- page of the file --- Evince or xpdf --- for these cases you can use external
- call of synctex.
- Please study the prepared examples in the Preferences dialog.
+ While many of the widespread PDF viewers (most notably Adobe Reader) do
+ not support forward search at all, some other viewers -- e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ evince and xpdf -- allow at least to reload the document and jump to a
+ specific page of the file, so you can at least navigate 
+\begin_inset Quotes eld
+\end_inset
+
+near
+\begin_inset Quotes erd
+\end_inset
+
+.
+ These latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+\end_layout
+
+\begin_layout Standard
+Forward search works both with DVI and PDF output.
+ LyX simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
 \end_layout
 
 \begin_layout Chapter