[prev in list] [next in list] [prev in thread] [next in thread]
List: lyx-cvs
Subject: [LyX/master] Re-organization of Additional Features manual by John Hudson.
From: Richard Heck <rgheck () lyx ! org>
Date: 2016-06-29 16:20:43
Message-ID: 20160629162043.04CD42802A1 () lyx ! lyx ! org
[Download RAW message or body]
commit c16986161a03c69dbbd34537be9dd62675038c45
Author: Richard Heck <rgheck@lyx.org>
Date: Wed Jun 29 12:18:36 2016 -0400
Re-organization of Additional Features manual by John Hudson.
---
lib/doc/Additional.lyx |13687 ++++++++++++++++++++++++------------------------
1 files changed, 6872 insertions(+), 6815 deletions(-)
diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx
index 5360485..f1c28a6 100644
--- a/lib/doc/Additional.lyx
+++ b/lib/doc/Additional.lyx
@@ -1,5 +1,5 @@
-#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 508
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 510
\begin_document
\begin_header
\save_transient_properties true
@@ -52,6 +52,7 @@ shapepar
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
+\use_microtype false
\graphics default
\default_output_format pdf2
\output_sync 0
@@ -108,11 +109,13 @@ shapepar
\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 424524441 "rgheck"
+\author 893223064 "John Robert Hudson" j.r.hudson@virginmedia.com
\end_header
\begin_body
@@ -123,7 +126,13 @@ Additional \SpecialChar LyX
\end_layout
\begin_layout Subtitle
-Version 2.2.x
+Version 2.
+\change_inserted 424524441 1467174349
+3
+\change_deleted 424524441 1467174348
+2
+\change_unchanged
+.x
\end_layout
\begin_layout Author
@@ -2179,5420 +2188,18 @@ perhaps
\end_layout
\begin_layout Chapter
-Supplemental Tools
-\end_layout
-
-\begin_layout Section
-Customizing Bibliographies with Bib\SpecialChar TeX
-
-\end_layout
-
-\begin_layout Standard
-The most basic information about how to use Bib\SpecialChar TeX
- with \SpecialChar LyX
- is contained in the
- section
-\emph on
-Bibliography databases (Bib\SpecialChar TeX
-)
-\emph default
- of the
-\emph on
-User's Guide
-\emph default
-.
- The following subsections explain special bibliography features supported
- by \SpecialChar LyX
-.
-\end_layout
-
-\begin_layout Subsection
-Alternative Citation Styles
-\end_layout
-
-\begin_layout Standard
-Standard Bib\SpecialChar TeX
- uses numbers (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-[12]
-\begin_inset Quotes erd
-\end_inset
-
-) to refer to a cited work.
- However, in many scientific disciplines, other citation styles are in use.
- The most common one is the author-year style (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-Knuth 1984a
-\begin_inset Quotes erd
-\end_inset
-
-).
- \SpecialChar LyX
- supports two packages that provide this style,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-natbib
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-jurabib
-\end_layout
-
-\end_inset
-
-.
- Both packages have their pros and cons, which cannot be listed in detail.
- If you only want to have simple author-year (or author-numerical) style,
- or if you want to use one of the countless style files for
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-natbib
-\end_layout
-
-\end_inset
-
-, then the established
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-natbib
-\end_layout
-
-\end_inset
-
- package is probably your choice.
- If you need special features like short title references, ibidem etc., you
- might consider the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-jurabib
-\end_layout
-
-\end_inset
-
- package.
-\end_layout
-
-\begin_layout Standard
-The handling of both packages in \SpecialChar LyX
- is basically the same.
- Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- and select under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bibliography
-\end_layout
-
-\end_inset
-
- the option
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Natbib
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Jurabib
-\end_layout
-
-\end_inset
-
-.
- With both packages, you will get some extra features in the citation dialog
- and you can select the style of the reference (
-\begin_inset Quotes eld
-\end_inset
-
-Knuth 1984
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Knuth (1984)
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Knuth, 1984
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-1984
-\begin_inset Quotes erd
-\end_inset
-
- etc.).
- Note that both packages need specifically designed style files.
- They both ship their own, but there are lots of additional style files,
- and there is even an interactive style file builder
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-See
-\begin_inset Flex URL
-status open
-
-\begin_layout Plain Layout
-
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
- for
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-natbib
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-Sectioned Bibliographies
-\end_layout
-
-\begin_layout Standard
-Sometimes you might need to divide your bibliography into several sections.
- If you are for instance a historian, the possibility to separate sources
- and scientific works is most likely a
-\begin_inset Quotes eld
-\end_inset
-
-must have
-\begin_inset Quotes erd
-\end_inset
-
-.
- Unfortunately, Bib\SpecialChar TeX
- itself does not allow you to do this.
- But with the help of some \SpecialChar LaTeX
- packages, Bib\SpecialChar TeX
- can be extended to fit your needs.
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- provides native support for one of these packages,
-\family typewriter
-bibtopic
-\family default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Available from
-\begin_inset Flex URL
-status open
-
-\begin_layout Plain Layout
-
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
- The advantage of this package (compared to other packages like
-\family typewriter
-multibib
-\family default
-) is that you don't need to define new citation commands.
- Instead, you need to prepare different bibliographic databases which include
- the entries for the different sections of the bibliography.
- For example: If you want to divide your bibliography into the sections
-
-\begin_inset Quotes eld
-\end_inset
-
-Sources
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-Scientific works
-\begin_inset Quotes erd
-\end_inset
-
-, you first need to create two bibliographic databases, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-sources.bib
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-scientific.bib
-\end_layout
-
-\end_inset
-
-.
-
-\end_layout
-
-\begin_layout Standard
-Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- and check under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bibliography
-\end_layout
-
-\end_inset
-
- the option
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Sectioned bibliography
-\end_layout
-
-\end_inset
-
-.
- Now you can insert multiple Bib\SpecialChar TeX
- bibliographies, one for each section of
- your bibliography.
- Returning to our example: Insert the Bib\SpecialChar TeX
- bibliography
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-sources.bib
-\end_layout
-
-\end_inset
-
- and a second one for the database
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-scientific.bib
-\end_layout
-
-\end_inset
-
-.
- You are free to use the same or different styles for each section.
- Additionally, you can choose if the bibliography section should contain
-
-\begin_inset Quotes eld
-\end_inset
-
-all cited references
-\begin_inset Quotes erd
-\end_inset
-
- of the specified database(s) (which is the default),
-\begin_inset Quotes eld
-\end_inset
-
-all uncited references
-\begin_inset Quotes erd
-\end_inset
-
- or even
-\begin_inset Quotes eld
-\end_inset
-
-all references
-\begin_inset Quotes erd
-\end_inset
-
-.
- This might be useful if you would like to separate your bibliography into
- three sections:
-\begin_inset Quotes eld
-\end_inset
-
-Cited sources
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Uncited sources
-\begin_inset Quotes erd
-\end_inset
-
-, and
-\begin_inset Quotes eld
-\end_inset
-
-Scientific works
-\begin_inset Quotes erd
-\end_inset
-
-.
- The titles for the sections can be added as ordinary sections or subsections.
- Since
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-bibtopic
-\end_layout
-
-\end_inset
-
- removes the bibliography title, you have to manually re-add that, too (as
- a chapter* or section*, for instance).
-\end_layout
-
-\begin_layout Subsection
-Multiple Bibliographies
-\end_layout
-
-\begin_layout Standard
-Multiple bibliographies, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-a bibliography for each section or chapter of the document, are not supported
- by Bib\SpecialChar TeX
- itself.
- But the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-bibtopic
-\end_layout
-
-\end_inset
-
- package, which is used for the creation of sectioned bibliographies in
- \SpecialChar LyX
- (see the previous section), provides an easy way to solve this task, if
- you are willing to use some
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar TeX
- Code
-\end_layout
-
-\end_inset
-
- (see section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Inserting-TeX-Code"
-
-\end_inset
-
-).
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-An alternative approach is to use the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-chapterbib
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-bibunits
-\end_layout
-
-\end_inset
-
- package, respectively.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-First go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- and under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bibliography
-\end_layout
-
-\end_inset
-
- check
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Sectioned bibliography
-\end_layout
-
-\end_inset
-
-.
- In the document, you have to enclose the sections, which shall contain
- their own bibliography (including the Bib\SpecialChar TeX
- bibliography itself), between
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-begin{btUnit}
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-end{btUnit}
-\end_layout
-
-\end_inset
-
- (those commands have to be inserted as \SpecialChar TeX
- code).
- The bibliography will contain all references that have been cited in the
- current
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-btUnit
-\end_layout
-
-\end_inset
-
-.
-
-\series bold
-Note:
-\series default
- If you are using this approach, then every citation reference has to be
- inside some
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-btUnit
-\end_layout
-
-\end_inset
-
-.
- Also, the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-btUnit
-\end_layout
-
-\end_inset
-
-s cannot be nested.
-\end_layout
-
-\begin_layout Section
-Multipart Documents
-\end_layout
-
-\begin_layout Subsection
-General Operation
-\end_layout
-
-\begin_layout Standard
-When you are working on a large file with many sections, it is often convenient
- to break up the document into several files, or perhaps you have something
- where a table may change from time to time, but the preceding text does
- not.
- In these cases, you should seriously consider using multipart documents.
- For example, scientific papers often have five major sections: the introduction
-, observations, results, discussion, and conclusion.
- Each of these could be its own separate \SpecialChar LyX
- file, with one
-\begin_inset Quotes eld
-\end_inset
-
-master
-\begin_inset Quotes erd
-\end_inset
-
- file which contains the title, authors, abstract, references, etc., plus
- the five included files.
- It is important to note that each of these files is a full \SpecialChar LyX
- file which
- can be formatted and printed on its own, as well as included in a master
- file.
- Each of these files must have the same document class, however—don't attempt
- to mix book classes with article classes.
- You may also include \SpecialChar LaTeX
- files; however, these files must not have their own
- preamble (i.
-\begin_inset space \thinspace{}
-\end_inset
-
-e.
-\begin_inset space \space{}
-\end_inset
-
-everything up to and including the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-begin{document}
-\end_layout
-
-\end_inset
-
- line as well as the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-end{document}
-\end_layout
-
-\end_inset
-
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- allows you to include files quite easily with
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Insert\SpecialChar menuseparator
-ChiId
-\begin_inset space ~
-\end_inset
-
-Document
-\end_layout
-
-\end_inset
-
-.
- When you click on this selection a small box is inserted into the file
- at the current cursor location.
- Clicking on the box raises a dialog which allows you to select the file
- to be included, and the method of its inclusion.
-
-\end_layout
-
-\begin_layout Standard
-The file selection box should by now be obvious.
- The three inclusion methods are
-\begin_inset Quotes eld
-\end_inset
-
-include
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-input
-\begin_inset Quotes erd
-\end_inset
-
-, and
-\begin_inset Quotes eld
-\end_inset
-
-verbatim
-\begin_inset Quotes erd
-\end_inset
-
-.
- The difference between
-\begin_inset Quotes eld
-\end_inset
-
-include
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-input
-\begin_inset Quotes erd
-\end_inset
-
- is really only meaningful to \SpecialChar LaTeX
-perts, but the practical difference is that
- files that are
-\begin_inset Quotes eld
-\end_inset
-
-included
-\begin_inset Quotes erd
-\end_inset
-
- are typeset beginning on a new page, while files that are
-\begin_inset Quotes eld
-\end_inset
-
-inputted
-\begin_inset Quotes erd
-\end_inset
-
- are typeset starting on the current page.
-\end_layout
-
-\begin_layout Standard
-Generally, the master file is converted into a full \SpecialChar LaTeX
- file before typesetting,
- while the included files are converted to \SpecialChar LaTeX
- files that do not have all the
- preamble information.
-\end_layout
-
-\begin_layout Standard
-A
-\begin_inset Quotes eld
-\end_inset
-
-verbatim
-\begin_inset Quotes erd
-\end_inset
-
- included file allows you to include a file typeset exactly as it appears
- in the file, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-e.
-\begin_inset space \space{}
-\end_inset
-
-in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-verbatim
-\end_layout
-
-\end_inset
-
- mode, with the characters set in a fixed-width typewriter font.
- Normally, spaces in this file are invisible, though two consecutive spaces
- are conserved, unlike \SpecialChar LyX
-'s normal treatment of spaces.
- However, setting the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Mark
-\begin_inset space ~
-\end_inset
-
-spaces
-\begin_inset space ~
-\end_inset
-
-in
-\begin_inset space ~
-\end_inset
-
-output
-\end_layout
-
-\end_inset
-
- checkbox typesets a mark to unambiguously define the presence of a space.
-
-\end_layout
-
-\begin_layout Subsection
-Cross-References Between Files
-\end_layout
-
-\begin_layout Standard
-\begin_inset Box Shadowbox
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 0
-use_makebox 0
-width "100col%"
-special "none"
-height "1in"
-height_special "totalheight"
-thickness "0.4pt"
-separation "3pt"
-shadowsize "4pt"
-framecolor "black"
-backgroundcolor "none"
-status open
-
-\begin_layout Plain Layout
-This section is somewhat out of date.
- Need to describe default master documents and how children are opened when
- the master is.
- [[FIXME]]
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-It is possible to set up cross-references between the different files.
- First, open all the files in question: let's call them A and B in a two
- file example, where B is included in A.
- Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog whilst in document B, and you can select
- the
-\begin_inset Quotes eld
-\end_inset
-
-buffer
-\begin_inset Quotes erd
-\end_inset
-
- to use.
-\end_layout
-
-\begin_layout Subsection
-Bibliography Lists in all Subdocuments
-\end_layout
-
-\begin_layout Standard
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 0
-use_makebox 0
-width "100col%"
-special "none"
-height "1in"
-height_special "totalheight"
-thickness "0.4pt"
-separation "3pt"
-shadowsize "4pt"
-framecolor "black"
-backgroundcolor "none"
-status open
-
-\begin_layout Plain Layout
-This section also needs updating.
- There is now material about this on the wiki, and it could be copied here.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Copy the bibliography list with all entries to all subdocuments and transform
- them to a comment.
- This way \SpecialChar LyX
- will find the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.bib
-\end_layout
-
-\end_inset
-
--files and you can easily insert references without making the bibliography
- list visible.
-\end_layout
-
-\begin_layout Standard
-As the bibliography list is in a comment, \SpecialChar LaTeX
- won't use it and the references
- will look like this: [?], instead of like this: [1].
- One solution is to use the \SpecialChar LaTeX
--package
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-comment
-\end_layout
-
-\end_inset
-
- that will only include comments by processing the files separately.
- To do this, add in the \SpecialChar LaTeX
- preamble of every subdocument the following:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-usepackage{comment}
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-includecomment{comment}
-\end_layout
-
-\begin_layout Standard
-See also
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://wiki.lyx.org/FAQ/Unsorted#toc31
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Section
-\SpecialChar LyX
- Archives
-\end_layout
-
-\begin_layout Standard
-Users sometimes need to be able to
-\begin_inset Quotes eld
-\end_inset
-
-bundle
-\begin_inset Quotes erd
-\end_inset
-
- a \SpecialChar LyX
- file together with all the images (and other files) on which it depends,
- either for sending to a publisher or for sharing with a co-author.
- \SpecialChar LyX
- 2.0 includes a Python script (
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpak.py
-\end_layout
-
-\end_inset
-
-) that automates this process.
- To use it, you must have either the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-zipfile
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-tarfile
-\end_layout
-
-\end_inset
-
- python modules installed on your system.
- By default, the script prefers the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-gzip
-\end_layout
-
-\end_inset
-
--compressed
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-tar
-\end_layout
-
-\end_inset
-
- format on Unix-like systems and the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-zip
-\end_layout
-
-\end_inset
-
- format on Windows.
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
-'s configuration process will set the script up to export a `\SpecialChar LyX
- Archive',
- and this format will then be available under
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-File\SpecialChar menuseparator
-Export
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Independently of the platform, the generation of a particular archive format
- can be forced by adding either the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--t
-\end_layout
-
-\end_inset
-
- (for the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-tar
-\end_layout
-
-\end_inset
-
- format) or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--z
-\end_layout
-
-\end_inset
-
- (for the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-zip
-\end_layout
-
-\end_inset
-
- format) switch to the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar LyX
-\SpecialChar menuseparator
-\SpecialChar LyX
- Archive
-\end_layout
-
-\end_inset
-
- converter in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
-\end_layout
-
-\end_inset
-
-.
- (Make sure you add the switch after the script name, not before it.)
-\end_layout
-
-\begin_layout Section
-Fancy Headers and Footers
-\end_layout
-
-\begin_layout Standard
-The default page layout is rather plain; for an
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-article
-\end_layout
-
-\end_inset
-
- document class, all you get is a centered page number at the bottom of
- the page.
- This document uses KOMA-script's book class, so it appears to be a bit
- fancier.
- But to really put on a show, you need to set the document page style to
-
-\begin_inset Quotes eld
-\end_inset
-
-fancy
-\begin_inset Quotes erd
-\end_inset
-
-, as mentioned in the
-\emph on
-User Guide
-\emph default
-.
- This section describes the \SpecialChar LaTeX
- code you need to insert in your \SpecialChar LaTeX
- preamble in
- order to get the desired effects.
-\end_layout
-
-\begin_layout Standard
-For more information on fancy headers, see the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-fancyhdr
-\end_layout
-
-\end_inset
-
- package documentation.
- (
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
-\end_layout
-
-\end_inset
-
-)
-\end_layout
-
-\begin_layout Standard
-The page header is divided into three fields, not surprisingly labeled
-\begin_inset Quotes eld
-\end_inset
-
-left
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-center
-\begin_inset Quotes erd
-\end_inset
-
-, and
-\begin_inset Quotes eld
-\end_inset
-
-right
-\begin_inset Quotes erd
-\end_inset
-
-.
- The footer is also divided into these three fields.
- The \SpecialChar LaTeX
- commands to set these fields in the simplest manner are
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-lhead
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-chead
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-rhead
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-lfoot
-\end_layout
-
-\end_inset
-
-, etc.
- Suppose you wish to put your name in the upper left hand corner of each
- page.
- Simply insert the following command in the preamble:
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lhead{John Q.
- DocWriter}
-\end_layout
-
-\begin_layout Standard
-You will now see your name in the upper left.
- If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer) simply include a command
- with a blank argument, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.:
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-cfoot{}
-\end_layout
-
-\begin_layout Standard
-Let's get really fancy: lets put the section number with the word
-\begin_inset Quotes eld
-\end_inset
-
-Section
-\begin_inset Quotes erd
-\end_inset
-
- (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-Section 3) in the upper left, the page number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-Page 4) in the upper right, your name in the lower left, and the date in
- the lower right.
- The following commands should now appear in the preamble:
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lhead{Section
-\backslash
-thesection}
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-chead{}
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-rhead{Page
-\backslash
-thepage}
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lfoot{John Q.
- DocWriter}
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-cfoot{}
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-rfoot{
-\backslash
-today}
-\end_layout
-
-\begin_layout Standard
-The commands
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-thesection
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-thepage
-\end_layout
-
-\end_inset
-
- access \SpecialChar LaTeX
-'s section and page counters, and so print out the current section
- and page numbers.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-today
-\end_layout
-
-\end_inset
-
- simply prints out today's date.
-\end_layout
-
-\begin_layout Standard
-The thicknesses of the horizontal rules drawn beneath the header and above
- the footer can also be modified.
- If you don't want one of the rules, set its thickness to 0.
- The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
- Use commands
-\family typewriter
-
-\family default
-like
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-renewcommand{
-\backslash
-headrulewidth}{0.4pt}
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-renewcommand{
-\backslash
-footrulewidth}{0.4pt}
-\end_layout
-
-\end_inset
-
- to set the thicknesses.
-\end_layout
-
-\begin_layout Standard
-You can switch the header/footer settings on and off for individual pages
- using commands like
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-thispagestyle{empty}
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-thispagestyle{plain}
-\end_layout
-
-\end_inset
-
-, and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-thispagestyle{fancy}
-\end_layout
-
-\end_inset
-
-.
- Simply insert them in the text on the page you want changed and mark them
- as \SpecialChar TeX
- code.
- In fact, title pages are marked as plain by default, while following pages
- are marked fancy when using the global fancy setting.
-\end_layout
-
-\begin_layout Standard
-As a final example, it is possible to include an image in the header or
- footer.
- Suppose you want to put a company logo in the upper lefthand corner.
- You might try something like
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lhead{
-\backslash
-resizebox{1in}{!}{
-\backslash
-includegraphics{logo.eps}}}
-\end_layout
-
-\begin_layout Standard
-\noindent
-(you may need to preface this with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-\noindent
-
-\backslash
-usepackage{graphics}
-\end_layout
-
-\end_inset
-
- if you don't include graphics elsewhere in your document).
-\end_layout
-
-\begin_layout Section
-Itemize Bullet Selection
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:bullet"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
- Allan Rae
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- provides 216 bullet shapes that can be accessed from a simple dialog.
- Using this dialog you can easily specify what bullet shape to use at each
- level of an itemized list.
- These settings are document-wide so you won't be able to specify different
- sets of bullets for different paragraphs.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Well, actually you can but you'll have to do it by hand.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-How it looks
-\end_layout
-
-\begin_layout Standard
-Open the dialog by selecting the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- menu item and then select the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bullets
-\end_layout
-
-\end_inset
-
- tab.
-\end_layout
-
-\begin_layout Standard
-The dialog provides you with a table of bullet shapes.
- A column of buttons on the left of the table provides access to the six
- different panels of bullet shapes.
- The row of buttons across the top is used to select which bullet depth
- you are changing.
- A text entry under the table shows the currently selected bullet shape's
- \SpecialChar LaTeX
- equivalent and this can be edited if desired.
- If you do modify the text you will also need to specify any needed packages
- in the \SpecialChar LaTeX
- preamble.
-\end_layout
-
-\begin_layout Standard
-The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to \SpecialChar LaTeX
- package.
-\begin_inset Separator latexpar
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="7" columns="2">
-<features tabularvalignment="middle">
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Button
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Packages Required
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Standard
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-base \SpecialChar LaTeX
-
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Maths
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-amssymb.sty
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding1
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding2
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding3
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding4
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
-\end_layout
-
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- doesn't stop you using bullets from packages you don't have.
- If you get errors from \SpecialChar LaTeX
- when you try to view or print the file, then it
- is likely you are missing a package.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar LyX
- doesn't restrict your use since you may be editing locally and exporting
- elsewhere.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-How to use it
-\end_layout
-
-\begin_layout Standard
-Select which bullet depth you want to change then select the bullet shape
- and size.
- Any changes will not be visible in \SpecialChar LyX
-, but are visible when viewing the document.
-\end_layout
-
-\begin_layout Standard
-You can reset a bullet shape to the default simply by clicking your right
- mouse button on the appropriate bullet depth button.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-If you
-\emph on
-really
-\emph default
- want to have multiple sets of paragraphs with different sets of bullets
- in each, then you're going to have to get your hands dirty with \SpecialChar TeX
- code.
- The bullet selection dialog can help though because it provides you with
- the \SpecialChar LaTeX
- code for a wide range of bullet shapes.
- To make your own custom paragraphs you have the following options:
-\end_layout
-
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Itemize
-Use the \SpecialChar LaTeX
- command
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-renewcommand{}{}
-\end_layout
-
-\end_inset
-
- to specify a new bullet shape for a given depth.
- You'll also need to save the current bullet shape so you can restore it
- again afterwards.
- In this itemized list the following \SpecialChar LaTeX
- code was used to change the bullet
- used for the first depth.
-\begin_inset Separator latexpar
-\end_inset
-
-
-\end_layout
-
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
-Note that the itemize depth is specified in Roman numerals as part of the
-
-\family typewriter
-
-\backslash
-labelitem
-\family default
- command.
-\end_layout
-
-\begin_layout Itemize
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-[
-\backslash
-(
-\backslash
-star
-\backslash
-)]
-\end_layout
-
-\end_inset
-
- Specify each individual entry by starting each item with the bullet shape
- enclosed in square brackets and set as
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar TeX
- Code
-\end_layout
-
-\end_inset
-
-.
- For example, this item was started with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[
-\backslash
-(
-\backslash
-star
-\backslash
-)]
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Plain Layout
-You'll also need to revert the labelitem back to its previous setting for
- the global bullet shape settings to remain in effect.
- The way used here was:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Chapter
-\SpecialChar LyX
- and the World Wide Web
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- has long supported the export of documents to various web-friendly formats,
- such as HTML.
- Before verson 2.0, however, HTML export was always accomplished by the use
- of external converters.
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-For details on the use of external converters with \SpecialChar LyX
-, see the
-\emph on
-Converters
-\emph default
- section of the Customization manual.
-\end_layout
-
-\end_inset
-
- These fall into two large groups: there are converters that use \SpecialChar LaTeX
- as an
- intermediate format, such as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-htlatex
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-html2latex
-\end_layout
-
-\end_inset
-
-, and
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-plastex
-\end_layout
-
-\end_inset
-
-, relying upon \SpecialChar LyX
- to produce the \SpecialChar LaTeX
-; and there is a converter that works directly
- on \SpecialChar LyX
- files,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-e\SpecialChar LyX
-er
-\end_layout
-
-\end_inset
-
-.
- All of these have different advantages and disadvantages.
-
+\change_inserted 893223064 1464851738
+Document classes
\end_layout
\begin_layout Standard
-The \SpecialChar LaTeX
--based converters have the advantage that, in principle, they know everythin
-g about the exported document that \SpecialChar LaTeX
- does.
- Such converters do not care, for example, if a certain block of code was
- produced by \SpecialChar LyX
- or was Evil Red Text.
- These converters know about
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-aux
-\end_layout
-
-\end_inset
-
- files, counters, and references, and can often make use of the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-bbl
-\end_layout
-
-\end_inset
-
- files generated by Bib\SpecialChar TeX
-.
- On the other hand, \SpecialChar LaTeX
- is a very hard language to parse—it is sometimes said
- that only \SpecialChar TeX
- itself understands \SpecialChar TeX
-—and \SpecialChar LaTeX
--based converters will often choke on
- what seem to be quite simple constructs; complex ones can throw them completely
-, and as of this writing, for example, the
-\emph on
-Embedded Objects
-\emph default
- manual will not export with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-htlatex
-\end_layout
-
-\end_inset
-
-, though the others will.
- The other issue concerns how math is handled.
- These converters typically convert the formulae into little pictures that
- are then linked from the HTML document.
- Since these are actually generated by \SpecialChar LaTeX
-, they are accurate.
- But they do not scale well, and just getting them to look as if they are
- actually meant to be in your document—so that the font sizes seem to be
- roughly the same—can be a challenge.
+\change_inserted 893223064 1464852146
+This section will be updated in due course.
\end_layout
\begin_layout Standard
-Alex Fernandez's
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-e\SpecialChar LyX
-er
-\end_layout
-
-\end_inset
-
- (
-\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
-
-\begin_layout Plain Layout
-htlatex
-\end_layout
-
-\end_inset
-
-; 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
-e\SpecialChar LyX
-er
-\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
-
- More importantly (as of version 1.1.1, at least),
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-e\SpecialChar LyX
-er
-\end_layout
-
-\end_inset
-
- 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
-
-\begin_layout Plain Layout
-e\SpecialChar LyX
-er
-\end_layout
-
-\end_inset
-
- unsuitable for many of the documents \SpecialChar LyX
- users produce.
- In principle, of course, these problems could be solved, but the \SpecialChar LyX
- developers
- have decided to follow a different path and have made \SpecialChar LyX
- itself capable of
- writing XHTML, just as it is capable of writing \SpecialChar LaTeX
-, DocBook, and plaintext.
-\end_layout
-
-\begin_layout Standard
-As of this writing, XHTML output remains under development and should probably
- be regarded as
-\begin_inset Quotes eld
-\end_inset
-
-experimental
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The file
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-development/HTML.notes
-\end_layout
-
-\end_inset
-
-, which can be found in the \SpecialChar LyX
- source tree or
-\begin_inset CommandInset href
-LatexCommand href
-name "accessed online"
-target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
-
-\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
-
- Still, the developers have chosen this approach because it has several
- potential advantages over the other two.
-\end_layout
-
-\begin_layout Standard
-These advantages are primarily due to the fact that the XHTML output routines,
- since they are part of \SpecialChar LyX
-, know everything \SpecialChar LyX
- knows about the document being
- exported.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Another advantage is that, since these routines are internal to \SpecialChar LyX
-, they are
- immune to changes in \SpecialChar LyX
-'s file format, or to changes in the semantics of
- existing insets.
-\end_layout
-
-\end_inset
-
- So they know about the table of contents (as displayed in the outline),
- about the counters associated with different paragraph styles, and about
- user-defined styles.
- The XHTML output routines know what \SpecialChar LyX
- knows about internationalization,
- too, so they will output
-\begin_inset Quotes eld
-\end_inset
-
-Chapter 1
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-
-\lang ngerman
-Kapitel
-\lang english
- 1
-\begin_inset Quotes erd
-\end_inset
-
-, depending upon the language in effect at the time.
-
-\end_layout
-
-\begin_layout Standard
-Quite generally, the output routines know what \SpecialChar 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, \SpecialChar LyX
-
-\emph on
-automatically
-\emph default
- generates CSS style information corresponding to the layout information
- it uses to render the document on screen: if section headings are supposed
- to be sans-serif and bold as seen in \SpecialChar LyX
-, then (by default) they will be sans-seri
-f and bold when viewed in a web browser, too.
- And this is true not just for pre-defined styles, like Section, but for
- any style, including user-defined styles.
- Indeed, the XHTML output routines make no distinction between user-defined
- paragraph and character styles and \SpecialChar LyX
-'s own pre-defined styles: in each case,
- everything \SpecialChar LyX
- knows about the styles is contained in the layout files.
- And much the same is true as regards pre-defined textual insets, such as
- footnotes, and various custom insets.
-
-\end_layout
-
-\begin_layout Standard
-The result is that XHTML output can be customized and extended in exactly
- the same way \SpecialChar LaTeX
- output can be customized and extended: through layout files
- and modules.
- See chapter five of the
-\emph on
-Customization
-\emph default
-manual for the details.
-\end_layout
-
-\begin_layout Standard
-The remainder of this chapter contains more detailed information on XHTML
- output, its limitations, and ways to work around those limitations.
-\end_layout
-
-\begin_layout Section
-Math Output in XHTML
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- offers four choices for how math is rendered.
- These have various advantages and disadvantages:
-\end_layout
-
-\begin_layout Itemize
-MathML
-\begin_inset Newline newline
-\end_inset
-
-MathML is a dialect of XML designed specifically for mathematics on the
- web, and it typically renders very well in browsers that support it.
- The disadvantage is that not all browsers support MathML, and support is
- not complete even in the Gecko-based browsers, such as Firefox.
-\begin_inset Newline newline
-\end_inset
-
-If \SpecialChar LyX
- is unable to render a formula as MathML—for example, if the formula
- uses the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-xymatrix
-\end_layout
-
-\end_inset
-
- package or ERT—then it will instead output the formula as an image.
-
-\end_layout
-
-\begin_layout Itemize
-HTML
-\begin_inset Newline newline
-\end_inset
-
-As mentioned above,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-elyxer
-\end_layout
-
-\end_inset
-
- outputs math as HTML, styled by CSS.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar LyX
- has borrowed some of the CSS for its HTML output from
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-elyxer
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
- For simple formulae, this can work quite well, though with more complicated
- formulae it tends to break down.
- Still, this method has the advantage that it is very widely supported and
- so it may be appropriate for documents that contain only a little, fairly
- simple math.
-\begin_inset Newline newline
-\end_inset
-
-If Lyx is unable to render a formula as HTML—for example, if the formula
- uses the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-xymatrix
-\end_layout
-
-\end_inset
-
- package or ERT—then it will instead output the formula as an image.
-
-\end_layout
-
-\begin_layout Itemize
-Images
-\begin_inset Newline newline
-\end_inset
-
-Like
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-htlatex
-\end_layout
-
-\end_inset
-
-, \SpecialChar LyX
- will output formulae as images, the very same images, in fact, that are
- used for instant preview.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Instant preview does
-\emph on
-not
-\emph default
-have to be on for images to be output, however.
-\end_layout
-
-\end_inset
-
- The advantage to this method is that the images are simply generated by
- \SpecialChar 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
-
-The size of the images can be controlled by setting the
-\begin_inset Quotes eld
-\end_inset
-
-Math Images Scaling
-\begin_inset Quotes erd
-\end_inset
-
- parameter under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output
-\end_layout
-
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-For those who want to know, this controls the resolution of the image in
- dots per inch and is based upon a default of 75 dpi.
-\end_layout
-
-\end_inset
-
-
-\begin_inset Newline newline
-\end_inset
-
-If \SpecialChar LyX
- for some reason fails to create an image for a formula (e.g., if a required
- \SpecialChar LaTeX
- package is not installed), then it will fall back to outputing the raw
- \SpecialChar LaTeX
-.
-\end_layout
-
-\begin_layout Itemize
-\SpecialChar LaTeX
-
-\begin_inset Newline newline
-\end_inset
-
-Finally, \SpecialChar LyX
- will happily output math as \SpecialChar LaTeX
-.
- As well as being the output of last resort, this method can be used with
- such tools as
-\begin_inset CommandInset href
-LatexCommand href
-name "jsMath"
-target "http://www.math.union.edu/~dpvc/jsMath/"
-
-\end_inset
-
-, which uses JavaScript to render \SpecialChar LaTeX
- embedded in HTML documents.
- \SpecialChar LyX
- wraps the \SpecialChar LaTeX
- in either a
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-span
-\end_layout
-
-\end_inset
-
- (for inline formulas) or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-div
-\end_layout
-
-\end_inset
-
- (for displayed formulas) with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-class='math'
-\end_layout
-
-\end_inset
-
-, as is required for jsMath.
-\end_layout
-
-\begin_layout Standard
-One of these output methods must be selected under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output
-\end_layout
-
-\end_inset
-
-.
- By default, \SpecialChar LyX
- outputs MathML.
- This is a document-wide setting, therefore.
-\end_layout
-
-\begin_layout Standard
-Eventually, \SpecialChar LyX
- will offer the user the option to select an alternate output
- method for a particular inset, say, one that isn't being rendered very
- well by MathML.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-That said, since \SpecialChar LyX
- falls back to images if the inset contains ERT, then one
- can force output as an image by putting some harmless ERT into the math,
- for example:
-\begin_inset Formula $a=b\relax$
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Section
-Bibliography and Citations
-\end_layout
-
-\begin_layout Standard
-XHTML output fully supports bibliographies and citations.
-
-\end_layout
-
-\begin_layout Standard
-Citation labels are generated by the same machinery that generates \SpecialChar LyX
-'s on-screen
- labels, so the labels will look in the output much as they do in \SpecialChar LyX
-, though
- better.
- If you are using numerical citations, then \SpecialChar LyX
- will output numerical labels,
- such as [1] or [17], rather than simply showing the citation key in square
- brackets, as it does on-screen.
- If you are using author-year citations, then \SpecialChar LyX
- will add lowercase letters
- to the years, just as Bib\SpecialChar TeX
- does, if it finds more than one citation for
- a given author-year combination.
- The labels will be printed with the bibliography entries.
- Note that there is, at present, no way to customize the appearance of the
- labels, for example, to choose between square brackets and parentheses.
-\end_layout
-
-\begin_layout Standard
-Bibliography output is handled by the same machinery that handles the presentati
-on of reference information in the citation dialog, so you will see in the
- XHTML output pretty much what you would see if you were to look at a given
- entry in the citation dialog.
- The formatting can be customized in your layout file or, preferably, in
- a module.
- See the
-\emph on
-Customization
-\emph default
- manual for the details.
-\end_layout
-
-\begin_layout Standard
-The main defect at present is that cross-referenced information is printed
- with every entry with which it is associated.
- So you can see things like this:
-\end_layout
-
-\begin_layout Quote
-Jason Stanley,
-\begin_inset Quotes eld
-\end_inset
-
-Context and Logical Form
-\begin_inset Quotes erd
-\end_inset
-
-, in
-\emph on
-Language in Context: Selected Essays
-\emph default
- (Oxford: Oxford University Press, 2007), pp.
- 30–68.
-\end_layout
-
-\begin_layout Quote
-Jason Stanley,
-\begin_inset Quotes eld
-\end_inset
-
-Semantics in Context
-\begin_inset Quotes erd
-\end_inset
-
-, in
-\emph on
-Language in Context: Selected Essays
-\emph default
- (Oxford: Oxford University Press, 2007), pp.
- 201–30.
-\end_layout
-
-\begin_layout Standard
-This should be fixed before long.
-\end_layout
-
-\begin_layout Standard
-There is no support at present for sectioned bibliographies.
- If you have multiple bibliographies, then \SpecialChar LyX
- will print the same bibliography
- over and over.
-\end_layout
-
-\begin_layout Section
-Indexes
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- will happily export indexes as XHTML, but with certain limitations at the
- moment.
-\end_layout
-
-\begin_layout Standard
-Index export will be most reliable when you do not attempt to use the fancy
- constructs that are described in the section on indexes in the
-\emph on
-User's Guide
-\emph default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The main issue here is that \SpecialChar LyX
- itself does not really handle these.
- It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
-.
-\end_layout
-
-\end_inset
-
- We'll describe how they are handled using the subsection headings from
- that section.
-\end_layout
-
-\begin_layout Itemize
-Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
- makes an effort to support these,
- but the entries must be separated by
-\begin_inset Quotes eld
-\end_inset
-
- !
-\begin_inset Quotes erd
-\end_inset
-
-, that is, there must be spaces around the exclamation point.
- This is because it is otherwise too difficult to check for escaped exclamation
- points, ones in math, and so forth.
-\end_layout
-
-\begin_layout Itemize
-Page Ranges: There is no support at all for page ranges, since these make
- no sense with XHMTL.
- Instead, you will just get two index entries, one at either end.
-\end_layout
-
-\begin_layout Itemize
-Cross-referencing: There is no support for cross-referencing.
- If \SpecialChar LyX
- finds an entry containing the
-\begin_inset Quotes eld
-\end_inset
-
-|see\SpecialChar ldots
-
-\begin_inset Quotes erd
-\end_inset
-
- construct, it is just dropped, and the rest is treated as an ordinary index
- entry.
-\end_layout
-
-\begin_layout Itemize
-Index Entry Order: \SpecialChar LyX
- does support attempts to fix the sorting order.
- It will take what is before the first `@' it finds and use that for sorting,
- taking what follows the first `@' to be the actual entry.
- At present, \SpecialChar LyX
- does not check for escaped `@', so do not try to index email
- addresses.
-\end_layout
-
-\begin_layout Itemize
-Index Entry Layout: You can format entries by using the text style dialog,
- or by using any other method available within \SpecialChar LyX
- itself.
- There is no support for constructs like:
-\begin_inset Quotes eld
-\end_inset
-
-entry|textbf
-\begin_inset Quotes erd
-\end_inset
-
-.
- Indeed, if \SpecialChar LyX
- finds a pipe symbol, `|', in an entry, it will delete it and
- everything that follows it.
-\end_layout
-
-\begin_layout Itemize
-Multiple Indexes: There is no support for multiple indexes.
- Rather, all index entries will be printed as one large index.
- To avoid our printing several versions of the index, we print only the
- main index, so make sure you have one.
-\end_layout
-
-\begin_layout Section
-Nomenclature and Glossary
-\end_layout
-
-\begin_layout Standard
-There is at present no support for glossaries.
- Adding it would be fairly trivial, and welcome.
-\end_layout
-
-\begin_layout Chapter
-The \SpecialChar LyX
- Server
-\end_layout
-
-\begin_layout Section
-Introduction
-\end_layout
-
-\begin_layout Standard
-The `\SpecialChar LyX
- server' allows other programs to talk to \SpecialChar LyX
-, invoke \SpecialChar LyX
- commands, and retrieve
- information about the \SpecialChar LyX
- internal state.
- This is only intended for advanced users, but they should find it useful.
- It is by writing to the \SpecialChar LyX
- server, for example, that bibliography managers,
- such as JabRef, are able to
-\begin_inset Quotes eld
-\end_inset
-
-push
-\begin_inset Quotes erd
-\end_inset
-
- citations to \SpecialChar LyX
-.
-\end_layout
-
-\begin_layout Section
-Starting the \SpecialChar LyX
- Server
-\end_layout
-
-\begin_layout Standard
-The \SpecialChar LyX
- server works through the use of a pair of named pipes.
- These are usually located in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-UserDir
-\end_layout
-
-\end_inset
-
-, (except on Windows, where
-\emph on
-local
-\emph default
- named pipes are special objects located in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\end_layout
-
-\end_inset
-
-) and have the names
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpipe.in
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpipe.out
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- External programs write into
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpipe.in
-\end_layout
-
-\end_inset
-
- and read back data from
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpipe.out
-\end_layout
-
-\end_inset
-
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences
-\end_layout
-
-\end_inset
-
- dialog, for example
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-"/home/myhome/lyxpipe"
-\end_layout
-
-\end_inset
-
-, or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-"
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe"
-\end_layout
-
-\end_inset
-
- on Windows (where any working path instead of lyxpipe can be used, for
- example
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-"
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-my
-\backslash
-lyx
-\backslash
-pipe"
-\end_layout
-
-\end_inset
-
- would also work).
- You
-\emph on
-must
-\emph default
- configure this manually in order for the server to start.
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- will add the '
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.in
-\end_layout
-
-\end_inset
-
-' and '
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.out
-\end_layout
-
-\end_inset
-
-' to create the pipes.
- If one of the pipes already exists, \SpecialChar LyX
- will assume that another \SpecialChar LyX
- process
- is already running and will not start the server.
- On POSIX (Unix like) systems, if for some other reason, an unused
-\begin_inset Quotes eld
-\end_inset
-
-stale
-\begin_inset Quotes erd
-\end_inset
-
- pipe is left in existence when \SpecialChar LyX
- closes, then \SpecialChar LyX
- will try to delete it.
- If this fails for some reason, you will need to delete the pipes manually
- and then restart \SpecialChar LyX
-.
- On Windows, pipes are deleted by the OS on program termination or crash,
- so
-\begin_inset Quotes eld
-\end_inset
-
-stale
-\begin_inset Quotes erd
-\end_inset
-
- pipes should not be possible.
-\end_layout
-
-\begin_layout Standard
-To have several \SpecialChar LyX
- processes with servers at the same time, you have to use
- different configurations, perhaps by using separate user directories, each
- with its own
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-preferences
-\end_layout
-
-\end_inset
-
- file, for each process.
-\end_layout
-
-\begin_layout Standard
-If you are developing a client program, you might find it useful to enable
- debugging information from the \SpecialChar LyX
- server.
- Do this by starting \SpecialChar LyX
- as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyx -dbg lyxserver
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-You can find a complete example client written in C++ in the source distribution
- as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-development/lyxserver/server_monitor.cpp
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Another useful tool is the command-line based client found in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-src/client/lyxclient
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Section
-Normal communication
-\end_layout
-
-\begin_layout Standard
-To issue a \SpecialChar LyX
- call, the client writes a line of ASCII text into the input
- pipe.
- This line has the following format:
-\end_layout
-
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-argument
-\end_layout
-
-\begin_layout Description
-clientname is a name that the client can choose arbitrarily.
- Its only use is that \SpecialChar LyX
- will echo it if it sends an answer—so a client can
- dispatch results from different requesters.
-\end_layout
-
-\begin_layout Description
-function is the function you want \SpecialChar LyX
- to perform.
- It is the same as the commands you'd use in the minibuffer.
-\end_layout
-
-\begin_layout Description
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
-\begin_inset Quotes eld
-\end_inset
-
-self-insert
-\begin_inset Quotes erd
-\end_inset
-
- LFUN will insert the argument as text at the cursor position).
-\end_layout
-
-\begin_layout Standard
-The answer from \SpecialChar LyX
- will arrive in the output pipe and be of the form
-\end_layout
-
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-data
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-clientname
-\emph default
- and
-\emph on
-function
-\emph default
- are just echoed from the command request, while
-\emph on
-data
-\emph default
- is more or less useful information filled according to how the command
- execution worked out.
- Some commands, such as
-\begin_inset Quotes eld
-\end_inset
-
-font-state
-\begin_inset Quotes erd
-\end_inset
-
-, will return information about the internal state of \SpecialChar LyX
-, while other will
- return an empty data-response.
- This means that the command execution went fine.
-\end_layout
-
-\begin_layout Standard
-In case of errors, the response from \SpecialChar LyX
- will have this form
-\end_layout
-
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\end_layout
-
-\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
-\end_layout
-
-\begin_layout Standard
-Examples:
-\end_layout
-
-\begin_layout LyX-Code
-echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
-\begin_inset Newline newline
-\end_inset
-
-echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
-\begin_inset Newline newline
-\end_inset
-
-read a <~/.lyxpipe.out
-\begin_inset Newline newline
-\end_inset
-
-echo $a
-\end_layout
-
-\begin_layout Subsection
-AppleScript (Mac OS X)
-\end_layout
-
-\begin_layout Standard
-Since \SpecialChar LyX
- 2.1, \SpecialChar LyX
- supports basic interactions with AppleScript for normal communicatio
-n through the command run.
- This command takes a direct argument (the
-\series bold
-function
-\series default
- to perform) and an optional argument.
- It either returns the output of the function or triggers an error with
- the error message and code.
-\end_layout
-
-\begin_layout Standard
-Example:
-\end_layout
-
-\begin_layout LyX-Code
-tell application "\SpecialChar LyX
-"
-\end_layout
-
-\begin_layout LyX-Code
- try
-\end_layout
-
-\begin_layout LyX-Code
- -- Stores the current file name into f
-\end_layout
-
-\begin_layout LyX-Code
- set f to (run "server-get-filename" with argument "")
-\end_layout
-
-\begin_layout LyX-Code
- on error the error_message number the error_number
-\end_layout
-
-\begin_layout LyX-Code
- display dialog "Error: " & the error_number & ".
- " ¬
-\end_layout
-
-\begin_layout LyX-Code
- & the error_message buttons {"OK"} default button 1
-\end_layout
-
-\begin_layout LyX-Code
- end try
-\end_layout
-
-\begin_layout LyX-Code
-end tell
-\end_layout
-
-\begin_layout Section
-Notification
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- can notify clients of events going on asynchronously.
- Currently it will only do this if the user binds a key sequence with the
- function
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
-\end_inset
-
-.
- The format of the string \SpecialChar LyX
- sends is as follows:
-\end_layout
-
-\begin_layout Quote
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-NOTIFY:
-\end_layout
-
-\end_inset
-
-
-\emph on
-key-sequence
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-key-sequence
-\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
-\end_layout
-
-\begin_layout Standard
-This mechanism can be used to extend \SpecialChar LyX
-'s command set and implement macros.
- Bind some key sequence to
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
-\end_inset
-
-.
- Then start a client that listens on the output pipe, dispatches the command
- according to the sequence, and starts a function that may use \SpecialChar LyX
- calls and
- \SpecialChar LyX
- requests to issue a command or a series of commands to \SpecialChar LyX
-.
-\end_layout
-
-\begin_layout Section
-The simple \SpecialChar LyX
- Server Protocol
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- implements a simple protocol that can be used for session management.
- All messages are of the form
-\end_layout
-
-\begin_layout Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-protocol message
-\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
-.
- If
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- is received from a client, \SpecialChar LyX
- will report back to inform the client that
- it's listening to it's messages, while
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
- sent from \SpecialChar LyX
- will inform clients that \SpecialChar LyX
- is closing.
-\end_layout
-
-\begin_layout Section
-Reverse DVI/PDF search
-\end_layout
-
-\begin_layout Standard
-Some DVI/PDF viewers
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
-\end_layout
-
-\end_inset
-
- provide
-\emph on
-reverse search
-\emph default
- facility (also called
-\emph on
-inverse search
-\emph default
-).
- This means that you can tell \SpecialChar LyX
- to put the cursor to a specific line in the
- document by clicking at the respective position in the DVI/PDF output.
- To achieve this, the viewer must be able to communicate with \SpecialChar LyX
-.
- This is done via the \SpecialChar LyX
- server either by using the named pipe (
-\emph on
-lyxpipe
-\emph default
-), or the UNIX domain socket (
-\emph on
-lyxsocket
-\emph default
-) that \SpecialChar LyX
- creates in its temporary directory (this is the way the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient
-\end_layout
-
-\end_inset
-
- program communicates with \SpecialChar LyX
-).
- In some cases, you need a helper script that mediates between the viewer
- and \SpecialChar LyX
-, in others, the viewer can communicate with \SpecialChar LyX
- directly.
- This depends on the selected viewer and on your operating system.
- The same applies to the way viewers need to be configured and the way the
- reverse search is actually performed.
- In what follows, we will thus describe how to setup reverse search for
- specific viewers.
- Before we turn to this, though, we will explain what needs to be done generally
- to enable reverse search in the DVI/PDF output.
-\end_layout
-
-\begin_layout Subsection
-Automatic setup
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:rev-search"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-In most cases \SpecialChar LyX
- will do the work for you by enabling the option
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Synchronize with Output
-\end_layout
-
-\end_inset
-
- in the menu
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output
-\end_layout
-
-\end_inset
-
-.
- In such a case \SpecialChar LyX
- will automatically insert the necessary Sync\SpecialChar TeX
- 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
-\end_layout
-
-\end_inset
-
- Toolbar.
-\end_layout
-
-\begin_layout Standard
-If you need a different setting, you can select or input a custom macro
- from the drop down box just below
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-Synchronize with Output
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Note that the method
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-synctex=1
-\end_layout
-
-\end_inset
-
- enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-synctex=-1
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Please also 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
-
-\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
-
-.
-
-\end_layout
-
-\begin_layout Standard
-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 "subsec: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 setup
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LaTeX
- provides several different methods for reverse search.
- Some are built-in in the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-latex/pdflatex
-\end_layout
-
-\end_inset
-
- program, some are provided by external packages.
- Your choice depends on whether your \SpecialChar LaTeX
- distribution already provides a given
- method (the built-in methods are rather new) and whether your viewer can
- cope with it.
- The available methods are described in the following.
-\end_layout
-
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
-\end_layout
-
-\begin_layout Standard
-This method provides the DVI file with the necessary information for reverse
- search.
- It is available in \SpecialChar LaTeX
- since quite some time (any somewhat recent \SpecialChar LaTeX
- distribution
- should include it), and it works reliably.
- To enable it, change the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain)->DVI
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain)->DraftDVI
-\end_layout
-
-\end_inset
-
- converter in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
-\end_layout
-
-\end_inset
-
- to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-latex -src-specials $$i
-\end_layout
-
-\end_inset
-
-.
- If this doesn't work, check if your \SpecialChar TeX
- engine needs different options (the
- syntax might differ in some distributions).
-\end_layout
-
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
-\end_layout
-
-\begin_layout Standard
-The packages
-\emph on
-pdfsync
-\emph default
- and
-\emph on
-scrltx
-\emph default
- provide reverse search facility for PDF output (via pdflatex) and DVI output,
- respectively.
- In order to enable it, load the packages in the \SpecialChar LyX
- preamble:
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-usepackage{pdfsync}
-\end_layout
-
-\end_inset
-
- for reverse PDF search,
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-usepackage[active]{srcltx}
-\end_layout
-
-\end_inset
-
- for reverse DVI search.
-\end_layout
-
-\begin_layout Standard
-If you want to be able to perform both DVI and PDF reverse searches, you
- can also insert in the preamble the following lines
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-usepackage{ifpdf}
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-ifpdf
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-usepackage{pdfsync}
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-else
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-usepackage[active]{srcltx}
-\begin_inset Newline newline
-\end_inset
-
-
-\backslash
-fi
-\end_layout
-
-\begin_layout Standard
-This way, you can preview the file as either DVI or PDF (pdflatex) and the
- right package will be used.
-\end_layout
-
-\begin_layout Standard
-Note that PDFSync might affect the output layout of your document.
- It is therefore advised to disable PDFsync for final documents.
-\end_layout
-
-\begin_layout Subsubsection*
-Built-in reverse search via Sync\SpecialChar TeX
- (DVI and PDF)
-\end_layout
-
-\begin_layout Standard
-Recent versions of
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-(pdf)latex
-\end_layout
-
-\end_inset
-
- have built-in support for both PDF and DVI reverse search.
- This so-called
-\emph on
-Sync\SpecialChar TeX
-
-\emph default
- facility is basically the result of the integration of the PDFSync package
- to the pdftex program and its merge with the
-\emph on
-scr-specials
-\emph default
- approach.
- You need at least \SpecialChar TeX
-Live 2008 or a recent Mik\SpecialChar TeX
- distribution in order to use
- it.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-For some reason, Mik\SpecialChar TeX
- does not understand/obey the command \SpecialChar LyX
- inserts into
- the preamble when you check the "Enable Forward/Reverse Search" button
- in the toolbar and does not generate the necessary info.
-\end_layout
-
-\begin_layout Plain Layout
-The generation of the required info can be forced by changing the converter
- "\SpecialChar LaTeX
- (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
- from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
- the -synctex=1 switch).
-\end_layout
-
-\end_inset
-
- Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
- on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
- support.
-\end_layout
-
-\begin_layout Standard
-To enable Sync\SpecialChar TeX
- for DVI output, change the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain) -> DVI
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain) -> DraftDVI
-\end_layout
-
-\end_inset
-
- converter in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
-\end_layout
-
-\end_inset
-
- to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-latex -synctex=1 $$i
-\end_layout
-
-\end_inset
-
-, and for PDF output, change the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (pdflatex) -> PDF (pdflatex)
-\end_layout
-
-\end_inset
-
- or converter to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-pdflatex -synctex=1 $$i
-\end_layout
-
-\end_inset
-
-.
- Check the documentation of your viewer whether the viewer needs to be configure
-d for the use with Sync\SpecialChar TeX
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Note that the option
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--synctex=1
-\end_layout
-
-\end_inset
-
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--synctex=-1
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-Configuring and using specific viewers
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:configuring-viewers"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection*
-Xdvi (all platforms)
-\end_layout
-
-\begin_layout Standard
-If you use
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-xdvi
-\end_layout
-
-\end_inset
-
-, you don't need to do anything else for performing a reverse DVI search,
- as \SpecialChar LyX
- already provides the necessary hooks for automatically using the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient
-\end_layout
-
-\end_inset
-
- program.
- Just setup your document as described above (reverse search is triggered
- by Ctrl-click or Alt-click on Mac OSX, respectively).
-\end_layout
-
-\begin_layout Standard
-However, if for whatever reason you want to use the named pipe instead of
- the socket for communicating with \SpecialChar LyX
-, simply change the DVI viewer in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats
-\end_layout
-
-\end_inset
-
- to
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-On Mac OSX you have to use
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-xdvi -editor "lyxeditor.sh %f %l"
-\end_layout
-
-\end_inset
-
-, where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.sh
-\end_layout
-
-\end_inset
-
- is a suitable script.
- For example, a minimal shell script is the following one:
-\end_layout
-
-\begin_layout LyX-Code
-#!/bin/sh
-\begin_inset Newline newline
-\end_inset
-
-LYXPIPE="/path/to/lyxpipe"
-\begin_inset Newline newline
-\end_inset
-
-COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
-\begin_inset Newline newline
-\end_inset
-
-echo "$COMMAND" > "${LYXPIPE}".in || exit
-\begin_inset Newline newline
-\end_inset
-
-read TMP < "${LYXPIPE}".out || exit
-\end_layout
-
-\begin_layout Standard
-where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-/path/to/lyxpipe
-\end_layout
-
-\end_inset
-
- is the Ly
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-XServer pipe path specified in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-Paths
-\end_layout
-
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-In the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-development/tools
-\end_layout
-
-\end_inset
-
- folder of a source distribution you can find a
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor
-\end_layout
-
-\end_inset
-
- script which is able to locate the
-\emph on
-lyxpipe
-\emph default
- based on your preferences.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
-\end_layout
-
-\begin_layout Standard
-At the end of
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-/Applications/MacDviX_Folder/calleditor.script
-\end_layout
-
-\end_inset
-
-, add the following lines:
-\end_layout
-
-\begin_layout LyX-Code
-/Applications/Ly
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-X.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
-\end_inset
-
-exit 1
-\end_layout
-
-\begin_layout Standard
-Modify the lines accordingly if you install \SpecialChar LyX
- somewhere else than in the
- Applications folder.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by Alt-click (OPTION-click).
-\end_layout
-
-\begin_layout Subsubsection*
-Skim (Mac OSX)
-\end_layout
-
-\begin_layout Standard
-Enter
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-open -a Skim.app $$i
-\end_layout
-
-\end_inset
-
- to the viewer setting in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats\SpecialChar menuseparator
-PDF (pdflatex)
-\end_layout
-
-\end_inset
-
-, and then in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Skim\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Sync
-\end_layout
-
-\end_inset
-
- choose
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-custom
-\end_layout
-
-\end_inset
-
- preset and enter command
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-/Applications/\SpecialChar LyX
-.app/Contents/MacOS/lyxeditor
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
-\end_layout
-
-\begin_layout Subsubsection*
-Okular (KDE)
-\end_layout
-
-\begin_layout Standard
-Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Settings\SpecialChar menuseparator
-Configure Okular\SpecialChar menuseparator
-Editor
-\end_layout
-
-\end_inset
-
-, select
-\begin_inset Quotes eld
-\end_inset
-
-Custom Text Editor
-\begin_inset Quotes erd
-\end_inset
-
- and add the command
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient -g %f %l
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by SHIFT-click.
-\end_layout
-
-\begin_layout Subsubsection*
-Qpdfview (Unix)
-\end_layout
-
-\begin_layout Standard
-Qpdfview supports Sync\SpecialChar TeX
- since version 0.3.5.
- Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Behavior
-\end_layout
-
-\end_inset
-
-, click on the input field of the
-\begin_inset Quotes eld
-\end_inset
-
-Source editor
-\begin_inset Quotes erd
-\end_inset
-
- item and add the command
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient -g %1 %2
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-YAP (Windows)
-\end_layout
-
-\begin_layout Standard
-Launch yap, choose its
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-View\SpecialChar menuseparator
-Options
-\end_layout
-
-\end_inset
-
- menu and select the
-\begin_inset Quotes eld
-\end_inset
-
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
-
- tab.
- Click on the
-\begin_inset Quotes eld
-\end_inset
-
-New\SpecialChar ldots
-
-\begin_inset Quotes erd
-\end_inset
-
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
-
-\SpecialChar LyX
- Editor
-\begin_inset Quotes erd
-\end_inset
-
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
-
-Name:
-\begin_inset Quotes erd
-\end_inset
-
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
-
-\SpecialChar ldots
-
-\begin_inset Quotes erd
-\end_inset
-
- to open a file dialog and navigate to the directory containing the batch
- file
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-
-\end_inset
-
- (see below).
- Select
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-
-\end_inset
-
- and then specify the program arguments as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-%f %l
-\end_layout
-
-\end_inset
-
-.
- The
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-
-\end_inset
-
- wrapper is used for communicating with \SpecialChar LyX
- through the
-\emph on
-lyxpipe
-\emph default
- and is as follows:
-\end_layout
-
-\begin_layout LyX-Code
-@echo off
-\begin_inset Newline newline
-\end_inset
-
-echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.in
-\begin_inset Newline newline
-\end_inset
-
-type
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.out
-\end_layout
-
-\begin_layout Standard
-Make sure that the \SpecialChar LyX
-Server pipe path you specified in \SpecialChar LyX
- is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe
-\end_layout
-
-\end_inset
-
-, otherwise change the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-
-\end_inset
-
- wrapper accordingly.
-\end_layout
-
-\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-SumatraPDF (Windows)
-\end_layout
-
-\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor.bat %f %l"
-\end_layout
-
-\end_inset
-
- in the viewer setting in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats\SpecialChar menuseparator
-PDF (pdflatex)
-\end_layout
-
-\end_inset
-
-, where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-
-\end_inset
-
- is the previous wrapper.
- If SumatraPDF.exe is not in your command PATH, use its full file name.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-YAP (Cygwin)
-\end_layout
-
-\begin_layout Standard
-First of all, make sure that yap is your default DVI viewer in the Windows
- environment, then launch it, choose its
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-View\SpecialChar menuseparator
-Options
-\end_layout
-
-\end_inset
-
- menu and select the
-\begin_inset Quotes eld
-\end_inset
-
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
-
- tab.
- Click on the
-\begin_inset Quotes eld
-\end_inset
-
-New\SpecialChar ldots
-
-\begin_inset Quotes erd
-\end_inset
-
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
-
-\SpecialChar LyX
- Editor
-\begin_inset Quotes erd
-\end_inset
-
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
-
-Name:
-\begin_inset Quotes erd
-\end_inset
-
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
-
-\SpecialChar ldots
-
-\begin_inset Quotes erd
-\end_inset
-
- to open a file dialog and navigate to the directory containing the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.exe
-\end_layout
-
-\end_inset
-
- program (which is installed by default on Cygwin along with the \SpecialChar LyX
- executable).
- Select
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.exe
-\end_layout
-
-\end_inset
-
- and then specify the program arguments as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--g %f %l
-\end_layout
-
-\end_inset
-
-.
- In this way, you will be using the
-\emph on
-lyxsocket
-\emph default
- for communicating with \SpecialChar LyX
-.
- If, for whatever reason, you want to use the
-\emph on
-lyxpipe
-\emph default
-, omit the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--g
-\end_layout
-
-\end_inset
-
- option and be sure to specify the \SpecialChar LyX
-Server pipe path in the \SpecialChar LyX
- preferences.
-\end_layout
-
-\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-SumatraPDF (Cygwin)
-\end_layout
-
-\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor -g %f %l"
-\end_layout
-
-\end_inset
-
- in the viewer setting in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats\SpecialChar menuseparator
-PDF (pdflatex)
-\end_layout
-
-\end_inset
-
-.
- If SumatraPDF.exe is not in your command PATH, use its full posix path.
- The
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--g
-\end_layout
-
-\end_inset
-
- enables communication via the
-\emph on
-lyxsocket
-\emph default
-.
- Again, omit the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--g
-\end_layout
-
-\end_inset
-
- option if you want to use the
-\emph on
-lyxpipe
-\emph default
-, and be sure to specify the \SpecialChar LyX
-Server pipe path in the \SpecialChar LyX
- preferences.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Section
-Forward search
-\end_layout
-
-\begin_layout Standard
-Forward search is, as the name implies, in a sense the
-\begin_inset Quotes eld
-\end_inset
-
-opposite
-\begin_inset Quotes erd
-\end_inset
-
- of reverse search.
- It allows you to let the viewer jump to a given position from within \SpecialChar \
LyX
-.
- If forward search is set up (as described in what follows), you can put
- the cursor anywhere in your \SpecialChar LyX
- document, and hit
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Navigate\SpecialChar menuseparator
-Forward search
-\end_layout
-
-\end_inset
-
- (or select
-\begin_inset Flex Noun
-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 \SpecialChar TeX
- sources.
- This can be done via the methods described in the section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:rev-search"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-Additionally, you need to configure \SpecialChar LyX
- for using your viewers in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-General
-\end_layout
-
-\end_inset
-
-.
- 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 (without path)
-\end_layout
-
-\begin_layout Itemize
-\noindent
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-$$f
-\end_layout
-
-\end_inset
-
-: name of the (temporary) exported .tex file (including path)
-\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
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-You might want to set
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-okular –unique
-\end_layout
-
-\end_inset
-
- in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File
-\begin_inset space ~
-\end_inset
-
-Formats
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-, qpdfview and SumatraPDF
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-SumatraPDF can also use DDE commands through the external program CMCDDE
- — downloadable from
-\begin_inset CommandInset href
-LatexCommand href
-target "http://www.istri.fr/spip/zip/CMCDDE.zip"
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-.
- 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
-
-.
- This 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.
- \SpecialChar 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
Special Document Classes
\end_layout
@@ -18462,6 +13069,4552 @@ Perhaps you can take on the task\SpecialChar ldots
\end_layout
\begin_layout Chapter
+
+\change_inserted 893223064 1464851900
+Modules
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 893223064 1464851910
+This is a holder for prepared text.
+\end_layout
+
+\begin_layout Chapter
+
+\change_inserted 893223064 1464851939
+Page layout
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 893223064 1464851945
+This is a holder for prepared text.
+\end_layout
+
+\begin_layout Section
+Special features
+\end_layout
+
+\begin_layout Standard
+You can do everything with \SpecialChar LyX
+ that you can do with \SpecialChar LaTeX
+.
+ However, \SpecialChar LyX
+ cannot support every \SpecialChar LaTeX
+ feature directly.
+ But you can always use \SpecialChar TeX
+ Code.
+ This chapter shows you some more special things you might want to use.
+ For other special things you can do with figures, tables, floats, boxes
+ and notes, have a look at the
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual.
+\end_layout
+
+\begin_layout Section
+Fancy Headers and Footers
+\end_layout
+
+\begin_layout Standard
+The default page layout is rather plain; for an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+article
+\end_layout
+
+\end_inset
+
+ document class, all you get is a centered page number at the bottom of
+ the page.
+ This document uses KOMA-script's book class, so it appears to be a bit
+ fancier.
+ But to really put on a show, you need to set the document page style to
+
+\begin_inset Quotes eld
+\end_inset
+
+fancy
+\begin_inset Quotes erd
+\end_inset
+
+, as mentioned in the
+\emph on
+User Guide
+\emph default
+.
+ This section describes the \SpecialChar LaTeX
+ code you need to insert in your \SpecialChar LaTeX
+ preamble in
+ order to get the desired effects.
+\end_layout
+
+\begin_layout Standard
+For more information on fancy headers, see the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+fancyhdr
+\end_layout
+
+\end_inset
+
+ package documentation.
+ (
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Standard
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
+
+left
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+center
+\begin_inset Quotes erd
+\end_inset
+
+, and
+\begin_inset Quotes eld
+\end_inset
+
+right
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The footer is also divided into these three fields.
+ The \SpecialChar LaTeX
+ commands to set these fields in the simplest manner are
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+lhead
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+chead
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+rhead
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+lfoot
+\end_layout
+
+\end_inset
+
+, etc.
+ Suppose you wish to put your name in the upper left hand corner of each
+ page.
+ Simply insert the following command in the preamble:
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lhead{John Q.
+ DocWriter}
+\end_layout
+
+\begin_layout Standard
+You will now see your name in the upper left.
+ If a field has a default entry that you would like to get rid of (often
+ the page number appears in the central footer) simply include a command
+ with a blank argument, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.:
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+cfoot{}
+\end_layout
+
+\begin_layout Standard
+Let's get really fancy: lets put the section number with the word
+\begin_inset Quotes eld
+\end_inset
+
+Section
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+Section 3) in the upper left, the page number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+Page 4) in the upper right, your name in the lower left, and the date in
+ the lower right.
+ The following commands should now appear in the preamble:
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lhead{Section
+\backslash
+thesection}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+chead{}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+rhead{Page
+\backslash
+thepage}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lfoot{John Q.
+ DocWriter}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+cfoot{}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+rfoot{
+\backslash
+today}
+\end_layout
+
+\begin_layout Standard
+The commands
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thesection
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thepage
+\end_layout
+
+\end_inset
+
+ access \SpecialChar LaTeX
+'s section and page counters, and so print out the current section
+ and page numbers.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+today
+\end_layout
+
+\end_inset
+
+ simply prints out today's date.
+\end_layout
+
+\begin_layout Standard
+The thicknesses of the horizontal rules drawn beneath the header and above
+ the footer can also be modified.
+ If you don't want one of the rules, set its thickness to 0.
+ The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
+ Use commands
+\family typewriter
+
+\family default
+like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+renewcommand{
+\backslash
+footrulewidth}{0.4pt}
+\end_layout
+
+\end_inset
+
+ to set the thicknesses.
+\end_layout
+
+\begin_layout Standard
+You can switch the header/footer settings on and off for individual pages
+ using commands like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{empty}
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{plain}
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{fancy}
+\end_layout
+
+\end_inset
+
+.
+ Simply insert them in the text on the page you want changed and mark them
+ as \SpecialChar TeX
+ code.
+ In fact, title pages are marked as plain by default, while following pages
+ are marked fancy when using the global fancy setting.
+\end_layout
+
+\begin_layout Standard
+As a final example, it is possible to include an image in the header or
+ footer.
+ Suppose you want to put a company logo in the upper lefthand corner.
+ You might try something like
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lhead{
+\backslash
+resizebox{1in}{!}{
+\backslash
+includegraphics{logo.eps}}}
+\end_layout
+
+\begin_layout Standard
+\noindent
+(you may need to preface this with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\noindent
+
+\backslash
+usepackage{graphics}
+\end_layout
+
+\end_inset
+
+ if you don't include graphics elsewhere in your document).
+\end_layout
+
+\begin_layout Section
+Multiple Text Columns
+\end_layout
+
+\begin_layout Standard
+This feature is independent of the option
+\family sans
+Two-column document
+\family default
+ in the document settings under
+\family sans
+Text Layout
+\family default
+.
+ If you want to have 2
+\begin_inset space ~
+\end_inset
+
+columns for the whole document, it is recommended to use the
+\family sans
+Two-column document
+\family default
+ option.
+ For all other cases use this feature.
+\end_layout
+
+\begin_layout Standard
+To use multiple text columns in your document, you have to load the module
+
+\family sans
+Multiple Columns
+\family default
+ (menu
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Modules
+\family default
+) and must have the \SpecialChar LaTeX
+-package
+\series bold
+multicol
+\series default
+ installed.
+\end_layout
+
+\begin_layout Standard
+Footnotes within multiple columns will be placed at the bottom of the page
+ and not under each column.
+ Within the different columns you can use everything, with the limitation
+ that for floats you need to use the float option
+\family sans
+Span columns
+\family default
+.
+\end_layout
+
+\begin_layout Subsection
+Basics
+\end_layout
+
+\begin_layout Standard
+If you want to have 2
+\begin_inset space ~
+\end_inset
+
+columns in your text, insert a multicolumn inset via the menu
+\family sans
+Insert\SpecialChar menuseparator
+Custom
+\begin_inset space ~
+\end_inset
+
+Insets\SpecialChar menuseparator
+Multiple
+\begin_inset space ~
+\end_inset
+
+Columns
+\family default
+ where the columns should start.
+ Write all text that should be printed in 2
+\begin_inset space ~
+\end_inset
+
+columns into this inset.
+\end_layout
+
+\begin_layout Standard
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\noindent
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\noindent
+
+\series bold
+\size small
+The Adventure of the Empty House
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+by Sir Arthur Conan Doyle
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+It was in the spring of the year 1894 that all London was interested, and
+ the fashionable world dismayed, by the murder of the Honourable Ronald
+ Adair under most unusual and inexplicable circumstances.
+ The public has already learned those particulars of the crime which came
+ out in the police investigation, but a good deal was suppressed upon that
+ occasion, since the case for the prosecution was so overwhelmingly strong
+ that it was not necessary to bring forward all the facts.
+ Only now, at the end of nearly ten years, am I allowed to supply those
+ missing links which make up the whole of that remarkable chain.
+ The crime was of interest in itself, but that interest was as nothing to
+ me compared to the inconceivable sequel, which afforded me the greatest
+ shock and surprise of any event in my adventurous life.
+ Even now, after this long interval, I find myself thrilling as I think
+ of it, and feeling once more that sudden flood of joy, amazement, and increduli
+ty which utterly submerged my mind.
+ Let me say to that public, which has shown some interest in those glimpses
+ which I have occasionally given them of the thoughts and actions of a very
+ remarkable man, that they are not to blame me if I have not shared my knowledge
+ with them, for I should have considered it my first duty to do so, had
+ I not been barred by a positive prohibition from his own lips, which was
+ only withdrawn upon the third of last month.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+To get 3 or more columns, set the cursor into the multicolumn inset and
+ use the menu
+\family sans
+Insert\SpecialChar menuseparator
+Number
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+
+Columns
+\family default
+.
+ The number of the desired columns is written into that inset (for 3
+\begin_inset space ~
+\end_inset
+
+columns write
+\begin_inset Quotes eld
+\end_inset
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
+Here is an example with 3
+\begin_inset space ~
+\end_inset
+
+columns:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+3
+\end_layout
+
+\end_inset
+
+It can be imagined that my close intimacy with Sherlock Holmes had interested
+ me deeply in crime, and that after his disappearance I never failed to
+ read with care the various problems which came before the public.
+ And I even attempted, more than once, for my own private satisfaction,
+ to employ his methods in their solution, though with indifferent success.
+ There was none, however, which appealed to me like this tragedy of Ronald
+ Adair.
+ As I read the evidence at the inquest, which led up to a verdict of willful
+ murder against some person or persons unknown, I realized more clearly
+ than I had ever done the loss which the community had sustained by the
+ death of Sherlock Holmes.
+ There were points about this strange business which would, I was sure,
+ have specially appealed to him, and the efforts of the police would have
+ been supplemented, or more probably anticipated, by the trained observation
+ and the alert mind of the first criminal agent in Europe.
+ All day, as I drove upon my round, I turned over the case in my mind and
+ found no explanation which appeared to me to be adequate.
+ At the risk of telling a twice-told tale, I will recapitulate the facts
+ as they were known to the public at the conclusion of the inquest.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+You can have up to 10
+\begin_inset space ~
+\end_inset
+
+columns if you want to, but that might not be very pleasant for the readers
+ of your document.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Columns inside Columns
+\end_layout
+
+\begin_layout Standard
+You can also have columns inside columns:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+The Honourable Ronald Adair was the second son of the Earl of Maynooth,
+ at that time governor of one of the Australian colonies.
+ Adair's mother had returned from Australia to undergo the operation for
+ cataract, and she, her son Ronald, and her daughter Hilda were living together
+ at 427 Park Lane.
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+The youth moved in the best society–had, so far as was known, no enemies
+ and no particular vices.
+ He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
+ had been broken off by mutual consent some months before, and there was
+ no sign that it had left any very profound feeling behind it.
+ For the rest {sic} the man's life moved in a narrow and conventional circle,
+ for his habits were quiet and his nature unemotional.
+ Yet it was upon this easy-going young aristocrat that death came, in most
+ strange and unexpected form, between the hours of ten and eleven-twenty
+ on the night of March 30, 1894.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size footnotesize
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
+
+\size default
+
+\size footnotesize
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
+ and that there was a fairly equal fall of the cards.
+ Adair might have lost five pounds, but not more.
+ His fortune was a considerable one, and such a loss could not in any way
+ affect him.
+ He had played nearly every day at one club or other, but he was a cautious
+ player, and usually rose a winner.
+ It came out in evidence that, in partnership with Colonel Moran, he had
+ actually won as much as four hundred and twenty pounds in a sitting, some
+ weeks before, from Godfrey Milner and Lord Balmoral.
+ So much for his recent history as it came out at the inquest.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Advanced Examples
+\end_layout
+
+\begin_layout Standard
+The examples in this section show some more special features of multiple
+ columns.
+\end_layout
+
+\begin_layout Standard
+For more features of multiple columns, have a look at the documentation
+ of the \SpecialChar LaTeX
+-package
+\series bold
+multicol
+\series default
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "multicol"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+Preface
+\end_layout
+
+\begin_layout Standard
+To add a preface text for multiple columns, set the cursor into the multicolumn
+ inset and use the menu
+\family sans
+Insert\SpecialChar menuseparator
+Preface
+\family default
+.
+ Write your preface text into that inset.
+\begin_inset Newline newline
+\end_inset
+
+This is an example with some preface text:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
+
+\begin_layout Plain Layout
+And the story continues and continues and continues and continues\SpecialChar ldots
+
+\end_layout
+
+\end_inset
+
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+You can also use a section heading as the preface if you use a section command
+ as \SpecialChar TeX
+ Code.
+ For example the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+subsection{subsection title}
+\end_layout
+
+\begin_layout Standard
+creates a subsection.
+ In this example the preface is a subsubsection:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
+
+\begin_layout Plain Layout
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+subsubsection{
+\end_layout
+
+\end_inset
+
+This is a subsubsection heading as a preface
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\size small
+A minute examination of the circumstances served only to make the case more
+ complex.
+ In the first place, no reason could be given why the young man should have
+ fastened the door upon the inside.
+ There was the possibility that the murderer had done this, and had afterwards
+ escaped by the window.
+ The drop was at least twenty feet, however, and a bed of crocuses in full
+ bloom lay beneath.
+ Neither the flowers nor the earth showed any sign of having been disturbed,
+ nor were there any marks upon the narrow strip of grass which separated
+ the house from the road.
+ Apparently, therefore, it was the young man himself who had fastened the
+ door.
+ But how did he come by his death? No one could have climbed up to the window
+ without leaving traces.
+ Suppose a man had fired through the window, he would indeed be a remarkable
+ shot who could with a revolver inflict so deadly a wound.
+ Again, Park Lane is a frequented thoroughfare; there is a cab stand within
+ a hundred yards of the house.
+ No one had heard a shot.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+If there is less vertical space than 6
+\begin_inset space ~
+\end_inset
+
+text lines is left on the page at the beginning of the multiple columns,
+ a page break will be inserted before the multiple columns.
+ Depending on the number of lines of the preface text, you might want to
+ change this space.
+ This is done by setting the cursor into the mulitcolumn inset behind the
+ preface (if there is any) and using the menu
+\family sans
+Insert\SpecialChar menuseparator
+Space
+\begin_inset space ~
+\end_inset
+
+Before
+\begin_inset space ~
+\end_inset
+
+Page
+\begin_inset space ~
+\end_inset
+
+Break
+\family default
+.
+ Insert into that inset the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+5cm
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+In this example the space is set to 7
+\begin_inset space ~
+\end_inset
+
+text lines by using
+\begin_inset Quotes eld
+\end_inset
+
+7
+\backslash
+baselineskip
+\begin_inset Quotes erd
+\end_inset
+
+ (where the command
+\series bold
+
+\backslash
+baselineskip
+\series default
+ needs to be inserted as \SpecialChar TeX
+ code):
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 3
+status open
+
+\begin_layout Plain Layout
+7
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+baselineskip
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Surrounding Space
+\end_layout
+
+\begin_layout Standard
+The amount of space before and after multiple columns can be changed by
+ changing the length
+\series bold
+
+\backslash
+multicolsep
+\series default
+.
+ For example the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+setlength{
+\backslash
+multicolsep}{3cm}
+\end_layout
+
+\begin_layout Standard
+in \SpecialChar TeX
+ Code changes its value to 3
+\begin_inset space \thinspace{}
+\end_inset
+
+cm.
+ The change must be made before the multiple columns' start.
+ The predefined value is 13
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
+\end_layout
+
+\begin_layout Standard
+For this example
+\series bold
+
+\backslash
+multicolsep
+\series default
+ was set to 2.5
+\begin_inset space \thinspace{}
+\end_inset
+
+cm:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+multicolsep}{2.5cm}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+All day I turned these facts over in my mind, endeavouring to hit upon some
+ theory which could reconcile them all, and to find that line of least resistanc
+e which my poor friend had declared to be the starting-point of every investigat
+ion.
+ I confess that I made little progress.
+ In the evening I strolled across the Park, and found myself about six o'clock
+ at the Oxford Street end of Park Lane.
+ A group of loafers upon the pavements, all staring up at a particular window,
+ directed me to the house which I had come to see.
+ A tall, thin man with coloured glasses, whom I strongly suspected of being
+ a plain-clothes detective, was pointing out some theory of his own, while
+ the others crowded round to listen to what he said.
+ I got as near him as I could, but his observations seemed to me to be absurd,
+ so I withdrew again in some disgust.
+ As I did so I struck against an elderly, deformed man, who had been behind
+ me, and I knocked down several books which he was carrying.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ The values you set with
+\series bold
+
+\backslash
+setlength
+\series default
+ will be used for all following multiple columns until you change them again.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+multicolsep}{13pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Column Breaks
+\end_layout
+
+\begin_layout Standard
+A column break can be forced by inserting the command
+\series bold
+
+\backslash
+columnbreak{}
+\series default
+ as \SpecialChar TeX
+ Code to that position in the text where the column should be broken.
+ Note that this leads in most cases to whitespace in the text.
+\begin_inset Newline newline
+\end_inset
+
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+ AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+columnbreak{}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+–a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Column Separation
+\end_layout
+
+\begin_layout Standard
+The width of the columns is automatically calculated, but you can modify
+ the space between the columns.
+ This is done by changing the length
+\series bold
+
+\backslash
+columnsep
+\series default
+.
+ Its predefined value is 10
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
+ Here is an example where
+\series bold
+
+\backslash
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
+\end_inset
+
+cm:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+My observations of No.
+\begin_inset space \space{}
+\end_inset
+
+427 Park Lane did little to clear up the problem in which I was interested.
+ The house was separated from the street by a low wall and railing, the
+ whole not more than five feet high.
+ It was perfectly easy, therefore, for anyone to get into the garden, but
+ the window was entirely inaccessible, since there was no water pipe or
+ anything which could help the most active man to climb it.
+ More puzzled than ever, I retraced my steps to Kensington.
+ I had not been in my study five minutes when the maid entered to say that
+ a person desired to see me.
+ To my astonishment it was none other than my strange old book collector,
+ his sharp, wizened face peering out from a frame of white hair, and his
+ precious volumes, a dozen of them at least, wedged under his right arm.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{10pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Vertical Lines
+\end_layout
+
+\begin_layout Standard
+Between the columns a rule with a width of the length
+\series bold
+
+\backslash
+columnseprule
+\series default
+ is placed.
+ If this rule width is set to 0
+\begin_inset space \thinspace{}
+\end_inset
+
+pt (this is the default), the rule is suppressed.
+ In the following example the rule is 2
+\begin_inset space \thinspace{}
+\end_inset
+
+pt wide:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnseprule}{2pt}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+–a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The rule can be colored by redefining the command
+\series bold
+
+\backslash
+columnseprulecolor
+\series default
+.
+ This is done by inserting the command
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+as \SpecialChar TeX
+ Code before the multicolumn inset.
+ Replace
+\series bold
+red
+\series default
+ in this command by a color of your choice.
+ You can use all pre- and self-defined colors.
+ See the
+\emph on
+EmbeddedObjects
+\emph default
+ manual, section
+\emph on
+Colored
+\begin_inset space ~
+\end_inset
+
+Tables
+\emph default
+ for more information about pre- and self-defined colors.
+ To go back to the default color insert the command
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+Here is the example with a cyan rule and 1
+\begin_inset space \thinspace{}
+\end_inset
+
+cm column separation:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{1cm}
+\end_layout
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{cyan}}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+–a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnseprule}{0pt}
+\end_layout
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Chapter
+
+\change_inserted 893223064 1464852301
+Text formatting
+\end_layout
+
+\begin_layout Section
+Non-standard Paragraph Shapes
+\end_layout
+
+\begin_layout Standard
+\noindent
+\SpecialChar LaTeX
+ as well as any other text processor uses by default rectangular paragraphs.
+ For special cases like for example posters, invitation cards or poems you
+ can modify the paragraph shape to one of your choice.
+ This can be done by using the \SpecialChar LaTeX
+-package
+\series bold
+shapepar
+\series default
+ which is loaded by using in the document settings the module
+\family sans
+Custom paragraph shapes
+\family default
+.
+\end_layout
+
+\begin_layout Subsection
+Predefined shapes
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+shapepar
+\series default
+ provides the following shapes:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Tabular
+<lyxtabular version="3" rows="13" columns="3">
+<features booktabs="true" islongtable="true" longtabularalignment="center">
+<column alignment="center" valignment="middle" width="16col%">
+<column alignment="center" valignment="middle" width="40col%">
+<column alignment="center" valignment="middle" width="35col%">
+<row endhead="true">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Name
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Description
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Annotation
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+CDlabel
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Circle with circular hole (in the size of a CD/DVD)
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Cannot be scaled, take care there is not too much text
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Circle
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Circle
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Fragile, calculation might fail
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Diamond
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Rhomboid (symbolizing a
+\begin_inset Quotes eld
+\end_inset
+
+diamond
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Heart
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Heart-like shape
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Hexagon
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Hexagon
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Nut
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Nut for bolt (hexagon with circular hole)
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Square
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Square
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Star
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Five-point star
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Candle
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Burning candle
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Drop down/up
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Normal/reversed rain drop
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Fragile, calculation might fail
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+\SpecialChar TeX
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+The \SpecialChar TeX
+ logo
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Triangle up/down/
+\begin_inset Newline newline
+\end_inset
+
+left/right
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+Triangles in different orientations
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+To use a shape for your paragraph, simply select it in \SpecialChar LyX
+'s pull-down box
+ for environments in the toolbar.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Here is an example paragraph in the shape of a nut:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Nut
+
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note
+\series default
+: shapepar paragraphs cannot run over a page break.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+shapepar
+\series default
+ takes care that the shape will always be preserved, no matter how much
+ text is in the paragraph.
+ Therefore the paragraph size changes with the amount of contained text.
+ This can lead to paragraph sizes exceeding the page margins.
+ To demonstrate the size scaling, here is the same example paragraph but
+ with twice as much text:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Nut
+
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+An exception is the shape
+\family sans
+CDlabel
+\family default
+.
+ It cannot be scaled because it must fit the size of a CD/DVD.
+ Therefore the amount of text that fits into the shape is limited.
+\begin_inset Newline newline
+\end_inset
+
+The
+\family sans
+drop
+\family default
+ shapes and the
+\family sans
+circle
+\family default
+ shape are fragile, meaning that the calculation of their size can fail,
+ depending on the amount of text.
+ You will then get the \SpecialChar LaTeX
+ error
+\begin_inset Quotes eld
+\end_inset
+
+Arithmetic overflow
+\begin_inset Quotes erd
+\end_inset
+
+.
+ In this case one can try to remove or add some text; if nothing works one
+ has to use another shape.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+For shapes with tips you will maybe see that \SpecialChar LaTeX
+'s hyphenation routine fails
+ for text in the tips.
+ Therefore it is often necessary to add hyphenation points
+\family sans
+(
+\begin_inset Info
+type "shortcut"
+arg "specialchar-insert hyphenation"
+\end_inset
+
+
+\family default
+) to the corresponding text parts.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Shapepar paragraphs are either always centered or placed on the page so
+ that their left border touches the left page margin.
+ You can therefore not use the paragraph dialog to align such paragraphs.
+ A solution is to put the paragraph into a minipage or parbox and align
+ the box.
+ The problem is hereby to find the right width for the box.
+ Because if it is too wide and you center the box, the paragraph is not
+ centered too because it sticks at the left side of the box.
+ So you might have to play a bit with the width until it fits.
+ Here are two heart-shaped paragraphs, the first one is not aligned, the
+ second one is right-aligned:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Heart
+\noindent
+
+\lang latin
+Lo\SpecialChar softhyphen
+rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+\align right
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 1
+use_makebox 0
+width "42col%"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Heart
+\noindent
+
+\lang latin
+Lo\SpecialChar softhyphen
+rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Custom shapes
+\end_layout
+
+\begin_layout Standard
+You can define any shape you want.
+ Doing this manually is a lot of work because every coordinate must be specified.
+ But there is a way to let the computer calculate the coordinates:
+\end_layout
+
+\begin_layout Enumerate
+Install the program
+\begin_inset CommandInset href
+LatexCommand href
+name "Jpgfdraw"
+target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+In
+\family sans
+Jpgfdraw
+\family default
+ go to the menu
+\family sans
+TeX/LaTeX\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Set Normal Size
+\family default
+ and select the font size you are using in your document.
+ For example this document uses the size 12
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
+\end_layout
+
+\begin_layout Enumerate
+Draw a shape.
+\end_layout
+
+\begin_layout Enumerate
+Use the menu
+\family sans
+TeX/LaTeX\SpecialChar menuseparator
+Shapepar
+\family default
+ to export the shape to coordinates.
+ In the appearing dialog use either the outline of your shape for the coordinate
+s or the path itself.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For more information see
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The coordinates are written into a \SpecialChar TeX
+ file.
+ To use it for your \SpecialChar LyX
+ document
+\end_layout
+
+\begin_layout Enumerate
+Place the cursor before the first character of your paragraph (or into a
+ new empty one).
+\end_layout
+
+\begin_layout Enumerate
+Open in \SpecialChar LyX
+ the menu
+\family sans
+Insert\SpecialChar menuseparator
+File\SpecialChar menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
+\family default
+, select the file and use
+\family sans
+Input
+\family default
+ as
+\family sans
+Include Type.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note
+\series default
+: The changed shape only applies to the current paragraph; everything is
+ reset to normal for the next paragraph.
+ Therefore the shape definition file must be input into every paragraph
+ with the desired shape.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset CommandInset include
+LatexCommand input
+filename "/usr/share/lyx/doc/SpecialParagraphShape.tex"
+
+\end_inset
+
+
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+A tip:
+\series default
+ to draw complexer shapes in
+\family sans
+Jpgfdraw
+\family default
+ you can draw the shape in a program of your choice and import the resulting
+ image to
+\family sans
+Jpgfdraw
+\family default
+.
+ Then you only need to draw a line or spline along the outline of the image.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The module
+\family sans
+Custom paragraph shapes
+\family default
+ also provides the two commands
+\family sans
+shapepar
+\family default
+ and
+\family sans
+Shapepar
+\family default
+ which can be used to define custom shapes coordinate by coordinate.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+These commands are internally used for all shapes described here.
+\end_layout
+
+\end_inset
+
+ For information how these styles are used and about further customization
+ possibilities, have a look at the documentation of the package
+\series bold
+shapepar
+\series default
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "shapepar"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Bibliography
+\begin_inset CommandInset bibitem
+LatexCommand bibitem
+key "multicol"
+
+\end_inset
+
+Documentation of the \SpecialChar LaTeX
+-package
+\begin_inset CommandInset href
+LatexCommand href
+name "multicol"
+target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Bibliography
+\begin_inset CommandInset bibitem
+LatexCommand bibitem
+key "shapepar"
+
+\end_inset
+
+Documentation of the \SpecialChar LaTeX
+-package
+\begin_inset CommandInset href
+LatexCommand href
+name "shapepar"
+target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Chapter
+
+\change_inserted 893223064 1464852414
+Bibliographic databases
+\change_deleted 893223064 1464852406
+Supplemental Tools
+\change_unchanged
+
+\end_layout
+
+\begin_layout Section
+Customizing Bibliographies with Bib\SpecialChar TeX
+
+\end_layout
+
+\begin_layout Standard
+The most basic information about how to use Bib\SpecialChar TeX
+ with \SpecialChar LyX
+ is contained in the
+ section
+\emph on
+Bibliography databases (Bib\SpecialChar TeX
+)
+\emph default
+ of the
+\emph on
+User's Guide
+\emph default
+.
+ The following subsections explain special bibliography features supported
+ by \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Subsection
+Alternative Citation Styles
+\end_layout
+
+\begin_layout Standard
+Standard Bib\SpecialChar TeX
+ uses numbers (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+[12]
+\begin_inset Quotes erd
+\end_inset
+
+) to refer to a cited work.
+ However, in many scientific disciplines, other citation styles are in use.
+ The most common one is the author-year style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+Knuth 1984a
+\begin_inset Quotes erd
+\end_inset
+
+).
+ \SpecialChar LyX
+ supports two packages that provide this style,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+jurabib
+\end_layout
+
+\end_inset
+
+.
+ Both packages have their pros and cons, which cannot be listed in detail.
+ If you only want to have simple author-year (or author-numerical) style,
+ or if you want to use one of the countless style files for
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
+
+\end_inset
+
+, then the established
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
+
+\end_inset
+
+ package is probably your choice.
+ If you need special features like short title references, ibidem etc., you
+ might consider the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+jurabib
+\end_layout
+
+\end_inset
+
+ package.
+\end_layout
+
+\begin_layout Standard
+The handling of both packages in \SpecialChar LyX
+ is basically the same.
+ Go to
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and select under
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Bibliography
+\end_layout
+
+\end_inset
+
+ the option
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Natbib
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Jurabib
+\end_layout
+
+\end_inset
+
+.
+ With both packages, you will get some extra features in the citation dialog
+ and you can select the style of the reference (
+\begin_inset Quotes eld
+\end_inset
+
+Knuth 1984
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Knuth (1984)
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Knuth, 1984
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+1984
+\begin_inset Quotes erd
+\end_inset
+
+ etc.).
+ Note that both packages need specifically designed style files.
+ They both ship their own, but there are lots of additional style files,
+ and there is even an interactive style file builder
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+See
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ for
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Sectioned Bibliographies
+\end_layout
+
+\begin_layout Standard
+Sometimes you might need to divide your bibliography into several sections.
+ If you are for instance a historian, the possibility to separate sources
+ and scientific works is most likely a
+\begin_inset Quotes eld
+\end_inset
+
+must have
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Unfortunately, Bib\SpecialChar TeX
+ itself does not allow you to do this.
+ But with the help of some \SpecialChar LaTeX
+ packages, Bib\SpecialChar TeX
+ can be extended to fit your needs.
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ provides native support for one of these packages,
+\family typewriter
+bibtopic
+\family default
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Available from
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ The advantage of this package (compared to other packages like
+\family typewriter
+multibib
+\family default
+) is that you don't need to define new citation commands.
+ Instead, you need to prepare different bibliographic databases which include
+ the entries for the different sections of the bibliography.
+ For example: If you want to divide your bibliography into the sections
+
+\begin_inset Quotes eld
+\end_inset
+
+Sources
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Scientific works
+\begin_inset Quotes erd
+\end_inset
+
+, you first need to create two bibliographic databases, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+sources.bib
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+scientific.bib
+\end_layout
+
+\end_inset
+
+.
+
+\end_layout
+
+\begin_layout Standard
+Go to
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and check under
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Bibliography
+\end_layout
+
+\end_inset
+
+ the option
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Sectioned bibliography
+\end_layout
+
+\end_inset
+
+.
+ Now you can insert multiple Bib\SpecialChar TeX
+ bibliographies, one for each section of
+ your bibliography.
+ Returning to our example: Insert the Bib\SpecialChar TeX
+ bibliography
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+sources.bib
+\end_layout
+
+\end_inset
+
+ and a second one for the database
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+scientific.bib
+\end_layout
+
+\end_inset
+
+.
+ You are free to use the same or different styles for each section.
+ Additionally, you can choose if the bibliography section should contain
+
+\begin_inset Quotes eld
+\end_inset
+
+all cited references
+\begin_inset Quotes erd
+\end_inset
+
+ of the specified database(s) (which is the default),
+\begin_inset Quotes eld
+\end_inset
+
+all uncited references
+\begin_inset Quotes erd
+\end_inset
+
+ or even
+\begin_inset Quotes eld
+\end_inset
+
+all references
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This might be useful if you would like to separate your bibliography into
+ three sections:
+\begin_inset Quotes eld
+\end_inset
+
+Cited sources
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Uncited sources
+\begin_inset Quotes erd
+\end_inset
+
+, and
+\begin_inset Quotes eld
+\end_inset
+
+Scientific works
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The titles for the sections can be added as ordinary sections or subsections.
+ Since
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
+\end_layout
+
+\end_inset
+
+ removes the bibliography title, you have to manually re-add that, too (as
+ a chapter* or section*, for instance).
+\end_layout
+
+\begin_layout Subsection
+Multiple Bibliographies
+\end_layout
+
+\begin_layout Standard
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a bibliography for each section or chapter of the document, are not supported
+ by Bib\SpecialChar TeX
+ itself.
+ But the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
+\end_layout
+
+\end_inset
+
+ package, which is used for the creation of sectioned bibliographies in
+ \SpecialChar LyX
+ (see the previous section), provides an easy way to solve this task, if
+ you are willing to use some
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar TeX
+ Code
+\end_layout
+
+\end_inset
+
+ (see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
+
+\end_inset
+
+).
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+An alternative approach is to use the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+chapterbib
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibunits
+\end_layout
+
+\end_inset
+
+ package, respectively.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+First go to
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and under
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Bibliography
+\end_layout
+
+\end_inset
+
+ check
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Sectioned bibliography
+\end_layout
+
+\end_inset
+
+.
+ In the document, you have to enclose the sections, which shall contain
+ their own bibliography (including the Bib\SpecialChar TeX
+ bibliography itself), between
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{btUnit}
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{btUnit}
+\end_layout
+
+\end_inset
+
+ (those commands have to be inserted as \SpecialChar TeX
+ code).
+ The bibliography will contain all references that have been cited in the
+ current
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+btUnit
+\end_layout
+
+\end_inset
+
+.
+
+\series bold
+Note:
+\series default
+ If you are using this approach, then every citation reference has to be
+ inside some
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+btUnit
+\end_layout
+
+\end_inset
+
+.
+ Also, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+btUnit
+\end_layout
+
+\end_inset
+
+s cannot be nested.
+\end_layout
+
+\begin_layout Chapter
+Multipart Documents
+\end_layout
+
+\begin_layout Section
+General Operation
+\end_layout
+
+\begin_layout Standard
+When you are working on a large file with many sections, it is often convenient
+ to break up the document into several files, or perhaps you have something
+ where a table may change from time to time, but the preceding text does
+ not.
+ In these cases, you should seriously consider using multipart documents.
+ For example, scientific papers often have five major sections: the introduction
+, observations, results, discussion, and conclusion.
+ Each of these could be its own separate \SpecialChar LyX
+ file, with one
+\begin_inset Quotes eld
+\end_inset
+
+master
+\begin_inset Quotes erd
+\end_inset
+
+ file which contains the title, authors, abstract, references, etc., plus
+ the five included files.
+ It is important to note that each of these files is a full \SpecialChar LyX
+ file which
+ can be formatted and printed on its own, as well as included in a master
+ file.
+ Each of these files must have the same document class, however—don't attempt
+ to mix book classes with article classes.
+ You may also include \SpecialChar LaTeX
+ files; however, these files must not have their own
+ preamble (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+everything up to and including the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{document}
+\end_layout
+
+\end_inset
+
+ line as well as the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{document}
+\end_layout
+
+\end_inset
+
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ allows you to include files quite easily with
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar menuseparator
+ChiId
+\begin_inset space ~
+\end_inset
+
+Document
+\end_layout
+
+\end_inset
+
+.
+ When you click on this selection a small box is inserted into the file
+ at the current cursor location.
+ Clicking on the box raises a dialog which allows you to select the file
+ to be included, and the method of its inclusion.
+
+\end_layout
+
+\begin_layout Standard
+The file selection box should by now be obvious.
+ The three inclusion methods are
+\begin_inset Quotes eld
+\end_inset
+
+include
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+input
+\begin_inset Quotes erd
+\end_inset
+
+, and
+\begin_inset Quotes eld
+\end_inset
+
+verbatim
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The difference between
+\begin_inset Quotes eld
+\end_inset
+
+include
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+input
+\begin_inset Quotes erd
+\end_inset
+
+ is really only meaningful to \SpecialChar LaTeX
+perts, but the practical difference is that
+ files that are
+\begin_inset Quotes eld
+\end_inset
+
+included
+\begin_inset Quotes erd
+\end_inset
+
+ are typeset beginning on a new page, while files that are
+\begin_inset Quotes eld
+\end_inset
+
+inputted
+\begin_inset Quotes erd
+\end_inset
+
+ are typeset starting on the current page.
+\end_layout
+
+\begin_layout Standard
+Generally, the master file is converted into a full \SpecialChar LaTeX
+ file before typesetting,
+ while the included files are converted to \SpecialChar LaTeX
+ files that do not have all the
+ preamble information.
+\end_layout
+
+\begin_layout Standard
+A
+\begin_inset Quotes eld
+\end_inset
+
+verbatim
+\begin_inset Quotes erd
+\end_inset
+
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+verbatim
+\end_layout
+
+\end_inset
+
+ mode, with the characters set in a fixed-width typewriter font.
+ Normally, spaces in this file are invisible, though two consecutive spaces
+ are conserved, unlike \SpecialChar LyX
+'s normal treatment of spaces.
+ However, setting the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Mark
+\begin_inset space ~
+\end_inset
+
+spaces
+\begin_inset space ~
+\end_inset
+
+in
+\begin_inset space ~
+\end_inset
+
+output
+\end_layout
+
+\end_inset
+
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
+\end_layout
+
+\begin_layout Section
+Cross-References Between Files
+\end_layout
+
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+This section is somewhat out of date.
+ Need to describe default master documents and how children are opened when
+ the master is.
+ [[FIXME]]
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is possible to set up cross-references between the different files.
+ First, open all the files in question: let's call them A and B in a two
+ file example, where B is included in A.
+ Let's say you insert a label in A, then want to reference it in B.
+ Open the cross-reference dialog whilst in document B, and you can select
+ the
+\begin_inset Quotes eld
+\end_inset
+
+buffer
+\begin_inset Quotes erd
+\end_inset
+
+ to use.
+\end_layout
+
+\begin_layout Section
+Bibliography Lists in all Subdocuments
+\end_layout
+
+\begin_layout Standard
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+This section also needs updating.
+ There is now material about this on the wiki, and it could be copied here.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Copy the bibliography list with all entries to all subdocuments and transform
+ them to a comment.
+ This way \SpecialChar LyX
+ will find the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.bib
+\end_layout
+
+\end_inset
+
+-files and you can easily insert references without making the bibliography
+ list visible.
+\end_layout
+
+\begin_layout Standard
+As the bibliography list is in a comment, \SpecialChar LaTeX
+ won't use it and the references
+ will look like this: [?], instead of like this: [1].
+ One solution is to use the \SpecialChar LaTeX
+-package
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+comment
+\end_layout
+
+\end_inset
+
+ that will only include comments by processing the files separately.
+ To do this, add in the \SpecialChar LaTeX
+ preamble of every subdocument the following:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+usepackage{comment}
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+includecomment{comment}
+\end_layout
+
+\begin_layout Standard
+See also
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://wiki.lyx.org/FAQ/Unsorted#toc31
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bullet"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Allan Rae
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ provides 216 bullet shapes that can be accessed from a simple dialog.
+ Using this dialog you can easily specify what bullet shape to use at each
+ level of an itemized list.
+ These settings are document-wide so you won't be able to specify different
+ sets of bullets for different paragraphs.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Well, actually you can but you'll have to do it by hand.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+How it looks
+\end_layout
+
+\begin_layout Standard
+Open the dialog by selecting the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ menu item and then select the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Bullets
+\end_layout
+
+\end_inset
+
+ tab.
+\end_layout
+
+\begin_layout Standard
+The dialog provides you with a table of bullet shapes.
+ A column of buttons on the left of the table provides access to the six
+ different panels of bullet shapes.
+ The row of buttons across the top is used to select which bullet depth
+ you are changing.
+ A text entry under the table shows the currently selected bullet shape's
+ \SpecialChar LaTeX
+ equivalent and this can be edited if desired.
+ If you do modify the text you will also need to specify any needed packages
+ in the \SpecialChar LaTeX
+ preamble.
+\end_layout
+
+\begin_layout Standard
+The six panels are divided up by the packages they require.
+ The following table shows the mappings from button name to \SpecialChar LaTeX
+ package.
+\begin_inset Separator latexpar
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="7" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0pt">
+<column alignment="center" valignment="top" width="0pt">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Button
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Packages Required
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Standard
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+base \SpecialChar LaTeX
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Maths
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+amssymb.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding1
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding2
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding3
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding4
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none"> +\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ doesn't stop you using bullets from packages you don't have.
+ If you get errors from \SpecialChar LaTeX
+ when you try to view or print the file, then it
+ is likely you are missing a package.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar LyX
+ doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+How to use it
+\end_layout
+
+\begin_layout Standard
+Select which bullet depth you want to change then select the bullet shape
+ and size.
+ Any changes will not be visible in \SpecialChar LyX
+, but are visible when viewing the document.
+\end_layout
+
+\begin_layout Standard
+You can reset a bullet shape to the default simply by clicking your right
+ mouse button on the appropriate bullet depth button.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+If you
+\emph on
+really
+\emph default
+ want to have multiple sets of paragraphs with different sets of bullets
+ in each, then you're going to have to get your hands dirty with \SpecialChar TeX
+ code.
+ The bullet selection dialog can help though because it provides you with
+ the \SpecialChar LaTeX
+ code for a wide range of bullet shapes.
+ To make your own custom paragraphs you have the following options:
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+Use the \SpecialChar LaTeX
+ command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+renewcommand{}{}
+\end_layout
+
+\end_inset
+
+ to specify a new bullet shape for a given depth.
+ You'll also need to save the current bullet shape so you can restore it
+ again afterwards.
+ In this itemized list the following \SpecialChar LaTeX
+ code was used to change the bullet
+ used for the first depth.
+\begin_inset Separator latexpar
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+Note that the itemize depth is specified in Roman numerals as part of the
+
+\family typewriter
+
+\backslash
+labelitem
+\family default
+ command.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+[
+\backslash
+(
+\backslash
+star
+\backslash
+)]
+\end_layout
+
+\end_inset
+
+ Specify each individual entry by starting each item with the bullet shape
+ enclosed in square brackets and set as
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar TeX
+ Code
+\end_layout
+
+\end_inset
+
+.
+ For example, this item was started with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[
+\backslash
+(
+\backslash
+star
+\backslash
+)]
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+You'll also need to revert the labelitem back to its previous setting for
+ the global bullet shape settings to remain in effect.
+ The way used here was:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Chapter
\SpecialChar LyX
Features needing Extra Software
\end_layout
@@ -24086,712 +23239,832 @@ Specific Manuals
\end_layout
\begin_layout Chapter
-Special features
+\SpecialChar LyX
+ Archives
\end_layout
\begin_layout Standard
-You can do everything with \SpecialChar LyX
- that you can do with \SpecialChar LaTeX
-.
- However, \SpecialChar LyX
- cannot support every \SpecialChar LaTeX
- feature directly.
- But you can always use \SpecialChar TeX
- Code.
- This chapter shows you some more special things you might want to use.
- For other special things you can do with figures, tables, floats, boxes
- and notes, have a look at the
-\emph on
-Embedded
-\begin_inset space ~
+Users sometimes need to be able to
+\begin_inset Quotes eld
\end_inset
-Objects
-\emph default
- manual.
-\end_layout
+bundle
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Section
-Multiple Text Columns
+ a \SpecialChar LyX
+ file together with all the images (and other files) on which it depends,
+ either for sending to a publisher or for sharing with a co-author.
+ \SpecialChar LyX
+ 2.0 includes a Python script (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxpak.py
\end_layout
-\begin_layout Standard
-This feature is independent of the option
-\family sans
-Two-column document
-\family default
- in the document settings under
-\family sans
-Text Layout
-\family default
-.
- If you want to have 2
-\begin_inset space ~
\end_inset
-columns for the whole document, it is recommended to use the
-\family sans
-Two-column document
-\family default
- option.
- For all other cases use this feature.
-\end_layout
+) that automates this process.
+ To use it, you must have either the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-To use multiple text columns in your document, you have to load the module
-
-\family sans
-Multiple Columns
-\family default
- (menu
-\family sans
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Modules
-\family default
-) and must have the \SpecialChar LaTeX
--package
-\series bold
-multicol
-\series default
- installed.
+\begin_layout Plain Layout
+zipfile
\end_layout
-\begin_layout Standard
-Footnotes within multiple columns will be placed at the bottom of the page
- and not under each column.
- Within the different columns you can use everything, with the limitation
- that for floats you need to use the float option
-\family sans
-Span columns
-\family default
-.
-\end_layout
+\end_inset
-\begin_layout Subsection
-Basics
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tarfile
\end_layout
-\begin_layout Standard
-If you want to have 2
-\begin_inset space ~
\end_inset
-columns in your text, insert a multicolumn inset via the menu
-\family sans
-Insert\SpecialChar menuseparator
-Custom
-\begin_inset space ~
-\end_inset
+ python modules installed on your system.
+ By default, the script prefers the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+gzip
+\end_layout
-Insets\SpecialChar menuseparator
-Multiple
-\begin_inset space ~
\end_inset
-Columns
-\family default
- where the columns should start.
- Write all text that should be printed in 2
-\begin_inset space ~
+-compressed
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tar
+\end_layout
+
\end_inset
-columns into this inset.
+ format on Unix-like systems and the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
\end_layout
-\begin_layout Standard
-Here is an example:
+\end_inset
+
+ format on Windows.
\end_layout
\begin_layout Standard
-\noindent
-\begin_inset Flex Multiple Columns
-status open
+\SpecialChar LyX
+'s configuration process will set the script up to export a `\SpecialChar LyX
+ Archive',
+ and this format will then be available under
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\noindent
-
-\series bold
-\size small
-The Adventure of the Empty House
-\series default
+File\SpecialChar menuseparator
+Export
+\end_layout
-\begin_inset Newline newline
\end_inset
-by Sir Arthur Conan Doyle
+.
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Independently of the platform, the generation of a particular archive format
+ can be forced by adding either the
+\begin_inset Flex Code
+status collapsed
-\size small
-It was in the spring of the year 1894 that all London was interested, and
- the fashionable world dismayed, by the murder of the Honourable Ronald
- Adair under most unusual and inexplicable circumstances.
- The public has already learned those particulars of the crime which came
- out in the police investigation, but a good deal was suppressed upon that
- occasion, since the case for the prosecution was so overwhelmingly strong
- that it was not necessary to bring forward all the facts.
- Only now, at the end of nearly ten years, am I allowed to supply those
- missing links which make up the whole of that remarkable chain.
- The crime was of interest in itself, but that interest was as nothing to
- me compared to the inconceivable sequel, which afforded me the greatest
- shock and surprise of any event in my adventurous life.
- Even now, after this long interval, I find myself thrilling as I think
- of it, and feeling once more that sudden flood of joy, amazement, and increduli
-ty which utterly submerged my mind.
- Let me say to that public, which has shown some interest in those glimpses
- which I have occasionally given them of the thoughts and actions of a very
- remarkable man, that they are not to blame me if I have not shared my knowledge
- with them, for I should have considered it my first duty to do so, had
- I not been barred by a positive prohibition from his own lips, which was
- only withdrawn upon the third of last month.
+\begin_layout Plain Layout
+-t
\end_layout
\end_inset
+ (for the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+tar
\end_layout
-\begin_layout Standard
-To get 3 or more columns, set the cursor into the multicolumn inset and
- use the menu
-\family sans
-Insert\SpecialChar menuseparator
-Number
-\begin_inset space ~
\end_inset
-of
-\begin_inset space ~
-\end_inset
+ format) or
+\begin_inset Flex Code
+status collapsed
-Columns
-\family default
-.
- The number of the desired columns is written into that inset (for 3
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+-z
+\end_layout
-columns write
-\begin_inset Quotes eld
\end_inset
-3
-\begin_inset Quotes erd
+ (for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
+\end_layout
+
\end_inset
-).
-\begin_inset Newline newline
+ format) switch to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar LyX
+\SpecialChar menuseparator
+\SpecialChar LyX
+ Archive
+\end_layout
+
\end_inset
-Here is an example with 3
-\begin_inset space ~
+ converter in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
+\end_layout
+
\end_inset
-columns:
+.
+ (Make sure you add the switch after the script name, not before it.)
+\end_layout
+
+\begin_layout Chapter
+\SpecialChar LyX
+ and the World Wide Web
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+\SpecialChar LyX
+ has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before verson 2.0, however, HTML export was always accomplished by the use
+ of external converters.
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
+For details on the use of external converters with \SpecialChar LyX
+, see the
+\emph on
+Converters
+\emph default
+ section of the Customization manual.
+\end_layout
-\size footnotesize
-\begin_inset Argument 1
-status open
+\end_inset
+
+ These fall into two large groups: there are converters that use \SpecialChar LaTeX
+ as an
+ intermediate format, such as
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-3
+htlatex
\end_layout
\end_inset
-It can be imagined that my close intimacy with Sherlock Holmes had interested
- me deeply in crime, and that after his disappearance I never failed to
- read with care the various problems which came before the public.
- And I even attempted, more than once, for my own private satisfaction,
- to employ his methods in their solution, though with indifferent success.
- There was none, however, which appealed to me like this tragedy of Ronald
- Adair.
- As I read the evidence at the inquest, which led up to a verdict of willful
- murder against some person or persons unknown, I realized more clearly
- than I had ever done the loss which the community had sustained by the
- death of Sherlock Holmes.
- There were points about this strange business which would, I was sure,
- have specially appealed to him, and the efforts of the police would have
- been supplemented, or more probably anticipated, by the trained observation
- and the alert mind of the first criminal agent in Europe.
- All day, as I drove upon my round, I turned over the case in my mind and
- found no explanation which appeared to me to be adequate.
- At the risk of telling a twice-told tale, I will recapitulate the facts
- as they were known to the public at the conclusion of the inquest.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+html2latex
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plastex
\end_layout
\end_inset
+, relying upon \SpecialChar LyX
+ to produce the \SpecialChar LaTeX
+; and there is a converter that works directly
+ on \SpecialChar LyX
+ files,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Standard
-You can have up to 10
-\begin_inset space ~
\end_inset
-columns if you want to, but that might not be very pleasant for the readers
- of your document.
+.
+ All of these have different advantages and disadvantages.
+
\end_layout
\begin_layout Standard
-\begin_inset Newpage newpage
+The \SpecialChar LaTeX
+-based converters have the advantage that, in principle, they know everythin
+g about the exported document that \SpecialChar LaTeX
+ does.
+ Such converters do not care, for example, if a certain block of code was
+ produced by \SpecialChar LyX
+ or was Evil Red Text.
+ These converters know about
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+aux
+\end_layout
+
\end_inset
+ files, counters, and references, and can often make use of the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+bbl
\end_layout
-\begin_layout Subsection
-Columns inside Columns
+\end_inset
+
+ files generated by Bib\SpecialChar TeX
+.
+ On the other hand, \SpecialChar LaTeX
+ is a very hard language to parse—it is sometimes said
+ that only \SpecialChar TeX
+ itself understands \SpecialChar TeX
+—and \SpecialChar LaTeX
+-based converters will often choke on
+ what seem to be quite simple constructs; complex ones can throw them completely
+, and as of this writing, for example, the
+\emph on
+Embedded Objects
+\emph default
+ manual will not export with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Standard
-You can also have columns inside columns:
+\end_inset
+
+, though the others will.
+ The other issue concerns how math is handled.
+ These converters typically convert the formulae into little pictures that
+ are then linked from the HTML document.
+ Since these are actually generated by \SpecialChar LaTeX
+, they are accurate.
+ But they do not scale well, and just getting them to look as if they are
+ actually meant to be in your document—so that the font sizes seem to be
+ roughly the same—can be a challenge.
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+Alex Fernandez's
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-\size footnotesize
-The Honourable Ronald Adair was the second son of the Earl of Maynooth,
- at that time governor of one of the Australian colonies.
- Adair's mother had returned from Australia to undergo the operation for
- cataract, and she, her son Ronald, and her daughter Hilda were living together
- at 427 Park Lane.
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Plain Layout
-\begin_inset Flex Multiple Columns
-status open
+\end_inset
-\begin_layout Plain Layout
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
-\size footnotesize
-The youth moved in the best society–had, so far as was known, no enemies
- and no particular vices.
- He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
- had been broken off by mutual consent some months before, and there was
- no sign that it had left any very profound feeling behind it.
- For the rest {sic} the man's life moved in a narrow and conventional circle,
- for his habits were quiet and his nature unemotional.
- Yet it was upon this easy-going young aristocrat that death came, in most
- strange and unexpected form, between the hours of ten and eleven-twenty
- on the night of March 30, 1894.
+\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
+
+\begin_layout Plain Layout
+htlatex
\end_layout
\end_inset
+; this reflects the limitations of HTML.
+\begin_inset Foot
+status collapsed
-\end_layout
+\begin_layout Plain Layout
+That said,
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+e\SpecialChar LyX
+er
+\end_layout
-\size footnotesize
-Ronald Adair was fond of cards–playing continually, but never for such stakes
- as would hurt him.
- He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
- It was shown that, after dinner on the day of his death, he had played
- a rubber of whist at the latter club.
- He had also played there in the afternoon.
+\end_inset
-\size default
-
-\size footnotesize
-The evidence of those who had played with him– Mr.
- Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
- and that there was a fairly equal fall of the cards.
- Adair might have lost five pounds, but not more.
- His fortune was a considerable one, and such a loss could not in any way
- affect him.
- He had played nearly every day at one club or other, but he was a cautious
- player, and usually rose a winner.
- It came out in evidence that, in partnership with Colonel Moran, he had
- actually won as much as four hundred and twenty pounds in a sitting, some
- weeks before, from Godfrey Milner and Lord Balmoral.
- So much for his recent history as it came out at the inquest.
+ 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
+ More importantly (as of version 1.1.1, at least),
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Subsection
-Advanced Examples
+\end_inset
+
+ 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
+
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Standard
-The examples in this section show some more special features of multiple
- columns.
+\end_inset
+
+ unsuitable for many of the documents \SpecialChar LyX
+ users produce.
+ In principle, of course, these problems could be solved, but the \SpecialChar LyX
+ developers
+ have decided to follow a different path and have made \SpecialChar LyX
+ itself capable of
+ writing XHTML, just as it is capable of writing \SpecialChar LaTeX
+, DocBook, and plaintext.
\end_layout
\begin_layout Standard
-For more features of multiple columns, have a look at the documentation
- of the \SpecialChar LaTeX
--package
-\series bold
-multicol
-\series default
-,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "multicol"
+As of this writing, XHTML output remains under development and should probably
+ be regarded as
+\begin_inset Quotes eld
+\end_inset
+experimental
+\begin_inset Quotes erd
\end_inset
.
-\end_layout
+\begin_inset Foot
+status collapsed
-\begin_layout Subsubsection
-Preface
+\begin_layout Plain Layout
+The file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/HTML.notes
\end_layout
-\begin_layout Standard
-To add a preface text for multiple columns, set the cursor into the multicolumn
- inset and use the menu
-\family sans
-Insert\SpecialChar menuseparator
-Preface
-\family default
-.
- Write your preface text into that inset.
-\begin_inset Newline newline
\end_inset
-This is an example with some preface text:
-\end_layout
+, which can be found in the \SpecialChar LyX
+ source tree or
+\begin_inset CommandInset href
+LatexCommand href
+name "accessed online"
+target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
-\begin_layout Standard
-\begin_inset VSpace bigskip
\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
-\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+\end_inset
-\begin_layout Plain Layout
-\begin_inset Argument 2
-status open
+ Still, the developers have chosen this approach because it has several
+ potential advantages over the other two.
+\end_layout
-\begin_layout Plain Layout
-And the story continues and continues and continues and continues\SpecialChar ldots
+\begin_layout Standard
+These advantages are primarily due to the fact that the XHTML output routines,
+ since they are part of \SpecialChar LyX
+, know everything \SpecialChar LyX
+ knows about the document being
+ exported.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+Another advantage is that, since these routines are internal to \SpecialChar LyX
+, they are
+ immune to changes in \SpecialChar LyX
+'s file format, or to changes in the semantics of
+ existing insets.
\end_layout
\end_inset
+ So they know about the table of contents (as displayed in the outline),
+ about the counters associated with different paragraph styles, and about
+ user-defined styles.
+ The XHTML output routines know what \SpecialChar LyX
+ knows about internationalization,
+ too, so they will output
+\begin_inset Quotes eld
+\end_inset
-\size small
-On the evening of the crime, he returned from the club exactly at ten.
- His mother and sister were out spending the evening with a relation.
- The servant deposed that she heard him enter the front room on the second
- floor, generally used as his sitting-room.
- She had lit a fire there, and as it smoked she had opened the window.
- No sound was heard from the room until eleven-twenty, the hour of the return
- of Lady Maynooth and her daughter.
- Desiring to say good-night, she attempted to enter her son's room.
- The door was locked on the inside, and no answer could be got to their
- cries and knocking.
- Help was obtained, and the door forced.
- The unfortunate young man was found lying near the table.
- His head had been horribly mutilated by an expanding revolver bullet, but
- no weapon of any sort was to be found in the room.
-\end_layout
+Chapter 1
+\begin_inset Quotes erd
+\end_inset
+ or
+\begin_inset Quotes eld
\end_inset
+\lang ngerman
+Kapitel
+\lang english
+ 1
+\begin_inset Quotes erd
+\end_inset
+
+, depending upon the language in effect at the time.
+
\end_layout
\begin_layout Standard
-You can also use a section heading as the preface if you use a section command
- as \SpecialChar TeX
- Code.
- For example the command
+Quite generally, the output routines know what \SpecialChar 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, \SpecialChar LyX
+
+\emph on
+automatically
+\emph default
+ generates CSS style information corresponding to the layout information
+ it uses to render the document on screen: if section headings are supposed
+ to be sans-serif and bold as seen in \SpecialChar LyX
+, then (by default) they will be sans-seri
+f and bold when viewed in a web browser, too.
+ And this is true not just for pre-defined styles, like Section, but for
+ any style, including user-defined styles.
+ Indeed, the XHTML output routines make no distinction between user-defined
+ paragraph and character styles and \SpecialChar LyX
+'s own pre-defined styles: in each case,
+ everything \SpecialChar LyX
+ knows about the styles is contained in the layout files.
+ And much the same is true as regards pre-defined textual insets, such as
+ footnotes, and various custom insets.
+
\end_layout
\begin_layout Standard
+The result is that XHTML output can be customized and extended in exactly
+ the same way \SpecialChar LaTeX
+ output can be customized and extended: through layout files
+ and modules.
+ See chapter five of the
+\emph on
+Customization
+\emph default
+manual for the details.
+\end_layout
-\series bold
+\begin_layout Standard
+The remainder of this chapter contains more detailed information on XHTML
+ output, its limitations, and ways to work around those limitations.
+\end_layout
-\backslash
-subsection{subsection title}
+\begin_layout Section
+Math Output in XHTML
\end_layout
\begin_layout Standard
-creates a subsection.
- In this example the preface is a subsubsection:
+\SpecialChar LyX
+ offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
\end_layout
-\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-\begin_inset Argument 2
-status open
+MathML is a dialect of XML designed specifically for mathematics on the
+ web, and it typically renders very well in browsers that support it.
+ The disadvantage is that not all browsers support MathML, and support is
+ not complete even in the Gecko-based browsers, such as Firefox.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-\begin_inset ERT
+If \SpecialChar LyX
+ is unable to render a formula as MathML—for example, if the formula
+ uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+xymatrix
+\end_layout
+\end_inset
-\backslash
-subsubsection{
+ package or ERT—then it will instead output the formula as an image.
+
\end_layout
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
\end_inset
-This is a subsubsection heading as a preface
-\begin_inset ERT
+As mentioned above,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-}
+elyxer
\end_layout
\end_inset
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+\SpecialChar LyX
+ has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+elyxer
\end_layout
\end_inset
-
-\size small
-A minute examination of the circumstances served only to make the case more
- complex.
- In the first place, no reason could be given why the young man should have
- fastened the door upon the inside.
- There was the possibility that the murderer had done this, and had afterwards
- escaped by the window.
- The drop was at least twenty feet, however, and a bed of crocuses in full
- bloom lay beneath.
- Neither the flowers nor the earth showed any sign of having been disturbed,
- nor were there any marks upon the narrow strip of grass which separated
- the house from the road.
- Apparently, therefore, it was the young man himself who had fastened the
- door.
- But how did he come by his death? No one could have climbed up to the window
- without leaving traces.
- Suppose a man had fired through the window, he would indeed be a remarkable
- shot who could with a revolver inflict so deadly a wound.
- Again, Park Lane is a frequented thoroughfare; there is a cab stand within
- a hundred yards of the house.
- No one had heard a shot.
+.
\end_layout
\end_inset
+ For simple formulae, this can work quite well, though with more complicated
+ formulae it tends to break down.
+ Still, this method has the advantage that it is very widely supported and
+ so it may be appropriate for documents that contain only a little, fairly
+ simple math.
+\begin_inset Newline newline
+\end_inset
+
+If Lyx is unable to render a formula as HTML—for example, if the formula
+ uses the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+xymatrix
\end_layout
-\begin_layout Standard
-If there is less vertical space than 6
-\begin_inset space ~
\end_inset
-text lines is left on the page at the beginning of the multiple columns,
- a page break will be inserted before the multiple columns.
- Depending on the number of lines of the preface text, you might want to
- change this space.
- This is done by setting the cursor into the mulitcolumn inset behind the
- preface (if there is any) and using the menu
-\family sans
-Insert\SpecialChar menuseparator
-Space
-\begin_inset space ~
-\end_inset
+ package or ERT—then it will instead output the formula as an image.
+
+\end_layout
-Before
-\begin_inset space ~
+\begin_layout Itemize
+Images
+\begin_inset Newline newline
\end_inset
-Page
-\begin_inset space ~
-\end_inset
+Like
+\begin_inset Flex Code
+status collapsed
-Break
-\family default
-.
- Insert into that inset the amount of space like e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+htlatex
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
+, \SpecialChar LyX
+ will output formulae as images, the very same images, in fact, that are
+ used for instant preview.
+\begin_inset Foot
+status collapsed
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Instant preview does
+\emph on
+not
+\emph default
+have to be on for images to be output, however.
+\end_layout
-5cm
-\begin_inset Quotes erd
\end_inset
-.
-\begin_inset Newline newline
+ The advantage to this method is that the images are simply generated by
+ \SpecialChar 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
-In this example the space is set to 7
-\begin_inset space ~
+.)
+\begin_inset Newline newline
\end_inset
-text lines by using
+The size of the images can be controlled by setting the
\begin_inset Quotes eld
\end_inset
-7
-\backslash
-baselineskip
+Math Images Scaling
\begin_inset Quotes erd
\end_inset
- (where the command
-\series bold
+ parameter under
+\begin_inset Flex Noun
+status collapsed
-\backslash
-baselineskip
-\series default
- needs to be inserted as \SpecialChar TeX
- code):
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output
\end_layout
-\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
-
-\begin_layout Plain Layout
-\begin_inset Argument 3
-status open
+\end_inset
-\begin_layout Plain Layout
-7
-\begin_inset ERT
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-baselineskip
+For those who want to know, this controls the resolution of the image in
+ dots per inch and is based upon a default of 75 dpi.
\end_layout
\end_inset
+\begin_inset Newline newline
+\end_inset
+
+If \SpecialChar LyX
+ for some reason fails to create an image for a formula (e.g., if a required
+ \SpecialChar LaTeX
+ package is not installed), then it will fall back to outputing the raw
+ \SpecialChar LaTeX
+.
\end_layout
-\end_inset
+\begin_layout Itemize
+\SpecialChar LaTeX
+\begin_inset Newline newline
+\end_inset
-\size small
-On the evening of the crime, he returned from the club exactly at ten.
- His mother and sister were out spending the evening with a relation.
- The servant deposed that she heard him enter the front room on the second
- floor, generally used as his sitting-room.
- She had lit a fire there, and as it smoked she had opened the window.
- No sound was heard from the room until eleven-twenty, the hour of the return
- of Lady Maynooth and her daughter.
- Desiring to say good-night, she attempted to enter her son's room.
- The door was locked on the inside, and no answer could be got to their
- cries and knocking.
- Help was obtained, and the door forced.
- The unfortunate young man was found lying near the table.
- His head had been horribly mutilated by an expanding revolver bullet, but
- no weapon of any sort was to be found in the room.
-\end_layout
+Finally, \SpecialChar LyX
+ will happily output math as \SpecialChar LaTeX
+.
+ As well as being the output of last resort, this method can be used with
+ such tools as
+\begin_inset CommandInset href
+LatexCommand href
+name "jsMath"
+target "http://www.math.union.edu/~dpvc/jsMath/"
\end_inset
+, which uses JavaScript to render \SpecialChar LaTeX
+ embedded in HTML documents.
+ \SpecialChar LyX
+ wraps the \SpecialChar LaTeX
+ in either a
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+span
\end_layout
-\begin_layout Subsubsection
-Surrounding Space
-\end_layout
+\end_inset
-\begin_layout Standard
-The amount of space before and after multiple columns can be changed by
- changing the length
-\series bold
+ (for inline formulas) or
+\begin_inset Flex Code
+status collapsed
-\backslash
-multicolsep
-\series default
-.
- For example the command
+\begin_layout Plain Layout
+div
\end_layout
-\begin_layout Standard
+\end_inset
-\series bold
+ (for displayed formulas) with
+\begin_inset Flex Code
+status collapsed
-\backslash
-setlength{
-\backslash
-multicolsep}{3cm}
+\begin_layout Plain Layout
+class='math'
\end_layout
-\begin_layout Standard
-in \SpecialChar TeX
- Code changes its value to 3
-\begin_inset space \thinspace{}
\end_inset
-cm.
- The change must be made before the multiple columns' start.
- The predefined value is 13
-\begin_inset space \thinspace{}
-\end_inset
-
-pt.
+, as is required for jsMath.
\end_layout
\begin_layout Standard
-For this example
-\series bold
+One of these output methods must be selected under
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output
+\end_layout
-\backslash
-multicolsep
-\series default
- was set to 2.5
-\begin_inset space \thinspace{}
\end_inset
-cm:
+.
+ By default, \SpecialChar LyX
+ outputs MathML.
+ This is a document-wide setting, therefore.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+Eventually, \SpecialChar LyX
+ will offer the user the option to select an alternate output
+ method for a particular inset, say, one that isn't being rendered very
+ well by MathML.
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
+That said, since \SpecialChar LyX
+ falls back to images if the inset contains ERT, then one
+ can force output as an image by putting some harmless ERT into the math,
+ for example:
+\begin_inset Formula $a=b\relax$
+\end_inset
-
-\backslash
-setlength{
-\backslash
-multicolsep}{2.5cm}
+.
\end_layout
\end_inset
@@ -24799,1711 +24072,2495 @@ multicolsep}{2.5cm}
\end_layout
+\begin_layout Section
+Bibliography and Citations
+\end_layout
+
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+XHTML output fully supports bibliographies and citations.
+
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Citation labels are generated by the same machinery that generates \SpecialChar LyX
+'s on-screen
+ labels, so the labels will look in the output much as they do in \SpecialChar LyX
+, though
+ better.
+ If you are using numerical citations, then \SpecialChar LyX
+ will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then \SpecialChar LyX
+ will add lowercase letters
+ to the years, just as Bib\SpecialChar TeX
+ does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
+\end_layout
-\size small
-All day I turned these facts over in my mind, endeavouring to hit upon some
- theory which could reconcile them all, and to find that line of least resistanc
-e which my poor friend had declared to be the starting-point of every investigat
-ion.
- I confess that I made little progress.
- In the evening I strolled across the Park, and found myself about six o'clock
- at the Oxford Street end of Park Lane.
- A group of loafers upon the pavements, all staring up at a particular window,
- directed me to the house which I had come to see.
- A tall, thin man with coloured glasses, whom I strongly suspected of being
- a plain-clothes detective, was pointing out some theory of his own, while
- the others crowded round to listen to what he said.
- I got as near him as I could, but his observations seemed to me to be absurd,
- so I withdrew again in some disgust.
- As I did so I struck against an elderly, deformed man, who had been behind
- me, and I knocked down several books which he was carrying.
+\begin_layout Standard
+Bibliography output is handled by the same machinery that handles the presentati
+on of reference information in the citation dialog, so you will see in the
+ XHTML output pretty much what you would see if you were to look at a given
+ entry in the citation dialog.
+ The formatting can be customized in your layout file or, preferably, in
+ a module.
+ See the
+\emph on
+Customization
+\emph default
+ manual for the details.
+\end_layout
+
+\begin_layout Standard
+The main defect at present is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
\end_layout
+\begin_layout Quote
+Jason Stanley,
+\begin_inset Quotes eld
\end_inset
+Context and Logical Form
+\begin_inset Quotes erd
+\end_inset
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 30–68.
\end_layout
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
+\begin_layout Quote
+Jason Stanley,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+Semantics in Context
+\begin_inset Quotes erd
+\end_inset
-\series bold
-Note:
-\series default
- The values you set with
-\series bold
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 201–30.
+\end_layout
-\backslash
-setlength
-\series default
- will be used for all following multiple columns until you change them again.
+\begin_layout Standard
+This should be fixed before long.
\end_layout
-\end_inset
+\begin_layout Standard
+There is no support at present for sectioned bibliographies.
+ If you have multiple bibliographies, then \SpecialChar LyX
+ will print the same bibliography
+ over and over.
+\end_layout
+\begin_layout Section
+Indexes
+\end_layout
+\begin_layout Standard
+\SpecialChar LyX
+ will happily export indexes as XHTML, but with certain limitations at the
+ moment.
\end_layout
\begin_layout Standard
-\begin_inset ERT
+Index export will be most reliable when you do not attempt to use the fancy
+ constructs that are described in the section on indexes in the
+\emph on
+User's Guide
+\emph default
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
+The main issue here is that \SpecialChar LyX
+ itself does not really handle these.
+ It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
+.
+\end_layout
+\end_inset
-\backslash
-setlength{
-\backslash
-multicolsep}{13pt}
+ We'll describe how they are handled using the subsection headings from
+ that section.
\end_layout
+\begin_layout Itemize
+Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
+ makes an effort to support these,
+ but the entries must be separated by
+\begin_inset Quotes eld
\end_inset
+ !
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Note Note
-status collapsed
+, that is, there must be spaces around the exclamation point.
+ This is because it is otherwise too difficult to check for escaped exclamation
+ points, ones in math, and so forth.
+\end_layout
-\begin_layout Plain Layout
-go back to the default
+\begin_layout Itemize
+Page Ranges: There is no support at all for page ranges, since these make
+ no sense with XHMTL.
+ Instead, you will just get two index entries, one at either end.
\end_layout
+\begin_layout Itemize
+Cross-referencing: There is no support for cross-referencing.
+ If \SpecialChar LyX
+ finds an entry containing the
+\begin_inset Quotes eld
\end_inset
+|see\SpecialChar ldots
+\begin_inset Quotes erd
+\end_inset
+
+ construct, it is just dropped, and the rest is treated as an ordinary index
+ entry.
\end_layout
-\begin_layout Standard
-\begin_inset Newpage newpage
+\begin_layout Itemize
+Index Entry Order: \SpecialChar LyX
+ does support attempts to fix the sorting order.
+ It will take what is before the first `@' it finds and use that for sorting,
+ taking what follows the first `@' to be the actual entry.
+ At present, \SpecialChar LyX
+ does not check for escaped `@', so do not try to index email
+ addresses.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Layout: You can format entries by using the text style dialog,
+ or by using any other method available within \SpecialChar LyX
+ itself.
+ There is no support for constructs like:
+\begin_inset Quotes eld
\end_inset
+entry|textbf
+\begin_inset Quotes erd
+\end_inset
+.
+ Indeed, if \SpecialChar LyX
+ finds a pipe symbol, `|', in an entry, it will delete it and
+ everything that follows it.
\end_layout
-\begin_layout Subsubsection
-Column Breaks
+\begin_layout Itemize
+Multiple Indexes: There is no support for multiple indexes.
+ Rather, all index entries will be printed as one large index.
+ To avoid our printing several versions of the index, we print only the
+ main index, so make sure you have one.
+\end_layout
+
+\begin_layout Section
+Nomenclature and Glossary
\end_layout
\begin_layout Standard
-A column break can be forced by inserting the command
-\series bold
+There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
+\end_layout
-\backslash
-columnbreak{}
-\series default
- as \SpecialChar TeX
- Code to that position in the text where the column should be broken.
- Note that this leads in most cases to whitespace in the text.
-\begin_inset Newline newline
-\end_inset
+\begin_layout Chapter
+The \SpecialChar LyX
+ Server
+\end_layout
-Here is an example:
+\begin_layout Section
+Introduction
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
-
-\begin_layout Plain Layout
-
-\size small
+The `\SpecialChar LyX
+ server' allows other programs to talk to \SpecialChar LyX
+, invoke \SpecialChar LyX
+ commands, and retrieve
+ information about the \SpecialChar LyX
+ internal state.
+ This is only intended for advanced users, but they should find it useful.
+ It is by writing to the \SpecialChar LyX
+ server, for example, that bibliography managers,
+ such as JabRef, are able to
\begin_inset Quotes eld
\end_inset
-You're surprised to see me, sir,
+push
\begin_inset Quotes erd
\end_inset
- said he, in a strange, croaking voice.
+ citations to \SpecialChar LyX
+.
\end_layout
-\begin_layout Plain Layout
+\begin_layout Section
+Starting the \SpecialChar LyX
+ Server
+\end_layout
-\size small
-I acknowledged that I was.
+\begin_layout Standard
+The \SpecialChar LyX
+ server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
\end_layout
+\end_inset
+
+, (except on Windows, where
+\emph on
+local
+\emph default
+ named pipes are special objects located in
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
-\size small
-\begin_inset Quotes eld
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\end_layout
+
\end_inset
-Well, I've a conscience, sir, and when I chanced to see you go into this
- house, as I came hobbling after you, I thought to myself, I'll just step
- in and see that kind gentleman, and tell him that if I was a bit gruff
- in my manner there was not any harm meant, and that I am much obliged to
- him for picking up my books.
-\begin_inset Quotes erd
+) and have the names
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+lyxpipe.in
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
-You make too much of a trifle,
+
\begin_inset Quotes erd
\end_inset
- said I.
-
+ and
\begin_inset Quotes eld
\end_inset
-May I ask how you knew who I was?
-\begin_inset Quotes erd
-\end_inset
- AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
-\begin_inset ERT
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-columnbreak{}
+lyxpipe.out
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+ External programs write into
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+lyxpipe.in
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
-Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
- you'll find my little bookshop at the corner of Church Street, and very
- happy to see you, I am sure.
- Maybe you collect yourself, sir.
- Here's
-\noun on
-British
-\begin_inset space ~
-\end_inset
+ and read back data from
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxpipe.out
+\end_layout
-Birds
-\noun default
-, and
-\noun on
-Catullus
-\noun default
-, and
-\noun on
-The Holy War
-\noun default
-–a bargain, every one of them.
- With five volumes you could just fill that gap on that second shelf.
- It looks untidy, does it not, sir?
-\begin_inset Quotes erd
\end_inset
+.
+ The stem of the pipe names can be defined in the
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences
\end_layout
\end_inset
+ dialog, for example
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+"/home/myhome/lyxpipe"
\end_layout
-\begin_layout Subsubsection
-Column Separation
-\end_layout
+\end_inset
-\begin_layout Standard
-The width of the columns is automatically calculated, but you can modify
- the space between the columns.
- This is done by changing the length
-\series bold
+, or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+"
+\backslash
\backslash
-columnsep
-\series default
.
- Its predefined value is 10
-\begin_inset space \thinspace{}
+\backslash
+pipe
+\backslash
+lyxpipe"
+\end_layout
+
\end_inset
-pt.
- Here is an example where
-\series bold
+ on Windows (where any working path instead of lyxpipe can be used, for
+ example
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+"
+\backslash
\backslash
-columnsep
-\series default
- is set to 3
-\begin_inset space \thinspace{}
+.
+\backslash
+pipe
+\backslash
+my
+\backslash
+lyx
+\backslash
+pipe"
+\end_layout
+
\end_inset
-cm:
+ would also work).
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+\SpecialChar LyX
+ will add the '
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+.in
+\end_layout
+
+\end_inset
+' and '
+\begin_inset Flex Code
+status collapsed
-\backslash
-setlength{
-\backslash
-columnsep}{3cm}
+\begin_layout Plain Layout
+.out
\end_layout
\end_inset
+' to create the pipes.
+ If one of the pipes already exists, \SpecialChar LyX
+ will assume that another \SpecialChar LyX
+ process
+ is already running and will not start the server.
+ On POSIX (Unix like) systems, if for some other reason, an unused
+\begin_inset Quotes eld
+\end_inset
+
+stale
+\begin_inset Quotes erd
+\end_inset
+ pipe is left in existence when \SpecialChar LyX
+ closes, then \SpecialChar LyX
+ will try to delete it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart \SpecialChar LyX
+.
+ On Windows, pipes are deleted by the OS on program termination or crash,
+ so
+\begin_inset Quotes eld
+\end_inset
+
+stale
+\begin_inset Quotes erd
+\end_inset
+
+ pipes should not be possible.
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+To have several \SpecialChar LyX
+ processes with servers at the same time, you have to use
+ different configurations, perhaps by using separate user directories, each
+ with its own
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+preferences
+\end_layout
-\size small
-My observations of No.
-\begin_inset space \space{}
\end_inset
-427 Park Lane did little to clear up the problem in which I was interested.
- The house was separated from the street by a low wall and railing, the
- whole not more than five feet high.
- It was perfectly easy, therefore, for anyone to get into the garden, but
- the window was entirely inaccessible, since there was no water pipe or
- anything which could help the most active man to climb it.
- More puzzled than ever, I retraced my steps to Kensington.
- I had not been in my study five minutes when the maid entered to say that
- a person desired to see me.
- To my astonishment it was none other than my strange old book collector,
- his sharp, wizened face peering out from a frame of white hair, and his
- precious volumes, a dozen of them at least, wedged under his right arm.
+ file, for each process.
\end_layout
-\end_inset
+\begin_layout Standard
+If you are developing a client program, you might find it useful to enable
+ debugging information from the \SpecialChar LyX
+ server.
+ Do this by starting \SpecialChar LyX
+ as
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyx -dbg lyxserver
+\end_layout
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-\begin_inset ERT
+You can find a complete example client written in C++ in the source distribution
+ as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-setlength{
-\backslash
-columnsep}{10pt}
+development/lyxserver/server_monitor.cpp
\end_layout
\end_inset
+.
+\end_layout
-\begin_inset Note Note
+\begin_layout Standard
+Another useful tool is the command-line based client found in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-go back to the default
+src/client/lyxclient
\end_layout
\end_inset
+.
+\end_layout
+\begin_layout Section
+Normal communication
\end_layout
-\begin_layout Subsubsection
-Vertical Lines
+\begin_layout Standard
+To issue a \SpecialChar LyX
+ call, the client writes a line of ASCII text into the input
+ pipe.
+ This line has the following format:
+\end_layout
+
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
+\end_layout
+
+\begin_layout Description
+clientname is a name that the client can choose arbitrarily.
+ Its only use is that \SpecialChar LyX
+ will echo it if it sends an answer—so a client can
+ dispatch results from different requesters.
+\end_layout
+
+\begin_layout Description
+function is the function you want \SpecialChar LyX
+ to perform.
+ It is the same as the commands you'd use in the minibuffer.
+\end_layout
+
+\begin_layout Description
+argument is an optional argument which is meaningful only to some functions
+ (for instance, the
+\begin_inset Quotes eld
+\end_inset
+
+self-insert
+\begin_inset Quotes erd
+\end_inset
+
+ LFUN will insert the argument as text at the cursor position).
\end_layout
\begin_layout Standard
-Between the columns a rule with a width of the length
-\series bold
+The answer from \SpecialChar LyX
+ will arrive in the output pipe and be of the form
+\end_layout
-\backslash
-columnseprule
-\series default
- is placed.
- If this rule width is set to 0
-\begin_inset space \thinspace{}
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
+\end_layout
+
+\begin_layout Standard
+where
+\emph on
+clientname
+\emph default
+ and
+\emph on
+function
+\emph default
+ are just echoed from the command request, while
+\emph on
+data
+\emph default
+ is more or less useful information filled according to how the command
+ execution worked out.
+ Some commands, such as
+\begin_inset Quotes eld
\end_inset
-pt (this is the default), the rule is suppressed.
- In the following example the rule is 2
-\begin_inset space \thinspace{}
+font-state
+\begin_inset Quotes erd
\end_inset
-pt wide:
+, will return information about the internal state of \SpecialChar LyX
+, while other will
+ return an empty data-response.
+ This means that the command execution went fine.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+In case of errors, the response from \SpecialChar LyX
+ will have this form
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
+\end_layout
+\begin_layout Standard
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
-\backslash
-setlength{
-\backslash
-columnseprule}{2pt}
+\begin_layout Standard
+Examples:
\end_layout
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_inset Newline newline
\end_inset
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
+\end_inset
+
+echo $a
+\end_layout
+
+\begin_layout Subsection
+AppleScript (Mac OS X)
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+Since \SpecialChar LyX
+ 2.1, \SpecialChar LyX
+ supports basic interactions with AppleScript for normal communicatio
+n through the command run.
+ This command takes a direct argument (the
+\series bold
+function
+\series default
+ to perform) and an optional argument.
+ It either returns the output of the function or triggers an error with
+ the error message and code.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Example:
+\end_layout
-\size small
+\begin_layout LyX-Code
+tell application "\SpecialChar LyX
+"
+\end_layout
+
+\begin_layout LyX-Code
+ try
+\end_layout
+
+\begin_layout LyX-Code
+ -- Stores the current file name into f
+\end_layout
+
+\begin_layout LyX-Code
+ set f to (run "server-get-filename" with argument "")
+\end_layout
+
+\begin_layout LyX-Code
+ on error the error_message number the error_number
+\end_layout
+
+\begin_layout LyX-Code
+ display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
+
+\begin_layout LyX-Code
+ & the error_message buttons {"OK"} default button 1
+\end_layout
+
+\begin_layout LyX-Code
+ end try
+\end_layout
+
+\begin_layout LyX-Code
+end tell
+\end_layout
+
+\begin_layout Section
+Notification
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ can notify clients of events going on asynchronously.
+ Currently it will only do this if the user binds a key sequence with the
+ function
\begin_inset Quotes eld
\end_inset
-You're surprised to see me, sir,
+notify
\begin_inset Quotes erd
\end_inset
- said he, in a strange, croaking voice.
+.
+ The format of the string \SpecialChar LyX
+ sends is as follows:
\end_layout
+\begin_layout Quote
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
+NOTIFY:
+\end_layout
-\size small
-I acknowledged that I was.
+\end_inset
+
+
+\emph on
+key-sequence
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+where
+\emph on
+key-sequence
+\emph default
+ is the printed representation of the key sequence that was actually typed
+ by the user.
+\end_layout
-\size small
+\begin_layout Standard
+This mechanism can be used to extend \SpecialChar LyX
+'s command set and implement macros.
+ Bind some key sequence to
\begin_inset Quotes eld
\end_inset
-Well, I've a conscience, sir, and when I chanced to see you go into this
- house, as I came hobbling after you, I thought to myself, I'll just step
- in and see that kind gentleman, and tell him that if I was a bit gruff
- in my manner there was not any harm meant, and that I am much obliged to
- him for picking up my books.
+notify
\begin_inset Quotes erd
\end_inset
+.
+ Then start a client that listens on the output pipe, dispatches the command
+ according to the sequence, and starts a function that may use \SpecialChar LyX
+ calls and
+ \SpecialChar LyX
+ requests to issue a command or a series of commands to \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Section
+The simple \SpecialChar LyX
+ Server Protocol
+\end_layout
+\begin_layout Standard
+\SpecialChar LyX
+ implements a simple protocol that can be used for session management.
+ All messages are of the form
\end_layout
-\begin_layout Plain Layout
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
+\end_layout
-\size small
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
\begin_inset Quotes eld
\end_inset
-You make too much of a trifle,
+hello
\begin_inset Quotes erd
\end_inset
- said I.
-
+ or
\begin_inset Quotes eld
\end_inset
-May I ask how you knew who I was?
+bye
\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Plain Layout
-
-\size small
+.
+ If
\begin_inset Quotes eld
\end_inset
-Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
- you'll find my little bookshop at the corner of Church Street, and very
- happy to see you, I am sure.
- Maybe you collect yourself, sir.
- Here's
-\noun on
-British
-\begin_inset space ~
+hello
+\begin_inset Quotes erd
\end_inset
-Birds
-\noun default
-, and
-\noun on
-Catullus
-\noun default
-, and
-\noun on
-The Holy War
-\noun default
-–a bargain, every one of them.
- With five volumes you could just fill that gap on that second shelf.
- It looks untidy, does it not, sir?
+ is received from a client, \SpecialChar LyX
+ will report back to inform the client that
+ it's listening to it's messages, while
+\begin_inset Quotes eld
+\end_inset
+
+bye
\begin_inset Quotes erd
\end_inset
+ sent from \SpecialChar LyX
+ will inform clients that \SpecialChar LyX
+ is closing.
+\end_layout
+\begin_layout Section
+Reverse DVI/PDF search
+\end_layout
+
+\begin_layout Standard
+Some DVI/PDF viewers
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
\end_inset
+ provide
+\emph on
+reverse search
+\emph default
+ facility (also called
+\emph on
+inverse search
+\emph default
+).
+ This means that you can tell \SpecialChar LyX
+ to put the cursor to a specific line in the
+ document by clicking at the respective position in the DVI/PDF output.
+ To achieve this, the viewer must be able to communicate with \SpecialChar LyX
+.
+ This is done via the \SpecialChar LyX
+ server either by using the named pipe (
+\emph on
+lyxpipe
+\emph default
+), or the UNIX domain socket (
+\emph on
+lyxsocket
+\emph default
+) that \SpecialChar LyX
+ creates in its temporary directory (this is the way the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Standard
-\begin_inset VSpace defskip
\end_inset
-
+ program communicates with \SpecialChar LyX
+).
+ In some cases, you need a helper script that mediates between the viewer
+ and \SpecialChar LyX
+, in others, the viewer can communicate with \SpecialChar LyX
+ directly.
+ This depends on the selected viewer and on your operating system.
+ The same applies to the way viewers need to be configured and the way the
+ reverse search is actually performed.
+ In what follows, we will thus describe how to setup reverse search for
+ specific viewers.
+ Before we turn to this, though, we will explain what needs to be done generally
+ to enable reverse search in the DVI/PDF output.
\end_layout
-\begin_layout Standard
-The rule can be colored by redefining the command
-\series bold
+\begin_layout Subsection
+Automatic setup
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:rev-search"
-\backslash
-columnseprulecolor
-\series default
-.
- This is done by inserting the command
-\begin_inset Newline newline
\end_inset
-\series bold
+\end_layout
-\backslash
-renewcommand{
-\backslash
-columnseprulecolor}{
-\backslash
-color{red}}
-\series default
+\begin_layout Standard
+In most cases \SpecialChar LyX
+ will do the work for you by enabling the option
+\begin_inset Flex Noun
+status collapsed
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+Synchronize with Output
+\end_layout
-as \SpecialChar TeX
- Code before the multicolumn inset.
- Replace
-\series bold
-red
-\series default
- in this command by a color of your choice.
- You can use all pre- and self-defined colors.
- See the
-\emph on
-EmbeddedObjects
-\emph default
- manual, section
-\emph on
-Colored
-\begin_inset space ~
\end_inset
-Tables
-\emph default
- for more information about pre- and self-defined colors.
- To go back to the default color insert the command
-\begin_inset Newline newline
-\end_inset
+ in the menu
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output
+\end_layout
-\series bold
+\end_inset
-\backslash
-renewcommand{
-\backslash
-columnseprulecolor}{
-\backslash
-normalcolor}
-\series default
+.
+ In such a case \SpecialChar LyX
+ will automatically insert the necessary Sync\SpecialChar TeX
+ 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_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+View/Update
+\end_layout
-Here is the example with a cyan rule and 1
-\begin_inset space \thinspace{}
\end_inset
-cm column separation:
+ Toolbar.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+Synchronize with Output
+\end_layout
+\end_inset
-\backslash
-setlength{
-\backslash
-columnsep}{1cm}
+.
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Note that the method
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
\backslash
-renewcommand{
-\backslash
-columnseprulecolor}{
-\backslash
-color{cyan}}
+synctex=1
\end_layout
\end_inset
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\backslash
+synctex=-1
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
+Please also note that including the
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+srcltx
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
-You're surprised to see me, sir,
-\begin_inset Quotes erd
-\end_inset
+ package or
+\begin_inset Flex Code
+status collapsed
- said he, in a strange, croaking voice.
+\begin_layout Plain Layout
+src-specials
\end_layout
-\begin_layout Plain Layout
+\end_inset
-\size small
-I acknowledged that I was.
-\end_layout
+ 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
\begin_layout Plain Layout
+srcltx
+\end_layout
-\size small
-\begin_inset Quotes eld
-\end_inset
-
-Well, I've a conscience, sir, and when I chanced to see you go into this
- house, as I came hobbling after you, I thought to myself, I'll just step
- in and see that kind gentleman, and tell him that if I was a bit gruff
- in my manner there was not any harm meant, and that I am much obliged to
- him for picking up my books.
-\begin_inset Quotes erd
\end_inset
-
-\end_layout
+ package or
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
+src-specials
+\end_layout
-\size small
-\begin_inset Quotes eld
-\end_inset
-
-You make too much of a trifle,
-\begin_inset Quotes erd
\end_inset
- said I.
+.
-\begin_inset Quotes eld
+\end_layout
+
+\begin_layout Standard
+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
-May I ask how you knew who I was?
-\begin_inset Quotes erd
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec: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 setup
\end_layout
+\begin_layout Standard
+\SpecialChar LaTeX
+ provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
+latex/pdflatex
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
-Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
- you'll find my little bookshop at the corner of Church Street, and very
- happy to see you, I am sure.
- Maybe you collect yourself, sir.
- Here's
-\noun on
-British
-\begin_inset space ~
-\end_inset
+ program, some are provided by external packages.
+ Your choice depends on whether your \SpecialChar LaTeX
+ distribution already provides a given
+ method (the built-in methods are rather new) and whether your viewer can
+ cope with it.
+ The available methods are described in the following.
+\end_layout
+
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
+\end_layout
+
+\begin_layout Standard
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in \SpecialChar LaTeX
+ since quite some time (any somewhat recent \SpecialChar LaTeX
+ distribution
+ should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain)->DVI
+\end_layout
-Birds
-\noun default
-, and
-\noun on
-Catullus
-\noun default
-, and
-\noun on
-The Holy War
-\noun default
-–a bargain, every one of them.
- With five volumes you could just fill that gap on that second shelf.
- It looks untidy, does it not, sir?
-\begin_inset Quotes erd
\end_inset
+ or
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain)->DraftDVI
\end_layout
\end_inset
+ converter in
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
\end_layout
-\begin_layout Standard
-\begin_inset ERT
+\end_inset
+
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+latex -src-specials $$i
+\end_layout
+\end_inset
-\backslash
-setlength{
-\backslash
-columnseprule}{0pt}
+.
+ If this doesn't work, check if your \SpecialChar TeX
+ engine needs different options (the
+ syntax might differ in some distributions).
\end_layout
-\begin_layout Plain Layout
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
+\end_layout
+\begin_layout Standard
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the \SpecialChar LyX
+ preamble:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
-renewcommand{
-\backslash
-columnseprulecolor}{
-\backslash
-normalcolor}
+usepackage{pdfsync}
\end_layout
\end_inset
+ for reverse PDF search,
+\end_layout
-\begin_inset Note Note
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-go back to the default
+
+\backslash
+usepackage[active]{srcltx}
\end_layout
\end_inset
-
+ for reverse DVI search.
\end_layout
-\begin_layout Section
-Non-standard Paragraph Shapes
+\begin_layout Standard
+If you want to be able to perform both DVI and PDF reverse searches, you
+ can also insert in the preamble the following lines
\end_layout
-\begin_layout Standard
-\noindent
-\SpecialChar LaTeX
- as well as any other text processor uses by default rectangular paragraphs.
- For special cases like for example posters, invitation cards or poems you
- can modify the paragraph shape to one of your choice.
- This can be done by using the \SpecialChar LaTeX
--package
-\series bold
-shapepar
-\series default
- which is loaded by using in the document settings the module
-\family sans
-Custom paragraph shapes
-\family default
-.
+\begin_layout LyX-Code
+
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+ifpdf
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+else
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+fi
\end_layout
-\begin_layout Subsection
-Predefined shapes
+\begin_layout Standard
+This way, you can preview the file as either DVI or PDF (pdflatex) and the
+ right package will be used.
\end_layout
\begin_layout Standard
+Note that PDFSync might affect the output layout of your document.
+ It is therefore advised to disable PDFsync for final documents.
+\end_layout
-\series bold
-shapepar
-\series default
- provides the following shapes:
+\begin_layout Subsubsection*
+Built-in reverse search via Sync\SpecialChar TeX
+ (DVI and PDF)
\end_layout
\begin_layout Standard
-\begin_inset Tabular
-<lyxtabular version="3" rows="13" columns="3">
-<features booktabs="true" islongtable="true" longtabularalignment="center">
-<column alignment="center" valignment="middle" width="16col%">
-<column alignment="center" valignment="middle" width="40col%">
-<column alignment="center" valignment="middle" width="35col%">
-<row endhead="true">
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
+Recent versions of
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Name
+(pdf)latex
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
+
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+Sync\SpecialChar TeX
+
+\emph default
+ facility is basically the result of the integration of the PDFSync package
+ to the pdftex program and its merge with the
+\emph on
+scr-specials
+\emph default
+ approach.
+ You need at least \SpecialChar TeX
+Live 2008 or a recent Mik\SpecialChar TeX
+ distribution in order to use
+ it.
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
-Description
+For some reason, Mik\SpecialChar TeX
+ does not understand/obey the command \SpecialChar LyX
+ inserts into
+ the preamble when you check the "Enable Forward/Reverse Search" button
+ in the toolbar and does not generate the necessary info.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Plain Layout
-Annotation
+The generation of the required info can be forced by changing the converter
+ "\SpecialChar LaTeX
+ (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
+ from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
+ the -synctex=1 switch).
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
+ on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
+ support.
+\end_layout
+
+\begin_layout Standard
+To enable Sync\SpecialChar TeX
+ for DVI output, change the
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-CDlabel
+La
+\family sans
+TeX
+\family default
+ (plain) -> DVI
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ or
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Circle with circular hole (in the size of a CD/DVD)
+La
+\family sans
+TeX
+\family default
+ (plain) -> DraftDVI
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+ converter in
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Cannot be scaled, take care there is not too much text
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+ to
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Circle
+latex -synctex=1 $$i
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+, and for PDF output, change the
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Circle
+La
+\family sans
+TeX
+\family default
+ (pdflatex) -> PDF (pdflatex)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+ or converter to
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Fragile, calculation might fail
+pdflatex -synctex=1 $$i
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+.
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with Sync\SpecialChar TeX
+.
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
-Diamond
+Note that the option
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-synctex=1
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Rhomboid (symbolizing a
-\begin_inset Quotes eld
-\end_inset
+-synctex=-1
+\end_layout
-diamond
-\begin_inset Quotes erd
\end_inset
-)
+.
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
--
+
\end_layout
+\begin_layout Subsection
+Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:configuring-viewers"
+
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+
+\end_layout
+
+\begin_layout Subsubsection*
+Xdvi (all platforms)
+\end_layout
+
+\begin_layout Standard
+If you use
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Heart
+xdvi
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+, you don't need to do anything else for performing a reverse DVI search,
+ as \SpecialChar LyX
+ already provides the necessary hooks for automatically using the
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Heart-like shape
+lyxclient
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+ program.
+ Just setup your document as described above (reverse search is triggered
+ by Ctrl-click or Alt-click on Mac OSX, respectively).
+\end_layout
+
+\begin_layout Standard
+However, if for whatever reason you want to use the named pipe instead of
+ the socket for communicating with \SpecialChar LyX
+, simply change the DVI viewer in
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
--
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ to
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
-Hexagon
+On Mac OSX you have to use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-Hexagon
+
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
--
+xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+, where
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Nut
+lyxeditor.sh
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-Nut for bolt (hexagon with circular hole)
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
+
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
+\end_inset
+
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
+\end_inset
+
+read TMP < "${LYXPIPE}".out || exit
+\end_layout
+
+\begin_layout Standard
+where
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
--
+/path/to/lyxpipe
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ is the Ly
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
-Square
+
+{}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+XServer pipe path specified in
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Square
+Preferences\SpecialChar menuseparator
+Paths
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+.
+\begin_inset Foot
+status collapsed
\begin_layout Plain Layout
--
+In the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/tools
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
+
+ folder of a source distribution you can find a
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Star
+lyxeditor
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-Five-point star
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+
+\end_layout
+
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
+\end_layout
+
+\begin_layout Standard
+At the end of
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
--
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+, add the following lines:
+\end_layout
+
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
-Candle
+
+{}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
+
+exit 1
+\end_layout
+
+\begin_layout Standard
+Modify the lines accordingly if you install \SpecialChar LyX
+ somewhere else than in the
+ Applications folder.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by Alt-click (OPTION-click).
+\end_layout
+
+\begin_layout Subsubsection*
+Skim (Mac OSX)
+\end_layout
+
+\begin_layout Standard
+Enter
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Burning candle
+open -a Skim.app $$i
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+ to the viewer setting in
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
--
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
+PDF (pdflatex)
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+, and then in
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Drop down/up
+Skim\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Sync
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+
+ choose
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Normal/reversed rain drop
+custom
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+ preset and enter command
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Fragile, calculation might fail
+/Applications/\SpecialChar LyX
+.app/Contents/MacOS/lyxeditor
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-\SpecialChar TeX
+.
+\end_layout
+\begin_layout Standard
+Reverse search is triggered by COMMAND-SHIFT-click
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
usebox="none">
-\begin_inset Text
+\begin_layout Subsubsection*
+Okular (KDE)
+\end_layout
+
+\begin_layout Standard
+Go to
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-The \SpecialChar TeX
- logo
+Settings\SpecialChar menuseparator
+Configure Okular\SpecialChar menuseparator
+Editor
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" \
rightline="true" usebox="none">
-\begin_inset Text
+
+, select
+\begin_inset Quotes eld
+\end_inset
+
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
+
+ and add the command
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
--
+lyxclient -g %f %l
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
+
+.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by SHIFT-click.
+\end_layout
+
+\begin_layout Subsubsection*
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+Qpdfview supports Sync\SpecialChar TeX
+ since version 0.3.5.
+ Go to
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-Triangle up/down/
-\begin_inset Newline newline
+Edit\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Behavior
+\end_layout
+
\end_inset
-left/right
-\end_layout
+, click on the input field of the
+\begin_inset Quotes eld
+\end_inset
+Source editor
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" usebox="none">
-\begin_inset Text
+
+ item and add the command
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Triangles in different orientations
+lyxclient -g %1 %2
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" \
leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
+
+\begin_layout Subsubsection*
+YAP (Windows)
+\end_layout
+
+\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
--
+View\SpecialChar menuseparator
+Options
\end_layout
\end_inset
-</cell>
-</row>
-</lyxtabular>
+ menu and select the
+\begin_inset Quotes eld
\end_inset
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-To use a shape for your paragraph, simply select it in \SpecialChar LyX
-'s pull-down box
- for environments in the toolbar.
+New\SpecialChar ldots
+
+\begin_inset Quotes erd
+\end_inset
+
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
+
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
+
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
+
+Name:
+\begin_inset Quotes erd
+\end_inset
+
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
+
+\SpecialChar ldots
+
+\begin_inset Quotes erd
+\end_inset
+
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset Newpage newpage
\end_inset
+ (see below).
+ Select
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-Here is an example paragraph in the shape of a nut:
+\end_inset
+
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%f %l
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+.
+ The
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Nut
+\end_inset
-\lang latin
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
+ wrapper is used for communicating with \SpecialChar LyX
+ through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
+\end_inset
+
+echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
\end_inset
+type
+\backslash
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.out
\end_layout
\begin_layout Standard
-\begin_inset Note Greyedout
-status open
+Make sure that the \SpecialChar LyX
+Server pipe path you specified in \SpecialChar LyX
+ is
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\series bold
-Note
-\series default
-: shapepar paragraphs cannot run over a page break.
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\end_layout
\end_inset
+, otherwise change the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
-
+ wrapper accordingly.
\end_layout
\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\series bold
-shapepar
-\series default
- takes care that the shape will always be preserved, no matter how much
- text is in the paragraph.
- Therefore the paragraph size changes with the amount of contained text.
- This can lead to paragraph sizes exceeding the page margins.
- To demonstrate the size scaling, here is the same example paragraph but
- with twice as much text:
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
\begin_layout Standard
-\begin_inset Newpage newpage
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat %f %l"
+\end_layout
+
\end_inset
+ in the viewer setting in
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Nut
+\end_inset
-\lang latin
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+ is the previous wrapper.
+ If SumatraPDF.exe is not in your command PATH, use its full file name.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
\begin_layout Standard
-An exception is the shape
-\family sans
-CDlabel
-\family default
-.
- It cannot be scaled because it must fit the size of a CD/DVD.
- Therefore the amount of text that fits into the shape is limited.
-\begin_inset Newline newline
+First of all, make sure that yap is your default DVI viewer in the Windows
+ environment, then launch it, choose its
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+View\SpecialChar menuseparator
+Options
+\end_layout
+
\end_inset
-The
-\family sans
-drop
-\family default
- shapes and the
-\family sans
-circle
-\family default
- shape are fragile, meaning that the calculation of their size can fail,
- depending on the amount of text.
- You will then get the \SpecialChar LaTeX
- error
+ menu and select the
\begin_inset Quotes eld
\end_inset
-Arithmetic overflow
+Inverse DVI Search
\begin_inset Quotes erd
\end_inset
-.
- In this case one can try to remove or add some text; if nothing works one
- has to use another shape.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
+ tab.
+ Click on the
+\begin_inset Quotes eld
\end_inset
+New\SpecialChar ldots
-\end_layout
-
-\begin_layout Standard
-For shapes with tips you will maybe see that \SpecialChar LaTeX
-'s hyphenation routine fails
- for text in the tips.
- Therefore it is often necessary to add hyphenation points
-\family sans
-(
-\begin_inset Info
-type "shortcut"
-arg "specialchar-insert hyphenation"
+\begin_inset Quotes erd
\end_inset
-
-\family default
-) to the corresponding text parts.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
\end_inset
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Shapepar paragraphs are either always centered or placed on the page so
- that their left border touches the left page margin.
- You can therefore not use the paragraph dialog to align such paragraphs.
- A solution is to put the paragraph into a minipage or parbox and align
- the box.
- The problem is hereby to find the right width for the box.
- Because if it is too wide and you center the box, the paragraph is not
- centered too because it sticks at the left side of the box.
- So you might have to play a bit with the width until it fits.
- Here are two heart-shaped paragraphs, the first one is not aligned, the
- second one is right-aligned:
-\end_layout
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\begin_inset Newpage newpage
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
\end_inset
+\SpecialChar ldots
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Heart
-\noindent
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\lang latin
-Lo\SpecialChar softhyphen
-rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+ program (which is installed by default on Cygwin along with the \SpecialChar LyX
+ executable).
+ Select
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Standard
-\noindent
-\align right
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 1
-use_makebox 0
-width "42col%"
-special "none"
-height "1in"
-height_special "totalheight"
-thickness "0.4pt"
-separation "3pt"
-shadowsize "4pt"
-framecolor "black"
-backgroundcolor "none"
-status open
+\end_inset
-\begin_layout Heart
-\noindent
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\lang latin
-Lo\SpecialChar softhyphen
-rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
+\begin_layout Plain Layout
+-g %f %l
\end_layout
\end_inset
+.
+ In this way, you will be using the
+\emph on
+lyxsocket
+\emph default
+ for communicating with \SpecialChar LyX
+.
+ If, for whatever reason, you want to use the
+\emph on
+lyxpipe
+\emph default
+, omit the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Subsection
-Custom shapes
+\end_inset
+
+ option and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Standard
-You can define any shape you want.
- Doing this manually is a lot of work because every coordinate must be specified.
- But there is a way to let the computer calculate the coordinates:
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Enumerate
-Install the program
-\begin_inset CommandInset href
-LatexCommand href
-name "Jpgfdraw"
-target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\end_inset
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
-\begin_layout Enumerate
-In
-\family sans
-Jpgfdraw
-\family default
- go to the menu
-\family sans
-TeX/LaTeX\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Set Normal Size
-\family default
- and select the font size you are using in your document.
- For example this document uses the size 12
-\begin_inset space \thinspace{}
\end_inset
-pt.
-\end_layout
+ in the viewer setting in
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Enumerate
-Draw a shape.
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Enumerate
-Use the menu
-\family sans
-TeX/LaTeX\SpecialChar menuseparator
-Shapepar
-\family default
- to export the shape to coordinates.
- In the appearing dialog use either the outline of your shape for the coordinate
-s or the path itself.
-\begin_inset Foot
+\end_inset
+
+.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-For more information see
-\begin_inset CommandInset href
-LatexCommand href
-target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
+-g
+\end_layout
\end_inset
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
+.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+-g
\end_layout
\end_inset
-
+ option if you want to use the
+\emph on
+lyxpipe
+\emph default
+, and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Standard
-The coordinates are written into a \SpecialChar TeX
- file.
- To use it for your \SpecialChar LyX
- document
+Reverse search is triggered by double-click.
\end_layout
-\begin_layout Enumerate
-Place the cursor before the first character of your paragraph (or into a
- new empty one).
+\begin_layout Section
+Forward search
\end_layout
-\begin_layout Enumerate
-Open in \SpecialChar LyX
- the menu
-\family sans
-Insert\SpecialChar menuseparator
-File\SpecialChar menuseparator
-Child
-\begin_inset space ~
+\begin_layout Standard
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
\end_inset
-Document
-\family default
-, select the file and use
-\family sans
-Input
-\family default
- as
-\family sans
-Include Type.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace defskip
+opposite
+\begin_inset Quotes erd
\end_inset
+ of reverse search.
+ It allows you to let the viewer jump to a given position from within \SpecialChar \
LyX +.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your \SpecialChar LyX
+ document, and hit
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Navigate\SpecialChar menuseparator
+Forward search
\end_layout
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
+\end_inset
-\begin_layout Plain Layout
+ (or select
+\begin_inset Flex Noun
+status collapsed
-\series bold
-Note
-\series default
-: The changed shape only applies to the current paragraph; everything is
- reset to normal for the next paragraph.
- Therefore the shape definition file must be input into every paragraph
- with the desired shape.
+\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
-\begin_inset VSpace bigskip
-\end_inset
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the \SpecialChar TeX
+ sources.
+ This can be done via the methods described in the section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:rev-search"
+\end_inset
+.
\end_layout
\begin_layout Standard
-Here is an example:
+Additionally, you need to configure \SpecialChar LyX
+ for using your viewers in
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+General
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
-
+.
+ 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 Standard
-\begin_inset CommandInset include
-LatexCommand input
-filename "SpecialParagraphShape.tex"
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
+\end_layout
\end_inset
+: row number
+\end_layout
-\lang latin
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
- At vero eos et accusam et justo duo dolores et ea rebum.
- Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
- sit amet.
- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
- eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
- voluptua.
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
-
+: name of the (temporary) exported .tex file (without path)
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\series bold
-A tip:
-\series default
- to draw complexer shapes in
-\family sans
-Jpgfdraw
-\family default
- you can draw the shape in a program of your choice and import the resulting
- image to
-\family sans
-Jpgfdraw
-\family default
-.
- Then you only need to draw a line or spline along the outline of the image.
+\begin_layout Plain Layout
+$$f
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+: name of the (temporary) exported .tex file (including path)
+\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
-The module
-\family sans
-Custom paragraph shapes
-\family default
- also provides the two commands
-\family sans
-shapepar
-\family default
- and
-\family sans
-Shapepar
-\family default
- which can be used to define custom shapes coordinate by coordinate.
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-These commands are internally used for all shapes described here.
+You might want to set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+okular –unique
\end_layout
\end_inset
- For information how these styles are used and about further customization
- possibilities, have a look at the documentation of the package
-\series bold
-shapepar
-\series default
-,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "shapepar"
+ in
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File
+\begin_inset space ~
\end_inset
-.
+Formats
\end_layout
-\begin_layout Bibliography
-\begin_inset CommandInset bibitem
-LatexCommand bibitem
-key "multicol"
+\end_inset
+
+
+\end_layout
\end_inset
-Documentation of the \SpecialChar LaTeX
--package
+, qpdfview and SumatraPDF
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF can also use DDE commands through the external program CMCDDE
+ — downloadable from
\begin_inset CommandInset href
LatexCommand href
-name "multicol"
-target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
+target "http://www.istri.fr/spip/zip/CMCDDE.zip"
\end_inset
\end_layout
-\begin_layout Bibliography
-\begin_inset CommandInset bibitem
-LatexCommand bibitem
-key "shapepar"
+\end_inset
+.
+ 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
-Documentation of the \SpecialChar LaTeX
--package
-\begin_inset CommandInset href
-LatexCommand href
-name "shapepar"
-target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
+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
+.
+ This 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.
+ \SpecialChar 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
\end_body
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic