).
\end_layout
-\begin_layout Section
-
-\change_inserted 564990737 1670439605
-Curricula vitarum
-\end_layout
-
-\begin_layout Section
-
-\change_inserted 564990737 1670439627
-Letters
-\end_layout
-
-\begin_layout Section
-
-\change_inserted 564990737 1670439660
-Presentations
+\begin_layout Subsection
+Memoir
\end_layout
-\begin_layout Section
-
-\change_inserted 564990737 1670439661
-Reports
+\begin_layout Standard
+By
+\noun on
+Jürgen Spitzmüller
\end_layout
-\begin_layout Subsection
-
-\change_inserted 564990737 1670439661
-report
+\begin_layout Subsubsection
+Overview
\end_layout
\begin_layout Standard
-
-\change_inserted 564990737 1670439661
-The document class
-\family sans
-report
-\family default
- provides the
-\family sans
-report.cls
-\family default
- document class for preparing reports.
- Like the
-\family sans
-book
-\family default
- document class, this provides parts, chapters and sections but does not
- provide the paragraph styles needed for a book; like the
-\family sans
-article
-\family default
- document class, it provides the abstract paragraph style.
- In two-sided mode, it does not start a new chapter on the right hand page.
+Memoir is a very powerful and constantly evolving class.
+ It has been designed with regard to fictional and non-fictional literature.
+ Its aim is to let the user have maximum control over the typesetting of
+ his document.
+ Memoir is based on the standard book class, but it can also emulate the
+ article class (see below).
\end_layout
\begin_layout Standard
+Peter Wilson, the developer of Memoir, is known as the author of lots of
+ useful packages in the \SpecialChar LaTeX
+ world.
+ Most of them have been merged with Memoir.
+ Therefore, it is much easier to layout the table of contents, appendices,
+ chapter designs and such.
+ \SpecialChar LyX
+, though, does not support all of these goodies natively.
+ Some of them might be added to forthcoming releases
+\begin_inset Foot
+status collapsed
-\change_inserted 564990737 1670439674
-The remaining
-\family sans
-report
-\family default
- document classes are described in the Collections (section
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+You are invited to send suggestions to
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Collections"
+lyx-devel@lists.lyx.org
+\end_layout
\end_inset
-).
+.
\end_layout
-\begin_layout Section
+\end_inset
-\change_inserted 564990737 1670439674
-Scripts (drama)
-\end_layout
+, lots will probably never be supported, due to the limitations of \SpecialChar LyX
+'s framework.
+ Of course you can still use all features with the help of some native \SpecialChar LaTeX
-\begin_layout Chapter
-Supplemental Tools
-\end_layout
+ commands (\SpecialChar TeX
+ code
+\begin_inset Foot
+status collapsed
-\begin_layout Section
-Customizing Bibliographies with Bib\SpecialChar TeX
- or Biblatex
-\end_layout
+\begin_layout Plain Layout
+Cf.
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
-The most basic information about how to use Bib\SpecialChar TeX
- or
-\family sans
-Biblatex
-\family default
- with \SpecialChar LyX
- is contained in the section
-\emph on
-Bibliography databases
-\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 Plain 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
+\backslash
+
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-
-\begin_inset Quotes eld
+section
+\begin_inset space ~
\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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
-g.
-\begin_inset space \space{}
\end_inset
+ for details.
+\end_layout
-\begin_inset Quotes eld
-\end_inset
-
-Knuth 1984a
-\begin_inset Quotes erd
\end_inset
).
- \SpecialChar LyX
- supports three packages that provide this style,
-\begin_inset Flex Code
+ In this section, we can only list those features that are natively supported
+ by \SpecialChar LyX
+.
+ For detailed descriptions (and for the rest of features) we recommend you
+ have a look at the detailed manual of the Memoir class
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-biblatex
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
+Cf.
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-natbib
+
+
+\backslash
+
\end_layout
\end_inset
-, and
-\begin_inset Flex Code
+
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-jurabib
+
+CTAN:/macros/latex/memoir/memman.pdf
\end_layout
\end_inset
.
- Each of these packages has 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
+, which is not only a user guide for the class, but also both a comprehensive
+ description on good typesetting and a superb example for good typesetting
+ itself.
\end_layout
-\end_inset
-
- package is probably your choice.
- If you look for specific citation styles common in law studies, you might
- consider the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Subsubsection
+Basic features and restrictions
+\end_layout
-\begin_layout Plain Layout
-jurabib
+\begin_layout Standard
+Memoir supports basically all features of the standard book classes.
+ There are, however, some differences, as follows:
\end_layout
+\begin_layout Description
+Font
+\begin_inset space ~
\end_inset
- package.
- If you want to have full control over the formatting or look for advanced
- features such as ibidem, footnote citations, full title citations, advanced
- date formats (such as 400 BC) or full localization to other languages than
- English, you should definitely consider
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-biblatex
+sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
\end_layout
+\begin_layout Description
+Page
+\begin_inset space ~
\end_inset
-, which exceeds all other packages in terms of features, but is also quite
- heavy and more resource-hungry.
-\end_layout
-
-\begin_layout Standard
-The handling of these packages in \SpecialChar LyX
- is basically the same.
- Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
+style: The fancy page style is not supported, due to a command clash between
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses \SpecialChar LaTeX
+).
+ Instead, Memoir comes with a number of its own page styles (see
+\family sans
Document\SpecialChar menuseparator
-Settings
-\end_layout
-
+Settings\SpecialChar menuseparator
+Page
+\begin_inset space ~
\end_inset
- and select under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bibliography
-\end_layout
+Style
+\family default
+).
+ If you want to use these for the chapter pages, you have to use the command
+
+\family typewriter
+\backslash
+chapterstyle
+\family default
+ in the main text or in preamble (e.
+\begin_inset space \thinspace{}
\end_inset
- the
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Style Format
-\end_layout
-
+g.
+\begin_inset space \space{}
\end_inset
-
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Basic (BibTeX)
-\end_layout
-
-\end_inset
-,
-\begin_inset Flex Noun
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Biblatex
+\backslash
+chapterstyle{companion}
+\family default
+).
\end_layout
+\begin_layout Description
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
+ With this, you can specify an alternative version of the title for the
+ table of contents and the headers (for instance, if the title is too long).
+ In \SpecialChar LyX
+, you can do this via
+\family sans
+Insert\SpecialChar menuseparator
+Short
+\begin_inset space ~
\end_inset
-,
-\begin_inset Flex Noun
-status collapsed
+Title
+\family default
+ at the beginning of a chapter/section.
+ Memoir features a second optional argument and thus separates the table
+ of contents from the header.
+ You can define three variants of a title with this: one for the main text,
+ one for the table of contents, and one for the headers.
+ \SpecialChar LyX
+ makes these available in form of specific
+\family sans
+Short Title
+\family default
+ variants in the
+\family sans
+Insert
+\family default
+ menu.
+\end_layout
-\begin_layout Plain Layout
-Biblatex (Natbib mode)
+\begin_layout Description
+TOC/LOT/LOF: In the standard classes (and in many other classes), the table
+ of contents, the list of figures and the list of table start a new page
+ automatically.
+ Memoir does not follow this route.
+ You have to insert a page break yourself, if you want to have one.
\end_layout
+\begin_layout Description
+Titlepage: For some unknown reason, Memoir uses pagination on the title
+ page (in the standard classes, title pages are
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Natbib (BibTeX)
-\end_layout
-
+empty
+\begin_inset Quotes erd
\end_inset
- or
-\begin_inset Flex Noun
-status collapsed
+).
+ If you want an empty title page, type
+\family typewriter
-\begin_layout Plain Layout
-Jurabib (BibTeX)
+\backslash
+aliaspagestyle{title}{empty}
+\family default
+ in the preamble.
\end_layout
-\end_inset
-
- (see sec.
+\begin_layout Description
+Article: With the class option
+\emph on
+article
+\emph default
+ (to be inserted in
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Class Settings\SpecialChar menuseparator
+Custom
\begin_inset space ~
\end_inset
-6.5.3 in the User's Guide for more information on these choices).
- With all these packages, you will get some extra features in the citation
- dialog and you can select the style of the reference (
+Options
+\family default
+), you can emulate article style.
+ That is, counters (footnotes, figures, tables etc.) will not be reset on
+ new chapters, chapters don't start a new page (but are—in contrary to
\begin_inset Quotes eld
\end_inset
-Knuth 1984
+real
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+ article classes—still allowed), parts, though, use their own page, as in
+ book.
+\end_layout
-Knuth (1984)
-\begin_inset Quotes erd
+\begin_layout Description
+Oldfontcommands: By default, Memoir does not allow the use of the deprecated
+ font commands, which have been used in the old \SpecialChar LaTeX
+ version 2.09 (e.
+\begin_inset space \thinspace{}
\end_inset
-,
-\begin_inset Quotes eld
+g.
+\begin_inset space \space{}
\end_inset
-Knuth, 1984
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
+
+\backslash
+rm
+\family default
,
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
-1984
-\begin_inset Quotes erd
-\end_inset
+\backslash
+it
+\family default
+).
+ It produces an error and stops \SpecialChar LaTeX
+ whenever such a command appears.
+ The class option
+\emph on
+oldfontcommands
+\emph default
+ reallows the commands and spits out warnings instead (which does at least
+ not stop \SpecialChar LaTeX
+).
+ Since a lot of packages and particularly Bib\SpecialChar TeX
+ style files are still using
+ those commands, we have decided to use this option by default.
+\end_layout
- etc.).
- Note that either package needs specifically designed style files.
- They all ship their own, but there are lots of additional style files,
- and there is even an interactive style file builder
+\begin_layout Subsubsection
+Extra features
+\end_layout
+
+\begin_layout Standard
+We will only describe the features supported by \SpecialChar LyX
+ (which is not much currently).
+ Please consult the Memoir manual
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-See
-\begin_inset Flex URL
-status open
+Cf.
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
-\end_layout
-
-\end_inset
-
+\backslash
+
\end_layout
\end_inset
- for
-\begin_inset Flex Code
+
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-natbib
+
+CTAN:/macros/latex/memoir/memman.pdf
\end_layout
\end_inset
.
\end_layout
-\begin_layout Subsection
-Subdivided 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
+ for details.
+\end_layout
-.
- 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.
+\begin_layout Description
+Abstract: You may wonder why an abstract is an extra feature.
+ Well, it is in book class.
+ Usually books don't have abstracts.
+ Memoir, however, has.
+ You can use it wherever and how often you like.
\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- provides native support for one of these packages,
-\family typewriter
-bibtopic
+\begin_layout Description
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\emph on
+Our hero arrives in Troia; he loses some friends; he finds others
+\emph default
+).
+ Chapterprecis does exactly this.
+ It is therefore only sensible below a chapter.
+\end_layout
+
+\begin_layout Description
+Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
+ The epigraph environment provides an elegant way of typesetting such a
+ motto.
+ The motto itself (text) and its (optional) author (source) are divided
+ by a short line.
+ The author (source) can be inserted via
+\family sans
+Insert\SpecialChar menuseparator
+Epigraph Source
\family default
+\emph on
.
-\begin_inset Foot
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-Available from
-\begin_inset Flex URL
-status open
+\begin_layout Description
+Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
+ complex figurative poems).
+ \SpecialChar LyX
+ can only support a few of them.
+ One is poemtitle, which is a centered title for poems, which will also
+ be added to the table of contents (verse is the standard environment for
+ poems.
+ Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
+ code,
+ because they have to be nested inside regular verse environments, which
+ is not possible with \SpecialChar LyX
+).
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Description
+Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
+\end_layout
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
+\begin_layout Section
+
+\change_inserted 564990737 1670439605
+Curricula vitarum
\end_layout
-\end_inset
+\begin_layout Section
+
+\change_inserted 564990737 1670439627
+Letters
+\end_layout
+
+\begin_layout Section
+
+\change_inserted 564990737 1670439660
+Presentations
+\end_layout
+
+\begin_layout Section
+
+\change_inserted 564990737 1670439661
+Reports
+\end_layout
+
+\begin_layout Subsection
+
+\change_inserted 564990737 1670439661
+report
+\end_layout
+\begin_layout Standard
+\change_inserted 564990737 1670439661
+The document class
+\family sans
+report
+\family default
+ provides the
+\family sans
+report.cls
+\family default
+ document class for preparing reports.
+ Like the
+\family sans
+book
+\family default
+ document class, this provides parts, chapters and sections but does not
+ provide the paragraph styles needed for a book; like the
+\family sans
+article
+\family default
+ document class, it provides the abstract paragraph style.
+ In two-sided mode, it does not start a new chapter on the right hand page.
\end_layout
+\begin_layout Standard
+
+\change_inserted 564990737 1670439674
+The remaining
+\family sans
+report
+\family default
+ document classes are described in the Collections (section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Collections"
+
\end_inset
- The advantage of this package (compared to other packages such as
-\family typewriter
-multibib
+).
+\end_layout
+
+\begin_layout Section
+
+\change_inserted 564990737 1670439674
+Scripts (drama)
+\end_layout
+
+\begin_layout Chapter
+Supplemental Tools
+\end_layout
+
+\begin_layout Section
+Customizing Bibliographies with Bib\SpecialChar TeX
+ or Biblatex
+\end_layout
+
+\begin_layout Standard
+The most basic information about how to use Bib\SpecialChar TeX
+ or
+\family sans
+Biblatex
\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
+ with \SpecialChar LyX
+ is contained in the section
+\emph on
+Bibliography databases
+\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
-Sources
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
- and
+
\begin_inset Quotes eld
\end_inset
-Scientific works
+[12]
\begin_inset Quotes erd
\end_inset
-, you first need to create two bibliographic databases, e.
+) 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
\end_inset
+\begin_inset Quotes eld
+\end_inset
+
+Knuth 1984a
+\begin_inset Quotes erd
+\end_inset
+
+).
+ \SpecialChar LyX
+ supports three packages that provide this style,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-sources.bib
+biblatex
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-scientific.bib
+natbib
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Standard
-Go to
-\begin_inset Flex Noun
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
+jurabib
\end_layout
\end_inset
- and check under
-\begin_inset Flex Noun
+.
+ Each of these packages has 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
-Bibliography
+natbib
\end_layout
\end_inset
- the option
-\begin_inset Flex Noun
+, then the established
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Subdivided bibliography
+natbib
\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
+ package is probably your choice.
+ If you look for specific citation styles common in law studies, you might
+ consider the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-sources.bib
+jurabib
\end_layout
\end_inset
- and a second one for the database
+ package.
+ If you want to have full control over the formatting or look for advanced
+ features such as ibidem, footnote citations, full title citations, advanced
+ date formats (such as 400 BC) or full localization to other languages than
+ English, you should definitely consider
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-scientific.bib
+biblatex
\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
+, which exceeds all other packages in terms of features, but is also quite
+ heavy and more resource-hungry.
+\end_layout
-.
- The titles for the sections can be added as ordinary sections or subsections.
- Since
-\begin_inset Flex Code
+\begin_layout Standard
+The handling of these packages in \SpecialChar LyX
+ is basically the same.
+ Go to
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-bibtopic
+Document\SpecialChar menuseparator
+Settings
\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 Standard
-With
-\family sans
-Biblatex
-\family default
-, the procedure is a bit different.
- Since
-\family typewriter
-bibtopic
-\family default
- does not work with
-\family sans
-Biblatex
-\family default
-, the aforementioned
+ and select under
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Subdivided bibliography
+Bibliography
\end_layout
\end_inset
- option is disabled if you use
-\family sans
-Biblatex
-\family default
-.
- However,
-\family sans
-Biblatex
-\family default
- provides its own means to generate subdivided bibliographies.
- You can either add keywords to bibliography entries via the
-\begin_inset Flex Code
+ the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-keywords
+Style Format
\end_layout
\end_inset
- entry option and then filter bibliography sections by keyword (by adding
-\begin_inset Flex Code
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-keyword=mykeyword
+Basic (BibTeX)
\end_layout
\end_inset
- to the
+,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Options
+Biblatex
\end_layout
\end_inset
- field of the dialog that opens if you left-click on the
+,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Biblatex Generated Bibliography
+Biblatex (Natbib mode)
\end_layout
\end_inset
- button), or you can filter by entry types (such as
-\emph on
-book
-\emph default
- or
-\emph on
-article
-\emph default
-) by entering e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-type=book
+Natbib (BibTeX)
\end_layout
\end_inset
or
-\begin_inset Flex Code
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-nottype=collection
+Jurabib (BibTeX)
\end_layout
\end_inset
- to the mentioned
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Options
-\end_layout
-
+ (see sec.
+\begin_inset space ~
\end_inset
- field, or you can create so-called
+6.5.3 in the User's Guide for more information on these choices).
+ With all these 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
-Bibliography Categories
+Knuth 1984
\begin_inset Quotes erd
\end_inset
- to which you can assign individual entries.
- Please refer to the Biblatex manual, section
-\emph on
-Subdivided Bibliographies
-\emph default
-, for details.
-\end_layout
-
-\begin_layout Subsection
-Multiple Bibliographies
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Multiple-Bibliographies"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Multiple bibliographies, e.
-\begin_inset space \thinspace{}
+,
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset space \space{}
+Knuth (1984)
+\begin_inset Quotes erd
\end_inset
-a bibliography for each part, chapter, section, subsection or child (sub-documen
-t) of the document, are also supported by \SpecialChar LyX
-.
- In order to enable it, go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Bibliography
-\end_layout
-
+,
+\begin_inset Quotes eld
\end_inset
- and select the relevant unit (e.
-\begin_inset space \thinspace{}
+Knuth, 1984
+\begin_inset Quotes erd
\end_inset
-g.,
+,
\begin_inset Quotes eld
\end_inset
-per section
+1984
\begin_inset Quotes erd
\end_inset
-) in the
-\begin_inset Flex Noun
+ etc.).
+ Note that either package needs specifically designed style files.
+ They all 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
-Multiple Bibliographies
-\end_layout
-
-\end_inset
+See
+\begin_inset Flex URL
+status open
- combo box.
- Then add a Bib(la)\SpecialChar TeX
- bibliography to each unit (e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
-g., section) of your document.
- In the output, a separate bibliography, containing only the references
- done in the current unit is generated.
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
\end_layout
-\begin_layout Standard
-If you use Bib\SpecialChar TeX
-, either the
-\begin_inset Flex Code
-status collapsed
+\end_inset
+
-\begin_layout Plain Layout
-chapterbib
\end_layout
\end_inset
- or the
+ for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bibtopic
+natbib
\end_layout
\end_inset
- package is used to create multiple bibliographies.
- The former package is used if you select
+.
+\end_layout
+
+\begin_layout Subsection
+Subdivided 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
-per child document
+must have
\begin_inset Quotes erd
\end_inset
- and do
-\emph on
-not
-\emph default
- check
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Sectioned Bibliography
+.
+ 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
-\end_inset
-
+\begin_layout Standard
+\SpecialChar LyX
+ provides native support for one of these packages,
+\family typewriter
+bibtopic
+\family default
.
- In all other cases,
-\begin_inset Flex Code
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-bibtopic
+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
- is used.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-An alternative approach, 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 ~
+ The advantage of this package (compared to other packages such as
+\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
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Inserting-TeX-Code"
+ and
+\begin_inset Quotes eld
+\end_inset
+Scientific works
+\begin_inset Quotes erd
\end_inset
-), is to use the
+, 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
-bibunits
+sources.bib
\end_layout
\end_inset
- package.
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+scientific.bib
\end_layout
\end_inset
- If
-\begin_inset Flex Code
+.
+
+\end_layout
+
+\begin_layout Standard
+Go to
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-bibtopic
+Document\SpecialChar menuseparator
+Settings
\end_layout
\end_inset
- is used, \SpecialChar LyX
- encloses the specified units in
-\begin_inset Flex Code
+ and check under
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-bibtopic
+Bibliography
\end_layout
\end_inset
-'s
-\begin_inset Flex Code
+ the option
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{btUnit}
+Subdivided bibliography
\end_layout
\end_inset
- and
+.
+ 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
-
-\backslash
-end{btUnit}
+sources.bib
\end_layout
\end_inset
- in order to create the units.
- Note that this approach has some limitations.
- First, every citation reference has to be inside some
+ and a second one for the database
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-btUnit
+scientific.bib
\end_layout
\end_inset
.
- So citations outside a defined unit (e.
-\begin_inset space \thinspace{}
+ 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
-g., before the first section if you use
+all cited references
+\begin_inset Quotes erd
+\end_inset
+
+ of the specified database(s) (which is the default),
\begin_inset Quotes eld
\end_inset
-by section
+all uncited references
\begin_inset Quotes erd
\end_inset
-) will appear as
+ or even
\begin_inset Quotes eld
\end_inset
-???
+all references
\begin_inset Quotes erd
\end_inset
.
- You can also create your own units by entering
+ 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
-
-\backslash
-begin{btUnit}
+bibtopic
\end_layout
\end_inset
- and
-\begin_inset Flex Code
+ removes the bibliography title, you have to manually re-add that, too (as
+ a chapter* or section*, for instance).
+\end_layout
+
+\begin_layout Standard
+With
+\family sans
+Biblatex
+\family default
+, the procedure is a bit different.
+ Since
+\family typewriter
+bibtopic
+\family default
+ does not work with
+\family sans
+Biblatex
+\family default
+, the aforementioned
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{btUnit}
+Subdivided bibliography
\end_layout
\end_inset
- as \SpecialChar TeX
- code (for instance to work around the mentioned limitation).
- Note, though, that
+ option is disabled if you use
+\family sans
+Biblatex
+\family default
+.
+ However,
+\family sans
+Biblatex
+\family default
+ provides its own means to generate subdivided bibliographies.
+ You can either add keywords to bibliography entries via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-btUnit
+keywords
\end_layout
\end_inset
-s cannot be nested.
- A second limitation is that
+ entry option and then filter bibliography sections by keyword (by adding
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bibtopic
+keyword=mykeyword
\end_layout
\end_inset
- always processes all references of a bibliography database, even if they
- are not cited.
- This can result in odd labels (e.
-\begin_inset space \thinspace{}
+ to the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Options
+\end_layout
+
\end_inset
-g.
-
-\begin_inset Quotes eld
-\end_inset
+ field of the dialog that opens if you left-click on the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Biblatex Generated Bibliography
+\end_layout
-Miller 2014b
-\begin_inset Quotes erd
\end_inset
- if two works of this author from 2014 are in the database, even if only
- one is cited).
-\end_layout
+ button), or you can filter by entry types (such as
+\emph on
+book
+\emph default
+ or
+\emph on
+article
+\emph default
+) by entering e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-If you use
-\family sans
-Biblatex
-\family default
-, the
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-refsection
+type=book
\end_layout
\end_inset
- option is used instead.
- If you need specific units, you can start them with the \SpecialChar TeX
- code
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newrefsection
+nottype=collection
\end_layout
\end_inset
- or
-\begin_inset Flex Code
+ to the mentioned
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newrefsegment
+Options
\end_layout
\end_inset
-, respectively.
- If you also want to control the end of the unit, use the environment
-\begin_inset Flex Code
-status collapsed
+ field, or you can create so-called
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+Bibliography Categories
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{refsection}
+ to which you can assign individual entries.
+ Please refer to the Biblatex manual, section
+\emph on
+Subdivided Bibliographies
+\emph default
+, for details.
\end_layout
-\end_inset
+\begin_layout Subsection
+Multiple Bibliographies
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Multiple-Bibliographies"
- \SpecialChar ldots
-
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-\backslash
-end{refsection}
\end_layout
+\begin_layout Standard
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
\end_inset
- instead.
- Note, though, that
-\begin_inset Flex Code
+a bibliography for each part, chapter, section, subsection or child (sub-documen
+t) of the document, are also supported by \SpecialChar LyX
+.
+ In order to enable it, go to
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-refsection
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
\end_layout
\end_inset
-s cannot be nested.
- In addition to the individual bibliography of the current unit,
-\family sans
-Biblatex
-\family default
- also provides an easy way to output all bibliographies, subsequently, at
- one place (e.
+ and select the relevant unit (e.
\begin_inset space \thinspace{}
\end_inset
-g., at the end of the document).
- Select
+g.,
\begin_inset Quotes eld
\end_inset
-all reference units
+per section
\begin_inset Quotes erd
\end_inset
- from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
- this.
- Please refer to the
-\family sans
-Biblatex
-\family default
- manual for more information on this topic.
-\end_layout
-
-\begin_layout Section
-Multipart Documents
-\end_layout
+) in the
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Subsection
-General Operation
+\begin_layout Plain Layout
+Multiple Bibliographies
\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.
+ combo box.
+ Then add a Bib(la)\SpecialChar TeX
+ bibliography to each unit (e.
\begin_inset space \thinspace{}
\end_inset
-e.
-\begin_inset space \space{}
-\end_inset
+g., section) of your document.
+ In the output, a separate bibliography, containing only the references
+ done in the current unit is generated.
+\end_layout
-everything up to and including the
+\begin_layout Standard
+If you use Bib\SpecialChar TeX
+, either the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{document}
+chapterbib
\end_layout
\end_inset
- line as well as the
+ or the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{document}
+bibtopic
\end_layout
\end_inset
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
-\end_layout
+ package is used to create multiple bibliographies.
+ The former package is used if you select
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\SpecialChar LyX
- allows you to include files quite easily with
+per child document
+\begin_inset Quotes erd
+\end_inset
+
+ and do
+\emph on
+not
+\emph default
+ check
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar menuseparator
-Child
-\begin_inset space ~
-\end_inset
-
-Document
+Sectioned Bibliography
\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.
-
+ In all other cases,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
\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
+ is used.
+\begin_inset Foot
+status collapsed
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+An alternative approach, if you are willing to use some
+\begin_inset Flex Noun
+status collapsed
-input
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+\SpecialChar TeX
+ Code
+\end_layout
-, and
-\begin_inset Quotes eld
\end_inset
-verbatim
-\begin_inset Quotes erd
+ (see section
+\begin_inset space ~
\end_inset
-.
- The methods
-\begin_inset Quotes eld
-\end_inset
-include
-\begin_inset Quotes erd
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
- and
-\begin_inset Quotes eld
\end_inset
-input
-\begin_inset Quotes erd
-\end_inset
+), is to use the
+\begin_inset Flex Code
+status collapsed
- are similar in many ways, but there are also some notable differences:
+\begin_layout Plain Layout
+bibunits
\end_layout
-\begin_layout Enumerate
-Files that are
-\begin_inset Quotes eld
\end_inset
-included
-\begin_inset Quotes erd
+ package.
+\end_layout
+
\end_inset
- are typeset beginning on a new page, while files that are
-\begin_inset Quotes eld
+ If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
+\end_layout
+
\end_inset
-inputted
-\begin_inset Quotes erd
+ is used, \SpecialChar LyX
+ encloses the specified units in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
+\end_layout
+
\end_inset
- are typeset starting on the current page.
+'s
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{btUnit}
\end_layout
-\begin_layout Enumerate
-\begin_inset Quotes eld
\end_inset
-Included
-\begin_inset Quotes erd
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{btUnit}
+\end_layout
+
\end_inset
- files cannot themselves
-\begin_inset Quotes eld
+ in order to create the units.
+ Note that this approach has some limitations.
+ First, every citation reference has to be inside some
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+btUnit
+\end_layout
+
\end_inset
-include
-\begin_inset Quotes erd
+.
+ So citations outside a defined unit (e.
+\begin_inset space \thinspace{}
\end_inset
- further files (
+g., before the first section if you use
\begin_inset Quotes eld
\end_inset
-grandchilds
+by section
\begin_inset Quotes erd
\end_inset
-).
- With
+) will appear as
\begin_inset Quotes eld
\end_inset
-input
+???
\begin_inset Quotes erd
\end_inset
-, on the other hand, infinite sub-inputting is possible.
+.
+ You can also create your own units by entering
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{btUnit}
\end_layout
-\begin_layout Enumerate
-\begin_inset Quotes eld
\end_inset
-Include
-\begin_inset Quotes erd
-\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
- allow for the output of only selected
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-included
-\begin_inset Quotes erd
-\end_inset
+\backslash
+end{btUnit}
+\end_layout
- files, while maintaining the actual counters (pagination etc.) and references
- (please refer to the section
-\emph on
-Child
-\begin_inset space ~
\end_inset
-Documents
-\emph default
- of the
-\emph on
-Embedded
-\begin_inset space ~
+ as \SpecialChar TeX
+ code (for instance to work around the mentioned limitation).
+ Note, though, that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+btUnit
+\end_layout
+
\end_inset
-Objects
-\emph default
- manual for details).
+s cannot be nested.
+ A second limitation is that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtopic
\end_layout
-\begin_layout Standard
-Hence,
-\begin_inset Quotes eld
\end_inset
-include
-\begin_inset Quotes erd
+ always processes all references of a bibliography database, even if they
+ are not cited.
+ This can result in odd labels (e.
+\begin_inset space \thinspace{}
\end_inset
- is the preferred method for chapters that are outsourced to child documents,
- while
+g.
+
\begin_inset Quotes eld
\end_inset
-input
+Miller 2014b
\begin_inset Quotes erd
\end_inset
- is more suitable for arbitrary file inheritance.
+ if two works of this author from 2014 are in the database, even if only
+ one is cited).
\end_layout
\begin_layout Standard
-A
-\begin_inset Quotes eld
-\end_inset
-
-verbatim
-\begin_inset Quotes erd
-\end_inset
+If you use
+\family sans
+Biblatex
+\family default
+, the
+\begin_inset Flex Code
+status collapsed
- included file allows you to include a file typeset exactly as it appears
- in the file, i.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+refsection
+\end_layout
-e.
-\begin_inset space \space{}
\end_inset
-in
+ option is used instead.
+ If you need specific units, you can start them with the \SpecialChar TeX
+ code
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-verbatim
+
+\backslash
+newrefsection
\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
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Mark
-\begin_inset space ~
-\end_inset
-spaces
-\begin_inset space ~
-\end_inset
+\backslash
+newrefsegment
+\end_layout
-in
-\begin_inset space ~
\end_inset
-output
+, respectively.
+ If you also want to control the end of the unit, use the environment
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{refsection}
\end_layout
\end_inset
- checkbox typesets a mark to unambiguously define the presence of a space.
+ \SpecialChar ldots
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\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 Plain 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]]
+\backslash
+end{refsection}
\end_layout
\end_inset
+ instead.
+ Note, though, that
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+refsection
\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
-If you work with child documents, you might want to have only one main bibliogra
-phy at the end, but still be able to have a selected bibliography for the
- child if you output it on its own.
- Here is how to achieve this.
-\end_layout
-
-\begin_layout Standard
-For the main document, you just insert a bibliography inset at the place
- where the main bibliography has to appear (within the master file or within
- a child).
- If the bibliography inset is in the master file, the references will be
- inherited by all children, so they are available in the citation dialog
- within each child.
-\end_layout
-
-\begin_layout Standard
-For child-specific bibliographies, insert bibliography insets within the
- child documents, at the place where the bibliography should appear when
- the child is compiled separately.
- However, the trick is to insert them into a branch (
+s cannot be nested.
+ In addition to the individual bibliography of the current unit,
\family sans
-Insert\SpecialChar menuseparator
-Branch\SpecialChar menuseparator
-Insert New Branch...
+Biblatex
\family default
-), e.
+ also provides an easy way to output all bibliographies, subsequently, at
+ one place (e.
\begin_inset space \thinspace{}
\end_inset
-g.
- called
+g., at the end of the document).
+ Select
\begin_inset Quotes eld
\end_inset
-Childonly
+all reference units
\begin_inset Quotes erd
\end_inset
-.
- Within the children, activate the branch (
-\family sans
-Document\SpecialChar menuseparator
-Settings...\SpecialChar menuseparator
-Branches
-\family default
-).
- Within the master, deactivate the branch (
+ from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
+ this.
+ Please refer to the
\family sans
-Document\SpecialChar menuseparator
-Settings...\SpecialChar menuseparator
-Branches
+Biblatex
\family default
-).
- Now the child's bibliography will be ignored by the master, but considered
- by the child.
+ manual for more information on this topic.
\end_layout
-\begin_layout Standard
-If you need multiple bibliographies (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., one per child in the
-\emph on
-main document
-\emph default
-), please refer to sec.
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Multiple-Bibliographies"
-
-\end_inset
-
-.
+\begin_layout Section
+Multipart Documents
\end_layout
-\begin_layout Section
-\SpecialChar LyX
- Archives
+\begin_layout Subsection
+General Operation
\end_layout
\begin_layout Standard
-Users sometimes need to be able to
+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
-bundle
+master
\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
- includes a Python script (
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxpak.py
-\end_layout
-
+ 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
-) 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
-
+e.
+\begin_inset space \space{}
\end_inset
- or
+everything up to and including the
\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
+\backslash
+begin{document}
\end_layout
\end_inset
--compressed
+ line as well as the
\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
+\backslash
+end{document}
\end_layout
\end_inset
- format on Windows.
+ 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
-'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
+ allows you to include files quite easily with
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar menuseparator
-Export
+Insert\SpecialChar menuseparator
+Child
+\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
-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
+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
- (for the
-\begin_inset Flex Code
-status collapsed
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-tar
-\end_layout
+input
+\begin_inset Quotes erd
+\end_inset
+, and
+\begin_inset Quotes eld
\end_inset
- format) or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
--z
-\end_layout
-
+verbatim
+\begin_inset Quotes erd
\end_inset
- (for the
-\begin_inset Flex Code
-status collapsed
+.
+ The methods
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-zip
-\end_layout
+include
+\begin_inset Quotes erd
+\end_inset
+ and
+\begin_inset Quotes eld
\end_inset
- format) switch to the
-\begin_inset Flex Code
-status collapsed
+input
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-\SpecialChar LyX
-\SpecialChar menuseparator
-\SpecialChar LyX
- Archive
+ are similar in many ways, but there are also some notable differences:
\end_layout
+\begin_layout Enumerate
+Files that are
+\begin_inset Quotes eld
\end_inset
- converter in
-\begin_inset Flex Code
-status collapsed
+included
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
-\end_layout
+ are typeset beginning on a new page, while files that are
+\begin_inset Quotes eld
+\end_inset
+inputted
+\begin_inset Quotes erd
\end_inset
-.
- (Make sure you add the switch after the script name, not before it.)
+ are typeset starting on the current page.
\end_layout
-\begin_layout Section
-Fancy Headers and Footers
-\end_layout
+\begin_layout Enumerate
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-The default page layout is rather plain; for an
-\begin_inset Flex Code
-status collapsed
+Included
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-article
-\end_layout
+ files cannot themselves
+\begin_inset Quotes eld
+\end_inset
+include
+\begin_inset Quotes erd
\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
-
+ further files (
\begin_inset Quotes eld
\end_inset
-fancy
+grandchilds
\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
+).
+ With
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-For more information on fancy headers, see the
-\begin_inset Flex Code
-status collapsed
+input
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-fancyhdr
+, on the other hand, infinite sub-inputting is possible.
\end_layout
+\begin_layout Enumerate
+\begin_inset Quotes eld
\end_inset
- package documentation.
- (
-\begin_inset Flex URL
-status collapsed
+Include
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+ allow for the output of only selected
+\begin_inset Quotes eld
+\end_inset
-https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
-\end_layout
+included
+\begin_inset Quotes erd
+\end_inset
+ files, while maintaining the actual counters (pagination etc.) and references
+ (please refer to the section
+\emph on
+Child
+\begin_inset space ~
\end_inset
-)
+Documents
+\emph default
+ of the
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual for details).
\end_layout
\begin_layout Standard
-The page header is divided into three fields, not surprisingly labeled
+Hence,
\begin_inset Quotes eld
\end_inset
-left
+include
\begin_inset Quotes erd
\end_inset
-,
+ is the preferred method for chapters that are outsourced to child documents,
+ while
\begin_inset Quotes eld
\end_inset
-center
+input
\begin_inset Quotes erd
\end_inset
-, and
+ is more suitable for arbitrary file inheritance.
+\end_layout
+
+\begin_layout Standard
+A
\begin_inset Quotes eld
\end_inset
-right
+verbatim
\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
-
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.
+\begin_inset space \thinspace{}
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-chead
-\end_layout
-
+e.
+\begin_inset space \space{}
\end_inset
-,
+in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-rhead
+verbatim
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+ 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
-
-\backslash
-lfoot
-\end_layout
-
+Mark
+\begin_inset space ~
\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
+spaces
+\begin_inset space ~
+\end_inset
-\family typewriter
+in
+\begin_inset space ~
+\end_inset
-\backslash
-lhead{John Q.
- DocWriter}
+output
\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.:
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
\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
-\family typewriter
-
-\backslash
-cfoot{}
+\begin_layout Subsection
+Cross-References Between Files
\end_layout
\begin_layout Standard
-Let's get really fancy: lets put the section number with the word
-\begin_inset Quotes eld
-\end_inset
+\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
-Section
-\begin_inset Quotes erd
-\end_inset
+\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
- (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_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
-g.
-\begin_inset space \space{}
+buffer
+\begin_inset Quotes erd
\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:
+ to use.
\end_layout
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lhead{Section
-\backslash
-thesection}
+\begin_layout Subsection
+Bibliography Lists in all Subdocuments
\end_layout
\begin_layout Standard
-
-\family typewriter
-
-\backslash
-chead{}
+If you work with child documents, you might want to have only one main bibliogra
+phy at the end, but still be able to have a selected bibliography for the
+ child if you output it on its own.
+ Here is how to achieve this.
\end_layout
\begin_layout Standard
-
-\family typewriter
-
-\backslash
-rhead{Page
-\backslash
-thepage}
+For the main document, you just insert a bibliography inset at the place
+ where the main bibliography has to appear (within the master file or within
+ a child).
+ If the bibliography inset is in the master file, the references will be
+ inherited by all children, so they are available in the citation dialog
+ within each child.
\end_layout
\begin_layout Standard
+For child-specific bibliographies, insert bibliography insets within the
+ child documents, at the place where the bibliography should appear when
+ the child is compiled separately.
+ However, the trick is to insert them into a branch (
+\family sans
+Insert\SpecialChar menuseparator
+Branch\SpecialChar menuseparator
+Insert New Branch...
+\family default
+), e.
+\begin_inset space \thinspace{}
+\end_inset
-\family typewriter
+g.
+ called
+\begin_inset Quotes eld
+\end_inset
-\backslash
-lfoot{John Q.
- DocWriter}
+Childonly
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Within the children, activate the branch (
+\family sans
+Document\SpecialChar menuseparator
+Settings...\SpecialChar menuseparator
+Branches
+\family default
+).
+ Within the master, deactivate the branch (
+\family sans
+Document\SpecialChar menuseparator
+Settings...\SpecialChar menuseparator
+Branches
+\family default
+).
+ Now the child's bibliography will be ignored by the master, but considered
+ by the child.
\end_layout
\begin_layout Standard
+If you need multiple bibliographies (e.
+\begin_inset space \thinspace{}
+\end_inset
-\family typewriter
+g., one per child in the
+\emph on
+main document
+\emph default
+), please refer to sec.
+\begin_inset space ~
+\end_inset
-\backslash
-cfoot{}
-\end_layout
-\begin_layout Standard
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Multiple-Bibliographies"
-\family typewriter
+\end_inset
-\backslash
-rfoot{
-\backslash
-today}
+.
+\end_layout
+
+\begin_layout Section
+\SpecialChar LyX
+ Archives
\end_layout
\begin_layout Standard
-The commands
+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
+ includes a Python script (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thesection
+lyxpak.py
\end_layout
\end_inset
- and
+) that automates this process.
+ To use it, you must have either the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thepage
+zipfile
\end_layout
\end_inset
- access \SpecialChar LaTeX
-'s section and page counters, and so print out the current section
- and page number.
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-today
+tarfile
\end_layout
\end_inset
- simply prints out today's date.
+ 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
-\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
+\end_inset
+
+-compressed
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-renewcommand{
-\backslash
-headrulewidth}{0.4pt}
+tar
\end_layout
\end_inset
- and
+ format on Unix-like systems and the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-renewcommand{
-\backslash
-footrulewidth}{0.4pt}
+zip
\end_layout
\end_inset
- to set the thicknesses.
+ format on Windows.
\end_layout
\begin_layout Standard
-You can switch the header/footer settings on and off for individual pages
- using commands like
+\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
-
-\backslash
-thispagestyle{empty}
+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
-
-\backslash
-thispagestyle{plain}
+-t
\end_layout
\end_inset
-, and
+ (for the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thispagestyle{fancy}
+tar
\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
+ format) or
+\begin_inset Flex Code
+status collapsed
-\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
+\begin_layout Plain Layout
+-z
\end_layout
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-lhead{
-\backslash
-resizebox{1in}{!}{
-\backslash
-includegraphics{logo.eps}}}
-\end_layout
+\end_inset
-\begin_layout Standard
-\noindent
-(you may need to preface this with
+ (for the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-usepackage{graphics}
+zip
\end_layout
\end_inset
- if you don't include graphics elsewhere in your document).
-\end_layout
+ format) switch to the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Section
-Itemize Bullet Selection
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:bullet"
+\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
-\begin_layout Standard
-by
-\noun on
- Allan Rae
+\end_inset
+
+.
+ (Make sure you add the switch after the script name, not before it.)
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Section
+Fancy Headers and Footers
\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
+The default page layout is rather plain; for an
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Well, actually you can but you'll have to do it by hand.
+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
-\end_layout
+fancy
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-How it looks
+, 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
-Open the dialog by selecting the
-\begin_inset Flex Noun
+For more information on fancy headers, see the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
+fancyhdr
\end_layout
\end_inset
- menu item and then select the
-\begin_inset Flex Noun
+ package documentation.
+ (
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-Bullets
+
+https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
\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.
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 244031559 1603875981
- 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.
-\change_unchanged
+left
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\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.
-\end_layout
+center
+\begin_inset Quotes erd
+\end_inset
-\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
+, 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
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Button
+\backslash
+lhead
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+,
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Packages Required
+\backslash
+chead
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+,
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Standard
+\backslash
+rhead
\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
+,
+\begin_inset Flex Code
+status collapsed
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-base \SpecialChar LaTeX
+\begin_layout Plain Layout
+\backslash
+lfoot
\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
+, 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
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Maths
+\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
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
+g.:
+\end_layout
+
+\begin_layout Standard
\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-amssymb.sty
+
+\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
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
+Section
+\begin_inset Quotes erd
+\end_inset
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding1
-\end_layout
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
+Section 3) in the upper left, the page number (e.
+\begin_inset space \thinspace{}
+\end_inset
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+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
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
-\begin_layout Plain Layout
+\family typewriter
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding2
+\backslash
+lhead{Section
+\backslash
+thesection}
\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
+\begin_layout Standard
\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+
+\backslash
+chead{}
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
-\begin_layout Plain Layout
+\family typewriter
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding3
+\backslash
+rhead{Page
+\backslash
+thepage}
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
-\begin_layout Plain Layout
+\family typewriter
+
+\backslash
+lfoot{John Q.
+ DocWriter}
+\end_layout
+
+\begin_layout Standard
\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+
+\backslash
+cfoot{}
\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 Standard
-\begin_layout Plain Layout
+\family typewriter
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding4
+\backslash
+rfoot{
+\backslash
+today}
\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 Standard
+The commands
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\backslash
+thesection
\end_layout
\end_inset
-</cell>
-</row>
-</lyxtabular>
-\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+\backslash
+thepage
\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
+\end_inset
+
+ access \SpecialChar LaTeX
+'s section and page counters, and so print out the current section
+ and page number.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar LyX
- doesn't restrict your use since you may be editing locally and exporting
- elsewhere.
+
+\backslash
+today
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Subsection
-How to use it
+ simply prints out today's date.
\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 open
+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
-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:
+
+\backslash
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\end_inset
-\begin_layout Plain Layout
+ and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
\backslash
-let
-\backslash
-savelabelitemi=
+renewcommand{
\backslash
-labelitemi
+footrulewidth}{0.4pt}
\end_layout
\end_inset
-
+ to set the thicknesses.
\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\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
-renewcommand
\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
+thispagestyle{empty}
\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{}{}
+thispagestyle{plain}
\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.
-\end_layout
+, and
+\begin_inset Flex Code
+status collapsed
-\begin_deeper
-\begin_layout LyX-Code
+\begin_layout Plain Layout
\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
+thispagestyle{fancy}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
+.
+ 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
-\end_deeper
-\begin_layout Itemize
-Note that the itemize depth is specified in Roman numerals as part of the
-
+\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
-labelitem
-\family default
- command.
+lhead{
+\backslash
+resizebox{1in}{!}{
+\backslash
+includegraphics{logo.eps}}}
\end_layout
-\begin_layout Itemize
-\begin_inset Argument item:1
-status open
-
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\begin_layout Standard
+\noindent
+(you may need to preface this with
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-\backslash
-(
-\backslash
-star
\backslash
-)
+usepackage{graphics}
\end_layout
\end_inset
-
+ if you don't include graphics elsewhere in your document).
\end_layout
-\end_inset
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bullet"
- Specify each individual entry by starting each item with the bullet shape
- enclosed in a
-\begin_inset Quotes eld
\end_inset
-Custom Item
-\begin_inset Quotes erd
-\end_inset
- inset (available at
-\family sans
-Insert\SpecialChar menuseparator
-Custom Item
-\family default
-) and set as
-\begin_inset Flex Noun
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-\SpecialChar TeX
- Code
+\begin_layout Standard
+by
+\noun on
+ Allan Rae
\end_layout
-\end_inset
+\begin_layout Subsection
+Introduction
+\end_layout
-.
- For example, this item was started with
-\begin_inset Flex Code
+\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
-
-\backslash
-(
-\backslash
-star
-\backslash
-)
+Well, actually you can but you'll have to do it by hand.
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Subsection
+How it looks
+\end_layout
+\begin_layout Standard
+Open the dialog by selecting the
+\begin_inset Flex Noun
+status collapsed
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
\end_layout
\end_inset
-
-\end_layout
+ menu item and then select the
+\begin_inset Flex Noun
+status collapsed
\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:
+Bullets
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+ tab.
\end_layout
-\end_inset
+\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.
+\change_deleted 244031559 1603875981
+ 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.
+\change_unchanged
\end_layout
-\begin_layout Chapter
-\SpecialChar LyX
- and the World Wide Web
+\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.
\end_layout
\begin_layout Standard
-\SpecialChar LyX
- has long supported the export of documents to various web-friendly formats,
- such as HTML.
- Before version 2.0, however, HTML export was always accomplished by the
- use of external converters.
-\begin_inset Foot
-status collapsed
+\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
-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
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Button
\end_layout
\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-html2latex
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Packages Required
\end_layout
\end_inset
-
-, and
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-plastex
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Standard
\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
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-e\SpecialChar LyX
-er
-\end_layout
-\end_inset
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+base \SpecialChar LaTeX
-.
- All of these have different advantages and disadvantages.
-
\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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-aux
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Maths
\end_layout
\end_inset
-
- files, counters, and references, and can often make use of the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-bbl
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+amssymb.sty
\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
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-htlatex
+
+\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
-, 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.
+\begin_layout Plain Layout
+
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
\end_layout
-\begin_layout Standard
-Alex Fernandez's
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-e\SpecialChar LyX
-er
+
+\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_inset CommandInset href
-LatexCommand href
-name "http://pinchito.es/elyxer/"
-target "http://pinchito.es/elyxer/"
-literal "false"
+\begin_layout Plain Layout
-\end_inset
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
-) 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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-htlatex
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding3
\end_layout
\end_inset
-
-; this reflects the limitations of HTML.
-\begin_inset Foot
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-That said,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-e\SpecialChar LyX
-er
+\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
- 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.
+\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
-
- More importantly (as of version 1.1.1, at least),
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-e\SpecialChar LyX
-er
+
+\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
- has limited support for math macros and no support for user-defined paragraph
- or character styles.
- These limitations make
-\begin_inset Flex Code
+
+\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
-e\SpecialChar LyX
-er
+\SpecialChar LyX
+ doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
\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
+\begin_layout Subsection
+How to use it
+\end_layout
-experimental
-\begin_inset Quotes erd
-\end_inset
+\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
+status open
\begin_layout Plain Layout
-The file
-\begin_inset Flex Code
-status collapsed
+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
-development/HTML/HTML.notes
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
\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 "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
-literal "false"
-\end_inset
+\end_layout
-, 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 "https://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"
-literal "false"
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
-\end_inset
+\begin_layout Plain Layout
-.
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
\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
+\begin_layout Itemize
+Use the \SpecialChar LaTeX
+ command
+\begin_inset Flex Code
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
+\backslash
+renewcommand{}{}
+\end_layout
-Chapter 1
-\begin_inset Quotes erd
\end_inset
- or
-\begin_inset Quotes eld
-\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.
+\end_layout
+\begin_deeper
+\begin_layout LyX-Code
-\lang ngerman
-Kapitel
-\lang english
- 1
-\begin_inset Quotes erd
-\end_inset
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
-, depending upon the language in effect at the time.
-
+\begin_layout LyX-Code
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
\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
-\change_deleted 244031559 1603876931
-character
-\change_inserted 244031559 1603876940
-text
-\change_unchanged
- 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_deeper
+\begin_layout Itemize
+Note that the itemize depth is specified in Roman numerals as part of the
-\end_layout
+\family typewriter
-\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.
+\backslash
+labelitem
+\family default
+ command.
\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 Itemize
+\begin_inset Argument item:1
+status open
-\begin_layout Section
-Math Output in XHTML
-\end_layout
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
-\begin_layout Standard
-\SpecialChar LyX
- offers four choices for how math is rendered.
- These have various advantages and disadvantages:
-\end_layout
+\begin_layout Plain 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
+\backslash
+(
+\backslash
+star
+\backslash
+)
+\end_layout
+
\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
+ Specify each individual entry by starting each item with the bullet shape
+ enclosed in a
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-HTML
-\begin_inset Newline newline
+Custom Item
+\begin_inset Quotes erd
\end_inset
-As mentioned above,
-\begin_inset Flex Code
+ inset (available at
+\family sans
+Insert\SpecialChar menuseparator
+Custom Item
+\family default
+) and set as
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-elyxer
+\SpecialChar TeX
+ Code
\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
+.
+ For example, this item was started with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-elyxer
+
+\backslash
+(
+\backslash
+star
+\backslash
+)
\end_layout
\end_inset
.
\end_layout
-\end_inset
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
- 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
+
+\end_layout
\begin_layout Plain Layout
-xymatrix
+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
-\end_inset
+\begin_layout LyX-Code
- package or ERT—then it will instead output the formula as an image.
-
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
\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
+\begin_layout Chapter
+\SpecialChar LyX
+ and the World Wide Web
+\end_layout
-, \SpecialChar LyX
- will output formulae as images, the very same images, in fact, that are
- used for instant preview.
+\begin_layout Standard
+\SpecialChar LyX
+ has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before version 2.0, however, HTML export was always accomplished by the
+ use of external converters.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Instant preview does
+For details on the use of external converters with \SpecialChar LyX
+, see the
\emph on
-not
+Converters
\emph default
-have to be on for images to be output, however.
+ section of the Customization manual.
\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.
-\begin_inset Newline newline
-\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
-The size of the images can be controlled by setting the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+htlatex
+\end_layout
-Math Images Scaling
-\begin_inset Quotes erd
\end_inset
- parameter under
-\begin_inset Flex Noun
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Formats
+html2latex
\end_layout
\end_inset
-.
-\begin_inset Foot
+, and
+\begin_inset Flex Code
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.
+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_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
-.
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\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/"
-literal "false"
-
-\end_inset
+ All of these have different advantages and disadvantages.
+
+\end_layout
-, which uses JavaScript to render \SpecialChar LaTeX
- embedded in HTML documents.
- \SpecialChar LyX
- wraps the \SpecialChar LaTeX
- in either a
+\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
-span
+aux
\end_layout
\end_inset
- (for inline formulas) or
+ files, counters, and references, and can often make use of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+bbl
\end_layout
\end_inset
- (for displayed formulas) with
+ 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
-class='math'
+htlatex
\end_layout
\end_inset
-, as is required for jsMath.
+, 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
-One of these output methods must be selected under
-\begin_inset Flex Noun
+Alex Fernandez's
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Formats
+e\SpecialChar LyX
+er
\end_layout
\end_inset
-.
- By default, \SpecialChar LyX
- outputs MathML.
- This is a document-wide setting, therefore.
-\end_layout
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://pinchito.es/elyxer/"
+target "http://pinchito.es/elyxer/"
+literal "false"
-\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
+\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
-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
-
-.
+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 Section
-Bibliography and Citations
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Standard
-XHTML output fully supports bibliographies and citations.
-
-\end_layout
+\end_inset
-\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.
+ 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
-\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
+\end_inset
-\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:
+ 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 Quote
-Jason Stanley,
-\begin_inset Quotes eld
\end_inset
-Context and Logical Form
-\begin_inset Quotes erd
+ 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
-, in
-\emph on
-Language in Context: Selected Essays
-\emph default
- (Oxford: Oxford University Press, 2007), pp.
- 30–68.
+ 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 Quote
-Jason Stanley,
+\begin_layout Standard
+As of this writing, XHTML output remains under development and should probably
+ be regarded as
\begin_inset Quotes eld
\end_inset
-Semantics in Context
+experimental
\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_inset Foot
+status collapsed
-\begin_layout Standard
-This should be fixed before long.
-\end_layout
+\begin_layout Plain Layout
+The file
+\begin_inset Flex Code
+status collapsed
-\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.
+\begin_layout Plain Layout
+development/HTML/HTML.notes
\end_layout
-\begin_layout Section
-Indexes
+\end_inset
+
+, which can be found in the \SpecialChar LyX
+ source tree or
+\begin_inset CommandInset href
+LatexCommand href
+name "accessed online"
+target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
+literal "false"
+
+\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 "https://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"
+literal "false"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- will happily export indexes as XHTML, but with certain limitations at the
- moment.
+\end_inset
+
+ Still, the developers have chosen this approach because it has several
+ potential advantages over the other two.
\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
-.
+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
-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
-.
+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
- 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
+ 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
-, 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
+ or
\begin_inset Quotes eld
\end_inset
-|see\SpecialChar ldots
+\lang ngerman
+Kapitel
+\lang english
+ 1
\begin_inset Quotes erd
\end_inset
- construct, it is just dropped, and the rest is treated as an ordinary index
- entry.
+, depending upon the language in effect at the time.
+
\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.
+\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
+\change_deleted 244031559 1603876931
+character
+\change_inserted 244031559 1603876940
+text
+\change_unchanged
+ 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 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.
+\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 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.
+\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
-Nomenclature and Glossary
+Math Output in XHTML
\end_layout
\begin_layout Standard
-There is at present no support for glossaries.
- Adding it would be fairly trivial, and welcome.
+\SpecialChar LyX
+ offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
\end_layout
-\begin_layout Chapter
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
+\end_inset
-\change_inserted 1075283030 1616534180
-DocBook Output
-\end_layout
+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 Standard
+If \SpecialChar LyX
+ is unable to render a formula as MathML—for example, if the formula
+ uses the
+\begin_inset Flex Code
+status collapsed
-\change_inserted 1075283030 1616534386
-Apart from HTML, \SpecialChar LyX
- can generate documents in the DocBook XML vocabulary.
- With versions 2.3 and before, only select templates could be used to generate
- DocBook documents (only version 4).
- Starting with \SpecialChar LyX
- 2.4, most \SpecialChar LyX
- layouts can generate valid DocBook documents (only
- version 5).
- This feature is built into \SpecialChar LyX
- and does not require the use of external tools.
+\begin_layout Plain Layout
+xymatrix
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted 1075283030 1616534437
-The result is that the DocBook 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.
+ package or ERT—then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
+\end_inset
-\change_inserted 1075283030 1616534475
-Most \SpecialChar LyX
- features are supported with DocBook, like math output.
+As mentioned above,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+elyxer
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616534741
-Math output is performed mostly in MathML (the major exception being constructio
-ns not supported by \SpecialChar LyX
-, i.e.
- ERTs).
- All formulae are also available in raw \SpecialChar TeX
- in the DocBook output for further
- processing.
-\end_layout
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+\SpecialChar LyX
+ has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
+status collapsed
-\change_inserted 1075283030 1616534852
-Bibliographies and citations are implemented, including with an external
- BibTeX file.
- Bibliography entries are not prerendered when the detailed information
- are available, but rather output with the standard DocBook constructs.
- The external DocBook processor is expected to handle the rendering of entries.
+\begin_layout Plain Layout
+elyxer
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616534863
-Indexes are supported, including multiple indices.
- Grouping (with
-\family typewriter
-!
-\family default
-), page ranges, and cross-references (
-\family typewriter
-|see
-\family default
-) are supported, with the exception of the same symbols escaped.
- Entry order (
-\family typewriter
-@
-\family default
-) and layout (
-\family typewriter
-|mathbf
-\family default
-) are not supported.
- There is no support for escaping of index entries.
+.
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616534884
-Glossaries are implemented.
-\end_layout
+ 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
-\begin_layout Standard
+If Lyx is unable to render a formula as HTML—for example, if the formula
+ uses the
+\begin_inset Flex Code
+status collapsed
-\change_inserted 1075283030 1616534894
-Two major parameters can be set at the document level.
+\begin_layout Plain Layout
+xymatrix
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616534948
-Format for tables: \SpecialChar LyX
- can generate tables either as HTML (default value) or
- CALS, depending on the user's requirements.
- Most DocBook processors accept both formats.
+ 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
-\change_inserted 1075283030 1616535006
-MathML prefix: in DocBook, MathML is included within its own name space,
- unlike HTML.
- The implication is that there must be an indication of the tags belonging
- to the MathML standard.
- Three choices are offered:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+Like
+\begin_inset Flex Code
+status collapsed
-\change_inserted 1075283030 1616535044
-Inline: the MathML name space is defined for each formula (using the
-\family typewriter
-xmlns
-\family default
- attribute on each formula)
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616535090
-With the
-\family typewriter
-m
-\family default
- prefix (default): the MathML name space is defined at the document level
- (using the
-\family typewriter
-xmlns:m
-\family default
- attribute on the root element).
- Each MathML is prefixed with
-\family typewriter
-m
-\family default
-: for instance,
-\family typewriter
-m:math
+, \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
-\begin_layout Itemize
+\end_inset
-\change_inserted 1075283030 1616620405
-With the
-\family typewriter
-mml
-\family default
- prefix: similar to the
-\family typewriter
-m
-\family default
- option, but with
-\family typewriter
-mml
-\end_layout
+ 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.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
+The size of the images can be controlled by setting the
+\begin_inset Quotes eld
+\end_inset
-\change_inserted 1075283030 1616620470
-This option is especially useful if you want \SpecialChar LyX
- to match your personal style
- or to work with buggy software that only accepts one prefix for MathML.
-\change_unchanged
+Math Images Scaling
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ parameter under
+\begin_inset Flex Noun
+status collapsed
-\end_deeper
-\begin_layout Chapter
-The \SpecialChar LyX
- Server
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\end_layout
-\begin_layout Section
-Introduction
+\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
-\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
+
+\begin_inset Newline newline
\end_inset
- citations to \SpecialChar LyX
+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 Section
-Starting the \SpecialChar LyX
- Server
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Starting-the-Server"
+\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/"
+literal "false"
-\end_layout
+\end_inset
-\begin_layout Standard
-The \SpecialChar LyX
- server works through the use of a pair of named pipes.
- These are usually located in
+, 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
-UserDir
+span
\end_layout
\end_inset
-, (except on Windows, where
-\emph on
-local
-\emph default
- named pipes are special objects located in
+ (for inline formulas) or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+div
+\end_layout
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\end_layout
-
-\end_inset
-
-) and have the names
-\begin_inset Quotes eld
-\end_inset
-
+\end_inset
+ (for displayed formulas) with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+class='math'
\end_layout
\end_inset
+, as is required for jsMath.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
+\begin_layout Standard
+One of these output methods must be selected under
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\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
+ By default, \SpecialChar LyX
+ outputs MathML.
+ This is a document-wide setting, therefore.
\end_layout
-\end_inset
-
- and read back data from
-\begin_inset Flex Code
+\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
-lyxpipe.out
-\end_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
.
- 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"
+\begin_layout Section
+Bibliography and Citations
\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"
+\begin_layout Standard
+XHTML output fully supports bibliographies and citations.
+
\end_layout
-\end_inset
+\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
- would also work).
- You
+\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
-must
+Customization
\emph default
- configure this manually in order for the server to start.
+ manual for the details.
\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
+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
-\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_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-stale
+Context and Logical Form
\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
+, 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
-stale
+Semantics in Context
\begin_inset Quotes erd
\end_inset
- pipes should not be possible.
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 201–30.
\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
+This should be fixed before long.
+\end_layout
-\begin_layout Plain Layout
-preferences
+\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
-\end_inset
+\begin_layout Section
+Indexes
+\end_layout
- file, for each process.
+\begin_layout Standard
+\SpecialChar LyX
+ will happily export indexes as XHTML, but with certain limitations at the
+ moment.
\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
+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
-lyx -dbg lyxserver
+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
-.
-\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
+ 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
-.
-\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
-
+ !
+\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 Section
-Normal communication
+\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 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 Itemize
+Cross-referencing: There is no support for cross-referencing.
+ If \SpecialChar LyX
+ finds an entry containing the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-argument
-\end_layout
+|see\SpecialChar ldots
-\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.
+\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 Description
-function is the function you want \SpecialChar LyX
- to perform.
- It is the same as the commands you'd use in the minibuffer.
+\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 Description
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
+\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
-self-insert
+entry|textbf
\begin_inset Quotes erd
\end_inset
- LFUN will insert the argument as text at the cursor position).
+.
+ Indeed, if \SpecialChar LyX
+ finds a pipe symbol, `|', in an entry, it will delete it and
+ everything that follows it.
\end_layout
-\begin_layout Standard
-The answer from \SpecialChar LyX
- will arrive in the output pipe and be of the form
+\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 Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-data
+\begin_layout Section
+Nomenclature and Glossary
\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
+There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
+\end_layout
-font-state
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Chapter
-, 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.
+\change_inserted 1075283030 1616534180
+DocBook Output
\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
+\change_inserted 1075283030 1616534386
+Apart from HTML, \SpecialChar LyX
+ can generate documents in the DocBook XML vocabulary.
+ With versions 2.3 and before, only select templates could be used to generate
+ DocBook documents (only version 4).
+ Starting with \SpecialChar LyX
+ 2.4, most \SpecialChar LyX
+ layouts can generate valid DocBook documents (only
+ version 5).
+ This feature is built into \SpecialChar LyX
+ and does not require the use of external tools.
\end_layout
\begin_layout Standard
-where the
+
+\change_inserted 1075283030 1616534437
+The result is that the DocBook 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
-error message
+Customization
\emph default
- should contain an explanation of why the command failed.
+manual for the details.
\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
+\change_inserted 1075283030 1616534475
+Most \SpecialChar LyX
+ features are supported with DocBook, like math output.
\end_layout
-\begin_layout Subsection
-AppleScript (Mac OS X)
-\end_layout
+\begin_layout Itemize
-\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.
+\change_inserted 1075283030 1616534741
+Math output is performed mostly in MathML (the major exception being constructio
+ns not supported by \SpecialChar LyX
+, i.e.
+ ERTs).
+ All formulae are also available in raw \SpecialChar TeX
+ in the DocBook output for further
+ processing.
\end_layout
-\begin_layout Standard
-Example:
-\end_layout
+\begin_layout Itemize
-\begin_layout LyX-Code
-tell application "\SpecialChar LyX
-"
+\change_inserted 1075283030 1616534852
+Bibliographies and citations are implemented, including with an external
+ BibTeX file.
+ Bibliography entries are not prerendered when the detailed information
+ are available, but rather output with the standard DocBook constructs.
+ The external DocBook processor is expected to handle the rendering of entries.
\end_layout
-\begin_layout LyX-Code
- try
-\end_layout
+\begin_layout Itemize
-\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 "")
+\change_inserted 1075283030 1616534863
+Indexes are supported, including multiple indices.
+ Grouping (with
+\family typewriter
+!
+\family default
+), page ranges, and cross-references (
+\family typewriter
+|see
+\family default
+) are supported, with the exception of the same symbols escaped.
+ Entry order (
+\family typewriter
+@
+\family default
+) and layout (
+\family typewriter
+|mathbf
+\family default
+) are not supported.
+ There is no support for escaping of index entries.
\end_layout
-\begin_layout LyX-Code
- on error the error_message number the error_number
-\end_layout
+\begin_layout Itemize
-\begin_layout LyX-Code
- display dialog "Error: " & the error_number & ".
- " ¬
+\change_inserted 1075283030 1616534884
+Glossaries are implemented.
\end_layout
-\begin_layout LyX-Code
- & the error_message buttons {"OK"} default button 1
-\end_layout
+\begin_layout Standard
-\begin_layout LyX-Code
- end try
+\change_inserted 1075283030 1616534894
+Two major parameters can be set at the document level.
\end_layout
-\begin_layout LyX-Code
-end tell
+\begin_layout Itemize
+
+\change_inserted 1075283030 1616534948
+Format for tables: \SpecialChar LyX
+ can generate tables either as HTML (default value) or
+ CALS, depending on the user's requirements.
+ Most DocBook processors accept both formats.
\end_layout
-\begin_layout Section
-Notification
+\begin_layout Itemize
+
+\change_inserted 1075283030 1616535006
+MathML prefix: in DocBook, MathML is included within its own name space,
+ unlike HTML.
+ The implication is that there must be an indication of the tags belonging
+ to the MathML standard.
+ Three choices are offered:
\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
+\begin_deeper
+\begin_layout Itemize
-notify
-\begin_inset Quotes erd
-\end_inset
+\change_inserted 1075283030 1616535044
+Inline: the MathML name space is defined for each formula (using the
+\family typewriter
+xmlns
+\family default
+ attribute on each formula)
+\end_layout
-.
- The format of the string \SpecialChar LyX
- sends is as follows:
+\begin_layout Itemize
+
+\change_inserted 1075283030 1616535090
+With the
+\family typewriter
+m
+\family default
+ prefix (default): the MathML name space is defined at the document level
+ (using the
+\family typewriter
+xmlns:m
+\family default
+ attribute on the root element).
+ Each MathML is prefixed with
+\family typewriter
+m
+\family default
+: for instance,
+\family typewriter
+m:math
\end_layout
-\begin_layout Quote
-\begin_inset Flex Code
-status collapsed
+\begin_layout Itemize
-\begin_layout Plain Layout
-NOTIFY:
+\change_inserted 1075283030 1616620405
+With the
+\family typewriter
+mml
+\family default
+ prefix: similar to the
+\family typewriter
+m
+\family default
+ option, but with
+\family typewriter
+mml
\end_layout
-\end_inset
+\begin_layout Standard
+\change_inserted 1075283030 1616620470
+This option is especially useful if you want \SpecialChar LyX
+ to match your personal style
+ or to work with buggy software that only accepts one prefix for MathML.
+\change_unchanged
-\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_deeper
+\begin_layout Chapter
+The \SpecialChar LyX
+ Server
+\end_layout
+
+\begin_layout Section
+Introduction
\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
+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
-notify
+push
\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
+ citations to \SpecialChar LyX
.
\end_layout
\begin_layout Section
-The simple \SpecialChar LyX
- Server Protocol
+Starting the \SpecialChar LyX
+ Server
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Starting-the-Server"
+
+\end_inset
+
+
\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
+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 Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
+\begin_layout Plain Layout
+UserDir
\end_layout
-\begin_layout Standard
-where
+\end_inset
+
+, (except on Windows, where
\emph on
-protocol message
+local
\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
+ named pipes are special objects located in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\end_layout
-hello
-\begin_inset Quotes erd
\end_inset
- or
+) and have the names
\begin_inset Quotes eld
\end_inset
-bye
-\begin_inset Quotes erd
-\end_inset
-.
- If
-\begin_inset Quotes eld
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxpipe.in
+\end_layout
+
\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
+ and
\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_inset Flex Code
+status collapsed
-\begin_layout Section
-Reverse DVI/PDF search
+\begin_layout Plain Layout
+lyxpipe.out
\end_layout
-\begin_layout Standard
-Some DVI/PDF viewers
-\begin_inset Foot
-status collapsed
+\end_inset
-\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
+\begin_inset Quotes erd
\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
+ External programs write into
\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
-
-
+lyxpipe.in
\end_layout
-\begin_layout Standard
-In most cases \SpecialChar LyX
- will do the work for you by pressing the following button
- in the toolbar:
-\begin_inset Info
-type "icon"
-arg "buffer-toggle-output-sync"
\end_inset
-.
- Alternatively, you can also enable the feature by checking
-\family sans
-Synchronize with Output
-\family default
- in
-\begin_inset Flex Noun
+ and read back data from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Formats
+lyxpipe.out
\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
+ The stem of the pipe names can be defined in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View/Update
+Tools\SpecialChar menuseparator
+Preferences
\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
+ dialog, for example
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-Synchronize with Output
+"/home/myhome/lyxpipe"
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-Note that the method
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+"
+\backslash
\backslash
-synctex=1
+.
+\backslash
+pipe
+\backslash
+lyxpipe"
\end_layout
\end_inset
- enables gzip compression.
- If your viewer does not support it, you should instead use
+ 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
-synctex=-1
+.
+\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
-Please also note that including the
+\SpecialChar LyX
+ will add the '
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-srcltx
+.in
\end_layout
\end_inset
- package or
+' and '
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src-specials
+.out
\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
+' 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
-srcltx
+preferences
\end_layout
\end_inset
- package or
+ 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
-src-specials
+lyx -dbg lyxserver
\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
-
+You can find a complete example client written in C++ in the source distribution
+ as
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:configuring-viewers"
+\begin_layout Plain Layout
+development/lyxserver/server_monitor.cpp
+\end_layout
\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
+Another useful tool is the command-line based client found in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex/pdflatex
+src/client/lyxclient
\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)
+\begin_layout Section
+Normal communication
\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
+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
-\end_inset
-
- or
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain)->DraftDVI
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
\end_layout
-\end_inset
-
- converter in
-\begin_inset Flex Noun
-status collapsed
+\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 Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
+\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
- to
-\begin_inset Flex Code
-status collapsed
+self-insert
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-latex -src-specials $$i
+ LFUN will insert the argument as text at the cursor position).
\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).
+\begin_layout Standard
+The answer from \SpecialChar LyX
+ will arrive in the output pipe and be of the form
\end_layout
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
\end_layout
\begin_layout Standard
-The packages
+where
\emph on
-pdfsync
+clientname
\emph default
and
\emph on
-scrltx
+function
\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
+ 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
- for reverse PDF search,
+, 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 Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-usepackage[active]{srcltx}
+\begin_layout Standard
+In case of errors, the response from \SpecialChar LyX
+ will have this form
\end_layout
-\end_inset
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
+\end_layout
- for reverse DVI search.
+\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
-If you want to be able to perform both DVI and PDF reverse searches, you
- can also insert in the preamble the following lines
+Examples:
\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}
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
\begin_inset Newline newline
\end_inset
-
-\backslash
-else
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
\begin_inset Newline newline
\end_inset
-
-\backslash
-usepackage[active]{srcltx}
+read a <~/.lyxpipe.out
\begin_inset Newline newline
\end_inset
+echo $a
+\end_layout
-\backslash
-fi
+\begin_layout Subsection
+AppleScript (Mac OS X)
\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.
+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
-Note that PDFSync might affect the output layout of your document.
- It is therefore advised to disable PDFsync for final documents.
+Example:
\end_layout
-\begin_layout Subsubsection*
-Built-in reverse search via Sync\SpecialChar TeX
- (DVI and PDF)
+\begin_layout LyX-Code
+tell application "\SpecialChar LyX
+"
\end_layout
-\begin_layout Standard
-Recent versions of
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+ try
+\end_layout
-\begin_layout Plain Layout
-(pdf)latex
+\begin_layout LyX-Code
+ -- Stores the current file name into f
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ set f to (run "server-get-filename" with argument "")
+\end_layout
- have built-in support for both PDF and DVI reverse search.
- This so-called
-\emph on
-Sync\SpecialChar TeX
+\begin_layout LyX-Code
+ on error the error_message number the error_number
+\end_layout
-\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 LyX-Code
+ display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
-\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.
+\begin_layout LyX-Code
+ & the error_message buttons {"OK"} default button 1
\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).
+\begin_layout LyX-Code
+ end try
\end_layout
-\end_inset
-
- Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
- Skim on the Mac, SumatraPDF on Windows; see the next section for details)
- already provide Sync\SpecialChar TeX
- support.
+\begin_layout LyX-Code
+end tell
\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
+\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
- or
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain) -> DraftDVI
-\end_layout
-
+notify
+\begin_inset Quotes erd
\end_inset
- converter in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
+.
+ The format of the string \SpecialChar LyX
+ sends is as follows:
\end_layout
-\end_inset
-
- to
+\begin_layout Quote
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex -synctex=1 $$i
+NOTIFY:
\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)
+\emph on
+key-sequence
\end_layout
-\end_inset
-
- converter to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-pdflatex -synctex=1 $$i
+\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
.
- Should your viewer not be considered in the following description, or in
- case of missing success, please check the documentation of your viewer
- whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
+ 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
.
-\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
+\begin_layout Section
+The simple \SpecialChar LyX
+ Server Protocol
+\end_layout
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex Code
-status collapsed
+\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
--synctex=-1
+\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
-.
-\end_layout
+hello
+\begin_inset Quotes erd
+\end_inset
+ or
+\begin_inset Quotes eld
\end_inset
+bye
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+.
+ If
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Configuring and using specific viewers
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:configuring-viewers"
+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 Subsubsection*
-Xdvi (all platforms)
+\begin_layout Section
+Reverse DVI/PDF search
\end_layout
\begin_layout Standard
-If you use
-\begin_inset Flex Code
+Some DVI/PDF viewers
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-xdvi
+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
-, 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
+ 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
\end_inset
- program.
- Just setup your document as described above (reverse search is triggered
- by Ctrl-click or Alt-click on Mac OSX, respectively).
+ 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
-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
+\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 pressing the following button
+ in the toolbar:
+\begin_inset Info
+type "icon"
+arg "buffer-toggle-output-sync"
\end_inset
-
-\begin_inset Flex Code
+.
+ Alternatively, you can also enable the feature by checking
+\family sans
+Synchronize with Output
+\family default
+ in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-xdvi -editor "lyxeditor.sh %f %l"
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\end_layout
\end_inset
-, where
+.
+ 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
-lyxeditor.sh
+View/Update
\end_layout
\end_inset
- is a suitable script.
- For example, a minimal shell script is the following one:
+ Toolbar.
\end_layout
-\begin_layout LyX-Code
-#!/bin/sh
-\begin_inset Newline newline
-\end_inset
-
-LYXPIPE="/path/to/lyxpipe"
-\begin_inset Newline newline
-\end_inset
+\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
-COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+Synchronize with Output
+\end_layout
-echo "$COMMAND" > "${LYXPIPE}".in || exit
-\begin_inset Newline newline
\end_inset
-read TMP < "${LYXPIPE}".out || exit
+.
\end_layout
\begin_layout Standard
-where
+Note that the method
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/path/to/lyxpipe
+
+\backslash
+synctex=1
\end_layout
\end_inset
- is the LyXServer pipe path specified in
-\begin_inset Flex Noun
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-Paths
+
+\backslash
+synctex=-1
\end_layout
\end_inset
.
-\begin_inset Foot
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-In the
+\begin_layout Standard
+Please also note that including the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/tools
+srcltx
\end_layout
\end_inset
- folder of a source distribution you can find a
+ package or
\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.
+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
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
-\end_layout
+\end_inset
-\begin_layout Standard
-At the end of
+ package or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/Applications/MacDviX_Folder/calleditor.script
+src-specials
\end_layout
\end_inset
-, add the following lines:
+.
+
\end_layout
-\begin_layout LyX-Code
-/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
+\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
-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_inset CommandInset ref
+LatexCommand ref
+reference "subsec:configuring-viewers"
-\begin_layout Standard
-Reverse search is triggered by Alt-click (OPTION-click).
+\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 Subsubsection*
-Skim (Mac OSX)
+\begin_layout Subsection
+Manual setup
\end_layout
\begin_layout Standard
-Enter
+\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
-open -a Skim.app $$i
+latex/pdflatex
\end_layout
\end_inset
- to the viewer setting in
+ 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
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats\SpecialChar menuseparator
-PDF (pdflatex)
+La
+\family sans
+TeX
+\family default
+ (plain)->DVI
\end_layout
\end_inset
-, and then in
+ or
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Skim\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Sync
+La
+\family sans
+TeX
+\family default
+ (plain)->DraftDVI
\end_layout
\end_inset
- choose
+ converter in
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-custom
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
\end_layout
\end_inset
- preset and enter command
-\begin_inset Flex Noun
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/Applications/\SpecialChar LyX
-.app/Contents/MacOS/lyxeditor
+latex -src-specials $$i
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
+ 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*
-Evince (GNOME)
+External Packages (PDFSync and scrltx)
\end_layout
\begin_layout Standard
-Reverse search with evince does not work out of the box, but it can be achieved
- by means of some third party helper scripts.
- Please refer to
-\begin_inset CommandInset href
-LatexCommand href
-target "https://wiki.lyx.org/LyX/SyncTeX"
-literal "false"
+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
-\end_inset
-
- for details.
-\end_layout
-
-\begin_layout Subsubsection*
-Okular (KDE)
-\end_layout
-
-\begin_layout Standard
-Go to
-\begin_inset Flex Noun
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Settings\SpecialChar menuseparator
-Configure Okular\SpecialChar menuseparator
-Editor
+
+\backslash
+usepackage{pdfsync}
\end_layout
\end_inset
- and select LyX
-\begin_inset Quotes erd
-\end_inset
+ for reverse PDF search,
+\end_layout
- as editor.
- This inserts the appropriate command (
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient -g %f %l
+
+\backslash
+usepackage[active]{srcltx}
\end_layout
\end_inset
-).
+ for reverse DVI search.
\end_layout
\begin_layout Standard
-Reverse search is triggered by SHIFT-click.
+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
-\change_inserted -712698321 1578211026
- Note that this only works if Okular is in
-\begin_inset Quotes eld
+\begin_layout LyX-Code
+
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
\end_inset
-Browse
-\begin_inset Quotes erd
+
+\backslash
+ifpdf
+\begin_inset Newline newline
\end_inset
- mode (i.
-\begin_inset space \thinspace{}
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-e., the hand symbol is clicked).
-\change_unchanged
+\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*
-Qpdfview (Unix)
+Built-in reverse search via Sync\SpecialChar TeX
+ (DVI and PDF)
\end_layout
\begin_layout Standard
-Qpdfview supports Sync\SpecialChar TeX
- since version 0.3.5.
- Go to
-\begin_inset Flex Noun
+Recent versions of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Behavior
+(pdf)latex
\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
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+Sync\SpecialChar TeX
- item and add the command
-\begin_inset Flex Code
+\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
-lyxclient -g %1 %2
+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
-
-.
+\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
-\begin_layout Standard
-Reverse search is triggered by double-click or, in more recent versions,
- by context menu.
-\end_layout
+\end_inset
-\begin_layout Subsubsection*
-YAP (Windows)
+ Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
+ Skim on the Mac, SumatraPDF on Windows; see the next section for details)
+ already provide Sync\SpecialChar TeX
+ support.
\end_layout
\begin_layout Standard
-Launch yap, choose its
+To enable Sync\SpecialChar TeX
+ for DVI output, change the
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar menuseparator
-Options
+La
+\family sans
+TeX
+\family default
+ (plain) -> DVI
\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
+ or
+\begin_inset Flex Noun
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain) -> DraftDVI
+\end_layout
- button and, in the window that opens, enter
-\begin_inset Quotes eld
\end_inset
-\SpecialChar LyX
- Editor
-\begin_inset Quotes erd
-\end_inset
+ converter in
+\begin_inset Flex Noun
+status collapsed
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
+\end_layout
-Name:
-\begin_inset Quotes erd
\end_inset
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
+ to
+\begin_inset Flex Code
+status collapsed
-\SpecialChar ldots
+\begin_layout Plain Layout
+latex -synctex=1 $$i
+\end_layout
-\begin_inset Quotes erd
\end_inset
- to open a file dialog and navigate to the directory containing the batch
- file
-\begin_inset Flex Code
+, and for PDF output, change the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+La
+\family sans
+TeX
+\family default
+ (pdflatex) -> PDF (pdflatex)
\end_layout
\end_inset
- (see below).
- Select
+ converter to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+pdflatex -synctex=1 $$i
\end_layout
\end_inset
- and then specify the program arguments as
+.
+ Should your viewer not be considered in the following description, or in
+ case of missing success, please check the documentation of your viewer
+ whether the viewer needs to be configured 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
-%f %l
+-synctex=1
\end_layout
\end_inset
-.
- The
+ 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
-lyxeditor.bat
+-synctex=-1
\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_layout
+
+\begin_layout Subsection
+Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:configuring-viewers"
+
\end_inset
-type
-\backslash
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.out
+\end_layout
+
+\begin_layout Subsubsection*
+Xdvi (all platforms)
\end_layout
\begin_layout Standard
-Make sure that the \SpecialChar LyX
-Server pipe path you specified in \SpecialChar LyX
- is
+If you use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe
+xdvi
\end_layout
\end_inset
-, otherwise change the
+, 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
-lyxeditor.bat
+lyxclient
\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)
+ 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
-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
+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\SpecialChar menuseparator
-PDF (pdflatex)
+File formats
\end_layout
\end_inset
-, where
+ 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
-lyxeditor.bat
+DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
\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
+\end_inset
-\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
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-View\SpecialChar menuseparator
-Options
+xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\end_inset
+, where
+\begin_inset Flex Code
+status collapsed
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+lyxeditor.sh
+\end_layout
- tab.
- Click on the
-\begin_inset Quotes eld
\end_inset
-New\SpecialChar ldots
+ is a suitable script.
+ For example, a minimal shell script is the following one:
+\end_layout
-\begin_inset Quotes erd
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
\end_inset
-\SpecialChar LyX
- Editor
-\begin_inset Quotes erd
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
\end_inset
- (or any other name you like) in the
-\begin_inset Quotes eld
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
\end_inset
-Name:
-\begin_inset Quotes erd
-\end_inset
+read TMP < "${LYXPIPE}".out || exit
+\end_layout
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+where
+\begin_inset Flex Code
+status collapsed
-\SpecialChar ldots
+\begin_layout Plain Layout
+/path/to/lyxpipe
+\end_layout
-\begin_inset Quotes erd
\end_inset
- to open a file dialog and navigate to the directory containing the
-\begin_inset Flex Code
+ is the LyXServer pipe path specified in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-lyxeditor.exe
+Preferences\SpecialChar menuseparator
+Paths
\end_layout
\end_inset
- program (which is installed by default on Cygwin along with the \SpecialChar LyX
- executable).
- Select
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.exe
+development/tools
\end_layout
\end_inset
- and then specify the program arguments as
+ folder of a source distribution you can find a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--g %f %l
+lyxeditor
\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
+ script which is able to locate the
\emph on
lyxpipe
\emph default
-, omit the
+ 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
--g
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
\end_inset
- option and be sure to specify the \SpecialChar LyX
-Server pipe path in the \SpecialChar LyX
- preferences.
+, add the following lines:
+\end_layout
+
+\begin_layout LyX-Code
+/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
+
+exit 1
\end_layout
\begin_layout Standard
-In yap, reverse search is triggered by double-click.
+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*
-SumatraPDF (Cygwin)
+Skim (Mac OSX)
\end_layout
\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
+Enter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor -g %f %l"
+open -a Skim.app $$i
\end_layout
\end_inset
- in the viewer setting in
+ to the viewer setting in
\begin_inset Flex Noun
status collapsed
\end_inset
-.
- If SumatraPDF.exe is not in your command PATH, use its full posix path.
- The
-\begin_inset Flex Code
+, and then in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
--g
+Skim\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Sync
\end_layout
\end_inset
- enables communication via the
-\emph on
-lyxsocket
-\emph default
-.
- Again, omit the
-\begin_inset Flex Code
-status collapsed
+ choose
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
--g
+custom
\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.
+ 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 double-click.
+Reverse search is triggered by COMMAND-SHIFT-click
\end_layout
-\begin_layout Section
-Forward search
+\begin_layout Subsubsection*
+Evince (GNOME)
\end_layout
\begin_layout Standard
-Forward search is, as the name implies, in a sense the
-\begin_inset Quotes eld
-\end_inset
+Reverse search with evince does not work out of the box, but it can be achieved
+ by means of some third party helper scripts.
+ Please refer to
+\begin_inset CommandInset href
+LatexCommand href
+target "https://wiki.lyx.org/LyX/SyncTeX"
+literal "false"
-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
+ for details.
+\end_layout
+
+\begin_layout Subsubsection*
+Okular (KDE)
+\end_layout
+
+\begin_layout Standard
+Go to
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Navigate\SpecialChar menuseparator
-Forward search
+Settings\SpecialChar menuseparator
+Configure Okular\SpecialChar menuseparator
+Editor
\end_layout
\end_inset
- (or select
-\begin_inset Flex Noun
+ and select LyX
+\begin_inset Quotes erd
+\end_inset
+
+ as editor.
+ This inserts the appropriate command (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Forward search
+lyxclient -g %f %l
\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"
+Reverse search is triggered by SHIFT-click.
+
+\change_inserted -712698321 1578211026
+ Note that this only works if Okular is in
+\begin_inset Quotes eld
+\end_inset
+Browse
+\begin_inset Quotes erd
\end_inset
-.
+ mode (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., the hand symbol is clicked).
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsubsection*
+Qpdfview (Unix)
\end_layout
\begin_layout Standard
-Additionally, you need to configure \SpecialChar LyX
- for using your viewers in
+Qpdfview supports Sync\SpecialChar TeX
+ since version 0.3.5.
+ Go to
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-General
+Edit\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Behavior
\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
+, click on the input field of the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-\noindent
+Source editor
+\begin_inset Quotes erd
+\end_inset
+
+ item and add the command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$$n
+lyxclient -g %1 %2
\end_layout
\end_inset
-: row number
+.
\end_layout
-\begin_layout Itemize
-\noindent
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-$$t
+\begin_layout Standard
+Reverse search is triggered by double-click or, in more recent versions,
+ by context menu.
\end_layout
-\end_inset
-
-: name of the (temporary) exported .tex file (without path)
+\begin_layout Subsubsection*
+YAP (Windows)
\end_layout
-\begin_layout Itemize
-\noindent
-\begin_inset Flex Code
+\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-$$f
+View\SpecialChar menuseparator
+Options
\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
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-$$o
-\end_layout
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
+ tab.
+ Click on the
+\begin_inset Quotes eld
\end_inset
-: name of the exported output file (either dvi or pdf, depending on which
- one exists in the temporary directory)
-\end_layout
+New\SpecialChar ldots
-\begin_layout Standard
-Note that only some of the viewers provide full and usable forward search
- functionality out of the box, among them yap, xdvi, okular
-\begin_inset Foot
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-You might want to set
-\begin_inset Flex Code
-status collapsed
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-okular --unique
-\end_layout
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
+ (or any other name you like) in the
+\begin_inset Quotes eld
\end_inset
- in
-\begin_inset Flex Noun
-status collapsed
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File
-\begin_inset space ~
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
\end_inset
-Formats
-\end_layout
+\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
-, qpdfview, and SumatraPDF
-\begin_inset Foot
+ (see below).
+ Select
+\begin_inset Flex Code
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"
-literal "false"
+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
.
- Others, such as evince
-\begin_inset Foot
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Forward search with evince can be achieved by means of third party helper
- scripts.
- Please refer to
-\begin_inset CommandInset href
-LatexCommand href
-target "https://wiki.lyx.org/LyX/SyncTeX"
-literal "false"
-
-\end_inset
-
- for details.
+lyxeditor.bat
\end_layout
\end_inset
-, require some extra tools in order to use forward search.
- 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
+ wrapper is used for communicating with \SpecialChar LyX
+ through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
+\end_layout
-g.
- 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
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
\end_inset
-near
-\begin_inset Quotes erd
-\end_inset
+echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
+\backslash
+\backslash
.
- 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{}
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
\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
-
-\begin_layout Section
+type
+\backslash
-\change_deleted 564990737 1669742044
-A&A Paper
+\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
-\change_deleted 564990737 1669742044
-by
-\noun on
-Peter Sütterlin
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
+\backslash
-\change_deleted 564990737 1669742044
-Introduction
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-This section describes how \SpecialChar LyX
- can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (
-\begin_inset Flex URL
+, otherwise change the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-https://www.aanda.org/
+lyxeditor.bat
\end_layout
\end_inset
-) using Version 5.01 of the document class
-\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
+ wrapper accordingly.
\end_layout
\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\change_deleted 564990737 1669742044
-\begin_inset VSpace medskip
-\end_inset
-
-
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
\begin_layout Standard
-\align center
-
-\change_deleted 564990737 1669742044
-\begin_inset Flex URL
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-ftp://ftp.edpsciences.org/pub/aa/readme.html
+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 Standard
-
-\change_deleted 564990737 1669742044
-\begin_inset VSpace medskip
\end_inset
+, where
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-A manual comes together with that package, and this text is not meant to
- replace the original manual but is merely a short guide in how to realize
- the correct form of your paper.
-
+ is the previous wrapper.
+ If SumatraPDF.exe is not in your command PATH, use its full file name.
\end_layout
\begin_layout Standard
-
-\change_deleted 564990737 1669742044
-Please note that the publisher of the journal was changed from Springer
- to EDP Sciences starting January 1, 2001.
- That change involved also some slight changes to the style files, namely
- the removal of the thesaurus command.
- The \SpecialChar LyX
- class aa supports the newest version of these style files, V 5.01.
- If you have an older version installed, please upgrade.
- For compatibility, the old (version 4) layout has been kept as
-\family sans
-article (A&A V4)
-\family default
-.
- Please refer to the comments in
-\family typewriter
-\SpecialChar LyX
-Dir/layouts/aapaper.layout
-\family default
-.
+Reverse search is triggered by double-click.
\end_layout
-\begin_layout Subsection
-
-\change_deleted 564990737 1669742044
-Getting started
+\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
-\change_deleted 564990737 1669742044
-It is recommended you start from the example template distributed with \SpecialChar LyX
-.
- If you are not using a template, note the following settings:
+\begin_layout Plain Layout
+View\SpecialChar menuseparator
+Options
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-Document\SpecialChar menuseparator
-Settings
-\family default
- dialog (OK, that one was obvious).
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
-Don't change the option
-\family sans
-Page
-\begin_inset space ~
+ tab.
+ Click on the
+\begin_inset Quotes eld
\end_inset
-style
-\family default
-: Leave it set to
-\family sans
-default
-\family default
-.
- The whole layout is done by the macros, you shouldn't change anything.
-\end_layout
+New\SpecialChar ldots
-\begin_layout Subsection
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
-The header block
-\end_layout
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\end_layout
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Name:
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Title
-\family default
-: [required]
-\end_layout
+\SpecialChar ldots
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\family sans
-Subtitle
-\family default
-: [optional]
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+ program (which is installed by default on Cygwin along with the \SpecialChar LyX
+ executable).
+ Select
+\begin_inset Flex Code
+status collapsed
-\family sans
-Author
-\family default
-: [required]
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\family sans
-Address
-\family default
-: [required]
+\begin_layout Plain Layout
+-g %f %l
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+.
+ 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
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+ option and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
+\end_layout
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\change_deleted 564990737 1669742044
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-There is no need to issue the
-\family typewriter
+ in the viewer setting in
+\begin_inset Flex Noun
+status collapsed
-\backslash
-maketitle
-\family default
- command, this is done automatically by \SpecialChar LyX
- when the header is finished.
- Although the order of the single header entries doesn't matter it is advised
- to keep the above sequence, just to get the best optics and meets the layout
- of the real document.
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Standard
-
-\change_deleted 564990737 1669742044
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
+.
+ 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
-to state your present address, just use the standard footnote via the menu
-
-\family sans
-Insert\SpecialChar menuseparator
-Footnote.
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
+.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
-\family default
- \SpecialChar LyX
- will automagically use the term
-\family typewriter
+\begin_layout Plain Layout
+-g
+\end_layout
-\backslash
-thanks{}
-\family default
- in that case.
+\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
-\change_deleted 564990737 1669742044
-Under
-\family sans
-Edit\SpecialChar menuseparator
-Text Style
-\family default
-, you'll find two insets which are relevant for the titling:
+\begin_layout Section
+Forward search
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 564990737 1669742044
+opposite
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Institute
-\family typewriter
-
-\family default
-to mark corresponding author\SpecialChar breakableslash
-institute pairs.
- The institutes are numbered sequentially as they appear in the
-\family sans
-Address
-\family default
- field, so you have to put a marker to each author.
+ 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 Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+ (or select
+\begin_inset Flex Noun
+status collapsed
-\family sans
-Email
-\family default
- to supply an email address for fast contact.
+\begin_layout Plain Layout
+Forward search
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-In addition to these topics, the macros use one additional \SpecialChar LaTeX
- command that
- has no counterpart in \SpecialChar LyX
-:
+ 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 Itemize
+\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"
-\change_deleted 564990737 1669742044
+\end_inset
-\family typewriter
-
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+.
\end_layout
\begin_layout Standard
+Additionally, you need to configure \SpecialChar LyX
+ for using your viewers in
+\begin_inset Flex Noun
+status collapsed
-\change_deleted 564990737 1669742044
-The appropriate command has to be entered in \SpecialChar LyX
- and marked as \SpecialChar LaTeX
- code.
- See the examples.
-
-\end_layout
-
-\begin_layout Subsection
-
-\change_deleted 564990737 1669742044
-The abstract
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+General
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-The abstract should immediately follow the header block.
- With version 5 the abstract environment was changed to a command, and there
- is now a restriction to only one paragraph.
- In addition, it should contain an entry with the keywords.
- This is done via the paragraph style
-\family sans
-Keywords
-\family default
.
- Refer to the example paper.
+ 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 Subsection
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\change_deleted 564990737 1669742044
-Supported environments
+\begin_layout Plain Layout
+$$n
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669742044
-The A&A paper layout supports the following environments for structuring
- your text:
+: row number
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\change_deleted 564990737 1669742044
-
-\family sans
-Standard
+\begin_layout Plain Layout
+$$t
\end_layout
-\begin_layout Itemize
-
-\change_deleted 564990737 1669742044
+\end_inset
-\family sans
-Section
+: name of the (temporary) exported .tex file (without path)
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\change_deleted 564990737 1669742044
-
-\family sans
-Subsection
+\begin_layout Plain Layout
+$$f
\end_layout
-\begin_layout Itemize
-
-\change_deleted 564990737 1669742044
+\end_inset
-\family sans
-Subsubsection
+: name of the (temporary) exported .tex file (including path)
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\change_deleted 564990737 1669742044
-
-\family sans
-Itemize
+\begin_layout Plain Layout
+$$o
\end_layout
-\begin_layout Itemize
-
-\change_deleted 564990737 1669742044
+\end_inset
-\family sans
-Enumerate
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Note that only some of the viewers provide full and usable forward search
+ functionality out of the box, among them yap, xdvi, okular
+\begin_inset Foot
+status collapsed
-\change_deleted 564990737 1669742044
+\begin_layout Plain Layout
+You might want to set
+\begin_inset Flex Code
+status collapsed
-\family sans
-Description
+\begin_layout Plain Layout
+okular --unique
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+ in
+\begin_inset Flex Noun
+status collapsed
-\family sans
-Caption
+\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 Itemize
+\end_inset
-\change_deleted 564990737 1669742044
-\family sans
-Abstract
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+, qpdfview, and SumatraPDF
+\begin_inset Foot
+status collapsed
-\family sans
-Acknowledgment
-\end_layout
+\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"
+literal "false"
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
-\family sans
-Bibliography
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted 564990737 1669742044
+.
+ Others, such as evince
+\begin_inset Foot
+status collapsed
-\family sans
-\SpecialChar LaTeX
+\begin_layout Plain Layout
+Forward search with evince can be achieved by means of third party helper
+ scripts.
+ Please refer to
+\begin_inset CommandInset href
+LatexCommand href
+target "https://wiki.lyx.org/LyX/SyncTeX"
+literal "false"
+
+\end_inset
+ for details.
\end_layout
-\begin_layout Subsection
+\end_inset
-\change_deleted 564990737 1669742044
-Commands not supported by \SpecialChar LyX
+, require some extra tools in order to use forward search.
+ 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
-\end_layout
+g.
+ 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
-\begin_layout Standard
+near
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669742044
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
-\family default
- layout for \SpecialChar LyX
.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
+ This latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
\end_layout
-\begin_layout Itemize
-
-\change_deleted 564990737 1669742044
+\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
-\family typewriter
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
+\end_layout
-\backslash
-and
+\begin_layout Chapter
+Special Document Classes
\end_layout
-\begin_layout Itemize
+\begin_layout Section
\change_deleted 564990737 1669742044
-
-\family typewriter
-
-\backslash
-authorrunning
+A&A Paper
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
\change_deleted 564990737 1669742044
-
-\family typewriter
-
-\backslash
-object{}
+by
+\noun on
+Peter Sütterlin
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
\change_deleted 564990737 1669742044
-
-\family typewriter
-
-\backslash
-titlerunning{}
+Introduction
\end_layout
\begin_layout Standard
\change_deleted 564990737 1669742044
-If you want to use any of these commands, you have to enter them yourself.
-
-\series bold
-Do not forget to mark them as \SpecialChar LaTeX
- code!
+This section describes how \SpecialChar LyX
+ can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+https://www.aanda.org/
\end_layout
-\begin_layout Subsection
+\end_inset
-\change_deleted 564990737 1669742044
-Figure and Table Floats
+) using Version 5.01 of the document class
+\family typewriter
+aa.cls
+\family default
+.
+ This package can be downloaded from the ftp site
\end_layout
\begin_layout Standard
\change_deleted 564990737 1669742044
-\SpecialChar LyX
- provides support for the necessary float environments
-\family sans
-figure, figure*, table
-\family default
- and
-\family sans
-table*
-\family default
-, therefore we won't tell much about it here.
- Refer to the
-\emph on
-User's
-\begin_inset space ~
+\begin_inset VSpace medskip
\end_inset
-Guide
-\emph default
-.
- Just remember that tables should be left-aligned.
- For that, select the table and change the alignment in
-\family sans
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-Settings.
\end_layout
\begin_layout Standard
+\align center
\change_deleted 564990737 1669742044
-There is only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
-\end_layout
+\begin_inset Flex URL
+status collapsed
-\begin_layout Enumerate
+\begin_layout Plain Layout
+
+ftp://ftp.edpsciences.org/pub/aa/readme.html
+\end_layout
-\change_deleted 564990737 1669742044
-Create a wide figure float:
-\family sans
-Insert\SpecialChar menuseparator
-Float\SpecialChar menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-Span
-\begin_inset space ~
\end_inset
-columns
-\family default
-.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
\change_deleted 564990737 1669742044
-Enter your caption text.
-\end_layout
+\begin_inset VSpace medskip
+\end_inset
-\begin_layout Enumerate
-\change_deleted 564990737 1669742044
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
\change_deleted 564990737 1669742044
-Insert your figure
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but is merely a short guide in how to realize
+ the correct form of your paper.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
\change_deleted 564990737 1669742044
-Position the cursor behind the figure and insert a horizontal fill:
+Please note that the publisher of the journal was changed from Springer
+ to EDP Sciences starting January 1, 2001.
+ That change involved also some slight changes to the style files, namely
+ the removal of the thesaurus command.
+ The \SpecialChar LyX
+ class aa supports the newest version of these style files, V 5.01.
+ If you have an older version installed, please upgrade.
+ For compatibility, the old (version 4) layout has been kept as
\family sans
-Insert\SpecialChar menuseparator
-Special
-\begin_inset space ~
-\end_inset
-
-Character\SpecialChar menuseparator
-Horizontal
-\begin_inset space ~
-\end_inset
-
-Fill
+article (A&A V4)
+\family default
+.
+ Please refer to the comments in
+\family typewriter
+\SpecialChar LyX
+Dir/layouts/aapaper.layout
\family default
.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
\change_deleted 564990737 1669742044
-Switch to \SpecialChar LaTeX
- mode:
-\family sans
-M-c
-\begin_inset space ~
-\end_inset
+Getting started
+\end_layout
-t
-\family default
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+It is recommended you start from the example template distributed with \SpecialChar LyX
.
+ If you are not using a template, note the following settings:
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
\change_deleted 564990737 1669742044
-Enter
-\family typewriter
-
-\backslash
-parbox[b]{55mm}{
+Select
+\family sans
+article (A&A)
\family default
-.
-
-\series bold
-Do not close the brace!
+ in the
+\family sans
+Document\SpecialChar menuseparator
+Settings
+\family default
+ dialog (OK, that one was obvious).
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
\change_deleted 564990737 1669742044
-Position the cursor behind the caption text, switch to \SpecialChar LaTeX
- mode and insert
- the closing brace:
+Don't change the option
\family sans
-M-c
+Page
\begin_inset space ~
\end_inset
-t
+style
\family default
-
-\family typewriter
-}
+: Leave it set to
+\family sans
+default
\family default
.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_layout Standard
+\begin_layout Subsection
\change_deleted 564990737 1669742044
-Also, refer to the figures in the example paper.
+The header block
\end_layout
-\begin_layout Subsection
+\begin_layout Standard
\change_deleted 564990737 1669742044
-Referee layout
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\change_deleted 564990737 1669742044
-For submission, the paper has to be formated in a special double-spacing
- layout.
- For this purpose, you have to give the option
-\family typewriter
-referee
-\family default
- to the document class.
- This must be done using the custom class options field in the
+
\family sans
-Document\SpecialChar menuseparator
-Settings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
+Title
\family default
- there.
+: [required]
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
\change_deleted 564990737 1669742044
-The example paper
+
+\family sans
+Subtitle
+\family default
+: [optional]
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\change_deleted 564990737 1669742044
-The
+
\family sans
-Examples
+Author
\family default
- directory contains an example paper written with \SpecialChar LyX
-.
- It is the example paper from the original macro package, translated to
- \SpecialChar LyX
-.
- Use it for inspiration, and compare the original \SpecialChar LaTeX
- code with \SpecialChar LyX
- way of writing.
+: [required]
\end_layout
-\begin_layout Section
-AAS\SpecialChar TeX
+\begin_layout Itemize
-\end_layout
+\change_deleted 564990737 1669742044
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\family sans
+Address
+\family default
+: [required]
\end_layout
-\begin_layout Subsection
-Introduction
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-AAS\SpecialChar TeX
- is a set of macros produced by the American Astronomical Society to
- facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- \SpecialChar LyX
- has proven to be an excellent tool for generating these documents, especially
- given its equation, citation, and figure handling capabilities.
- \SpecialChar LyX
- requires version 5.0 (or higher) of these macros; preferably 6.0, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
-2.09 and are fundamentally
- incompatible with \SpecialChar LyX
-.
- The AAS\SpecialChar TeX
- package may be downloaded from the AAS\SpecialChar TeX
- Web site
+\change_deleted 564990737 1669742044
+
+\family sans
+Offprints
+\family default
+: [optional] if more than one author: whom to contact for offprint requests.
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+\change_deleted 564990737 1669742044
+\family sans
+Mail
+\family default
+: [optional] mail address for contacts.
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Flex URL
-status collapsed
+\begin_layout Itemize
-\begin_layout Plain Layout
+\change_deleted 564990737 1669742044
-https://aas.org/aastex/aastex-downloads
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
\end_layout
-\end_inset
+\begin_layout Standard
+\change_deleted 564990737 1669742044
+There is no need to issue the
+\family typewriter
+\backslash
+maketitle
+\family default
+ command, this is done automatically by \SpecialChar LyX
+ when the header is finished.
+ Although the order of the single header entries doesn't matter it is advised
+ to keep the above sequence, just to get the best optics and meets the layout
+ of the real document.
\end_layout
\begin_layout Standard
-\begin_inset VSpace medskip
+
+\change_deleted 564990737 1669742044
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
+to state your present address, just use the standard footnote via the menu
+
+\family sans
+Insert\SpecialChar menuseparator
+Footnote.
-\begin_layout Standard
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
-.
+\family default
\SpecialChar LyX
- will not reduce the need to figure out all the AAS\SpecialChar TeX
- commands, it will only
- reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported \SpecialChar LaTeX
- document conforms
- completely to the requirements of the journal to which you are submitting
- your paper.
-\end_layout
+ will automagically use the term
+\family typewriter
-\begin_layout Subsection
-Starting a New Paper
+\backslash
+thanks{}
+\family default
+ in that case.
\end_layout
\begin_layout Standard
-I strongly suggest that you start with the AAS\SpecialChar TeX
- template file.
- Click on
+
+\change_deleted 564990737 1669742044
+Under
\family sans
-File\SpecialChar menuseparator
-New from
+Edit\SpecialChar menuseparator
+Text Style
\family default
-
+, you'll find two insets which are relevant for the titling:
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family sans
-Template
-\family default
-, enter the new file name, then choose the
+Institute
\family typewriter
-aastex6.lyx
+
\family default
- template.
- This will show the most common fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
-\family typewriter
-<>
+to mark corresponding author\SpecialChar breakableslash
+institute pairs.
+ The institutes are numbered sequentially as they appear in the
+\family sans
+Address
\family default
-) with the correct information.
- Many of the AAS\SpecialChar TeX
- commands and environments can be implemented directly in
- \SpecialChar LyX
-, but some cannot.
- For commands such as these, the \SpecialChar LaTeX
- code must be entered directly and marked
- as such.
- Such commands are referred to as \SpecialChar TeX
- code, or Evil Red Text.
- I tried to minimize the amount of \SpecialChar TeX
- code needed in an AAS\SpecialChar TeX
- document.
+ field, so you have to put a marker to each author.
\end_layout
-\begin_layout Subsection
-Finishing Your Paper
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Email
+\family default
+ to supply an email address for fast contact.
\end_layout
\begin_layout Standard
-When the paper is finished to your satisfaction and previews/prints correctly,
- there are a few
-\begin_inset Quotes eld
-\end_inset
-
-postprocessing
-\begin_inset Quotes erd
-\end_inset
- actions which need to be done before you submit it to the journals.
-
+\change_deleted 564990737 1669742044
+In addition to these topics, the macros use one additional \SpecialChar LaTeX
+ command that
+ has no counterpart in \SpecialChar LyX
+:
\end_layout
-\begin_layout Enumerate
-Export your paper as a \SpecialChar LaTeX
- file (
-\family sans
-File\SpecialChar menuseparator
-Export\SpecialChar menuseparator
-\SpecialChar LaTeX
+\begin_layout Itemize
-\family default
-).
-
-\end_layout
+\change_deleted 564990737 1669742044
-\begin_layout Enumerate
-Edit the resulting
\family typewriter
-.tex
+
+\backslash
+and
\family default
- file with your favorite text editor
+ to separate different names for more than one author and institute, respectivel
+y.
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
-\family typewriter
+\begin_layout Standard
-\backslash
-documentclass
-\family default
- command
+\change_deleted 564990737 1669742044
+The appropriate command has to be entered in \SpecialChar LyX
+ and marked as \SpecialChar LaTeX
+ code.
+ See the examples.
+
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
+\begin_layout Subsection
-\backslash
-usepackage...{fontenc}
-\family default
- line if it appears (usually just after
-\family typewriter
+\change_deleted 564990737 1669742044
+The abstract
+\end_layout
-\backslash
-documentclass
-\family default
-}; also remove the
-\family typewriter
+\begin_layout Standard
-\backslash
-secnumdepth
+\change_deleted 564990737 1669742044
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a restriction to only one paragraph.
+ In addition, it should contain an entry with the keywords.
+ This is done via the paragraph style
+\family sans
+Keywords
\family default
- line if it appears.
+.
+ Refer to the example paper.
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
-\family typewriter
+\begin_layout Subsection
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+\change_deleted 564990737 1669742044
+Supported environments
+\end_layout
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the \SpecialChar LaTeX
- preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
-User specified \SpecialChar LaTeX
- commands
-\begin_inset Quotes erd
-\end_inset
+\change_deleted 564990737 1669742044
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
- comment in the
-\family typewriter
-.tex
-\family default
- file).
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Standard
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through \SpecialChar LaTeX
- to make sure it still processes correctly.
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Section
\end_layout
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Subsection
\end_layout
-\begin_layout Enumerate
-Submit it.
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Subsubsection
\end_layout
-\begin_layout Subsection
-Comments On Specific Commands
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Itemize
\end_layout
-\begin_layout Standard
-I will not describe the detailed usage of the individual AAS\SpecialChar TeX
- commands: the
- AAS\SpecialChar TeX
- User Guide (
-\family typewriter
-aasguide.tex
-\family default
-) gives a good description of each.
- Thus it's probably easiest for me to go down the list as found in the guide
- and offer comments where necessary.
- So let's begin \SpecialChar ldots
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+\family sans
+Enumerate
\end_layout
-\begin_layout Subsubsection
-Things that work as expected
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Description
\end_layout
-\begin_layout Standard
-Because they work as you might expect, I simply list them and the section
- they are found in:
-\family typewriter
+\begin_layout Itemize
-\backslash
-documentclass
-\family default
- (2.1.1),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-begin{document}
-\family default
- (2.2),
-\family typewriter
+\family sans
+Caption
+\end_layout
-\backslash
-title
-\family default
- (2.3),
-\family typewriter
+\begin_layout Itemize
-\backslash
-author
-\family default
- (2.3),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
+\family sans
+Abstract
+\end_layout
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
+\begin_layout Itemize
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
+\family sans
+Acknowledgment
+\end_layout
-\backslash
-subsection
-\family default
- (2.7),
-\family typewriter
+\begin_layout Itemize
-\backslash
-subsubsection
-\family default
- (2.7),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
+\family sans
+Bibliography
+\end_layout
-\backslash
-facility
-\family default
- (2.10),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{displaymath}
-\family default
- (2.12),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
+\family sans
+\SpecialChar LaTeX
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+\end_layout
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Subsection
-\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+\change_deleted 564990737 1669742044
+Commands not supported by \SpecialChar LyX
-\backslash
-bibitem
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+Some commands are not yet supported by the
+\family sans
+paper (A&A)
\family default
- (2.13.2), all the cite commands and their variations (2.13.2), the generic
- graphicx figure commands (2.14.1),
+ layout for \SpecialChar LyX
+.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-begin{table}
-\family default
- (2.15.4),
+and
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-begin{tabular}
-\family default
- (2.15.4),
+authorrunning
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-caption
-\family default
- (2.15.4),
+object{}
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+titlerunning{}
+\end_layout
-\backslash
-tablerefs
-\family default
- (2.15.5),
-\family typewriter
+\begin_layout Standard
-\backslash
-tablecomments
-\family default
- (2.15.5),
-\family typewriter
+\change_deleted 564990737 1669742044
+If you want to use any of these commands, you have to enter them yourself.
+
+\series bold
+Do not forget to mark them as \SpecialChar LaTeX
+ code!
+\end_layout
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+\begin_layout Subsection
-\backslash
-end{document}
-\family default
- (2.18).
+\change_deleted 564990737 1669742044
+Figure and Table Floats
\end_layout
\begin_layout Standard
-The following style options also work correctly:
-\family typewriter
-longabstract
-\family default
- (2.4),
-\family typewriter
-preprint
-\family default
- (3.2.1),
-\family typewriter
-preprint2
-\family default
- (3.2.2),
-\family typewriter
-eqsecnum
-\family default
- (3.3),
-\family typewriter
-flushrt
-\family default
- (3.4).
- Simply put them in the
+
+\change_deleted 564990737 1669742044
+\SpecialChar LyX
+ provides support for the necessary float environments
\family sans
-Options
+figure, figure*, table
\family default
- box in
+ and
\family sans
-Layout\SpecialChar menuseparator
-Document
+table*
\family default
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's
+\begin_inset space ~
+\end_inset
+
+Guide
+\emph default
.
-\end_layout
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
-\begin_layout Subsubsection
-Things that work, but require more comment
+Settings.
\end_layout
\begin_layout Standard
-The following items work, but require a little more discussion:
-\end_layout
-\begin_layout Itemize
-These items are reserved for use by the journal editors, but you can put
- them into the \SpecialChar LaTeX
- preamble if you feel compelled to do so:
-\family typewriter
+\change_deleted 564990737 1669742044
+There is only one special thing: the figures with caption besides the figure.
+ To create such a figure, you have to do the following:
+\end_layout
-\backslash
-received
-\family default
-,
-\family typewriter
+\begin_layout Enumerate
-\backslash
-revised
+\change_deleted 564990737 1669742044
+Create a wide figure float:
+\family sans
+Insert\SpecialChar menuseparator
+Float\SpecialChar menuseparator
+Figure
\family default
-,
-\family typewriter
+, then right click in the figure and select
+\family sans
+Span
+\begin_inset space ~
+\end_inset
-\backslash
-accepted
+columns
\family default
-,
-\family typewriter
+.
+\end_layout
-\backslash
-ccc
-\family default
-,
-\family typewriter
+\begin_layout Enumerate
-\backslash
-cpright
-\family default
- (all from 2.1.3)
+\change_deleted 564990737 1669742044
+Enter your caption text.
\end_layout
-\begin_layout Itemize
-These items may be placed in the \SpecialChar LaTeX
- preamble, and are included as blanks in
- the template file:
-\family typewriter
+\begin_layout Enumerate
-\backslash
-slugcomment
+\change_deleted 564990737 1669742044
+Press
+\family sans
+Return
\family default
- (2.1.4),
-\family typewriter
+ to move the cursor above the caption.
+\end_layout
-\backslash
-shorttitle
-\family default
- (2.1.5),
-\family typewriter
+\begin_layout Enumerate
-\backslash
-shortauthors
-\family default
- (2.1.5)
+\change_deleted 564990737 1669742044
+Insert your figure
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
-\backslash
-email
-\family default
- (2.3) – can only be used
-\begin_inset Quotes eld
+\change_deleted 564990737 1669742044
+Position the cursor behind the figure and insert a horizontal fill:
+\family sans
+Insert\SpecialChar menuseparator
+Special
+\begin_inset space ~
\end_inset
-standalone
-\begin_inset Quotes erd
+Character\SpecialChar menuseparator
+Horizontal
+\begin_inset space ~
\end_inset
-, not in the middle of a paragraph.
- Use \SpecialChar TeX
- code if you need to embed it.
+Fill
+\family default
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\family typewriter
+\change_deleted 564990737 1669742044
+Switch to \SpecialChar LaTeX
+ mode:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-and
+t
\family default
- (2.3) – will have extra {} after it.
- This should not cause an error.
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+\change_deleted 564990737 1669742044
+Enter
\family typewriter
\backslash
-notetoeditor
+parbox[b]{55mm}{
\family default
- (2.6) – can only be used
-\begin_inset Quotes eld
-\end_inset
-
-standalone
-\begin_inset Quotes erd
-\end_inset
-
-, not in the middle of a paragraph.
- Use \SpecialChar TeX
- code if you need to embed it.
+.
+
+\series bold
+Do not close the brace!
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\family typewriter
+\change_deleted 564990737 1669742044
+Position the cursor behind the caption text, switch to \SpecialChar LaTeX
+ mode and insert
+ the closing brace:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-placetable
+t
\family default
- (2.8) – can't insert a cross-reference tag, you must type the tag name by
- hand
+
+\family typewriter
+}
+\family default
+.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Standard
-\backslash
-placefigure
-\family default
- (2.8) – same as for
-\family typewriter
+\change_deleted 564990737 1669742044
+Also, refer to the figures in the example paper.
+\end_layout
-\backslash
-placetable
+\begin_layout Subsection
+
+\change_deleted 564990737 1669742044
+Referee layout
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\change_deleted 564990737 1669742044
+For submission, the paper has to be formated in a special double-spacing
+ layout.
+ For this purpose, you have to give the option
\family typewriter
-
-\backslash
-acknowledgements
+referee
\family default
- (2.9) – will have extra {} after it.
- This should not cause an error.
+ to the document class.
+ This must be done using the custom class options field in the
+\family sans
+Document\SpecialChar menuseparator
+Settings
+\family default
+ dialog.
+ Just enter the string
+\family typewriter
+referee
+\family default
+ there.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
-\family typewriter
+\change_deleted 564990737 1669742044
+The example paper
+\end_layout
-\backslash
-appendix
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+The
+\family sans
+Examples
\family default
- (2.11) – will have extra {} after it.
- This should not cause an error.
+ directory contains an example paper written with \SpecialChar LyX
+.
+ It is the example paper from the original macro package, translated to
+ \SpecialChar LyX
+.
+ Use it for inspiration, and compare the original \SpecialChar LaTeX
+ code with \SpecialChar LyX
+ way of writing.
\end_layout
-\begin_layout Itemize
+\begin_layout Section
+AAS\SpecialChar TeX
-\family typewriter
+\end_layout
-\backslash
-figcaption
-\family default
- (2.14.2) – you can insert an optional filename argument by placing the cursor
- at the beginning of the text and selecting
-\family sans
-Insert\SpecialChar menuseparator
-Short Title
-\family default
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+AAS\SpecialChar TeX
+ is a set of macros produced by the American Astronomical Society to
+ facilitate electronic manuscript submission to the three journals they
+ publish: the Astrophysical Journal (including the Letters and Supplement),
+ the Astronomical Journal, and the Publications of the Astronomical Society
+ of the Pacific.
+ \SpecialChar LyX
+ has proven to be an excellent tool for generating these documents, especially
+ given its equation, citation, and figure handling capabilities.
+ \SpecialChar LyX
+ requires version 5.0 (or higher) of these macros; preferably 6.0, which
+ is the version described here, or higher.
+ Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
+2.09 and are fundamentally
+ incompatible with \SpecialChar LyX
.
-
-\begin_inset Quotes eld
+ The AAS\SpecialChar TeX
+ package may be downloaded from the AAS\SpecialChar TeX
+ Web site
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
-Short Title
-\begin_inset Quotes erd
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+https://aas.org/aastex/aastex-downloads
+\end_layout
+
\end_inset
- inserts an optional argument of the type needed by
-\family typewriter
-\backslash
-figcaption
-\family default
-.
- Hopefully it will be renamed someday.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\family typewriter
-\backslash
-objectname
-\family default
- (2.17.1) – same as
-\family typewriter
+\end_layout
-\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
+\begin_layout Standard
+A complete user guide is contained in that package and you should familiarize
+ yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
+.
+ \SpecialChar LyX
+ will not reduce the need to figure out all the AAS\SpecialChar TeX
+ commands, it will only
+ reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported \SpecialChar LaTeX
+ document conforms
+ completely to the requirements of the journal to which you are submitting
+ your paper.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
+\begin_layout Standard
+I strongly suggest that you start with the AAS\SpecialChar TeX
+ template file.
+ Click on
+\family sans
+File\SpecialChar menuseparator
+New from
+\family default
+
+\family sans
+Template
+\family default
+, enter the new file name, then choose the
\family typewriter
-
-\backslash
-dataset
+aastex6.lyx
\family default
- (2.17.1) – same as
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-
-\backslash
-figcaption
+<>
\family default
- for the catalog ID optional parameter
+) with the correct information.
+ Many of the AAS\SpecialChar TeX
+ commands and environments can be implemented directly in
+ \SpecialChar LyX
+, but some cannot.
+ For commands such as these, the \SpecialChar LaTeX
+ code must be entered directly and marked
+ as such.
+ Such commands are referred to as \SpecialChar TeX
+ code, or Evil Red Text.
+ I tried to minimize the amount of \SpecialChar TeX
+ code needed in an AAS\SpecialChar TeX
+ document.
\end_layout
-\begin_layout Subsubsection
-Things not implemented, use \SpecialChar TeX
- code
+\begin_layout Subsection
+Finishing Your Paper
\end_layout
\begin_layout Standard
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+postprocessing
+\begin_inset Quotes erd
+\end_inset
+
+ actions which need to be done before you submit it to the journals.
+
+\end_layout
+
+\begin_layout Enumerate
+Export your paper as a \SpecialChar LaTeX
+ file (
+\family sans
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
-\backslash
-eqnum
\family default
- (2.12),
-\family typewriter
+).
+
+\end_layout
-\backslash
-setcounter{equation}
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
\family default
- (2.12), Journal name abbreviations (2.13.4),
+ file with your favorite text editor
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
\family typewriter
\backslash
-figurenum
+documentclass
\family default
- (2.14.1),
+ command
+\end_layout
+
+\begin_layout Enumerate
+remove the
\family typewriter
\backslash
-epsscale
+usepackage...{fontenc}
\family default
- (2.14.1),
+ line if it appears (usually just after
\family typewriter
\backslash
-plotone
+documentclass
\family default
- (2.14.1),
+}; also remove the
\family typewriter
\backslash
-plottwo
+secnumdepth
\family default
- (2.14.1),
+ line if it appears.
+\end_layout
+
+\begin_layout Enumerate
+remove everything between (and including) the
\family typewriter
\backslash
-tablenum
+makeatletter
\family default
- (2.15.4),
+ and
\family typewriter
\backslash
-tableline
+makeatother
\family default
- (2.15.4, insert it as the first element in the lefthand cell after where
- you want it.
- Don't use any of \SpecialChar LyX
-'s rules in the table),
+ commands, except for any commands you specifically put into the \SpecialChar LaTeX
+ preamble
+ (which should appear immediately after the
+\begin_inset Quotes eld
+\end_inset
+
+User specified \SpecialChar LaTeX
+ commands
+\begin_inset Quotes erd
+\end_inset
+
+ comment in the
\family typewriter
+.tex
+\family default
+ file).
+\end_layout
-\backslash
-tablenotemark
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through \SpecialChar LaTeX
+ to make sure it still processes correctly.
+\end_layout
+
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
+\end_layout
+
+\begin_layout Enumerate
+Submit it.
+\end_layout
+
+\begin_layout Subsection
+Comments On Specific Commands
+\end_layout
+
+\begin_layout Standard
+I will not describe the detailed usage of the individual AAS\SpecialChar TeX
+ commands: the
+ AAS\SpecialChar TeX
+ User Guide (
+\family typewriter
+aasguide.tex
\family default
- (2.15.5),
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar ldots
+
+\end_layout
+
+\begin_layout Subsubsection
+Things that work as expected
+\end_layout
+
+\begin_layout Standard
+Because they work as you might expect, I simply list them and the section
+ they are found in:
\family typewriter
\backslash
-tablenotetext
+documentclass
\family default
- (2.15.5), much of Misc (2.17, except
+ (2.1.1),
\family typewriter
\backslash
-objectname
+begin{document}
\family default
-,
+ (2.2),
\family typewriter
\backslash
-dataset
+title
\family default
-,
+ (2.3),
\family typewriter
\backslash
-url
+author
\family default
-, and
+ (2.3),
\family typewriter
\backslash
-email
+affil
\family default
-; see above),
+ (2.3),
\family typewriter
\backslash
-singlespace
+abstract
\family default
- (3.1),
+ (2.4),
\family typewriter
\backslash
-doublespace
+keywords
\family default
- (3.1),
+ (2.5),
\family typewriter
\backslash
-onecolumn
+section
\family default
- (3.2),
+ (2.7),
\family typewriter
\backslash
-twocolumn
+subsection
\family default
- (3.2)
-\end_layout
-
-\begin_layout Subsubsection
-Things that cannot be implemented
-\end_layout
+ (2.7),
+\family typewriter
-\begin_layout Standard
-\SpecialChar ldots
- at least in any meaningful sort of way, so I suggest ignoring them.
- They are the references environment (2.13.3), and the deluxetable environment
- (2.15).
- If you really, really need to use deluxetable, I suggest editing it in
- a separate file with a text editor, then using
-\family sans
-Insert\SpecialChar menuseparator
-Child
-\begin_inset space ~
-\end_inset
+\backslash
+subsubsection
+\family default
+ (2.7),
+\family typewriter
-Document
+\backslash
+paragraph
\family default
- to include it in your \SpecialChar LyX
- document.
- See the
+ (2.7),
\family typewriter
-aas_sample.lyx
+
+\backslash
+facility
\family default
- file to see an example of this.
-\end_layout
+ (2.10),
+\family typewriter
-\begin_layout Subsection
-FAQs, Tips, Tricks, and Other Ruminations
-\end_layout
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Subsubsection
-Getting \SpecialChar LyX
- and AAS\SpecialChar TeX
- to cooperate
-\end_layout
+\backslash
+begin{equation}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Standard
-It can be a bit tricky to get \SpecialChar LyX
- to recognize a new layout and document class.
- When all else fails, do this:
-\end_layout
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Enumerate
-Make certain that \SpecialChar LaTeX
- can find AAS\SpecialChar TeX
-.
- Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
- distribution into a
- directory completely unrelated to \SpecialChar LaTeX
- or AAS\SpecialChar TeX
- and run \SpecialChar LaTeX
- on
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
\family typewriter
-sample.tex
+
+\backslash
+begin{thebibliography}
\family default
-.
-\end_layout
+ (2.13.1),
+\family typewriter
-\begin_layout Enumerate
-Make certain that
+\backslash
+bibitem
+\family default
+ (2.13.2), all the cite commands and their variations (2.13.2), the generic
+ graphicx figure commands (2.14.1),
\family typewriter
-aastex.layout
+
+\backslash
+begin{table}
\family default
- appears in \SpecialChar LyX
-'s
+ (2.15.4),
\family typewriter
-layouts
+
+\backslash
+begin{tabular}
\family default
- folder
-\end_layout
+ (2.15.4),
+\family typewriter
-\begin_layout Enumerate
-Rerun
-\family sans
-Tools\SpecialChar menuseparator
-Reconfigure
+\backslash
+caption
\family default
- in \SpecialChar LyX
-, then restart \SpecialChar LyX
-.
-\end_layout
+ (2.15.4),
+\family typewriter
-\begin_layout Enumerate
-Open a regular new file, not from a template.
- Does AAS\SpecialChar TeX
- appear in the class list in
-\family sans
-Document\SpecialChar menuseparator
-Settings
+\backslash
+label
\family default
-?
-\end_layout
+ (2.15.4, amongst other places),
+\family typewriter
-\begin_layout Standard
-If you get a warning from an existing AAS\SpecialChar TeX
- document about not being able
- to find the AAS\SpecialChar TeX
- layout or a message about
-\begin_inset Quotes eld
-\end_inset
+\backslash
+tablerefs
+\family default
+ (2.15.5),
+\family typewriter
-You should not mix title layouts with normal ones
-\begin_inset Quotes erd
-\end_inset
+\backslash
+tablecomments
+\family default
+ (2.15.5),
+\family typewriter
-, things haven't been installed correctly.
-\end_layout
+\backslash
+url
+\family default
+ (2.17.4),
+\family typewriter
-\begin_layout Subsubsection
-\SpecialChar LaTeX
- error processing a table
+\backslash
+end{document}
+\family default
+ (2.18).
\end_layout
\begin_layout Standard
-\SpecialChar LyX
-, by default, attempts to center the table caption/title.
- This seems to produce a bad interaction in AAS\SpecialChar TeX
- so you should click somewhere
- in the caption/title, then select
-\family sans
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+The following style options also work correctly:
+\family typewriter
+longabstract
\family default
-, then set the
+ (2.4),
+\family typewriter
+preprint
+\family default
+ (3.2.1),
+\family typewriter
+preprint2
+\family default
+ (3.2.2),
+\family typewriter
+eqsecnum
+\family default
+ (3.3),
+\family typewriter
+flushrt
+\family default
+ (3.4).
+ Simply put them in the
\family sans
-Alignment
+Options
\family default
- to
+ box in
\family sans
-Block
+Layout\SpecialChar menuseparator
+Document
\family default
.
- This took care of it for me.
\end_layout
\begin_layout Subsubsection
-References
+Things that work, but require more comment
\end_layout
\begin_layout Standard
-A couple of things: 1) I have noticed some funny spacing in the reference
- entries in the text.
- When you enter the bibliography item data, make sure their is
-\emph on
-no
-\emph default
- space between the last author and the parenthesis setting off the year;
-
-\emph on
-e.
-\begin_inset space \thinspace{}
-\end_inset
+The following items work, but require a little more discussion:
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Itemize
+These items are reserved for use by the journal editors, but you can put
+ them into the \SpecialChar LaTeX
+ preamble if you feel compelled to do so:
+\family typewriter
+\backslash
+received
+\family default
+,
+\family typewriter
-\emph default
-type
+\backslash
+revised
+\family default
+,
\family typewriter
-Ressler(1992)
+
+\backslash
+accepted
\family default
-, not
+,
\family typewriter
-Ressler (1992)
+
+\backslash
+ccc
\family default
-.
- 2) Entering the references at all is not obvious.
- The easiest thing is to start typing your first reference at the end of
- the document, then mark it as type
-\family sans
-References
+,
+\family typewriter
+
+\backslash
+cpright
\family default
-.
- That will put a small gray box in front of what you just typed.
- Click on the box to fill in the rest of the information.
- For new references, go to the end of an existing reference and press return.
- That will create a new line with its own box, etc.
+ (all from 2.1.3)
\end_layout
-\begin_layout Subsubsection
-Including EPS files
-\end_layout
+\begin_layout Itemize
+These items may be placed in the \SpecialChar LaTeX
+ preamble, and are included as blanks in
+ the template file:
+\family typewriter
-\begin_layout Standard
-Even though AAS\SpecialChar TeX
- provides its own figure commands (
+\backslash
+slugcomment
+\family default
+ (2.1.4),
\family typewriter
\backslash
-plotone
+shorttitle
\family default
-, for example), I much prefer \SpecialChar LaTeX
-'s standard figure commands (with the default
- graphicx).
- You can insert the
+ (2.1.5),
\family typewriter
\backslash
-plotone
+shortauthors
\family default
-, etc.
-\begin_inset space ~
-\end_inset
+ (2.1.5)
+\end_layout
+
+\begin_layout Itemize
-commands as \SpecialChar TeX
- code into a Figure Float box if you desire, but I never have
- much luck getting the layout right.
- With the standard graphics, \SpecialChar LyX
- will insert a
\family typewriter
\backslash
-usepackage{graphicx}
+email
\family default
- command into the \SpecialChar LaTeX
- preamble and handle the figures in the standard \SpecialChar LaTeX2e
- way,
- interspersing the figures in the text.
- I believe ApJ accepts figures exactly this way now; AJ might still use
- the
+ (2.3) – can only be used
\begin_inset Quotes eld
\end_inset
-stack everything at the end
+standalone
\begin_inset Quotes erd
\end_inset
- technique.
+, not in the middle of a paragraph.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
-\begin_layout Subsubsection
-Things I could have done, but didn't
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Standard
-There are a few
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+notetoeditor
+\family default
+ (2.6) – can only be used
\begin_inset Quotes eld
\end_inset
-pretty
+standalone
\begin_inset Quotes erd
\end_inset
- things I could have implemented, but chose not to.
- For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
- window,
- even though it is double-spaced in the paper manuscript.
- Also, I chose not to make separate layouts for the preprint and preprint2
- styles.
- Since I assume you will spend most of your time in the plain manuscript
- mode anyway, I decided not to chew up more disk space with this.
-
+, not in the middle of a paragraph.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
-\begin_layout Subsection
-Final Caveat
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Your mileage may vary.
- I've now had papers published by both ApJ and AJ that have had 98% of the
- effort done in \SpecialChar LyX
-; the last 2% was the \SpecialChar LaTeX
- post-processing and a few cleanups.
- I have had no trouble with the submission process, and I'm sure the journals
- were never aware that there might be a difference.
- So, go forth and publish!
-\end_layout
+\family typewriter
-\begin_layout Section
-Broadway
+\backslash
+placetable
+\family default
+ (2.8) – can't insert a cross-reference tag, you must type the tag name by
+ hand
\end_layout
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Introduction
-\end_layout
+\family typewriter
-\begin_layout Standard
-Broadway is for writing plays.
- The format is more decorative than Hollywood, and much less standardized.
- This format should be suitable for workshops.
-\end_layout
-
-\begin_layout Subsection
-Special problems
-\end_layout
-
-\begin_layout Standard
-The same as in Hollywood.
-\end_layout
-
-\begin_layout Subsection
-Special features
-\end_layout
-
-\begin_layout Standard
-Insert the
-\family sans
-Speaker
+\backslash
+placefigure
\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
-\end_layout
-
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
-
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-
-\begin_layout Subsection
-Environments
-\end_layout
+ (2.8) – same as for
+\family typewriter
-\begin_layout Standard
-The following environments are available.
- You can use broadway.bind to get the bind keys shown at the right.
+\backslash
+placetable
\end_layout
\begin_layout Itemize
-\family sans
-Standard
-\begin_inset Newline newline
-\end_inset
-
+\family typewriter
+\backslash
+acknowledgements
\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
\end_layout
\begin_layout Itemize
-\family sans
-Narrative
-\begin_inset space \hfill{}
-\end_inset
-
-M-z n
-\begin_inset Newline newline
-\end_inset
-
+\family typewriter
+\backslash
+appendix
\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
\end_layout
\begin_layout Itemize
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ (2.14.2) – you can insert an optional filename argument by placing the cursor
+ at the beginning of the text and selecting
\family sans
-ACT
-\begin_inset space \hfill{}
+Insert\SpecialChar menuseparator
+Short Title
+\family default
+.
+
+\begin_inset Quotes eld
\end_inset
-M-z a
-\begin_inset Newline newline
+Short Title
+\begin_inset Quotes erd
\end_inset
+ inserts an optional argument of the type needed by
+\family typewriter
+\backslash
+figcaption
\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
+.
+ Hopefully it will be renamed someday.
\end_layout
\begin_layout Itemize
-\family sans
-ACT*
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S at
-\begin_inset Newline newline
-\end_inset
-
+\family typewriter
+\backslash
+objectname
\family default
-Subtitle for
-\family sans
-ACT.
+ (2.17.1) – same as
+\family typewriter
+\backslash
+figcaption
\family default
- It is just centered text.
+ for the catalog ID optional parameter
\end_layout
\begin_layout Itemize
-\family sans
-SCENE
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-S
-\begin_inset Newline newline
-\end_inset
+\family typewriter
+\backslash
+dataset
+\family default
+ (2.17.1) – same as
+\family typewriter
+\backslash
+figcaption
\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Things not implemented, use \SpecialChar TeX
+ code
+\end_layout
-\family sans
-AT_RISE:
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Standard
-M-z S-R
-\begin_inset Newline newline
-\end_inset
+\family typewriter
+\backslash
+eqnum
+\family default
+ (2.12),
+\family typewriter
+\backslash
+setcounter{equation}
\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
-\end_layout
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\begin_layout Itemize
+\backslash
+figurenum
+\family default
+ (2.14.1),
+\family typewriter
-\family sans
-Speaker
-\begin_inset space \hfill{}
-\end_inset
+\backslash
+epsscale
+\family default
+ (2.14.1),
+\family typewriter
-M-z s
-\begin_inset Newline newline
-\end_inset
+\backslash
+plotone
+\family default
+ (2.14.1),
+\family typewriter
+\backslash
+plottwo
+\family default
+ (2.14.1),
+\family typewriter
+\backslash
+tablenum
\family default
-The speaker's (actor's) title, centered in all CAPS.
-\end_layout
+ (2.15.4),
+\family typewriter
-\begin_layout Itemize
+\backslash
+tableline
+\family default
+ (2.15.4, insert it as the first element in the lefthand cell after where
+ you want it.
+ Don't use any of \SpecialChar LyX
+'s rules in the table),
+\family typewriter
-\family sans
-Parenthetical
-\begin_inset space \hfill{}
-\end_inset
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
+\family typewriter
-M-z p
-\begin_inset Newline newline
-\end_inset
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
+\backslash
+objectname
+\family default
+,
+\family typewriter
+\backslash
+dataset
\family default
-Instructions to the speaker.
- The parentheses are automatically inserted.
- The ( will appear on screen, but both will be in the printed play.
- This environment is only used within
-\family sans
-Dialogue
+,
+\family typewriter
+
+\backslash
+url
\family default
-.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Dialogue
-\begin_inset space \hfill{}
-\end_inset
-
-M-z d
-\begin_inset Newline newline
-\end_inset
+, and
+\family typewriter
+\backslash
+email
+\family default
+; see above),
+\family typewriter
+\backslash
+singlespace
\family default
-What the Speaker says.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-CURTAIN
-\begin_inset space \hfill{}
-\end_inset
+ (3.1),
+\family typewriter
-M-z S-C
-\begin_inset Newline newline
-\end_inset
+\backslash
+doublespace
+\family default
+ (3.1),
+\family typewriter
+\backslash
+onecolumn
+\family default
+ (3.2),
+\family typewriter
+\backslash
+twocolumn
\family default
-The curtain comes down.
+ (3.2)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Title
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-T
+\begin_layout Subsubsection
+Things that cannot be implemented
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+\SpecialChar ldots
+ at least in any meaningful sort of way, so I suggest ignoring them.
+ They are the references environment (2.13.3), and the deluxetable environment
+ (2.15).
+ If you really, really need to use deluxetable, I suggest editing it in
+ a separate file with a text editor, then using
\family sans
-Author
-\begin_inset space \hfill{}
+Insert\SpecialChar menuseparator
+Child
+\begin_inset space ~
\end_inset
-M-z S-A
+Document
+\family default
+ to include it in your \SpecialChar LyX
+ document.
+ See the
+\family typewriter
+aas_sample.lyx
+\family default
+ file to see an example of this.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Right_Address
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
+\end_layout
-M-z r
+\begin_layout Subsubsection
+Getting \SpecialChar LyX
+ and AAS\SpecialChar TeX
+ to cooperate
\end_layout
\begin_layout Standard
-Hello there.
+It can be a bit tricky to get \SpecialChar LyX
+ to recognize a new layout and document class.
+ When all else fails, do this:
\end_layout
-\begin_layout Section
-Dinbrief
+\begin_layout Enumerate
+Make certain that \SpecialChar LaTeX
+ can find AAS\SpecialChar TeX
+.
+ Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
+ distribution into a
+ directory completely unrelated to \SpecialChar LaTeX
+ or AAS\SpecialChar TeX
+ and run \SpecialChar LaTeX
+ on
+\family typewriter
+sample.tex
+\family default
+.
\end_layout
-\begin_layout Standard
-The document class
-\family sans
-dinbrief
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
\family default
- can be used to type letters according to German conventions.
- A template file is included in
+ appears in \SpecialChar LyX
+'s
\family typewriter
-.../lyx/share/templates
+layouts
\family default
- for you to use as a starting point.
-\end_layout
-
-\begin_layout Section
-Elsevier Journals
+ folder
\end_layout
-\begin_layout Standard
-See the \SpecialChar LyX
- template file
-\family typewriter
-elsarticle.lyx
+\begin_layout Enumerate
+Rerun
+\family sans
+Tools\SpecialChar menuseparator
+Reconfigure
\family default
+ in \SpecialChar LyX
+, then restart \SpecialChar LyX
.
- It contains all infos you need.
\end_layout
-\begin_layout Section
-Foils [aka
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AAS\SpecialChar TeX
+ appear in the class list in
\family sans
-Foil\SpecialChar TeX
-
+Document\SpecialChar menuseparator
+Settings
\family default
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:foiltex"
+?
+\end_layout
+\begin_layout Standard
+If you get a warning from an existing AAS\SpecialChar TeX
+ document about not being able
+ to find the AAS\SpecialChar TeX
+ layout or a message about
+\begin_inset Quotes eld
\end_inset
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
+\end_inset
+, things haven't been installed correctly.
\end_layout
-\begin_layout Standard
-by
-\noun on
-Allan Rae
-\end_layout
-
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection
+\SpecialChar LaTeX
+ error processing a table
\end_layout
\begin_layout Standard
-This section describes how to use \SpecialChar LyX
- to make slides for overhead projectors.
- There are two document classes that can do this: the default slides class
- and the
+\SpecialChar LyX
+, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AAS\SpecialChar TeX
+ so you should click somewhere
+ in the caption/title, then select
\family sans
-Foil\SpecialChar TeX
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+Settings
\family default
- slides class.
- This section documents the latter.
+, then set the
+\family sans
+Alignment
+\family default
+ to
+\family sans
+Block
+\family default
+.
+ This took care of it for me.
\end_layout
-\begin_layout Standard
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\begin_layout Subsubsection
+References
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+A couple of things: 1) I have noticed some funny spacing in the reference
+ entries in the text.
+ When you enter the bibliography item data, make sure their is
+\emph on
+no
+\emph default
+ space between the last author and the parenthesis setting off the year;
+
+\emph on
+e.
+\begin_inset space \thinspace{}
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
-\begin_inset Quotes eld
+g.
+\begin_inset space \space{}
\end_inset
+\emph default
+type
+\family typewriter
+Ressler(1992)
+\family default
+, not
+\family typewriter
+Ressler (1992)
+\family default
+.
+ 2) Entering the references at all is not obvious.
+ The easiest thing is to start typing your first reference at the end of
+ the document, then mark it as type
\family sans
-FoilTeX
+References
\family default
+.
+ That will put a small gray box in front of what you just typed.
+ Click on the box to fill in the rest of the information.
+ For new references, go to the end of an existing reference and press return.
+ That will create a new line with its own box, etc.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-
-\emph on
-only.
+\begin_layout Subsubsection
+Including EPS files
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+Even though AAS\SpecialChar TeX
+ provides its own figure commands (
+\family typewriter
+
+\backslash
+plotone
+\family default
+, for example), I much prefer \SpecialChar LaTeX
+'s standard figure commands (with the default
+ graphicx).
+ You can insert the
+\family typewriter
+
+\backslash
+plotone
+\family default
+, etc.
+\begin_inset space ~
+\end_inset
+
+commands as \SpecialChar TeX
+ code into a Figure Float box if you desire, but I never have
+ much luck getting the layout right.
+ With the standard graphics, \SpecialChar LyX
+ will insert a
+\family typewriter
+
+\backslash
+usepackage{graphicx}
+\family default
+ command into the \SpecialChar LaTeX
+ preamble and handle the figures in the standard \SpecialChar LaTeX2e
+ way,
+ interspersing the figures in the text.
+ I believe ApJ accepts figures exactly this way now; AJ might still use
+ the
+\begin_inset Quotes eld
+\end_inset
+
+stack everything at the end
+\begin_inset Quotes erd
\end_inset
+ technique.
+\end_layout
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
\begin_layout Standard
-If you're looking for the documentation for
+There are a few
\begin_inset Quotes eld
\end_inset
-
-\family sans
-slides (default)
-\family default
-
+pretty
\begin_inset Quotes erd
\end_inset
-, check out section
-\begin_inset space ~
-\end_inset
+ things I could have implemented, but chose not to.
+ For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
+ window,
+ even though it is double-spaced in the paper manuscript.
+ Also, I chose not to make separate layouts for the preprint and preprint2
+ styles.
+ Since I assume you will spend most of your time in the plain manuscript
+ mode anyway, I decided not to chew up more disk space with this.
+
+\end_layout
+\begin_layout Subsection
+Final Caveat
+\end_layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:slitex"
+\begin_layout Standard
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in \SpecialChar LyX
+; the last 2% was the \SpecialChar LaTeX
+ post-processing and a few cleanups.
+ I have had no trouble with the submission process, and I'm sure the journals
+ were never aware that there might be a difference.
+ So, go forth and publish!
+\end_layout
-\end_inset
+\begin_layout Section
+Broadway
+\end_layout
-.
- If your machine doesn't have the
-\family sans
-foils
-\family default
- class
-\family sans
-FoilTeX
-\family default
- installed, you'll probably have to use the default
-\family sans
-slides
-\family default
- class, which isn't quite as good as
-\family sans
-foils.
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
+
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-The
-\family sans
-foils
-\family default
- class is designed for use with version
-\begin_inset space ~
-\end_inset
+Broadway is for writing plays.
+ The format is more decorative than Hollywood, and much less standardized.
+ This format should be suitable for workshops.
+\end_layout
-2.1 of the
-\family sans
-foils.cls
-\family default
- \SpecialChar LaTeX
- class file which is now an integral part of \SpecialChar LaTeX2e
-.
+\begin_layout Subsection
+Special problems
+\end_layout
+
+\begin_layout Standard
+The same as in Hollywood.
\end_layout
\begin_layout Subsection
-Getting Started
+Special features
\end_layout
\begin_layout Standard
-Obviously, to use this document class, you need to select
-\family sans
-FoilTeX
-\family default
- from the
+Insert the
\family sans
-Class
+Speaker
\family default
- entry in the
-\family sans
-Document
-\begin_inset space ~
-\end_inset
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
+\end_layout
-Layout
-\family default
- dialog.
- There are some settings in the
-\family sans
-Document
-\begin_inset space ~
-\end_inset
+\begin_layout Subsection
+Paper size and Margins
+\end_layout
-Layout
-\family default
- dialog that you should know about that are specific to this class:
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
+
+\begin_layout Subsection
+Environments
+\end_layout
+
+\begin_layout Standard
+The following environments are available.
+ You can use broadway.bind to get the bind keys shown at the right.
\end_layout
\begin_layout Itemize
-Don't change the options
-\family sans
-Sides
-\family default
- and
-\family sans
-Columns
-\family default
- on the
+
\family sans
-Document
-\begin_inset space ~
+Standard
+\begin_inset Newline newline
\end_inset
-Layout
-\family default
- dialog.
- They're ignored by the
-\family sans
-foils
+
\family default
- class.
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
\end_layout
\begin_layout Itemize
-The default font size is 20
-\begin_inset space \thinspace{}
-\end_inset
-
-pt with the other options being 17
-\begin_inset space \thinspace{}
-\end_inset
-pt, 25
-\begin_inset space \thinspace{}
+\family sans
+Narrative
+\begin_inset space \hfill{}
\end_inset
-pt and 30
-\begin_inset space \thinspace{}
+M-z n
+\begin_inset Newline newline
\end_inset
-pt.
-\end_layout
-\begin_layout Itemize
-The default font is
-\family sans
-sans
-\family default
-
-\family sans
-serif
\family default
- but all math equations are still typeset in the usual roman font.
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
\end_layout
\begin_layout Itemize
\family sans
-Foil\SpecialChar TeX
+ACT
+\begin_inset space \hfill{}
+\end_inset
-\family default
- supports A4 and Letter paper sizes as well as a special size for working
- with 35
-\begin_inset space \thinspace{}
+M-z a
+\begin_inset Newline newline
\end_inset
-mm slides.
- It doesn't support A5, B5, legal or executive paper sizes.
+
+\family default
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
\end_layout
\begin_layout Itemize
-Don't bother changing the
+
\family sans
-Float Placement
-\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
-\end_layout
+ACT*
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S at
+\begin_inset Newline newline
+\end_inset
+
-\begin_layout Itemize
-The
-\family sans
-Pagestyle
\family default
- setting behaves a bit differently for this class.
-
+Subtitle for
\family sans
-Foil\SpecialChar TeX
+ACT.
\family default
- provides extensive footer and header capabilities including a user-defined
- logo.
- See section
-\begin_inset space ~
-\end_inset
+ It is just centered text.
+\end_layout
+\begin_layout Itemize
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:foilfoot"
+\family sans
+SCENE
+\begin_inset space \hfill{}
+\end_inset
+M-z S-S
+\begin_inset Newline newline
\end_inset
- for more details.
- The title page is treated differently to all other pages in the document
- and is
-\emph on
-always
-\emph default
- unnumbered and
-\emph on
-always
-\emph default
- has the logo centered at the bottom of the page (if one is defined).
- The possible page style choices and what they do are as follows:
+
+\family default
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
\end_layout
-\begin_deeper
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\family sans
-\series bold
-empty
+AT_RISE:
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-R
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-\series default
- The final output contains no page numbers, or other headers or footers
- (except footnotes of course).
-
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\family sans
-\series bold
-plain
-\family default
-\series default
- The final output contains page numbers centered at the bottom of the page.
- No other headings or footers (other than footnotes).
-\end_layout
+Speaker
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+M-z s
+\begin_inset Newline newline
+\end_inset
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
+
+\family default
+The speaker's (actor's) title, centered in all CAPS.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
-\series bold
-fancy
-\series default
- Gives you access to the
-\family sans
-fancyheadings
-\family default
- package although its use with
\family sans
-Foil\SpecialChar TeX
+Parenthetical
+\begin_inset space \hfill{}
+\end_inset
+
+M-z p
+\begin_inset Newline newline
+\end_inset
+
\family default
- is discouraged by the writer of the
+Instructions to the speaker.
+ The parentheses are automatically inserted.
+ The ( will appear on screen, but both will be in the printed play.
+ This environment is only used within
\family sans
-Foil\SpecialChar TeX
-
+Dialogue
\family default
- package because of some potential page layout clashes.
+.
\end_layout
-\end_deeper
-\begin_layout Subsubsection
-Extra Options
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-The following options may be used in the extra class options in the
\family sans
-Document\SpecialChar menuseparator
-Settings
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
+
+M-z d
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- dialog.
+What the Speaker says.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Itemize
-\series bold
-35mmSlide
-\series default
- This sets up the page layout for 7.33
-\begin_inset space \thinspace{}
+\family sans
+CURTAIN
+\begin_inset space \hfill{}
\end_inset
-in by 11
-\begin_inset space \thinspace{}
+M-z S-C
+\begin_inset Newline newline
\end_inset
-in paper, which is about the same aspect ratio as a 35
-\begin_inset space \thinspace{}
-\end_inset
-mm slide, making it a bit easier to work with this medium.
+\family default
+The curtain comes down.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Itemize
-\series bold
-headrule
-\series default
- Places a rule across the page below the header on every page except the
- title page.
+\family sans
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Itemize
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
+\family sans
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Itemize
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
-\family sans
-foils
-\family default
- document.
- This option tells
\family sans
-Foil\SpecialChar TeX
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\family default
- to use the dvips driver to rotate those pages that are set as landscape
- foils.
+M-z r
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Standard
+Hello there.
+\end_layout
-\series bold
-landscape
-\series default
- Simply changes the page dimensions to those of a landscape page but doesn't
- do any rotation.
- Thus if you use this option you need to use an external program to rotate
- each page or feed your paper through your printer as landscape.
- Note that this option effectively reverses the roles of the
+\begin_layout Section
+Dinbrief
+\end_layout
+
+\begin_layout Standard
+The document class
\family sans
-Foilhead
+dinbrief
\family default
- and
-\family sans
-Rotatefoilhead
+ can be used to type letters according to German conventions.
+ A template file is included in
+\family typewriter
+.../lyx/share/templates
\family default
- environments (don't worry these are described in the next section).
+ for you to use as a starting point.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
-
-\series bold
-leqno
-\series default
- Equation numbers on the left.
+\begin_layout Section
+Elsevier Journals
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Standard
+See the \SpecialChar LyX
+ template file
+\family typewriter
+elsarticle.lyx
+\family default
+.
+ It contains all infos you need.
+\end_layout
-\series bold
-fleqn
-\series default
- Flush-left equations.
+\begin_layout Section
+Foils [aka
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Allan Rae
\end_layout
\begin_layout Subsection
-Supported Environments
+Introduction
\end_layout
\begin_layout Standard
-Most of the environments commonly supported in other classes are also supported
- by the
-\family sans
-foils
-\family default
- class.
- There are several additional environments provided by
+This section describes how to use \SpecialChar LyX
+ to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
\family sans
Foil\SpecialChar TeX
\family default
- as well as a couple added by \SpecialChar LyX
-.
- The following environments are shared with other classes:
+ slides class.
+ This section documents the latter.
\end_layout
\begin_layout Standard
-\begin_inset Flex Multiple Columns
-status open
-
-\begin_layout Itemize
-
-\family sans
-Standard
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-\family sans
-Itemize
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
-\family sans
-Enumerate
-\end_layout
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Description
-\end_layout
+FoilTeX
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-List
+
+\emph on
+only.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-\family sans
-\SpecialChar LyX
--Code
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
+
\family sans
-Verse
-\end_layout
+slides (default)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Quote
-\end_layout
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Itemize
-\family sans
-Quotation
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
-\begin_layout Itemize
+\end_inset
+.
+ If your machine doesn't have the
\family sans
-TitleAuthor
+foils
+\family default
+ class
+\family sans
+FoilTeX
+\family default
+ installed, you'll probably have to use the default
+\family sans
+slides
+\family default
+ class, which isn't quite as good as
+\family sans
+foils.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The
+\family sans
+foils
+\family default
+ class is designed for use with version
+\begin_inset space ~
+\end_inset
+2.1 of the
\family sans
-Date
+foils.cls
+\family default
+ \SpecialChar LaTeX
+ class file which is now an integral part of \SpecialChar LaTeX2e
+.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Abstract
+\begin_layout Subsection
+Getting Started
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Obviously, to use this document class, you need to select
+\family sans
+FoilTeX
+\family default
+ from the
+\family sans
+Class
+\family default
+ entry in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog.
+ There are some settings in the
\family sans
-Bibliography
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
+\family default
+ dialog that you should know about that are specific to this class:
\end_layout
\begin_layout Itemize
+Don't change the options
+\family sans
+Sides
+\family default
+ and
+\family sans
+Columns
+\family default
+ on the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog.
+ They're ignored by the
\family sans
-Address
+foils
+\family default
+ class.
\end_layout
\begin_layout Itemize
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
-\family sans
-RightAddress
-\end_layout
+pt with the other options being 17
+\begin_inset space \thinspace{}
+\end_inset
+pt, 25
+\begin_inset space \thinspace{}
\end_inset
+pt and 30
+\begin_inset space \thinspace{}
+\end_inset
+pt.
\end_layout
-\begin_layout Standard
-That is, all the major environments apart from the sectioning environments.
- Since foils are essentially self-contained sections, with a title and body,
+\begin_layout Itemize
+The default font is
+\family sans
+sans
+\family default
\family sans
-Foil\SpecialChar TeX
-
+serif
\family default
- provides specific commands for starting new foils and these are:
+ but all math equations are still typeset in the usual roman font.
\end_layout
\begin_layout Itemize
\family sans
-Foilhead
-\end_layout
+Foil\SpecialChar TeX
-\begin_layout Itemize
+\family default
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
-\family sans
-Rotatefoilhead
+mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- also provides slightly modified versions of these two environments called:
+\begin_layout Itemize
+Don't bother changing the
+\family sans
+Float Placement
+\family default
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
+The
+\family sans
+Pagestyle
+\family default
+ setting behaves a bit differently for this class.
+
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
+
+\end_inset
+
+ for more details.
+ The title page is treated differently to all other pages in the document
+ and is
+\emph on
+always
+\emph default
+ unnumbered and
+\emph on
+always
+\emph default
+ has the logo centered at the bottom of the page (if one is defined).
+ The possible page style choices and what they do are as follows:
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
\family sans
-ShortFoilhead
+\series bold
+empty
+\family default
+\series default
+ The final output contains no page numbers, or other headers or footers
+ (except footnotes of course).
+
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
\family sans
-ShortRotatefoilhead
+\series bold
+plain
+\family default
+\series default
+ The final output contains page numbers centered at the bottom of the page.
+ No other headings or footers (other than footnotes).
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+
+\series bold
+foilheadings
+\series default
+ Page numbers in lower right corner.
+ Additional headers and footers are also shown.
+ This is also the default.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+
+\series bold
+fancy
+\series default
+ Gives you access to the
+\family sans
+fancyheadings
+\family default
+ package although its use with
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ is discouraged by the writer of the
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ package because of some potential page layout clashes.
+\end_layout
+
+\end_deeper
+\begin_layout Subsubsection
+Extra Options
\end_layout
\begin_layout Standard
-and the differences will be explained in the next section.
+The following options may be used in the extra class options in the
+\family sans
+Document\SpecialChar menuseparator
+Settings
+\family default
+ dialog.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+35mmSlide
+\series default
+ This sets up the page layout for 7.33
+\begin_inset space \thinspace{}
+\end_inset
+
+in by 11
+\begin_inset space \thinspace{}
+\end_inset
+
+in paper, which is about the same aspect ratio as a 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slide, making it a bit easier to work with this medium.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+headrule
+\series default
+ Places a rule across the page below the header on every page except the
+ title page.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+footrule
+\series default
+ Places a rule across the page above the footer on every page except the
+ title page.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
+\family sans
+foils
+\family default
+ document.
+ This option tells
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ to use the dvips driver to rotate those pages that are set as landscape
+ foils.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+landscape
+\series default
+ Simply changes the page dimensions to those of a landscape page but doesn't
+ do any rotation.
+ Thus if you use this option you need to use an external program to rotate
+ each page or feed your paper through your printer as landscape.
+ Note that this option effectively reverses the roles of the
+\family sans
+Foilhead
+\family default
+ and
+\family sans
+Rotatefoilhead
+\family default
+ environments (don't worry these are described in the next section).
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+leqno
+\series default
+ Equation numbers on the left.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+fleqn
+\series default
+ Flush-left equations.
+\end_layout
+
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Standard
-Since foils are often used in presenting ideas or new theorems and such
-
+Most of the environments commonly supported in other classes are also supported
+ by the
+\family sans
+foils
+\family default
+ class.
+ There are several additional environments provided by
\family sans
Foil\SpecialChar TeX
\family default
- also provides a comprehensive box of goodies for presenting them:
+ as well as a couple added by \SpecialChar LyX
+.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
\begin_layout Itemize
\family sans
-Theorem
+Standard
\end_layout
\begin_layout Itemize
\family sans
-Lemma
+Itemize
\end_layout
\begin_layout Itemize
\family sans
-Corollary
+Enumerate
\end_layout
\begin_layout Itemize
\family sans
-Proposition
+Description
\end_layout
\begin_layout Itemize
\family sans
-Definition
+List
\end_layout
\begin_layout Itemize
\family sans
-Proof
+\SpecialChar LyX
+-Code
\end_layout
\begin_layout Itemize
\family sans
-Theorem*
+Verse
\end_layout
\begin_layout Itemize
\family sans
-Lemma*
+Quote
\end_layout
\begin_layout Itemize
\family sans
-Corollary*
+Quotation
\end_layout
\begin_layout Itemize
\family sans
-Proposition*
+TitleAuthor
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Date
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Abstract
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Address
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+RightAddress
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+That is, all the major environments apart from the sectioning environments.
+ Since foils are essentially self-contained sections, with a title and body,
+
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ provides specific commands for starting new foils and these are:
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Foilhead
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Rotatefoilhead
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ also provides slightly modified versions of these two environments called:
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+ShortFoilhead
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+ShortRotatefoilhead
+\end_layout
+
+\begin_layout Standard
+and the differences will be explained in the next section.
+\end_layout
+
+\begin_layout Standard
+Since foils are often used in presenting ideas or new theorems and such
+
+\family sans
+Foil\SpecialChar TeX
+
+\family default
+ also provides a comprehensive box of goodies for presenting them:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Itemize
+
+\family sans
+Theorem
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Lemma
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Corollary
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Proposition
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Definition
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Proof
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Theorem*
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Lemma*
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Corollary*
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Proposition*
\end_layout
\begin_layout Itemize
\begin_layout Standard
by
\shape smallcaps
-Garst Reese
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-Getting the format of a Hollywood script right is a
-\begin_inset Quotes eld
-\end_inset
-
-rite of passage.
-\begin_inset Quotes erd
-\end_inset
-
- It is designed to make the readers focus on content and to be easy and
- familiar for the actors to read.
- Each page of a script should be one minute of film.
- Nothing goes in a script that you cannot see or hear on screen.
- The courier 12 pt font should be used throughout.
- No italics.
-\end_layout
-
-\begin_layout Subsection
-Special problems
-\end_layout
-
-\begin_layout Standard
-Speakers' lines should NEVER break in mid-sentence.
- If a speaker's lines continue over a page break, repeat the
-\family sans
-Speaker
-\family default
- title followed by (Cont'd).
-\end_layout
-
-\begin_layout Subsection
-Special features
-\end_layout
-
-\begin_layout Standard
-Insert the
-\family sans
-Speaker
-\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
- You can use this to insert the speaker name in narratives also.
-\end_layout
-
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
-
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-
-\begin_layout Subsection
-Environments
-\end_layout
-
-\begin_layout Standard
-The following environments are available.
- You can use hollywood.bind to get the bind keys shown at the right.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Standard
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-Used where nothing else works.
- Try to avoid it.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-FADE_IN
-\family default
-:
-\begin_inset space \hfill{}
-\end_inset
-
-
-\family sans
-M-z S-I
-\family default
-
-\begin_inset Newline newline
-\end_inset
-
-Usually followed by something like
-\begin_inset Quotes eld
-\end_inset
-
-on Sally waking up.
-\begin_inset Quotes erd
-\end_inset
-
-
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-INT:
-\begin_inset space \hfill{}
-\end_inset
-
-M-z i
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-Introduces a new INTERIOR camera set-up.
- Always followed by DAY or NIGHT, or something similar to define the lighting
- required.
- Everthing on this line in CAPS.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-EXT:
-\begin_inset space \hfill{}
-\end_inset
-
-M-z e
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-Introduces a new EXTERIOR camera set-up.
- Everthing on this line in CAPS.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Speaker
-\begin_inset space \hfill{}
-\end_inset
-
-M-z s
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-The character speaking.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Parenthetical
-\begin_inset space \hfill{}
-\end_inset
-
-M-z p
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-Instructions to the speaker.
- The () are automatically inserted.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Dialogue
-\begin_inset space \hfill{}
-\end_inset
-
-M-z d
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-What the
-\family sans
-Speaker
-\family default
- says.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Transition
-\begin_inset space \hfill{}
-\end_inset
-
-M-z t
-\begin_inset Newline newline
-\end_inset
-
-
-\family default
-Camera movement instruction.
- e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-CUT TO:
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-FADE OUT:
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-I
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Author
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-A
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Title
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-T
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Right_Address
-\begin_inset space \hfill{}
-\end_inset
-
-M-z r
-\end_layout
-
-\begin_layout Subsection
-Script jargon
-\end_layout
-
-\begin_layout Itemize
-(O.S) — off screen
-\end_layout
-
-\begin_layout Itemize
-(V.0) — voice over
-\end_layout
-
-\begin_layout Itemize
-b.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
- — background
-\end_layout
-
-\begin_layout Itemize
-C.U.
- — close-up
-\end_layout
-
-\begin_layout Itemize
-PAN — camera movement
-\end_layout
-
-\begin_layout Itemize
-INSERT — cut to close-up of
-\end_layout
-
-\begin_layout Section
-
-\change_deleted 564990737 1669755802
-ijmpc and ijmpd
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted 564990737 1669755802
-by
-\noun on
-Panayotis Papasotiriou
-\end_layout
-
-\begin_layout Subsection
-
-\change_deleted 564990737 1669755802
-Overview
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted 564990737 1669755802
-The ijmpc package is a set of macros that facilitates electronic manuscript
- submission to the
-\emph on
-International Journal of Modern Physics C
-\emph default
-.
- Similarly, the ijmpd package is for creating manuscripts to be submitted
- to the
-\emph on
-International Journal of Modern Physics D
-\emph default
-.
- Both journals are published by World Scientific.
- The corresponding document classes are named
-\family typewriter
-ws-ijmpc.cls
-\family default
- and
-\family typewriter
-ws-ijmpd.cls
-\family default
-, respectively.
- These files, together with instructions for the authors, can be downloaded
- from the sites
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
-\end_layout
-
-\end_inset
-
-.
- Both packages are modified versions of the standard
-\begin_inset Quotes eld
-\end_inset
-
-article
-\begin_inset Quotes erd
-\end_inset
-
- package, and they are almost (but not exactly) identical.
- Most of their features are supported by \SpecialChar LyX
-.
- I have used \SpecialChar LyX
- successfully to write articles submitted to both journals
- without any problem.
-\end_layout
-
-\begin_layout Subsection
-
-\change_deleted 564990737 1669755802
-Writing a paper
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted 564990737 1669755802
-As usual, the easiest way to write a paper is to start with a template.
- Click on
-\family sans
-File\SpecialChar menuseparator
-New from
-\family default
-
-\family sans
-Template
-\family default
-, then choose the
-\family typewriter
-ijmpc.lyx
-\family default
- or
-\family typewriter
-ijmpd.lyx
-\family default
- template.
- This will give an (almost) empty document that includes the most common
- fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
-\family typewriter
-<>
-\family default
-) with your text.
- You should keep in mind the following remarks.
-\end_layout
-
-\begin_layout Enumerate
-
-\change_deleted 564990737 1669755802
-\SpecialChar LyX
- won't let you change the font size and the page style of the document,
- because such modifications are not allowed by both packages.
-\end_layout
-
-\begin_layout Enumerate
-
-\change_deleted 564990737 1669755802
-The language of the document should not be changed.
- Before previewing your paper, be sure that the babel package is not used.
- To do this, click on
-\begin_inset Info
-type "menu"
-arg "dialog-show document"
-\end_inset
-
-
-\family sans
-\SpecialChar menuseparator
-Language
-\family default
-, and select
-\begin_inset Quotes eld
-\end_inset
-
-None
-\begin_inset Quotes erd
-\end_inset
-
- as
-\family sans
-Language Package
-\family default
-.
+Garst Reese
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
+Introduction
+\end_layout
-\change_deleted 564990737 1669755802
-The
+\begin_layout Standard
+Getting the format of a Hollywood script right is a
\begin_inset Quotes eld
\end_inset
-Keywords
+rite of passage.
\begin_inset Quotes erd
\end_inset
- style must be used to define keywords.
+ It is designed to make the readers focus on content and to be easy and
+ familiar for the actors to read.
+ Each page of a script should be one minute of film.
+ Nothing goes in a script that you cannot see or hear on screen.
+ The courier 12 pt font should be used throughout.
+ No italics.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
+Special problems
+\end_layout
-\change_deleted 564990737 1669755802
-The ijmpc package provides a style named
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+Speakers' lines should NEVER break in mid-sentence.
+ If a speaker's lines continue over a page break, repeat the
+\family sans
+Speaker
+\family default
+ title followed by (Cont'd).
+\end_layout
-Classification Codes
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Special features
+\end_layout
-, which can be used to define classification codes, such as PACS numbers.
- Note that this facility is not supported by the ijmpd package.
+\begin_layout Standard
+Insert the
+\family sans
+Speaker
+\family default
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
+ You can use this to insert the speaker name in narratives also.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
+Paper size and Margins
+\end_layout
-\change_deleted 564990737 1669755802
-Several new environments are available:
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
-Definition
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Environments
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+The following environments are available.
+ You can use hollywood.bind to get the bind keys shown at the right.
+\end_layout
-Step
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
+\family sans
+Standard
+\begin_inset Newline newline
\end_inset
-Example
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family default
+Used where nothing else works.
+ Try to avoid it.
+\end_layout
-Remark
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
+\family sans
+FADE_IN
+\family default
+:
+\begin_inset space \hfill{}
\end_inset
-Notation
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+M-z S-I
+\family default
-Theorem
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
-,
+Usually followed by something like
\begin_inset Quotes eld
\end_inset
-Proof
+on Sally waking up.
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Corollary
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Lemma
-\begin_inset Quotes erd
+\family sans
+INT:
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
+M-z i
+\begin_inset Newline newline
\end_inset
-Proposition
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family default
+Introduces a new INTERIOR camera set-up.
+ Always followed by DAY or NIGHT, or something similar to define the lighting
+ required.
+ Everthing on this line in CAPS.
+\end_layout
-Prop
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
+\family sans
+EXT:
+\begin_inset space \hfill{}
\end_inset
-Question
-\begin_inset Quotes erd
+M-z e
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Claim
-\begin_inset Quotes erd
-\end_inset
+\family default
+Introduces a new EXTERIOR camera set-up.
+ Everthing on this line in CAPS.
+\end_layout
-, and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Conjecture
-\begin_inset Quotes erd
+\family sans
+Speaker
+\begin_inset space \hfill{}
\end_inset
-.
- Their use is more or less obvious.
- \SpecialChar LyX
- supports all these environments; it will use the proper label, text style,
- and numbering scheme for each of them.
-\end_layout
+M-z s
+\begin_inset Newline newline
+\end_inset
-\begin_layout Enumerate
-\change_deleted 564990737 1669755802
-Both packages use basic citations; the natbib package should not be used.
- In \SpecialChar LyX
-, citation references are shown as usual; in the output, citations are
- shown as superscripts.
- If you want to use a citation as normal text, you should use the
-\family typewriter
-refcite
\family default
- command, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
+The character speaking.
+\end_layout
+\begin_layout Itemize
-\begin_inset Quotes eld
+\family sans
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-See Ref.
-\begin_inset space \space{}
+M-z p
+\begin_inset Newline newline
\end_inset
-\family typewriter
-
-\backslash
-refcite{key}
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+Instructions to the speaker.
+ The () are automatically inserted.
\end_layout
-\begin_layout Enumerate
-
-\change_deleted 564990737 1669755802
-There is no
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Acknowledgments
-\begin_inset Quotes erd
+\family sans
+Dialogue
+\begin_inset space \hfill{}
\end_inset
- section in both packages.
- To put acknowledgments, just use the
-\begin_inset Quotes eld
+M-z d
+\begin_inset Newline newline
\end_inset
-Section*
-\begin_inset Quotes erd
-\end_inset
- environment.
+\family default
+What the
+\family sans
+Speaker
+\family default
+ says.
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-\change_deleted 564990737 1669755802
-Appendices may be added to the paper,
-\emph on
-after
-\emph default
- the Acknowledgments and
-\shape italic
-before
-\shape default
- the References.
- \SpecialChar LyX
- provides a special environment, called
-\begin_inset Quotes eld
+\family sans
+Transition
+\begin_inset space \hfill{}
\end_inset
-Appendices Section
-\begin_inset Quotes erd
+M-z t
+\begin_inset Newline newline
\end_inset
- which marks the beginning of the appendices.
- This environment should be left blank; it just sends a \SpecialChar LaTeX
- command, but nothing
- is really printed.
- In \SpecialChar LyX
-, the word
-\begin_inset Quotes eld
-\end_inset
-Appendix
-\begin_inset Quotes erd
+\family default
+Camera movement instruction.
+ e.
+\begin_inset space \thinspace{}
\end_inset
- is printed with blue letters, as a signal that all sections after that
- point are appendices.
- To write an appendix, use the
-\begin_inset Quotes eld
+g.
+\begin_inset space \space{}
\end_inset
-Appendix
-\begin_inset Quotes erd
-\end_inset
+CUT TO:
+\end_layout
- environment.
- \SpecialChar LyX
- will number each appendix with capital letters, as required by both journals.
- Note that
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Appendices Section
-\begin_inset Quotes erd
+\family sans
+FADE OUT:
+\begin_inset space \hfill{}
\end_inset
-
-\emph on
-must
-\emph default
- be present before the first appendix; if not, all appendices will be numbered
- as normal sections in the output.
+M-z S-I
\end_layout
-\begin_layout Enumerate
-
-\change_deleted 564990737 1669755802
-The ijmpc and the ijmpd packages use the
-\family typewriter
-tbl
-\family default
- command to implement table captions.
- As a result, a table created by \SpecialChar LyX
- is printed correctly, but its caption
- is ignored.
- However, you can use some \SpecialChar TeX
- code to overcome this problem, so that captions
- are printed as expected.
- To do so, create a float table as usual, remove the caption, and replace
- it with the \SpecialChar TeX
- code
-\family typewriter
+\begin_layout Itemize
-\backslash
-tbl{
-\emph on
-your table caption
-\emph default
-}{
-\family default
- (sic); you must also the \SpecialChar TeX
- code
-\family typewriter
-}
-\family default
- immediately after the tabular material.
- Study the example table included in the template files to see how this
- trick is implemented.
- Alternatively, If you need table captions, you should implement the whole
- table float in a
-\family typewriter
-.tex
-\family default
- file, then include this file to the \SpecialChar LyX
- document (
\family sans
-Insert\SpecialChar menuseparator
-File\SpecialChar menuseparator
-Child
-\begin_inset space ~
+Author
+\begin_inset space \hfill{}
\end_inset
-Document
-\family default
-).
- Details on how to create a table float can be found in the files
-\family typewriter
-ws-ijmpc.tex
-\family default
- and
-\family typewriter
-ws-ijmpd.tex
-\family default
-, included in the corresponding packages.
+M-z S-A
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-\change_deleted 564990737 1669755802
-Preparing a paper for submission
+\family sans
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-\change_deleted 564990737 1669755802
-Before you submit your paper you must export the \SpecialChar LyX
- document as a \SpecialChar LaTeX
- file (
\family sans
-File\SpecialChar menuseparator
-Export\SpecialChar menuseparator
-\SpecialChar LaTeX
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\family default
-)
-\begin_inset Foot
-status open
+M-z r
+\end_layout
-\begin_layout Plain Layout
-Actually you have the choice between \SpecialChar LaTeX
- (plain) and pdflatex.
- If you intend to use pdflatex to prepare the paper, you should use the
- pdflatex option so that included graphics are converted to PDF format,
- ready for use by pdflatex.
+\begin_layout Subsection
+Script jargon
\end_layout
-\end_inset
+\begin_layout Itemize
+(O.S) — off screen
+\end_layout
-, then make the following changes to the resulting
-\family typewriter
-.tex
-\family default
- file.
+\begin_layout Itemize
+(V.0) — voice over
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
+b.
+\begin_inset space \thinspace{}
+\end_inset
-\change_deleted 564990737 1669755802
-Remove the comment lines before the
-\family typewriter
+g.
+ — background
+\end_layout
-\backslash
-documentclass
-\family default
- command.
+\begin_layout Itemize
+C.U.
+ — close-up
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
+PAN — camera movement
+\end_layout
-\change_deleted 564990737 1669755802
-Remove everything between (and including) the
-\family typewriter
+\begin_layout Itemize
+INSERT — cut to close-up of
+\end_layout
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+\begin_layout Section
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the \SpecialChar LaTeX
- preamble.
+\change_deleted 564990737 1669755802
+ijmpc and ijmpd
\end_layout
\begin_layout Standard
\change_deleted 564990737 1669755802
-The modified
-\family typewriter
-.tex
-\family default
- file should be saved and processed through \SpecialChar LaTeX
- as many times as necessary.
- You may also want to check the resulting
-\family typewriter
-.dvi
-\family default
- document.
-\change_unchanged
-
+by
+\noun on
+Panayotis Papasotiriou
\end_layout
-\begin_layout Section
+\begin_layout Subsection
-\change_deleted 564990737 1669801478
-iopart
+\change_deleted 564990737 1669755802
+Overview
\end_layout
\begin_layout Standard
-\change_deleted 564990737 1669801478
-by
-\noun on
-Uwe Stöhr
-\end_layout
+\change_deleted 564990737 1669755802
+The ijmpc package is a set of macros that facilitates electronic manuscript
+ submission to the
+\emph on
+International Journal of Modern Physics C
+\emph default
+.
+ Similarly, the ijmpd package is for creating manuscripts to be submitted
+ to the
+\emph on
+International Journal of Modern Physics D
+\emph default
+.
+ Both journals are published by World Scientific.
+ The corresponding document classes are named
+\family typewriter
+ws-ijmpc.cls
+\family default
+ and
+\family typewriter
+ws-ijmpd.cls
+\family default
+, respectively.
+ These files, together with instructions for the authors, can be downloaded
+ from the sites
+\begin_inset Flex URL
+status collapsed
-\begin_layout Subsection
+\begin_layout Plain Layout
-\change_deleted 564990737 1669801478
-Overview
+http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted 564990737 1669801478
-The iopart package provides a document class to create electronic manuscript
- submission to the journals published by the Institute of Physics.
- Instructions for the authors how to create a paper using the iopart class
- can be downloaded together with the iopart package from the site
+ and
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-ftp://ftp.iop.org/pub/journals/latex2e
+http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
\end_layout
\end_inset
.
+ Both packages are modified versions of the standard
+\begin_inset Quotes eld
+\end_inset
+
+article
+\begin_inset Quotes erd
+\end_inset
+
+ package, and they are almost (but not exactly) identical.
+ Most of their features are supported by \SpecialChar LyX
+.
+ I have used \SpecialChar LyX
+ successfully to write articles submitted to both journals
+ without any problem.
\end_layout
\begin_layout Subsection
-\change_deleted 564990737 1669801478
+\change_deleted 564990737 1669755802
Writing a paper
\end_layout
\begin_layout Standard
-\change_deleted 564990737 1669801478
-The easiest way to write a paper is to start with the template
-\emph on
-IOP-article.lyx
-\emph default
- that is available via
+\change_deleted 564990737 1669755802
+As usual, the easiest way to write a paper is to start with a template.
+ Click on
\family sans
File\SpecialChar menuseparator
-New From Template
+New from
\family default
- The template explains how to use the special text environments.
- Here are the most important advices:
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted 564990737 1669801478
-To be able to compile your document to a PDF, PS, or DVI, ensure that the
- no AMS packages are loaded in
+
\family sans
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Math Options
+Template
\family default
-!
+, then choose the
+\family typewriter
+ijmpc.lyx
+\family default
+ or
+\family typewriter
+ijmpd.lyx
+\family default
+ template.
+ This will give an (almost) empty document that includes the most common
+ fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
+\family typewriter
+<>
+\family default
+) with your text.
+ You should keep in mind the following remarks.
\end_layout
-\begin_layout Itemize
-
-\change_deleted 564990737 1669801478
+\begin_layout Enumerate
-\size normal
-The title environment defines the kind of your paper.
- So use one of the following environments for the title:
+\change_deleted 564990737 1669755802
+\SpecialChar LyX
+ won't let you change the font size and the page style of the document,
+ because such modifications are not allowed by both packages.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Enumerate
-\change_deleted 564990737 1669801478
+\change_deleted 564990737 1669755802
+The language of the document should not be changed.
+ Before previewing your paper, be sure that the babel package is not used.
+ To do this, click on
+\begin_inset Info
+type "menu"
+arg "dialog-show document"
+\end_inset
+
\family sans
-\size normal
-Title
+\SpecialChar menuseparator
+Language
\family default
- for a Paper
-\end_layout
-
-\begin_layout Itemize
+, and select
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 564990737 1669801478
+None
+\begin_inset Quotes erd
+\end_inset
+ as
\family sans
-\size normal
-Review
+Language Package
\family default
- for a Review
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\change_deleted 564990737 1669801478
+\change_deleted 564990737 1669755802
+The
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\size normal
-Topical
-\family default
- for a Topical review
+Keywords
+\begin_inset Quotes erd
+\end_inset
+
+ style must be used to define keywords.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\change_deleted 564990737 1669801478
+\change_deleted 564990737 1669755802
+The ijmpc package provides a style named
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\size normal
-Comment
-\family default
- for a Comment
+Classification Codes
+\begin_inset Quotes erd
+\end_inset
+
+, which can be used to define classification codes, such as PACS numbers.
+ Note that this facility is not supported by the ijmpd package.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\change_deleted 564990737 1669801478
+\change_deleted 564990737 1669755802
+Several new environments are available:
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\size normal
-Note
-\family default
- for a Note
-\end_layout
+Definition
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 564990737 1669801478
+Step
+\begin_inset Quotes erd
+\end_inset
-\family sans
-\size normal
-Paper
-\family default
- for a Paper (same as Title)
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Example
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669801478
+,
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\size normal
-Prelim
-\family default
- for a Preliminary communication
-\end_layout
+Remark
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Notation
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Theorem
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Proof
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Corollary
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Lemma
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 564990737 1669801478
+Proposition
+\begin_inset Quotes erd
+\end_inset
-\family sans
-\size normal
-Rapid
-\family default
- for a Rapid communication
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Prop
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669801478
+,
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\size normal
-Letter
-\family default
- for a Letter to the editor
-\end_layout
+Question
+\begin_inset Quotes erd
+\end_inset
-\end_deeper
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\change_deleted 564990737 1669801478
+Claim
+\begin_inset Quotes erd
+\end_inset
-\size normal
-All title environments except of
-\family sans
-Letter
-\family default
- can have an optional short title.
-\end_layout
+, and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Conjecture
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1669801478
-There is a general title environment
-\family sans
-Article
-\family default
- which is not directly supported by \SpecialChar LyX
.
- This can be used as \SpecialChar TeX
- code when your document doesn't fit into one of the
- other title types.
+ Their use is more or less obvious.
+ \SpecialChar LyX
+ supports all these environments; it will use the proper label, text style,
+ and numbering scheme for each of them.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-\change_deleted 564990737 1669801478
-For more informations like hints for special table and formula formatting,
- look at the IOP author guidelines.
-\change_unchanged
+\change_deleted 564990737 1669755802
+Both packages use basic citations; the natbib package should not be used.
+ In \SpecialChar LyX
+, citation references are shown as usual; in the output, citations are
+ shown as superscripts.
+ If you want to use a citation as normal text, you should use the
+\family typewriter
+refcite
+\family default
+ command, e.
+\begin_inset space \thinspace{}
+\end_inset
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Section
-\change_deleted 564990737 1670317155
-Kluwer
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+See Ref.
+\begin_inset space \space{}
+\end_inset
-\change_deleted 564990737 1670317155
-by
-\noun on
-Panayotis Papasotiriou
-\end_layout
-\begin_layout Subsection
+\family typewriter
-\change_deleted 564990737 1670317155
-Overview
-\end_layout
+\backslash
+refcite{key}
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1670317155
-The Kluwer package is a set of macros produced by Kluwer Academic Publishers
- that facilitates electronic manuscript submission to the journals they
- publish.
- Most known of them (at least in my domain of interest) are
-\emph on
-Astrophysics and Space Science
-\emph default
- and
-\emph on
-Solar Physics
-\emph default
-, but there are many others (see a complete list at
-\begin_inset Flex URL
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
-http://www.wkap.nl/jrnllist.htm/JRNLHOME
-\end_layout
+\change_deleted 564990737 1669755802
+There is no
+\begin_inset Quotes eld
+\end_inset
+Acknowledgments
+\begin_inset Quotes erd
\end_inset
-).
- The Kluwer package may be downloaded from the site
-\begin_inset Flex URL
-status collapsed
+ section in both packages.
+ To put acknowledgments, just use the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+Section*
+\begin_inset Quotes erd
+\end_inset
-http://www.wkap.nl/kaphtml.htm/STYLEFILES
+ environment.
\end_layout
-\end_inset
+\begin_layout Enumerate
-.
- A complete user guide is contained in that package (but it can also be
- downloaded separately).
-\end_layout
+\change_deleted 564990737 1669755802
+Appendices may be added to the paper,
+\emph on
+after
+\emph default
+ the Acknowledgments and
+\shape italic
+before
+\shape default
+ the References.
+ \SpecialChar LyX
+ provides a special environment, called
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Appendices Section
+\begin_inset Quotes erd
+\end_inset
-\change_deleted 564990737 1670317155
-\SpecialChar LyX
- supports many features of the package but not everything.
- However, the \SpecialChar TeX
- code needed is reduced to some
+ which marks the beginning of the appendices.
+ This environment should be left blank; it just sends a \SpecialChar LaTeX
+ command, but nothing
+ is really printed.
+ In \SpecialChar LyX
+, the word
\begin_inset Quotes eld
\end_inset
-peculiar
+Appendix
\begin_inset Quotes erd
\end_inset
- commands of the package (see
-\begin_inset space ~
+ is printed with blue letters, as a signal that all sections after that
+ point are appendices.
+ To write an appendix, use the
+\begin_inset Quotes eld
\end_inset
+Appendix
+\begin_inset Quotes erd
+\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:kluwer_peculiarities"
+ environment.
+ \SpecialChar LyX
+ will number each appendix with capital letters, as required by both journals.
+ Note that
+\begin_inset Quotes eld
+\end_inset
+Appendices Section
+\begin_inset Quotes erd
\end_inset
-).
- I have recently used \SpecialChar LyX
- to write an article submitted to the
+
\emph on
-Astrophysics and Space Science
+must
\emph default
- without any problem.
+ be present before the first appendix; if not, all appendices will be numbered
+ as normal sections in the output.
\end_layout
-\begin_layout Subsection
-
-\change_deleted 564990737 1670317155
-Writing a paper
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
+\change_deleted 564990737 1669755802
+The ijmpc and the ijmpd packages use the
+\family typewriter
+tbl
+\family default
+ command to implement table captions.
+ As a result, a table created by \SpecialChar LyX
+ is printed correctly, but its caption
+ is ignored.
+ However, you can use some \SpecialChar TeX
+ code to overcome this problem, so that captions
+ are printed as expected.
+ To do so, create a float table as usual, remove the caption, and replace
+ it with the \SpecialChar TeX
+ code
+\family typewriter
-\change_deleted 564990737 1670317155
-The easiest way to write a paper is to start with the Kluwer template file.
- Click on
-\family sans
-File\SpecialChar menuseparator
-New from
+\backslash
+tbl{
+\emph on
+your table caption
+\emph default
+}{
\family default
-
+ (sic); you must also the \SpecialChar TeX
+ code
+\family typewriter
+}
+\family default
+ immediately after the tabular material.
+ Study the example table included in the template files to see how this
+ trick is implemented.
+ Alternatively, If you need table captions, you should implement the whole
+ table float in a
+\family typewriter
+.tex
+\family default
+ file, then include this file to the \SpecialChar LyX
+ document (
\family sans
-Template
+Insert\SpecialChar menuseparator
+File\SpecialChar menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
\family default
-, then choose the
+).
+ Details on how to create a table float can be found in the files
\family typewriter
-kluwer.lyx
+ws-ijmpc.tex
\family default
- template.
- This will give an (almost) empty document that includes the most common
- fields found in a manuscript and a short description of their use.
- As in most templates, simply overwrite the existing text (including the
- brackets,
+ and
\family typewriter
-<>
+ws-ijmpd.tex
\family default
-) with the correct information.
+, included in the corresponding packages.
\end_layout
\begin_layout Subsection
-\change_deleted 564990737 1670317155
+\change_deleted 564990737 1669755802
Preparing a paper for submission
\end_layout
\begin_layout Standard
-\change_deleted 564990737 1670317155
-As in the AAS\SpecialChar TeX
- package, before you submit your paper to a journal you must
-
-\begin_inset Quotes eld
-\end_inset
-
-postprocess
-\begin_inset Quotes erd
-\end_inset
-
- it as follows.
-\end_layout
-
-\begin_layout Enumerate
-
-\change_deleted 564990737 1670317155
-Export your paper as a \SpecialChar LaTeX
- file.
- To do this, click on
+\change_deleted 564990737 1669755802
+Before you submit your paper you must export the \SpecialChar LyX
+ document as a \SpecialChar LaTeX
+ file (
\family sans
File\SpecialChar menuseparator
Export\SpecialChar menuseparator
\SpecialChar LaTeX
\family default
-.
-
+)
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Actually you have the choice between \SpecialChar LaTeX
+ (plain) and pdflatex.
+ If you intend to use pdflatex to prepare the paper, you should use the
+ pdflatex option so that included graphics are converted to PDF format,
+ ready for use by pdflatex.
\end_layout
-\begin_layout Enumerate
+\end_inset
-\change_deleted 564990737 1670317155
-Edit the resulting
+, then make the following changes to the resulting
\family typewriter
.tex
\family default
- file with a text editor and make the following changes
+ file.
\end_layout
-\begin_deeper
\begin_layout Enumerate
-\change_deleted 564990737 1670317155
-remove the comment lines before the
+\change_deleted 564990737 1669755802
+Remove the comment lines before the
\family typewriter
\backslash
documentclass
\family default
- command,
+ command.
\end_layout
\begin_layout Enumerate
-\change_deleted 564990737 1670317155
-remove everything between (and including) the
+\change_deleted 564990737 1669755802
+Remove everything between (and including) the
\family typewriter
\backslash
\begin_layout Standard
-\change_deleted 564990737 1670317155
-Save the resulting
+\change_deleted 564990737 1669755802
+The modified
\family typewriter
.tex
\family default
- file.
+ file should be saved and processed through \SpecialChar LaTeX
+ as many times as necessary.
+ You may also want to check the resulting
+\family typewriter
+.dvi
+\family default
+ document.
+\change_unchanged
+
\end_layout
-\end_deeper
-\begin_layout Enumerate
+\begin_layout Section
-\change_deleted 564990737 1670317155
-Run the
-\family typewriter
-.tex
-\family default
- file through \SpecialChar LaTeX
- as many times as necessary (usually up to three).
+\change_deleted 564990737 1669801478
+iopart
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
-\change_deleted 564990737 1670317155
-View the resulting
-\family typewriter
-.dvi
-\family default
- document using, e.
-\begin_inset space \thinspace{}
-\end_inset
+\change_deleted 564990737 1669801478
+by
+\noun on
+Uwe Stöhr
+\end_layout
+
+\begin_layout Subsection
+
+\change_deleted 564990737 1669801478
+Overview
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted 564990737 1669801478
+The iopart package provides a document class to create electronic manuscript
+ submission to the journals published by the Institute of Physics.
+ Instructions for the authors how to create a paper using the iopart class
+ can be downloaded together with the iopart package from the site
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+ftp://ftp.iop.org/pub/journals/latex2e
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
+.
+\end_layout
+
+\begin_layout Subsection
+
+\change_deleted 564990737 1669801478
+Writing a paper
+\end_layout
+
+\begin_layout Standard
+\change_deleted 564990737 1669801478
+The easiest way to write a paper is to start with the template
+\emph on
+IOP-article.lyx
+\emph default
+ that is available via
\family sans
-xdvi
+File\SpecialChar menuseparator
+New From Template
\family default
-, and check if everything is OK (it should, if you didn't make any mistake).
+ The template explains how to use the special text environments.
+ Here are the most important advices:
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-\change_deleted 564990737 1670317155
-\begin_inset Quotes eld
-\end_inset
+\change_deleted 564990737 1669801478
+To be able to compile your document to a PDF, PS, or DVI, ensure that the
+ no AMS packages are loaded in
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Math Options
+\family default
+!
+\end_layout
-Peculiarities
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- of the Kluwer package
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:kluwer_peculiarities"
+\change_deleted 564990737 1669801478
-\end_inset
+\size normal
+The title environment defines the kind of your paper.
+ So use one of the following environments for the title:
+\end_layout
+\begin_deeper
+\begin_layout Itemize
-\end_layout
+\change_deleted 564990737 1669801478
-\begin_layout Standard
+\family sans
+\size normal
+Title
+\family default
+ for a Paper
+\end_layout
-\change_deleted 564990737 1670317155
-The Kluwer package has the following
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-peculiarities
-\begin_inset Quotes erd
-\end_inset
+\change_deleted 564990737 1669801478
-.
+\family sans
+\size normal
+Review
+\family default
+ for a Review
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-\change_deleted 564990737 1670317155
-It is possible to write multiple articles in the same \SpecialChar LaTeX
- file
-\begin_inset Foot
-status collapsed
+\change_deleted 564990737 1669801478
-\begin_layout Plain Layout
-I can't imagine any good reason to do this.
+\family sans
+\size normal
+Topical
+\family default
+ for a Topical review
\end_layout
-\end_inset
-
-.
- Each article must be included in the environment
-\begin_inset Quotes eld
-\end_inset
-
-article
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-.
- Unfortunately, this environment cannot be omitted, even if you write just
- one article.
- Therefore, each article starts with the command
-\family typewriter
+\change_deleted 564990737 1669801478
-\backslash
-begin{article}
+\family sans
+\size normal
+Comment
\family default
- and, obviously, ends with the command
-\family typewriter
+ for a Comment
+\end_layout
-\backslash
-end{article}
-\family default
-.
- Although this can be implemented in \SpecialChar LyX
-, I didn't included it, since it looks
- ugly and can confuse the novice user.
- Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
- code (the
- well-known
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-\SpecialChar TeX
- code
-\begin_inset Quotes erd
-\end_inset
+\change_deleted 564990737 1669801478
-).
+\family sans
+\size normal
+Note
+\family default
+ for a Note
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-\change_deleted 564990737 1670317155
-Information given at the beginning of the article (i.
-\begin_inset space \thinspace{}
-\end_inset
+\change_deleted 564990737 1669801478
-e.
-\begin_inset space \space{}
-\end_inset
+\family sans
+\size normal
+Paper
+\family default
+ for a Paper (same as Title)
+\end_layout
-title, subtitle, author, institution, running title, running author, abstract
- and keywords) must be included in an environment called
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-opening
-\begin_inset Quotes erd
-\end_inset
+\change_deleted 564990737 1669801478
-.
- This is not implemented in \SpecialChar LyX
-, so you must enter title, subtitle etc.
-\begin_inset space ~
-\end_inset
+\family sans
+\size normal
+Prelim
+\family default
+ for a Preliminary communication
+\end_layout
-between two \SpecialChar TeX
- code lines (
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{opening}
-\family default
- and
-\family typewriter
+\change_deleted 564990737 1669801478
-\backslash
-end{opening}
+\family sans
+\size normal
+Rapid
\family default
-).
+ for a Rapid communication
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-\change_deleted 564990737 1670317155
-According to the user manual, the label of each bibliography item must be
- written as
-\family typewriter
+\change_deleted 564990737 1669801478
-\backslash
-protect
-\backslash
-citeauthoryear{
-\family default
-\emph on
-author(s)
-\family typewriter
-\emph default
-}{
-\family default
-\emph on
-year
-\family typewriter
-\emph default
-}
+\family sans
+\size normal
+Letter
\family default
-.
+ for a Letter to the editor
\end_layout
-\begin_layout Standard
+\end_deeper
+\begin_layout Itemize
-\change_deleted 564990737 1670317155
-The
-\family typewriter
-kluwer.lyx
+\change_deleted 564990737 1669801478
+
+\size normal
+All title environments except of
+\family sans
+Letter
\family default
- template takes care of all these
-\begin_inset Quotes eld
-\end_inset
+ can have an optional short title.
+\end_layout
-peculiarities
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+\change_deleted 564990737 1669801478
+There is a general title environment
+\family sans
+Article
+\family default
+ which is not directly supported by \SpecialChar LyX
.
- If you start a new paper using this template you don't need to do anything
- special.
- Just
+ This can be used as \SpecialChar TeX
+ code when your document doesn't fit into one of the
+ other title types.
\end_layout
-\begin_layout Enumerate
-
-\change_deleted 564990737 1670317155
-don't delete the \SpecialChar TeX
- code included in the template, and
-\end_layout
+\begin_layout Standard
-\begin_layout Enumerate
+\change_deleted 564990737 1669801478
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
+\change_unchanged
-\change_deleted 564990737 1670317155
-copy the example bibliography item included in the template and modify it
- as necessary to enter new bibliography items.
\end_layout
\begin_layout Section
-Memoir
+
+\change_deleted 564990737 1670317155
+Kluwer
\end_layout
\begin_layout Standard
-By
+
+\change_deleted 564990737 1670317155
+by
\noun on
-Jürgen Spitzmüller
+Panayotis Papasotiriou
\end_layout
\begin_layout Subsection
-Overview
-\end_layout
-\begin_layout Standard
-Memoir is a very powerful and constantly evolving class.
- It has been designed with regard to fictional and non-fictional literature.
- Its aim is to let the user have maximum control over the typesetting of
- his document.
- Memoir is based on the standard book class, but it can also emulate the
- article class (see below).
+\change_deleted 564990737 1670317155
+Overview
\end_layout
\begin_layout Standard
-Peter Wilson, the developer of Memoir, is known as the author of lots of
- useful packages in the \SpecialChar LaTeX
- world.
- Most of them have been merged with Memoir.
- Therefore, it is much easier to layout the table of contents, appendices,
- chapter designs and such.
- \SpecialChar LyX
-, though, does not support all of these goodies natively.
- Some of them might be added to forthcoming releases
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-You are invited to send suggestions to
+\change_deleted 564990737 1670317155
+The Kluwer package is a set of macros produced by Kluwer Academic Publishers
+ that facilitates electronic manuscript submission to the journals they
+ publish.
+ Most known of them (at least in my domain of interest) are
+\emph on
+Astrophysics and Space Science
+\emph default
+ and
+\emph on
+Solar Physics
+\emph default
+, but there are many others (see a complete list at
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-lyx-devel@lists.lyx.org
-\end_layout
-
-\end_inset
-
-.
+http://www.wkap.nl/jrnllist.htm/JRNLHOME
\end_layout
\end_inset
-, lots will probably never be supported, due to the limitations of \SpecialChar LyX
-'s framework.
- Of course you can still use all features with the help of some native \SpecialChar LaTeX
-
- commands (\SpecialChar TeX
- code
-\begin_inset Foot
+).
+ The Kluwer package may be downloaded from the site
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-Cf.
-\begin_inset ERT
-status collapsed
-\begin_layout Plain Layout
+http://www.wkap.nl/kaphtml.htm/STYLEFILES
+\end_layout
+
+\end_inset
+
+.
+ A complete user guide is contained in that package (but it can also be
+ downloaded separately).
+\end_layout
+\begin_layout Standard
-\backslash
-
-\end_layout
+\change_deleted 564990737 1670317155
+\SpecialChar LyX
+ supports many features of the package but not everything.
+ However, the \SpecialChar TeX
+ code needed is reduced to some
+\begin_inset Quotes eld
+\end_inset
+peculiar
+\begin_inset Quotes erd
\end_inset
-section
+ commands of the package (see
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:Inserting-TeX-Code"
+reference "subsec:kluwer_peculiarities"
\end_inset
- for details.
+).
+ I have recently used \SpecialChar LyX
+ to write an article submitted to the
+\emph on
+Astrophysics and Space Science
+\emph default
+ without any problem.
\end_layout
-\end_inset
+\begin_layout Subsection
-).
- In this section, we can only list those features that are natively supported
- by \SpecialChar LyX
-.
- For detailed descriptions (and for the rest of features) we recommend you
- have a look at the detailed manual of the Memoir class
-\begin_inset Foot
-status collapsed
+\change_deleted 564990737 1670317155
+Writing a paper
+\end_layout
-\begin_layout Plain Layout
-Cf.
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
-\begin_layout Plain Layout
+\change_deleted 564990737 1670317155
+The easiest way to write a paper is to start with the Kluwer template file.
+ Click on
+\family sans
+File\SpecialChar menuseparator
+New from
+\family default
+
+\family sans
+Template
+\family default
+, then choose the
+\family typewriter
+kluwer.lyx
+\family default
+ template.
+ This will give an (almost) empty document that includes the most common
+ fields found in a manuscript and a short description of their use.
+ As in most templates, simply overwrite the existing text (including the
+ brackets,
+\family typewriter
+<>
+\family default
+) with the correct information.
+\end_layout
+\begin_layout Subsection
-\backslash
-
+\change_deleted 564990737 1670317155
+Preparing a paper for submission
\end_layout
+\begin_layout Standard
+
+\change_deleted 564990737 1670317155
+As in the AAS\SpecialChar TeX
+ package, before you submit your paper to a journal you must
+
+\begin_inset Quotes eld
\end_inset
+postprocess
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Flex URL
-status collapsed
+ it as follows.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
-CTAN:/macros/latex/memoir/memman.pdf
+\change_deleted 564990737 1670317155
+Export your paper as a \SpecialChar LaTeX
+ file.
+ To do this, click on
+\family sans
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
+\family default
+.
+
\end_layout
-\end_inset
+\begin_layout Enumerate
-.
+\change_deleted 564990737 1670317155
+Edit the resulting
+\family typewriter
+.tex
+\family default
+ file with a text editor and make the following changes
\end_layout
-\end_inset
+\begin_deeper
+\begin_layout Enumerate
-, which is not only a user guide for the class, but also both a comprehensive
- description on good typesetting and a superb example for good typesetting
- itself.
+\change_deleted 564990737 1670317155
+remove the comment lines before the
+\family typewriter
+
+\backslash
+documentclass
+\family default
+ command,
\end_layout
-\begin_layout Subsection
-Basic features and restrictions
+\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
+remove everything between (and including) the
+\family typewriter
+
+\backslash
+makeatletter
+\family default
+ and
+\family typewriter
+
+\backslash
+makeatother
+\family default
+ commands, except for any commands you specifically put into the \SpecialChar LaTeX
+ preamble.
\end_layout
\begin_layout Standard
-Memoir supports basically all features of the standard book classes.
- There are, however, some differences, as follows:
+
+\change_deleted 564990737 1670317155
+Save the resulting
+\family typewriter
+.tex
+\family default
+ file.
\end_layout
-\begin_layout Description
-Font
-\begin_inset space ~
-\end_inset
+\end_deeper
+\begin_layout Enumerate
-sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
+\change_deleted 564990737 1670317155
+Run the
+\family typewriter
+.tex
+\family default
+ file through \SpecialChar LaTeX
+ as many times as necessary (usually up to three).
\end_layout
-\begin_layout Description
-Page
-\begin_inset space ~
-\end_inset
-
-style: The fancy page style is not supported, due to a command clash between
- Memoir and the fancyhdr package (they both define a command with the same
- name, which confuses \SpecialChar LaTeX
-).
- Instead, Memoir comes with a number of its own page styles (see
-\family sans
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Page
-\begin_inset space ~
-\end_inset
+\begin_layout Enumerate
-Style
-\family default
-).
- If you want to use these for the chapter pages, you have to use the command
-
+\change_deleted 564990737 1670317155
+View the resulting
\family typewriter
-
-\backslash
-chapterstyle
+.dvi
\family default
- in the main text or in preamble (e.
+ document using, e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
-\family typewriter
-
-\backslash
-chapterstyle{companion}
+\family sans
+xdvi
\family default
-).
+, and check if everything is OK (it should, if you didn't make any mistake).
\end_layout
-\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) come with an
- optional argument in the standard classes.
- With this, you can specify an alternative version of the title for the
- table of contents and the headers (for instance, if the title is too long).
- In \SpecialChar LyX
-, you can do this via
-\family sans
-Insert\SpecialChar menuseparator
-Short
-\begin_inset space ~
+\begin_layout Subsection
+
+\change_deleted 564990737 1670317155
+\begin_inset Quotes eld
\end_inset
-Title
-\family default
- at the beginning of a chapter/section.
- Memoir features a second optional argument and thus separates the table
- of contents from the header.
- You can define three variants of a title with this: one for the main text,
- one for the table of contents, and one for the headers.
- \SpecialChar LyX
- makes these available in form of specific
-\family sans
-Short Title
-\family default
- variants in the
-\family sans
-Insert
-\family default
- menu.
+Peculiarities
+\begin_inset Quotes erd
+\end_inset
+
+ of the Kluwer package
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:kluwer_peculiarities"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted 564990737 1670317155
+The Kluwer package has the following
+\begin_inset Quotes eld
+\end_inset
+
+peculiarities
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Description
-TOC/LOT/LOF: In the standard classes (and in many other classes), the table
- of contents, the list of figures and the list of table start a new page
- automatically.
- Memoir does not follow this route.
- You have to insert a page break yourself, if you want to have one.
+\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
+It is possible to write multiple articles in the same \SpecialChar LaTeX
+ file
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+I can't imagine any good reason to do this.
\end_layout
-\begin_layout Description
-Titlepage: For some unknown reason, Memoir uses pagination on the title
- page (in the standard classes, title pages are
+\end_inset
+
+.
+ Each article must be included in the environment
\begin_inset Quotes eld
\end_inset
-empty
+article
\begin_inset Quotes erd
\end_inset
-).
- If you want an empty title page, type
+.
+ Unfortunately, this environment cannot be omitted, even if you write just
+ one article.
+ Therefore, each article starts with the command
\family typewriter
\backslash
-aliaspagestyle{title}{empty}
+begin{article}
\family default
- in the preamble.
-\end_layout
-
-\begin_layout Description
-Article: With the class option
-\emph on
-article
-\emph default
- (to be inserted in
-\family sans
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Class Settings\SpecialChar menuseparator
-Custom
-\begin_inset space ~
-\end_inset
+ and, obviously, ends with the command
+\family typewriter
-Options
+\backslash
+end{article}
\family default
-), you can emulate article style.
- That is, counters (footnotes, figures, tables etc.) will not be reset on
- new chapters, chapters don't start a new page (but are—in contrary to
+.
+ Although this can be implemented in \SpecialChar LyX
+, I didn't included it, since it looks
+ ugly and can confuse the novice user.
+ Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
+ code (the
+ well-known
\begin_inset Quotes eld
\end_inset
-real
+\SpecialChar TeX
+ code
\begin_inset Quotes erd
\end_inset
- article classes—still allowed), parts, though, use their own page, as in
- book.
+).
\end_layout
-\begin_layout Description
-Oldfontcommands: By default, Memoir does not allow the use of the deprecated
- font commands, which have been used in the old \SpecialChar LaTeX
- version 2.09 (e.
+\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
+Information given at the beginning of the article (i.
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
+title, subtitle, author, institution, running title, running author, abstract
+ and keywords) must be included in an environment called
+\begin_inset Quotes eld
+\end_inset
+
+opening
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This is not implemented in \SpecialChar LyX
+, so you must enter title, subtitle etc.
+\begin_inset space ~
+\end_inset
+between two \SpecialChar TeX
+ code lines (
\family typewriter
\backslash
-rm
+begin{opening}
\family default
-,
+ and
\family typewriter
\backslash
-it
+end{opening}
\family default
).
- It produces an error and stops \SpecialChar LaTeX
- whenever such a command appears.
- The class option
-\emph on
-oldfontcommands
-\emph default
- reallows the commands and spits out warnings instead (which does at least
- not stop \SpecialChar LaTeX
-).
- Since a lot of packages and particularly Bib\SpecialChar TeX
- style files are still using
- those commands, we have decided to use this option by default.
-\end_layout
-
-\begin_layout Subsection
-Extra features
\end_layout
-\begin_layout Standard
-We will only describe the features supported by \SpecialChar LyX
- (which is not much currently).
- Please consult the Memoir manual
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Cf.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\begin_layout Enumerate
+\change_deleted 564990737 1670317155
+According to the user manual, the label of each bibliography item must be
+ written as
+\family typewriter
\backslash
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-CTAN:/macros/latex/memoir/memman.pdf
-\end_layout
-
-\end_inset
-
+protect
+\backslash
+citeauthoryear{
+\family default
+\emph on
+author(s)
+\family typewriter
+\emph default
+}{
+\family default
+\emph on
+year
+\family typewriter
+\emph default
+}
+\family default
.
\end_layout
-\end_inset
-
- for details.
-\end_layout
-
-\begin_layout Description
-Abstract: You may wonder why an abstract is an extra feature.
- Well, it is in book class.
- Usually books don't have abstracts.
- Memoir, however, has.
- You can use it wherever and how often you like.
-\end_layout
+\begin_layout Standard
-\begin_layout Description
-Chapterprecis: You may know this older typesetting style: The contents of
- a chapter are summarized below the title and also in the table of contents
- (e.
-\begin_inset space \thinspace{}
+\change_deleted 564990737 1670317155
+The
+\family typewriter
+kluwer.lyx
+\family default
+ template takes care of all these
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset space \space{}
+peculiarities
+\begin_inset Quotes erd
\end_inset
-
-\emph on
-Our hero arrives in Troia; he loses some friends; he finds others
-\emph default
-).
- Chapterprecis does exactly this.
- It is therefore only sensible below a chapter.
-\end_layout
-
-\begin_layout Description
-Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
- The epigraph environment provides an elegant way of typesetting such a
- motto.
- The motto itself (text) and its (optional) author (source) are divided
- by a short line.
- The author (source) can be inserted via
-\family sans
-Insert\SpecialChar menuseparator
-Epigraph Source
-\family default
-\emph on
.
+ If you start a new paper using this template you don't need to do anything
+ special.
+ Just
\end_layout
-\begin_layout Description
-Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
- complex figurative poems).
- \SpecialChar LyX
- can only support a few of them.
- One is poemtitle, which is a centered title for poems, which will also
- be added to the table of contents (verse is the standard environment for
- poems.
- Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
- code,
- because they have to be nested inside regular verse environments, which
- is not possible with \SpecialChar LyX
-).
+\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
+don't delete the \SpecialChar TeX
+ code included in the template, and
\end_layout
-\begin_layout Description
-Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
+\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
+copy the example bibliography item included in the template and modify it
+ as necessary to enter new bibliography items.
\end_layout
\begin_layout Section
projects / features.git / commitdiff