-#LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 344
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 362
\begin_document
\begin_header
\textclass scrbook
% redefine the \LyX macro for PDF bookmarks
\def\LyX{\texorpdfstring{%
L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX }}
+ {LyX}}
% used for multi-column text
\usepackage{multicol}
\font_sans default
\font_typewriter default
\font_default_family default
+\use_xetex false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
+\default_output_format default
+\bibtex_command default
+\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
\use_esint 0
\cite_engine basic
\use_bibtopic false
+\use_indices false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
status collapsed
\begin_layout Plain Layout
-
-\bar under
-F
-\bar default
-ile
+File
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\bar under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\emph on
+View\SpecialChar \menuseparator
Format
\end_layout
\end_layout
\begin_layout Itemize
-
-\bar under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-U
-\bar default
-pdate\SpecialChar \menuseparator
-
-\emph on
+View\SpecialChar \menuseparator
+Update\SpecialChar \menuseparator
Format
\end_layout
\end_layout
\begin_layout Itemize
-
-\bar under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-P
-\bar default
-rint
+File\SpecialChar \menuseparator
+Print
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\bar under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-F
-\bar default
-ax
+File\SpecialChar \menuseparator
+Fax
\end_layout
\end_inset
\end_inset
- to convert the DVI file to PostScript®.
+ to convert the DVI file to PostScript.
\end_layout
\begin_layout Itemize
-Run a PostScript® viewer, such as
+Run a PostScript viewer, such as
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-, to display the PostScript® file.
+, to display the PostScript file.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX
+File\SpecialChar \menuseparator
+Import\SpecialChar \menuseparator
+LaTeX
\end_layout
\end_inset
\end_inset
will translate most legal LaTeX, but not everything.
- It will put things it doesn't understand into ERT, so after translating
+ It will put things it doesn't understand into TeX code, so after translating
a file with
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-, you can look for ERT and hand-edit it until it looks right.
+, you can look for TeX code and hand-edit it until it looks right.
\end_layout
\begin_layout Standard
-If you don't know what ERT is, read the next section.
+If you don't know what TeX code is, read the next section.
\end_layout
\begin_layout Section
\end_inset
box containing this text is directly after this paragraph.
- Those of you reading the manual in LyX will only see the ERT inset.
+ Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
\end_layout
\end_layout
\begin_layout Standard
-In addition to using ERT, you can also create a separate file containing
+In addition to using TeX code, you can also create a separate file containing
some complex LaTeX structure and then use
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Standard
If you already know LaTeX, there is no need to explain here what the preamble
is good for.
- If you don't, the following will give you some ideas---we recommend again
+ If you don't, the following will give you some ideas—we recommend again
that you consult a LaTeX book for further information.
In any case, you should read the points below, because they explain what
you can do and what you don't need to do in the LaTeX preamble of a LyX
status collapsed
\begin_layout Plain Layout
-
-\bar under
-L
-\bar default
-aTeX
+LaTeX
\begin_inset space ~
\end_inset
-
-\bar under
-P
-\bar default
-reamble
+Preamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
\end_inset
- are both 0 points, i.e., the page isn't shifted.
+ are both 0
+\begin_inset space \thinspace{}
+\end_inset
+
+points, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the page isn't shifted.
Unfortunately, some DVI drivers always seem to shift the page.
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5 inches too big.
+ Suppose you're left and top margins are always 0.5
+\begin_inset space \thinspace{}
+\end_inset
+
+inches too big.
You can add this to the preamble:
\end_layout
\end_layout
\begin_layout Standard
-This sets things up for Avery® label sheets, stock #5360.
+This sets things up for Avery label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
\begin_inset Flex CharStyle:Code
it follows another one.
The idea behind indenting the first line of a paragraph is to distinguish
neighboring paragraphs from one another.
- If there is no previous paragraph---for example, if it follows a figure
- or is the first paragraph in a section---then there is no need for indentation.
+ If there is no previous paragraph—for example, if it follows a figure or
+ is the first paragraph in a section—then there is no need for indentation.
\end_layout
\end_layout
\begin_layout Enumerate
-If you get a bunch of error boxes piled up at the very top of the document---and
+If you get a bunch of error boxes piled up at the very top of the document—and
especially if you see a
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- error---it means that there are errors in the preamble.
+ error—it means that there are errors in the preamble.
Start debugging your preamble.
\end_layout
\end_layout
\begin_layout Standard
-If all this doesn't help---well, then
+If all this doesn't help—well, then
\emph on
perhaps
\emph default
\end_layout
\begin_layout Standard
-Standard BibTeX uses numbers (e.g.,
+Standard BibTeX uses numbers (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
) to refer to a cited work.
However, in many scientific disciplines, other citation styles are in use.
- The most common one is the author-year style (e.g.,
+ The most common one is the author-year style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, you first need to create two bibliographic databases, e.g.,
+, 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 CharStyle:Code
status collapsed
\end_layout
\begin_layout Standard
-Multiple bibliographies, e.g., a bibliography for each section or chapter
- of the document, are not supported by BibTeX itself.
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a bibliography for each section or chapter of the document, are not supported
+ by BibTeX itself.
But the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- (those commands have to be inserted as ERT).
+ (those commands have to be inserted as TeX code).
The bibliography will contain all references which have been cited in the
current
\begin_inset Flex CharStyle:Code
It is important to note that each of these files is a full 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.
+ 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 LaTeX files; however, these files must not have their
- own preamble
-\emph on
-(i.e.
+ own preamble (i.
+\begin_inset space \thinspace{}
+\end_inset
-\emph default
- everything up to and including the
+g.
+\begin_inset space \space{}
+\end_inset
+
+everything up to and including the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
included file allows you to include a file typeset exactly as it appears
- in the file, i.e., in
+ in the file, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in
\begin_inset Flex CharStyle:Code
status collapsed
preamble in order to get the desired effects.
\end_layout
+\begin_layout Standard
+For more information on fancy headers, see the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+fancyhdr
+\end_layout
+
+\end_inset
+
+ package documentation.
+ This can be found in the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+fancyhdr.dvi
+\end_layout
+
+\end_inset
+
+, which should have been installed with your LaTeX distribution, or
+\begin_inset CommandInset href
+LatexCommand href
+name "online"
+target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Standard
The page header is divided into three fields, not surprisingly labeled
\begin_inset Quotes eld
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.g.:
+ with a blank argument, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.:
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- (e.g., Section 3) in the upper left, the page number (e.g., Page 4) in the
- upper right, your name in the lower left, and the date in the lower right.
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+Section 3) in the upper left, the page number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+Page 4) in the upper right, your name in the lower left, and the date in
+ the lower right.
The following commands should now appear in the preamble:
\end_layout
are marked fancy when using the global fancy setting.
\end_layout
-\begin_layout Standard
-There are more complex commands which will let you insert things in the
- upper left on odd numbered pages, etc., but we will refer you to the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-fancyhdr
-\end_layout
-
-\end_inset
-
- package documentation for more information.
- (Find the file
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-fancyhdr.dvi
-\end_layout
-
-\end_inset
-
-.)
-\end_layout
-
\begin_layout Standard
As a final example, it is possible to include an image in the header or
footer.
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
-<features>
+<features tabularvalignment="middle">
<column alignment="center" valignment="top" width="0pt">
<column alignment="center" valignment="top" width="0pt">
<row>
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 ERT.
+ in each, then you're going to have to get your hands dirty with TeX code.
The bullet selection dialog can help though because it provides you with
the LaTeX code for a wide range of bullet shapes.
To make your own custom paragraphs you have the following options:
\begin_layout Standard
Please note that, at present,
\emph on
-the server does not work on Windows
+the server does not work natively on Windows
\emph default
-®.
+
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
There is no reason it cannot do so.
- But none of the developers on Windows® have yet implemented this functionality
+ But none of the developers on Windows have yet implemented this functionality
there.
\end_layout
\end_inset
-
+ but it does work with Cygwin versions of LyX.
\end_layout
\begin_layout Section
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
\end_inset
' to create the pipes.
If one of the pipes already exists, LyX will assume that another LyX process
is already running and will not start the server.
- This means that if LyX crashes, or if for some other reason, a
+ If for some other reason, an unused
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- pipe is left in existence when LyX closes, then LyX will not start the
- server.
- (This is bug 641.) You will need to delete the pipes manually and then restart
- LyX.
+ pipe is left in existence when LyX closes, then LyX will try to delete
+ it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart LyX.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Other than this, there are a few points to consider:
-\end_layout
-
-\begin_layout Itemize
-Both server and clients must run on UNIX or OS/2 machines.
- Communications between LyX on UNIX and clients on OS/2 or vice versa is
- not possible right now.
-\end_layout
-
-\begin_layout Itemize
-On OS/2, only one client can connect to LyXServer at a time.
-\end_layout
-
-\begin_layout Itemize
-On OS/2, clients must open the input pipe with
+You can find a complete example client written in C in the source distribution
+ as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-O_WRONLY
+development/lyxserver/server_monitor.c
\end_layout
\end_inset
- mode.
+.
\end_layout
\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
+Another useful tool is command-line based client you will find in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-development/lyxserver/server_monitor.c
+src/client/lyxclient
\end_layout
\end_inset
\begin_layout Description
clientname is a name that the client can choose arbitrarily.
- Its only use is that LyX will echo it if it sends an answer---so a client
+ Its only use is that LyX will echo it if it sends an answer—so a client
can dispatch results from different requesters.
\end_layout
\begin_layout LyX-Code
echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
\begin_inset Newline newline
\end_inset
sent from LyX will inform clients that LyX is closing.
\end_layout
-\begin_layout Chapter
-Special Document Classes
-\end_layout
-
\begin_layout Section
-A&A Paper
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
-
-\begin_layout Subsection
-Introduction
+Reverse DVI/PDF search
\end_layout
\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (www.edpsciences.fr/aa/
-\begin_inset Flex URL
+Some DVI/PDF viewers
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-http://www.edpsciences.fr/aa/
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Skim on Mac OSX and SumatraPDF on Windows.
\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
+ provide
+\emph on
+reverse search
+\emph default
+ facility (also called
+\emph on
+inverse search
+\emph default
+).
+ This means that you can tell 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 LyX.
+ This is done via the LyX server either by using the named pipe (
+\emph on
+lyxpipe
+\emph default
+), or the UNIX domain socket (
+\emph on
+lyxsocket
+\emph default
+) that LyX creates in its temporary directory (this is the way the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+ program communicates with LyX).
+ In some cases, you need a helper script that mediates between the viewer
+ and LyX, in others, the viewer can communicate with 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
+Enabling reverse search
\end_layout
\begin_layout Standard
-\align center
-\begin_inset Flex URL
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-ftp://ftp.edpsciences.org/pub/aa/readme.html
+latex/pdflatex
\end_layout
\end_inset
+ program, some are provided by external packages.
+ Your choice depends on whether your LaTeX distribution already provides
+ a given method (the built-in methods are rather new) and whether your viewer
+ can cope with it.
+ The available methods are described in the following.
+\end_layout
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
-
+{}
\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 implicated also some slight changes of the style files, namely
- the removal of the thesaurus command.
- The 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
-LyXDir/layouts/aapaper.layout
-\family default
-.
-\end_layout
+\end_inset
-\begin_layout Subsection
-Getting started
+eX (plain)->DVI
\end_layout
-\begin_layout Standard
-It is recommended you start from the example template distributed with LyX.
- If you are not using a template, note the following settings:
-\end_layout
+\end_inset
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog (OK, that one was obvious).
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
\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.
+eX (plain)->DraftDVI
\end_layout
-\begin_layout Subsection
-The header block
-\end_layout
+\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
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Title
-\family default
-: [required]
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+latex -src-specials $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
+.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
+\end_layout
-\family sans
-Author
-\family default
-: [required]
+\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 LyX preamble:
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Address
-\family default
-: [required]
+\begin_layout Plain Layout
+
+\backslash
+usepackage{pdfsync}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+ for reverse PDF search,
\end_layout
\begin_layout Itemize
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+\begin_layout Plain Layout
+
+\backslash
+usepackage[active]{srcltx}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+ for reverse DVI search.
\end_layout
\begin_layout Standard
-There is no need to issue the
-\family typewriter
+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
-maketitle
-\family default
- command, this is done automatically by 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
+usepackage{ifpdf}
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
+
+\backslash
+ifpdf
+\begin_inset Newline newline
\end_inset
-g.
-\begin_inset space ~
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-to state your present address, just use the standard footnote via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-\bar under
-F
-\bar default
-ootnote.
+\backslash
+else
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
-\family default
- LyX will automagically use the term
-\family typewriter
\backslash
-thanks{}
-\family default
- in that case.
+fi
\end_layout
\begin_layout Standard
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
+This way, you can preview the file as either DVI or PDF (pdflatex) and the
+ right package will be used.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Note that PDFSync might affect the output layout of your document.
+ It is therefore advised to disable PDFsync for final documents.
+\end_layout
-\family typewriter
+\begin_layout Subsubsection*
+Built-in reverse search via SyncTeX (DVI and PDF)
+\end_layout
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+\begin_layout Standard
+Recent versions of
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+(pdf)latex
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+SyncTeX
+\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 TeXLive 2008 or a recent MikTeX distribution in order
+ to use it.
+ Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
+ already provide SyncTeX support.
+\end_layout
-\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.
-\end_layout
+\begin_layout Standard
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
+{}
\end_layout
-\begin_layout Standard
-In all cases, the appropriate command has to be entered in LyX and marked
- as LaTeX code.
- See the examples.
-
-\end_layout
+\end_inset
-\begin_layout Subsection
-The abstract
+eX (plain) -> DVI
\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 not yet implemented for LyX, therefore you have to enter the LaTeX
- command
-\family typewriter
+\end_inset
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
-\end_layout
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Subsection
-Supported environments
-\end_layout
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
+\begin_layout Plain Layout
+
+{}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Standard
+eX (plain) -> DraftDVI
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Section
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsection
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+latex -synctex=1 $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsubsection
-\end_layout
+, and for PDF output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\family sans
-Itemize
+\begin_layout Plain Layout
+
+{}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Enumerate
+eX (pdflatex) -> PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Description
+ or converter to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+pdflatex -synctex=1 $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Caption
-\end_layout
+.
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with SyncTeX.
+\begin_inset Foot
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Abstract
+\begin_layout Plain Layout
+-synctex=1
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Acknowledgment
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-synctex=-1
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Bibliography
+.
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\family sans
-LaTeX
\end_layout
\begin_layout Subsection
-Commands not supported by LyX
+Configuring and using specific viewers
+\end_layout
+
+\begin_layout Subsubsection*
+Xdvi (all platforms)
\end_layout
\begin_layout Standard
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
-\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
+If you use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+xdvi
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+, you don't need to do anything else for performing a reverse DVI search,
+ as LyX already provides the necessary hooks for automatically using the
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-and
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ program.
+ Just setup your document as described above (reverse search is triggered
+ by Ctrl-click or Alt-click on Mac OSX, respectively).
+\end_layout
-\backslash
-email
+\begin_layout Standard
+However, if for whatever reason you want to use the named pipe instead of
+ the socket for communicating with LyX, simply change the DVI viewer in
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ to
+\begin_inset Foot
+status collapsed
-\backslash
-appendix
+\begin_layout Plain Layout
+On Mac OSX you have to use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
-\backslash
-authorrunning
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-inst{}
+\begin_layout Plain Layout
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-keywords{}
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-object{}
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-\family typewriter
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
-\backslash
-titlerunning{}
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
+\end_inset
+
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
+\end_inset
+
+read < "${LYXPIPE}".out || exit
\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 LaTeX code!
-\end_layout
+where
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-Figure and Table Floats
+\begin_layout Plain Layout
+/path/to/lyxpipe
\end_layout
-\begin_layout Standard
-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
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+ is the Ly
+\begin_inset ERT
+status open
-\bar under
-P
-\bar default
-aragraph
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
-Settings.
+{}
\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:
+\end_inset
+
+XServer pipe path specified in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
-\begin_layout Enumerate
-Create a wide figure float:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Flo
-\bar under
-a
-\bar default
-t\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-\bar under
-S
-\bar default
-pan
-\begin_inset space ~
\end_inset
-columns
-\family default
.
-\end_layout
+\begin_inset Foot
+status collapsed
-\begin_layout Enumerate
-Enter your caption text.
-\end_layout
+\begin_layout Plain Layout
+In the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Enumerate
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
+\begin_layout Plain Layout
+development/tools
\end_layout
-\begin_layout Enumerate
-Insert your figure
-\end_layout
+\end_inset
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ folder of a source distribution you can find a
+\begin_inset Flex CharStyle:Code
+status collapsed
-\bar under
-S
-\bar default
-pecial
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+lyxeditor
+\end_layout
-Character
-\bar under
-\SpecialChar \menuseparator
-H
-\bar default
-orizontal
-\begin_inset space ~
\end_inset
-Fill
-\family default
-.
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c
-\begin_inset space ~
\end_inset
-t
-\family default
-.
+
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
+\end_layout
-\backslash
-parbox[b]{55mm}{
-\family default
-.
-
-\series bold
-Do not close the brace!
+\begin_layout Standard
+At the end of
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
-\family sans
-M-c
-\begin_inset space ~
\end_inset
-t
-\family default
-
-\family typewriter
-}
-\family default
-.
+, add the following lines:
\end_layout
-\begin_layout Standard
-Also, refer to the figures in the example paper.
-\end_layout
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
+status collapsed
-\begin_layout Subsection
-Referee layout
+\begin_layout Plain Layout
+
+{}
\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
-\family default
- to the documentclass.
- This must be done using the extra class options field in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
-\end_layout
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection
-The example paper
+exit 1
\end_layout
\begin_layout Standard
-The
-\family sans
-Examples
-\family default
- directory contains an example paper written with LyX.
- It is the example paper from the original macro package, translated to
- LyX.
- Use it for inspiration, and compare the original LaTeX code with LyX way
- of writing.
-\end_layout
-
-\begin_layout Section
-AASTeX
+Modify the lines accordingly if you install LyX somewhere else than in the
+ Applications folder.
\end_layout
\begin_layout Standard
-by
-\noun on
-Mike Ressler
+Reverse search is triggered by Alt-click (OPTION-click).
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection*
+Skim (Mac OSX)
\end_layout
\begin_layout Standard
-AASTeX 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.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
+Enter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+open -a Skim.app $$i
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+ to the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Flex URL
+\end_inset
+
+, and then in
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-http://www.journals.uchicago.edu/AAS/AASTeX
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
\end_inset
+ select Ly
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+{}
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
-
+X.
\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 LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
+Reverse search is triggered by COMMAND-SHIFT-click
\end_layout
-\begin_layout Subsection
-Starting a New Paper
+\begin_layout Subsubsection*
+Okular (KDE)
\end_layout
\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
- Click on
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New from
-\family default
-
-\family sans
-\bar under
-T
-\bar default
-emplate
+Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
+\end_layout
+
+\end_inset
+
+, select
+\begin_inset Quotes eld
+\end_inset
+
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
+
+ and add the command
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient -g %f %l
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by SHIFT-click.
+\end_layout
+
+\begin_layout Subsubsection*
+YAP (Cygwin)
+\end_layout
+
+\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
+\end_layout
+
+\end_inset
+
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
+
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
+
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
+
+New\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
+
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
+
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
+
+Name:
+\begin_inset Quotes erd
+\end_inset
+
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
+
+\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
+\end_layout
+
+\end_inset
+
+ (see below).
+ Select
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
+\end_layout
+
+\end_inset
+
+ and then specify the program arguments as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+%f %l
+\end_layout
+
+\end_inset
+
+ if you want to use the shell script above, or as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-g %f %l
+\end_layout
+
+\end_inset
+
+ if you want to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
+\end_layout
+
+\end_inset
+
+ program.
+ Since yap is a native Windows application, the filename it provides should
+ be converted to POSIX style before being passed to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
+\end_layout
+
+\end_inset
+
+, and this is the purpose of the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
+\end_layout
+
+\end_inset
+
+ wrapper, which is as follows:
+\end_layout
+
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
+\end_inset
+
+if "%1" == "-g" goto lyxclient
+\begin_inset Newline newline
+\end_inset
+
+bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
+\begin_inset Newline newline
+\end_inset
+
+exit
+\begin_inset Newline newline
+\end_inset
+
+:lyxclient
+\begin_inset Newline newline
+\end_inset
+
+bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
+\end_layout
+
+\begin_layout Standard
+You have to make sure that both
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient.exe
+\end_layout
+
+\end_inset
+
+ are in the command PATH, otherwise you have to use their full posix path
+ in the above batch file.
+\end_layout
+
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
+
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
+
+\begin_layout Standard
+In SumatraPDF, you can set the name of the program that communicates with
+ LyX by simply launching SumatraPDF as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
+\end_layout
+
+\end_inset
+
+ and then quit.
+ The program will remember the setting and using the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-inverse-search
+\end_layout
+
+\end_inset
+
+ option will not be needed from now on
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It has been reported that SumatraPDF is not able to remember the settings
+ if it is installed in the Program Files system folder.
+ This problem can be avoided by installing it somewhere else, for example
+ in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/usr/local/bin
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+ (in this way you will be using the lyxsocket; omit the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-g
+\end_layout
+
+\end_inset
+
+ option if you want to use the lyxpipe and be sure that the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
+\end_layout
+
+\end_inset
+
+ script is in your command PATH).
+ If SumatraPDF is not your default PDF viewer, you should enter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
+\end_layout
+
+\end_inset
+
+ in the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
+\end_layout
+
+\end_inset
+
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
+\end_layout
+
+\end_inset
+
+ is the following script (to be placed in your command PATH,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/usr/local/bin
+\end_layout
+
+\end_inset
+
+ being the best choice):
+\end_layout
+
+\begin_layout LyX-Code
+#!/bin/bash
+\begin_inset Newline newline
+\end_inset
+
+cd $(dirname $1)
+\begin_inset Newline newline
+\end_inset
+
+SumatraPDF.exe $(basename $1)
+\end_layout
+
+\begin_layout Standard
+This is needed because SumatraPDF is a native Windows application and does
+ not understand the posix paths used by the Cygwin version of LyX.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
+
+\begin_layout Chapter
+Special Document Classes
+\end_layout
+
+\begin_layout Section
+A&A Paper
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Peter Sütterlin
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.edpsciences.fr/aa/
+\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
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+ftp://ftp.edpsciences.org/pub/aa/readme.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but merely a short guide how to realize the
+ correct form of your paper.
+
+\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 implicated also some slight changes of the style files, namely
+ the removal of the thesaurus command.
+ The 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
+LyXDir/layouts/aapaper.layout
+\family default
+.
+\end_layout
+
+\begin_layout Subsection
+Getting started
+\end_layout
+
+\begin_layout Standard
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
+\end_layout
+
+\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).
+\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
+
+\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
+
+\begin_layout Itemize
+
+\family sans
+Title
+\family default
+: [required]
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Subtitle
+\family default
+: [optional]
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Author
+\family default
+: [required]
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Address
+\family default
+: [required]
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Offprints
+\family default
+: [optional] if more than one author: whom to contact for offprint requests.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Mail
+\family default
+: [optional] mail address for contacts.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
+\end_layout
+
+\begin_layout Standard
+There is no need to issue the
+\family typewriter
+
+\backslash
+maketitle
+\family default
+ command, this is done automatically by 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
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+to state your present address, just use the standard footnote via the menu
+
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
+
+\family default
+ LyX will automagically use the term
+\family typewriter
+
+\backslash
+thanks{}
+\family default
+ in that case.
+\end_layout
+
+\begin_layout Standard
+In addition to these topics, the macros use three additional LaTeX commands
+ that have no counterpart in LyX:
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
+\family default
+ to separate different names for more than one author and institute, respectivel
+y.
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\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.
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+email{address}
+\family default
+ to supply an email address for fast contact.
+\end_layout
+
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
+\end_layout
+
+\begin_layout Subsection
+The abstract
+\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 not yet implemented for LyX, therefore you have to enter the LaTeX
+ command
+\family typewriter
+
+\backslash
+keywords{}
+\family default
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
+\end_layout
+
+\begin_layout Subsection
+Supported environments
+\end_layout
+
+\begin_layout Standard
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Standard
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Section
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Subsection
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Subsubsection
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Itemize
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Enumerate
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Description
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Caption
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Abstract
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Acknowledgment
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+LaTeX
+\end_layout
+
+\begin_layout Subsection
+Commands not supported by LyX
+\end_layout
+
+\begin_layout Standard
+Some commands are not yet supported by the
+\family sans
+paper (A&A)
+\family default
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+email
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+appendix
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+authorrunning
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+inst{}
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+keywords{}
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+object{}
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+titlerunning{}
+\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 LaTeX code!
+\end_layout
+
+\begin_layout Subsection
+Figure and Table Floats
+\end_layout
+
+\begin_layout Standard
+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
+
+Settings.
+\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:
+\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
+\bar under
+S
+\bar default
+pan
+\begin_inset space ~
+\end_inset
+
+columns
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Enter your caption text.
+\end_layout
+
+\begin_layout Enumerate
+Press
+\family sans
+Return
+\family default
+ to move the cursor above the caption.
+\end_layout
+
+\begin_layout Enumerate
+Insert your figure
+\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 LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
+
+t
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Enter
+\family typewriter
+
+\backslash
+parbox[b]{55mm}{
+\family default
+.
+
+\series bold
+Do not close the brace!
+\end_layout
+
+\begin_layout Enumerate
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
+
+t
+\family default
+
+\family typewriter
+}
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+Also, refer to the figures in the example paper.
+\end_layout
+
+\begin_layout Subsection
+Referee layout
+\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
+\family default
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+ Just enter the string
+\family typewriter
+referee
+\family default
+ there.
+\end_layout
+
+\begin_layout Subsection
+The example paper
+\end_layout
+
+\begin_layout Standard
+The
+\family sans
+Examples
+\family default
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
+\end_layout
+
+\begin_layout Section
+AASTeX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+AASTeX 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.
+ LyX has proven to be an excellent tool for generating these documents,
+ especially given its equation, citation, and figure handling capabilities.
+ LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
+ is the version described here, or higher.
+ Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
+ incompatible with LyX.
+ The AASTeX package may be downloaded from the AASTeX Web site
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.journals.uchicago.edu/AAS/AASTeX
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\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 LyX.
+ LyX will not reduce the need to figure out all the AASTeX commands, it
+ will only reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported LaTeX document
+ conforms completely to the requirements of the journal to which you are
+ submitting your paper.
+\end_layout
+
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
+
+\begin_layout Standard
+I strongly suggest that you start with the AASTeX template file.
+ Click on
+\family sans
+File\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
+Template
\family default
, enter the new file name, then choose the
\family typewriter
template file.
For commands such as these, the LaTeX code must be entered directly and
marked as such.
- Such commands are referred to as ERT, or Evil Red Text.
- I tried to minimize the amount of ERT needed in an AASTeX document, but
- there is still a bit more required than any of us would like.
+ Such commands are referred to as TeX code, or Evil Red Text.
+ I tried to minimize the amount of TeX code needed in an AASTeX document,
+ but there is still a bit more required than any of us would like.
\end_layout
\begin_layout Subsection
\begin_layout Enumerate
Export your paper as a LaTeX file (
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
).
\backslash
email
\family default
- (2.3) -- can only be used
+ (2.3) – can only be used
\begin_inset Quotes eld
\end_inset
\end_inset
, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+ Use TeX code if you need to embed it.
\end_layout
\begin_layout Itemize
\backslash
and
\family default
- (2.3) -- will have extra {} after it.
+ (2.3) – will have extra {} after it.
This should not cause an error.
\end_layout
\backslash
notetoeditor
\family default
- (2.6) -- can only be used
+ (2.6) – can only be used
\begin_inset Quotes eld
\end_inset
\end_inset
, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+ Use TeX code if you need to embed it.
\end_layout
\begin_layout Itemize
\backslash
placetable
\family default
- (2.8) -- can't insert a cross-reference tag, you must type the tag name
- by hand
+ (2.8) – can't insert a cross-reference tag, you must type the tag name by
+ hand
\end_layout
\begin_layout Itemize
\backslash
placefigure
\family default
- (2.8) -- same as for
+ (2.8) – same as for
\family typewriter
\backslash
\backslash
acknowledgements
\family default
- (2.9) -- will have extra {} after it.
+ (2.9) – will have extra {} after it.
This should not cause an error.
\end_layout
\backslash
appendix
\family default
- (2.11) -- will have extra {} after it.
+ (2.11) – will have extra {} after it.
This should not cause an error.
\end_layout
\backslash
figcaption
\family default
- (2.14.2) -- you can insert an optional filename argument by placing the cursor
+ (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
\backslash
objectname
\family default
- (2.17.1) -- same as
+ (2.17.1) – same as
\family typewriter
\backslash
\backslash
dataset
\family default
- (2.17.1) -- same as
+ (2.17.1) – same as
\family typewriter
\backslash
\end_layout
\begin_layout Subsubsection
-Things not implemented, use ERT
+Things not implemented, use TeX code
\end_layout
\begin_layout Standard
If you really, really need to use deluxetable, I suggest editing it in
a separate file with a text editor, then using
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-
+Insert\SpecialChar \menuseparator
+Child
\begin_inset space ~
\end_inset
\begin_layout Enumerate
Rerun
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
+Tools\SpecialChar \menuseparator
+Reconfigure
\family default
in LyX, then restart LyX.
\end_layout
Open a regular new file, not from a template.
Does AASTeX appear in the class list in
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
?
\end_layout
This seems to produce a bad interaction in AASTeX so you should click somewhere
in the caption/title, then select
\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+Edit\SpecialChar \menuseparator
+Paragraph
\begin_inset space ~
\end_inset
\family default
to
\family sans
-\bar under
-B
-\bar default
-lock
+Block
\family default
.
This took care of it for me.
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
\begin_inset space ~
\end_inset
-commands as ERT into a Figure Float box if you desire, but I never have
- much luck getting the layout right.
+commands as TeX code into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
With the standard graphics, LyX will insert a
\family typewriter
\end_layout
\begin_layout Standard
-The following environments---as well as the standard environments, such
- as
+The following environments—as well as the standard environments, such as
+
\begin_inset Flex CharStyle:Noun
status collapsed
\end_inset
----are provided by
+—are provided by
\begin_inset Flex CharStyle:Code
status collapsed
\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.
+ 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
\family typewriter
jgrga.layout
\family default
- --- Martin Vermeer
+ — Martin Vermeer
\end_layout
\begin_layout Standard
.
This can be done in the
\family sans
-layout\SpecialChar \menuseparator
-document
+Layout\SpecialChar \menuseparator
+Document
\family default
or
\family sans
-document\SpecialChar \menuseparator
-settings
+Document\SpecialChar \menuseparator
+Settings
\family default
menu item.
(AGU articles are always in English, right? So
\begin_layout Section
Foils [aka
\family sans
-Foil
+FoilTeX
\family default
-\noun on
-TeX
-\noun default
]
\begin_inset CommandInset label
LatexCommand label
There are two document classes that can do this: the default slides class
and the
\family sans
-Foil
+FoilTeX
\family default
-TeX slides class.
+ slides class.
This section documents the latter.
\end_layout
from the
\family sans
-\bar under
-C
-\bar default
-lass
+Class
\family default
entry in the
\family sans
\end_layout
\begin_layout Itemize
-The default font size is 20pt with the other options being 17pt, 25pt and
- 30pt.
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
+
+pt with the other options being 17
+\begin_inset space \thinspace{}
+\end_inset
+
+pt, 25
+\begin_inset space \thinspace{}
+\end_inset
+
+pt and 30
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
\end_layout
\begin_layout Itemize
\begin_layout Itemize
\family sans
-Foil
+FoilTeX
\family default
-TeX supports A4 and Letter paper sizes as well as a special size for working
- with 35mm slides.
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slides.
It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
\begin_layout Itemize
The
\family sans
-\bar under
-P
-\bar default
-agestyle
+Pagestyle
\family default
setting behaves a bit differently for this class.
\family sans
-Foil
+FoilTeX
\family default
-TeX provides extensive footer and header capabilities including a user-defined
+ provides extensive footer and header capabilities including a user-defined
logo.
See section
\begin_inset space ~
\family default
package although its use with
\family sans
-Foil
+FoilTeX
\family default
-TeX is discouraged by the writer of the
+ is discouraged by the writer of the
\family sans
-Foil
+FoilTeX
\family default
-TeX package because of some potential page layout clashes.
+ package because of some potential page layout clashes.
\end_layout
\end_deeper
\begin_layout Standard
The following options may be used in the extra class options in the
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
dialog.
\end_layout
\series bold
35mmSlide
\series default
- This sets up the page layout for 7.33in by 11in paper, which is about the
- same aspect ratio as a 35mm slide, making it a bit easier to work with
- this medium.
+ This sets up the page layout for 7.33
+\begin_inset space \thinspace{}
+\end_inset
+
+in by 11
+\begin_inset space \thinspace{}
+\end_inset
+
+in paper, which is about the same aspect ratio as a 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slide, making it a bit easier to work with this medium.
\end_layout
\begin_layout Labeling
document.
This option tells
\family sans
-Foil
+FoilTeX
\family default
-TeX to use the dvips driver to rotate those pages that are set as landscape
+ to use the dvips driver to rotate those pages that are set as landscape
foils.
\end_layout
class.
There are several additional environments provided by
\family sans
-Foil
+FoilTeX
\family default
-TeX as well as a couple added by LyX.
+ as well as a couple added by LyX.
The following environments are shared with other classes:
\end_layout
Since foils are essentially self-contained sections, with a title and body,
\family sans
-Foil
+FoilTeX
\family default
-TeX provides specific commands for starting new foils and these are:
+ provides specific commands for starting new foils and these are:
\end_layout
\begin_layout Itemize
Since foils are often used in presenting ideas or new theorems and such
\family sans
-Foil
+FoilTeX
\family default
-TeX also provides a comprehensive box of goodies for presenting them:
+ also provides a comprehensive box of goodies for presenting them:
\end_layout
\begin_layout Standard
\begin_layout Standard
\family sans
-Foil
+FoilTeX
\family default
-TeX provides some powerful header and footer capabilities that are best
- set in the preamble although they may be set at any point in a document.
+ provides some powerful header and footer capabilities that are best set
+ in the preamble although they may be set at any point in a document.
If you want to change these settings in your document the best place to
- do so is at the very top of a foil,
+ do so is at the very top of a foil, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
\emph on
-i.e.
+
+\begin_inset space \space{}
+\end_inset
+
\emph default
- straight after the foilhead.
+straight after the foilhead.
\end_layout
\begin_layout Standard
\begin_layout Standard
There are also a few commands provided by
\family sans
-Foil
+FoilTeX
\family default
-TeX that aren't directly supported by LyX but I'll tell you what they do
- and how to use them in section
+ that aren't directly supported by LyX but I'll tell you what they do and
+ how to use them in section
\begin_inset space ~
\end_inset
\begin_layout Standard
\family sans
-Foil
+FoilTeX
\family default
-TeX redefines the floating tables and figures so that they appear exactly
- where they are in the text rather than pushing them to the top of the page
- or to some user specified location.
+ redefines the floating tables and figures so that they appear exactly where
+ they are in the text rather than pushing them to the top of the page or
+ to some user specified location.
In fact if you change the float placement settings they are simply ignored.
\end_layout
-Typeset by
\family sans
-Foil
+FoilTeX
\family default
-TeX-
+-
\begin_inset Quotes erd
\end_inset
g.
\emph default
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
Confidential.
\begin_layout Subsection
Unsupported
\family sans
-Foil
+FoilTeX
\family default
-TeX Goodies
+ Goodies
\begin_inset CommandInset label
LatexCommand label
name "sec:unsuppfoils"
\emph on
all
\emph default
- foilheads 0.5 inches closer to their bodies put the following in the preamble:
-
+ foilheads 0.5
+\begin_inset space \space{}
+\end_inset
+
+in closer to their bodies put the following in the preamble:
\family typewriter
\backslash
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
CUT TO:
\end_layout
\begin_layout Itemize
-(O.S) --- off screen
+(O.S) — off screen
\end_layout
\begin_layout Itemize
-(V.0) --- voice over
+(V.0) — voice over
\end_layout
\begin_layout Itemize
-b.g.
- --- background
+b.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ — background
\end_layout
\begin_layout Itemize
C.U.
- --- close-up
+ — close-up
\end_layout
\begin_layout Itemize
-PAN --- camera movement
+PAN — camera movement
\end_layout
\begin_layout Itemize
-INSERT --- cut to close-up of
+INSERT — cut to close-up of
\end_layout
\begin_layout Section
As usual, the easiest way to write a paper is to start with a template.
Click on
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
New from
\family default
Before previewing your paper, be sure that the babel package is not used.
To do this, click on
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\family default
, select the
\family sans
\family default
tab, deselect the
\family sans
-\bar under
-U
-\bar default
-se babel
+Use babel
\family default
checkbox in the language settings, and click on
\family sans
-\bar under
-A
-\bar default
-pply
+Apply
\family default
(or
\family sans
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
See Ref.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
command to implement table captions.
As a result, a table created by LyX is printed correctly, but its caption
is ignored.
- However, you can use some ERT to overpass this problem, so that captions
+ However, you can use some TeX code to overpass this problem, so that captions
are printed as expected.
To do so, create a float table as usual, remove the caption, and replace
- it with the ERT
+ it with the TeX code
\family typewriter
\backslash
\emph default
}{
\family default
- (sic); you must also the ERT
+ (sic); you must also the TeX code
\family typewriter
}
\family default
\family default
file, then include this file to the LyX document (
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Fil
-\bar under
-e
-\bar default
-\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
\begin_inset space ~
\end_inset
Before you submit your paper you must export the LyX document as a LaTeX
file (
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-a
-\family default
-T
-\family sans
-eX
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
)
\begin_inset Foot
\end_layout
\begin_layout Subsection
-Use of ERT
+Use of TeX code
\end_layout
\begin_layout Standard
-The use of ERT is reduced to two commands, which must be placed at the top
- of the document.
+The use of 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 typewriter
ijmpd.lyx
\family default
- template, the ERT needed is already in its place; you usually don't need
- to delete it.
- You may only modify the first ERT to specify the information printed to
- the top of odd and even pages (authors' names and short paper's title,
+ template, the TeX code needed is already in its place; you usually don't
+ need to delete it.
+ You may only modify the first TeX code to specify the information printed
+ to the top of odd and even pages (authors' names and short paper's title,
respectively).
- This ERT must have the form
+ This TeX code must have the form
\family typewriter
\backslash
Article
\family default
which is not directly supported by the LyX.
- This can be used as ERT when your document doesn't fit into one of the
- other title types.
+ This can be used as TeX code when your document doesn't fit into one of
+ the other title types.
\end_layout
\begin_layout Standard
\begin_layout Standard
LyX supports many features of the package but not everything.
- However, the ERT needed is reduced to some
+ However, the TeX code needed is reduced to some
\begin_inset Quotes eld
\end_inset
\family default
\family sans
-\bar under
-T
-\bar default
-emplate
+Template
\family default
, then choose the
\family typewriter
Export your paper as a LaTeX file.
To do this, click on
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
.
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\family sans
xdvi
\family default
\begin_inset Quotes eld
\end_inset
-ERT
+TeX code
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Enumerate
-Information given at the beginning of the article (i.e., title, subtitle,
- author, institution, running title, running author, abstract and keywords)
- must be included in an environment called
+Information given at the beginning of the article (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+title, subtitle, author, institution, running title, running author, abstract
+ and keywords) must be included in an environment called
\begin_inset Quotes eld
\end_inset
\begin_inset space ~
\end_inset
-between two ERT lines (
+between two TeX code lines (
\family typewriter
\backslash
\end_layout
\begin_layout Enumerate
-don't delete the ERT included in the template, and
+don't delete the TeX code included in the template, and
\end_layout
\begin_layout Enumerate
In addition, the appearance of the headings can be modified by using a
number of options (in LyX to be entered in the field
\family sans
-E
-\bar under
-x
-\bar default
-tra
+Extra
\begin_inset space ~
-\end_inset
-
-Options
-\family default
- of the dialog
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-ocument
+\end_inset
+
+Options
+\family default
+ of the dialog
+\family sans
+Layout\SpecialChar \menuseparator
+Document
\family default
).
A detailed German description of these options can be found in the Koma-Script
\family default
(in LyX to be entered in the extra class options field in the dialog
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
).
They make a clearer modification of page margins possible as do the options
of the dialog
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
.
A detailed German description of these and other type area options can
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
at the beginning of a chapter.
If you use the optional argument (
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+Insert\SpecialChar \menuseparator
Short
\begin_inset space ~
\end_inset
\family default
.
This is thought of as a place to define your own types.
- Copy s
+ Copy scrmacros
\family typewriter
-crmacros.inc
+.inc
\family default
in your personal layout directory and edit the file!
\end_layout
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
for the
scrlettr
\family default
.
- It has --- on the LaTeX side --- a completely new interface and is not
- compatible with the old class.
+ It has — on the LaTeX side — a completely new interface and is not compatible
+ with the old class.
Therefore, LyX supports both, though it is recommended to use the new class.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-e.
-\begin_inset space ~
+g.
+\begin_inset space \space{}
\end_inset
you can write several letters per document).
\family default
(via
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-G
-\bar default
-raphics
+Insert\SpecialChar \menuseparator
+Graphics
\family default
) in the header.
\end_layout
LaTeX table of contents, but not in the LyX table of contents (
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-T
-\bar default
-able
+Document\SpecialChar \menuseparator
+Table
\begin_inset space ~
\end_inset
that.
But in the
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
dialog the corresponding radio button indicates
\family sans
-\bar under
-I
-\bar default
-ndent
+Indent
\family default
.
A
\family sans
-S
-\bar under
-k
-\bar default
-ip
+Skip
\family default
value always has the effect that extra LaTeX commands are inserted in the
document to produce the gap, which is not what is wanted in this case.
, lots will probably never, due to the limitations of LyX's framework.
Of course you can still use all features with the help of some native LaTeX
- commands (ERT
+ commands (TeX code
\begin_inset Foot
status collapsed
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
\begin_inset Quotes erd
\end_inset
-, i
+, i.
\begin_inset space \thinspace{}
\end_inset
-e.
-\begin_inset space ~
+g.
+\begin_inset space \space{}
\end_inset
without pagina).
\family default
), you can emulate article style.
That is, counters (footnotes, figures, tables etc.) will not be reset on
- new chapters, chapters don't start a new page (but are---in contrary to
-
+ new chapters, chapters don't start a new page (but are—in contrary to
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- article classes---still allowed), parts, though, use their own page, as
- in book.
+ article classes—still allowed), parts, though, use their own page, as in
+ book.
\end_layout
\begin_layout Description
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
One is poemtitle, which is a centered title for poems, which will also
be added to the table of contents (verse is the standard environment for
poems.
- Memoir has some enhanced versions of verse, but you need to use ERT, because
- they have to be nested inside regular verse environments, which is not
- possible with LyX).
+ Memoir has some enhanced versions of verse, but you need to use TeX code,
+ because they have to be nested inside regular verse environments, which
+ is not possible with LyX).
\end_layout
\begin_layout Description
\end_layout
\begin_layout Itemize
-Unnumbered titles (with star, eg.
-
+Unnumbered titles (with star, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\family sans
Section*
\family default
\begin_deeper
\begin_layout Description
-rmheadings serif titles --- default,
+rmheadings serif titles — default,
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-authortitle on title page first placed is author next title --- default,
+authortitle on title page first placed is author next title — default,
\end_layout
\begin_layout Description
.
Install it somewhere that LaTeX can see it.
Test it by trying to LaTeX a short RevTeX 4 document in some random directory
- (i.e., not the directory where you installed the class file.) Then, if you
- reconfigure LyX, it will find the class file and let you use the RevTeX4
- textclass.
+ (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+not the directory where you installed the class file.) Then, if you reconfigure
+ LyX, it will find the class file and let you use the RevTeX4 textclass.
\end_layout
\begin_layout Standard
goes in the
\family sans
-La
-\family default
-T
-\family sans
-eX
+LaTeX
\begin_inset space ~
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g., the running title for the page headers.
+g.
+\begin_inset space \space{}
+\end_inset
+
+the running title for the page headers.
Lacking these layouts makes the
\family typewriter
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\family typewriter
svjog.layout
\family default
\family typewriter
texhash
\family default
-, as root if necessary --- doesn't LyX take care of this?), reconfigure
- LyX and it should work.
+, as root if necessary — doesn't LyX take care of this?), reconfigure LyX
+ and it should work.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-A large number of theorem-like styles ---
+A large number of theorem-like styles —
\family sans
Claim, Conjecture,
\family default
\family typewriter
svjog.layout
\family default
- --- Martin Vermeer
+ — Martin Vermeer
\end_layout
\begin_layout Itemize
\family typewriter
svprobth.layout
\family default
- --- Jean-Marc Lasgouttes
+ — Jean-Marc Lasgouttes
\end_layout
\begin_layout Standard
\begin_layout Section
Slides [aka
\noun on
-Sli
+SliTeX
\noun default
-TeX]
+]
\begin_inset CommandInset label
LatexCommand label
name "sec:slitex"
There are two document classes that can do this: the default slides class
and the
\family sans
-Foil
+FoilTeX
\family default
-TeX slides class.
+ slides class.
This section documents the former.
\end_layout
\begin_layout Standard
This class is the LaTeX2e improvement of the old
\noun on
-Sli
+SliTeX
\noun default
-TeX package.
+ package.
Every LaTeX2e distribution includes this class [which I'll just refer to
as
\begin_inset Quotes eld
from the class list in the
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\family default
dialog.
There are some other special things you should know about this class:
\begin_layout Itemize
The option
\family sans
-\bar under
-P
-\bar default
-age
+Page
\begin_inset space ~
\end_inset
\family default
class [using
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
New
\begin_inset space ~
\end_inset
\begin_inset space ~
\end_inset
-
-\bar under
-T
-\bar default
-emplate
+Template
\family default
to open your new document].
The template file also contains some examples of the special paragraph
VisibleText
\family default
, is a rather long-ish label.
- The text following this label --- ordinarily the contents of the paragraph
- environment --- is utterly irrelevant for
+ The text following this label — ordinarily the contents of the paragraph
+ environment — is utterly irrelevant for
\family sans
Slide
\family default
support for time markers, a
\noun on
-Sli
+SliTeX
\noun default
-TeX feature.
+ feature.
So, you'll have to resort to using the LaTeX codes.
\end_layout
\family sans
Slide
\family default
- --
+ –
\family sans
Overlay
\family default
- --
+ –
\family sans
Note
\family default
\noun on
-Sli
+SliTeX
\noun default
-TeX emulation
+ emulation
\begin_inset Quotes erd
\end_inset
\family typewriter
chktex
\family default
- program installed, you'll find in the
+ program installed
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+chktex
+\family default
+ is not yet available when you are using the LaTeX distribution MiKTeX.
+\end_layout
+
+\end_inset
+
+, you'll find in the
\family sans
Tools
\family default
\end_inset
e.
- g.
- is too wide spacing.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+is too wide spacing.
\end_layout
\begin_layout Itemize
\begin_layout Standard
If you have the program installed, usage is as simple as choosing
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-heck
+Tools\SpecialChar \menuseparator
+Check
\begin_inset space ~
\end_inset
The warnings will be placed close to the point of the mistake, and you
can quickly find them by using the
\family sans
-\bar under
-N
-\bar default
-avigate\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-rror
+Navigate\SpecialChar \menuseparator
+Error
\family default
menu item, or the shortcut key
\family sans
to get better along with you.
Another choice in the most desperate situations is to use
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-emove
+View\SpecialChar \menuseparator
+Remove
\begin_inset space ~
\end_inset
\begin_layout Itemize
Export your document as a raw LaTeX file using
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
and run
\family typewriter
because LyX relies on some of the other command line parameters to be set
in a specific way to have a chance to communicate with
\family typewriter
-chktex
+chktex
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Command terminated with space.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Non-breaking space (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+~
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) should have been used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found in non-italic buffer.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
\family default
-.
+
+\begin_inset Quotes erd
+\end_inset
+
+) found more than once.
\end_layout
\begin_layout Enumerate
\size small
\emph on
-Command terminated with space.
+No italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found.
\end_layout
\begin_layout Enumerate
\size small
-Non-breaking space (
+Accent command
\begin_inset Quotes eld
\end_inset
\family typewriter
-~
+cmd
\family default
\begin_inset Quotes erd
\end_inset
-) should have been used.
+ needs use of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+cmd
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Wrong length of dash may have been used.
\end_layout
\begin_layout Enumerate
\size small
\emph on
-You should enclose the previous parenthesis with
\begin_inset Quotes eld
\end_inset
\family typewriter
-{}
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ expected, found
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
\family default
\begin_inset Quotes erd
\begin_layout Enumerate
\size small
-Italic correction (
+Solo
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-/
+%s
\family default
\begin_inset Quotes erd
\end_inset
-) found in non-italic buffer.
+ found.
\end_layout
\begin_layout Enumerate
\size small
-Italic correction (
+You should use
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-/
+%s
\family default
\begin_inset Quotes erd
\end_inset
-) found more than once.
+ to achieve an ellipsis.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-No italic correction (
+Inter-word spacing (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
-/
-\family default
-\begin_inset Quotes erd
+\family default
+
+\begin_inset Quotes eld
\end_inset
-) found.
+) should perhaps be used.
\end_layout
\begin_layout Enumerate
\size small
-Accent command
+Inter-sentence spacing (
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+
+\backslash
+@
\family default
\begin_inset Quotes erd
\end_inset
- needs use of
+) should perhaps be used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not find argument for command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+No match found for
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+%s
\family default
\begin_inset Quotes erd
\begin_layout Enumerate
\size small
-Wrong length of dash may have been used.
+Math mode still on at end of LaTeX file.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
+Number of
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+char
\family default
\begin_inset Quotes erd
\end_inset
- expected, found
+ doesn't match the number of
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+char
\family default
\begin_inset Quotes erd
\begin_layout Enumerate
\size small
-Solo
+You should use either
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
+\family default
+ or
\family typewriter
-%s
+
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ as an alternative to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+"
\family default
\begin_inset Quotes erd
\end_inset
- found.
+.
\end_layout
\begin_layout Enumerate
\size small
-You should use
+You should use "
+\family typewriter
+'
+\family default
+" (ASCII 39) instead of "
+\family typewriter
+´
+\family default
+" (ASCII 180).
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+User-specified pattern found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This command might not be intended.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Comment displayed.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Either
+\family typewriter
+''
+\backslash
+,'
+\family default
+ or
+\family typewriter
+'
+\backslash
+,''
+\family default
+ will look better.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Delete this space to maintain correct page references.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You might wish to put this between a pair of
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+{}
\family default
\begin_inset Quotes erd
\end_inset
- to achieve an ellipsis.
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to remove spaces in front of punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not execute LaTeX command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Don't use
+\family typewriter
+
+\backslash
+/
+\family default
+ in front of small punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Multiple spaces detected in output.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This text may be ignored.
\end_layout
\begin_layout Enumerate
\size small
-Inter-word spacing (
+Use
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
+\family default
+ to begin quotation, not
\family typewriter
+'
+\family default
+.
+\end_layout
-\backslash
+\begin_layout Enumerate
+\size small
+Use
+\family typewriter
+'
\family default
-
+ to end quotation, not
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-) should perhaps be used.
+
+\family default
+.
\end_layout
\begin_layout Enumerate
\size small
-Inter-sentence spacing (
+Don't mix quotes.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-@
+cmd
\family default
\begin_inset Quotes erd
\end_inset
-) should perhaps be used.
+ instead.
\end_layout
\begin_layout Enumerate
\size small
-Could not find argument for command.
+You should put a space in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
-No match found for
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-%s
-\family default
+You should avoid spaces in front of/after parenthesis.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-.
+\size small
+\emph on
+You should not use punctuation in front of/after quotes.
\end_layout
\begin_layout Enumerate
\size small
-Math mode still on at end of LaTeX file.
+Double space found.
\end_layout
\begin_layout Enumerate
\size small
-Number of
-\begin_inset Quotes eld
-\end_inset
+You should put punctuation outside inner/inside display math mode.
+\end_layout
+\begin_layout Enumerate
-\family typewriter
-char
-\family default
+\size small
+You ought to not use primitive TeX in LaTeX code.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- doesn't match the number of
+\size small
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\family typewriter
-char
+%s
\family default
\begin_inset Quotes erd
\end_inset
-.
+
\end_layout
\begin_layout Enumerate
\size small
-You should use either
-\family typewriter
-
\begin_inset Quotes eld
\end_inset
-\family default
- or
\family typewriter
+%s
+\family default
\begin_inset Quotes erd
\end_inset
-
-\family default
- as an alternative to
+ is normally not followed by
\begin_inset Quotes eld
\end_inset
\family typewriter
-"
+%c
\family default
\begin_inset Quotes erd
.
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should use "
-\family typewriter
-'
-\family default
-" (ASCII 39) instead of "
+\begin_layout Standard
+In later versions of LyX, we hope to provide a more complete interface to
+ this tool (and it's smaller cousin
\family typewriter
-´
+lacheck
\family default
-" (ASCII 180).
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-User-specified pattern found.
+) to exploit the full power of it.
+ But it's not exactly useless as it is now: go try it on one of your existing
+ documents of a certain length and be surprised.
\end_layout
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
+\begin_layout Section
+Version Control in LyX
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-Comment displayed.
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes,
+\noun default
+updated by
+\noun on
+Pavel Sanda
\end_layout
-\begin_layout Enumerate
-
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
-\family default
- will look better.
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout Enumerate
-
-\size small
-Delete this space to maintain correct page references.
+\begin_layout Standard
+A friend of mine wanted to try LyX for a group project.
+ When he didn't find support for version control or file locking, he dropped
+ it.
+ This angered me a bit, so I thought that I should at least make support
+ for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
+ This has now been done.
+ LyX now supports some of the most basic RCS commands.
+ If you need to something a bit more sophisticated you will have to do that
+ manually in an xterm.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-You might wish to put this between a pair of
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ read
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-{}
-\family default
-
+rcsintro
\begin_inset Quotes erd
\end_inset
-.
+ (a man file, read it with
+\family typewriter
+man rcsintro
+\family default
+).
+ This file describes all the basic features of RCS.
+ You should especially notice the comment about a RCS directory, and the
+ notion of a master RCS file (the file ending in
+\family typewriter
+,v
+\family default
+).
\end_layout
-\begin_layout Enumerate
-
-\size small
-You ought to remove spaces in front of punctuation.
+\begin_layout Standard
+Later basic CVS/SVN support was added.
+ You should be familiar with CVS/SVN usage before start using it under LyX.
+ Most of the log messages are not currently displayed after operations -
+ you can check them in terminal window if unsure.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package—no guarantees are made for older versions.
+\end_layout
-\size small
-Could not execute LaTeX command.
+\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
+RCS commands in LyX
+\end_layout
-\size small
-Don't use
-\family typewriter
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\backslash
-/
+Control
\family default
- in front of small punctuation.
+ submenu.
+ LyX was tested against RCS 5.7.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
+\family sans
+Register
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-Multiple spaces detected in output.
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+Register
+\family default
+ item is not visible.
+
\end_layout
-\begin_layout Enumerate
-
-\size small
-This text may be ignored.
-\end_layout
+\begin_layout Standard
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
+ The document is now set in Read-Only mode and you have to
+\family sans
+Check
+\begin_inset space ~
+\end_inset
-\begin_layout Enumerate
+Out
+\begin_inset space ~
+\end_inset
-\size small
-Use
-\family typewriter
+For
+\begin_inset space ~
+\end_inset
+Edit
+\family default
+, before making any changes to it.
+ A document under revision control has a
\begin_inset Quotes eld
\end_inset
+[RCS:<version> <locker>]
+\begin_inset Quotes erd
+\end_inset
+
+ item tagged to the filename in the minibuffer.
+\end_layout
-\family default
- to begin quotation, not
+\begin_layout Standard
+RCS command that is run:
\family typewriter
-'
-\family default
-.
+ci -q -u -i -t-"<initial description>" <file-name>
\end_layout
-\begin_layout Enumerate
-
-\size small
-Use
-\family typewriter
-'
-\family default
- to end quotation, not
+\begin_layout Standard
+Read
\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
+man ci
\family default
-.
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Don't mix quotes.
+\family sans
+Check In Changes
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should perhaps use
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Standard
+When you are finished editing a file, you check in your changes.
+ When you do this, you are asked for a description of the changes.
+ This is stored in the history log.
+ The version number is bumped, your changes are applied to the master RCS
+ file, the document is unlocked and set to Read-Only mode.
+
+\end_layout
+\begin_layout Standard
+RCS command:
\family typewriter
-cmd
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- instead.
+ci -q -u -m"<description>" <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You should put a space in front of/after parenthesis.
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+By doing this you lock the document so that only you can edit it.
+ This will also make the document Read-Write only for you.
+ You will usually continue editing for a while and when you are finished
+ you check in your changes.
+ The status line is changed to reflect that you have locked the file.
+
+\end_layout
-\size small
-You should avoid spaces in front of/after parenthesis.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Enumerate
+\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
-\size small
-Double space found.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -f -u<version> <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You should put punctuation outside inner/inside display math mode.
+\family sans
+Undo Last Checkin
\end_layout
-\begin_layout Enumerate
-
-\size small
-You ought to not use primitive TeX in LaTeX code.
+\begin_layout Standard
+This makes as if the last check in never happened.
+ No changes are made to the document loaded into LyX, but the last version
+ is removed from the master RCS file.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+RCS command:
+\family typewriter
+rcs -o<version> <file-name>
+\end_layout
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+\family sans
+Show History
+\end_layout
+\begin_layout Standard
+This show the complete history of the RCS document.
+ The output of
\family typewriter
-%s
+rlog <file-name>
+\family default
+ is shown in a browser.
+ See
+\family typewriter
+man rlog
\family default
+ for more info.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
+\begin_layout Standard
+CVS is now partially supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+Control
+\family default
+ submenu.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Register
+\end_layout
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
+\end_layout
+\begin_layout Standard
+This command registers in CVS your document ONLY in case you have already
+ the documents directory under CVS control (in particular
\family typewriter
-%s
+CVS/Entries
\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
+
+\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 commited.
+\end_layout
+\begin_layout Standard
+CVS command that is run:
+\family typewriter
+cvs -q add -m
\begin_inset Quotes erd
\end_inset
- is normally not followed by
+<entered message>"
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-%c
-\family default
-
+<file-name>
\begin_inset Quotes erd
\end_inset
-.
+
\end_layout
\begin_layout Standard
-In later versions of LyX, we hope to provide a more complete interface to
- this tool (and it's smaller cousin
+Read
\family typewriter
-lacheck
+man svn
\family default
-) to exploit the full power of it.
- But it's not exactly useless as it is now: go try it on one of your existing
- documents of a certain length and be surprised.
+ to understand the switches.
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
\end_layout
-\begin_layout Section
-Version Control in LyX
+\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 commited.
\end_layout
\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes,
-\noun default
-updated by
-\noun on
-Pavel Sanda
+CVS command:
+\family typewriter
+cvs -q commit -m"<description>" "<file-name>"
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
\end_layout
\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
- manually in an xterm.
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
\end_layout
\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
+CVS command:
+\family typewriter
+cvs update
\begin_inset Quotes eld
\end_inset
-rcsintro
+<file-name>
\begin_inset Quotes erd
\end_inset
- (a man file, read it with
-\family typewriter
-man rcsintro
-\family default
-).
- This file describes all the basic features of RCS.
- You should especially notice the comment about a RCS directory, and the
- notion of a master RCS file (the file ending in
-\family typewriter
-,v
-\family default
-).
+
\end_layout
-\begin_layout Standard
-Later basic CVS/SVN support was added.
- You should be familiar with CVS/SVN usage before start using it under LyX.
- Most of the log messages are not currently displayed after operations -
- you can check them in terminal window if unsure.
+\begin_layout Subsubsection
+
+\family sans
+Show History
\end_layout
\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package---no guarantees are made for older versions.
+This show the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ is shown in a browser.
\end_layout
\begin_layout Subsection
-RCS commands in LyX
+SVN commands in LyX
\end_layout
\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
- You can find them in the
+SVN is now partially supported by LyX.
+ You can find the commands in the
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-V
-\bar default
-ersion
+File\SpecialChar \menuseparator
+Version
\begin_inset space ~
\end_inset
Control
\family default
submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against SVN 1.4 and 1.5.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-This command registers your document with RCS (unless you are under the
- directory managed by CVS)\SpecialChar \@.
- You are asked interactively to supply an initial
- description of the document.
- The document is now set in Read-Only mode and you have to
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
+
+\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 commited.
+\end_layout
+
+\begin_layout Standard
+SVN command that is run:
+\family typewriter
+snv add -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man svn
+\family default
+ to understand the switches.
+
+\end_layout
+
+\begin_layout Subsubsection
+
\family sans
-Check
-\begin_inset space ~
+Check In Changes
+\end_layout
+
+\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 commited.
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
+
\end_inset
-Out
-\begin_inset space ~
+.
+\end_layout
+
\end_inset
-For
-\begin_inset space ~
+
+\family typewriter
+svn commit -q -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check Out For Edit
+\end_layout
+
+\begin_layout Standard
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be done manually by you!
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Ditto.
+\end_layout
+
\end_inset
-Edit
-\family default
-, before making any changes to it.
- A document under revision control has a
+
+\family typewriter
+svn update
\begin_inset Quotes eld
\end_inset
-[RCS:<version> <locker>]
+<file-name>
\begin_inset Quotes erd
\end_inset
- item tagged to the filename in the minibuffer.
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
\end_layout
\begin_layout Standard
-RCS command that is run:
+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
+SVN command:
\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
+svn revert -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
\end_layout
\begin_layout Standard
-Read
+This show the complete history of the SVN document.
+ The output of
\family typewriter
-man ci
+svn log
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\family default
- to understand the switches.
-
+ is shown in a browser.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Subsubsection
+File Locking
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-File-Locking"
+
+\end_inset
+
-\family sans
-Check In Changes
\end_layout
\begin_layout Standard
-When you are finished editing a file, you check in your changes.
- When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
+The file exchange through various revision control systems brings the problem
+ of merge conflicts in case two different users try to edit the same (parts
+ of) document.
+ When such conflict happens it needs manual resolving and one reasonable
+ alternative is to provide some kind of locking mechanism, which guarantees
+ that only one user is allowed to edit file at the given time.
\end_layout
\begin_layout Standard
-RCS command:
-\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
+SVN has two mechanisms to provide such kind of mutual exclusivity for file
+ access - locks and automatical setting of write permissions (see sec.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Automatical-Locking-Property"
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Check Out For Edit
-\end_layout
+) based on
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-By doing this you lock the document so that only you can edit it.
- This will also make the document Read-Write only for you.
- You will usually continue editing for a while and when you are finished
- you check in your changes.
- The status line is changed to reflect that you have locked the file.
-
+\begin_layout Plain Layout
+svn:needs-lock
\end_layout
-\begin_layout Standard
-RCS command:
-\family typewriter
-co -q -l <file-name>
+\end_inset
+
+ file svn property
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Revert To Repository Version
+.
+ In a case this property is detected for a given document LyX starts to
+ use SVN locks for document editing automatically and the whole check-in/out
+ mechanism switches to the same regimen as for RCS.
+ This in particular means there are two different modes how file is used
+ in LyX:
\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.
+\begin_layout Itemize
+Unlocked state.
+ The loaded file is in the read-only mode.
+ For editation on needs to check-out.
+
+\emph on
+Check-out
+\emph default
+ consists of update from repository and gaining write lock.
+ If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
-\begin_layout Standard
-RCS command:
-\family typewriter
-co -f -u<version> <file-name>
+\begin_layout Itemize
+Locked state.
+ The loaded file is in the 'normal' edit mode.
+ No other user is allowed to edit the file.
+
+\emph on
+Check-in
+\emph default
+ consists of commiting changes and releasing write-lock.
+ If no changes have been made to the document, no commit will be produced
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Don't be puzzled by the fact that you will be asked for commit message anyway.
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Undo Last Checkin
+ and only the write-lock will be released.
\end_layout
\begin_layout Standard
-This makes as if the last check in never happened.
- No changes are made to the document loaded into LyX, but the last version
- is removed from the master RCS file.
-
+SVN commands:
\end_layout
-\begin_layout Standard
-RCS command:
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-in:
\family typewriter
-rcs -o<version> <file-name>
+ svn commit -q -m"<description>" "<file-name>"
+\begin_inset Newline newline
+\end_inset
+
+svn unlock "<file-name>"
\end_layout
-\begin_layout Subsubsection
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-out:
+\family typewriter
+svn update "<file-name>"
+\begin_inset Newline newline
+\end_inset
-\family sans
-Show History
+svn lock "<file-name>"
\end_layout
-\begin_layout Standard
-This show the complete history of the RCS document.
- The output of
-\family typewriter
-rlog <file-name>
-\family default
- is shown in a browser.
- See
+\begin_layout Subsubsection
+
\family typewriter
-man rlog
-\family default
- for more info.
-\end_layout
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Automatical-Locking-Property"
-\begin_layout Subsection
-CVS commands in LyX
+\end_inset
+
+
+\family default
+Automatical Locking Property
\end_layout
\begin_layout Standard
-CVS is now partially supported by LyX.
- You can find the commands in the
+The above mentioned automatical setting of write permissions of the .lyx
+ file can be set through
\family sans
\bar under
-F
+ F
\bar default
ile\SpecialChar \menuseparator
\begin_inset space ~
\end_inset
-Control
+Control\SpecialChar \menuseparator
+
+\bar under
+T
+\bar default
+oggle locking property
\family default
- submenu.
+.
+ This command is active only when the file is not locked on the svn server
+ (i.e.
+ you need to check-out before proceeding).
\end_layout
-\begin_layout Subsubsection
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
-\family sans
-Register
+commands:
\end_layout
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-\bar under
-R
-\bar default
-egister
-\family default
- item is not visible.
-
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Set:
+\family typewriter
+ svn propset svn:needs-lock ON "<file-name>"
\end_layout
-\begin_layout Standard
-This command registers in CVS your document ONLY in case you have already
- the documents directory under CVS control (in particular
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Unset:
\family typewriter
-CVS/Entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
+svn propdel svn:needs-lock "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
+Revision Information in Documents
\end_layout
\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 commited.
+Currently there is no way how to provide such kind of information directly
+ from LyX.
+ There are possibilities how to activate it with the help of svn features,
+ but each has its own drawbacks.
\end_layout
\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
-\end_inset
+One possibility is to use svn keywords
+\begin_inset Foot
+status collapsed
-<entered message>"
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
+\end_layout
-<file-name>
-\begin_inset Quotes erd
\end_inset
+.
+ In short -- you set file keywords property (e.g.
+
+\family sans
+svn propset svn:keywords 'Rev' file.lyx
+\family default
+) and then paste keyword ERT
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+This is an easy way how to ensure that LyX won't break the line in the middle
+ of keyword tag.
\end_layout
-\begin_layout Standard
-Read
-\family typewriter
-man svn
-\family default
- to understand the switches.
+\end_inset
+
+ tag in your document (e.g.
-\end_layout
+\begin_inset ERT
+status open
-\begin_layout Subsubsection
+\begin_layout Plain Layout
-\family sans
-Check In Changes
+$Rev$
\end_layout
-\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 commited.
-\end_layout
+\end_inset
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs -q commit -m"<description>" <file-name>
+).
+ This way svn client will automatically substitute revision number (e.g.
+
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+$Rev: 59 $
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Revert To Repository Version
+) after each update and commit.
+ There are more problems with this approach.
+ Firstly, the '$' character is used in TeX world for math equations, so
+ any occurence of math formula
+\begin_inset Formula $Rev$
+\end_inset
+
+ become
+\begin_inset Formula $Rev:59$
+\end_inset
+
+ in your LyX document.
+ Similarly for other keywords like Id, Date, Author, etc.
+ Secondly svn output is dependent on your locales, so its very easy that
+ svn would produce some problematic strings once Date is used.
+ Thirdly you get the whole 'Rev: 59' string in your document instead of
+ the plain number.
+ Until subversion implements user's custom keywords it will be hard to use
+ this approach reliably or let LyX to support it directly .
\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.
- Firstly the file is deleted, secondly CVS update command is run.
+The second possibility would be to write your own external-material template
+ which calls either
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
\end_layout
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs update
-\begin_inset Quotes eld
\end_inset
-<file-name>
-\begin_inset Quotes erd
+ utility or parses the output of
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svn info file.lyx
+\end_layout
+
\end_inset
+ command and returns the result back, when typeseting the document.
+\end_layout
+
+\begin_layout Subsection
+SVN and Windows Environment
+\end_layout
+\begin_layout Quote
+My inclination is to say that if the user cannot figure out the command
+ line operations on their own fairly quickly, they would be well advised
+ to use TortoiseSVN.
+ ---P.
+ A.
+ Rubin
\end_layout
\begin_layout Subsubsection
+Preparation
+\end_layout
-\family sans
-Show History
+\begin_layout Standard
+In addition to installing LyX, and having access to a Subversion repository,
+ the user will need to install the Subversion client program.
+ A Windows installer for the client program is available from
+\begin_inset CommandInset href
+LatexCommand href
+name "CollabNet"
+target "http://www.collab.net/nonav/downloads/subversion/"
+
+\end_inset
+
+.
+ The user may also want to install
+\begin_inset CommandInset href
+LatexCommand href
+name "TortoiseSVN"
+target "http://tortoisesvn.tigris.org/"
+
+\end_inset
+
+, which integrates Subversion operations into the context (rightclick) menu
+ of Windows Explorer.
+ Operations done outside LyX will typically be more convenient using the
+ Explorer context menu.
+ Note that TortoiseSVN is not a replacement for the client program, which
+ is what LyX itself will use.
\end_layout
-\begin_layout Standard
-This show the complete history of the CVS document.
- The output of
+\begin_layout Subsubsection
+Bringing a document under Subversion control
+\end_layout
+
+\begin_layout Standard
+Before a LyX document can be brought under version control in Subversion,
+ its parent directory needs to be under version control.
+ If the document is being added to a project already in the repository,
+ this is accomplished by checking the project out to the directory where
+ the new document will be placed.
+ If the project itself is not yet under version control (for instance, if
+ this document starts a new project), the directory must be imported into
+ the repository.
+ This is done outside LyX.
+ Both import and checkout are easily accomplished from the Explorer context
+ menu using TortoiseSVN, or alternatively can be done using the command
+ line client at a DOS prompt.
+ The procedure for importing the project using TortoiseSVN is described
+ below, assuming an existing repository and a new project being started
+ in
\family typewriter
-cvs log
-\begin_inset Quotes eld
-\end_inset
+C:
+\backslash
+new project
+\family default
+.
+ For information on using the Subversion client program, run
+\family typewriter
+svn --help
+\family default
+in a DOS shell.
+\end_layout
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
+Locate
+\family typewriter
+C:
+\backslash
+new project
+\family default
+in Windows Explorer, right click it, and select
+\family typewriter
+TortoiseSVN > Repo-browser
+\family default
+.
+ If necessary, adjust the URL for the repository, then click OK.
+\end_layout
+\begin_layout Enumerate
+Right click the level of the repository under which you want to place the
+ new project folder (typically the top level) and click
+\family typewriter
+Create folder\SpecialChar \ldots{}
\family default
- is shown in a browser.
+ Supply a name for the project folder and click OK.
+ Add a message for the log file if desired, then click OK again.
+ The new project folder should appear in the repository.
+ Finally, click OK again to exit the repository browser.
\end_layout
-\begin_layout Subsection
-SVN commands in LyX
+\begin_layout Enumerate
+Once again right click
+\family typewriter
+C:
+\backslash
+new project
+\family default
+, this time selecting SVN Checkout\SpecialChar \ldots{}
+ Select the URL of the project folder
+ you just created in the repository, and set the checkout directory to
+\family typewriter
+C:
+\backslash
+new project.
+
+\family default
+ Click OK.
+ You will be warned about a non-empty folder; click OK to proceed.
+ You should now have a
+\family typewriter
+.svn
+\family default
+ directory under
+\family typewriter
+C:
+\backslash
+new project.
\end_layout
-\begin_layout Standard
-SVN is now partially supported by LyX.
- You can find the commands in the
+\begin_layout Enumerate
+Create or open your document in LyX and click
\family sans
\bar under
F
\begin_inset space ~
\end_inset
-Control
-\family default
- submenu.
- Please note that if you use password protected access to repository via
- ssh, you will be asked in terminal window.
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Register
-\end_layout
+Control\SpecialChar \menuseparator
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
\bar under
R
\bar default
-egister
-\family default
- item is not visible.
+egister.
-\end_layout
-
-\begin_layout Standard
-This command registers in SVN your document ONLY in case you have already
- the documents directory under SVN control (in particular
-\family typewriter
-.svn/entries
\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
-\end_layout
-
-\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 commited.
+Add a log message and click OK to commit the document to version control.
\end_layout
\begin_layout Standard
-SVN command that is run:
-\family typewriter
-snv add -q
-\begin_inset Quotes eld
-\end_inset
+From this point onward, you should have full functionality in the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-<file-name>
-\begin_inset Quotes erd
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Read
-\family typewriter
-man svn
+Control
\family default
- to understand the switches.
-
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check In Changes
-\end_layout
-
-\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 commited.
-\end_layout
-
-\begin_layout Standard
-SVN command:
-\family typewriter
-svn commit -q -m"<description>" <file-name>
+ menu.
+ You also have the option of checking the document in and out, viewing its
+ history, etc.
+ using the TortoiseSVN context menu in Windows Explorer or the Subversion
+ client program from a command prompt.
\end_layout
-\begin_layout Subsubsection
-
-\family sans
-Check Out For Edit
+\begin_layout Subsection
+Further tuning
\end_layout
\begin_layout Standard
-Updates the changes of this file from the repository.
- Be sure you understand SVN merging and conflicts resolving before using
- this function, because all conflicts has to be done manually by you!
+With the recent addition of the vc-command function LyX power users are
+ allowed to create their own commands for revision control.
\end_layout
\begin_layout Standard
-SVN command:
-\family typewriter
-svn update
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
-
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
\end_layout
-\begin_layout Subsubsection
-
-\family sans
-Revert To Repository Version
-\end_layout
+\begin_layout Description
+Commit:
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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.
-
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
\end_layout
-\begin_layout Standard
-SVN command:
-\family typewriter
-svn revert -q
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Subsubsection
+\begin_layout Description
+Revert:
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Show History
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
\end_layout
-\begin_layout Standard
-This show the complete history of the SVN document.
- The output of
-\family typewriter
-svn log
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
\end_inset
-\family default
- is shown in a browser.
\end_layout
\begin_layout Section
and documentation in a single file.
Literate programming tools then parse the file to produce either readable
documentation or compilable source.
- The WEB style of literate programming was created by D.E.
+ The WEB style of literate programming was created by D.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
Knuth during the development of his TeX typesetting software.
\end_layout
\end_layout
\begin_layout Itemize
-It has a open architecture, i.e., it is easy to plug in new filters and to
- perform special processing that you may need.
+It has a open architecture, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+it is easy to plug in new filters and to perform special processing that
+ you may need.
\end_layout
\begin_inset Quotes erd
\end_inset
- way, i.e., you will be able to use this new LyX feature with some other literate
- programming tool of your choice by just changing your LyX preferences.
+ way, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+you will be able to use this new LyX feature with some other literate programmin
+g tool of your choice by just changing your LyX preferences.
\end_layout
\begin_layout Subsubsection
\family typewriter
@
\family default
- must be taken literally, i.e., LyX should be prevented from making any special
- interpretation of what has been written.
+ must be taken literally, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+LyX should be prevented from making any special interpretation of what has
+ been written.
This is handled by a special layout named Scrap, that works like a normal
paragraph but has a free spacing capability.
\end_layout
class, and with some code and text on it.
How do I print it? The answer is simple, you select
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI,
+View\SpecialChar \menuseparator
+DVI,
\family default
etc.
Just like you would do for a plain document.
\begin_layout Standard
All the Literate Programming support is configured by the
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\family default
panel in the
\begin_inset Quotes eld
It happens that you can define the editor command line invocation in ddd
by accessing the
\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
-
-\bar under
-H
-\bar default
-elpers
+Edit\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Helpers
\family default
dialog and changing the "Edit Sources" entry.
\end_layout
In my toolbar I like to combine the six short cuts above with two more:
One for
\family sans
-\bar under
-V
-\bar default
-iew
+View
\family default
\SpecialChar \menuseparator
\family sans
-\bar under
-U
-\bar default
-pdate
+Update
\family default
\SpecialChar \menuseparator
\family sans
-\bar under
-D
-\bar default
-VI
+DVI
\family default
and the other for
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI
+View\SpecialChar \menuseparator
+DVI
\family default
File menu entries.
Here is how it looks like:
examples/multicol.lyx
\family default
.
- --- mer
+ — mer
\end_layout
\end_inset
\begin_layout Standard
\size footnotesize
-The youth moved in the best society--had, so far as was known, no enemies
+The youth moved in the best society–had, so far as was known, no enemies
and no particular vices.
He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
had been broken off by mutual consent some months before, and there was
\begin_layout Standard
\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–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,
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
and that there was a fairly equal fall of the cards.
Adair might have lost five pounds, but not more.
His fortune was a considerable one, and such a loss could not in any way
\begin_inset Quotes erd
\end_inset
----those large capital letters which begin each new chapter or section.
+—those large capital letters which begin each new chapter or section.
Implementing them with plain LyX/LaTeX is straightforward (assuming you
know some plain TeX!) but does require a lot of work and many iterations,
as you can see by all the ugly TeX-mode stuff at the beginning of this
projects / lyx.git / blobdiff