-#LyX 2.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 544
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 610
\begin_document
\begin_header
\save_transient_properties true
% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
-
-% Improve line breaking
-\tolerance 1414
-\hbadness 1414
-\emergencystretch 1.5em
-\hfuzz 0.3pt
\end_preamble
\options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
multicol
shapepar
\end_modules
-\maintain_unincluded_children false
+\maintain_unincluded_children no
\language english
\language_package default
-\inputencoding auto
-\fontencoding global
+\inputencoding utf8
+\fontencoding auto
\font_roman "lmodern" "default"
\font_sans "lmss" "default"
\font_typewriter "lmtt" "default"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
-\font_osf false
+\font_roman_osf false
+\font_sans_osf false
+\font_typewriter_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\pdf_backref false
\pdf_pdfusetitle false
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
-\papersize a4paper
+\papersize a4
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
-\use_package cancel 0
-\use_package esint 0
+\use_package cancel 1
+\use_package esint 1
\use_package mathdots 1
-\use_package mathtools 0
+\use_package mathtools 1
\use_package mhchem 1
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\justification true
\use_refstyle 0
\use_minted 0
+\use_lineno 0
\notefontcolor #0000ff
\index Index
\shortcut idx
\papercolumns 1
\papersides 2
\paperpagestyle headings
+\tablestyle default
\tracking_changes true
\output_changes false
+\change_bars false
+\postpone_fragile_content false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
+\docbook_table_output 0
+\docbook_mathml_prefix 1
\author -712698321 "Jürgen Spitzmüller"
-\author 34634807 "Jean-Pierre"
+\author 177693 "x"
+\author 5863208 "ab"
+\author 244031559 "Yuriy"
+\author 564990737 "John Lyx"
+\author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
+\author 1075283030 "Thibaut"
+\author 1119979965 "Joel A. Kulesza"
\end_header
\begin_body
\end_layout
\begin_layout Subtitle
-Version 2.3.x
+Version 2.
+\change_deleted 630872221 1622909155
+3
+\change_inserted 630872221 1622909155
+4
+\change_unchanged
+.x
\end_layout
\begin_layout Author
\noindent
Principal maintainer of this file is
\noun on
- Richard Heck
+ Richard Kimberly Heck
\noun default
.
If you have comments or error corrections, please send them to the \SpecialChar LyX
status collapsed
\begin_layout Plain Layout
-\noindent
<lyx-docs@lists.lyx.org>
\end_layout
\end_layout
\begin_layout Standard
-This manual also documents some special features, like fax support, version
- control, and SGML support, which require additional software to work properly.
+This manual also documents some special features, like fax support
+\change_deleted 244031559 1603802929
+,
+\change_inserted 244031559 1603802931
+ and
+\change_unchanged
+ version control
+\change_deleted 244031559 1603802954
+, and SGML support
+\change_unchanged
+, which require additional software to work properly.
There is also a chapter on \SpecialChar LyX
's support for HTML.
And lastly, there's a chapter of \SpecialChar LaTeX
performs further steps:
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
Run
\begin_inset Flex Code
status collapsed
to convert the DVI file to PostScript.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
Run a PostScript viewer, such as
\begin_inset Flex Code
status collapsed
packages out there to do all sorts of things,
from labels to envelopes to fancy multipage tables.
Check out
+\change_inserted 244031559 1603815732
+
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "https://www.ctan.org/"
+literal "false"
+
+\end_inset
+
+
+\change_deleted 244031559 1603815732
+
\begin_inset CommandInset href
LatexCommand href
name "CTAN"
\end_inset
+
+\change_unchanged
for details.
\end_layout
loves
\emph default
to spew these out.
-
-\change_inserted -712698321 1501222056
-It seems to generate at least one of these messages for just about any document
- you write.
-
-\change_unchanged
-They are warnings about lines that were too long and run past the right
+ It seems to generate at least one of these messages for just about any
+ document you write.
+ They are warnings about lines that were too long and run past the right
margin.
-
-\change_inserted -712698321 1501222913
This happens if \SpecialChar LaTeX
does not find a reasonable way to break the lines (notoriously
often with typewriter font, since this does not allow for automatic break
points).
-
-\change_unchanged
-
-\change_deleted -712698321 1501221633
-Almost always
-\change_inserted -712698321 1501221635
-In many cases
-\change_unchanged
-, this is unnoticeable in the final output.
- (It can be just a point or two.)
-\change_deleted -712698321 1501221644
-Or, only one or two characters extend past the margin
-\change_inserted -712698321 1501222092
-Sometimes, however, the lines run rather visibly into the margin; something
- you will not want to have in your final print
-\change_unchanged
-.
+ In many cases, this is unnoticeable in the final output.
+ (It can be just a point or two.) Sometimes, however, the lines run rather
+ visibly into the margin; something you will not want to have in your final
+ print.
-\change_deleted -712698321 1501222038
-\SpecialChar LaTeX
- seems to generate at least one of these messages for just about any document
- you write.
-\change_unchanged
-
\begin_inset Newline newline
\end_inset
-
-\change_deleted -712698321 1501222960
-You can ignore these messages.
- Your eyes will tell you if there's a problem with something that's too
- wide; just look at the output.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-You can also enable the `draft' option in
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-
-\end_inset
-
-, and then \SpecialChar LaTeX
- will draw a black box in the margin of lines that are overfull.
-\end_layout
-
-\end_inset
-
-
-\change_inserted -712698321 1501223436
There are several global ways to try to minimize the overfull lines.
Clicking
\family sans
\begin_deeper
\begin_layout LyX-Code
-\change_inserted -712698321 1501223447
-
\backslash
tolerance 1414
\begin_inset Newline newline
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1501223436
In some cases, however, you eventually have to rewrite the text to get the
line breaking right.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501223436
For more information, see
\begin_inset Flex URL
status open
\begin_layout Plain Layout
-\change_inserted -712698321 1501223436
-
http://www.tex.ac.uk/FAQ-overfull.html
\end_layout
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1501223436
In any case, you should check the respective lines, at least for the final
version of your document.
Your eyes will tell you if there's a problem with something that's too
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501223436
You can also enable the `draft' option in
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501223436
Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
Not quite as common as its cousin.
-
-\change_inserted -712698321 1501223875
- This happens again if
-\change_unchanged
- \SpecialChar LaTeX
-
-\change_inserted -712698321 1501223913
-does not find a reasonable break point and consequently generates too loose
- lines.
-
-\change_deleted -712698321 1501223919
-seems to like to print lines that are a bit too wide as opposed to ones
- that are a bit too narrow.
- We have no idea why.
-\change_inserted -712698321 1501223940
-As with the overfull lines, you should check if this is a visible problem.
-\change_unchanged
-
+ This happens again if \SpecialChar LaTeX
+ does not find a reasonable break point and consequently
+ generates too loose lines.
+ As with the overfull lines, you should check if this is a visible problem.
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
+
+\change_deleted 177693 1654669036
Protected
+\change_inserted 177693 1654669038
+Non-Breaking
+\change_unchanged
+
\begin_inset space ~
\end_inset
+
+\change_deleted 177693 1654669040
Blanks
+\change_inserted 177693 1654669041
+Spaces
+\change_unchanged
+
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
-Supplemental Tools
+
+\change_inserted 564990737 1670439508
+Document classes
\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
- 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
-.
+\change_inserted 564990737 1670439533
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Collections"
+
+\end_inset
+
+Collections
\end_layout
\begin_layout Subsection
-Alternative Citation Styles
+AMS \SpecialChar LaTeX
+
\end_layout
\begin_layout Standard
-Standard Bib\SpecialChar TeX
- uses numbers (e.
-\begin_inset space \thinspace{}
-\end_inset
+by
+\noun on
+David Johnson
+\noun default
+; updated by
+\noun on
+Richard Kimberly Heck
+\end_layout
-g.
-\begin_inset space \space{}
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-[12]
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+\noindent
+The AMS \SpecialChar LaTeX
+ layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ \SpecialChar TeX
+ output).
+ That documentation is available on the Web at
+\begin_inset Flex URL
+status open
-) 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_layout Plain Layout
+
+http://www.ams.org
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
+ or by ftp at
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
-\begin_inset Quotes eld
-\end_inset
+ftp://ftp.ams.org/pub/tex/amslatex/
+\end_layout
-Knuth 1984a
-\begin_inset Quotes erd
\end_inset
-).
- \SpecialChar LyX
- supports three packages that provide this style,
-\begin_inset Flex Code
-status collapsed
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
+\end_layout
-\begin_layout Plain Layout
-biblatex
+\begin_layout Standard
+There are two basic AMS \SpecialChar LaTeX
+ layouts:
\end_layout
-\end_inset
+\begin_layout Itemize
+amsart: The standard AMS article format.
+\end_layout
-,
+\begin_layout Itemize
+amsbook: the standard AMS book (really, monograph) format.
+
+\end_layout
+
+\begin_layout Standard
+The layouts themselves contain only the minimum necessary to use the AMS
+ classes.
+ They do not, in particular, contain any of the `theorem' environments used
+ for setting theorems, lemmas, and the like.
+ These are contained, instead, in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-natbib
+Theorems (AMS)
\end_layout
\end_inset
-, and
+ module, which is loaded by default when you select one of the AMS classes.
+ (It can also be used with other classes and can be removed, if you would
+ rather use something else.) Less commonly used environments are in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-jurabib
+Theorems (AMS-Extended)
\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
+ module, which must be loaded manually.
+\end_layout
+
+\begin_layout Standard
+By default, theorems and the like are numbered consecutively throughout
+ the document, but this may be modified by loading the module
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-natbib
+Theorems (Order by Section)
\end_layout
\end_inset
-, then the established
+ or, if you are using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-natbib
+book (AMS)
\end_layout
\end_inset
- package is probably your choice.
- If you look for specific citation styles common in law studies, you might
- consider the
+, the module
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-jurabib
+Theorems (Order by Chapter)
\end_layout
\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
+.
+ These will number the results as
+\begin_inset Formula $n.m$
+\end_inset
+
+, where the first number refers to the section (or chapter) and the second
+ refers to the total number of results so far in that section (or chapter).
+ Many environments are also available unnumbered.
+ These are indicated by an asterisk at the end.
+ If you happen to want
+\emph on
+only
+\emph default
+ unnumbered results, the module
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-biblatex
+Theorems (Starred)
\end_layout
\end_inset
-, which exceeds all other packages in terms of features, but is also quite
- heavy and more resource-hungry.
+ provides that option.
\end_layout
\begin_layout Standard
-The handling of these packages in \SpecialChar LyX
- is basically the same.
- Go to
-\begin_inset Flex Noun
+Note that these modules do not
+\emph on
+have
+\emph default
+ to be used with the AMS classes.
+ It is perfectly possible to use the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
+Theorems (AMS)
\end_layout
\end_inset
- and select under
-\begin_inset Flex Noun
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+article
\end_layout
\end_inset
- the
-\begin_inset Flex Noun
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style Format
+report
\end_layout
\end_inset
-
-\begin_inset Flex Noun
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Biblatex
+book (KOMA-script)
\end_layout
\end_inset
-,
+, and so forth.
+\end_layout
+
+\begin_layout Subsubsection
+What these layouts provide
+\end_layout
+
+\begin_layout Standard
+There is a long list of included environments provided by these layouts.
+ In AMS-\SpecialChar LaTeX
+, there is, in fact, an opportunity to define an unlimited variety
+ of `theorem' environments.
+ However, the AMS recommends the environments that are available in \SpecialChar LyX
+.
+
+\end_layout
+
+\begin_layout Standard
+The following environments—as well as the standard environments, such as
+
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Biblatex (Natbib mode)
+section
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Natbib (BibTeX)
+bibliography
\end_layout
\end_inset
- or
+,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Jurabib (BibTeX)
+title
\end_layout
-\end_inset
-
- (see sec.
-\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 (
-\begin_inset Quotes eld
-\end_inset
-
-Knuth 1984
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-Knuth (1984)
-\begin_inset Quotes erd
\end_inset
,
-\begin_inset Quotes eld
-\end_inset
-
-Knuth, 1984
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Flex Noun
+status collapsed
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+author
+\end_layout
-1984
-\begin_inset Quotes erd
\end_inset
- 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
+, and
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-See
-\begin_inset Flex URL
-status open
-
-\begin_layout Plain Layout
-
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
+date
\end_layout
\end_inset
+—are provided by
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+article (AMS)
\end_layout
\end_inset
- for
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-natbib
+book (AMS)
\end_layout
\end_inset
-.
+:
\end_layout
-\begin_layout Subsection
-Subdivided Bibliographies
+\begin_layout Description
+Address This should be the author's permanent address.
\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
+\begin_layout Description
+Current
+\begin_inset space ~
\end_inset
-.
- Unfortunately, Bib\SpecialChar TeX
- itself does not allow you to do this.
- But with the help of some \SpecialChar LaTeX
- packages, Bib\SpecialChar TeX
- can be extended to fit your needs.
+Address This should be the author's temporary address at the time of submission,
+ if different from the Address.
\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- provides native support for one of these packages,
-\family typewriter
-bibtopic
-\family default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Available from
-\begin_inset Flex URL
-status open
-
-\begin_layout Plain Layout
-
-ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
+\begin_layout Description
+Email Author's e-mail address
\end_layout
-\end_inset
-
-
+\begin_layout Description
+URL Author's Web address, if desired.
\end_layout
-\end_inset
-
- 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
-
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
+\end_layout
-Scientific works
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+Subjectclass These refer to the AMS Subject Classifications, published and
+ described in
+\emph on
+Mathematical Reviews
+\emph default
+.
+ These are also available online at the AMS cites listed above.
+\end_layout
-, you first need to create two bibliographic databases, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Description
+Thanks
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Description
+Dedicatory
+\end_layout
+\begin_layout Description
+Translator
+\end_layout
+\begin_layout Standard
+The following environments are provided by both the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-sources.bib
+Theorems
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-scientific.bib
+Theorems (AMS)
\end_layout
\end_inset
-.
+ modules, in the latter case in both starred (unnumbered) and unstarred
+ (numbered) versions.
+ These same environments are provided only in the starred versions by the
-\end_layout
-
-\begin_layout Standard
-Go to
-\begin_inset Flex Noun
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
+Theorems (Starred)
\end_layout
\end_inset
- and check under
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Bibliography
+ module:
\end_layout
-\end_inset
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
+\end_layout
- the option
-\begin_inset Flex Noun
-status collapsed
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
+\end_layout
-\begin_layout Plain Layout
-Subdivided bibliography
+\begin_layout Lemma
+These are smaller results needed to prove other statements.
\end_layout
-\end_inset
+\begin_layout Proposition
+These are less major results which (hopefully) add to the general theory
+ being discussed.
+\end_layout
-.
- 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 Conjecture
+These are statements provided without justification, which the author does
+ not know how to prove, but which seem to be true (to the author, at least).
+\end_layout
-\begin_layout Plain Layout
-sources.bib
+\begin_layout Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
+
\end_layout
-\end_inset
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
- and a second one for the database
-\begin_inset Flex Code
-status collapsed
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
-\begin_layout Plain Layout
-scientific.bib
+\begin_layout Exercise*
+Write a description for this one.
\end_layout
-\end_inset
+\begin_layout Remark
+This environment is also a type of theorem, usually a lesser sort of observation.
+\end_layout
-.
- You are free to use the same or different styles for each section.
- Additionally, you can choose if the bibliography section should contain
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
+\end_layout
+
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-all cited references
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
+\end_layout
- of the specified database(s) (which is the default),
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Proof
+At the end of this environment, a QED symbol (usually a square, but it can
+ vary with different styles) is placed.
+ If you want to have other environments within this one—for example, Case
+ environments—and have the QED symbol appear only after them, then the other
+ environments need to be nested within the proof environment.
+ See the section
+\emph on
+Nesting Environments
+\emph default
+ of the
+\emph on
+User's Guide
+\emph default
+ for information on nesting.
+\end_layout
-all uncited references
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+And these environments are provided by
+\begin_inset Flex Code
+status collapsed
- or even
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
+\end_layout
-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
+:
+\end_layout
-Cited sources
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Criterion*
+A required condition.
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Algorithm*
+A general procedure to be used.
+\end_layout
-Uncited sources
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Axiom*
+This is a property or statement taken as true within the system being discussed.
+\end_layout
-, and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Condition*
+Sometimes used to state a condition assumed within the present context of
+ discussion.
+\end_layout
-Scientific works
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Note*
+Similar to a Remark.
+\end_layout
-.
- The titles for the sections can be added as ordinary sections or subsections.
- Since
-\begin_inset Flex Code
-status collapsed
+\begin_layout Notation*
+Used for the explanation of, yes, notation.
+\end_layout
-\begin_layout Plain Layout
-bibtopic
+\begin_layout Summary
+Do we really need to tell you?
\end_layout
-\end_inset
+\begin_layout Acknowledgement*
+Acknowledgement.
+\end_layout
- removes the bibliography title, you have to manually re-add that, too (as
- a chapter* or section*, for instance).
+\begin_layout Conclusion*
+Sometimes used at the end of a long train of argument.
+\end_layout
+
+\begin_layout Fact
+Used in a way similar to Proposition, though perhaps lower on the scale.
\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
+In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
+ and AMS fonts
+ packages.
+ They need to be available on your system in order to use these environments.
+\end_layout
-\begin_layout Plain Layout
-Subdivided bibliography
+\begin_layout Section
+
+\change_inserted 564990737 1670439534
+Articles
\end_layout
+\begin_layout Standard
+
+\change_inserted 564990737 1670439557
+See also the document classes in the Collections (section
+\begin_inset space ~
\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
-status collapsed
-\begin_layout Plain Layout
-keywords
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Collections"
\end_inset
- entry option and then filter bibliography sections by keyword (by adding
-
-\begin_inset Flex Code
-status collapsed
+).
+\end_layout
-\begin_layout Plain Layout
-keyword=mykeyword
+\begin_layout Section
+
+\change_inserted 564990737 1670439560
+Books
\end_layout
+\begin_layout Standard
+
+\change_inserted 564990737 1670439581
+See also the document classes in the Collections (section
+\begin_inset space ~
\end_inset
- to the
-\begin_inset Flex Noun
-status collapsed
-\begin_layout Plain Layout
-Options
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Collections"
\end_inset
- field of the dialog that opens if you right-click on the
-\begin_inset Flex Noun
-status collapsed
+).
+\end_layout
-\begin_layout Plain Layout
-Biblatex Generated Bibliography
+\begin_layout Section
+
+\change_inserted 564990737 1670439605
+Curricula vitarum
\end_layout
-\end_inset
+\begin_layout Section
- 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
+\change_inserted 564990737 1670439627
+Letters
+\end_layout
-g.
-
-\begin_inset Flex Code
-status collapsed
+\begin_layout Section
-\begin_layout Plain Layout
-type=book
+\change_inserted 564990737 1670439660
+Presentations
\end_layout
-\end_inset
-
- or
-\begin_inset Flex Code
-status collapsed
+\begin_layout Section
-\begin_layout Plain Layout
-nottype=collection
+\change_inserted 564990737 1670439661
+Reports
\end_layout
-\end_inset
+\begin_layout Subsection
- to the mentioned
-\begin_inset Flex Noun
-status collapsed
+\change_inserted 564990737 1670439661
+report
+\end_layout
-\begin_layout Plain Layout
-Options
+\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
-\end_inset
+\begin_layout Standard
- field, or you can create so-called
-\begin_inset Quotes eld
+\change_inserted 564990737 1670439674
+The remaining
+\family sans
+report
+\family default
+ document classes are described in the Collections (section
+\begin_inset space ~
\end_inset
-Bibliography Categories
-\begin_inset Quotes erd
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Collections"
+
\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
-\change_inserted -712698321 1501227893
+\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Multiple-Bibliographies"
+\change_inserted 564990737 1670439674
+Scripts (drama)
+\end_layout
-\end_inset
+\begin_layout Chapter
+Supplemental Tools
+\end_layout
+\begin_layout Section
+Customizing Bibliographies with Bib\SpecialChar TeX
+ or Biblatex
+\end_layout
-\change_unchanged
+\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 Subsection
+Alternative Citation Styles
\end_layout
\begin_layout Standard
-Multiple bibliographies, e.
+Standard Bib\SpecialChar TeX
+ uses numbers (e.
\begin_inset space \thinspace{}
\end_inset
\begin_inset space \space{}
\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
+[12]
+\begin_inset Quotes erd
\end_inset
- and select the relevant unit (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
-g.,
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
-per section
+Knuth 1984a
\begin_inset Quotes erd
\end_inset
-) in the
-\begin_inset Flex Noun
+).
+ \SpecialChar LyX
+ supports three packages that provide this style,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Multiple Bibliographies
+biblatex
\end_layout
\end_inset
- combo box.
- Then add a Bib(la)\SpecialChar TeX
- bibliography to each unit (e.
-\begin_inset space \thinspace{}
-\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
-
-\begin_layout Standard
-If you use Bib\SpecialChar TeX
-, either the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapterbib
+natbib
\end_layout
\end_inset
- o
-\change_deleted -712698321 1501067466
-f
-\change_inserted -712698321 1501067466
-r
-\change_unchanged
- the
+, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bibtopic
+jurabib
\end_layout
\end_inset
- package is used to create multiple bibliographies.
- The former package is used if you select
-\begin_inset Quotes eld
-\end_inset
-
-per child document
-\begin_inset Quotes erd
-\end_inset
-
- and do
-\emph on
-not
-\emph default
- check
-\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
-Sectioned Bibliography
+natbib
\end_layout
\end_inset
-.
- In all other cases,
+, then the established
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bibtopic
+natbib
\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
+ 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
-\SpecialChar TeX
- Code
+jurabib
\end_layout
\end_inset
- (see section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Inserting-TeX-Code"
-
-\end_inset
-
-), is to use the
+ 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
-bibunits
+biblatex
\end_layout
\end_inset
- package.
+, which exceeds all other packages in terms of features, but is also quite
+ heavy and more resource-hungry.
\end_layout
-\end_inset
-
- If
-\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
- is used, \SpecialChar LyX
- encloses the specified units in
-\begin_inset Flex Code
+ and select under
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-bibtopic
+Bibliography
\end_layout
\end_inset
-'s
-\begin_inset Flex Code
+ the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{btUnit}
+Style Format
\end_layout
\end_inset
- and
-\begin_inset Flex Code
+
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
+Basic (BibTeX)
+\end_layout
-\backslash
-end{btUnit}
+\end_inset
+
+,
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Biblatex
\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
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-btUnit
+Biblatex (Natbib mode)
\end_layout
\end_inset
-.
- So citations outside a defined unit (e.
-\begin_inset space \thinspace{}
+,
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Natbib (BibTeX)
+\end_layout
+
\end_inset
-g., before the first section if you use
+ or
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Jurabib (BibTeX)
+\end_layout
+
+\end_inset
+
+ (see sec.
+\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 (
\begin_inset Quotes eld
\end_inset
-by section
+Knuth 1984
\begin_inset Quotes erd
\end_inset
-) will appear as
+,
\begin_inset Quotes eld
\end_inset
-???
+Knuth (1984)
\begin_inset Quotes erd
\end_inset
-.
- You can also create your own units by entering
-\begin_inset Flex Code
-status collapsed
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+Knuth, 1984
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{btUnit}
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
+1984
+\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Flex Code
+ 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
+See
+\begin_inset Flex URL
+status open
-\backslash
-end{btUnit}
+\begin_layout Plain Layout
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
\end_layout
\end_inset
- 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
-s cannot be nested.
- A second limitation is that
+ for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bibtopic
+natbib
\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{}
-\end_inset
+.
+\end_layout
-g.
-
+\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
-Miller 2014b
+must have
\begin_inset Quotes erd
\end_inset
- if two works of this author from 2014 are in the database, even if only
- one is cited).
+.
+ Unfortunately, Bib\SpecialChar TeX
+ itself does not allow you to do this.
+ But with the help of some \SpecialChar LaTeX
+ packages, Bib\SpecialChar TeX
+ can be extended to fit your needs.
\end_layout
\begin_layout Standard
-If you use
-\family sans
-Biblatex
+\SpecialChar LyX
+ provides native support for one of these packages,
+\family typewriter
+bibtopic
\family default
-, the
-\begin_inset Flex Code
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-refsection
+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
- 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
-\backslash
-newrefsection
\end_layout
\end_inset
- or
+ 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
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Scientific works
+\begin_inset Quotes erd
+\end_inset
+
+, you first need to create two bibliographic databases, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newrefsegment
+sources.bib
\end_layout
\end_inset
-, respectively.
- If you also want to control the end of the unit, use the environment
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{refsection}
+scientific.bib
\end_layout
\end_inset
- \SpecialChar ldots
+.
-\begin_inset Flex Code
+\end_layout
+
+\begin_layout Standard
+Go to
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{refsection}
+Document\SpecialChar menuseparator
+Settings
\end_layout
\end_inset
- instead.
- Note, though, that
-\begin_inset Flex Code
+ and check under
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-refsection
+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.
-\begin_inset space \thinspace{}
-\end_inset
+ the option
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Subdivided bibliography
+\end_layout
-g., at the end of the document).
- Select
-\begin_inset Quotes eld
\end_inset
-all reference units
-\begin_inset Quotes erd
+.
+ Now you can insert multiple Bib\SpecialChar TeX
+ bibliographies, one for each section of
+ your bibliography.
+ Returning to our example: Insert the Bib\SpecialChar TeX
+ bibliography
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+sources.bib
+\end_layout
+
\end_inset
- 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
+ and a second one for the database
+\begin_inset Flex Code
+status collapsed
-\begin_layout Section
-Multipart Documents
+\begin_layout Plain Layout
+scientific.bib
\end_layout
-\begin_layout Subsection
-General Operation
-\end_layout
+\end_inset
-\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
+.
+ 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
-master
+all cited references
\begin_inset Quotes erd
\end_inset
- file which contains the title, authors, abstract, references, etc., plus
- the five included files.
- It is important to note that each of these files is a full \SpecialChar LyX
- file which
- can be formatted and printed on its own, as well as included in a master
- file.
- Each of these files must have the same document class, however—don't attempt
- to mix book classes with article classes.
- You may also include \SpecialChar LaTeX
- files; however, these files must not have their own
- preamble (i.
-\begin_inset space \thinspace{}
+ of the specified database(s) (which is the default),
+\begin_inset Quotes eld
\end_inset
-e.
-\begin_inset space \space{}
+all uncited references
+\begin_inset Quotes erd
\end_inset
-everything up to and including the
-\begin_inset Flex Code
-status collapsed
+ or even
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+all references
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{document}
-\end_layout
+.
+ 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
- line as well as the
+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
-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.
+ removes the bibliography title, you have to manually re-add that, too (as
+ a chapter* or section*, for instance).
\end_layout
\begin_layout Standard
-\SpecialChar LyX
- allows you to include files quite easily with
+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
-Insert\SpecialChar menuseparator
-Chi
-\change_deleted -712698321 1501147443
-I
-\change_inserted -712698321 1501147443
-l
-\change_unchanged
-d
-\begin_inset space ~
-\end_inset
-
-Document
+Subdivided bibliography
\end_layout
\end_inset
+ option is disabled if you use
+\family sans
+Biblatex
+\family default
.
- 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.
-
+ 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
+keywords
\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
+ entry option and then filter bibliography sections by keyword (by adding
+
+\begin_inset Flex Code
+status collapsed
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+keyword=mykeyword
+\end_layout
-input
-\begin_inset Quotes erd
\end_inset
-, and
-\begin_inset Quotes eld
-\end_inset
+ to the
+\begin_inset Flex Noun
+status collapsed
-verbatim
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Options
+\end_layout
-.
- The
-\change_deleted -712698321 1501225702
-difference between
-\change_inserted -712698321 1501225703
-methods
-\change_unchanged
-
-\begin_inset Quotes eld
\end_inset
-include
-\begin_inset Quotes erd
-\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
- and
-\begin_inset Quotes eld
\end_inset
-input
-\begin_inset Quotes erd
+ 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.
-\change_deleted -712698321 1501225710
-is really only meaningful to \SpecialChar LaTeX
-perts
-\change_inserted -712698321 1501225747
-are similar in many ways, but there are also some notable differences:
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Enumerate
+\begin_layout Plain Layout
+type=book
+\end_layout
-\change_deleted -712698321 1501225754
-, but the practical difference is that f
-\change_inserted -712698321 1501225754
-F
-\change_unchanged
-iles that are
-\begin_inset Quotes eld
\end_inset
-included
-\begin_inset Quotes erd
-\end_inset
+ or
+\begin_inset Flex Code
+status collapsed
- are typeset beginning on a new page, while files that are
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+nottype=collection
+\end_layout
-inputted
-\begin_inset Quotes erd
\end_inset
- are typeset starting on the current page.
-\change_inserted -712698321 1501225760
+ to the mentioned
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Options
\end_layout
-\begin_layout Enumerate
+\end_inset
-\change_inserted -712698321 1501225830
+ field, or you can create so-called
\begin_inset Quotes eld
\end_inset
-Included
+Bibliography Categories
\begin_inset Quotes erd
\end_inset
- files cannot themselves
-\begin_inset Quotes eld
-\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"
-include
-\begin_inset Quotes erd
\end_inset
- further files (
-\begin_inset Quotes eld
-\end_inset
-grandchilds
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-).
- With
-\begin_inset Quotes eld
+\begin_layout Standard
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
\end_inset
-input
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-, on the other hand, infinite sub-inputting is possible.
-\end_layout
+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 Enumerate
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
+\end_layout
-\change_inserted -712698321 1501226017
-\begin_inset Quotes eld
\end_inset
-Include
-\begin_inset Quotes erd
+ and select the relevant unit (e.
+\begin_inset space \thinspace{}
\end_inset
- allow for the output of only selected
+g.,
\begin_inset Quotes eld
\end_inset
-included
+per section
\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).
-\change_unchanged
+) in the
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Multiple Bibliographies
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1501225947
-Hence,
-\begin_inset Quotes eld
\end_inset
-include
-\begin_inset Quotes erd
+ combo box.
+ Then add a Bib(la)\SpecialChar TeX
+ bibliography to each unit (e.
+\begin_inset space \thinspace{}
\end_inset
- is the preferred method for chapters that are outsourced to child documents,
- while
-\begin_inset Quotes eld
-\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
-input
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+If you use Bib\SpecialChar TeX
+, either the
+\begin_inset Flex Code
+status collapsed
- is more suitable for arbitrary file inheritance.
+\begin_layout Plain Layout
+chapterbib
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted -712698321 1501226562
-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.
-\change_unchanged
+ or the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+bibtopic
\end_layout
-\begin_layout Standard
-A
+\end_inset
+
+ package is used to create multiple bibliographies.
+ The former package is used if you select
\begin_inset Quotes eld
\end_inset
-verbatim
+per child document
\begin_inset Quotes erd
\end_inset
- included file allows you to include a file typeset exactly as it appears
- in the file, i.
-\begin_inset space \thinspace{}
-\end_inset
+ and do
+\emph on
+not
+\emph default
+ check
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Sectioned Bibliography
+\end_layout
-e.
-\begin_inset space \space{}
\end_inset
-in
+.
+ In all other cases,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-verbatim
+bibtopic
\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
+ 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
-Mark
-\begin_inset space ~
+\SpecialChar TeX
+ Code
+\end_layout
+
\end_inset
-spaces
+ (see section
\begin_inset space ~
\end_inset
-in
-\begin_inset space ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
+
\end_inset
-output
+), is to use the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+bibunits
\end_layout
\end_inset
- checkbox typesets a mark to unambiguously define the presence of a space.
-
-\change_inserted -712698321 1501226563
-
+ package.
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1501226564
-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.
-\change_unchanged
+ If
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+bibtopic
\end_layout
-\begin_layout Subsection
-Cross-References Between Files
-\end_layout
+\end_inset
-\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
+ is used, \SpecialChar LyX
+ encloses the specified units in
+\begin_inset Flex Code
+status collapsed
\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]]
+bibtopic
\end_layout
\end_inset
+'s
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\backslash
+begin{btUnit}
\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
+ and
+\begin_inset Flex Code
+status collapsed
- to use.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
-Bibliography Lists in all Subdocuments
+\backslash
+end{btUnit}
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted -712698321 1501227275
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 0
-use_makebox 0
-width "100col%"
-special "none"
-height "1in"
-height_special "totalheight"
-thickness "0.4pt"
-separation "3pt"
-shadowsize "4pt"
-framecolor "black"
-backgroundcolor "none"
-status open
+ 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
-This section also needs updating.
- There is now material about this on the wiki, and it could be copied here.
+btUnit
\end_layout
\end_inset
-
-\change_unchanged
-
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted -712698321 1501226979
-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
-
-\change_inserted -712698321 1501227105
-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
-
-\change_inserted -712698321 1501227910
-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.
+.
+ So citations outside a defined unit (e.
\begin_inset space \thinspace{}
\end_inset
-g.
- called
+g., before the first section if you use
\begin_inset Quotes eld
\end_inset
-Childonly
+by section
\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
-
-\change_inserted -712698321 1501228082
-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 ~
+) will appear as
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Multiple-Bibliographies"
-
+???
+\begin_inset Quotes erd
\end_inset
.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -712698321 1501227257
-Copy the bibliography list with all entries to all subdocuments and transform
- them to a comment.
- This way \SpecialChar LyX
- will find the
+ You can also create your own units by entering
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.bib
-\end_layout
-\end_inset
-
--files and you can easily insert references without making the bibliography
- list visible.
+\backslash
+begin{btUnit}
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted -712698321 1501227257
-As the bibliography list is in a comment, \SpecialChar LaTeX
- won't use it and the references
- will look like this: [?], instead of like this: [1].
- One solution is to use the \SpecialChar LaTeX
--package
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-comment
-\end_layout
-
-\end_inset
-
- that will only include comments by processing the files separately.
- To do this, add in the \SpecialChar LaTeX
- preamble of every subdocument the following:
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted -712698321 1501227257
\backslash
-usepackage{comment}
+end{btUnit}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\change_deleted -712698321 1501227257
+ as \SpecialChar TeX
+ code (for instance to work around the mentioned limitation).
+ Note, though, that
+\begin_inset Flex Code
+status collapsed
-\backslash
-includecomment{comment}
+\begin_layout Plain Layout
+btUnit
\end_layout
-\begin_layout Standard
+\end_inset
-\change_deleted -712698321 1501227257
-See also
-\begin_inset Flex URL
-status open
+s cannot be nested.
+ A second limitation is that
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-http://wiki.lyx.org/FAQ/Unsorted#toc31
+bibtopic
\end_layout
\end_inset
-.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Section
-\SpecialChar LyX
- Archives
-\end_layout
+ 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
-\begin_layout Standard
-Users sometimes need to be able to
+g.
+
\begin_inset Quotes eld
\end_inset
-bundle
+Miller 2014b
\begin_inset Quotes erd
\end_inset
- a \SpecialChar LyX
- file together with all the images (and other files) on which it depends,
- either for sending to a publisher or for sharing with a co-author.
- \SpecialChar LyX
- 2.0 includes a Python script (
+ if two works of this author from 2014 are in the database, even if only
+ one is cited).
+\end_layout
+
+\begin_layout Standard
+If you use
+\family sans
+Biblatex
+\family default
+, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpak.py
+refsection
\end_layout
\end_inset
-) that automates this process.
- To use it, you must have either the
+ 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
-zipfile
+
+\backslash
+newrefsection
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tarfile
+
+\backslash
+newrefsegment
\end_layout
\end_inset
- python modules installed on your system.
- By default, the script prefers the
+, 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
-gzip
+
+\backslash
+begin{refsection}
\end_layout
\end_inset
--compressed
+ \SpecialChar ldots
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tar
+
+\backslash
+end{refsection}
\end_layout
\end_inset
- format on Unix-like systems and the
+ instead.
+ Note, though, that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-zip
+refsection
\end_layout
\end_inset
- format on Windows.
-\end_layout
+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.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-\SpecialChar LyX
-'s configuration process will set the script up to export a `\SpecialChar LyX
- Archive',
- and this format will then be available under
-\begin_inset Flex Code
-status collapsed
+g., at the end of the document).
+ Select
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-File\SpecialChar menuseparator
-Export
+all reference units
+\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
-\end_inset
+\begin_layout Section
+Multipart Documents
+\end_layout
-.
+\begin_layout Subsection
+General Operation
\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
-
+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
- (for the
-\begin_inset Flex Code
-status collapsed
+master
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-tar
-\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
+e.
+\begin_inset space \space{}
\end_inset
- format) or
+everything up to and including the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--z
+
+\backslash
+begin{document}
\end_layout
\end_inset
- (for the
+ line as well as the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-zip
+
+\backslash
+end{document}
\end_layout
\end_inset
- format) switch to the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar LyX
-\SpecialChar menuseparator
-\SpecialChar LyX
- Archive
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
\end_layout
-\end_inset
-
- converter in
-\begin_inset Flex Code
+\begin_layout Standard
+\SpecialChar LyX
+ allows you to include files quite easily with
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
+Insert\SpecialChar menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
\end_layout
\end_inset
.
- (Make sure you add the switch after the script name, not before it.)
-\end_layout
-
-\begin_layout Section
-Fancy Headers and Footers
+ When you click on this selection a small box is inserted into the file
+ at the current cursor location.
+ Clicking on the box raises a dialog which allows you to select the file
+ to be included, and the method of its inclusion.
+
\end_layout
\begin_layout Standard
-The default page layout is rather plain; for an
-\begin_inset Flex Code
-status collapsed
+The file selection box should by now be obvious.
+ The three inclusion methods are
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-article
-\end_layout
+include
+\begin_inset Quotes erd
+\end_inset
+,
+\begin_inset Quotes eld
\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
-
+input
+\begin_inset Quotes erd
+\end_inset
+
+, and
\begin_inset Quotes eld
\end_inset
-fancy
+verbatim
\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
+ The methods
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-For more information on fancy headers, see the
-\begin_inset Flex Code
-status collapsed
+include
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-fancyhdr
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
+input
+\begin_inset Quotes erd
\end_inset
- package documentation.
- (
-\begin_inset Flex URL
-status collapsed
+ are similar in many ways, but there are also some notable differences:
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
+Files that are
+\begin_inset Quotes eld
+\end_inset
-http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
-\end_layout
+included
+\begin_inset Quotes erd
+\end_inset
+
+ are typeset beginning on a new page, while files that are
+\begin_inset Quotes eld
+\end_inset
+inputted
+\begin_inset Quotes erd
\end_inset
-)
+ are typeset starting on the current page.
\end_layout
-\begin_layout Standard
-The page header is divided into three fields, not surprisingly labeled
+\begin_layout Enumerate
\begin_inset Quotes eld
\end_inset
-left
+Included
\begin_inset Quotes erd
\end_inset
-,
+ files cannot themselves
\begin_inset Quotes eld
\end_inset
-center
+include
\begin_inset Quotes erd
\end_inset
-, and
+ further files (
\begin_inset Quotes eld
\end_inset
-right
+grandchilds
\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
+).
+ With
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+input
+\begin_inset Quotes erd
+\end_inset
-\backslash
-lhead
+, on the other hand, infinite sub-inputting is possible.
\end_layout
+\begin_layout Enumerate
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+Include
+\begin_inset Quotes erd
+\end_inset
-\backslash
-chead
-\end_layout
+ allow for the output of only selected
+\begin_inset Quotes eld
+\end_inset
+included
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+ files, while maintaining the actual counters (pagination etc.) and references
+ (please refer to the section
+\emph on
+Child
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
+Documents
+\emph default
+ of the
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
-\backslash
-rhead
+Objects
+\emph default
+ manual for details).
\end_layout
+\begin_layout Standard
+Hence,
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+include
+\begin_inset Quotes erd
+\end_inset
-\backslash
-lfoot
-\end_layout
+ is the preferred method for chapters that are outsourced to child documents,
+ while
+\begin_inset Quotes eld
+\end_inset
+input
+\begin_inset Quotes erd
\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:
+ is more suitable for arbitrary file inheritance.
\end_layout
\begin_layout Standard
+A
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
-
-\backslash
-lhead{John Q.
- DocWriter}
-\end_layout
+verbatim
+\begin_inset Quotes erd
+\end_inset
-\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.
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.
\begin_inset space \thinspace{}
\end_inset
-g.:
-\end_layout
-
-\begin_layout Standard
+e.
+\begin_inset space \space{}
+\end_inset
-\family typewriter
+in
+\begin_inset Flex Code
+status collapsed
-\backslash
-cfoot{}
+\begin_layout Plain Layout
+verbatim
\end_layout
-\begin_layout Standard
-Let's get really fancy: lets put the section number with the word
-\begin_inset Quotes eld
\end_inset
-Section
-\begin_inset Quotes erd
-\end_inset
+ 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
- (e.
-\begin_inset space \thinspace{}
+\begin_layout Plain Layout
+Mark
+\begin_inset space ~
\end_inset
-g.
-\begin_inset space \space{}
+spaces
+\begin_inset space ~
\end_inset
-Section 3) in the upper left, the page number (e.
-\begin_inset space \thinspace{}
+in
+\begin_inset space ~
\end_inset
-g.
-\begin_inset space \space{}
+output
+\end_layout
+
\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:
+ 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
-lhead{Section
-\backslash
-thesection}
+\begin_layout Subsection
+Cross-References Between Files
\end_layout
\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+This section is somewhat out of date.
+ Need to describe default master documents and how children are opened when
+ the master is.
+ [[FIXME]]
+\end_layout
+
+\end_inset
-\family typewriter
-\backslash
-chead{}
\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
-\family typewriter
+buffer
+\begin_inset Quotes erd
+\end_inset
-\backslash
-rhead{Page
-\backslash
-thepage}
+ to use.
\end_layout
-\begin_layout Standard
+\begin_layout Subsection
+Bibliography Lists in all Subdocuments
+\end_layout
-\family typewriter
+\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
-\backslash
-lfoot{John Q.
- DocWriter}
+\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 (
+\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
-cfoot{}
+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
-rfoot{
-\backslash
-today}
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Multiple-Bibliographies"
+
+\end_inset
+
+.
+\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 numbers.
-
+ 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
-\noindent
-
-\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.
- A text entry under the table shows the currently selected bullet shape's
- \SpecialChar LaTeX
- equivalent and this can be edited if desired.
- If you do modify the text you will also need to specify any needed packages
- in the \SpecialChar LaTeX
- preamble.
-\end_layout
+The page header is divided into three fields, not surprisingly labeled
+\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
+left
+\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
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+center
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Button
-\end_layout
+, and
+\begin_inset Quotes eld
+\end_inset
+right
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+.
+ 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
-Packages Required
+\backslash
+lhead
\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
+chead
\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
+rhead
\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
-Maths
+\backslash
+lfoot
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-amssymb.sty
+, 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
-\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
-Ding1
+\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
-pifont.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
-Ding2
-\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
-Ding3
+\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" 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
+rhead{Page
+\backslash
+thepage}
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Plain Layout
+\begin_layout Standard
\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
-
+\backslash
+lfoot{John Q.
+ DocWriter}
\end_layout
\begin_layout Standard
-\SpecialChar LyX
- doesn't stop you using bullets from packages you don't have.
- If you get errors from \SpecialChar LaTeX
- when you try to view or print the file, then it
- is likely you are missing a package.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-\SpecialChar LyX
- doesn't restrict your use since you may be editing locally and exporting
- elsewhere.
-\end_layout
-
-\end_inset
-
-\end_layout
+\family typewriter
-\begin_layout Subsection
-How to use it
+\backslash
+cfoot{}
\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
+\family typewriter
-\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
+rfoot{
+\backslash
+today}
\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\begin_layout Standard
+The commands
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-\backslash
-let
-\backslash
-savelabelitemi=
\backslash
-labelitemi
+thesection
\end_layout
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\backslash
+thepage
\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\end_inset
-\begin_layout Plain Layout
+ 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
\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
+today
\end_layout
\end_inset
-
+ simply prints out today's date.
\end_layout
-\begin_layout Itemize
-Use the \SpecialChar LaTeX
- command
+\begin_layout Standard
+The thicknesses of the horizontal rules drawn beneath the header and above
+ the footer can also be modified.
+ If you don't want one of the rules, set its thickness to 0.
+ The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
+ Use commands
+\family typewriter
+
+\family default
+like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-renewcommand{}{}
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
\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=
+renewcommand{
\backslash
-labelitemi
+footrulewidth}{0.4pt}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
+ to set the thicknesses.
\end_layout
-\end_deeper
-\begin_layout Itemize
-Note that the itemize depth is specified in Roman numerals as part of the
-
-\family typewriter
+\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
-labelitem
-\family default
- command.
+thispagestyle{empty}
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted -712698321 1501149643
-\begin_inset ERT
-status open
+,
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-\change_deleted -712698321 1501149634
-
-[
-\change_unchanged
-
-\backslash
-(
\backslash
-star
-\backslash
-)
-\change_deleted -712698321 1501149636
-]
-\change_unchanged
-
+thispagestyle{plain}
\end_layout
\end_inset
+, and
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1501149643
+\begin_layout Plain Layout
-\begin_inset Argument item:1
-status open
+\backslash
+thispagestyle{fancy}
+\end_layout
-\begin_layout Plain Layout
+\end_inset
-\change_inserted -712698321 1501149643
-\begin_inset ERT
-status open
+.
+ Simply insert them in the text on the page you want changed and mark them
+ as \SpecialChar TeX
+ code.
+ In fact, title pages are marked as plain by default, while following pages
+ are marked fancy when using the global fancy setting.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+As a final example, it is possible to include an image in the header or
+ footer.
+ Suppose you want to put a company logo in the upper lefthand corner.
+ You might try something like
+\end_layout
-\change_inserted -712698321 1501149643
+\begin_layout Standard
+\family typewriter
\backslash
-(
+lhead{
\backslash
-star
+resizebox{1in}{!}{
\backslash
-)
+includegraphics{logo.eps}}}
\end_layout
-\end_inset
-
+\begin_layout Standard
+\noindent
+(you may need to preface this with
+\begin_inset Flex Code
+status collapsed
-\change_unchanged
+\begin_layout Plain Layout
+\backslash
+usepackage{graphics}
\end_layout
\end_inset
+ if you don't include graphics elsewhere in your document).
+\end_layout
-\change_unchanged
- Specify each individual entry by starting each item with the bullet shape
- enclosed in
-\change_deleted -712698321 1501149707
-square brackets
-\change_inserted -712698321 1501149740
-a
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bullet"
-Custom Item
-\begin_inset Quotes erd
\end_inset
- inset (available at
-\family sans
-Insert\SpecialChar menuseparator
-Custom Item
-\family default
-)
-\change_unchanged
- and set as
-\begin_inset Flex Noun
-status collapsed
-\begin_layout Plain Layout
-\SpecialChar TeX
- Code
\end_layout
-\end_inset
+\begin_layout Standard
+by
+\noun on
+ Allan Rae
+\end_layout
-.
- For example, this item was started with
-\begin_inset Flex Code
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ provides 216 bullet shapes that can be accessed from a simple dialog.
+ Using this dialog you can easily specify what bullet shape to use at each
+ level of an itemized list.
+ These settings are document-wide so you won't be able to specify different
+ sets of bullets for different paragraphs.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
+Well, actually you can but you'll have to do it by hand.
+\end_layout
-\change_deleted -712698321 1501149692
-[
-\change_unchanged
+\end_inset
-\backslash
-(
-\backslash
-star
-\backslash
-)
-\change_deleted -712698321 1501149693
-]
-\change_unchanged
\end_layout
-\end_inset
-
-.
+\begin_layout Subsection
+How it looks
\end_layout
-\begin_layout Plain Layout
-\begin_inset ERT
-status open
+\begin_layout Standard
+Open the dialog by selecting the
+\begin_inset Flex Noun
+status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+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 vers
-\change_inserted -712698321 1501076595
-i
-\change_unchanged
-on 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
-\end_layout
-\end_inset
-
-, though the others will.
- The other issue concerns how math is handled.
- These converters typically convert the formulae into little pictures that
- are then linked from the HTML document.
- Since these are actually generated by \SpecialChar LaTeX
-, they are accurate.
- But they do not scale well, and just getting them to look as if they are
- actually meant to be in your document—so that the font sizes seem to be
- roughly the same—can be a challenge.
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding1
\end_layout
-\begin_layout Standard
-Alex Fernandez's
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</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
- (
-\begin_inset CommandInset href
-LatexCommand href
-name "http://elyxer.nongnu.org/"
-target "http://elyxer.nongnu.org/"
-literal "false"
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
\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
+</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
+Ding2
\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" 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
+Ding3
\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" 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
-
- 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
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="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
+Ding4
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
- 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.
+\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
-As of this writing, XHTML output remains under development and should probably
- be regarded as
-\begin_inset Quotes eld
\end_inset
+</cell>
+</row>
+</lyxtabular>
-experimental
-\begin_inset Quotes erd
\end_inset
-.
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-The file
-\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
-development/
-\change_inserted -712698321 1501078933
-HTML/
-\change_unchanged
-HTML.notes
+\SpecialChar LyX
+ doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
\end_layout
\end_inset
-, which can be found in the \SpecialChar LyX
- source tree or
-\begin_inset CommandInset href
-LatexCommand href
-name "accessed online"
-target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
-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 "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
-literal "false"
-
-\end_inset
-.
\end_layout
-\end_inset
-
- Still, the developers have chosen this approach because it has several
- potential advantages over the other two.
+\begin_layout Subsection
+How to use it
\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.
+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
-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.
+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
-\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
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
-Chapter 1
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- or
-\begin_inset Quotes eld
-\end_inset
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
-\lang ngerman
-Kapitel
-\lang english
- 1
-\begin_inset Quotes erd
\end_inset
-, depending upon the language in effect at the time.
-
-\end_layout
-\begin_layout Standard
-Quite generally, the output routines know what \SpecialChar LyX
- knows about document layout,
- that is, about how the document is to be rendered on screen.
- We use this information when we output the document as XHTML.
- In particular, \SpecialChar LyX
-
-\emph on
-automatically
-\emph default
- generates CSS style information corresponding to the layout information
- it uses to render the document on screen: if section headings are supposed
- to be sans-serif and bold as seen in \SpecialChar LyX
-, then (by default) they will be sans-seri
-f and bold when viewed in a web browser, too.
- And this is true not just for pre-defined styles, like Section, but for
- any style, including user-defined styles.
- Indeed, the XHTML output routines make no distinction between user-defined
- paragraph and character styles and \SpecialChar LyX
-'s own pre-defined styles: in each case,
- everything \SpecialChar LyX
- knows about the styles is contained in the layout files.
- And much the same is true as regards pre-defined textual insets, such as
- footnotes, and various custom insets.
-
\end_layout
-\begin_layout Standard
-The result is that XHTML output can be customized and extended in exactly
- the same way \SpecialChar LaTeX
- output can be customized and extended: through layout files
- and modules.
- See chapter five of the
-\emph on
-Customization
-\emph default
-manual for the details.
-\end_layout
+\begin_layout Plain Layout
+\begin_inset ERT
+status open
-\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 Plain Layout
-\begin_layout Section
-Math Output in XHTML
-\end_layout
-\begin_layout Standard
-\SpecialChar LyX
- offers four choices for how math is rendered.
- These have various advantages and disadvantages:
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
\end_layout
-\begin_layout Itemize
-MathML
-\begin_inset Newline newline
\end_inset
-MathML is a dialect of XML designed specifically for mathematics on the
- web, and it typically renders very well in browsers that support it.
- The disadvantage is that not all browsers support MathML, and support is
- not complete even in the Gecko-based browsers, such as Firefox.
-\begin_inset Newline newline
-\end_inset
-If \SpecialChar LyX
- is unable to render a formula as MathML—for example, if the formula
- uses the
+\end_layout
+
+\begin_layout Itemize
+Use the \SpecialChar LaTeX
+ command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xymatrix
+
+\backslash
+renewcommand{}{}
\end_layout
\end_inset
- package or ERT—then it will instead output the formula as an image.
-
+ 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_layout Itemize
-HTML
-\begin_inset Newline newline
-\end_inset
+\begin_deeper
+\begin_layout LyX-Code
-As mentioned above,
-\begin_inset Flex Code
-status collapsed
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
-\begin_layout Plain Layout
-elyxer
+\begin_layout LyX-Code
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
\end_layout
-\end_inset
+\end_deeper
+\begin_layout Itemize
+Note that the itemize depth is specified in Roman numerals as part of the
+
+\family typewriter
- outputs math as HTML, styled by CSS.
-\begin_inset Foot
-status collapsed
+\backslash
+labelitem
+\family default
+ command.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Argument item:1
+status open
\begin_layout Plain Layout
-\SpecialChar LyX
- has borrowed some of the CSS for its HTML output from
-\begin_inset Flex Code
-status collapsed
+\begin_inset ERT
+status open
\begin_layout Plain Layout
-elyxer
+
+
+\backslash
+(
+\backslash
+star
+\backslash
+)
\end_layout
\end_inset
-.
+
\end_layout
\end_inset
- For simple formulae, this can work quite well, though with more complicated
- formulae it tends to break down.
- Still, this method has the advantage that it is very widely supported and
- so it may be appropriate for documents that contain only a little, fairly
- simple math.
-\begin_inset Newline newline
+ Specify each individual entry by starting each item with the bullet shape
+ enclosed in a
+\begin_inset Quotes eld
\end_inset
-If Lyx is unable to render a formula as HTML—for example, if the formula
- uses the
-\begin_inset Flex Code
+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
\begin_layout Plain Layout
-xymatrix
-\end_layout
-
-\end_inset
-
- package or ERT—then it will instead output the formula as an image.
-
+\SpecialChar TeX
+ Code
\end_layout
-\begin_layout Itemize
-Images
-\begin_inset Newline newline
\end_inset
-Like
+.
+ For example, this item was started with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-htlatex
-\end_layout
+
+\backslash
+(
+\backslash
+star
+\backslash
+)
+\end_layout
\end_inset
-, \SpecialChar LyX
- will output formulae as images, the very same images, in fact, that are
- used for instant preview.
-\begin_inset Foot
-status collapsed
+.
+\end_layout
\begin_layout Plain Layout
-Instant preview does
-\emph on
-not
-\emph default
-have to be on for images to be output, however.
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
\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.
-\change_deleted -712698321 1501075981
- (As of this writing, there are also problems about equation numbering.
- See
-\begin_inset CommandInset href
-LatexCommand href
-name "bug 6894"
-target "http://www.lyx.org/trac/ticket/6894"
-literal "false"
+\end_layout
-\end_inset
+\begin_layout Plain Layout
+You'll also need to revert the labelitem back to its previous setting for
+ the global bullet shape settings to remain in effect.
+ The way used here was:
+\end_layout
-.)
-\change_unchanged
+\begin_layout LyX-Code
-\begin_inset Newline newline
-\end_inset
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
-The size of the images can be controlled by setting the
-\begin_inset Quotes eld
\end_inset
-Math Images Scaling
-\begin_inset Quotes erd
-\end_inset
- parameter under
-\begin_inset Flex Noun
+\end_layout
+
+\begin_layout Chapter
+\SpecialChar LyX
+ and the World Wide Web
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before version 2.0, however, HTML export was always accomplished by the
+ use of external converters.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
+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
-\change_deleted -712698321 1501076136
-Output
-\change_inserted -712698321 1501076137
-Formats
-\change_unchanged
+\end_inset
+
+ These fall into two large groups: there are converters that use \SpecialChar LaTeX
+ as an
+ intermediate format, such as
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+htlatex
\end_layout
\end_inset
-.
-\begin_inset Foot
+,
+\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.
+html2latex
\end_layout
\end_inset
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plastex
+\end_layout
-\begin_inset Newline newline
\end_inset
-If \SpecialChar LyX
- for some reason fails to create an image for a formula (e.g., if a required
- \SpecialChar LaTeX
- package is not installed), then it will fall back to outputing the raw
- \SpecialChar LaTeX
-.
-\end_layout
+, relying upon \SpecialChar LyX
+ to produce the \SpecialChar LaTeX
+; and there is a converter that works directly
+ on \SpecialChar LyX
+ files,
+\begin_inset Flex Code
+status collapsed
-\begin_layout Itemize
-\SpecialChar LaTeX
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
+\end_layout
-\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
+e\SpecialChar LyX
+er
+\end_layout
-\change_deleted -712698321 1501076586
-Output
-\change_inserted -712698321 1501076587
-Formats
-\change_unchanged
+\end_inset
-\end_layout
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://pinchito.es/elyxer/"
+target "http://pinchito.es/elyxer/"
+literal "false"
\end_inset
-.
- By default, \SpecialChar LyX
- outputs MathML.
- This is a document-wide setting, therefore.
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+htlatex
\end_layout
-\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.
+\end_inset
+
+; this reflects the limitations of HTML.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-That said, since \SpecialChar LyX
- falls back to images if the inset contains ERT, then one
- can force output as an image by putting some harmless ERT into the math,
- for example:
-\begin_inset Formula $a=b\relax$
-\end_inset
+That said,
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
\end_inset
-
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
\end_layout
-\begin_layout Section
-Bibliography and Citations
-\end_layout
+\end_inset
-\begin_layout Standard
-XHTML output fully supports bibliographies and citations.
-
-\end_layout
+ More importantly (as of version 1.1.1, at least),
+\begin_inset Flex Code
+status collapsed
-\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.
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\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_inset
+
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
+ These limitations make
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+e\SpecialChar LyX
+er
\end_layout
-\begin_layout Standard
-The 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_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 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
-Context and Logical Form
+experimental
\begin_inset Quotes erd
\end_inset
-, in
-\emph on
-Language in Context: Selected Essays
-\emph default
- (Oxford: Oxford University Press, 2007), pp.
- 30–68.
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/HTML/HTML.notes
\end_layout
-\begin_layout Quote
-Jason Stanley,
-\begin_inset Quotes eld
\end_inset
-Semantics in Context
-\begin_inset Quotes erd
+, 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
-, in
-\emph on
-Language in Context: Selected Essays
-\emph default
- (Oxford: Oxford University Press, 2007), pp.
- 201–30.
-\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 Standard
-This should be fixed before long.
-\end_layout
+\end_inset
-\begin_layout Standard
-There is no support at present for sectioned bibliographies.
- If you have multiple bibliographies, then \SpecialChar LyX
- will print the same bibliography
- over and over.
+.
\end_layout
-\begin_layout Section
-Indexes
-\end_layout
+\end_inset
-\begin_layout Standard
-\SpecialChar LyX
- will happily export indexes as XHTML, but with certain limitations at the
- moment.
+ 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
+\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
-entry|textbf
-\begin_inset Quotes erd
-\end_inset
+\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
-.
- Indeed, if \SpecialChar LyX
- finds a pipe symbol, `|', in an entry, it will delete it and
- everything that follows it.
-\end_layout
-
-\begin_layout Itemize
-Multiple Indexes: There is no support for multiple indexes.
- Rather, all index entries will be printed as one large index.
- To avoid our printing several versions of the index, we print only the
- main index, so make sure you have one.
-\end_layout
-
-\begin_layout Section
-Nomenclature and Glossary
+\begin_layout Section
+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.
-\end_layout
-
-\begin_layout Chapter
-The \SpecialChar LyX
- Server
-\end_layout
-
-\begin_layout Section
-Introduction
+\SpecialChar LyX
+ offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
\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
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
\end_inset
-push
-\begin_inset Quotes erd
+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
- citations to \SpecialChar LyX
-.
-\end_layout
-
-\begin_layout Section
-Starting the \SpecialChar LyX
- Server
-\change_inserted -712698321 1501232552
+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_inset CommandInset label
-LatexCommand label
-name "sec:Starting-the-Server"
+\begin_layout Plain Layout
+xymatrix
+\end_layout
\end_inset
-
-\change_unchanged
-
+ package or ERT—then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Standard
-The \SpecialChar LyX
- server works through the use of a pair of named pipes.
- These are usually located in
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
+\end_inset
+
+As mentioned above,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir
+elyxer
\end_layout
\end_inset
-, (except on Windows, where
-\emph on
-local
-\emph default
- named pipes are special objects located in
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar LyX
+ has borrowed some of the CSS for its HTML output from
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+elyxer
+\end_layout
-\backslash
+\end_inset
-\backslash
.
-\backslash
-pipe
\end_layout
\end_inset
-) and have the names
-\begin_inset Quotes eld
+ For simple formulae, this can work quite well, though with more complicated
+ formulae it tends to break down.
+ Still, this method has the advantage that it is very widely supported and
+ so it may be appropriate for documents that contain only a little, fairly
+ simple math.
+\begin_inset Newline newline
\end_inset
-
+If Lyx is unable to render a formula as HTML—for example, if the formula
+ uses the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+xymatrix
\end_layout
\end_inset
+ package or ERT—then it will instead output the formula as an image.
+
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
+\begin_layout Itemize
+Images
+\begin_inset Newline newline
\end_inset
-
+Like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+htlatex
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- External programs write into
-\begin_inset Flex Code
+, \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
-lyxpipe.in
+Instant preview does
+\emph on
+not
+\emph default
+have to be on for images to be output, however.
\end_layout
\end_inset
- and read back data from
-\begin_inset Flex Code
-status collapsed
+ 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 Plain Layout
-lyxpipe.out
-\end_layout
+The size of the images can be controlled by setting the
+\begin_inset Quotes eld
+\end_inset
+Math Images Scaling
+\begin_inset Quotes erd
\end_inset
-.
- The stem of the pipe names can be defined in the
+ parameter under
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\end_layout
\end_inset
- dialog, for example
-\begin_inset Flex Code
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-"/home/myhome/lyxpipe"
+For those who want to know, this controls the resolution of the image in
+ dots per inch and is based upon a default of 75 dpi.
\end_layout
\end_inset
-, or
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-"
-\backslash
+\begin_inset Newline newline
+\end_inset
-\backslash
+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
.
-\backslash
-pipe
-\backslash
-lyxpipe"
\end_layout
+\begin_layout Itemize
+\SpecialChar LaTeX
+
+\begin_inset Newline newline
\end_inset
- on Windows (where any working path instead of lyxpipe can be used, for
- example
+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
+
+, 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
-"
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-my
-\backslash
-lyx
-\backslash
-pipe"
+span
\end_layout
\end_inset
- would also work).
- You
-\emph on
-must
-\emph default
- configure this manually in order for the server to start.
-\end_layout
-
-\begin_layout Standard
-\SpecialChar LyX
- will add the '
+ (for inline formulas) or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.in
+div
\end_layout
\end_inset
-' and '
+ (for displayed formulas) with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.out
+class='math'
\end_layout
\end_inset
-' to create the pipes.
- If one of the pipes already exists, \SpecialChar LyX
- will assume that another \SpecialChar LyX
- process
- is already running and will not start the server.
- On POSIX (Unix like) systems, if for some other reason, an unused
-\begin_inset Quotes eld
-\end_inset
-
-stale
-\begin_inset Quotes erd
-\end_inset
-
- pipe is left in existence when \SpecialChar LyX
- closes, then \SpecialChar LyX
- will try to delete it.
- If this fails for some reason, you will need to delete the pipes manually
- and then restart \SpecialChar LyX
-.
- On Windows, pipes are deleted by the OS on program termination or crash,
- so
-\begin_inset Quotes eld
-\end_inset
-
-stale
-\begin_inset Quotes erd
-\end_inset
-
- pipes should not be possible.
+, as is required for jsMath.
\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
+One of these output methods must be selected under
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-preferences
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\end_layout
\end_inset
- file, for each process.
+.
+ By default, \SpecialChar LyX
+ outputs MathML.
+ This is a document-wide setting, therefore.
\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
+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
-lyx -dbg lyxserver
-\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
.
\end_layout
-\begin_layout Standard
-You can find a complete example client written in C++ in the source distribution
- as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-development/lyxserver/server_monitor.cpp
-\end_layout
-
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-Another useful tool is the command-line based client found in
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-src/client/lyxclient
\end_layout
-\end_inset
-
-.
+\begin_layout Section
+Bibliography and Citations
\end_layout
-\begin_layout Section
-Normal communication
+\begin_layout Standard
+XHTML output fully supports bibliographies and citations.
+
\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:
+Citation labels are generated by the same machinery that generates \SpecialChar LyX
+'s on-screen
+ labels, so the labels will look in the output much as they do in \SpecialChar LyX
+, though
+ better.
+ If you are using numerical citations, then \SpecialChar LyX
+ will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then \SpecialChar LyX
+ will add lowercase letters
+ to the years, just as Bib\SpecialChar TeX
+ does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
\end_layout
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
+\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
-function
+Customization
\emph default
-:
-\emph on
-argument
-\end_layout
-
-\begin_layout Description
-clientname is a name that the client can choose arbitrarily.
- Its only use is that \SpecialChar LyX
- will echo it if it sends an answer—so a client can
- dispatch results from different requesters.
+ manual for the details.
\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 Standard
+The main defect at present is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
\end_layout
-\begin_layout Description
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
+\begin_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-self-insert
+Context and Logical Form
\begin_inset Quotes erd
\end_inset
- LFUN will insert the argument as text at the cursor position).
-\end_layout
-
-\begin_layout Standard
-The answer from \SpecialChar LyX
- will arrive in the output pipe and be of the form
-\end_layout
-
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
+, in
\emph on
-function
+Language in Context: Selected Essays
\emph default
-:
-\emph on
-data
+ (Oxford: Oxford University Press, 2007), pp.
+ 30–68.
\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_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-font-state
+Semantics in Context
\begin_inset Quotes erd
\end_inset
-, will return information about the internal state of \SpecialChar LyX
-, while other will
- return an empty data-response.
- This means that the command execution went fine.
-\end_layout
-
-\begin_layout Standard
-In case of errors, the response from \SpecialChar LyX
- will have this form
-\end_layout
-
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
+, in
\emph on
-function
+Language in Context: Selected Essays
\emph default
-:
-\emph on
-error message
+ (Oxford: Oxford University Press, 2007), pp.
+ 201–30.
\end_layout
\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
+This should be fixed before long.
\end_layout
\begin_layout Standard
-Examples:
+There is no support at present for sectioned bibliographies.
+ If you have multiple bibliographies, then \SpecialChar LyX
+ will print the same bibliography
+ over and over.
\end_layout
-\begin_layout 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
+\begin_layout Section
+Indexes
\end_layout
-\begin_layout Subsection
-AppleScript (Mac OS X)
+\begin_layout Standard
+\SpecialChar LyX
+ will happily export indexes as XHTML, but with certain limitations at the
+ moment.
\end_layout
\begin_layout Standard
-Since \SpecialChar LyX
- 2.1, \SpecialChar LyX
- supports basic interactions with AppleScript for normal communicatio
-n through the command run.
- This command takes a direct argument (the
-\series bold
-function
-\series default
- to perform) and an optional argument.
- It either returns the output of the function or triggers an error with
- the error message and code.
-\end_layout
+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 Standard
-Example:
+\begin_layout Plain Layout
+The main issue here is that \SpecialChar LyX
+ itself does not really handle these.
+ It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
+.
\end_layout
-\begin_layout LyX-Code
-tell application "\SpecialChar LyX
-"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- try
+ We'll describe how they are handled using the subsection headings from
+ that section.
\end_layout
-\begin_layout LyX-Code
- -- Stores the current file name into f
-\end_layout
+\begin_layout Itemize
+Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
+ makes an effort to support these,
+ but the entries must be separated by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- set f to (run "server-get-filename" with argument "")
-\end_layout
+ !
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- on error the error_message number the error_number
+, 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 LyX-Code
- display dialog "Error: " & the error_number & ".
- " ¬
+\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 LyX-Code
- & the error_message buttons {"OK"} default button 1
-\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 LyX-Code
- end try
-\end_layout
+|see\SpecialChar ldots
-\begin_layout LyX-Code
-end tell
+\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 Section
-Notification
+\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 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_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
-notify
+entry|textbf
\begin_inset Quotes erd
\end_inset
.
- The format of the string \SpecialChar LyX
- sends is as follows:
+ Indeed, if \SpecialChar LyX
+ finds a pipe symbol, `|', in an entry, it will delete it and
+ everything that follows it.
\end_layout
-\begin_layout Quote
-\begin_inset Flex Code
-status collapsed
+\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 Plain Layout
-NOTIFY:
+\begin_layout Section
+Nomenclature and Glossary
\end_layout
-\end_inset
+\begin_layout Standard
+There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
+\end_layout
+\begin_layout Chapter
-\emph on
-key-sequence
+\change_inserted 1075283030 1616534180
+DocBook Output
\end_layout
\begin_layout Standard
-where
+
+\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
+
+\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
-key-sequence
+Customization
\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
+manual for the details.
\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
+\change_inserted 1075283030 1616534475
+Most \SpecialChar LyX
+ features are supported with DocBook, like math output.
+\end_layout
-.
- 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_layout Itemize
+
+\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 Section
-The simple \SpecialChar LyX
- Server Protocol
+\begin_layout Itemize
+
+\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 Standard
-\SpecialChar LyX
- implements a simple protocol that can be used for session management.
- All messages are of the form
+\begin_layout Itemize
+
+\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 Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
+\begin_layout Itemize
+
+\change_inserted 1075283030 1616534884
+Glossaries are implemented.
\end_layout
\begin_layout Standard
-where
-\emph on
-protocol message
-\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
-hello
-\begin_inset Quotes erd
-\end_inset
+\change_inserted 1075283030 1616534894
+Two major parameters can be set at the document level.
+\end_layout
- or
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-bye
-\begin_inset Quotes erd
-\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.
+\end_layout
-.
- If
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-hello
-\begin_inset Quotes erd
-\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
- 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
+\begin_deeper
+\begin_layout Itemize
-bye
-\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
- sent from \SpecialChar LyX
- will inform clients that \SpecialChar LyX
- is closing.
+\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 Section
-Reverse DVI/PDF search
+\begin_layout Itemize
+
+\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
\begin_layout Standard
-Some DVI/PDF viewers
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
-\end_layout
+\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
-\end_inset
+\end_layout
- 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_deeper
+\begin_layout Chapter
+The \SpecialChar LyX
+ Server
+\end_layout
-\begin_layout Plain Layout
-lyxclient
+\begin_layout Section
+Introduction
\end_layout
+\begin_layout Standard
+The `\SpecialChar LyX
+ server' allows other programs to talk to \SpecialChar LyX
+, invoke \SpecialChar LyX
+ commands, and retrieve
+ information about the \SpecialChar LyX
+ internal state.
+ This is only intended for advanced users, but they should find it useful.
+ It is by writing to the \SpecialChar LyX
+ server, for example, that bibliography managers,
+ such as JabRef, are able to
+\begin_inset Quotes eld
\end_inset
- 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.
+push
+\begin_inset Quotes erd
+\end_inset
+
+ citations to \SpecialChar LyX
+.
\end_layout
-\begin_layout Subsection
-Automatic setup
+\begin_layout Section
+Starting the \SpecialChar LyX
+ Server
\begin_inset CommandInset label
LatexCommand label
-name "subsec:rev-search"
+name "sec:Starting-the-Server"
\end_inset
\end_layout
\begin_layout Standard
-In most cases \SpecialChar LyX
- will do the work for you by
-\change_inserted -712698321 1500975045
-pressing the following button in the toolbar:
-\begin_inset Info
-type "icon"
-arg "buffer-toggle-output-sync"
+The \SpecialChar LyX
+ server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
+\end_layout
+
\end_inset
-.
- Alternatively, you can also enable the feature by checking
-\family sans
-Synchronize with Output
-\family default
- in
-\begin_inset Flex Noun
+, (except on Windows, where
+\emph on
+local
+\emph default
+ named pipes are special objects located in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1500975071
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Formats
+\backslash
+
+\backslash
+.
+\backslash
+pipe
\end_layout
\end_inset
+) and have the names
+\begin_inset Quotes eld
+\end_inset
+
-\change_deleted -712698321 1500974764
-enabling the option
-\begin_inset Flex Noun
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Synchronize with Output
+lyxpipe.in
\end_layout
\end_inset
- in the menu
-\begin_inset Flex Noun
-status collapsed
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ and
+\begin_inset Quotes eld
\end_inset
-\change_unchanged
-.
- In such a case \SpecialChar LyX
- will automatically insert the necessary Sync\SpecialChar TeX
- macro (for
- PDF) or load the srcltx package (for DVI) respectively.
- This option can be easily reached also on
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-View/Update
+lyxpipe.out
\end_layout
\end_inset
- Toolbar.
-\end_layout
-
-\begin_layout Standard
-If you need a different setting, you can select or input a custom macro
- from the drop down box just below
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-Synchronize with Output
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
-\end_layout
-
-\begin_layout Standard
-Note that the method
+ External programs write into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-synctex=1
+lyxpipe.in
\end_layout
\end_inset
- enables gzip compression.
- If your viewer does not support it, you should instead use
+ and read back data from
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-synctex=-1
+lyxpipe.out
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Standard
-Please also note that including the
-\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
-srcltx
+Tools\SpecialChar menuseparator
+Preferences
\end_layout
\end_inset
- package or
+ dialog, for example
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src-specials
+"/home/myhome/lyxpipe"
\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
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-srcltx
+"
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe"
\end_layout
\end_inset
- package or
+ on Windows (where any working path instead of lyxpipe can be used, for
+ example
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src-specials
-\end_layout
-
-\end_inset
+"
+\backslash
+\backslash
.
-
+\backslash
+pipe
+\backslash
+my
+\backslash
+lyx
+\backslash
+pipe"
\end_layout
-\begin_layout Standard
-In case you need some more special settings that are not covered by the
- automatic settings, read the next section about how to set up output synchroniz
-ation manually.
- If the automatic setup suits your needs, you can readily jump to section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:configuring-viewers"
-
\end_inset
-, where the necessary configuration steps in your viewer – needed both with
- the automatic and the manual setup – are described.
-\end_layout
-
-\begin_layout Subsection
-Manual setup
+ would also work).
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
\begin_layout Standard
-\SpecialChar LaTeX
- provides several different methods for reverse search.
- Some are built-in in the
+\SpecialChar LyX
+ will add the '
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex/pdflatex
+.in
\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.
+' and '
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.out
\end_layout
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
+\end_inset
+
+' to create the pipes.
+ If one of the pipes already exists, \SpecialChar LyX
+ will assume that another \SpecialChar LyX
+ process
+ is already running and will not start the server.
+ On POSIX (Unix like) systems, if for some other reason, an unused
+\begin_inset Quotes eld
+\end_inset
+
+stale
+\begin_inset Quotes erd
+\end_inset
+
+ pipe is left in existence when \SpecialChar LyX
+ closes, then \SpecialChar LyX
+ will try to delete it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart \SpecialChar LyX
+.
+ On Windows, pipes are deleted by the OS on program termination or crash,
+ so
+\begin_inset Quotes eld
+\end_inset
+
+stale
+\begin_inset Quotes erd
+\end_inset
+
+ pipes should not be possible.
\end_layout
\begin_layout Standard
-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
+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
-La
-\family sans
-TeX
-\family default
- (plain)->DVI
+preferences
\end_layout
\end_inset
- or
-\begin_inset Flex Noun
+ 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
-La
-\family sans
-TeX
-\family default
- (plain)->DraftDVI
+lyx -dbg lyxserver
\end_layout
\end_inset
- converter in
-\begin_inset Flex Noun
+.
+\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
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-Converters
+development/lyxserver/server_monitor.cpp
\end_layout
\end_inset
- to
+.
+\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
-latex -src-specials $$i
+src/client/lyxclient
\end_layout
\end_inset
.
- If this doesn't work, check if your \SpecialChar TeX
- engine needs different options (the
- syntax might differ in some distributions).
\end_layout
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+\begin_layout Section
+Normal communication
\end_layout
\begin_layout Standard
-The packages
+To issue a \SpecialChar LyX
+ call, the client writes a line of ASCII text into the input
+ pipe.
+ This line has the following format:
+\end_layout
+
+\begin_layout Quote
+LYXCMD:
\emph on
-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:
+:
+\emph on
+argument
\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+\begin_layout Description
+clientname is a name that the client can choose arbitrarily.
+ Its only use is that \SpecialChar LyX
+ will echo it if it sends an answer—so a client can
+ dispatch results from different requesters.
+\end_layout
-\backslash
-usepackage{pdfsync}
+\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
- for reverse PDF search,
-\end_layout
+self-insert
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+ LFUN will insert the argument as text at the cursor position).
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+The answer from \SpecialChar LyX
+ will arrive in the output pipe and be of the form
+\end_layout
-\backslash
-usepackage[active]{srcltx}
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
\end_layout
+\begin_layout Standard
+where
+\emph on
+clientname
+\emph default
+ and
+\emph on
+function
+\emph default
+ are just echoed from the command request, while
+\emph on
+data
+\emph default
+ is more or less useful information filled according to how the command
+ execution worked out.
+ Some commands, such as
+\begin_inset Quotes eld
+\end_inset
+
+font-state
+\begin_inset Quotes erd
\end_inset
- for reverse DVI 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 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
+In case of errors, the response from \SpecialChar LyX
+ will have this form
\end_layout
-\begin_layout LyX-Code
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
+\end_layout
-\backslash
-usepackage{ifpdf}
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
+\begin_layout Standard
+Examples:
+\end_layout
-\backslash
-ifpdf
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
\begin_inset Newline newline
\end_inset
-
-\backslash
-usepackage{pdfsync}
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
\begin_inset Newline newline
\end_inset
-
-\backslash
-else
-\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 Plain Layout
-(pdf)latex
+\begin_layout LyX-Code
+ try
\end_layout
-\end_inset
-
- have built-in support for both PDF and DVI reverse search.
- This so-called
-\emph on
-Sync\SpecialChar TeX
-
-\emph default
- facility is basically the result of the integration of the PDFSync package
- to the pdftex program and its merge with the
-\emph on
-scr-specials
-\emph default
- approach.
- You need at least \SpecialChar TeX
-Live 2008 or a recent Mik\SpecialChar TeX
- distribution in order to use
- it.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-For some reason, Mik\SpecialChar TeX
- does not understand/obey the command \SpecialChar LyX
- inserts into
- the preamble when you check the "Enable Forward/Reverse Search" button
- in the toolbar and does not generate the necessary info.
+\begin_layout LyX-Code
+ -- Stores the current file name into f
\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
+ set f to (run "server-get-filename" with argument "")
\end_layout
-\end_inset
-
- Also note that only a few PDF viewers (
-\change_inserted -712698321 1500977288
-such as
-\change_unchanged
-Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
-\change_inserted -712698321 1500977299
-; see the next section for details
-\change_unchanged
-) already provide Sync\SpecialChar TeX
- support.
+\begin_layout LyX-Code
+ on error the error_message number the error_number
\end_layout
-\begin_layout Standard
-To enable Sync\SpecialChar TeX
- for DVI output, change the
-\begin_inset Flex Noun
-status collapsed
+\begin_layout LyX-Code
+ display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain) -> DVI
+\begin_layout LyX-Code
+ & the error_message buttons {"OK"} default button 1
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ end try
+\end_layout
- or
-\begin_inset Flex Noun
-status collapsed
+\begin_layout LyX-Code
+end tell
+\end_layout
-\begin_layout Plain Layout
-La
-\family sans
-TeX
-\family default
- (plain) -> DraftDVI
+\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
- converter in
-\begin_inset Flex Noun
-status collapsed
+notify
+\begin_inset Quotes erd
+\end_inset
-\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
-
-
-\change_deleted -712698321 1500977453
-or
-\change_unchanged
- 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
.
-
-\change_inserted -712698321 1500977740
-Should your viewer not be considered in the following description, or in
- case of missing success, please
-\change_deleted -712698321 1500977741
-C
-\change_inserted -712698321 1500977744
-c
-\change_unchanged
-heck 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
+\end_layout
-\begin_layout Plain Layout
-Note that the option
-\begin_inset Flex Code
-status collapsed
+\begin_layout Section
+The simple \SpecialChar LyX
+ Server Protocol
+\end_layout
-\begin_layout Plain Layout
--synctex=1
+\begin_layout Standard
+\SpecialChar LyX
+ implements a simple protocol that can be used for session management.
+ All messages are of the form
+\end_layout
+
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
\end_layout
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
\end_inset
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex Code
-status collapsed
+hello
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
--synctex=-1
-\end_layout
+ or
+\begin_inset Quotes eld
+\end_inset
+bye
+\begin_inset Quotes erd
\end_inset
.
-\end_layout
+ If
+\begin_inset Quotes eld
+\end_inset
+
+hello
+\begin_inset Quotes erd
+\end_inset
+ is received from a client, \SpecialChar LyX
+ will report back to inform the client that
+ it's listening to it's messages, while
+\begin_inset Quotes eld
\end_inset
+bye
+\begin_inset Quotes erd
+\end_inset
+ sent from \SpecialChar LyX
+ will inform clients that \SpecialChar LyX
+ is closing.
\end_layout
-\begin_layout Subsection
-Configuring and using specific viewers
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:configuring-viewers"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection*
-Xdvi (all platforms)
+\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 Subsection
+Automatic setup
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:rev-search"
+
+\end_inset
+
+
\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
+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
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File formats
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Formats
\end_layout
\end_inset
- to
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-On Mac OSX you have to use
+.
+ 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
-DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
+View/Update
\end_layout
\end_inset
-
+ Toolbar.
\end_layout
-\end_inset
-
-
-\begin_inset Flex Code
+\begin_layout Standard
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-xdvi -editor "lyxeditor.sh %f %l"
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+Synchronize with Output
\end_layout
\end_inset
-, where
+.
+\end_layout
+
+\begin_layout Standard
+Note that the method
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.sh
-\end_layout
-
-\end_inset
- is a suitable script.
- For example, a minimal shell script is the following one:
+\backslash
+synctex=1
\end_layout
-\begin_layout LyX-Code
-#!/bin/sh
-\begin_inset Newline newline
\end_inset
-LYXPIPE="/path/to/lyxpipe"
-\begin_inset Newline newline
-\end_inset
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
-COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+
+\backslash
+synctex=-1
+\end_layout
-echo "$COMMAND" > "${LYXPIPE}".in || exit
-\begin_inset Newline newline
\end_inset
-read TMP < "${LYXPIPE}".out || exit
+.
\end_layout
\begin_layout Standard
-where
+Please also note that including the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/path/to/lyxpipe
+srcltx
\end_layout
\end_inset
- is the LyXServer pipe path specified in
-\begin_inset Flex Noun
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar menuseparator
-Paths
+src-specials
\end_layout
\end_inset
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-In the
+ 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
-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
+src-specials
\end_layout
\end_inset
- script which is able to locate the
-\emph on
-lyxpipe
-\emph default
- based on your preferences.
+.
+
\end_layout
+\begin_layout Standard
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:configuring-viewers"
+
+\end_inset
+
+, where the necessary configuration steps in your viewer – needed both with
+ the automatic and the manual setup – are described.
\end_layout
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
+\begin_layout Subsection
+Manual setup
\end_layout
\begin_layout Standard
-At the end of
+\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
-/Applications/MacDviX_Folder/calleditor.script
+latex/pdflatex
\end_layout
\end_inset
-, add the following lines:
+ 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 LyX-Code
-/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
-\end_inset
-
-exit 1
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
-Modify the lines accordingly if you install \SpecialChar LyX
- somewhere else than in the
- Applications folder.
-\end_layout
+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 Standard
-Reverse search is triggered by Alt-click (OPTION-click).
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain)->DVI
\end_layout
-\begin_layout Subsubsection*
-Skim (Mac OSX)
-\end_layout
+\end_inset
-\begin_layout Standard
-Enter
-\begin_inset Flex Code
+ or
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-open -a Skim.app $$i
+La
+\family sans
+TeX
+\family default
+ (plain)->DraftDVI
\end_layout
\end_inset
- to the viewer setting in
+ converter in
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Preferences\SpecialChar menuseparator
File Handling\SpecialChar menuseparator
-File formats\SpecialChar menuseparator
-PDF (pdflatex)
+Converters
\end_layout
\end_inset
-, and then in
-\begin_inset Flex Noun
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Skim\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Sync
+latex -src-specials $$i
\end_layout
\end_inset
- choose
-\begin_inset Flex Noun
-status collapsed
+.
+ If this doesn't work, check if your \SpecialChar TeX
+ engine needs different options (the
+ syntax might differ in some distributions).
+\end_layout
-\begin_layout Plain Layout
-custom
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
\end_layout
-\end_inset
+\begin_layout Standard
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the \SpecialChar LyX
+ preamble:
+\end_layout
- preset and enter command
-\begin_inset Flex Noun
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/Applications/\SpecialChar LyX
-.app/Contents/MacOS/lyxeditor
+
+\backslash
+usepackage{pdfsync}
\end_layout
\end_inset
-.
+ for reverse PDF search,
\end_layout
-\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
-\end_layout
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection*
-Evince (GNOME)
-\end_layout
+\begin_layout Plain 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 "http://wiki.lyx.org/LyX/SyncTeX"
-literal "false"
+\backslash
+usepackage[active]{srcltx}
+\end_layout
\end_inset
- for details.
-\end_layout
-
-\begin_layout Subsubsection*
-Okular (KDE)
+ for reverse DVI search.
\end_layout
\begin_layout Standard
-Go to
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Settings\SpecialChar menuseparator
-Configure Okular\SpecialChar menuseparator
-Editor
+If you want to be able to perform both DVI and PDF reverse searches, you
+ can also insert in the preamble the following lines
\end_layout
+\begin_layout LyX-Code
+
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
\end_inset
-\change_inserted -712698321 1500981642
- and
-\change_deleted -712698321 1500981641
-,
-\change_unchanged
- select
-\change_deleted -712698321 1500981634
+\backslash
+ifpdf
+\begin_inset Newline newline
+\end_inset
-\begin_inset Quotes eld
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-Custom Text Editor
-\change_inserted -712698321 1500981635
-LyX
-\change_unchanged
-\begin_inset Quotes erd
+\backslash
+else
+\begin_inset Newline newline
\end_inset
-
-\change_inserted -712698321 1500981659
-as editor.
- This inserts the appropriate
-\change_deleted -712698321 1500981663
-and add the
-\change_unchanged
-command
-\change_inserted -712698321 1500981665
-(
-\change_unchanged
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-lyxclient -g %f %l
+\backslash
+fi
\end_layout
-\end_inset
-
-
-\change_inserted -712698321 1500981668
-)
-\change_unchanged
-.
+\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
-Reverse search is triggered by SHIFT-click.
+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
+ or
+\begin_inset Flex Noun
+status collapsed
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain) -> DraftDVI
+\end_layout
- tab.
- Click on the
-\begin_inset Quotes eld
\end_inset
-New\SpecialChar ldots
+ converter in
+\begin_inset Flex Noun
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
+\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
-
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
-
-Name:
-\begin_inset Quotes erd
-\end_inset
-
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
+ 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
+ choose
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
--g
-\end_layout
-
-\end_inset
-
- option if you want to use the
-\emph on
-lyxpipe
-\emph default
-, and be sure to specify the \SpecialChar LyX
-Server pipe path in the \SpecialChar LyX
- preferences.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Section
-Forward search
+custom
\end_layout
-\begin_layout Standard
-Forward search is, as the name implies, in a sense the
-\begin_inset Quotes eld
-\end_inset
-
-opposite
-\begin_inset Quotes erd
\end_inset
- of reverse search.
- It allows you to let the viewer jump to a given position from within \SpecialChar LyX
-.
- If forward search is set up (as described in what follows), you can put
- the cursor anywhere in your \SpecialChar LyX
- document, and hit
+ preset and enter command
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Navigate\SpecialChar menuseparator
-Forward search
+/Applications/\SpecialChar LyX
+.app/Contents/MacOS/lyxeditor
\end_layout
\end_inset
- (or select
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Forward search
+.
\end_layout
-\end_inset
+\begin_layout Standard
+Reverse search is triggered by COMMAND-SHIFT-click
+\end_layout
- 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.
+\begin_layout Subsubsection*
+Evince (GNOME)
\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 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"
\end_inset
-.
+ for details.
+\end_layout
+
+\begin_layout Subsubsection*
+Okular (KDE)
\end_layout
\begin_layout Standard
-Additionally, you need to configure \SpecialChar LyX
- for using your viewers in
+Go to
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-Output\SpecialChar menuseparator
-General
+Settings\SpecialChar menuseparator
+Configure Okular\SpecialChar menuseparator
+Editor
\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
+ and select LyX
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-\noindent
+ as editor.
+ This inserts the appropriate command (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$$n
+lyxclient -g %f %l
\end_layout
\end_inset
-: row number
+).
\end_layout
-\begin_layout Itemize
-\noindent
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
+Reverse search is triggered by SHIFT-click.
-\begin_layout Plain Layout
-$$t
-\end_layout
+\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
-: name of the (temporary) exported .tex file (without path)
+ mode (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., the hand symbol is clicked).
+\change_unchanged
+
\end_layout
-\begin_layout Itemize
-\noindent
-\begin_inset Flex Code
+\begin_layout Subsubsection*
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+Qpdfview supports Sync\SpecialChar TeX
+ since version 0.3.5.
+ Go to
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-$$f
+Edit\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Behavior
\end_layout
\end_inset
-: name of the (temporary) exported .tex file (including path)
-\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
-$$o
+lyxclient -g %1 %2
\end_layout
\end_inset
-: name of the exported output file (either dvi or pdf, depending on which
- one exists in the temporary directory)
+.
\end_layout
\begin_layout Standard
-Note that only some of the viewers provide full and usable forward search
- functionality out of the box, among them yap, xdvi, okular
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-You might want to set
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-okular –unique
+Reverse search is triggered by double-click or, in more recent versions,
+ by context menu.
\end_layout
-\end_inset
+\begin_layout Subsubsection*
+YAP (Windows)
+\end_layout
- in
+\begin_layout Standard
+Launch yap, choose its
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar menuseparator
-Preferences\SpecialChar menuseparator
-File Handling\SpecialChar menuseparator
-File
-\begin_inset space ~
+View\SpecialChar menuseparator
+Options
+\end_layout
+
\end_inset
-Formats
-\end_layout
+ 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
-\end_layout
+New\SpecialChar ldots
+\begin_inset Quotes erd
\end_inset
-, qpdfview, and SumatraPDF
-\begin_inset Foot
-status collapsed
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\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"
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
+ (or any other name you like) in the
+\begin_inset Quotes eld
\end_inset
+Name:
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
+
+\SpecialChar ldots
+\begin_inset Quotes erd
\end_inset
-.
- Others, such as evince
-\begin_inset Foot
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\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 "http://wiki.lyx.org/LyX/SyncTeX"
-literal "false"
+lyxeditor.bat
+\end_layout
\end_inset
- for details.
+ (see below).
+ Select
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-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 Plain Layout
+%f %l
+\end_layout
-near
-\begin_inset Quotes erd
\end_inset
.
- This latter functionality is provided by an external call of synctex (see
- the predefined example configurations).
-
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-Forward search works both with DVI and PDF output.
- \SpecialChar LyX
- simply checks which preview format you have used before (i.
-\begin_inset space \thinspace{}
\end_inset
-e., which format is already there in the temporary directory) and chooses
- the appropriate configuration for the respective format.
+ wrapper is used for communicating with \SpecialChar LyX
+ through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
\end_layout
-\begin_layout Chapter
-Special Document Classes
-\end_layout
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
+\end_inset
-\begin_layout Section
-A&A Paper
-\end_layout
+echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
+\backslash
-\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection
-Introduction
+type
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.out
\end_layout
\begin_layout Standard
-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
+Make sure that the \SpecialChar LyX
+Server pipe path you specified in \SpecialChar LyX
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-https://www.aanda.org/
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\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
+, otherwise change the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+ wrapper accordingly.
+\end_layout
+
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
\begin_layout Standard
-\align center
-\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
-\begin_inset VSpace medskip
\end_inset
+, where
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-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_inset
+
+ is the previous wrapper.
+ If SumatraPDF.exe is not in your command PATH, use its full file name.
\end_layout
\begin_layout Standard
-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
-Getting started
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
\begin_layout Standard
-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
+First of all, make sure that yap is your default DVI viewer in the Windows
+ environment, then launch it, choose its
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-Document\SpecialChar menuseparator
-Settings
-\family default
- dialog (OK, that one was obvious).
+\begin_layout Plain Layout
+View\SpecialChar menuseparator
+Options
\end_layout
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page
-\begin_inset space ~
\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
-
-\begin_layout Subsection
-The header block
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\end_layout
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Title
-\family default
-: [required]
-\end_layout
+New\SpecialChar ldots
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
-\end_layout
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+\SpecialChar LyX
+ Editor
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Author
-\family default
-: [required]
-\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
-\family sans
-Address
-\family default
-: [required]
-\end_layout
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+\SpecialChar ldots
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
-
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
-\end_layout
+\end_inset
-\begin_layout Standard
-There is no need to issue the
-\family typewriter
+ program (which is installed by default on Cygwin along with the \SpecialChar LyX
+ executable).
+ Select
+\begin_inset Flex Code
+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
+lyxeditor.exe
\end_layout
-\begin_layout Standard
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
-\end_inset
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-to state your present address, just use the standard footnote via the menu
-
-\family sans
-Insert\SpecialChar menuseparator
-Footnote.
+\begin_layout Plain Layout
+-g %f %l
+\end_layout
-\family default
- \SpecialChar LyX
- will automagically use the term
-\family typewriter
+\end_inset
-\backslash
-thanks{}
-\family default
- in that case.
-\change_inserted -712698321 1501150851
+.
+ In this way, you will be using the
+\emph on
+lyxsocket
+\emph default
+ for communicating with \SpecialChar LyX
+.
+ If, for whatever reason, you want to use the
+\emph on
+lyxpipe
+\emph default
+, omit the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Standard
+\end_inset
-\change_inserted -712698321 1501150892
-Under
-\family sans
-Edit\SpecialChar menuseparator
-Text Style
-\family default
-, you'll find two insets which are relevant for the titling:
+ option and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
\end_layout
-\begin_layout Itemize
-
-\change_inserted -712698321 1501150936
-
-\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.
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Itemize
-
-\change_inserted -712698321 1501150947
-
-\family sans
-Email
-\family default
- to supply an email address for fast contact.
-\change_unchanged
-
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
\end_layout
\begin_layout Standard
-In addition to these topics, the macros use
-\change_deleted -712698321 1501150958
- three
-\change_inserted -712698321 1501150961
- one
-\change_unchanged
- additional \SpecialChar LaTeX
- command
-\change_deleted -712698321 1501150963
-s
-\change_unchanged
- that ha
-\change_deleted -712698321 1501150967
-ve
-\change_inserted -712698321 1501150967
-s
-\change_unchanged
- no counterpart in \SpecialChar LyX
-:
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ in the viewer setting in
+\begin_inset Flex Noun
+status collapsed
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+\begin_layout Plain Layout
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
-
-\change_deleted -712698321 1501150911
+\end_inset
-\family typewriter
+.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path.
+ The
+\begin_inset Flex Code
+status collapsed
-\backslash
-inst{<nr>}
-\family default
-to mark corresponding author/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.
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted -712698321 1501150911
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
+.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+-g
+\end_layout
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
-\change_unchanged
+\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
-
-\change_deleted -712698321 1501150972
-In all cases, t
-\change_inserted -712698321 1501150972
-T
-\change_unchanged
-he appropriate command has to be entered in \SpecialChar LyX
- and marked as \SpecialChar LaTeX
- code.
- See the examples.
-
+Reverse search is triggered by double-click.
\end_layout
-\begin_layout Subsection
-The abstract
+\begin_layout Section
+Forward search
\end_layout
\begin_layout Standard
-The abstract should immediately follow the header block.
- With version 5 the abstract environment was changed to a command, and there
- is now a resctriction to only one paragraph.
- In addition, it should contain an entry with the keywords.
- This is
-\change_deleted -712698321 1501151111
-not yet implemented for \SpecialChar LyX
-, therefore you have to enter the \SpecialChar LaTeX
- command
-\family typewriter
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-keywords{}
-\family default
- by hand and mark it as \SpecialChar LaTeX
- code
-\change_inserted -712698321 1501151122
-done via the paragraph style
-\family sans
-Keywords
-\change_unchanged
+opposite
+\begin_inset Quotes erd
+\end_inset
-\family default
+ of reverse search.
+ It allows you to let the viewer jump to a given position from within \SpecialChar LyX
.
- Refer to the example paper.
-\end_layout
+ 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 Subsection
-Supported environments
+\begin_layout Plain Layout
+Navigate\SpecialChar menuseparator
+Forward search
\end_layout
-\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
-\end_layout
+\end_inset
-\begin_layout Itemize
+ (or select
+\begin_inset Flex Noun
+status collapsed
-\family sans
-Standard
+\begin_layout Plain Layout
+Forward search
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Section
+ 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"
-\family sans
-Subsection
+\end_inset
+
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Additionally, you need to configure \SpecialChar LyX
+ for using your viewers in
+\begin_inset Flex Noun
+status collapsed
-\family sans
-Subsubsection
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+General
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Itemize
+.
+ We provide a range of tested configurations for some viewers, which you
+ can select from the drop down list.
+ If none of these configurations suits you, you have to find out and enter
+ a suitable configuration yourself.
+ The definition syntax uses the following placeholders:
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\family sans
-Enumerate
+\begin_layout Plain Layout
+$$n
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Description
+: row number
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\family sans
-Caption
+\begin_layout Plain Layout
+$$t
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Abstract
+: name of the (temporary) exported .tex file (without path)
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\family sans
-Acknowledgment
+\begin_layout Plain Layout
+$$f
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Bibliography
+: name of the (temporary) exported .tex file (including path)
\end_layout
\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\family sans
-\SpecialChar LaTeX
-
+\begin_layout Plain Layout
+$$o
\end_layout
-\begin_layout Subsection
-Commands not supported by \SpecialChar LyX
+\end_inset
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
\end_layout
\begin_layout Standard
-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:
-\end_layout
-
-\begin_layout Itemize
+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
-\family typewriter
+\begin_layout Plain Layout
+You might want to set
+\begin_inset Flex Code
+status collapsed
-\backslash
-and
+\begin_layout Plain Layout
+okular --unique
\end_layout
-\begin_layout Itemize
-
-\change_deleted -712698321 1501151229
+\end_inset
-\family typewriter
+ in
+\begin_inset Flex Noun
+status collapsed
-\backslash
-email
-\change_unchanged
+\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
-
-\change_deleted -712698321 1501151308
-
-\family typewriter
+\end_inset
-\backslash
-appendix
-\change_unchanged
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-authorrunning
-\end_layout
+, qpdfview, and SumatraPDF
+\begin_inset Foot
+status collapsed
-\begin_layout Itemize
+\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"
-\change_deleted -712698321 1501151231
+\end_inset
-\family typewriter
-\backslash
-inst{}
\end_layout
-\begin_layout Itemize
+\end_inset
-\change_deleted -712698321 1501151231
+.
+ Others, such as evince
+\begin_inset Foot
+status collapsed
-\family typewriter
+\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"
-\backslash
-keywords{}
-\change_unchanged
+\end_inset
+ for details.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-object{}
-\end_layout
+, 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
-\begin_layout Itemize
+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
-\family typewriter
+near
+\begin_inset Quotes erd
+\end_inset
-\backslash
-titlerunning{}
+.
+ This latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
\end_layout
\begin_layout Standard
-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!
+Forward search works both with DVI and PDF output.
+ \SpecialChar LyX
+ simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
+\begin_layout Chapter
+Special Document Classes
+\end_layout
+
+\begin_layout Section
+
+\change_deleted 564990737 1669742044
+A&A Paper
\end_layout
\begin_layout Standard
-\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 ~
-\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
+\change_deleted 564990737 1669742044
+by
+\noun on
+Peter Sütterlin
+\end_layout
-Settings.
+\begin_layout Subsection
+
+\change_deleted 564990737 1669742044
+Introduction
\end_layout
\begin_layout Standard
-There is only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
+
+\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
+status collapsed
+
+\begin_layout Plain Layout
+
+https://www.aanda.org/
\end_layout
-\begin_layout Enumerate
-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
+) 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 Enumerate
-Enter your caption text.
-\end_layout
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+\begin_inset VSpace medskip
+\end_inset
+
-\begin_layout Enumerate
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
\end_layout
-\begin_layout Enumerate
-Insert your figure
+\begin_layout Standard
+\align center
+
+\change_deleted 564990737 1669742044
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+ftp://ftp.edpsciences.org/pub/aa/readme.html
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-Insert\SpecialChar menuseparator
-Special
-\begin_inset space ~
\end_inset
-Character\SpecialChar menuseparator
-Horizontal
-\begin_inset space ~
-\end_inset
-Fill
-\family default
-.
\end_layout
-\begin_layout Enumerate
-Switch to \SpecialChar LaTeX
- mode:
-\family sans
-M-c
-\begin_inset space ~
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+\begin_inset VSpace medskip
\end_inset
-t
-\family default
-.
+
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\begin_layout Standard
-\backslash
-parbox[b]{55mm}{
-\family default
-.
+\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.
-\series bold
-Do not close the brace!
\end_layout
-\begin_layout Enumerate
-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
+\begin_layout Standard
-t
+\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
.
\end_layout
-\begin_layout Standard
-Also, refer to the figures in the example paper.
-\end_layout
-
\begin_layout Subsection
-Referee layout
+
+\change_deleted 564990737 1669742044
+Getting started
\end_layout
\begin_layout Standard
-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
+
+\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 Itemize
+
+\change_deleted 564990737 1669742044
+Select
+\family sans
+article (A&A)
\family default
- to the documentclass.
- This must be done using the
-\change_deleted -712698321 1501151486
-extra
-\change_inserted -712698321 1501151487
-custom
-\change_unchanged
- class options field in the
+ in the
\family sans
Document\SpecialChar menuseparator
Settings
\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
+ dialog (OK, that one was obvious).
\end_layout
-\begin_layout Subsection
-The example paper
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-The
+\change_deleted 564990737 1669742044
+Don't change the option
\family sans
-Examples
+Page
+\begin_inset space ~
+\end_inset
+
+style
+\family default
+: Leave it set to
+\family sans
+default
\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.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_layout Section
-AAS\SpecialChar TeX
+\begin_layout Subsection
+\change_deleted 564990737 1669742044
+The header block
\end_layout
\begin_layout Standard
-by
-\noun on
-Mike Ressler
-\end_layout
-\begin_layout Subsection
-Introduction
+\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
-\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
-\change_deleted -712698321 1501152764
-5.2
-\change_inserted -712698321 1501152766
-6.0
-\change_unchanged
-, 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
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Title
+\family default
+: [required]
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+\change_deleted 564990737 1669742044
+\family sans
+Subtitle
+\family default
+: [optional]
\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
+Author
+\family default
+: [required]
\end_layout
-\end_inset
+\begin_layout Itemize
+\change_deleted 564990737 1669742044
+\family sans
+Address
+\family default
+: [required]
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+\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
-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
+\change_deleted 564990737 1669742044
-\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
+Mail
\family default
-
+: [optional] mail address for contacts.
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
\family sans
-Template
-\family default
-, enter the new file name, then choose the
-\family typewriter
-aastex
-\change_inserted -712698321 1501152130
-6
-\change_unchanged
-.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
-<>
+Date
\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
-\change_deleted -712698321 1501152213
-: most noticeably
+: [required].
+ Suggested format is
\family typewriter
+Received: <date>; Accepted <date>
+\end_layout
-\backslash
-altaffilmark
-\family default
- and
+\begin_layout Standard
+
+\change_deleted 564990737 1669742044
+There is no need to issue the
\family typewriter
\backslash
-altaffiltext
+maketitle
\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file
-\change_unchanged
-.
- 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
-\change_deleted -712698321 1501152220
-, but there is still a bit more required than any of us would like
-\change_unchanged
-.
-\end_layout
-
-\begin_layout Subsection
-Finishing Your Paper
+ 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
-When the paper is finished to your satisfaction and previews/prints correctly,
- there are a few
-\begin_inset Quotes eld
+
+\change_deleted 564990737 1669742044
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
\end_inset
-postprocessing
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
- actions which need to be done before you submit it to the journals.
+to state your present address, just use the standard footnote via the menu
-\end_layout
-
-\begin_layout Enumerate
-Export your paper as a \SpecialChar LaTeX
- file (
\family sans
-File\SpecialChar menuseparator
-Export\SpecialChar menuseparator
-\SpecialChar LaTeX
+Insert\SpecialChar menuseparator
+Footnote.
\family default
-).
-
-\end_layout
-
-\begin_layout Enumerate
-Edit the resulting
+ \SpecialChar LyX
+ will automagically use the term
\family typewriter
-.tex
+
+\backslash
+thanks{}
\family default
- file with your favorite text editor
+ in that case.
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
-\family typewriter
+\begin_layout Standard
-\backslash
-documentclass
+\change_deleted 564990737 1669742044
+Under
+\family sans
+Edit\SpecialChar menuseparator
+Text Style
\family default
- command
+, you'll find two insets which are relevant for the titling:
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
+\begin_layout Itemize
-\backslash
-usepackage...{fontenc}
-\family default
- line if it appears (usually just after
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-documentclass
-\family default
-}; also remove the
+\family sans
+Institute
\family typewriter
-
-\backslash
-secnumdepth
+
\family default
- line if it appears.
+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.
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
-\family typewriter
+\begin_layout Itemize
-\backslash
-makeatletter
+\change_deleted 564990737 1669742044
+
+\family sans
+Email
\family default
- and
+ to supply an email address for fast contact.
+\end_layout
+
+\begin_layout Standard
+
+\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 Itemize
+
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-makeatother
+and
\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
+ to separate different names for more than one author and institute, respectivel
+y.
+\end_layout
-User specified \SpecialChar LaTeX
- commands
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
- comment in the
-\family typewriter
-.tex
-\family default
- file).
+\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
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through \SpecialChar LaTeX
- to make sure it still processes correctly.
-\end_layout
+\begin_layout Subsection
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\change_deleted 564990737 1669742044
+The abstract
\end_layout
-\begin_layout Enumerate
-Submit it.
+\begin_layout Standard
+
+\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.
\end_layout
\begin_layout Subsection
-Comments On Specific Commands
+
+\change_deleted 564990737 1669742044
+Supported environments
\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
+\change_deleted 564990737 1669742044
+The A&A paper layout supports the following environments for structuring
+ your text:
\end_layout
-\begin_layout Subsubsection
-Things that work as expected
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Standard
\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
+Section
+\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
+Subsection
+\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
+Subsubsection
+\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
+Itemize
+\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
+Enumerate
+\end_layout
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+\family sans
+Description
+\end_layout
-\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
+\begin_layout Itemize
-\backslash
-begin{table}
-\family default
- (2.15.4),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-begin{tabular}
-\family default
- (2.15.4),
-\family typewriter
+\family sans
+Caption
+\end_layout
-\backslash
-caption
-\family default
- (2.15.4),
-\family typewriter
+\begin_layout Itemize
-\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-tablerefs
-\family default
- (2.15.5),
-\family typewriter
+\family sans
+Abstract
+\end_layout
-\backslash
-tablecomments
-\family default
- (2.15.5),
-\family typewriter
+\begin_layout Itemize
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+\change_deleted 564990737 1669742044
+
+\family sans
+Acknowledgment
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+
+\change_deleted 564990737 1669742044
+
+\family sans
+\SpecialChar LaTeX
+
+\end_layout
+
+\begin_layout Subsection
+
+\change_deleted 564990737 1669742044
+Commands not supported by \SpecialChar LyX
-\backslash
-end{document}
-\family default
- (2.18).
\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
-\family sans
-Options
-\family default
- box in
+
+\change_deleted 564990737 1669742044
+Some commands are not yet supported by the
\family sans
-Layout\SpecialChar menuseparator
-Document
+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:
\end_layout
-\begin_layout Subsubsection
-Things that work, but require more comment
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-The following items work, but require a little more discussion:
-\end_layout
+\change_deleted 564990737 1669742044
-\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
+and
+\end_layout
-\backslash
-revised
-\family default
-,
-\family typewriter
+\begin_layout Itemize
-\backslash
-accepted
-\family default
-,
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-ccc
-\family default
-,
\family typewriter
\backslash
-cpright
-\family default
- (all from 2.1.3)
+authorrunning
\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
-\backslash
-slugcomment
-\family default
- (2.1.4),
-\family typewriter
+\change_deleted 564990737 1669742044
-\backslash
-shorttitle
-\family default
- (2.1.5),
\family typewriter
\backslash
-shortauthors
-\family default
- (2.1.5)
+object{}
\end_layout
\begin_layout Itemize
+\change_deleted 564990737 1669742044
+
\family typewriter
\backslash
-email
-\family default
- (2.3) – can only be used
-\begin_inset Quotes eld
-\end_inset
+titlerunning{}
+\end_layout
-standalone
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-, not in the middle of a paragraph.
- Use \SpecialChar TeX
- code if you need to embed it.
+\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
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Subsection
-\backslash
-and
-\family default
- (2.3) – will have extra {} after it.
- This should not cause an error.
+\change_deleted 564990737 1669742044
+Figure and Table Floats
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Standard
-\backslash
-notetoeditor
+\change_deleted 564990737 1669742044
+\SpecialChar LyX
+ provides support for the necessary float environments
+\family sans
+figure, figure*, table
\family default
- (2.6) – can only be used
-\begin_inset Quotes eld
+ 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 ~
\end_inset
-standalone
-\begin_inset Quotes erd
+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
-, not in the middle of a paragraph.
- Use \SpecialChar TeX
- code if you need to embed it.
+Settings.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Standard
-\backslash
-placetable
-\family default
- (2.8) – can't insert a cross-reference tag, you must type the tag name by
- hand
+\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_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
-\backslash
-placefigure
+\change_deleted 564990737 1669742044
+Create a wide figure float:
+\family sans
+Insert\SpecialChar menuseparator
+Float\SpecialChar menuseparator
+Figure
\family default
- (2.8) – same as for
-\family typewriter
+, then right click in the figure and select
+\family sans
+Span
+\begin_inset space ~
+\end_inset
-\backslash
-placetable
+columns
+\family default
+.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
-\backslash
-acknowledgements
-\family default
- (2.9) – will have extra {} after it.
- This should not cause an error.
+\change_deleted 564990737 1669742044
+Enter your caption text.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
-\backslash
-appendix
+\change_deleted 564990737 1669742044
+Press
+\family sans
+Return
\family default
- (2.11) – will have extra {} after it.
- This should not cause an error.
+ to move the cursor above the caption.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-\family typewriter
+\change_deleted 564990737 1669742044
+Insert your figure
+\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
+\begin_layout Enumerate
+
+\change_deleted 564990737 1669742044
+Position the cursor behind the figure and insert a horizontal fill:
\family sans
Insert\SpecialChar menuseparator
-Short Title
-\family default
-.
-
-\begin_inset Quotes eld
+Special
+\begin_inset space ~
\end_inset
-Short Title
-\begin_inset Quotes erd
+Character\SpecialChar menuseparator
+Horizontal
+\begin_inset space ~
\end_inset
- inserts an optional argument of the type needed by
-\family typewriter
-
-\backslash
-figcaption
+Fill
\family default
.
- Hopefully it will be renamed someday.
\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
-objectname
+t
\family default
- (2.17.1) – same as
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\change_deleted 564990737 1669742044
+Enter
\family typewriter
\backslash
-figcaption
+parbox[b]{55mm}{
\family default
- for the catalog ID optional parameter
+.
+
+\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
-dataset
+t
\family default
- (2.17.1) – same as
+
\family typewriter
-
-\backslash
-figcaption
+}
\family default
- for the catalog ID optional parameter
-\end_layout
-
-\begin_layout Subsubsection
-Things not implemented, use \SpecialChar TeX
- code
+.
\end_layout
\begin_layout Standard
-\change_deleted -712698321 1501152401
+\change_deleted 564990737 1669742044
+Also, refer to the figures in the example paper.
+\end_layout
-\family typewriter
+\begin_layout Subsection
-\backslash
-altaffilmark
-\family default
- (2.3),
-\family typewriter
+\change_deleted 564990737 1669742044
+Referee layout
+\end_layout
-\backslash
-altaffiltext
-\family default
- (2.3),
-\change_unchanged
+\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
-eqnum
+referee
\family default
- (2.12),
-\family typewriter
-
-\backslash
-setcounter{equation}
+ to the document class.
+ This must be done using the custom class options field in the
+\family sans
+Document\SpecialChar menuseparator
+Settings
\family default
- (2.12), Journal name abbreviations (2.13.4),
+ dialog.
+ Just enter the string
\family typewriter
-
-\backslash
-figurenum
+referee
\family default
- (2.14.1),
-\family typewriter
+ there.
+\end_layout
-\backslash
-epsscale
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Subsection
-\backslash
-plotone
-\family default
- (2.14.1),
-\family typewriter
+\change_deleted 564990737 1669742044
+The example paper
+\end_layout
-\backslash
-plottwo
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Standard
-\backslash
-tablenum
+\change_deleted 564990737 1669742044
+The
+\family sans
+Examples
\family default
- (2.15.4),
-\family typewriter
+ 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
-\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
+\begin_layout Section
+AAS\SpecialChar TeX
-\backslash
-tablenotemark
-\family default
- (2.15.5),
-\family typewriter
+\end_layout
-\backslash
-tablenotetext
-\family default
- (2.15.5), much of Misc (2.17, except
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
-\backslash
-objectname
-\family default
-,
-\family typewriter
+\begin_layout Subsection
+Introduction
+\end_layout
-\backslash
-dataset
-\family default
-,
-\family typewriter
+\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
+\end_layout
-\backslash
-url
-\family default
-, and
-\family typewriter
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\backslash
-email
-\family default
-; see above),
-\family typewriter
-\backslash
-singlespace
-\family default
- (3.1),
-\family typewriter
+\end_layout
-\backslash
-doublespace
-\family default
- (3.1),
-\family typewriter
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\backslash
-onecolumn
-\family default
- (3.2),
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-twocolumn
-\family default
- (3.2)
+https://aas.org/aastex/aastex-downloads
\end_layout
-\begin_layout Subsubsection
-Things that cannot be implemented
+\end_inset
+
+
\end_layout
\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 ~
+\begin_inset VSpace medskip
\end_inset
-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 Subsection
-FAQs, Tips, Tricks, and Other Ruminations
\end_layout
-\begin_layout Subsubsection
-Getting \SpecialChar LyX
- and AAS\SpecialChar TeX
- to cooperate
+\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 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:
+\begin_layout Subsection
+Starting a New Paper
\end_layout
-\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
+\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
-.
-\end_layout
-
-\begin_layout Enumerate
-Make certain that
-\family typewriter
-aastex.layout
+
+\family sans
+Template
\family default
- appears in \SpecialChar LyX
-'s
+, enter the new file name, then choose the
\family typewriter
-layouts
+aastex6.lyx
\family default
- folder
-\end_layout
-
-\begin_layout Enumerate
-Rerun
-\family sans
-Tools\SpecialChar menuseparator
-Reconfigure
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
+\family typewriter
+<>
\family default
- in \SpecialChar LyX
-, then restart \SpecialChar LyX
-.
+) 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 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
-\family default
-?
+\begin_layout Subsection
+Finishing Your Paper
\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
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
\begin_inset Quotes eld
\end_inset
-You should not mix title layouts with normal ones
+postprocessing
\begin_inset Quotes erd
\end_inset
-, things haven't been installed correctly.
-\end_layout
-
-\begin_layout Subsubsection
-\SpecialChar LaTeX
- error processing a table
+ actions which need to be done before you submit it to the journals.
+
\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
+\begin_layout Enumerate
+Export your paper as a \SpecialChar LaTeX
+ file (
\family sans
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
-Settings
-\family default
-, 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 Subsubsection
-References
-\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
-
-g.
-\begin_inset space \space{}
-\end_inset
-
+\end_layout
-\emph default
-type
+\begin_layout Enumerate
+Edit the resulting
\family typewriter
-Ressler(1992)
+.tex
\family default
-, not
+ file with your favorite text editor
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
\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
-References
+
+\backslash
+documentclass
\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.
+ command
\end_layout
-\begin_layout Subsubsection
-Including EPS files
-\end_layout
+\begin_layout Enumerate
+remove the
+\family typewriter
-\begin_layout Standard
-Even though AAS\SpecialChar TeX
- provides its own figure commands (
+\backslash
+usepackage...{fontenc}
+\family default
+ line if it appears (usually just after
\family typewriter
\backslash
-plotone
+documentclass
\family default
-, for example), I much prefer \SpecialChar LaTeX
-'s standard figure commands (with the default
- graphicx).
- You can insert the
+}; also remove the
\family typewriter
\backslash
-plotone
+secnumdepth
\family default
-, etc.
-\begin_inset space ~
-\end_inset
+ line if it appears.
+\end_layout
-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
+\begin_layout Enumerate
+remove everything between (and including) the
\family typewriter
\backslash
-usepackage{graphicx}
+makeatletter
\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
+ and
+\family typewriter
+
+\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
-stack everything at the end
+User specified \SpecialChar LaTeX
+ commands
\begin_inset Quotes erd
\end_inset
- technique.
+ comment in the
+\family typewriter
+.tex
+\family default
+ file).
\end_layout
-\begin_layout Subsubsection
-Things I could have done, but didn't
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through \SpecialChar LaTeX
+ to make sure it still processes correctly.
\end_layout
-\begin_layout Standard
-There are a few
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
+\end_layout
-pretty
-\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.
-
-\end_layout
+\begin_layout Enumerate
+Submit it.
+\end_layout
\begin_layout Subsection
-Final Caveat
+Comments On Specific Commands
\end_layout
\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
-
-\begin_layout Section
-AMS \SpecialChar LaTeX
-
-\end_layout
+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 Standard
-by
-\noun on
-David Johnson
-\noun default
-; updated by
-\noun on
-Richard Heck
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
+\begin_layout Subsubsection
+Things that work as expected
\end_layout
\begin_layout Standard
-\noindent
-The AMS \SpecialChar LaTeX
- layouts are set up to conform to suggested styles for mathematical
- papers to be submitted to American Mathematical Society publications.
- The layouts are not tailored to a specific journal, but easily can be.
- You should refer to the AMS documentation for specific instructions for
- each journal (usually it will entail only changing a single line in the
- \SpecialChar TeX
- output).
- That documentation is available on the Web at
-\begin_inset Flex URL
-status open
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+documentclass
+\family default
+ (2.1.1),
+\family typewriter
-http://www.ams.org
-\end_layout
+\backslash
+begin{document}
+\family default
+ (2.2),
+\family typewriter
-\end_inset
+\backslash
+title
+\family default
+ (2.3),
+\family typewriter
- or by ftp at
-\begin_inset Flex URL
-status open
+\backslash
+author
+\family default
+ (2.3),
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+affil
+\family default
+ (2.3),
+\family typewriter
-ftp://ftp.ams.org/pub/tex/amslatex/
-\end_layout
+\backslash
+abstract
+\family default
+ (2.4),
+\family typewriter
-\end_inset
+\backslash
+keywords
+\family default
+ (2.5),
+\family typewriter
-.
- These layouts are appropriate, and useful, for any mathematical writing.
-
-\end_layout
+\backslash
+section
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Standard
-There are two basic AMS \SpecialChar LaTeX
- layouts:
-\end_layout
+\backslash
+subsection
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Itemize
-amsart: The standard AMS article format.
-\end_layout
+\backslash
+subsubsection
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Itemize
-amsbook: the standard AMS book (really, monograph) format.
-
-\end_layout
+\backslash
+paragraph
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Standard
-The layouts themselves contain only the minimum necessary to use the AMS
- classes.
- They do not, in particular, contain any of the `theorem' environments used
- for setting theorems, lemmas, and the like.
- These are contained, instead, in the
-\begin_inset Flex Code
-status collapsed
+\backslash
+facility
+\family default
+ (2.10),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
-\end_inset
+\backslash
+begin{equation}
+\family default
+ (2.12),
+\family typewriter
- module, which is loaded by default when you select one of the AMS classes.
- (It can also be used with other classes and can be removed, if you would
- rather use something else.) Less commonly used environments are in the
-\begin_inset Flex Code
-status collapsed
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS-Extended)
-\end_layout
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
+\family typewriter
-\end_inset
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
+\family typewriter
- module, which must be loaded manually.
-\end_layout
+\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
-\begin_layout Standard
-By default, theorems and the like are numbered consecutively throughout
- the document, but this may be modified by loading the module
-\begin_inset Flex Code
-status collapsed
+\backslash
+begin{table}
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Order by Section)
-\end_layout
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
+\family typewriter
-\end_inset
+\backslash
+caption
+\family default
+ (2.15.4),
+\family typewriter
- or, if you are using
-\begin_inset Flex Code
-status collapsed
+\backslash
+label
+\family default
+ (2.15.4, amongst other places),
+\family typewriter
-\begin_layout Plain Layout
-book (AMS)
-\end_layout
+\backslash
+tablerefs
+\family default
+ (2.15.5),
+\family typewriter
-\end_inset
+\backslash
+tablecomments
+\family default
+ (2.15.5),
+\family typewriter
-, the module
-\begin_inset Flex Code
-status collapsed
+\backslash
+url
+\family default
+ (2.17.4),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Order by Chapter)
+\backslash
+end{document}
+\family default
+ (2.18).
\end_layout
-\end_inset
-
+\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
+\family sans
+Options
+\family default
+ box in
+\family sans
+Layout\SpecialChar menuseparator
+Document
+\family default
.
- These will number the results as
-\begin_inset Formula $n.m$
-\end_inset
-
-, where the first number refers to the section (or chapter) and the second
- refers to the total number of results so far in that section (or chapter).
- Many environments are also available unnumbered.
- These are indicated by an asterisk at the end.
- If you happen to want
-\emph on
-only
-\emph default
- unnumbered results, the module
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems (Starred)
\end_layout
-\end_inset
-
- provides that option.
+\begin_layout Subsubsection
+Things that work, but require more comment
\end_layout
\begin_layout Standard
-Note that these modules do not
-\emph on
-have
-\emph default
- to be used with the AMS classes.
- It is perfectly possible to use the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
-
-\end_inset
-
- module, and the others mentioned, with other classes, such as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-article
+The following items work, but require a little more discussion:
\end_layout
-\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
,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-report
-\end_layout
-
-\end_inset
+\family typewriter
+\backslash
+revised
+\family default
,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-book (KOMA-script)
-\end_layout
-
-\end_inset
-
-, and so forth.
-\end_layout
-
-\begin_layout Subsection
-What these layouts provide
-\end_layout
-
-\begin_layout Standard
-There is a long list of included environments provided by these layouts.
- In AMS-\SpecialChar LaTeX
-, there is, in fact, an opportunity to define an unlimited variety
- of `theorem' environments.
- However, the AMS recommends the environments that are available in \SpecialChar LyX
-.
-
-\end_layout
-
-\begin_layout Standard
-The following environments—as well as the standard environments, such as
-
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-section
-\end_layout
-
-\end_inset
+\family typewriter
+\backslash
+accepted
+\family default
,
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-bibliography
-\end_layout
-
-\end_inset
+\family typewriter
+\backslash
+ccc
+\family default
,
-\begin_inset Flex Noun
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-title
+\backslash
+cpright
+\family default
+ (all from 2.1.3)
\end_layout
-\end_inset
+\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_inset Flex Noun
-status collapsed
+\backslash
+slugcomment
+\family default
+ (2.1.4),
+\family typewriter
-\begin_layout Plain Layout
-author
-\end_layout
+\backslash
+shorttitle
+\family default
+ (2.1.5),
+\family typewriter
-\end_inset
+\backslash
+shortauthors
+\family default
+ (2.1.5)
+\end_layout
-, and
-\begin_inset Flex Noun
-status collapsed
+\begin_layout Itemize
-\begin_layout Plain Layout
-date
-\end_layout
+\family typewriter
+\backslash
+email
+\family default
+ (2.3) – can only be used
+\begin_inset Quotes eld
\end_inset
-—are provided by
-\begin_inset Flex Code
-status collapsed
+standalone
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-article (AMS)
+, not in the middle of a paragraph.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
-\end_inset
+\begin_layout Itemize
- and
-\begin_inset Flex Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-book (AMS)
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
-
-:
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Address This should be the author's permanent address.
-\end_layout
+\family typewriter
-\begin_layout Description
-Current
-\begin_inset space ~
+\backslash
+notetoeditor
+\family default
+ (2.6) – can only be used
+\begin_inset Quotes eld
\end_inset
-Address This should be the author's temporary address at the time of submission,
- if different from the Address.
-\end_layout
-
-\begin_layout Description
-Email Author's e-mail address
-\end_layout
+standalone
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
-URL Author's Web address, if desired.
+, not in the middle of a paragraph.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Subjectclass These refer to the AMS Subject Classifications, published and
- described in
-\emph on
-Mathematical Reviews
-\emph default
-.
- These are also available online at the AMS cites listed above.
-\end_layout
+\family typewriter
-\begin_layout Description
-Thanks
+\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 Description
-Dedicatory
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Translator
-\end_layout
+\family typewriter
-\begin_layout Standard
-The following environments are provided by both the
-\begin_inset Flex Code
-status collapsed
+\backslash
+placefigure
+\family default
+ (2.8) – same as for
+\family typewriter
-\begin_layout Plain Layout
-Theorems
+\backslash
+placetable
\end_layout
-\end_inset
+\begin_layout Itemize
- and
-\begin_inset Flex Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
+\backslash
+acknowledgements
+\family default
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
+\begin_layout Itemize
- modules, in the latter case in both starred (unnumbered) and unstarred
- (numbered) versions.
- These same environments are provided only in the starred versions by the
-
-\begin_inset Flex Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Starred)
+\backslash
+appendix
+\family default
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
-
- module:
-\end_layout
+\begin_layout Itemize
-\begin_layout Theorem
-This is typically used for the statements of major results.
-
-\end_layout
+\family typewriter
-\begin_layout Corollary*
-This is used for statements which follow fairly directly from previous statement
-s.
- Again, these can be major results.
+\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
+.
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Lemma
-These are smaller results needed to prove other statements.
-\end_layout
+Short Title
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Proposition
-These are less major results which (hopefully) add to the general theory
- being discussed.
-\end_layout
+ inserts an optional argument of the type needed by
+\family typewriter
-\begin_layout Conjecture
-These are statements provided without justification, which the author does
- not know how to prove, but which seem to be true (to the author, at least).
+\backslash
+figcaption
+\family default
+.
+ Hopefully it will be renamed someday.
\end_layout
-\begin_layout Definition*
-Guess what this is for.
- The font is different for this environment than for the previous ones.
-
-\end_layout
+\begin_layout Itemize
-\begin_layout Example*
-Used for examples illustrating proven results.
-\end_layout
+\family typewriter
-\begin_layout Problem
-It's not really known what this is for.
- You should figure it out.
-\end_layout
+\backslash
+objectname
+\family default
+ (2.17.1) – same as
+\family typewriter
-\begin_layout Exercise*
-Write a description for this one.
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Remark
-This environment is also a type of theorem, usually a lesser sort of observation.
-\end_layout
+\begin_layout Itemize
-\begin_layout Claim*
-Often used in the course of giving a proof of a larger result.
-\end_layout
+\family typewriter
-\begin_layout Case
-Generally, these are used to break up long arguments, using specific instances
- of some condition.
-
-\end_layout
+\backslash
+dataset
+\family default
+ (2.17.1) – same as
+\family typewriter
-\begin_layout Case
-The numbering scheme for cases is on its own, not together with other numbered
- statements.
-
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Proof
-At the end of this environment, a QED symbol (usually a square, but it can
- vary with different styles) is placed.
- If you want to have other environments within this one—for example, Case
- environments—and have the QED symbol appear only after them, then the other
- environments need to be nested within the proof environment.
- See the section
-\emph on
-Nesting Environments
-\emph default
- of the
-\emph on
-User's Guide
-\emph default
- for information on nesting.
+\begin_layout Subsubsection
+Things not implemented, use \SpecialChar TeX
+ code
\end_layout
\begin_layout Standard
-And these environments are provided by
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Theorems (AMS-Extended)
-\end_layout
+\family typewriter
-\end_inset
+\backslash
+eqnum
+\family default
+ (2.12),
+\family typewriter
-:
-\end_layout
+\backslash
+setcounter{equation}
+\family default
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\begin_layout Criterion*
-A required condition.
-\end_layout
+\backslash
+figurenum
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Algorithm*
-A general procedure to be used.
-\end_layout
+\backslash
+epsscale
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Axiom*
-This is a property or statement taken as true within the system being discussed.
-\end_layout
+\backslash
+plotone
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Condition*
-Sometimes used to state a condition assumed within the present context of
- discussion.
-\end_layout
+\backslash
+plottwo
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Note*
-Similar to a Remark.
-\end_layout
+\backslash
+tablenum
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Notation*
-Used for the explanation of, yes, notation.
-\end_layout
+\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
-\begin_layout Summary
-Do we really need to tell you?
-\end_layout
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
+\family typewriter
-\begin_layout Acknowledgement*
-Acknowledgement.
-\end_layout
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
-\begin_layout Conclusion*
-Sometimes used at the end of a long train of argument.
-\end_layout
+\backslash
+objectname
+\family default
+,
+\family typewriter
-\begin_layout Fact
-Used in a way similar to Proposition, though perhaps lower on the scale.
-\end_layout
+\backslash
+dataset
+\family default
+,
+\family typewriter
-\begin_layout Standard
-In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
- and AMS fonts
- packages.
- They need to be available on your system in order to use these environments.
-\end_layout
+\backslash
+url
+\family default
+, and
+\family typewriter
-\begin_layout Section
-AGU journals (
-\family sans
-aguplus
+\backslash
+email
\family default
-)
-\end_layout
+; see above),
+\family typewriter
-\begin_layout Standard
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
+\backslash
+singlespace
+\family default
+ (3.1),
+\family typewriter
-\begin_layout Subsection
-Description
-\end_layout
+\backslash
+doublespace
+\family default
+ (3.1),
+\family typewriter
-\begin_layout Standard
-These are the layout files for some of the journals of the American Geophysical
- Society.
- It is assumed that you have both the AGU's own class files and AGUplus
- installed (everything to be found at
-\begin_inset Flex URL
-status collapsed
+\backslash
+onecolumn
+\family default
+ (3.2),
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+twocolumn
+\family default
+ (3.2)
+\end_layout
-http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
+\begin_layout Subsubsection
+Things that cannot be implemented
\end_layout
+\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
-).
+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 Subsection
-New styles
+FAQs, Tips, Tricks, and Other Ruminations
+\end_layout
+
+\begin_layout Subsubsection
+Getting \SpecialChar LyX
+ and AAS\SpecialChar TeX
+ to cooperate
\end_layout
\begin_layout Standard
-Redefined are
-\family sans
-Paragraph
-\family default
-,
-\family sans
-Paragraph*
-\family default
+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 Enumerate
+Make certain that \SpecialChar LaTeX
+ can find AAS\SpecialChar TeX
.
- They are still called this in the \SpecialChar LyX
- GUI, though their \SpecialChar LaTeX
- equivalents in the
- AGU classes are
-\family sans
-Subsubsubsection
-\family default
- and
-\family sans
-Subsubsubsection*
+ 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
-Newly defined styles are
-\family sans
-Left_Header
-\family default
-,
-\family sans
-Right_Header
-\family default
-,
-\family sans
-Received
-\family default
-,
-\family sans
-Revised
-\family default
-,
-\family sans
-Accepted
-\family default
-,
-\family sans
-CCC
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
\family default
-,
-\family sans
-PaperId
+ appears in \SpecialChar LyX
+'s
+\family typewriter
+layouts
\family default
-,
+ folder
+\end_layout
+
+\begin_layout Enumerate
+Rerun
\family sans
-AuthorAddr
+Tools\SpecialChar menuseparator
+Reconfigure
\family default
-,
+ in \SpecialChar LyX
+, then restart \SpecialChar LyX
+.
+\end_layout
+
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AAS\SpecialChar TeX
+ appear in the class list in
\family sans
-SlugComment
+Document\SpecialChar menuseparator
+Settings
\family default
-.
- These are mostly manuscript attributes and defined in the AGU class documentati
-on.
+?
\end_layout
\begin_layout Standard
-I suspect this is still badly incomplete.
+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 Subsection
-New floats
+\begin_layout Subsubsection
+\SpecialChar LaTeX
+ error processing a table
\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
-Planotable
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\family default
- and
+, then set the
\family sans
-Plate
+Alignment
\family default
-.
- We also have a new
+ to
\family sans
-Table_Caption
+Block
\family default
.
+ This took care of it for me.
\end_layout
-\begin_layout Subsection
-Supported journals
+\begin_layout Subsubsection
+References
\end_layout
-\begin_layout Itemize
-
+\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
-Journal of Geophysical Research
+no
\emph default
-:
+ space between the last author and the parenthesis setting off the year;
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\emph default
+type
\family typewriter
-jgrga.layout
+Ressler(1992)
\family default
- — Martin Vermeer
+, 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
+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_layout Subsubsection
+Including EPS files
\end_layout
\begin_layout Standard
-Add your own, it isn't so hard! Look at the
+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
-jgrga.layout
+
+\backslash
+plotone
\family default
- example and
+, 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
-aguplus.inc
+
+\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 Subsection
-Bugs and things to remember
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
\begin_layout Standard
-In order to use the new layouts, you must remember to do the following for
- a new document:
-\end_layout
+There are a few
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
+pretty
+\begin_inset Quotes erd
+\end_inset
-\emph on
-Turn off babel
-\emph default
-.
- This can be done in the
-\family sans
-Layout\SpecialChar menuseparator
-Document
-\family default
- or
-\family sans
-Document\SpecialChar menuseparator
-Settings
-\family default
- menu item.
- (AGU articles are always in English, right? So
-\emph on
-don't
-\emph default
- choose a language.)
+ 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 Enumerate
-Enter
-\family typewriter
-jgrga
-\family default
- into the document's
-\family sans
-Extra Options
-\family default
- field.
- (Yes, this is a bug.)
+\begin_layout Subsection
+Final Caveat
\end_layout
-\begin_layout Enumerate
-Make sure you use the
-\family typewriter
-agu.bst
-\family default
- bibliography style, by entering
-\family sans
-agu
-\family default
- into the second field of the Bib\SpecialChar TeX
- inset.
- None of the standard styles will do.
+\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
\begin_layout Section
for you to use as a starting point.
\end_layout
-\begin_layout Section
-EGS journals (
-\family sans
-egs
-\family default
-)
-\end_layout
-
-\begin_layout Standard
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
-
-\begin_layout Subsection
-Description
-\end_layout
-
-\begin_layout Standard
-This is the layout file for the European Geophysical Society journals.
- The needed
-\family typewriter
-egs.cls
-\family default
- can be downloaded from the web site of the EGS under
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-www.copernicus.org
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-New styles
-\end_layout
-
-\begin_layout Standard
-
-\family sans
-Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
- Accepted
-\family default
-,
-\family sans
-Offsets
-\family default
-.
- The current layout file is unfortunately very unmodular and would benefit
- from using the various
-\family typewriter
-std*.inc
-\family default
- file inclusions.
-\end_layout
-
\begin_layout Section
Elsevier Journals
\end_layout
\begin_layout Itemize
\family sans
-Title
-\change_deleted -712698321 1501158884
-
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Author
+TitleAuthor
\end_layout
\begin_layout Itemize
\begin_layout Itemize
\family sans
-Bibliography
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Address
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-RightAddress
+Bibliography
\end_layout
\begin_layout Itemize
-\change_deleted -712698321 1501158888
-
\family sans
-Caption
-\change_unchanged
-
+Address
\end_layout
\begin_layout Itemize
-\change_deleted -712698321 1501158891
-
\family sans
-Comment
-\change_unchanged
-
+RightAddress
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_deleted -712698321 1501160146
-Due to a small bug in \SpecialChar LyX
- y
-\change_inserted -712698321 1501160146
-Y
-\change_unchanged
-ou can't have two of the same type of these environments directly following
+You can't have two of the same type of these environments directly following
each other.
-
-\change_inserted -712698321 1501160182
-If you use a normal paragraph break,
-\change_deleted -712698321 1501160188
-They must be separated by something.
- If you try
-\change_unchanged
-, you will just be extending the previous environment as if you had merged
- the two environments together.
-
-\change_deleted -712698321 1501160194
-So, how do you get around this problem? The simplest option is to insert
- some text between the two environments or add a
-\family sans
-\SpecialChar LaTeX
-
-\family default
- environment between the two with just a
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-%
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- in it.
- This will force \SpecialChar LyX
- to produce two separate environments and hence the correct
- \SpecialChar LaTeX
- output.
- An example is provided in the example file included with the \SpecialChar LyX
- distribution.
- Remember, this problem only occurs if you are trying to place two of the
- same type of theorem-like environments one directly after the other.
-
-\change_inserted -712698321 1501160255
+ If you use a normal paragraph break, , you will just be extending the previous
+ environment as if you had merged the two environments together.
Rather than that, you need to insert a so-called separator.
Please refer to the section entitled
\emph on
User's Guide
\emph default
.
-\change_unchanged
-
\end_layout
\begin_layout Subsubsection
\family default
Instructions to the speaker.
- The () are automatically inserted
-\change_deleted -712698321 1501161286
-, but only the ( will show in \SpecialChar LyX
-.
- Both will be printed
-\change_unchanged
-.
+ The () are automatically inserted.
\end_layout
\begin_layout Itemize
\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
\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
\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
-\change_inserted -712698321 1501082726
-
+ To do this, click on
\begin_inset Info
type "menu"
arg "dialog-show document"
\end_inset
-
-\change_unchanged
-\change_deleted -712698321 1501082743
-
\family sans
-Tools
-\change_unchanged
\SpecialChar menuseparator
-
-\change_deleted -712698321 1501082747
-Preferences
-\change_inserted -712698321 1501082748
Language
-\change_unchanged
-
-\family default
-,
-\change_deleted -712698321 1501082762
-select the
-\family sans
-Lang Opts
-\family default
- tab, deselect the
-\family sans
-Use babel
-\family default
- checkbox in the language settings, and click on
-\family sans
-Apply
-\family default
- (or
-\family sans
-Save
\family default
-, if you wish to make this change permanent)
-\change_inserted -712698321 1501082770
-and select
+, and select
\begin_inset Quotes eld
\end_inset
as
\family sans
Language Package
-\change_unchanged
-
\family default
.
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
The
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
The ijmpc package provides a style named
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
Several new environments are available:
\begin_inset Quotes eld
\end_inset
\end_layout
\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
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
There is no
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
Appendices may be added to the paper,
\emph on
after
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
The ijmpc and the ijmpd packages use the
\family typewriter
tbl
\end_layout
\begin_layout Subsection
+
+\change_deleted 564990737 1669755802
Preparing a paper for submission
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1669755802
Before you submit your paper you must export the \SpecialChar LyX
document as a \SpecialChar LaTeX
file (
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
Remove the comment lines before the
\family typewriter
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1669755802
Remove everything between (and including) the
\family typewriter
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1669755802
The modified
\family typewriter
.tex
.dvi
\family default
document.
-\end_layout
-
-\begin_layout Subsection
-
-\change_deleted -712698321 1501082212
-Use of \SpecialChar TeX
- code
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -712698321 1501082212
-The use of \SpecialChar TeX
- code is reduced to two commands, which must be placed at the
- top of the document.
- If you started writing your paper by using the
-\family typewriter
-ijmpc.lyx
-\family default
- or the
-\family typewriter
-ijmpd.lyx
-\family default
- template, the \SpecialChar TeX
- code needed is already in its place; you usually don't need
- to delete it.
- You may only modify the first \SpecialChar TeX
- code to specify the information printed
- to the top of odd and even pages (authors' names and short paper's title,
- respectively).
- This \SpecialChar TeX
- code must have the form
-\family typewriter
-
-\backslash
-markboth{Authors' Names}{Short Paper's Title}
-\family default
-.
\change_unchanged
\end_layout
\begin_layout Section
+
+\change_deleted 564990737 1669801478
iopart
\end_layout
\begin_layout Standard
+
+\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
\end_layout
\begin_layout Subsection
+
+\change_deleted 564990737 1669801478
Writing a paper
\end_layout
\begin_layout Standard
-The easiest way to write a paper is to start with the
-\change_deleted -712698321 1501162201
-file
-\change_inserted -712698321 1501162202
-template
-\change_unchanged
-
+
+\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
-\change_deleted -712698321 1501162208
-in \SpecialChar LyX
-'s examples files folder
-\change_inserted -712698321 1501162222
-via
+ that is available via
\family sans
File\SpecialChar menuseparator
-New From Template\SpecialChar ldots
-
-\change_deleted -712698321 1501162219
-
+New From Template
\family default
-.
-
-\change_unchanged
-
-\change_deleted -712698321 1501162234
-Open this file, save it under a new name, and start writing.
-
-\change_unchanged
- The
-\change_deleted -712698321 1501162238
-example file
-\change_inserted -712698321 1501162239
-template
-\change_unchanged
- explains how to use the special text environments.
+ 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
-
-\change_deleted -712698321 1501162254
-two options
-\family sans
-Use AMS math package
-\family default
- in the document settings under
-\family sans
-Math Options
-\family default
- are not used
-\change_inserted -712698321 1501162277
-no AMS packages are loaded in
+ no AMS packages are loaded in
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
Math Options
-\change_unchanged
-
\family default
!
\end_layout
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\size normal
The title environment defines the kind of your paper.
So use one of the following environments for the title:
\begin_deeper
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Title
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Review
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Topical
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Comment
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Note
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Paper
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Prelim
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Rapid
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\family sans
\size normal
Letter
\end_deeper
\begin_layout Itemize
+\change_deleted 564990737 1669801478
+
\size normal
All title environments except of
\family sans
\end_layout
\begin_layout Itemize
+
+\change_deleted 564990737 1669801478
There is a general title environment
\family sans
Article
\family default
- which is not directly supported by
-\change_deleted -712698321 1501162663
- the
-\change_unchanged
- \SpecialChar LyX
+ 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
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1669801478
For more informations like hints for special table and formula formatting,
look at the IOP author guidelines.
+\change_unchanged
+
\end_layout
\begin_layout Section
+
+\change_deleted 564990737 1670317155
Kluwer
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
by
\noun on
Panayotis Papasotiriou
\end_layout
\begin_layout Subsection
+
+\change_deleted 564990737 1670317155
Overview
\end_layout
\begin_layout Standard
+
+\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.
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
\SpecialChar LyX
supports many features of the package but not everything.
However, the \SpecialChar TeX
\end_layout
\begin_layout Subsection
+
+\change_deleted 564990737 1670317155
Writing a paper
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
The easiest way to write a paper is to start with the Kluwer template file.
Click on
\family sans
\end_layout
\begin_layout Subsection
+
+\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
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
Export your paper as a \SpecialChar LaTeX
file.
To do this, click on
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
Edit the resulting
\family typewriter
.tex
\begin_deeper
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
remove the comment lines before the
\family typewriter
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
remove everything between (and including) the
\family typewriter
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
Save the resulting
\family typewriter
.tex
\end_deeper
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
Run the
\family typewriter
.tex
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
View the resulting
\family typewriter
.dvi
\end_layout
\begin_layout Subsection
+
+\change_deleted 564990737 1670317155
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
The Kluwer package has the following
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
It is possible to write multiple articles in the same \SpecialChar LaTeX
file
\begin_inset Foot
\end_layout
\begin_layout Enumerate
+
+\change_deleted 564990737 1670317155
Information given at the beginning of the article (i.
\begin_inset space \thinspace{}
\end_inset
\end_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
\end_layout
\begin_layout Standard
+
+\change_deleted 564990737 1670317155
The
\family typewriter
kluwer.lyx
\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 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
If you use the optional argument (
\family sans
Insert\SpecialChar menuseparator
-
-\change_deleted -712698321 1501163301
-Short
-\begin_inset space ~
-\end_inset
-
-Title
-\change_inserted -712698321 1501163306
Dictum
\begin_inset space ~
\end_inset
Author
-\change_unchanged
-
\family default
), you can insert the dictum's author there.
Dictum and author are separated by a line.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1501163945
Note: This section discusses the obsolete
\family sans
KOMA-Script-Letter (v.
name, which confuses \SpecialChar LaTeX
).
Instead, Memoir comes with a number of its own page styles (see
-\change_deleted -712698321 1501165256
-
\family sans
-Layout\SpecialChar menuseparator
-
-\change_unchanged
Document\SpecialChar menuseparator
-
-\change_inserted -712698321 1501165264
Settings\SpecialChar menuseparator
-
-\change_unchanged
Page
\begin_inset space ~
\end_inset
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.
-
-\change_deleted -712698321 1501165686
-Simply insert two optional arguments if you need this feature, the first
- one containing the short title for the Table of Contents, the second one
- containing an alternative short title for the headers
-\change_inserted -712698321 1501165708
-\SpecialChar LyX
+ \SpecialChar LyX
makes these available in form of specific
\family sans
Short Title
\family sans
Insert
\family default
- menu
-\change_unchanged
-.
+ menu.
\end_layout
\begin_layout Description
article
\emph default
(to be inserted in
-\change_deleted -712698321 1501165976
-
\family sans
-Layout\SpecialChar menuseparator
-
-\change_unchanged
Document\SpecialChar menuseparator
-
-\change_inserted -712698321 1501165986
Settings\SpecialChar menuseparator
Class Settings\SpecialChar menuseparator
-
-\change_deleted -712698321 1501165988
-Extra
-\change_inserted -712698321 1501165989
Custom
-\change_unchanged
-
\begin_inset space ~
\end_inset
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
-\change_inserted -712698321 1501166968
-(optional)
-\change_unchanged
-author (source) are divided by a short line.
-
-\change_deleted -712698321 1501166972
-Unfortunately, we have to fool \SpecialChar LyX
- a bit here again, since the environment
- needs two arguments (text and source).
- In this case, we have to use curly brackets (in \SpecialChar TeX
- mode) between the two
- arguments:
-\emph on
-<smart slogan>
-\emph default
-
-\family typewriter
-}{
-\family default
-
-\emph on
-<author of the slogan>
-\change_inserted -712698321 1501166996
-
-\emph default
-The author (source) can be inserted via
+ 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
-\change_unchanged
-
\family default
\emph on
.
\family sans
Address
\family default
-, the \SpecialChar LaTeX
- won't compile.
-\end_layout
-
-\begin_layout Subsection
-
-\change_deleted -712698321 1501168252
-Drawbacks
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -712698321 1501168252
-The main problem with this layout is that you can't use the optional arguments
- to layouts like Email and Title.
- (The problem is not unique to this layout; you can't use optional arguments
- to the Section layouts either.) This means that after you export that file
- to \SpecialChar LaTeX
- (which you'll need to do eventually to send it in to APS), you'll need
- to edit the \SpecialChar LaTeX
- file with a text editor to add the optional arguments to set,
- e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-the running title for the page headers.
- Lacking these layouts makes the
-\family typewriter
-
-\backslash
-altaffiliation
-\family default
- (and the equivalent
-\family typewriter
-
-\backslash
-altaddress
-\family default
-) useless, so the corresponding layouts don't exist, and will have to be
- added by hand.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Note from JMarc:
-\emph default
- actually, \SpecialChar LyX
- 1.3.0 supports some forms of optional arguments, but this layout
- has not been updated yet to take advantage of it.
-\end_layout
-
-\end_inset
-
-
-\change_unchanged
-
+, the \SpecialChar LaTeX
+ won't compile.
\end_layout
\begin_layout Section
.
\end_layout
-\begin_layout Standard
-
-\change_deleted -712698321 1501168901
-Limitations e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.: does not display the number for theorem-like layouts, just #.
-\change_unchanged
-
-\end_layout
-
\begin_layout Section
Slides [aka
\noun on
-Code
\end_layout
-\begin_layout Itemize
-
-\change_deleted -712698321 1501169265
-
-\family sans
-Comment
-\change_unchanged
-
-\end_layout
-
\begin_layout Standard
All of the other standard environments, including the section-heading environmen
ts, aren't used in the
\begin_inset CommandInset href
LatexCommand href
-target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
+target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
literal "false"
\end_inset
\end_layout
\begin_layout Standard
-Also note that CVS support is not as good as subversion support
-\change_inserted -712698321 1501253107
-,
-\change_unchanged
- so we advise using SVN instead.
- A good place to start learning Subversion is
-\change_inserted -712698321 1501253115
- the
-\change_unchanged
- SVN Book
+Also note that CVS support is not as good as subversion support, so we advise
+ using SVN instead.
+ A good place to start learning Subversion is the SVN Book
\begin_inset Foot
status collapsed
assumes a recent version of the GNU RCS or CVS/SVN
package — no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
- you can check them in the Messages pane if
-\change_inserted -712698321 1501253142
-you are
-\change_unchanged
-unsure.
- Regular users of version control will appreciate
-\change_inserted -712698321 1501253149
-the
-\change_unchanged
-VC toolbar, which can be enabled via
+ you can check them in the Messages pane if you are unsure.
+ Regular users of version control will appreciate the VC toolbar, which
+ can be enabled via
\family sans
View\SpecialChar menuseparator
Toolbars\SpecialChar menuseparator
\begin_layout Standard
For introducing your own external commands consult
-\change_deleted -712698321 1501253161
-vc-command
-\change_inserted -712698321 1501253161
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501253161
vc-command
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
in the manual
-\change_deleted -712698321 1501253168
-of
-\change_unchanged
-
\emph on
\SpecialChar LyX
-
-\change_inserted -712698321 1501253174
-F
-\change_deleted -712698321 1501253173
-f
-\change_unchanged
-unctions
+ Functions
\emph default
.
\end_layout
\begin_layout Standard
RCS command that is run:
-\change_inserted -712698321 1501253193
-
\end_layout
\begin_layout LyX-Code
-\change_deleted -712698321 1501253193
-
-\change_unchanged
-
\family typewriter
ci -q -u -i -t-"<initial description>" <file-name>
\end_layout
\begin_layout Plain Layout
-\change_deleted -712698321 1501253225
-
\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253225
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253231
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253231
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_deleted -712698321 1501253233
-
\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253233
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<new-file-name>
-\change_deleted -712698321 1501253234
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253235
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
ci -q -u
\family typewriter
-i
-\change_deleted -712698321 1501253236
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253236
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<new-file-name>
-\change_deleted -712698321 1501253239
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253239
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501254263
-
-\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254263
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<file-name>
-\change_deleted -712698321 1501254266
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254266
-
-\lang ngerman
-"
-\change_unchanged
-
+"<file-name>"
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501254267
-
-\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254267
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<new-file-name>
-\change_deleted -712698321 1501254269
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254269
-
-\lang ngerman
-"
-\change_unchanged
-
+"<new-file-name>"
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-cvs -q add
-\change_deleted -712698321 1501254271
-
-\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254271
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<new-file-name>
-\change_deleted -712698321 1501254272
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254272
-
-\lang ngerman
-"
-\change_unchanged
-
+cvs -q add "<new-file-name>"
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501254274
-
-\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254274
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<file-name>
-\change_deleted -712698321 1501254277
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254277
-
-\lang ngerman
-"
-\change_unchanged
-
+"<file-name>"
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501254278
-
-\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254278
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<new-file-name>
-\change_deleted -712698321 1501254279
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254279
-
-\lang ngerman
-"
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-cvs -q add
-\change_deleted -712698321 1501254281
-
-\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501254281
-
-\lang ngerman
-"
-\change_unchanged
-
-\lang english
-<new-file-name>
-\change_deleted -712698321 1501254282
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501254282
-
-\lang ngerman
-"
-\change_unchanged
-
+"<new-file-name>"
\end_layout
\end_inset
\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-cvs -q remove
-\change_deleted -712698321 1501254285
-
-\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
+status collapsed
-\change_inserted -712698321 1501254285
+\begin_layout Plain Layout
+cvs -q add "<new-file-name>"
+\end_layout
-\lang ngerman
-"
-\change_unchanged
+\end_inset
-\lang english
-<file-name>
-\change_deleted -712698321 1501254287
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
-\change_inserted -712698321 1501254287
-
-\lang ngerman
-"
-\change_unchanged
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+cvs -q remove "<file-name>"
\end_layout
\end_inset
SVN command that is run:
\family typewriter
svn add -q
-\change_deleted -712698321 1501253346
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253346
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253348
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253348
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Standard
\family typewriter
svn update --non-interactive
-\change_deleted -712698321 1501253354
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253354
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253356
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253356
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Subsubsection
SVN command:
\family typewriter
svn revert -q
-\change_deleted -712698321 1501253358
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253358
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253360
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253360
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Subsubsection
\begin_layout Plain Layout
svn copy -q
-\change_deleted -712698321 1501253363
-
\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253363
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253365
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253365
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
-\change_deleted -712698321 1501253366
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253366
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<new-file-name>
-\change_deleted -712698321 1501253368
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253368
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
svn move -q
-\change_deleted -712698321 1501253375
-
\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253375
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253377
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253377
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
-\change_deleted -712698321 1501253378
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253378
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<new-file-name>
-\change_deleted -712698321 1501253380
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253380
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-All the commands above have one shortco
-\change_deleted -712698321 1501253385
-m
-\change_unchanged
-ming
-\change_inserted -712698321 1501253389
-–
-\change_deleted -712698321 1501253389
--
-\change_unchanged
- they deal with the current document only.
+All the commands above have one shortcoming – they deal with the current
+ document only.
Once your document contains pictures, includes external
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-svn update –accept mine-full $path
+svn update --accept mine-full $path
\end_layout
\end_inset
The output of
\family typewriter
svn log
-\change_deleted -712698321 1501253404
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253404
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253406
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253406
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\family default
is shown in a browser.
\end_layout
\begin_layout Standard
SVN has two such mechanisms to provide mutual exclusivity for file access
-
-\change_inserted -712698321 1501253410
-–
-\change_deleted -712698321 1501253410
--
-\change_unchanged
- locks and automatic setting of write permissions (see sec.
+ – locks and automatic setting of write permissions (see sec.
\begin_inset CommandInset ref
LatexCommand ref
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501253418
-http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
-\change_inserted -712698321 1501253418
-
\begin_inset Flex URL
status open
\begin_layout Plain Layout
-\change_inserted -712698321 1501253418
-
http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
-\change_unchanged
-
\end_layout
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Itemize
Locked state.
The loaded file is in the
-\change_deleted -712698321 1501253433
-'
-\change_inserted -712698321 1501253433
-
\begin_inset Quotes els
\end_inset
-
-\change_unchanged
normal
-\change_deleted -712698321 1501253435
-'
-\change_inserted -712698321 1501253435
-
\begin_inset Quotes ers
\end_inset
-
-\change_unchanged
edit mode.
No other user is allowed to edit the file.
\end_inset
Control\SpecialChar menuseparator
-
-\change_deleted -712698321 1501244235
-Toggle
-\change_inserted -712698321 1501244235
-Use
-\change_unchanged
-
-\change_deleted -712698321 1501244236
-l
-\change_inserted -712698321 1501244237
-L
-\change_unchanged
-ocking
-\change_inserted -712698321 1501244242
-P
-\change_deleted -712698321 1501244242
-p
-\change_unchanged
-roperty
+Use Locking Property
\family default
.
This command is active only when the file is not locked on the svn server
\begin_inset space ~
\end_inset
-–xml
+--xml
\begin_inset space ~
\end_inset
\end_deeper
\begin_layout Standard
-You can obtain this info via InsetInfo (e.g.
+You can obtain this info via InsetInfo (
+\change_inserted 5863208 1564400022
+
+\lang american
+Insert\SpecialChar menuseparator
+Field\SpecialChar menuseparator
+Version Control Revision
+\change_deleted 5863208 1564399852
+
+\lang english
+e.g.
\begin_inset Flex Code
status collapsed
\end_inset
+
+\change_unchanged
).
The information will be available only when you have the file stored under
svn managment (i.e.
tag in your document (e.g.
-\change_deleted -712698321 1501253475
-
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-$Rev$
-\end_layout
-
-\end_inset
-
-
-\change_inserted -712698321 1501253480
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501253480
$Rev$
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
).
This way svn client will automatically substitute revision number (e.g.
-\change_deleted -712698321 1501253467
-
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-$Rev: 59 $
-\end_layout
-
-\end_inset
-
-
-\change_inserted -712698321 1501253473
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501253473
$Rev: 59 $
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
) after each update and commit.
There are more problems with this approach.
Firstly, the '$' character is used in \SpecialChar TeX
status collapsed
\begin_layout Plain Layout
-svn –version
+svn --version
\end_layout
\end_inset
Save your private .ppk key file and put the public one on the server side.
If the SVN server runs on Linux, note that the format of the public key
is not compatible with Linux openssh and you will need to direcly copy-paste
- the key from the “
+ the key from the
+\begin_inset Quotes eld
+\end_inset
+
+
\emph on
Public key for pasting into OpenSSH authorized_keys file
\emph default
-:” edit field into the server's
+:
+\begin_inset Quotes erd
+\end_inset
+
+ edit field into the server's
\begin_inset Flex Code
status collapsed
\begin_layout Standard
Then you are asked interactively to supply an initial description of the
document.
- Don't forget that registered file is not yet commi
-\change_inserted -712698321 1501253542
-t
-\change_unchanged
-ted.
+ Don't forget that registered file is not yet committed.
\end_layout
\begin_layout Standard
GIT command that is run:
\family typewriter
git add
-\change_deleted -712698321 1501253534
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253534
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253538
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253538
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Standard
\begin_layout Standard
When you are finished editing a file, you commit your changes.
When you do this, you are asked for a description of the changes.
- After that changes are commit
-\change_inserted -712698321 1501253548
-t
-\change_unchanged
-ed.
+ After that changes are committed.
\end_layout
\begin_layout Standard
This will discard all changes made to the document since the last check
in.
You get a warning before changes are discarded.
-\end_layout
-
-\begin_layout Standard
-GIT command:
-\family typewriter
-git checkout -q
-\change_deleted -712698321 1501253553
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253553
+\end_layout
+\begin_layout Standard
+GIT command:
+\family typewriter
+git checkout -q
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253555
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253555
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Subsubsection
\begin_layout Plain Layout
git mv
-\change_deleted -712698321 1501253559
-
\family typewriter
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253559
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253561
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253561
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
-\change_deleted -712698321 1501253562
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253562
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<new-file-name>
-\change_deleted -712698321 1501253564
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253564
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\end_layout
\end_inset
The output of
\family typewriter
git log
-\change_deleted -712698321 1501253567
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_inserted -712698321 1501253567
-
\begin_inset Quotes qld
\end_inset
-
-\change_unchanged
<file-name>
-\change_deleted -712698321 1501253569
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_inserted -712698321 1501253569
-
\begin_inset Quotes qld
\end_inset
-\change_unchanged
-
\family default
is shown in a browser.
\end_layout
\begin_layout Standard
\SpecialChar LyX
- supports GIT hash number of the last commit to the file, author name, date
- and time of last commit.
+ supports GIT hash number of the last commit to the file,
+\change_inserted 1119979965 1564297456
+its abbreviated form,
+\change_unchanged
+author name, date and time of last commit.
All those are extracted from
\family typewriter
-git log -n 1 --pretty=format:%H%n%an%n%ai
+git log -n 1 --pretty=format:%H%n
+\change_inserted 1119979965 1564297427
+%h%n
+\change_unchanged
+%an%n%ai
\family default
.
Tree version information is obtained via
\begin_layout Standard
With the recent addition of the
-\change_deleted -712698321 1501253582
-vc-command
-\change_inserted -712698321 1501253582
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501253582
vc-command
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
function \SpecialChar LyX
power users are allowed to create their own commands for revision
control.
case of \SpecialChar LyX
files, which have more a complicated structure.
Hence we provide binding to the Document comparison feature.
- There are two ways of calling this feature
-\change_inserted -712698321 1501253613
-–
-\change_deleted -712698321 1501253613
--
-\change_unchanged
- either by direct call of
+ There are two ways of calling this feature – either by direct call of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1501253619
-VC_COMPARE
-\change_inserted -712698321 1501253621
vc-compare
-\change_unchanged
-
\end_layout
\end_inset
\SpecialChar LyX
function (for details see \SpecialChar LyX
- functions manual) or by
-\change_inserted -712698321 1501253630
- the toolbar
-\change_unchanged
- icon
-\change_inserted -712698321 1501253655
-
+ functions manual) or by the toolbar icon
\begin_inset Info
type "icon"
arg "vc-compare"
\end_inset
-
-\change_deleted -712698321 1501253665
-/
-\change_inserted -712698321 1501253675
- or the
-\change_unchanged
-menu item
-\change_inserted -712698321 1501253679
-
+ or the menu item
\begin_inset Info
type "menu"
arg "vc-compare"
\end_inset
-
-\change_deleted -712698321 1501253689
-
-\begin_inset Flex Noun
-status collapsed
-
-\begin_layout Plain Layout
-Compare with older revision...
-\end_layout
-
-\end_inset
-
-
-\change_inserted -712698321 1501253693
-, respectively
-\change_unchanged
-.
+, respectively.
One can either compare two chosen revisions of the document or he can simply
compare the current version of edited text with older revisions (where
'
We don't currently support GIT addressing of revisions, one can just compare
edited document with its revision X steps backs, where X is addressed as
-\change_deleted -712698321 1501253702
-HEAD~X
-\change_inserted -712698321 1501253702
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501253702
HEAD~X
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
.
\end_layout
\end_inset
it is easy to plug in new filters
-\change_inserted -712698321 1501229014
-
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501229136
-
\emph on
Filters
\emph default
\end_inset
-
-\change_unchanged
and to perform special processing that you may need.
\end_layout
successfully, whenever you open a new document,
after you have chosen its document class, use the
\family sans
-Document
-\change_deleted -712698321 1501229457
-->
-\change_inserted -712698321 1501229457
-\SpecialChar menuseparator
-
-\change_unchanged
+Document\SpecialChar menuseparator
Settings
\family default
menu to add the
\begin_layout Standard
\SpecialChar LyX
- enables you to write code with a
-\change_deleted -712698321 1501229783
-layout
-\change_inserted -712698321 1501229785
-custom inset
-\change_unchanged
- named
+ enables you to write code with a custom inset named
\begin_inset Flex Noun
status collapsed
\end_inset
-, that works like a normal
-\change_deleted -712698321 1501229871
-paragraph
-\change_inserted -712698321 1501229873
-text inset
-\change_unchanged
- but has a free spacing capability.
+, that works like a normal text inset but has a free spacing capability.
\end_layout
\begin_layout Standard
\end_inset
-
-\change_deleted -712698321 1501230025
-layout
-\change_inserted -712698321 1501230027
-inset
-\change_unchanged
-that, by itself, takes care of the business.
+ inset that, by itself, takes care of the business.
\end_layout
\begin_layout Enumerate
\end_inset
setting, should be set to
-\change_inserted -712698321 1501230220
-
\end_layout
\begin_layout LyX-Code
-\change_deleted -712698321 1501230232
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_unchanged
-
\family typewriter
build-script $$i
\family default
$$r
-\change_deleted -712698321 1501230236
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Newline newline
-\end_inset
-
-
-\change_inserted -712698321 1501230224
-
\end_layout
\begin_layout Standard
that you can place in a directory on your path:
\end_layout
-\begin_layout Standard
-
-\change_deleted -712698321 1501230298
-\begin_inset VSpace defskip
-\end_inset
-
-
-\change_unchanged
-
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -712698321 1501230296
-\begin_inset Newpage pagebreak
-\end_inset
-
-
-\change_unchanged
-
-\end_layout
-
\begin_layout LyX-Code
\family sans
notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
\end_layout
-\begin_layout Standard
-
-\change_deleted -712698321 1501230299
-\begin_inset VSpace defskip
-\end_inset
-
-
-\change_unchanged
-
-\end_layout
-
\begin_layout Standard
The next part of the converter setting is the
\begin_inset Quotes eld
\end_inset
which is to be set to
-\change_inserted -712698321 1501230552
-
\end_layout
\begin_layout LyX-Code
-\change_deleted -712698321 1501230577
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\change_unchanged
-
\family typewriter
parselog=$$s/scripts/listerrors
-\change_deleted -712698321 1501230575
-
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Newline newline
-\end_inset
-
-
-\change_inserted -712698321 1501230544
-
\end_layout
\begin_layout Standard
to:
\end_layout
-\begin_layout Standard
-
-\change_deleted -712698321 1501232274
-\begin_inset VSpace defskip
-\end_inset
-
-
-\change_inserted -712698321 1501232276
-
-\end_layout
-
\begin_layout LyX-Code
echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
\end_layout
-\begin_layout Standard
-
-\change_deleted -712698321 1501232278
-\begin_inset VSpace defskip
-\end_inset
-
-
-\change_unchanged
-
-\end_layout
-
\begin_layout Standard
With this, whenever you are using ddd and find a point in the program that
you want to edit, you just press shift-ctrl-V (in the ddd window), and
Note however that you must enable the \SpecialChar LyX
server to get this feature working
(it is disabled by default).
-
-\change_deleted -712698321 1501232597
-You can enable it in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Inputs
-\family default
-,
-\family sans
-Paths
-\family default
-) by entering in the
-\family sans
-\SpecialChar LyX
-server pipe
-\family default
- a path like
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-/home/<your-home-directory>/.lyx/lyxpipe
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted -712698321 1501232576
-Sec.
+ Sec.
\begin_inset space ~
\end_inset
\end_inset
- explains how to do that
-\change_deleted -712698321 1501232579
-Read the \SpecialChar LyX
- server documentation in the
-\emph on
-Customization Manual
-\emph default
- for further information
-\change_unchanged
-.
+ explains how to do that.
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
There are six new buttons that can be added to your \SpecialChar LyX
toolbar.
-
-\change_deleted -712698321 1501232976
-Five
-\change_inserted -712698321 1501232977
-Four
-\change_unchanged
- of these buttons are short cuts to layout styles:
+ Four of these buttons are short cuts to layout styles:
\family sans
Standard
\family default
\SpecialChar LaTeX
\family default
-,
-\change_inserted -712698321 1501232982
- and
-\change_unchanged
-
+, and
\family sans
\SpecialChar LyX
-Code
\family default
-,
-\change_deleted -712698321 1501232984
-and
-\change_inserted -712698321 1501232988
-one f
-\change_inserted 34634807 1501446371
-o
-\change_deleted 34634807 1501446371
-p
-\change_inserted -712698321 1501232988
-r the custom inset
-\change_unchanged
-
+, one for the custom inset
\family sans
Chunk
\family default
\end_layout
\begin_layout LyX-Code
- Icon "
-\change_deleted -712698321 1501232918
-layout
-\change_inserted -712698321 1501232921
-flex.insert
-\change_unchanged
- Chunk"
+ Icon "flex.insert Chunk"
\end_layout
\begin_layout LyX-Code
\family default
) and must have the \SpecialChar LaTeX
-package
-\change_deleted -712698321 1501235255
-multicol
-\change_inserted -712698321 1501235255
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501235255
multicol
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
installed.
\end_layout
status open
\begin_layout Plain Layout
+
3
\end_layout
\begin_layout Plain Layout
\size footnotesize
-The youth moved in the best society–had, so far as was known, no enemies
- and no particular vices.
+The youth moved in the best society
+\begin_inset space ~
+\end_inset
+
+– had, so far as was known, no enemies and no particular vices.
He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
had been broken off by mutual consent some months before, and there was
no sign that it had left any very profound feeling behind it.
\begin_layout Plain Layout
\size footnotesize
-Ronald Adair was fond of cards–playing continually, but never for such stakes
- as would hurt him.
+Ronald Adair was fond of cards
+\begin_inset space ~
+\end_inset
+
+– playing continually, but never for such stakes as would hurt him.
He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
It was shown that, after dinner on the day of his death, he had played
a rubber of whist at the latter club.
\size default
\size footnotesize
-The evidence of those who had played with him– Mr.
- Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
- and that there was a fairly equal fall of the cards.
+The evidence of those who had played with him
+\begin_inset space ~
+\end_inset
+
+– Mr.
+ Murray, Sir John Hardy, and Colonel Moran
+\begin_inset space ~
+\end_inset
+
+– showed that the game was whist, and that there was a fairly equal fall
+ of the cards.
Adair might have lost five pounds, but not more.
His fortune was a considerable one, and such a loss could not in any way
affect him.
\begin_layout Standard
For more features of multiple columns, have a look at the
-\change_deleted -712698321 1501236578
-documentation
-\change_inserted -712698321 1501236578
-
\begin_inset CommandInset href
LatexCommand href
name "documentation"
\end_inset
-
-\change_unchanged
of the \SpecialChar LaTeX
-package
-\change_deleted -712698321 1501235271
-multicol
-\change_inserted -712698321 1501235271
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501235271
multicol
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_deleted -712698321 1501236609
-,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "multicol"
-literal "true"
-
-\end_inset
-
-
-\change_unchanged
.
\end_layout
\end_inset
text lines by using
-\change_deleted -712698321 1501235295
-
-\begin_inset Quotes eld
-\end_inset
-
-7
-\backslash
-baselineskip
-\change_inserted -712698321 1501235293
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501235293
7
\backslash
baselineskip
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_deleted -712698321 1501235296
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\change_unchanged
(where the command
-\change_deleted -712698321 1501235285
-
-\backslash
-baselineskip
-\change_inserted -712698321 1501235285
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235285
-
\backslash
baselineskip
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
needs to be inserted as \SpecialChar TeX
code):
\end_layout
\begin_layout Standard
The amount of space before and after multiple columns can be changed by
changing the length
-\change_deleted -712698321 1501235307
-
-\backslash
-multicolsep
-\change_inserted -712698321 1501235307
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235307
-
\backslash
multicolsep
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
.
For example the command
\end_layout
\begin_layout Standard
For this example
-\change_deleted -712698321 1501235314
-
-\backslash
-multicolsep
-\change_inserted -712698321 1501235315
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235315
-
\backslash
multicolsep
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
was set to 2.5
\begin_inset space \thinspace{}
\end_inset
Note:
\series default
The values you set with
-\change_inserted -712698321 1501235328
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235333
-
\backslash
setlength
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_deleted -712698321 1501235331
-
-\series bold
-
-\backslash
-setlength
-\change_unchanged
-
-\series default
will be used for all following multiple columns until you change them again.
\end_layout
\begin_layout Standard
A column break can be forced by inserting the command
-\change_deleted -712698321 1501235399
-
-\backslash
-columnbreak{}
-\change_inserted -712698321 1501235399
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235399
-
\backslash
columnbreak{}
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
as \SpecialChar TeX
Code to that position in the text where the column should be broken.
Note that this leads in most cases to whitespace in the text.
\noun on
The Holy War
\noun default
-–a bargain, every one of them.
+
+\begin_inset space ~
+\end_inset
+
+– a bargain, every one of them.
With five volumes you could just fill that gap on that second shelf.
It looks untidy, does it not, sir?
\begin_inset Quotes erd
The width of the columns is automatically calculated, but you can modify
the space between the columns.
This is done by changing the length
-\change_deleted -712698321 1501235412
-
-\backslash
-columnsep
-\change_inserted -712698321 1501235412
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235412
-
\backslash
columnsep
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
.
Its predefined value is 10
\begin_inset space \thinspace{}
pt.
Here is an example where
-\change_deleted -712698321 1501235418
-
-\backslash
-columnsep
-\change_inserted -712698321 1501235418
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235418
-
\backslash
columnsep
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
is set to 3
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
Between the columns a rule with a width of the length
-\change_deleted -712698321 1501235428
-
-\backslash
-columnseprule
-\change_inserted -712698321 1501235428
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235428
-
\backslash
columnseprule
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
is placed.
If this rule width is set to 0
\begin_inset space \thinspace{}
\noun on
The Holy War
\noun default
-–a bargain, every one of them.
+
+\begin_inset space ~
+\end_inset
+
+– a bargain, every one of them.
With five volumes you could just fill that gap on that second shelf.
It looks untidy, does it not, sir?
\begin_inset Quotes erd
\begin_layout Standard
The rule can be colored by redefining the command
-\change_deleted -712698321 1501235439
-
-\backslash
-columnseprulecolor
-\change_inserted -712698321 1501235439
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1501235439
-
\backslash
columnseprulecolor
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
.
This is done by inserting the command
-\change_deleted -712698321 1501235443
-
-\begin_inset Newline newline
-\end_inset
-
-
-\change_inserted -712698321 1501235444
-
\end_layout
\begin_layout LyX-Code
columnseprulecolor}{
\backslash
color{red}}
-\change_deleted -712698321 1501235445
-
-\begin_inset Newline newline
-\end_inset
-
-
-\change_inserted -712698321 1501235446
-
\end_layout
\begin_layout Standard
as \SpecialChar TeX
Code before the multicolumn inset.
Replace
-\change_deleted -712698321 1501235460
-red
-\change_inserted -712698321 1501235457
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501235462
red
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
in this command by a color of your choice.
You can use all pre- and self-defined colors.
See the
\emph default
for more information about pre- and self-defined colors.
To go back to the default color insert the command
-\change_inserted -712698321 1501235474
-
\end_layout
\begin_layout LyX-Code
-\change_deleted -712698321 1501235472
-\begin_inset Newline newline
-\end_inset
-
-
-\change_unchanged
-
\backslash
renewcommand{
\backslash
columnseprulecolor}{
\backslash
normalcolor}
-\change_inserted -712698321 1501235475
-
\end_layout
\begin_layout Standard
-
-\change_deleted -712698321 1501235473
-\begin_inset Newline newline
-\end_inset
-
-
-\change_unchanged
Here is the example with a cyan rule and 1
\begin_inset space \thinspace{}
\end_inset
\noun on
The Holy War
\noun default
-–a bargain, every one of them.
+
+\begin_inset space ~
+\end_inset
+
+– a bargain, every one of them.
With five volumes you could just fill that gap on that second shelf.
It looks untidy, does it not, sir?
\begin_inset Quotes erd
can modify the paragraph shape to one of your choice.
This can be done by using the \SpecialChar LaTeX
-package
-\change_deleted -712698321 1501236703
-shapepar
-\change_inserted -712698321 1501236703
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\noindent
-
-\change_inserted -712698321 1501236703
shapepar
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
which is loaded by using in the document settings the module
\family sans
Custom paragraph shapes
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1501236716
The package
-\change_deleted -712698321 1501236722
-shapepar
-\change_inserted -712698321 1501236723
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501236723
shapepar
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
takes care that the shape will always be preserved, no matter how much
text is in the paragraph.
Therefore the paragraph size changes with the amount of contained text.
\begin_inset CommandInset href
LatexCommand href
name "Jpgfdraw"
-target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
+target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
literal "false"
\end_inset
\begin_inset CommandInset include
LatexCommand input
filename "SpecialParagraphShape.tex"
+literal "true"
\end_inset
For information how these styles are used and about further customization
possibilities, have a look at the
-\change_inserted -712698321 1501236534
-
-\lang ngerman
-
\begin_inset CommandInset href
LatexCommand href
name "documentation"
-target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
+target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
literal "false"
\end_inset
-
-\change_deleted -712698321 1501236537
-
-\lang english
-documentation
-\change_unchanged
of the package
-\change_deleted -712698321 1501236618
-shapepar
-\change_inserted -712698321 1501236618
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1501236618
shapepar
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_deleted -712698321 1501236618
-,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "shapepar"
-literal "true"
-
-\end_inset
-
-
-\change_unchanged
.
-\change_deleted -712698321 1501236666
-
-\end_layout
-
-\begin_layout Bibliography
-
-\change_deleted -712698321 1501236522
-\begin_inset CommandInset bibitem
-LatexCommand bibitem
-key "multicol"
-literal "true"
-
-\end_inset
-
-Documentation of the \SpecialChar LaTeX
--package
-\begin_inset CommandInset href
-LatexCommand href
-name "multicol"
-target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
-literal "false"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Bibliography
-
-\change_deleted -712698321 1501236522
-\begin_inset CommandInset bibitem
-LatexCommand bibitem
-key "shapepar"
-literal "true"
-
-\end_inset
-
-Documentation of the \SpecialChar LaTeX
--package
-\begin_inset CommandInset href
-LatexCommand href
-name "shapepar"
-target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
-literal "false"
-
-\end_inset
-
-
-\change_unchanged
-
\end_layout
\end_body
projects / lyx.git / blobdiff