-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 459
+#LyX 2.2 created this file. For more info see http://www.lyx.org/
+\lyxformat 505
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/doc/
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
% the documentation team
% email: lyx-docs@lists.lyx.org
-% if pdflatex is used
-\usepackage{ifpdf}
-\ifpdf
-
- % set fonts for nicer pdf view
- \IfFileExists{lmodern.sty}
- {\usepackage{lmodern}}{}
-
-\fi % end if pdflatex is used
-
% the pages of the TOC are numbered roman
% and a PDF-bookmark for the TOC is added
\pagenumbering{roman}
shapepar
\end_modules
\maintain_unincluded_children false
-\begin_local_layout
-Format 7
-InsetLayout CharStyle:MenuItem
-LyxType charstyle
-LabelString menu
-LatexType command
-LatexName menuitem
-Font
-Family Sans
-EndFont
-Preamble
-\newcommand*{\menuitem}[1]{{\sffamily #1}}
-EndPreamble
-End
-\end_local_layout
\language english
\language_package default
\inputencoding auto
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "lmodern" "default"
+\font_sans "lmss" "default"
+\font_typewriter "lmtt" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command default
\index_command default
\pdf_backref false
\pdf_pdfusetitle false
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
-\papersize default
+\papersize a4paper
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
+\use_package cancel 0
\use_package esint 0
\use_package mathdots 1
\use_package mathtools 0
\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
-\cite_engine_type numerical
+\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\begin_body
\begin_layout Title
-Additional LyX Features
+Additional \SpecialChar LyX
+ Features
\end_layout
\begin_layout Subtitle
-Version 2.0.x
+Version 2.2.x
\end_layout
\begin_layout Author
-by the LyX Team
+by the \SpecialChar LyX
+ Team
\begin_inset Foot
status collapsed
Richard Heck
\noun default
.
- If you have comments or error corrections, please send them to the LyX
- Documentation mailing list,
+ If you have comments or error corrections, please send them to the \SpecialChar LyX
+ Documentati
+on mailing list,
\begin_inset Flex Code
status collapsed
\begin_layout Standard
This manual is essentially Part II of the
\emph on
-User's Guide\SpecialChar \@.
+User's Guide\SpecialChar endofsentence
\emph default
The reason for separating the two documents is simple: the
\emph default
is already quite lengthy, and it contains information on all of the basic
features one needs to know in order to prepare most documents.
- However, the LyX Team has worked to make LyX extensible through various
- configuration files and external packages.
- That means that if you want to support the Fizzwizzle LaTeX package, you
- can create a layout file (or module) for it without having to alter LyX
+ However, the \SpecialChar LyX
+ Team has worked to make \SpecialChar LyX
+ extensible through various configuration
+ files and external packages.
+ That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
+ package, you can
+ create a layout file (or module) for it without having to alter \SpecialChar LyX
itself.
We've already had contributions of several new features this way, and some
of them are documented here.
\begin_layout Standard
This manual also documents some special features, like fax support, version
control, and SGML support, which require additional software to work properly.
- There is also a chapter on LyX's support for HTML.
- And lastly, there's a chapter of LaTeX tools and tips, things you can use
- to spruce up your documents by directly using the powerful features of
- LaTeX.
- After all, LyX
+ There is also a chapter on \SpecialChar LyX
+'s support for HTML.
+ And lastly, there's a chapter of \SpecialChar LaTeX
+ tools and tips, things you can use to
+ spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
+.
+ After all, \SpecialChar LyX
+
\emph on
is
\emph default
- only WYSIWYM and will only ever interface to some, not all, LaTeX features.
+ only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
+ features.
\end_layout
\begin_layout Standard
\emph on
User's Guide
\emph default
- and all of the basic features of LyX before attempting to read this one.
+ and all of the basic features of \SpecialChar LyX
+ before attempting to read this one.
\end_layout
\begin_layout Standard
-Since many of the topics in this manual depend heavily on LyX's interaction
- with LaTeX, this first chapter covers the inner workings of LyX and how
- to direct LyX to generate exactly the LaTeX code you want.
- It is obviously for more seasoned LyX users.
+Since many of the topics in this manual depend heavily on \SpecialChar LyX
+'s interaction
+ with \SpecialChar LaTeX
+, this first chapter covers the inner workings of \SpecialChar LyX
+ and how to direct
+ \SpecialChar LyX
+ to generate exactly the \SpecialChar LaTeX
+ code you want.
+ It is obviously for more seasoned \SpecialChar LyX
+ users.
\end_layout
\begin_layout Chapter
-LyX and LaTeX
+\SpecialChar LyX
+ and \SpecialChar LaTeX
+
\end_layout
\begin_layout Section
-How LyX Uses LaTeX
+How \SpecialChar LyX
+ Uses \SpecialChar LaTeX
+
\end_layout
\begin_layout Standard
-This chapter is for both TeX-nicians and the LaTeX-curious.
- In it, we'll explain how LyX and LaTeX work together to produce printable
- output.
+This chapter is for both \SpecialChar TeX
+-nicians and the \SpecialChar LaTeX
+-curious.
+ In it, we'll explain how \SpecialChar LyX
+ and \SpecialChar LaTeX
+ work together to produce printable output.
This is the only place in any of the manuals where we assume you know something
- about LaTeX.
+ about \SpecialChar LaTeX
+.
\end_layout
\begin_layout Standard
-At one time, LyX was called a
+At one time, \SpecialChar LyX
+ was called a
\begin_inset Quotes eld
\end_inset
-WYSIWYM frontend to LaTeX,
+WYSIWYM frontend to \SpecialChar LaTeX
+,
\begin_inset Quotes erd
\end_inset
but that's no longer true.
- There are frontends to LaTeX out there.
+ There are frontends to \SpecialChar LaTeX
+ out there.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
- There are also the LaTeX modes for vi and emacs, of course.
+Some familar ones are \SpecialChar TeX
+maker and kile, on Linux, and \SpecialChar TeX
+shop, OSX.
+ There are also the \SpecialChar LaTeX
+ modes for vi and emacs, of course.
\end_layout
\end_inset
- These are basically text editors with the ability to run LaTeX and mark
- any errors in the file you're editing.
- Although LyX
+ These are basically text editors with the ability to run \SpecialChar LaTeX
+ and mark any
+ errors in the file you're editing.
+ Although \SpecialChar LyX
+
\emph on
is
\emph default
\emph on
does
\emph default
- run LaTeX, and it also indicates errors in the file, it also does much,
- much more.
- For one thing, you don't need to know LaTeX to use LyX effectively.
- And LyX has added its own extensions to LaTeX.
+ run \SpecialChar LaTeX
+, and it also indicates errors in the file, it also does much, much
+ more.
+ For one thing, you don't need to know \SpecialChar LaTeX
+ to use \SpecialChar LyX
+ effectively.
+ And \SpecialChar LyX
+ has added its own extensions to \SpecialChar LaTeX
+.
Try the following sometime: select
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Export\SpecialChar \menuseparator
-LaTeX
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\end_layout
\end_inset
from the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
menu (or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+View\SpecialChar menuseparator
Source
+\begin_inset space ~
+\end_inset
+
+Pane
\end_layout
\end_inset
\end_inset
file.
- You'll notice a variety of new macros defined specifically by LyX.
+ You'll notice a variety of new macros defined specifically by \SpecialChar LyX
+.
These macros are defined automatically, according to the features you use
in the document.
\end_layout
\begin_layout Standard
-There are several commands that automatically invoke LaTeX.
+There are several commands that automatically invoke \SpecialChar LaTeX
+.
They are:
\end_layout
\begin_layout Itemize
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
View
\end_layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Update
\end_layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Print
\end_layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Fax
\end_layout
\end_layout
\begin_layout Standard
-They will only invoke LaTeX if the file has changed since the last time
- LaTeX was run.
+They will only invoke \SpecialChar LaTeX
+ if the file has changed since the last time \SpecialChar LaTeX
+ was
+ run.
\end_layout
\begin_layout Standard
-When LyX runs LaTeX on the file you're editing, it performs these steps:
+When \SpecialChar LyX
+ runs \SpecialChar LaTeX
+ on the file you're editing, it performs these steps:
\end_layout
\begin_layout Enumerate
-Convert the document to LaTeX and save to a file with the extension
+Convert the document to \SpecialChar LaTeX
+ and save to a file with the extension
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Enumerate
-Run LaTeX on the
+Run \SpecialChar LaTeX
+ on the
\begin_inset Flex Code
status collapsed
\end_inset
-) needed to compile the LaTeX file.
+) needed to compile the \SpecialChar LaTeX
+ file.
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Standard
-If you have run LaTeX using
-\begin_inset Flex MenuItem
+If you have run \SpecialChar LaTeX
+ using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View
-\bar under
-\SpecialChar \menuseparator
-
-\bar default
+View\SpecialChar menuseparator
DVI
\end_layout
\end_inset
-, LyX then runs a DVI viewer to display the DVI-file.
+, \SpecialChar LyX
+ then runs a DVI viewer to display the DVI-file.
If you have used
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View
-\bar under
-\SpecialChar \menuseparator
-
-\bar default
+View\SpecialChar menuseparator
PostScript
\end_layout
\end_inset
-, LyX performs further steps:
+, \SpecialChar LyX
+ performs further steps:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-LyX does similar things when viewing, or exporting, other formats.
+\SpecialChar LyX
+ does similar things when viewing, or exporting, other formats.
\end_layout
\begin_layout Section
-Translating LaTeX files into LyX
+Translating \SpecialChar LaTeX
+ files into \SpecialChar LyX
+
\end_layout
\begin_layout Standard
-You can import a LaTeX file into LyX by using the
-\begin_inset Flex MenuItem
+You can import a \SpecialChar LaTeX
+ file into \SpecialChar LyX
+ by using the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
-Import\SpecialChar \menuseparator
-LaTeX
+File\SpecialChar menuseparator
+Import\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\end_layout
\end_inset
- command in LyX.
+ command in \SpecialChar LyX
+.
This will call a program named
\begin_inset Flex Code
status collapsed
\end_inset
.
- LyX will then open that file.
+ \SpecialChar LyX
+ will then open that file.
\begin_inset Foot
status collapsed
\end_inset
- will translate most legal LaTeX, but not everything.
- It will put things it doesn't understand into TeX code, so after translating
+ will translate most legal \SpecialChar LaTeX
+, but not everything.
+ It will put things it doesn't understand into \SpecialChar TeX
+ code, so after translating
a file with
\begin_inset Flex Code
status collapsed
\end_inset
-, you can look for TeX code and hand-edit it until it looks right.
+, you can look for \SpecialChar TeX
+ code and hand-edit it until it looks right.
\end_layout
\begin_layout Standard
-If you don't know what TeX code is, read the next section.
+If you don't know what \SpecialChar TeX
+ code is, read the next section.
\end_layout
\begin_layout Section
\end_inset
-Inserting TeX Code into LyX Documents
+Inserting \SpecialChar TeX
+ Code into \SpecialChar LyX
+ Documents
\end_layout
\begin_layout Standard
-Anything you can do in LaTeX you can do in LyX, for a very simple reason:
- You can always insert TeX code into any LyX document.
- LyX cannot, and will never be able to, display every possible LaTeX construct.
- If ever you need to insert LaTeX commands into your LyX document, you can
- use the
+Anything you can do in \SpecialChar LaTeX
+ you can do in \SpecialChar LyX
+, for a very simple reason: You can
+ always insert \SpecialChar TeX
+ code into any \SpecialChar LyX
+ document.
+ \SpecialChar LyX
+ cannot, and will never be able to, display every possible \SpecialChar LaTeX
+ construct.
+ If ever you need to insert \SpecialChar LaTeX
+ commands into your \SpecialChar LyX
+ document, you can use the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TeX Code
+\SpecialChar TeX
+ Code
\end_layout
\end_inset
box, which you can insert into your document with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
-TeX Code
+Insert\SpecialChar menuseparator
+
+\family sans
+TeX
+\family default
+ Code
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-Here's an example of inserting LaTeX commands in a LyX document.
+Here's an example of inserting \SpecialChar LaTeX
+ commands in a \SpecialChar LyX
+ document.
The code looks like this:
\end_layout
status collapsed
\begin_layout Plain Layout
-TeX Code
+\SpecialChar TeX
+ Code
\end_layout
\end_inset
box containing this text is directly after this paragraph.
- Those of you reading the manual in LyX will only see the TeX code inset.
+ Those of you reading the manual in \SpecialChar LyX
+ will only see the \SpecialChar TeX
+ code inset.
Those reading a printed version of the manuals will see the actual results:
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-In addition to using TeX code, you can also create a separate file containing
- some complex LaTeX structure and then use
-\begin_inset Flex MenuItem
+In addition to using \SpecialChar TeX
+ code, you can also create a separate file containing
+ some complex \SpecialChar LaTeX
+ structure and then use
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Child
\begin_inset space ~
\end_inset
know
\emph default
works already.
- Otherwise, you'll have a big job tracking down LaTeX errors.
+ Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
+ errors.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Itemize
-LyX
+\SpecialChar LyX
+
\emph on
does not
\emph default
- check if your LaTeX code is correct.
+ check if your \SpecialChar LaTeX
+ code is correct.
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-On that last point, LyX does have quite a few features tucked into it, and
+On that last point, \SpecialChar LyX
+ does have quite a few features tucked into it, and
more are coming.
- Be sure to check the manuals to make sure that LyX doesn't have such-and-such
+ Be sure to check the manuals to make sure that \SpecialChar LyX
+ doesn't have such-and-such
feature before you decide you have to do it by hand.
- Moreover, there are numerous LaTeX packages out there to do all sorts of
- things, from labels to envelopes to fancy multipage tables.
+ Moreover, there are numerous \SpecialChar LaTeX
+ packages out there to do all sorts of things,
+ from labels to envelopes to fancy multipage tables.
Check out
\begin_inset CommandInset href
LatexCommand href
\begin_layout Standard
If you do need to do some wild and fancy things within your document, be
- sure to check out a good LaTeX book for assistance.
+ sure to check out a good \SpecialChar LaTeX
+ book for assistance.
There are a number of them listed in the bibliography of the
\emph on
User's Guide
\end_layout
\begin_layout Section
-LyX and the LaTeX Preamble
+\SpecialChar LyX
+ and the \SpecialChar LaTeX
+ Preamble
\end_layout
\begin_layout Subsection
-About the LaTeX Preamble
+About the \SpecialChar LaTeX
+ Preamble
\end_layout
\begin_layout Standard
-If you already know LaTeX, there is no need to explain here what the preamble
+If you already know \SpecialChar 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
- that you consult a LaTeX book for further information.
+ that you consult a \SpecialChar 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
+ you can do and what you don't need to do in the \SpecialChar LaTeX
+ preamble of a \SpecialChar LyX
document.
\end_layout
\begin_layout Standard
-The LaTeX preamble comes at the very beginning of a document,
+The \SpecialChar LaTeX
+ preamble comes at the very beginning of a document,
\emph on
before
\emph default
\begin_inset Newline newline
\end_inset
-LyX already does this for you.
- If you're a seasoned LaTeX-nician, and you have a custom document class
- you want to use, check out the
+\SpecialChar LyX
+ already does this for you.
+ If you're a seasoned \SpecialChar LaTeX
+-nician, and you have a custom document class you
+ want to use, check out the
\emph on
Customization Manual
\emph default
- for information on how to make LyX interface to it.
+ for information on how to make \SpecialChar LyX
+ interface to it.
\end_layout
\begin_layout Itemize
\begin_inset Newline newline
\end_inset
-LaTeX packages provide special commands, which are only available within
- a document when the package has been declared in the preamble.
+\SpecialChar LaTeX
+ packages provide special commands, which are only available within a document
+ when the package has been declared in the preamble.
In addition to providing special commands, the inclusion of a package can
change the document.
For example, the package
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables that
+There are several \SpecialChar LaTeX
+ counters and variables that
\emph on
must
\emph default
\begin_inset Newline newline
\end_inset
-These are abbreviations for LaTeX commands which appear very often inside
- a document.
+These are abbreviations for \SpecialChar LaTeX
+ commands which appear very often inside a document.
Although the preamble is a good place to declare such commands, they
\emph on
can
\emph default
be declared anywhere (before they are used for the first time, of course).
- This can be useful if there is a lot of raw LaTeX code in your document,
- which normally should not be the case.
+ This can be useful if there is a lot of raw \SpecialChar LaTeX
+ code in your document, which
+ normally should not be the case.
\end_layout
\begin_layout Standard
-LyX adds its own set of definitions to the preamble of the
+\SpecialChar LyX
+ adds its own set of definitions to the preamble of the
\begin_inset Flex Code
status collapsed
\end_inset
file it produces.
- This makes LaTeX files generated by LyX portable.
+ This makes \SpecialChar LaTeX
+ files generated by \SpecialChar LyX
+ portable.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-The commands which LyX adds to the preamble of a LaTeX file are fixed; you
- can't change them without patching LyX itself.
+The commands which \SpecialChar LyX
+ adds to the preamble of a \SpecialChar LaTeX
+ file are fixed; you can't
+ change them without patching \SpecialChar LyX
+ itself.
You can, however, add your own stuff to the preamble by selecting
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-LaTeX
+\SpecialChar LaTeX
+
\begin_inset space ~
\end_inset
\end_inset
in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
dialog.
- LyX adds anything in the
-\begin_inset Flex MenuItem
+ \SpecialChar LyX
+ adds anything in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
dialog to its own built-in preamble.
Before adding your own declarations in the preamble, you should make sure
- that LyX doesn't already support what you want to do.
+ that \SpecialChar LyX
+ doesn't already support what you want to do.
(Remember what we said about reinventing the wheel?) Also,
\emph on
make sure your preamble code is correct
\emph default
.
- LyX doesn't check it for you.
+ \SpecialChar LyX
+ doesn't check it for you.
If there is an error, you're likely to get an error like
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-There are two variables under LaTeX that control page position:
+There are two variables under \SpecialChar LaTeX
+ that control page position:
\begin_inset Flex Code
status collapsed
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
- your sysadmin is a doofus,
+ If you're using \SpecialChar LyX
+ on a system that you don't personally maintain, and your
+ sysadmin is a doofus,
\begin_inset Flex Code
status collapsed
\begin_layout Standard
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
+ You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
+ code, placing
+ the commands
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-Someday, someone may write a LyX layout file to support this package directly.
+Someday, someone may write a \SpecialChar LyX
+ layout file to support this package directly.
Maybe that someone is you.
\end_layout
\end_layout
\begin_layout Standard
-If your TeX distribution isn't braindead, you'll have this package, and
- all of your paragraphs will get the indentation the Founding Fathers intended
+If your \SpecialChar TeX
+ distribution isn't braindead, you'll have this package, and all
+ of your paragraphs will get the indentation the Founding Fathers intended
they should have.
\end_layout
\end_layout
\begin_layout Section
-LyX and LaTeX Errors
-\end_layout
-
-\begin_layout Standard
-When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
- going.
- It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile, LyX displays a dialog listing the errors.
- Clicking on any one of them will take you to the position in your LyX file
+\SpecialChar LyX
+ and \SpecialChar LaTeX
+ Errors
+\end_layout
+
+\begin_layout Standard
+When \SpecialChar LyX
+ calls \SpecialChar LaTeX
+, it tells \SpecialChar LaTeX
+ to blithely ignore any errors and keep going.
+ It then uses the logfile from the \SpecialChar LaTeX
+ run to do a post-mortem.
+ After analyzing the logfile, \SpecialChar LyX
+ displays a dialog listing the errors.
+ Clicking on any one of them will take you to the position in your \SpecialChar LyX
+ file
where the error occurred.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Well, usually.
- Analyzing the logfile is a tough job, and LyX doesn't always go to the
- right line.
- There are also cases where LaTeX reports the error on one line, but the
- actual error is earlier.
+ Analyzing the logfile is a tough job, and \SpecialChar LyX
+ doesn't always go to the right
+ line.
+ There are also cases where \SpecialChar LaTeX
+ reports the error on one line, but the actual
+ error is earlier.
This is not unlike forgetting a closing brace in a program: You'll get
an error, but only later.
\end_layout
\begin_layout Standard
Some folks also like to look at the log file directly: It is available from
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document
-\bar under
-\SpecialChar \menuseparator
-
-\bar default
+Document\SpecialChar menuseparator
Latex
\begin_inset space ~
\end_inset
.
There are some fairly common error messages and warnings.
We'll cover those here.
- You should look at a good LaTeX book for a complete listing.
+ You should look at a good \SpecialChar LaTeX
+ book for a complete listing.
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-LaTeX Warning
+\SpecialChar LaTeX
+ Warning
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- the LaTeX code itself.
+ the \SpecialChar LaTeX
+ code itself.
You'll get messages like this if you added or changed cross-references
- or bibliography entries, in which case, LaTeX is trying to tell you that
- you need to make another run.
+ or bibliography entries, in which case, \SpecialChar LaTeX
+ is trying to tell you that you
+ need to make another run.
You can by-and-large ignore these.
\end_layout
status collapsed
\begin_layout Plain Layout
-LaTeX Font Warning
+\SpecialChar LaTeX
+ Font Warning
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-Another warning message, this time about fonts which LaTeX couldn't find.
+Another warning message, this time about fonts which \SpecialChar LaTeX
+ couldn't find.
The rest of the message will often say something about a replacement font
- that LaTeX used.
+ that \SpecialChar LaTeX
+ used.
You can safely ignore these, too.
\end_layout
\begin_inset Newline newline
\end_inset
-LaTeX absolutely
+\SpecialChar LaTeX
+ absolutely
\emph on
loves
\emph default
Almost always, this is unnoticeable in the final output.
(It can be just a point or two.) Or, only one or two characters extend past
the margin.
- LaTeX seems to generate at least one of these messages for just about any
- document you write.
+ \SpecialChar LaTeX
+ seems to generate at least one of these messages for just about any document
+ you write.
\begin_inset Newline newline
\end_inset
\begin_layout Plain Layout
You can also enable the `draft' option in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document
-\bar under
-\SpecialChar \menuseparator
-
-\bar default
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
-, and then LaTeX will draw a black box in the margin of lines that are overfull.
+, and then \SpecialChar LaTeX
+ will draw a black box in the margin of lines that are overfull.
\end_layout
\end_inset
\end_inset
Not quite as common as its cousin.
- LaTeX seems to like to print lines that are a bit too wide as opposed to
- ones that are a bit too narrow.
+ \SpecialChar LaTeX
+ seems to like to print lines that are a bit too wide as opposed to ones
+ that are a bit too narrow.
We have no idea why.
\end_layout
status collapsed
\begin_layout Plain Layout
-LaTeX Error: File
+\SpecialChar LaTeX
+ Error: File
\begin_inset Quotes els
\end_inset
\end_inset
- command, then one of the packages LyX tried to load is missing.
+ command, then one of the packages \SpecialChar LyX
+ tried to load is missing.
Use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
+Help\SpecialChar menuseparator
+\SpecialChar LaTeX
+ Configuration
\end_layout
\end_inset
- to get a list of packages that LyX knows about.
- This file is updated whenever you reconfigure LyX (using
-\begin_inset Flex MenuItem
+ to get a list of packages that \SpecialChar LyX
+ knows about.
+ This file is updated whenever you reconfigure \SpecialChar LyX
+ (using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\end_layout
status collapsed
\begin_layout Plain Layout
-LaTeX Error: Unknown option
+\SpecialChar LaTeX
+ Error: Unknown option
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-If you've inserted LaTeX code into your document, but made a typo, you'll
- get one of these.
+If you've inserted \SpecialChar LaTeX
+ code into your document, but made a typo, you'll get
+ one of these.
You may have forgotten to load a package.
In any case, this error message usually means that you used an undefined
command.
\begin_layout Standard
There are other error and warning messages.
Some are self-explanatory.
- These are usually LaTeX messages.
+ These are usually \SpecialChar LaTeX
+ messages.
Others are downright cryptic.
- These are usually TeX error messages, and we really have
+ These are usually \SpecialChar TeX
+ error messages, and we really have
\emph on
no clue
\emph default
\end_layout
\begin_layout Enumerate
-Look at the LaTeX code you inserted for typos.
+Look at the \SpecialChar LaTeX
+ code you inserted for typos.
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Enumerate
-If you didn't add anything to the preamble and didn't add any LaTeX code
- to the document, the first suspect is your LaTeX distribution itself.
+If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
+ code to the
+ document, the first suspect is your \SpecialChar LaTeX
+ distribution itself.
Check for missing packages and install them.
\end_layout
\begin_layout Enumerate
Okay, so there are no missing packages.
- Did you use any of the fine-tuning options in LyX? Specifically, did you
-
+ Did you use any of the fine-tuning options in \SpecialChar LyX
+? Specifically, did you
\emph on
misuse
\emph default
\end_layout
\begin_layout Enumerate
-Do you have long sections of text where LaTeX cannot find a place to break
- a line? By default, LaTeX is rather strict about how much extra inter-word
- spacing it will add in order to break a line.
+Do you have long sections of text where \SpecialChar LaTeX
+ cannot find a place to break a
+ line? By default, \SpecialChar LaTeX
+ is rather strict about how much extra inter-word spacing
+ it will add in order to break a line.
Preferably, you should rework the paragraph to avoid the problem.
- If this isn't an option, you can wrap your text in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-sloppypar
-\end_layout
-
-\end_inset
-
- to make LaTeX's line breaking more, well, sloppy.
\end_layout
\begin_layout Enumerate
-Did you go overboard with the nesting? LyX (currently) doesn't check to
- make sure you're in the limits for nesting environments.
+Did you go overboard with the nesting? \SpecialChar LyX
+ (currently) doesn't check to make
+ sure you're in the limits for nesting environments.
If you nested a bunch of environments to the
\begin_inset Formula $17^{\mathrm{th}}$
\end_inset
level, that's the problem.
- (The limit in LaTeX is five.)
+ (The limit in \SpecialChar LaTeX
+ is five.)
\end_layout
\begin_layout Enumerate
Okay, you didn't get any error messages, but your output looks awful.
If you have a table or figure that's too wide or long for the page, you
need to:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\emph on
perhaps
\emph default
- you might have found a bug in LyX\SpecialChar \ldots{}
+ you might have found a bug in \SpecialChar LyX
+\SpecialChar ldots
.
\end_layout
\end_layout
\begin_layout Section
-Customizing Bibliographies with BibTeX
+Customizing Bibliographies with Bib\SpecialChar TeX
+
\end_layout
\begin_layout Standard
-The most basic information about how to use BibTeX with LyX is contained
- in the section
+The most basic information about how to use Bib\SpecialChar TeX
+ with \SpecialChar LyX
+ is contained in the
+ section
\emph on
-Bibliography databases (BibTeX)
+Bibliography databases (Bib\SpecialChar TeX
+)
\emph default
of the
\emph on
\emph default
.
The following subsections explain special bibliography features supported
- by LyX.
+ by \SpecialChar LyX
+.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-Standard BibTeX uses numbers (e.
+Standard Bib\SpecialChar TeX
+ uses numbers (e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
).
- LyX supports two packages that provide this style,
+ \SpecialChar LyX
+ supports two packages that provide this style,
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The handling of both packages in LyX is basically the same.
+The handling of both packages in \SpecialChar LyX
+ is basically the same.
Go to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
and select under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
.
- Unfortunately, BibTeX itself does not allow you to do this.
- But with the help of some LaTeX packages, BibTeX can be extended to fit
- your needs.
+ Unfortunately, Bib\SpecialChar TeX
+ itself does not allow you to do this.
+ But with the help of some \SpecialChar LaTeX
+ packages, Bib\SpecialChar TeX
+ can be extended to fit your needs.
\end_layout
\begin_layout Standard
-LyX provides native support for one of these packages,
+\SpecialChar LyX
+ provides native support for one of these packages,
\family typewriter
bibtopic
\family default
\begin_layout Standard
Go to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
and check under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
.
- Now you can insert multiple BibTeX bibliographies, one for each section
- of your bibliography.
- Returning to our example: Insert the BibTeX bibliography
+ Now you can insert multiple Bib\SpecialChar TeX
+ bibliographies, one for each section of
+ your bibliography.
+ Returning to our example: Insert the Bib\SpecialChar TeX
+ bibliography
\begin_inset Flex Code
status collapsed
\end_inset
a bibliography for each section or chapter of the document, are not supported
- by BibTeX itself.
+ by Bib\SpecialChar TeX
+ itself.
But the
\begin_inset Flex Code
status collapsed
\end_inset
package, which is used for the creation of sectioned bibliographies in
- LyX (see the previous section), provides an easy way to solve this task,
- if you are willing to use some
-\begin_inset Flex MenuItem
+ \SpecialChar LyX
+ (see the previous section), provides an easy way to solve this task, if
+ you are willing to use some
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-TeX Code
+\SpecialChar TeX
+ Code
\end_layout
\end_inset
\begin_layout Standard
First go to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
and under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
check
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
In the document, you have to enclose the sections, which shall contain
- their own bibliography (including the BibTeX bibliography itself), between
+ their own bibliography (including the Bib\SpecialChar TeX
+ bibliography itself), between
\begin_inset Flex Code
status collapsed
\end_inset
- (those commands have to be inserted as TeX code).
+ (those commands have to be inserted as \SpecialChar TeX
+ code).
The bibliography will contain all references that have been cited in the
current
\begin_inset Flex Code
In these cases, you should seriously consider using multipart documents.
For example, scientific papers often have five major sections: the introduction
, observations, results, discussion, and conclusion.
- Each of these could be its own separate LyX file, with one
+ Each of these could be its own separate \SpecialChar LyX
+ file, with one
\begin_inset Quotes eld
\end_inset
file which contains the title, authors, abstract, references, etc., plus
the five included files.
- It is important to note that each of these files is a full LyX file which
+ It is important to note that each of these files is a full \SpecialChar LyX
+ file which
can be formatted and printed on its own, as well as included in a master
file.
Each of these files must have the same document class, however—don't attempt
to mix book classes with article classes.
- You may also include LaTeX files; however, these files must not have their
- own preamble (i.
+ You may also include \SpecialChar LaTeX
+ files; however, these files must not have their own
+ preamble (i.
\begin_inset space \thinspace{}
\end_inset
\end_layout
\begin_layout Standard
-LyX allows you to include files quite easily with
-\begin_inset Flex MenuItem
+\SpecialChar LyX
+ allows you to include files quite easily with
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
ChiId
\begin_inset space ~
\end_inset
\begin_inset Quotes erd
\end_inset
- is really only meaningful to LaTeXperts, but the practical difference is
- that files that are
+ is really only meaningful to \SpecialChar LaTeX
+perts, but the practical difference is that
+ files that are
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files that do not have
- all the preamble information.
+Generally, the master file is converted into a full \SpecialChar LaTeX
+ file before typesetting,
+ while the included files are converted to \SpecialChar LaTeX
+ files that do not have all the
+ preamble information.
\end_layout
\begin_layout Standard
mode, with the characters set in a fixed-width typewriter font.
Normally, spaces in this file are invisible, though two consecutive spaces
- are conserved, unlike LyX's normal treatment of spaces.
+ are conserved, unlike \SpecialChar LyX
+'s normal treatment of spaces.
However, setting the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
special "none"
height "1in"
height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
status open
\begin_layout Plain Layout
special "none"
height "1in"
height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
status open
\begin_layout Plain Layout
\begin_layout Standard
Copy the bibliography list with all entries to all subdocuments and transform
them to a comment.
- This way LyX will find the
+ This way \SpecialChar LyX
+ will find the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-As the bibliography list is in a comment, LaTeX won't use it and the references
+As the bibliography list is in a comment, \SpecialChar LaTeX
+ won't use it and the references
will look like this: [?], instead of like this: [1].
- One solution is to use the LaTeX-package
+ One solution is to use the \SpecialChar LaTeX
+-package
\begin_inset Flex Code
status collapsed
\end_inset
that will only include comments by processing the files separately.
- To do this, add in the LaTeX preamble of every subdocument the following:
+ To do this, add in the \SpecialChar LaTeX
+ preamble of every subdocument the following:
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Section
-LyX Archives
+\SpecialChar LyX
+ Archives
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- a LyX file together with all the images (and other files) on which it depends,
+ a \SpecialChar LyX
+ file together with all the images (and other files) on which it depends,
either for sending to a publisher or for sharing with a co-author.
- LyX 2.0 includes a Python script (
+ \SpecialChar LyX
+ 2.0 includes a Python script (
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-LyX's configuration process will set the script up to export a `LyX Archive',
+\SpecialChar LyX
+'s configuration process will set the script up to export a `\SpecialChar LyX
+ Archive',
and this format will then be available under
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Export
\end_layout
status collapsed
\begin_layout Plain Layout
-LyX\SpecialChar \menuseparator
-LyX Archive
+\SpecialChar LyX
+\SpecialChar menuseparator
+\SpecialChar LyX
+ Archive
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
Converters
\end_layout
User Guide
\emph default
.
- This section describes the LaTeX code you need to insert in your LaTeX
- preamble in order to get the desired effects.
+ This section describes the \SpecialChar LaTeX
+ code you need to insert in your \SpecialChar LaTeX
+ preamble in
+ order to get the desired effects.
\end_layout
\begin_layout Standard
.
The footer is also divided into these three fields.
- The LaTeX commands to set these fields in the simplest manner are
+ The \SpecialChar LaTeX
+ commands to set these fields in the simplest manner are
\begin_inset Flex Code
status collapsed
\end_inset
- access LaTeX's section and page counters, and so print out the current
- section and page numbers.
+ access \SpecialChar LaTeX
+'s section and page counters, and so print out the current section
+ and page numbers.
\begin_inset Flex Code
status collapsed
.
Simply insert them in the text on the page you want changed and mark them
- as TeX code.
+ as \SpecialChar TeX
+ code.
In fact, title pages are marked as plain by default, while following pages
are marked fancy when using the global fancy setting.
\end_layout
\end_layout
\begin_layout Standard
-LyX provides 216 bullet shapes that can be accessed from a simple dialog.
+\SpecialChar LyX
+ provides 216 bullet shapes that can be accessed from a simple dialog.
Using this dialog you can easily specify what bullet shape to use at each
level of an itemized list.
These settings are document-wide so you won't be able to specify different
\begin_layout Standard
Open the dialog by selecting the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
menu item and then select the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
The row of buttons across the top is used to select which bullet depth
you are changing.
A text entry under the table shows the currently selected bullet shape's
- LaTeX equivalent and this can be edited if desired.
+ \SpecialChar LaTeX
+ equivalent and this can be edited if desired.
If you do modify the text you will also need to specify any needed packages
- in the LaTeX preamble.
+ in the \SpecialChar LaTeX
+ preamble.
\end_layout
\begin_layout Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX package.
+ The following table shows the mappings from button name to \SpecialChar LaTeX
+ package.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_layout Standard
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
-<features rotate="0" tabularvalignment="middle">
+<features tabularvalignment="middle">
<column alignment="center" valignment="top" width="0pt">
<column alignment="center" valignment="top" width="0pt">
<row>
\bar no
\noun off
\color none
-base LaTeX
+base \SpecialChar LaTeX
+
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-LyX doesn't stop you using bullets from packages you don't have.
- If you get errors from LaTeX when you try to view or print the file, then
- it is likely you are missing a package.
+\SpecialChar LyX
+ doesn't stop you using bullets from packages you don't have.
+ If you get errors from \SpecialChar LaTeX
+ when you try to view or print the file, then it
+ is likely you are missing a package.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-LyX doesn't restrict your use since you may be editing locally and exporting
+\SpecialChar LyX
+ doesn't restrict your use since you may be editing locally and exporting
elsewhere.
\end_layout
\begin_layout Standard
Select which bullet depth you want to change then select the bullet shape
and size.
- Any changes will not be visible in LyX, but are visible when viewing the
- document.
+ Any changes will not be visible in \SpecialChar LyX
+, but are visible when viewing the document.
\end_layout
\begin_layout Standard
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 TeX code.
+ in each, then you're going to have to get your hands dirty with \SpecialChar TeX
+ code.
The bullet selection dialog can help though because it provides you with
- the LaTeX code for a wide range of bullet shapes.
+ the \SpecialChar LaTeX
+ code for a wide range of bullet shapes.
To make your own custom paragraphs you have the following options:
\end_layout
\end_layout
\begin_layout Itemize
-Use the LaTeX command
+Use the \SpecialChar LaTeX
+ command
\begin_inset Flex Code
status collapsed
to specify a new bullet shape for a given depth.
You'll also need to save the current bullet shape so you can restore it
again afterwards.
- In this itemized list the following LaTeX code was used to change the bullet
+ In this itemized list the following \SpecialChar LaTeX
+ code was used to change the bullet
used for the first depth.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-TeX Code
+\SpecialChar TeX
+ Code
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
-LyX and the World Wide Web
+\SpecialChar LyX
+ and the World Wide Web
\end_layout
\begin_layout Standard
-LyX has long supported the export of documents to various web-friendly formats,
+\SpecialChar LyX
+ has long supported the export of documents to various web-friendly formats,
such as HTML.
Before verson 2.0, however, HTML export was always accomplished by the use
of external converters.
status collapsed
\begin_layout Plain Layout
-For details on the use of external converters with LyX, see the
+For details on the use of external converters with \SpecialChar LyX
+, see the
\emph on
Converters
\emph default
\end_inset
- These fall into two large groups: there are converters that use LaTeX as
- an intermediate format, such as
+ These fall into two large groups: there are converters that use \SpecialChar LaTeX
+ as an
+ intermediate format, such as
\begin_inset Flex Code
status collapsed
\end_inset
-, relying upon LyX to produce the LaTeX; and there is a converter that works
- directly on LyX files,
+, relying upon \SpecialChar LyX
+ to produce the \SpecialChar LaTeX
+; and there is a converter that works directly
+ on \SpecialChar LyX
+ files,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-eLyXer
+e\SpecialChar LyX
+er
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-The LaTeX-based converters have the advantage that, in principle, they know
- everything about the exported document that LaTeX does.
+The \SpecialChar LaTeX
+-based converters have the advantage that, in principle, they know everythin
+g about the exported document that \SpecialChar LaTeX
+ does.
Such converters do not care, for example, if a certain block of code was
- produced by LyX or was Evil Red Text.
+ produced by \SpecialChar LyX
+ or was Evil Red Text.
These converters know about
\begin_inset Flex Code
status collapsed
\end_inset
- files generated by BibTeX.
- On the other hand, LaTeX is a very hard language to parse---it is sometimes
- said that only TeX itself understands TeX---and LaTeX-based converters
- will often choke on what seem to be quite simple constructs; complex ones
- can throw them completely, and as of this writing, for example, the
+ files generated by Bib\SpecialChar TeX
+.
+ On the other hand, \SpecialChar LaTeX
+ is a very hard language to parse—it is sometimes said
+ that only \SpecialChar TeX
+ itself understands \SpecialChar TeX
+—and \SpecialChar LaTeX
+-based converters will often choke on
+ what seem to be quite simple constructs; complex ones can throw them completely
+, and as of this writing, for example, the
\emph on
Embedded Objects
\emph default
The other issue concerns how math is handled.
These converters typically convert the formulae into little pictures that
are then linked from the HTML document.
- Since these are actually generated by LaTeX, they are accurate.
+ Since these are actually generated by \SpecialChar LaTeX
+, they are accurate.
But they do not scale well, and just getting them to look as if they are
- actually meant to be in your document---so that the font sizes seem to
- be roughly the same---can be a challenge.
+ actually meant to be in your document—so that the font sizes seem to be
+ roughly the same—can be a challenge.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-eLyXer
+e\SpecialChar LyX
+er
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-eLyXer
+e\SpecialChar LyX
+er
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-eLyXer
+e\SpecialChar LyX
+er
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-eLyXer
+e\SpecialChar LyX
+er
\end_layout
\end_inset
- unsuitable for many of the documents LyX users produce.
- In principle, of course, these problems could be solved, but the LyX developers
- have decided to follow a different path and have made LyX itself capable
- of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
- plaintext.
+ unsuitable for many of the documents \SpecialChar LyX
+ users produce.
+ In principle, of course, these problems could be solved, but the \SpecialChar LyX
+ developers
+ have decided to follow a different path and have made \SpecialChar LyX
+ itself capable of
+ writing XHTML, just as it is capable of writing \SpecialChar LaTeX
+, DocBook, and plaintext.
\end_layout
\begin_layout Standard
\end_inset
-, which can be found in the LyX source tree or
+, which can be found in the \SpecialChar LyX
+ source tree or
\begin_inset CommandInset href
LatexCommand href
name "accessed online"
\begin_layout Standard
These advantages are primarily due to the fact that the XHTML output routines,
- since they are part of LyX, know everything LyX knows about the document
- being exported.
+ since they are part of \SpecialChar LyX
+, know everything \SpecialChar LyX
+ knows about the document being
+ exported.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Another advantage is that, since these routines are internal to LyX, they
- are immune to changes in LyX's file format, or to changes in the semantics
- of existing insets.
+Another advantage is that, since these routines are internal to \SpecialChar LyX
+, they are
+ immune to changes in \SpecialChar LyX
+'s file format, or to changes in the semantics of
+ existing insets.
\end_layout
\end_inset
So they know about the table of contents (as displayed in the outline),
about the counters associated with different paragraph styles, and about
user-defined styles.
- The XHTML output routines know what LyX knows about internationalization,
+ The XHTML output routines know what \SpecialChar LyX
+ knows about internationalization,
too, so they will output
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Quite generally, the output routines know what LyX knows about document
- layout, that is, about how the document is to be rendered on screen.
+Quite generally, the output routines know what \SpecialChar LyX
+ knows about document layout,
+ that is, about how the document is to be rendered on screen.
We use this information when we output the document as XHTML.
- In particular, LyX
+ In particular, \SpecialChar LyX
+
\emph on
automatically
\emph default
generates CSS style information corresponding to the layout information
it uses to render the document on screen: if section headings are supposed
- to be sans-serif and bold as seen in LyX, then (by default) they will be
- sans-serif and bold when viewed in a web browser, too.
+ to be sans-serif and bold as seen in \SpecialChar LyX
+, then (by default) they will be sans-seri
+f and bold when viewed in a web browser, too.
And this is true not just for pre-defined styles, like Section, but for
any style, including user-defined styles.
Indeed, the XHTML output routines make no distinction between user-defined
- paragraph and character styles and LyX's own pre-defined styles: in each
- case, everything LyX knows about the styles is contained in the layout
- files.
+ paragraph and character styles and \SpecialChar LyX
+'s own pre-defined styles: in each case,
+ everything \SpecialChar LyX
+ knows about the styles is contained in the layout files.
And much the same is true as regards pre-defined textual insets, such as
footnotes, and various custom insets.
\begin_layout Standard
The result is that XHTML output can be customized and extended in exactly
- the same way LaTeX output can be customized and extended: through layout
- files and modules.
+ the same way \SpecialChar LaTeX
+ output can be customized and extended: through layout files
+ and modules.
See chapter five of the
\emph on
Customization
\end_layout
\begin_layout Standard
-LyX offers four choices for how math is rendered.
+\SpecialChar LyX
+ offers four choices for how math is rendered.
These have various advantages and disadvantages:
\end_layout
\begin_inset Newline newline
\end_inset
-If LyX is unable to render a formula as MathML---for example, if the formula
+If \SpecialChar LyX
+ is unable to render a formula as MathML—for example, if the formula
uses the
\begin_inset Flex Code
status collapsed
\end_inset
- package or ERT---then it will instead output the formula as an image.
+ package or ERT—then it will instead output the formula as an image.
\end_layout
status collapsed
\begin_layout Plain Layout
-LyX has borrowed some of the CSS for its HTML output from
+\SpecialChar LyX
+ has borrowed some of the CSS for its HTML output from
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-If Lyx is unable to render a formula as HTML---for example, if the formula
+If Lyx is unable to render a formula as HTML—for example, if the formula
uses the
\begin_inset Flex Code
status collapsed
\end_inset
- package or ERT---then it will instead output the formula as an image.
+ package or ERT—then it will instead output the formula as an image.
\end_layout
\end_inset
-, LyX will output formulae as images, the very same images, in fact, that
- are used for instant preview.
+, \SpecialChar LyX
+ will output formulae as images, the very same images, in fact, that are
+ used for instant preview.
\begin_inset Foot
status collapsed
\end_inset
The advantage to this method is that the images are simply generated by
- LaTeX, so they are very accurate.
+ \SpecialChar LaTeX
+, so they are very accurate.
The disadvantage, as mentioned earlier, is that these are bitmapped images,
so they do not scale terribly well, and one cannot copy them, etc.
(As of this writing, there are also problems about equation numbering.
\end_inset
parameter under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Output
\end_layout
\begin_inset Newline newline
\end_inset
-If LyX for some reason fails to create an image for a formula (e.g., if a
- required LaTeX package is not installed), then it will fall back to outputing
- the raw LaTeX.
+If \SpecialChar LyX
+ for some reason fails to create an image for a formula (e.g., if a required
+ \SpecialChar LaTeX
+ package is not installed), then it will fall back to outputing the raw
+ \SpecialChar LaTeX
+.
\end_layout
\begin_layout Itemize
-LaTeX
+\SpecialChar LaTeX
+
\begin_inset Newline newline
\end_inset
-Finally, LyX will happily output math as LaTeX.
+Finally, \SpecialChar LyX
+ will happily output math as \SpecialChar LaTeX
+.
As well as being the output of last resort, this method can be used with
such tools as
\begin_inset CommandInset href
\end_inset
-, which uses JavaScript to render LaTeX embedded in HTML documents.
- LyX wraps the LaTeX in either a
+, which uses JavaScript to render \SpecialChar LaTeX
+ embedded in HTML documents.
+ \SpecialChar LyX
+ wraps the \SpecialChar LaTeX
+ in either a
\begin_inset Flex Code
status collapsed
\begin_layout Standard
One of these output methods must be selected under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Output
\end_layout
\end_inset
.
- By default, LyX outputs MathML.
+ By default, \SpecialChar LyX
+ outputs MathML.
This is a document-wide setting, therefore.
\end_layout
\begin_layout Standard
-Eventually, LyX will offer the user the option to select an alternate output
+Eventually, \SpecialChar LyX
+ will offer the user the option to select an alternate output
method for a particular inset, say, one that isn't being rendered very
well by MathML.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-That said, since LyX falls back to images if the inset contains ERT, then
- one can force output as an image by putting some harmless ERT into the
- math, for example:
+That said, since \SpecialChar LyX
+ falls back to images if the inset contains ERT, then one
+ can force output as an image by putting some harmless ERT into the math,
+ for example:
\begin_inset Formula $a=b\relax$
\end_inset
\end_layout
\begin_layout Standard
-Citation labels are generated by the same machinery that generates LyX's
- on-screen labels, so the labels will look in the output much as they do
- in LyX, though better.
- If you are using numerical citations, then LyX will output numerical labels,
+Citation labels are generated by the same machinery that generates \SpecialChar LyX
+'s on-screen
+ labels, so the labels will look in the output much as they do in \SpecialChar LyX
+, though
+ better.
+ If you are using numerical citations, then \SpecialChar LyX
+ will output numerical labels,
such as [1] or [17], rather than simply showing the citation key in square
brackets, as it does on-screen.
- If you are using author-year citations, then LyX will add lowercase letters
- to the years, just as BibTeX does, if it finds more than one citation for
+ If you are using author-year citations, then \SpecialChar LyX
+ will add lowercase letters
+ to the years, just as Bib\SpecialChar TeX
+ does, if it finds more than one citation for
a given author-year combination.
The labels will be printed with the bibliography entries.
Note that there is, at present, no way to customize the appearance of the
Language in Context: Selected Essays
\emph default
(Oxford: Oxford University Press, 2007), pp.
- 30--68.
+ 30–68.
\end_layout
\begin_layout Quote
Language in Context: Selected Essays
\emph default
(Oxford: Oxford University Press, 2007), pp.
- 201--30.
+ 201–30.
\end_layout
\begin_layout Standard
\begin_layout Standard
There is no support at present for sectioned bibliographies.
- If you have multiple bibliographies, then LyX will print the same bibliography
+ If you have multiple bibliographies, then \SpecialChar LyX
+ will print the same bibliography
over and over.
\end_layout
\end_layout
\begin_layout Standard
-LyX will happily export indexes as XHTML, but with certain limitations at
- the moment.
+\SpecialChar LyX
+ will happily export indexes as XHTML, but with certain limitations at the
+ moment.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-The main issue here is that LyX itself does not really handle these.
- It just lets you enter what you would have to enter in raw LaTeX.
+The main issue here is that \SpecialChar LyX
+ itself does not really handle these.
+ It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
+.
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
- these, but the entries must be separated by
+Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
+ makes an effort to support these,
+ but the entries must be separated by
\begin_inset Quotes eld
\end_inset
\begin_layout Itemize
Cross-referencing: There is no support for cross-referencing.
- If LyX finds an entry containing the
+ If \SpecialChar LyX
+ finds an entry containing the
\begin_inset Quotes eld
\end_inset
-|see\SpecialChar \ldots{}
+|see\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Itemize
-Index Entry Order: LyX does support attempts to fix the sorting order.
+Index Entry Order: \SpecialChar LyX
+ does support attempts to fix the sorting order.
It will take what is before the first `@' it finds and use that for sorting,
taking what follows the first `@' to be the actual entry.
- At present, LyX does not check for escaped `@', so do not try to index
- email addresses.
+ At present, \SpecialChar LyX
+ does not check for escaped `@', so do not try to index email
+ addresses.
\end_layout
\begin_layout Itemize
Index Entry Layout: You can format entries by using the text style dialog,
- or by using any other method available within LyX itself.
+ or by using any other method available within \SpecialChar LyX
+ itself.
There is no support for constructs like:
\begin_inset Quotes eld
\end_inset
\end_inset
.
- Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
- and everything that follows it.
+ Indeed, if \SpecialChar LyX
+ finds a pipe symbol, `|', in an entry, it will delete it and
+ everything that follows it.
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Chapter
-The LyX Server
+The \SpecialChar LyX
+ Server
\end_layout
\begin_layout Section
\end_layout
\begin_layout Standard
-The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
- and retrieve information about the LyX internal state.
+The `\SpecialChar LyX
+ server' allows other programs to talk to \SpecialChar LyX
+, invoke \SpecialChar LyX
+ commands, and retrieve
+ information about the \SpecialChar LyX
+ internal state.
This is only intended for advanced users, but they should find it useful.
- It is by writing to the LyX server, for example, that bibliography managers,
+ It is by writing to the \SpecialChar LyX
+ server, for example, that bibliography managers,
such as JabRef, are able to
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- citations to LyX.
+ citations to \SpecialChar LyX
+.
\end_layout
\begin_layout Section
-Starting the LyX Server
+Starting the \SpecialChar LyX
+ Server
\end_layout
\begin_layout Standard
-The LyX server works through the use of a pair of named pipes.
+The \SpecialChar LyX
+ server works through the use of a pair of named pipes.
These are usually located in
\begin_inset Flex Code
status collapsed
.
The stem of the pipe names can be defined in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\end_layout
\end_inset
- on Windows (but any working path can be used).
+ on Windows (where any working path instead of lyxpipe can be used, for
+ example
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+"
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+my
+\backslash
+lyx
+\backslash
+pipe"
+\end_layout
+
+\end_inset
+
+ would also work).
You
\emph on
must
\end_layout
\begin_layout Standard
-LyX will add the '
+\SpecialChar LyX
+ will add the '
\begin_inset Flex Code
status collapsed
\end_inset
' to create the pipes.
- If one of the pipes already exists, LyX will assume that another LyX process
+ If one of the pipes already exists, \SpecialChar LyX
+ will assume that another \SpecialChar LyX
+ process
is already running and will not start the server.
On POSIX (Unix like) systems, if for some other reason, an unused
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
- pipe is left in existence when LyX closes, then LyX will try to delete
- it.
+ pipe is left in existence when \SpecialChar LyX
+ closes, then \SpecialChar LyX
+ will try to delete it.
If this fails for some reason, you will need to delete the pipes manually
- and then restart LyX.
+ and then restart \SpecialChar LyX
+.
On Windows, pipes are deleted by the OS on program termination or crash,
so
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-To have several LyX processes with servers at the same time, you have to
- use different configurations, perhaps by using separate user directories,
- each with its own
+To have several \SpecialChar LyX
+ processes with servers at the same time, you have to use
+ different configurations, perhaps by using separate user directories, each
+ with its own
\begin_inset Flex Code
status collapsed
\begin_layout Standard
If you are developing a client program, you might find it useful to enable
- debugging information from the LyX server.
- Do this by starting LyX as
+ debugging information from the \SpecialChar LyX
+ server.
+ Do this by starting \SpecialChar LyX
+ as
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-You can find a complete example client written in C in the source distribution
+You can find a complete example client written in C++ in the source distribution
as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/lyxserver/server_monitor.c
+development/lyxserver/server_monitor.cpp
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-Another useful tool is the command-line based clientfound in
+Another useful tool is the command-line based client found in
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-To issue a LyX call, the client writes a line of ASCII text into the input
+To issue a \SpecialChar LyX
+ call, the client writes a line of ASCII text into the input
pipe.
This line has the following format:
\end_layout
\begin_layout 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
- can dispatch results from different requesters.
+ Its only use is that \SpecialChar LyX
+ will echo it if it sends an answer—so a client can
+ dispatch results from different requesters.
\end_layout
\begin_layout Description
-function is the function you want LyX to perform.
+function is the function you want \SpecialChar LyX
+ to perform.
It is the same as the commands you'd use in the minibuffer.
\end_layout
\end_layout
\begin_layout Standard
-The answer from LyX will arrive in the output pipe and be of the form
+The answer from \SpecialChar LyX
+ will arrive in the output pipe and be of the form
\end_layout
\begin_layout Quote
\begin_inset Quotes erd
\end_inset
-, will return information about the internal state of LyX, while other will
+, will return information about the internal state of \SpecialChar LyX
+, while other will
return an empty data-response.
This means that the command execution went fine.
\end_layout
\begin_layout Standard
-In case of errors, the response from LyX will have this form
+In case of errors, the response from \SpecialChar LyX
+ will have this form
\end_layout
\begin_layout Quote
echo $a
\end_layout
+\begin_layout Subsection
+AppleScript (Mac OS X)
+\end_layout
+
+\begin_layout Standard
+Since \SpecialChar LyX
+ 2.1, \SpecialChar LyX
+ supports basic interactions with AppleScript for normal communicatio
+n through the command run.
+ This command takes a direct argument (the
+\series bold
+function
+\series default
+ to perform) and an optional argument.
+ It either returns the output of the function or triggers an error with
+ the error message and code.
+\end_layout
+
+\begin_layout Standard
+Example:
+\end_layout
+
+\begin_layout LyX-Code
+tell application "\SpecialChar LyX
+"
+\end_layout
+
+\begin_layout LyX-Code
+ try
+\end_layout
+
+\begin_layout LyX-Code
+ -- Stores the current file name into f
+\end_layout
+
+\begin_layout LyX-Code
+ set f to (run "server-get-filename" with argument "")
+\end_layout
+
+\begin_layout LyX-Code
+ on error the error_message number the error_number
+\end_layout
+
+\begin_layout LyX-Code
+ display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
+
+\begin_layout LyX-Code
+ & the error_message buttons {"OK"} default button 1
+\end_layout
+
+\begin_layout LyX-Code
+ end try
+\end_layout
+
+\begin_layout LyX-Code
+end tell
+\end_layout
+
\begin_layout Section
Notification
\end_layout
\begin_layout Standard
-LyX can notify clients of events going on asynchronously.
+\SpecialChar LyX
+ can notify clients of events going on asynchronously.
Currently it will only do this if the user binds a key sequence with the
function
\begin_inset Quotes eld
\end_inset
.
- The format of the string LyX sends is as follows:
+ The format of the string \SpecialChar LyX
+ sends is as follows:
\end_layout
\begin_layout Quote
\end_layout
\begin_layout Standard
-This mechanism can be used to extend LyX's command set and implement macros.
+This mechanism can be used to extend \SpecialChar LyX
+'s command set and implement macros.
Bind some key sequence to
\begin_inset Quotes eld
\end_inset
.
Then start a client that listens on the output pipe, dispatches the command
- according to the sequence, and starts a function that may use LyX calls
- and LyX requests to issue a command or a series of commands to LyX.
+ according to the sequence, and starts a function that may use \SpecialChar LyX
+ calls and
+ \SpecialChar LyX
+ requests to issue a command or a series of commands to \SpecialChar LyX
+.
\end_layout
\begin_layout Section
-The simple LyX Server Protocol
+The simple \SpecialChar LyX
+ Server Protocol
\end_layout
\begin_layout Standard
-LyX implements a simple protocol that can be used for session management.
+\SpecialChar LyX
+ implements a simple protocol that can be used for session management.
All messages are of the form
\end_layout
\begin_inset Quotes erd
\end_inset
- is received from a client, LyX will report back to inform the client that
+ is received from a client, \SpecialChar LyX
+ will report back to inform the client that
it's listening to it's messages, while
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- sent from LyX will inform clients that LyX is closing.
+ sent from \SpecialChar LyX
+ will inform clients that \SpecialChar LyX
+ is closing.
\end_layout
\begin_layout Section
\begin_layout Plain Layout
The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Skim on Mac OSX and SumatraPDF on Windows.
+ Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
\end_inset
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 (
+ This means that you can tell \SpecialChar LyX
+ to put the cursor to a specific line in the
+ document by clicking at the respective position in the DVI/PDF output.
+ To achieve this, the viewer must be able to communicate with \SpecialChar LyX
+.
+ This is done via the \SpecialChar LyX
+ server either by using the named pipe (
\emph on
lyxpipe
\emph default
\emph on
lyxsocket
\emph default
-) that LyX creates in its temporary directory (this is the way the
+) that \SpecialChar LyX
+ creates in its temporary directory (this is the way the
\begin_inset Flex Code
status collapsed
\end_inset
- program communicates with LyX).
+ program communicates with \SpecialChar 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.
+ and \SpecialChar LyX
+, in others, the viewer can communicate with \SpecialChar LyX
+ directly.
This depends on the selected viewer and on your operating system.
The same applies to the way viewers need to be configured and the way the
reverse search is actually performed.
Automatic setup
\begin_inset CommandInset label
LatexCommand label
-name "sub:rev-search"
+name "subsec:rev-search"
\end_inset
\end_layout
\begin_layout Standard
-In most cases LyX will do the work for you by enabling the option
-\begin_inset Flex MenuItem
+In most cases \SpecialChar LyX
+ will do the work for you by enabling the option
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
in the menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Output
\end_layout
\end_inset
.
- In such a case LyX will automatically insert the necessary SyncTeX macro
- (for PDF) or load the srcltx package (for DVI) respectively.
+ In such a case \SpecialChar LyX
+ will automatically insert the necessary Sync\SpecialChar TeX
+ macro (for
+ PDF) or load the srcltx package (for DVI) respectively.
This option can be easily reached also on
\begin_inset Flex Code
status collapsed
\begin_layout Standard
If you need a different setting, you can select or input a custom macro
from the drop down box just below
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
-Output\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Output\SpecialChar menuseparator
Synchronize with Output
\end_layout
\end_layout
\begin_layout Standard
-Please aöso note that including the
+Please also note that including the
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:configuring-viewers"
+reference "subsec:configuring-viewers"
\end_inset
-, where the necessary configuration steps in your viewer -- needed both
- with the automatic and the manual setup -- are described.
+, where the necessary configuration steps in your viewer – needed both with
+ the automatic and the manual setup – are described.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-LaTeX provides several different methods for reverse search.
+\SpecialChar LaTeX
+ provides several different methods for reverse search.
Some are built-in in the
\begin_inset Flex Code
status collapsed
\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.
+ Your choice depends on whether your \SpecialChar LaTeX
+ distribution already provides a given
+ method (the built-in methods are rather new) and whether your viewer can
+ cope with it.
The available methods are described in the following.
\end_layout
\begin_layout Standard
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.
+ It is available in \SpecialChar LaTeX
+ since quite some time (any somewhat recent \SpecialChar LaTeX
+ distribution
+ should include it), and it works reliably.
To enable it, change the
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX (plain)->DVI
+La
+\family sans
+TeX
+\family default
+ (plain)->DVI
\end_layout
\end_inset
or
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX (plain)->DraftDVI
+La
+\family sans
+TeX
+\family default
+ (plain)->DraftDVI
\end_layout
\end_inset
converter in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
Converters
\end_layout
\end_inset
.
- If this doesn't work, check if your TeX engine needs different options
- (the syntax might differ in some distributions).
+ If this doesn't work, check if your \SpecialChar TeX
+ engine needs different options (the
+ syntax might differ in some distributions).
\end_layout
\begin_layout Subsubsection*
\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:
+ In order to enable it, load the packages in the \SpecialChar LyX
+ preamble:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Subsubsection*
-Built-in reverse search via SyncTeX (DVI and PDF)
+Built-in reverse search via Sync\SpecialChar TeX
+ (DVI and PDF)
\end_layout
\begin_layout Standard
have built-in support for both PDF and DVI reverse search.
This so-called
\emph on
-SyncTeX
+Sync\SpecialChar TeX
+
\emph default
facility is basically the result of the integration of the PDFSync package
to the pdftex program and its merge with the
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
-
-\begin_layout Standard
-To enable SyncTeX for DVI output, change the
-\begin_inset Flex MenuItem
+ You need at least \SpecialChar TeX
+Live 2008 or a recent Mik\SpecialChar TeX
+ distribution in order to use
+ it.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-LaT
-\begin_inset ERT
-status collapsed
+For some reason, Mik\SpecialChar TeX
+ does not understand/obey the command \SpecialChar LyX
+ inserts into
+ the preamble when you check the "Enable Forward/Reverse Search" button
+ in the toolbar and does not generate the necessary info.
+\end_layout
\begin_layout Plain Layout
-
-{}
+The generation of the required info can be forced by changing the converter
+ "\SpecialChar LaTeX
+ (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
+ from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
+ the -synctex=1 switch).
\end_layout
\end_inset
-eX (plain) -> DVI
+ Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
+ on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
+ support.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_layout Standard
+To enable Sync\SpecialChar TeX
+ for DVI output, change the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-{}
+La
+\family sans
+TeX
+\family default
+ (plain) -> DVI
\end_layout
\end_inset
-eX (plain) -> DraftDVI
+ or
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+La
+\family sans
+TeX
+\family default
+ (plain) -> DraftDVI
\end_layout
\end_inset
converter in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
Converters
\end_layout
\end_inset
, and for PDF output, change the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-LaT
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX (pdflatex) -> PDF (pdflatex)
+La
+\family sans
+TeX
+\family default
+ (pdflatex) -> PDF (pdflatex)
\end_layout
\end_inset
.
Check the documentation of your viewer whether the viewer needs to be configure
-d for the use with SyncTeX.
+d for the use with Sync\SpecialChar TeX
+.
\begin_inset Foot
status collapsed
Configuring and using specific viewers
\begin_inset CommandInset label
LatexCommand label
-name "sub:configuring-viewers"
+name "subsec:configuring-viewers"
\end_inset
\end_inset
, 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
-
+ as \SpecialChar LyX
+ already provides the necessary hooks for automatically using the
\begin_inset Flex Code
status collapsed
\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 MenuItem
+ the socket for communicating with \SpecialChar LyX
+, simply change the DVI viewer in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
File formats
\end_layout
status collapsed
\begin_layout Plain Layout
-DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
+DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-xdvi -editor 'lyxeditor.sh %f %l'
+xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-read < "${LYXPIPE}".out || exit
+read TMP < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
\end_inset
XServer pipe path specified in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
Paths
\end_layout
\end_layout
\begin_layout Standard
-Modify the lines accordingly if you install LyX somewhere else than in the
+Modify the lines accordingly if you install \SpecialChar LyX
+ somewhere else than in the
Applications folder.
\end_layout
\end_inset
to the viewer setting in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
PDF (pdflatex)
\end_layout
\end_inset
, and then in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Skim\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
+Skim\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
Sync
\end_layout
\end_inset
choose
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
preset and enter command
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-/Applications/LyX.app/Contents/MacOS/lyxeditor
+/Applications/\SpecialChar LyX
+.app/Contents/MacOS/lyxeditor
\end_layout
\end_inset
\begin_layout Standard
Go to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Settings\SpecialChar \menuseparator
-Configure Okular\SpecialChar \ldots{}
-\SpecialChar \menuseparator
+Settings\SpecialChar menuseparator
+Configure Okular\SpecialChar menuseparator
Editor
\end_layout
Reverse search is triggered by SHIFT-click.
\end_layout
+\begin_layout Subsubsection*
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+Qpdfview supports Sync\SpecialChar TeX
+ since version 0.3.5.
+ Go to
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Edit\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Behavior
+\end_layout
+
+\end_inset
+
+, click on the input field of the
+\begin_inset Quotes eld
+\end_inset
+
+Source editor
+\begin_inset Quotes erd
+\end_inset
+
+ item and add the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient -g %1 %2
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
+
\begin_layout Subsubsection*
YAP (Windows)
\end_layout
\begin_layout Standard
Launch yap, choose its
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+View\SpecialChar menuseparator
Options
\end_layout
\begin_inset Quotes eld
\end_inset
-New\SpecialChar \ldots{}
+New\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-LyX Editor
+\SpecialChar LyX
+ Editor
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-\SpecialChar \ldots{}
+\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\end_inset
- wrapper is used for communicating with LyX through the
+ wrapper is used for communicating with \SpecialChar LyX
+ through the
\emph on
lyxpipe
\emph default
\end_layout
\begin_layout Standard
-Make sure that the LyXServer pipe path you specified in LyX is
+Make sure that the \SpecialChar LyX
+Server pipe path you specified in \SpecialChar LyX
+ is
\begin_inset Flex Code
status collapsed
\end_inset
in the viewer setting in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
PDF (pdflatex)
\end_layout
\begin_layout Standard
First of all, make sure that yap is your default DVI viewer in the Windows
environment, then launch it, choose its
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+View\SpecialChar menuseparator
Options
\end_layout
\begin_inset Quotes eld
\end_inset
-New\SpecialChar \ldots{}
+New\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-LyX Editor
+\SpecialChar LyX
+ Editor
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-\SpecialChar \ldots{}
+\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\end_inset
- program (which is installed by default on Cygwin along with the LyX executable).
+ program (which is installed by default on Cygwin along with the \SpecialChar LyX
+ executable).
Select
\begin_inset Flex Code
status collapsed
\emph on
lyxsocket
\emph default
- for communicating with LyX.
+ for communicating with \SpecialChar LyX
+.
If, for whatever reason, you want to use the
\emph on
lyxpipe
\end_inset
- option and be sure to specify the LyXServer pipe path in the LyX preferences.
+ option and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Standard
\end_inset
in the viewer setting in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File formats\SpecialChar menuseparator
PDF (pdflatex)
\end_layout
\emph on
lyxpipe
\emph default
-, and be sure to specify the LyXServer pipe path in the LyX preferences.
+, and be sure to specify the \SpecialChar LyX
+Server pipe path in the \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Standard
\end_inset
of reverse search.
- It allows you to let the viewer jump to a given position from within LyX.
+ It allows you to let the viewer jump to a given position from within \SpecialChar LyX
+.
If forward search is set up (as described in what follows), you can put
- the cursor anywhere in your LyX document, and hit
-\begin_inset Flex MenuItem
+ the cursor anywhere in your \SpecialChar LyX
+ document, and hit
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Navigate\SpecialChar \menuseparator
+Navigate\SpecialChar menuseparator
Forward search
\end_layout
\end_inset
(or select
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
To make forward search possible, you first need to provide the generated
- output PDF/DVI file with additional information about the TeX sources.
+ output PDF/DVI file with additional information about the \SpecialChar TeX
+ sources.
This can be done via the methods described in the section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:rev-search"
+reference "subsec:rev-search"
\end_inset
\end_layout
\begin_layout Standard
-Additionally, you need to configure LyX for using your viewers in
-\begin_inset Flex MenuItem
+Additionally, you need to configure \SpecialChar LyX
+ for using your viewers in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Output\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Output\SpecialChar menuseparator
General
\end_layout
\begin_layout Standard
Note that only some of the viewers provide full forward search functionality,
- among them yap, xdvi, okular and Sumatra PDF.
+ among them yap, xdvi, okular
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You might want to set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+okular –unique
+\end_layout
+
+\end_inset
+
+ in
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File
+\begin_inset space ~
+\end_inset
+
+Formats
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+, qpdfview and SumatraPDF
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-For Sumatra CMCDDE is needed --- downloadable from
+SumatraPDF can also use DDE commands through the external program CMCDDE
+ — downloadable from
\begin_inset CommandInset href
LatexCommand href
-target "http://www.istri.fr/zip/CMCDDE.zip"
+target "http://www.istri.fr/spip/zip/CMCDDE.zip"
\end_inset
\end_inset
+.
While many of the widespread PDF viewers (most notably Adobe Reader) do
- not support forward search at all, some other viewers -- e.
+ not support forward search at all, some other viewers – e.
\begin_inset space \thinspace{}
\end_inset
g.
- evince and xpdf -- allow at least to reload the document and jump to a
- specific page of the file, so you can at least navigate
+ evince and xpdf – allow at least to reload the document and jump to a specific
+ page of the file, so you can at least navigate
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Forward search works both with DVI and PDF output.
- LyX simply checks which preview format you have used before (i.
+ \SpecialChar LyX
+ simply checks which preview format you have used before (i.
\begin_inset space \thinspace{}
\end_inset
\end_layout
\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
+This section describes how \SpecialChar LyX
+ can be used to write articles for submission
to the scientific journal
\emph on
Astronomy and Astrophysics
\emph default
- (www.edpsciences.fr/aa/
+ (
\begin_inset Flex URL
status collapsed
to EDP Sciences starting January 1, 2001.
That change involved also some slight changes to the style files, namely
the removal of the thesaurus command.
- The LyX class aa supports the newest version of these style files, V 5.01.
+ The \SpecialChar LyX
+ class aa supports the newest version of these style files, V 5.01.
If you have an older version installed, please upgrade.
For compatibility, the old (version 4) layout has been kept as
\family sans
.
Please refer to the comments in
\family typewriter
-LyXDir/layouts/aapaper.layout
+\SpecialChar LyX
+Dir/layouts/aapaper.layout
\family default
.
\end_layout
\end_layout
\begin_layout Standard
-It is recommended you start from the example template distributed with LyX.
+It is recommended you start from the example template distributed with \SpecialChar LyX
+.
If you are not using a template, note the following settings:
\end_layout
\family default
in the
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
dialog (OK, that one was obvious).
\backslash
maketitle
\family default
- command, this is done automatically by LyX when the header is finished.
+ command, this is done automatically by \SpecialChar LyX
+ when the header is finished.
Although the order of the single header entries doesn't matter it is advised
to keep the above sequence, just to get the best optics and meets the layout
of the real document.
to state your present address, just use the standard footnote via the menu
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Footnote.
\family default
- LyX will automagically use the term
+ \SpecialChar LyX
+ will automagically use the term
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
+In addition to these topics, the macros use three additional \SpecialChar LaTeX
+ commands that
+ have no counterpart in \SpecialChar LyX
+:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-In all cases, the appropriate command has to be entered in LyX and marked
- as LaTeX code.
+In all cases, the appropriate command has to be entered in \SpecialChar LyX
+ and marked as
+ \SpecialChar LaTeX
+ code.
See the examples.
\end_layout
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
+ This is not yet implemented for \SpecialChar LyX
+, therefore you have to enter the \SpecialChar LaTeX
+ command
+
\family typewriter
\backslash
keywords{}
\family default
- by hand and mark it as LaTeX code.
+ by hand and mark it as \SpecialChar LaTeX
+ code.
Refer to the example paper.
\end_layout
\begin_layout Itemize
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\end_layout
\begin_layout Subsection
-Commands not supported by LyX
+Commands not supported by \SpecialChar LyX
+
\end_layout
\begin_layout Standard
\family sans
paper (A&A)
\family default
- layout for LyX.
+ layout for \SpecialChar LyX
+.
Some have already been mentioned.
For the sake of completeness, they are listed all together here:
\end_layout
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!
+Do not forget to mark them as \SpecialChar LaTeX
+ code!
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-LyX provides support for the necessary float environments
+\SpecialChar LyX
+ provides support for the necessary float environments
\family sans
figure, figure*, table
\family default
Just remember that tables should be left-aligned.
For that, select the table and change the alignment in
\family sans
-Edit\SpecialChar \menuseparator
+Edit\SpecialChar menuseparator
Paragraph
\begin_inset space ~
\end_inset
\begin_layout Enumerate
Create a wide figure float:
\family sans
-Insert\SpecialChar \menuseparator
-Float\SpecialChar \menuseparator
+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
+Span
\begin_inset space ~
\end_inset
\begin_layout Enumerate
Position the cursor behind the figure and insert a horizontal fill:
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Special
\begin_inset space ~
\end_inset
-Character\SpecialChar \menuseparator
+Character\SpecialChar menuseparator
Horizontal
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Enumerate
-Switch to LaTeX mode:
+Switch to \SpecialChar LaTeX
+ mode:
\family sans
M-c
\begin_inset space ~
\end_layout
\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
+Position the cursor behind the caption text, switch to \SpecialChar LaTeX
+ mode and insert
the closing brace:
\family sans
M-c
to the documentclass.
This must be done using the extra class options field in the
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
dialog.
\family sans
Examples
\family default
- directory contains an example paper written with LyX.
+ directory contains an example paper written with \SpecialChar 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.
+ \SpecialChar LyX
+.
+ Use it for inspiration, and compare the original \SpecialChar LaTeX
+ code with \SpecialChar LyX
+ way of writing.
\end_layout
\begin_layout Section
-AASTeX
+AAS\SpecialChar TeX
+
\end_layout
\begin_layout Standard
\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
+AAS\SpecialChar TeX
+ is a set of macros produced by the American Astronomical Society to
+ facilitate electronic manuscript submission to the three journals they
publish: the Astrophysical Journal (including the Letters and Supplement),
the Astronomical Journal, and the Publications of the Astronomical Society
of the Pacific.
- 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
+ \SpecialChar LyX
+ has proven to be an excellent tool for generating these documents, especially
+ given its equation, citation, and figure handling capabilities.
+ \SpecialChar LyX
+ requires version 5.0 (or higher) of these macros; preferably 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
+ Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
+2.09 and are fundamentally
+ incompatible with \SpecialChar LyX
+.
+ The AAS\SpecialChar TeX
+ package may be downloaded from the AAS\SpecialChar TeX
+ Web site
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
-http://www.journals.uchicago.edu/AAS/AASTeX
+https://aas.org/aastex/aastex-downloads
\end_layout
\end_inset
\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.
+ yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
+.
+ \SpecialChar LyX
+ will not reduce the need to figure out all the AAS\SpecialChar TeX
+ commands, it will only
+ reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported \SpecialChar LaTeX
+ document conforms
+ completely to the requirements of the journal to which you are submitting
+ your paper.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
+I strongly suggest that you start with the AAS\SpecialChar TeX
+ template file.
Click on
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
New from
\family default
<>
\family default
) with the correct information.
- Many of the AASTeX commands and environments can be implemented directly
- in LyX, but some cannot: most noticeably
+ Many of the AAS\SpecialChar TeX
+ commands and environments can be implemented directly in
+ \SpecialChar LyX
+, but some cannot: most noticeably
\family typewriter
\backslash
\family default
, which should stick out like a sore thumb if you actually just opened the
template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- 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.
+ For commands such as these, the \SpecialChar LaTeX
+ code must be entered directly and marked
+ as such.
+ Such commands are referred to as \SpecialChar TeX
+ code, or Evil Red Text.
+ I tried to minimize the amount of \SpecialChar TeX
+ code needed in an AAS\SpecialChar TeX
+ document, but
+ there is still a bit more required than any of us would like.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Enumerate
-Export your paper as a LaTeX file (
+Export your paper as a \SpecialChar LaTeX
+ file (
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\family default
).
.tex
\family default
file with your favorite text editor
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\backslash
makeatother
\family default
- commands, except for any commands you specifically put into the LaTeX preamble
+ commands, except for any commands you specifically put into the \SpecialChar LaTeX
+ preamble
(which should appear immediately after the
\begin_inset Quotes eld
\end_inset
-User specified LaTeX commands
+User specified \SpecialChar LaTeX
+ commands
\begin_inset Quotes erd
\end_inset
\end_deeper
\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
+Run the resulting file through \SpecialChar LaTeX
+ to make sure it still processes correctly.
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Standard
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
+I will not describe the detailed usage of the individual AAS\SpecialChar TeX
+ commands: the
+ AAS\SpecialChar TeX
+ User Guide (
\family typewriter
aasguide.tex
\family default
) gives a good description of each.
Thus it's probably easiest for me to go down the list as found in the guide
and offer comments where necessary.
- So let's begin \SpecialChar \ldots{}
+ So let's begin \SpecialChar ldots
\end_layout
\family default
box in
\family sans
-Layout\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
Document
\family default
.
\begin_layout Itemize
These items are reserved for use by the journal editors, but you can put
- them into the LaTeX preamble if you feel compelled to do so:
+ them into the \SpecialChar LaTeX
+ preamble if you feel compelled to do so:
\family typewriter
\backslash
\end_layout
\begin_layout Itemize
-These items may be placed in the LaTeX preamble, and are included as blanks
- in the template file:
+These items may be placed in the \SpecialChar LaTeX
+ preamble, and are included as blanks in
+ the template file:
\family typewriter
\backslash
\end_inset
, not in the middle of a paragraph.
- Use TeX code if you need to embed it.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
\begin_layout Itemize
\end_inset
, not in the middle of a paragraph.
- Use TeX code if you need to embed it.
+ Use \SpecialChar TeX
+ code if you need to embed it.
\end_layout
\begin_layout Itemize
(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
+Insert\SpecialChar menuseparator
Short Title
\family default
.
\end_layout
\begin_layout Subsubsection
-Things not implemented, use TeX code
+Things not implemented, use \SpecialChar TeX
+ code
\end_layout
\begin_layout Standard
\family default
(2.15.4, insert it as the first element in the lefthand cell after where
you want it.
- Don't use any of LyX's rules in the table),
+ Don't use any of \SpecialChar LyX
+'s rules in the table),
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-\SpecialChar \ldots{}
+\SpecialChar ldots
at least in any meaningful sort of way, so I suggest ignoring them.
They are the references environment (2.13.3), and the deluxetable environment
(2.15).
If you really, really need to use deluxetable, I suggest editing it in
a separate file with a text editor, then using
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Child
\begin_inset space ~
\end_inset
Document
\family default
- to include it in your LyX document.
+ to include it in your \SpecialChar LyX
+ document.
See the
\family typewriter
aas_sample.lyx
\end_layout
\begin_layout Subsubsection
-Getting LyX and AASTeX to cooperate
+Getting \SpecialChar LyX
+ and AAS\SpecialChar TeX
+ to cooperate
\end_layout
\begin_layout Standard
-It can be a bit tricky to get LyX to recognize a new layout and document
- class.
+It can be a bit tricky to get \SpecialChar LyX
+ to recognize a new layout and document class.
When all else fails, do this:
\end_layout
\begin_layout Enumerate
-Make certain that LaTeX can find AASTeX.
- Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
- a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
+Make certain that \SpecialChar LaTeX
+ can find AAS\SpecialChar TeX
+.
+ Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
+ distribution into a
+ directory completely unrelated to \SpecialChar LaTeX
+ or AAS\SpecialChar TeX
+ and run \SpecialChar LaTeX
+ on
\family typewriter
sample.tex
\family default
\family typewriter
aastex.layout
\family default
- appears in LyX's
+ appears in \SpecialChar LyX
+'s
\family typewriter
layouts
\family default
\begin_layout Enumerate
Rerun
\family sans
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\family default
- in LyX, then restart LyX.
+ in \SpecialChar LyX
+, then restart \SpecialChar LyX
+.
\end_layout
\begin_layout Enumerate
Open a regular new file, not from a template.
- Does AASTeX appear in the class list in
+ Does AAS\SpecialChar TeX
+ appear in the class list in
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
?
\end_layout
\begin_layout Standard
-If you get a warning from an existing AASTeX document about not being able
- to find the AASTeX layout or a message about
+If you get a warning from an existing AAS\SpecialChar TeX
+ document about not being able
+ to find the AAS\SpecialChar TeX
+ layout or a message about
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-LaTeX error processing a table
+\SpecialChar LaTeX
+ error processing a table
\end_layout
\begin_layout Standard
-LyX, by default, attempts to center the table caption/title.
- This seems to produce a bad interaction in AASTeX so you should click somewhere
+\SpecialChar LyX
+, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AAS\SpecialChar TeX
+ so you should click somewhere
in the caption/title, then select
\family sans
-Edit\SpecialChar \menuseparator
+Edit\SpecialChar menuseparator
Paragraph
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-Even though AASTeX provides its own figure commands (
+Even though AAS\SpecialChar TeX
+ provides its own figure commands (
\family typewriter
\backslash
plotone
\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
+, for example), I much prefer \SpecialChar LaTeX
+'s standard figure commands (with the default
+ graphicx).
You can insert the
\family typewriter
\begin_inset space ~
\end_inset
-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
+commands as \SpecialChar TeX
+ code into a Figure Float box if you desire, but I never have
+ much luck getting the layout right.
+ With the standard graphics, \SpecialChar LyX
+ will insert a
\family typewriter
\backslash
usepackage{graphicx}
\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way, interspersing the figures in the text.
+ command into the \SpecialChar LaTeX
+ preamble and handle the figures in the standard \SpecialChar LaTeX2e
+ way,
+ interspersing the figures in the text.
I believe ApJ accepts figures exactly this way now; AJ might still use
the
\begin_inset Quotes eld
\end_inset
things I could have implemented, but chose not to.
- For instance, I saw no point in double-spacing the text in the LyX window,
+ For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
+ window,
even though it is double-spaced in the paper manuscript.
Also, I chose not to make separate layouts for the preprint and preprint2
styles.
\begin_layout Standard
Your mileage may vary.
I've now had papers published by both ApJ and AJ that have had 98% of the
- effort done in LyX; the last 2% was the LaTeX post-processing and a few
- cleanups.
+ effort done in \SpecialChar LyX
+; the last 2% was the \SpecialChar LaTeX
+ post-processing and a few cleanups.
I have had no trouble with the submission process, and I'm sure the journals
were never aware that there might be a difference.
So, go forth and publish!
\end_layout
\begin_layout Section
-AMS LaTeX
+AMS \SpecialChar LaTeX
+
\end_layout
\begin_layout Standard
\begin_layout Standard
\noindent
-The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+The AMS \SpecialChar LaTeX
+ layouts are set up to conform to suggested styles for mathematical
papers to be submitted to American Mathematical Society publications.
The layouts are not tailored to a specific journal, but easily can be.
You should refer to the AMS documentation for specific instructions for
each journal (usually it will entail only changing a single line in the
- TeX output).
+ \SpecialChar TeX
+ output).
That documentation is available on the Web at
\begin_inset Flex URL
status open
\end_layout
\begin_layout Standard
-There are two basic AMS LaTeX layouts:
+There are two basic AMS \SpecialChar LaTeX
+ layouts:
\end_layout
\begin_layout Itemize
\begin_layout Standard
There is a long list of included environments provided by these layouts.
- In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
- variety of `theorem' environments.
- However, the AMS recommends the environments that are available in LyX.
+ In AMS-\SpecialChar LaTeX
+, there is, in fact, an opportunity to define an unlimited variety
+ of `theorem' environments.
+ However, the AMS recommends the environments that are available in \SpecialChar LyX
+.
\end_layout
\end_layout
\begin_layout Standard
-In addition, the AMS classes automatically provide the AMS LaTeX and AMS
- fonts packages.
+In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
+ and AMS fonts
+ packages.
They need to be available on your system in order to use these environments.
\end_layout
\begin_layout Plain Layout
-ftp://ftp.agu.org/journals/latex/journals
+http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
\end_layout
\end_inset
Paragraph*
\family default
.
- They are still called this in the LyX GUI, though their LaTeX equivalents
- in the AGU classes are
+ They are still called this in the \SpecialChar LyX
+ GUI, though their \SpecialChar LaTeX
+ equivalents in the
+ AGU classes are
\family sans
Subsubsubsection
\family default
.
This can be done in the
\family sans
-Layout\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
Document
\family default
or
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
menu item.
\family sans
agu
\family default
- into the second field of the BibTeX inset.
+ into the second field of the Bib\SpecialChar TeX
+ inset.
None of the standard styles will do.
\end_layout
\end_layout
\begin_layout Standard
-See the LyX template file
+See the \SpecialChar LyX
+ template file
\family typewriter
elsarticle.lyx
\family default
\begin_layout Section
Foils [aka
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
]
\begin_inset CommandInset label
\end_layout
\begin_layout Standard
-This section describes how to use LyX to make slides for overhead projectors.
+This section describes how to use \SpecialChar LyX
+ to make slides for overhead projectors.
There are two document classes that can do this: the default slides class
and the
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
slides class.
This section documents the latter.
\family sans
foils.cls
\family default
- LaTeX class file which is now an integral part of LaTeX2e.
+ \SpecialChar LaTeX
+ class file which is now an integral part of \SpecialChar LaTeX2e
+.
\end_layout
\begin_layout Subsection
\begin_layout Itemize
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
supports A4 and Letter paper sizes as well as a special size for working
with 35
setting behaves a bit differently for this class.
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
provides extensive footer and header capabilities including a user-defined
logo.
\emph default
has the logo centered at the bottom of the page (if one is defined).
The possible page style choices and what they do are as follows:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\family default
package although its use with
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
is discouraged by the writer of the
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
package because of some potential page layout clashes.
\end_layout
\begin_layout Standard
The following options may be used in the extra class options in the
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
dialog.
document.
This option tells
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
to use the dvips driver to rotate those pages that are set as landscape
foils.
class.
There are several additional environments provided by
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
- as well as a couple added by LyX.
+ as well as a couple added by \SpecialChar LyX
+.
The following environments are shared with other classes:
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
\begin_layout Itemize
\family sans
-LyX-Code
+\SpecialChar LyX
+-Code
\end_layout
\begin_layout Itemize
Comment
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
Since foils are essentially self-contained sections, with a title and body,
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
provides specific commands for starting new foils and these are:
\end_layout
\end_layout
\begin_layout Standard
-LyX also provides slightly modified versions of these two environments called:
+\SpecialChar LyX
+ also provides slightly modified versions of these two environments called:
\end_layout
\begin_layout Itemize
Since foils are often used in presenting ideas or new theorems and such
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
also provides a comprehensive box of goodies for presenting them:
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
Definition*
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\begin_layout Standard
The starred versions are unnumbered while the unstarred versions are numbered.
- There are also two list environments added by LyX and these are:
+ There are also two list environments added by \SpecialChar LyX
+ and these are:
\end_layout
\begin_layout Itemize
\begin_layout Standard
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
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.
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
\end_inset
Header
-\end_layout
+\family default
-\begin_deeper
-\begin_layout Standard
-\begin_inset space ~
+\begin_inset Separator parbreak
\end_inset
\end_layout
-\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status open
-
+\begin_deeper
\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
-\backslash
-end{multicols}
\end_layout
+\end_deeper
\end_inset
\begin_layout Standard
There are also a few commands provided by
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
- 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 \SpecialChar LyX
+ but I'll tell you what they do and how
+ to use them in section
\begin_inset space ~
\end_inset
\family typewriter
Foils.lyx
\family default
- file you find in LyX's
+ file you find in \SpecialChar LyX
+'s
\family typewriter
examples
\family default
\family sans
Date
\family default
- environment LaTeX will substitute the current date (every time you regenerate
+ environment \SpecialChar LaTeX
+ will substitute the current date (every time you regenerate
the output).
\end_layout
\family default
environments.
Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
+ Both of the short versions have 0.5
+\begin_inset space ~
+\end_inset
+
+inches less separation between the foilhead and the body.
\end_layout
\end_layout
\begin_layout Standard
-Due to a small bug in LyX you can't have two of the same type of these environme
-nts directly following each other.
+Due to a small bug in \SpecialChar LyX
+ you can't have two of the same type of these environments
+ directly following each other.
They must be separated by something.
If you try, you will just be extending the previous environment as if you
had merged the two environments together.
So, how do you get around this problem? The simplest option is to insert
some text between the two environments or add a
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\family default
environment between the two with just a
\begin_inset Quotes eld
\end_inset
in it.
- This will force LyX to produce two separate environments and hence the
- correct LaTeX output.
- An example is provided in the example file included with the LyX distribution.
+ This will force \SpecialChar LyX
+ to produce two separate environments and hence the correct
+ \SpecialChar LaTeX
+ output.
+ An example is provided in the example file included with the \SpecialChar LyX
+ distribution.
Remember, this problem only occurs if you are trying to place two of the
same type of theorem-like environments one directly after the other.
\end_layout
\begin_layout Standard
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
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
-Typeset by
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
-
\begin_inset Quotes erd
\begin_layout Subsection
Unsupported
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
Goodies
\begin_inset CommandInset label
\begin_layout Standard
All the commands mentioned below need to be set in a
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\family default
environment or as
\family sans
-TeX
+\SpecialChar TeX
+
\family default
within another environment.
\end_layout
\family default
Instructions to the speaker.
- The () are automatically inserted, but only the ( will show in LyX.
+ The () are automatically inserted, but only the ( will show in \SpecialChar LyX
+.
Both will be printed.
\end_layout
\end_inset
package, and they are almost (but not exactly) identical.
- Most of their features are supported by LyX.
- I have used LyX successfully to write articles submitted to both journals
+ Most of their features are supported by \SpecialChar LyX
+.
+ I have used \SpecialChar LyX
+ successfully to write articles submitted to both journals
without any problem.
\end_layout
As usual, the easiest way to write a paper is to start with a template.
Click on
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
New from
\family default
\family sans
-\bar under
-T
-\bar default
-emplate
+Template
\family default
, then choose the
\family typewriter
\end_layout
\begin_layout Enumerate
-LyX won't let you change the font size and the page style of the document,
+\SpecialChar LyX
+ won't let you change the font size and the page style of the document,
because such modifications are not allowed by both packages.
\end_layout
Before previewing your paper, be sure that the babel package is not used.
To do this, click on
\family sans
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\family default
, select the
.
Their use is more or less obvious.
- LyX supports all these environments; it will use the proper label, text
- style, and numbering scheme for each of them.
+ \SpecialChar LyX
+ supports all these environments; it will use the proper label, text style,
+ and numbering scheme for each of them.
\end_layout
\begin_layout Enumerate
Both packages use basic citations; the natbib package should not be used.
- In LyX, citation references are shown as usual; in the output, citations
- are shown as superscripts.
+ In \SpecialChar LyX
+, citation references are shown as usual; in the output, citations are
+ shown as superscripts.
If you want to use a citation as normal text, you should use the
\family typewriter
refcite
before
\shape default
the References.
- LyX provides a special environment, called
+ \SpecialChar LyX
+ provides a special environment, called
\begin_inset Quotes eld
\end_inset
\end_inset
which marks the beginning of the appendices.
- This environment should be left blank; it just sends a LaTeX command, but
- nothing is really printed.
- In LyX, the word
+ This environment should be left blank; it just sends a \SpecialChar LaTeX
+ command, but nothing
+ is really printed.
+ In \SpecialChar LyX
+, the word
\begin_inset Quotes eld
\end_inset
\end_inset
environment.
- LyX will number each appendix with capital letters, as required by both
- journals.
+ \SpecialChar LyX
+ will number each appendix with capital letters, as required by both journals.
Note that
\begin_inset Quotes eld
\end_inset
tbl
\family default
command to implement table captions.
- As a result, a table created by LyX is printed correctly, but its caption
+ As a result, a table created by \SpecialChar LyX
+ is printed correctly, but its caption
is ignored.
- However, you can use some TeX code to overcome this problem, so that captions
+ However, you can use some \SpecialChar TeX
+ code to overcome this problem, so that captions
are printed as expected.
To do so, create a float table as usual, remove the caption, and replace
- it with the TeX code
+ it with the \SpecialChar TeX
+ code
\family typewriter
\backslash
\emph default
}{
\family default
- (sic); you must also the TeX code
+ (sic); you must also the \SpecialChar TeX
+ code
\family typewriter
}
\family default
\family typewriter
.tex
\family default
- file, then include this file to the LyX document (
+ file, then include this file to the \SpecialChar LyX
+ document (
\family sans
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
+File\SpecialChar menuseparator
Child
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-Before you submit your paper you must export the LyX document as a LaTeX
+Before you submit your paper you must export the \SpecialChar LyX
+ document as a \SpecialChar LaTeX
file (
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\family default
)
\begin_inset Foot
status open
\begin_layout Plain Layout
-Actually you have the choice between LaTeX (plain) and pdflatex.
+Actually you have the choice between \SpecialChar LaTeX
+ (plain) and pdflatex.
If you intend to use pdflatex to prepare the paper, you should use the
pdflatex option so that included graphics are converted to PDF format,
ready for use by pdflatex.
\backslash
makeatother
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
+ commands, except for any commands you specifically put into the \SpecialChar LaTeX
+ preamble.
\end_layout
\begin_layout Standard
\family typewriter
.tex
\family default
- file should be saved and processed through LaTeX as many times as necessary.
+ file should be saved and processed through \SpecialChar LaTeX
+ as many times as necessary.
You may also want to check the resulting
\family typewriter
.dvi
\end_layout
\begin_layout Subsection
-Use of TeX code
+Use of \SpecialChar TeX
+ code
\end_layout
\begin_layout Standard
-The use of TeX code is reduced to two commands, which must be placed at
- the top of the document.
+The use of \SpecialChar TeX
+ code is reduced to two commands, which must be placed at the
+ top of the document.
If you started writing your paper by using the
\family typewriter
ijmpc.lyx
\family typewriter
ijmpd.lyx
\family default
- 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
+ template, the \SpecialChar TeX
+ code needed is already in its place; you usually don't need
+ to delete it.
+ You may only modify the first \SpecialChar TeX
+ code to specify the information printed
to the top of odd and even pages (authors' names and short paper's title,
respectively).
- This TeX code must have the form
+ This \SpecialChar TeX
+ code must have the form
\family typewriter
\backslash
\emph on
IOP-article.lyx
\emph default
- that is available in LyX's examples files folder.
+ that is available in \SpecialChar LyX
+'s examples files folder.
Open this file, save it under a new name, and start writing.
The example file explains how to use the special text environments.
Here are the most important advices:
\size normal
The title environment defines the kind of your paper.
So use one of the following environments for the title:
+\size default
+
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\family sans
Article
\family default
- which is not directly supported by the LyX.
- This can be used as TeX code when your document doesn't fit into one of
- the other title types.
+ which is not directly supported by the \SpecialChar LyX
+.
+ This can be used as \SpecialChar TeX
+ code when your document doesn't fit into one of the
+ other title types.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-LyX supports many features of the package but not everything.
- However, the TeX code needed is reduced to some
+\SpecialChar LyX
+ supports many features of the package but not everything.
+ However, the \SpecialChar TeX
+ code needed is reduced to some
\begin_inset Quotes eld
\end_inset
\end_inset
).
- I have recently used LyX to write an article submitted to the
+ I have recently used \SpecialChar LyX
+ to write an article submitted to the
\emph on
Astrophysics and Space Science
\emph default
The easiest way to write a paper is to start with the Kluwer template file.
Click on
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
New from
\family default
\end_layout
\begin_layout Standard
-As in the AASTeX package, before you submit your paper to a journal you
- must
+As in the AAS\SpecialChar TeX
+ package, before you submit your paper to a journal you must
+
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-Export your paper as a LaTeX file.
+Export your paper as a \SpecialChar LaTeX
+ file.
To do this, click on
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\family default
.
.tex
\family default
file with a text editor and make the following changes
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\backslash
makeatother
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
+ commands, except for any commands you specifically put into the \SpecialChar LaTeX
+ preamble.
\end_layout
\begin_layout Standard
\family typewriter
.tex
\family default
- file through LaTeX as many times as necessary (usually up to three).
+ file through \SpecialChar LaTeX
+ as many times as necessary (usually up to three).
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Enumerate
-It is possible to write multiple articles in the same LaTeX file
+It is possible to write multiple articles in the same \SpecialChar LaTeX
+ file
\begin_inset Foot
status collapsed
end{article}
\family default
.
- Although this can be implemented in LyX, I didn't included it, since it
- looks ugly and can confuse the novice user.
- Therefore, you need to enter them directly and mark them as LaTeX code
- (the well-known
+ Although this can be implemented in \SpecialChar LyX
+, I didn't included it, since it looks
+ ugly and can confuse the novice user.
+ Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
+ code (the
+ well-known
\begin_inset Quotes eld
\end_inset
-TeX code
+\SpecialChar TeX
+ code
\begin_inset Quotes erd
\end_inset
\end_inset
.
- This is not implemented in LyX, so you must enter title, subtitle etc.
+ This is not implemented in \SpecialChar LyX
+, so you must enter title, subtitle etc.
\begin_inset space ~
\end_inset
-between two TeX code lines (
+between two \SpecialChar TeX
+ code lines (
\family typewriter
\backslash
\end_layout
\begin_layout Enumerate
-don't delete the TeX code included in the template, and
+don't delete the \SpecialChar TeX
+ code included in the template, and
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Standard
-The LyX document classes
+The \SpecialChar LyX
+ document classes
\emph on
article (koma-script)
\emph default
\emph on
(koma-script)
\emph default
- correspond to the LaTeX document classes
+ correspond to the \SpecialChar LaTeX
+ document classes
\family typewriter
scrartcl.cls
\family default
There is a big difference between the bold sans serif old cm fonts and new
ec fonts, especially in the appearance of headings.
In comparison, the ec bold sans serif fonts look a bit thin.
- Here the LaTeX package
+ Here the \SpecialChar LaTeX
+ package
\family typewriter
cmsd.sty by
\family default
\begin_inset Quotes eld
\end_inset
-Chapter\SpecialChar \ldots{}
+Chapter\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
.
In addition, the appearance of the headings can be modified by using a
- number of options (in LyX to be entered in the field
+ number of options (in \SpecialChar LyX
+ to be entered in the field
\family sans
Extra
\begin_inset space ~
\family default
of the dialog
\family sans
-Layout\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
Document
\family default
).
\family sans
DIV
\family default
- (in LyX to be entered in the extra class options field in the dialog
+ (in \SpecialChar LyX
+ to be entered in the extra class options field in the dialog
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
).
They make a clearer modification of page margins possible as do the options
of the dialog
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
.
\end_layout
\begin_layout Itemize
-The LaTeX document classes of the Koma-Script family define a number of
- additional commands.
- Those part of it which makes sense in LyX is implemented in corresponding
+The \SpecialChar LaTeX
+ document classes of the Koma-Script family define a number of additional
+ commands.
+ Those part of it which makes sense in \SpecialChar LyX
+ is implemented in corresponding
paragraph types.
\end_layout
\begin_layout Standard
-Detailed descriptions of the LaTeX document classes of the Koma-Script family
+Detailed descriptions of the \SpecialChar LaTeX
+ document classes of the Koma-Script family
can be found in the Koma-Script documentation
\emph on
scrguide
\emph on
book
\emph default
-, resp., partly modified, with the exception of the LyX specific
+, resp., partly modified, with the exception of the \SpecialChar LyX
+ specific
\family sans
List
\family default
\family sans
Part*
\family default
-, is has not been implemented in LyX.
+, is has not been implemented in \SpecialChar LyX
+.
\end_layout
\end_inset
at the beginning of a chapter.
If you use the optional argument (
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Short
\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-The corresponding LaTeX commands must appear before the
+The corresponding \SpecialChar LaTeX
+ commands must appear before the
\family typewriter
\backslash
\emph on
letter
\emph default
-, partly modified, with the exception of the LyX specific types
+, partly modified, with the exception of the \SpecialChar LyX
+ specific types
\family sans
-LyX-Code
+\SpecialChar LyX
+-Code
\family default
and
\family sans
In addition, it contains, in contrast to the standard document class, the
standard types
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\family default
,
\family sans
\begin_layout Standard
The appearance of the letter produced by this document class can be controlled
- by a number of LaTeX commands, which you can put in the LaTeX preamble.
+ by a number of \SpecialChar LaTeX
+ commands, which you can put in the \SpecialChar LaTeX
+ preamble.
\begin_inset Foot
status collapsed
\begin_inset Quotes erd
\end_inset
- heading is produced by the following LaTeX commands in the preamble:
+ heading is produced by the following \SpecialChar LaTeX
+ commands in the preamble:
\end_layout
\begin_layout LyX-Code
\end_inset
- A detailed German description of such LaTeX commands can be found in the
- Koma-Script documentation
+ A detailed German description of such \SpecialChar LaTeX
+ commands can be found in the Koma-Script
+ documentation
\emph on
scrguide
\emph default
Opening
\family default
define the beginning of the letter and must be used in every letter.
- To emphasize them in the LyX document class, they are marked with the letter
+ To emphasize them in the \SpecialChar LyX
+ document class, they are marked with the letter
\shape italic
L
\family sans
Telephone
\family default
-: sender's telephone number, in the standard behavior only sets the LaTeX
- variable
+: sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
+ variable
+
\family typewriter
\backslash
\family sans
Place
\family default
- type however does not appear, but only the LaTeX variable
+ type however does not appear, but only the \SpecialChar LaTeX
+ variable
\family typewriter
\backslash
scrlettr
\family default
.
- It has — on the LaTeX side — a completely new interface and is not compatible
+ It has — on the \SpecialChar LaTeX
+ side — a completely new interface and is not compatible
with the old class.
- Therefore, LyX supports both, though it is recommended you use the new
- class.
+ Therefore, \SpecialChar LyX
+ supports both, though it is recommended you use the new class.
\end_layout
\begin_layout Standard
\family default
(via
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Graphics
\family default
) in the header.
\family default
, inserted via the
\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
+Document\SpecialChar menuseparator
Extra Options
\family default
field.
\emph on
koma-letter2
\emph default
- template that is included in LyX for examples.
+ template that is included in \SpecialChar LyX
+ for examples.
A detailed description is to be found in the Koma-Script documentation
(
\emph on
\end_layout
\begin_layout Standard
-Visualizing the Koma-Script document classes in LyX, the LyX internals cause
- some problems.
+Visualizing the Koma-Script document classes in \SpecialChar LyX
+, the \SpecialChar LyX
+ internals cause some
+ problems.
\end_layout
\begin_layout Itemize
\family default
type appears on a line of its own above the chapter heading instead of
appearing in the same line ahead of it.
- The cause for that is the LyX internal behavior for the labeltype
+ The cause for that is the \SpecialChar LyX
+ internal behavior for the labeltype
\family sans
Counter_Chapter
\family default
\begin_inset Quotes erd
\end_inset
- LaTeX table of contents, but not in the LyX table of contents (
+ \SpecialChar LaTeX
+ table of contents, but not in the \SpecialChar LyX
+ table of contents (
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Table
\begin_inset space ~
\end_inset
letter
\emph default
document class appear in a skip separation mode, not indented.
- This is the standard behavior, no special LaTeX commands are needed for
- that.
+ This is the standard behavior, no special \SpecialChar LaTeX
+ commands are needed for that.
But in the
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
dialog the corresponding radio button indicates
\family sans
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.
+ value always has the effect that extra \SpecialChar LaTeX
+ commands are inserted in the document
+ to produce the gap, which is not what is wanted in this case.
\end_layout
\begin_layout Section
\begin_layout Standard
Peter Wilson, the developer of Memoir, is known as the author of lots of
- useful packages in the LaTeX world.
+ useful packages in the \SpecialChar LaTeX
+ world.
Most of them have been merged with Memoir.
Therefore, it is much easier to layout the table of contents, appendices,
chapter designs and such.
- LyX, though, does not support all of these goodies natively.
+ \SpecialChar LyX
+, though, does not support all of these goodies natively.
Some of them might be added to forthcoming releases
\begin_inset Foot
status collapsed
\end_inset
-, lots will probably never be supported, due to the limitations of LyX's
- framework.
- Of course you can still use all features with the help of some native LaTeX
- commands (TeX code
+, lots will probably never be supported, due to the limitations of \SpecialChar LyX
+'s framework.
+ Of course you can still use all features with the help of some native \SpecialChar LaTeX
+
+ commands (\SpecialChar TeX
+ code
\begin_inset Foot
status collapsed
).
In this section, we can only list those features that are natively supported
- by LyX.
+ by \SpecialChar LyX
+.
For detailed descriptions (and for the rest of features) we recommend you
have a look at the detailed manual of the Memoir class
\begin_inset Foot
style: The fancy page style is not supported, due to a command clash between
Memoir and the fancyhdr package (they both define a command with the same
- name, which confuses LaTeX).
+ name, which confuses \SpecialChar LaTeX
+).
Instead, Memoir comes with a number of its own page styles (see
\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
+Document\SpecialChar menuseparator
Page
\begin_inset space ~
\end_inset
optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
- In LyX, you can do this via
+ In \SpecialChar LyX
+, you can do this via
\family sans
-Insert\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
Short
\begin_inset space ~
\end_inset
\emph default
(to be inserted in
\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
+Layout\SpecialChar menuseparator
+Document\SpecialChar menuseparator
Extra
\begin_inset space ~
\end_inset
\begin_layout Description
Oldfontcommands: By default, Memoir does not allow the use of the deprecated
- font commands, which have been used in the old LaTeX version 2.09 (e.
+ font commands, which have been used in the old \SpecialChar LaTeX
+ version 2.09 (e.
\begin_inset space \thinspace{}
\end_inset
it
\family default
).
- It produces an error and stops LaTeX whenever such a command appears.
+ It produces an error and stops \SpecialChar LaTeX
+ whenever such a command appears.
The class option
\emph on
oldfontcommands
\emph default
reallows the commands and spits out warnings instead (which does at least
- not stop LaTeX).
- Since a lot of packages and particularly BibTeX style files are still using
+ not stop \SpecialChar LaTeX
+).
+ Since a lot of packages and particularly Bib\SpecialChar TeX
+ style files are still using
those commands, we have decided to use this option by default.
\end_layout
\end_layout
\begin_layout Standard
-We will only describe the features supported by LyX (which is not much currently
-).
+We will only describe the features supported by \SpecialChar LyX
+ (which is not much currently).
Please consult the Memoir manual
\begin_inset Foot
status collapsed
motto.
The motto itself (text) and its author (source) are divided by a short
line.
- Unfortunately, we have to fool LyX a bit here again, since the environment
+ Unfortunately, we have to fool \SpecialChar LyX
+ a bit here again, since the environment
needs two arguments (text and source).
- In this case, we have to use curly brackets (in TeX mode) between the two
+ In this case, we have to use curly brackets (in \SpecialChar TeX
+ mode) between the two
arguments:
\emph on
<smart slogan>
\begin_layout Description
Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
complex figurative poems).
- LyX can only support a few of them.
+ \SpecialChar LyX
+ can only support a few of them.
One is poemtitle, which is a centered title for poems, which will also
be added to the table of contents (verse is the standard environment for
poems.
- Memoir has some enhanced versions of verse, but you need to use TeX code,
+ Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
+ code,
because they have to be nested inside regular verse environments, which
- is not possible with LyX).
+ is not possible with \SpecialChar LyX
+).
\end_layout
\begin_layout Description
\end_layout
\begin_layout Standard
-The LyX document classes
+The \SpecialChar LyX
+ document classes
\emph on
article (mwart)
\emph default
\emph on
(mwbk)
\emph default
- correspond to the LaTeX document classes
+ correspond to the \SpecialChar LaTeX
+ document classes
\family typewriter
mwart.cls
\family default
\begin_layout Itemize
Additional page styles:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_deeper
\begin_layout Itemize
Options
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_layout
\begin_layout Section
-RevTeX4
+Rev\SpecialChar TeX
+4
\end_layout
\begin_layout Standard
4
\family default
- textclass works with the American Physical Sociey's RevTeX 4.0 (the
+ textclass works with the American Physical Sociey's Rev\SpecialChar TeX
+ 4.0 (the
\begin_inset Formula $\beta$
\end_inset
\end_layout
\begin_layout Standard
-LyX has a
+\SpecialChar LyX
+ has a
\family sans
Revtex
\family default
- textclass, which works with RevTeX 3.1.
- However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
- That means that it doesn't interact very well with LyX, which requires
- LaTeX2e, although it has been kludged to work.
- Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
- LyX with the
+ textclass, which works with Rev\SpecialChar TeX
+ 3.1.
+ However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
+ 2.09.
+ That means that it doesn't interact very well with \SpecialChar LyX
+, which requires \SpecialChar LaTeX2e
+, although
+ it has been kludged to work.
+ Since Rev\SpecialChar TeX
+ 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
+, \SpecialChar LyX
+ with the
+
\family sans
-RevTeX
+Rev\SpecialChar TeX
+
\begin_inset space ~
\end_inset
\emph on
addition
\emph default
- to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
- macros, and assume you'll know what to put in the preamble if necessary.
+ to the Rev\SpecialChar TeX
+ 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
+ macros,
+ and assume you'll know what to put in the preamble if necessary.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-All you need to do is install RevTeX 4, as described in the package's README
+All you need to do is install Rev\SpecialChar TeX
+ 4, as described in the package's README
file.
- The package can be found at The RevTeX 4 Web Site
+ The package can be found at The Rev\SpecialChar TeX
+ 4 Web Site
\begin_inset Flex URL
status collapsed
\end_inset
.
- Install it somewhere that LaTeX can see it.
- Test it by trying to LaTeX a short RevTeX 4 document in some random directory
- (i.
+ Install it somewhere that \SpecialChar LaTeX
+ can see it.
+ Test it by trying to \SpecialChar LaTeX
+ a short Rev\SpecialChar TeX
+ 4 document in some random directory (i.
\begin_inset space \thinspace{}
\end_inset
\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.
+ \SpecialChar LyX
+, it will find the class file and let you use the Rev\SpecialChar TeX
+4 textclass.
\end_layout
\begin_layout Standard
-Probably the easiest way to get started is either to import a RevTeX 4 document
+Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
+ 4 document
using
\family typewriter
tex2lyx
, go in the
\family sans
-E
-\bar under
-x
-\bar default
-tra
+Extra
\begin_inset space ~
\end_inset
Layout
\family default
dialog, as usual.
- Remember that in RevTeX, at least one optional argument is required!
+ Remember that in Rev\SpecialChar TeX
+, at least one optional argument is required!
\end_layout
\begin_layout Standard
goes in the
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-The layouts basically correspond to the commands in RevTeX4.0.
+The layouts basically correspond to the commands in Rev\SpecialChar TeX
+4.0.
For example, the Email layout corresponds to
\family typewriter
email{}
\family default
.
- Note that (at least as of RevTeX 4.0 Beta), the
+ Note that (at least as of Rev\SpecialChar TeX
+ 4.0 Beta), the
\family sans
Address
\family default
\end_layout
\begin_layout Standard
-There are a couple of important unique aspects of RevTeX 4 which might cause
- bugs that will be even more confusing in LyX.
+There are a couple of important unique aspects of Rev\SpecialChar TeX
+ 4 which might cause
+ bugs that will be even more confusing in \SpecialChar LyX
+.
\end_layout
\begin_layout Standard
-In RevTeX, the
+In Rev\SpecialChar TeX
+, the
\family typewriter
\backslash
author
\family default
command.
- The LyX equivalent is that there is a separate Thanks layout.
+ The \SpecialChar LyX
+ equivalent is that there is a separate Thanks layout.
Do
\emph on
not
Author
\family default
layout, or weird things may happen.
- See the RevTeX 4 documentation for more details.
+ See the Rev\SpecialChar TeX
+ 4 documentation for more details.
\end_layout
\begin_layout Standard
\family sans
Address
\family default
-, the LaTeX won't compile.
+, the \SpecialChar LaTeX
+ won't compile.
\end_layout
\begin_layout Subsection
to layouts like Email and Title.
(The problem is not unique to this layout; you can't use optional arguments
to the Section layouts either.) This means that after you export that file
- to LaTeX (which you'll need to do eventually to send it in to APS), you'll
- need to edit the LaTeX file with a text editor to add the optional arguments
- to set, e.
+ to \SpecialChar LaTeX
+ (which you'll need to do eventually to send it in to APS), you'll need
+ to edit the \SpecialChar LaTeX
+ file with a text editor to add the optional arguments to set,
+ e.
\begin_inset space \thinspace{}
\end_inset
\emph on
Note from JMarc:
\emph default
- actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
+ actually, \SpecialChar LyX
+ 1.3.0 supports some forms of optional arguments, but this layout
has not been updated yet to take advantage of it.
\end_layout
\end_inset
-, where you should also go to fetch the class files (yes, these are LaTeX2e
+, where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
now!).
It is a modular system: the things common to all journals are implemented
in
\family typewriter
svjog
\family default
- come with the standard LyX distribution.
+ come with the standard \SpecialChar LyX
+ distribution.
Install the relevant class file (downloaded from Springer) in a proper
- directory, reconfigure LaTeX (in the teTeX case by running
+ directory, reconfigure \SpecialChar LaTeX
+ (in the te\SpecialChar TeX
+ case by running
\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 \SpecialChar LyX
+ take care of this?), reconfigure \SpecialChar LyX
+ and
+ it should work.
\end_layout
\begin_layout Subsection
\family default
\family sans
-\SpecialChar \ldots{}
+\SpecialChar ldots
Theorem
\family default
.
\begin_layout Standard
\family sans
-Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
+Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
+_Title, Author_Running, Institute,
Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
\family default
.
\family typewriter
ejour2.layout
\family default
-, which was again based on a tinkered-with version of an old LaTeX 2.09 style
+, which was again based on a tinkered-with version of an old \SpecialChar LaTeX
+ 2.09 style
file from Springer.
All this, and the
\family typewriter
\family default
layout, are now defunct.
Jean-Marc Lasgouttes helped out big in making me find my way around the
- LyX layout file mechanism.
+ \SpecialChar LyX
+ layout file mechanism.
\end_layout
\begin_layout Subsection
\begin_layout Standard
Probably.
- But probably less than in the old hacked-LaTeX
+ But probably less than in the old hacked-\SpecialChar LaTeX
+
\family typewriter
ejour2
\family default
\begin_layout Section
Slides [aka
\noun on
-SliTeX
+Sli\SpecialChar TeX
+
\noun default
]
\begin_inset CommandInset label
\end_layout
\begin_layout Standard
-This section describes how to use LyX to make slides for overhead projectors.
+This section describes how to use \SpecialChar LyX
+ to make slides for overhead projectors.
There are two document classes that can do this: the default slides class
and the
\family sans
-FoilTeX
+Foil\SpecialChar TeX
+
\family default
slides class.
This section documents the former.
\family sans
-slides (FoilTeX)
+slides (Foil\SpecialChar TeX
+)
\family default
\begin_inset Quotes erd
\family sans
-slides (FoilTeX)
+slides (Foil\SpecialChar TeX
+)
\family default
\begin_inset Quotes erd
status collapsed
\begin_layout Plain Layout
-\SpecialChar \ldots{}
+\SpecialChar ldots
or so I've been told repeatedly by its advocates.
Having never used it, I have no idea if this claim is true or not.
\end_layout
\end_layout
\begin_layout Standard
-This class is the LaTeX2e improvement of the old
+This class is the \SpecialChar LaTeX2e
+ improvement of the old
\noun on
-SliTeX
+Sli\SpecialChar TeX
+
\noun default
package.
- Every LaTeX2e distribution includes this class [which I'll just refer to
- as
+ Every \SpecialChar LaTeX2e
+ distribution includes this class [which I'll just refer to as
\begin_inset Quotes eld
\end_inset
from the class list in the
\family sans
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\family default
dialog.
\family default
behaves a bit differently for this class.
The possible choices and what they do are as follows:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_inset
in the extra class options.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\family default
class [using
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
New
\begin_inset space ~
\end_inset
\begin_layout Itemize
\family sans
-LyX-Code
+\SpecialChar LyX
+-Code
\end_layout
\begin_layout Itemize
\begin_inset Quotes erd
\end_inset
- in LyX.
- You see, LyX doesn't permit you to nest any other paragraph environment
- into an empty environment.
+ in \SpecialChar LyX
+.
+ You see, \SpecialChar LyX
+ doesn't permit you to nest any other paragraph environment into
+ an empty environment.
Now, that's fine and dandy, but it means that you wouldn't be able to start
a slide with anything except plain text.
To deal with this, I've performed a little
\begin_inset Quotes eld
\end_inset
-LaTeX magic.
+\SpecialChar LaTeX
+ magic.
\begin_inset Quotes erd
\end_inset
\begin_layout Standard
All five of the new paragraph environments are somewhat quirky due to inherent
- limitiations in the current version of LyX.
- As I just mentioned, LyX forbids environments that begin with another environme
-nt.
+ limitiations in the current version of \SpecialChar LyX
+.
+ As I just mentioned, \SpecialChar LyX
+ forbids environments that begin with another environment.
To get around this, the
\family sans
Slide
VisibleText
\family default
.
- LyX completely ignores it.
+ \SpecialChar LyX
+ completely ignores it.
In fact, you can leave these five environments completely empty.
\end_layout
\begin_layout Standard
If, on the other hand, you don't want to enter any descriptive text, you'll
- hit another LyX quirk.
- LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
+ hit another \SpecialChar LyX
+ quirk.
+ \SpecialChar LyX
+, like nature, abhors a vacuum, and will not let you start a new paragraph
environment until you put something in the old one.
So, do this:
\end_layout
\end_layout
\begin_layout Standard
-Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
+Some future version of \SpecialChar LyX
+ will, hopefully, resolve this quirkiness\SpecialChar ldots
\end_layout
\emph on
is
\emph default
- the LyX philosophy.]
+ the \SpecialChar LyX
+ philosophy.]
\end_layout
\begin_layout Standard
\end_inset
-] tells LyX to begin a new slide [duh].
+] tells \SpecialChar LyX
+ to begin a new slide [duh].
The label for this environment/
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
-Slides are probably the only time you'll need to forcibly end pages in LyX
+Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
+
(this can be specified in the
\family sans
Paragraph Layout
Slide
\family default
.
- Indeed, the LyX
+ Indeed, the \SpecialChar LyX
+
\family sans
slides
\family default
\end_layout
\begin_layout Standard
-There's one problem with the way I've designed the LyX
+There's one problem with the way I've designed the \SpecialChar LyX
+
\family sans
slides
\family default
class: you can't make text in the middle of a paragraph invisible, nor
make text in the middle of an invisible paragraph visible again.
- To accomplish this feat, you'll need to use some inlined LaTeX codes.
+ To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
+ codes.
\begin_inset Foot
status collapsed
\family typewriter
{
\backslash
-invisible \SpecialChar \ldots{}
+invisible \SpecialChar ldots
}
\end_layout
\family typewriter
{
\backslash
-visible \SpecialChar \ldots{}
+visible \SpecialChar ldots
}
\end_layout
\begin_layout Plain Layout
-\SpecialChar \ldots{}
-and need to be marked as TeX.
+\SpecialChar ldots
+and need to be marked as \SpecialChar TeX
+.
The text whose
\begin_inset Quotes eld
\end_inset
visible
\family default
command].
- If you don't know how to mark text as TeX, see the appropriate section
- of the
+ If you don't know how to mark text as \SpecialChar TeX
+, see the appropriate section of
+ the
\emph on
User's Guide
\emph default
Slide
\family default
.
- Here, too, the LyX
+ Here, too, the \SpecialChar LyX
+
\family sans
slides
\family default
\family default
.
In the case of the latter, you might want to make use of time markers.
- Currently, the LyX
+ Currently, the \SpecialChar LyX
+
\family sans
slides
\family default
support for time markers, a
\noun on
-SliTeX
+Sli\SpecialChar TeX
+
\noun default
feature.
- So, you'll have to resort to using the LaTeX codes.
+ So, you'll have to resort to using the \SpecialChar LaTeX
+ codes.
\end_layout
\begin_layout Standard
Note
\family default
you generate.
- To set what appears in the time marker, you use the LaTeX commands
+ To set what appears in the time marker, you use the \SpecialChar LaTeX
+ commands
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Luckily, there are two LaTeX commands that allow you to select what to print
+Luckily, there are two \SpecialChar LaTeX
+ commands that allow you to select what to print
out.
Both must be placed into the preamble of your document.
The command
\end_inset
commands.
- See a good LaTeX book for details.
+ See a good \SpecialChar LaTeX
+ book for details.
\end_layout
\begin_layout Subsection
class.
To use it, begin your new presentation with
\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
.
- Your new LyX presentation file will contain an example
+ Your new \SpecialChar LyX
+ presentation file will contain an example
\family sans
Slide
\family default
\end_layout
\begin_layout Standard
-One final thing: I created this class to support the LaTeX2e
+One final thing: I created this class to support the \SpecialChar LaTeX2e
+
\begin_inset Quotes eld
\end_inset
\noun on
-SliTeX
+Sli\SpecialChar TeX
+
\noun default
emulation
\begin_inset Quotes erd
\end_inset
- class, one of the built-in LaTeX2e classes.
- Neither I nor the rest of the LyX Team endorse or oppose the use of this
- built-in slide class.
+ class, one of the built-in \SpecialChar LaTeX2e
+ classes.
+ Neither I nor the rest of the \SpecialChar LyX
+ Team endorse or oppose the use of this built-in
+ slide class.
It's here if you want it or need it.
- There exist other LaTeX2e classes for creating presentations, such as the
-
+ There exist other \SpecialChar LaTeX2e
+ classes for creating presentations, such as the
\family sans
Foils
\family default
\begin_inset Quotes erd
\end_inset
- package [present on some TeX distributions].
- The latter is not yet supported under LyX.
+ package [present on some \SpecialChar TeX
+ distributions].
+ The latter is not yet supported under \SpecialChar LyX
+.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Perhaps you can take on the task\SpecialChar \ldots{}
+Perhaps you can take on the task\SpecialChar ldots
\end_layout
\end_layout
\begin_layout Chapter
-LyX Features needing Extra Software
+\SpecialChar LyX
+ Features needing Extra Software
\end_layout
\begin_layout Section
-Checking TeX
+Checking \SpecialChar TeX
+
\end_layout
\begin_layout Standard
\family typewriter
chktex
\family default
- is not yet available when you are using the LaTeX distribution MiKTeX.
+ is not yet available when you are using the \SpecialChar LaTeX
+ distribution MiK\SpecialChar TeX
+.
\end_layout
\end_inset
\begin_layout Standard
The
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
package is a program that was written by
\begin_inset Flex Noun
\end_inset
- in frustration because some constructs in LaTeX are sometimes non-intuitive,
+ in frustration because some constructs in \SpecialChar LaTeX
+ are sometimes non-intuitive,
and easy to forget.
- The program runs over your LaTeX file, checks the integrity of the file,
- and flags some common errors.
+ The program runs over your \SpecialChar LaTeX
+ file, checks the integrity of the file, and
+ flags some common errors.
In other technical words, it is
\family typewriter
lint
\family default
- for LaTeX.
+ for \SpecialChar LaTeX
+.
\end_layout
\begin_layout Standard
-Well, what is a syntax checker doing in LyX which is supposed to produce
- correct LaTeX anyways? The answer is simple: Just as
+Well, what is a syntax checker doing in \SpecialChar LyX
+ which is supposed to produce correct
+ \SpecialChar LaTeX
+ anyways? The answer is simple: Just as
\family typewriter
Lint
\family default
\emph default
checks for type-errors,
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
catches some common
\emph on
errors, in addition to the syntactical ones.
Specifically,
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
is capable of detecting several common errors, such as
\end_layout
\begin_inset Newline newline
\end_inset
-Use \SpecialChar \ldots{}
+Use \SpecialChar ldots
instead of ...
\end_layout
\end_layout
\begin_layout Standard
-and more \SpecialChar \ldots{}
+and more \SpecialChar ldots
It is an invaluable tool when you are
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
If you have the program installed, usage is as simple as choosing
\family sans
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Check
\begin_inset space ~
\end_inset
TeX
\family default
.
- This will make LyX generate a LaTeX file of your document, start
+ This will make \SpecialChar LyX
+ generate a \SpecialChar LaTeX
+ file of your document, start
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
- to check it, and then make LyX insert
+ to check it, and then make \SpecialChar LyX
+ insert
\begin_inset Quotes eld
\end_inset
with the warnings from
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
, if there were any.
The warnings will be placed close to the point of the mistake, and you
can quickly find them by using the
\family sans
-Navigate\SpecialChar \menuseparator
+Navigate\SpecialChar menuseparator
Error
\family default
menu item, or the shortcut key
Remember that there is a hidden layer between the document on screen and
the technical details in invoking
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
Sometimes, you'll find that
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
makes more noise than suits your mood.
Then you can choose not to use it, wait until your mood changes, or try
to customize
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
to get better along with you.
\end_layout
\begin_layout Standard
Although
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
\emph on
is
\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
+ very configurable and extensible, you should not expect to solve all problems
with
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
- in LyX this way.
- Since LyX has to generate a somewhat special LaTeX file to be able to match
- the line numbers from the
+ in \SpecialChar LyX
+ this way.
+ Since \SpecialChar LyX
+ has to generate a somewhat special \SpecialChar LaTeX
+ file to be able to match the
+ line numbers from the
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
output
\begin_inset Foot
\family default
by using
\family sans
-Edit\SpecialChar \menuseparator
-View
-\begin_inset space ~
-\end_inset
+Document\SpecialChar menuseparator
+\SpecialChar LaTeX
-LaTeX
\begin_inset space ~
\end_inset
\begin_layout Itemize
Fine tune the
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
invocation command line in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Output\SpecialChar \menuseparator
-LaTeX\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Output\SpecialChar menuseparator
+LaTeX\SpecialChar menuseparator
CheckTeX command
\end_layout
, or the global
\family sans
-ChkTeX
+Chk\SpecialChar TeX
+
\family default
installation configuration file (usually with the file
\family typewriter
\end_layout
\begin_layout Itemize
-Export your document as a raw LaTeX file using
+Export your document as a raw \SpecialChar LaTeX
+ file using
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+File\SpecialChar menuseparator
+Export\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\family default
and run
\family typewriter
\family default
manually on that.
Invoked in this way, it can be a hassle to find the corresponding place
- in the document inside LyX, but with a little patience, you should be able
+ in the document inside \SpecialChar LyX
+, but with a little patience, you should be able
to do it.
\end_layout
\begin_layout Standard
Notice that you should only use the options that enable and disable warnings,
- because LyX relies on some of the other command line parameters to be set
+ because \SpecialChar 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
\begin_layout Enumerate
\size small
-Math mode still on at end of LaTeX file.
+Math mode still on at end of \SpecialChar LaTeX
+ file.
\end_layout
\begin_layout Enumerate
\begin_layout Enumerate
\size small
-Could not execute LaTeX command.
+Could not execute \SpecialChar LaTeX
+ command.
\end_layout
\begin_layout Enumerate
\begin_layout Enumerate
\size small
-You ought to not use primitive TeX in LaTeX code.
+You ought to not use primitive \SpecialChar TeX
+ in \SpecialChar LaTeX
+ code.
\end_layout
\begin_layout Enumerate
\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
+In later versions of \SpecialChar LyX
+, we hope to provide a more complete interface to this
+ tool (and it's smaller cousin
\family typewriter
lacheck
\family default
\end_layout
\begin_layout Section
-Version Control in LyX
+Version Control in \SpecialChar LyX
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-LyX supports some of the most basic RCS/CVS/SVN commands.
+\SpecialChar LyX
+ supports some of the most basic RCS/CVS/SVN/GIT commands.
If you need something a bit more sophisticated you will have to do that
manually in a terminal.
\end_layout
using SVN instead.
A good place to start learning Subversion is SVN Book
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset href
\end_layout
\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- be familiar with RCS/CVS/SVN usage.
- The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package—no guarantees are made for older versions.
+Before you begin to use the version control features in \SpecialChar LyX
+, you should be
+ familiar with RCS/CVS/SVN/GIT usage.
+ The implementation in \SpecialChar LyX
+ assumes a recent version of the GNU RCS or CVS/SVN
+ package — no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
you can check them in the Messages pane if unsure.
Regular users of version control will appreciate VC toolbar, which can
be enabled via
\family sans
-View\SpecialChar \menuseparator
-Toolbars\SpecialChar \menuseparator
+View\SpecialChar menuseparator
+Toolbars\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
\begin_layout Standard
For introducing your own external commands consult vc-command in the manual
- of LyX functions.
+ of \SpecialChar LyX
+ functions.
+\end_layout
+
+\begin_layout Standard
+It is strongly recommended to store documents in uncompressed format if
+ using version control (uncheck
+\family sans
+Document\SpecialChar menuseparator
+Compressed
+\family default
+ if it is checked): Uncompressed LyX documents are text files and therefore
+ for merging two different versions by version control systems.
+ Compressed LyX documents are binary files, which cannot be merged by version
+ control systems.
\end_layout
\begin_layout Subsection
-RCS commands in LyX
+RCS commands in \SpecialChar LyX
+
\end_layout
\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
+The following sections describe the RCS commands supported by \SpecialChar LyX
+.
You can find them in the
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Control
\family default
submenu.
- LyX was tested against RCS 5.7/5.8
-\begin_inset Foot
-status open
-
-\begin_layout Plain Layout
-Note that old DOS / MS Windows builds (5.7) need to setup environment variables
- in order to work properly with LyX.
- In particular time zone (TZ) should be set and more importantly RCSINIT
- in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
- expects archive to be found in file.lyx,v within the original document directory.
- See also README shipped with Windows RCS binaries.
-\end_layout
-
-\end_inset
-
-.
+ \SpecialChar LyX
+ was tested against RCS 5.7/5.8.
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
This command registers your document with RCS (unless you are under the
- directory managed by CVS)\SpecialChar \@.
+ directory managed by CVS)\SpecialChar endofsentence
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 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
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
\begin_layout Standard
\begin_layout Subsubsection
+\family sans
+Copy
+\end_layout
+
+\begin_layout Standard
+This will create a copy of the current document.
+ Since RCS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+RCS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Copy
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ci -q -u
+\family typewriter
+-i
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
\family sans
Undo Last Checkin
\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
+ No changes are made to the document loaded into \SpecialChar LyX
+, but the last version
is removed from the master RCS file.
-
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-LyX supports RCS version number, author name, date and time of last commit.
+\SpecialChar LyX
+ supports RCS version number, author name, date and time of last commit.
All those are extracted from
\family typewriter
rlog -r <file-name>
\family default
.
- For other details see
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:VCS-Revision-Information"
+reference "subsec:VCS-Revision-Information"
\end_inset
\end_layout
\begin_layout Subsection
-CVS commands in LyX
+CVS commands in \SpecialChar LyX
+
\end_layout
\begin_layout Standard
-A subset of CVS operations is supported by LyX.
+A subset of CVS operations is supported by \SpecialChar LyX
+.
You can find the commands in the
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
If your documents are under revision control and others are using the same
repository problems arise when different changes to the same document at
the same location happen.
- Standard CVS repositories doesn't operate with a file locking mechanism.
+ Standard CVS repositories don't operate with a file locking mechanism.
This may be surprising, but conflicts only occur if people disagree on
the proper content of the same part of a document.
So, if co-workers are used to communicate regularly, these conflicts occur
first and the user starts editing after using a special command to make
the working copy writable.
When the changes are checked in the working copy returns to readonly state.
- With LyX one has to edit the
+ With \SpecialChar LyX
+ one has to edit the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-LyX tries to guess if you're using reserved or non-reserved checkouts.
+\SpecialChar LyX
+ tries to guess if you're using reserved or non-reserved checkouts.
If your working copy is readonly or it is writable and an additional copy
of your document exists in the CVS/Base sub-directory a reserved otherwise
a non-reserved checkout is assumed.
When a reserved checkout is detected you have to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
to make your working copy writable if it's readonly.
After doing so the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
in the menu.
And if it is under revision control, the
\family sans
-\bar under
-R
-\bar default
-egister
+Register
\family default
item is not visible.
file exists).
This means you have to create or checkout the archive by yourself using
external tools.
- (In case you forget that step LyX registers the document with RCS.)
+ (In case you forget that step \SpecialChar LyX
+ registers the document with RCS.)
\end_layout
\begin_layout Standard
After that changes are written to the repository.
In case you didn't change the document and a reserved checkout is detected
the reservation made on
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsubsection
-Update of the local directory checkout from repository
+
+\family sans
+Copy
\end_layout
\begin_layout Standard
-Once your documents gets more complex, containing sub-documents and pictures,
- including external
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.tex
+This will create a copy of the current document.
+ Since CVS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the copy is loaded instead of the original document.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
- files and so on using version control becomes more complicated.
- LyX supports updating the whole tree in which resides the document.
- This become especially useful once you cooperate with people which neither
- have detailed knowledge about CVS usage nor they have ambition to commit
- additional material to the repository.
- You have to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
- It's good practice anyway to store multipart documents in an extra directory.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
+commands:
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Update local directory from repository
-\end_layout
+\begin_inset Newline newline
\end_inset
- command updates the whole directory.
- If local changes are detected user is warned before update starts.
- In case of merge conflicts both versions of the conflicting document parts
- are placed in the final document.
- You have to review and correct the result of the merge.
- You'll find the conflicts enclosed in pairs of
+Copy
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<<<<<<<
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
->>>>>>>
\end_layout
\end_inset
- separated by
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-=======
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
-.
- The first part is your version as before the update operation with the
- document name prepended.
- The second one is the repository version with the version number after
- the sequence of
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
->
\end_layout
\end_inset
- signs.
-\end_layout
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q add
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document.
+ Since CVS does not support rename operations natively, the version history
+ is not preserved, the renamed document is added as a new file, and the
+ original document is deleted.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Rename
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q add
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q remove
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
+\end_layout
+
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
+\end_inset
+
+ files and so on using version control becomes more complicated.
+ \SpecialChar LyX
+ supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
+\end_inset
+
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
+\end_layout
+
+\end_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
+\end_layout
+
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
+\end_layout
+
+\end_inset
+
+ signs.
+\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
is shown in a browser.
\end_layout
+\begin_layout Subsubsection
+Revision info
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ supports CVS version number, author name, date and time of last commit.
+ All those are extracted from
+\family typewriter
+cvs log -r <file-name>
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:VCS-Revision-Information"
+
+\end_inset
+
+ for details.
+\end_layout
+
\begin_layout Subsection
-SVN commands in LyX
+SVN commands in \SpecialChar LyX
+
\end_layout
\begin_layout Standard
-SVN is now partially supported by LyX.
+SVN is now partially supported by \SpecialChar LyX
+.
You can find the commands in the
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
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.5 and 1.6
+ \SpecialChar LyX
+ was tested against SVN 1.5, 1.6, 1.7 and 1.8
\begin_inset Foot
status open
Most of the commands will work with 1.4 too, see
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:SVN-Repo-Update"
+reference "subsec:SVN-Repo-Update"
\end_inset
.
+ There seems to be currently unresolved permissions problem under SVN 1.8
+ with reverting changes when file is locked.
\end_layout
\end_inset
in the menu.
And if it is under revision control, the
\family sans
-\bar under
-R
-\bar default
-egister
+Register
\family default
item is not visible.
-
\end_layout
\begin_layout Standard
\family default
file exists).
This means you have to checkout the archive by yourself.
-
\end_layout
\begin_layout Standard
man svn
\family default
to understand the switches.
-
\end_layout
\begin_layout Subsubsection
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
\end_layout
\begin_layout Subsubsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:SVN-Repo-Update"
-\end_inset
-
-Update of the local directory checkout from repository
-\begin_inset Foot
-status collapsed
+\family sans
+Copy
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+This will create a copy of the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn copy -q
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn move -q
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
Note that this command will work only with subversion
\begin_inset Formula $\geqq1.5$
\end_inset
\end_inset
files and so on administration becomes more complicated.
- LyX now supports updating the whole tree in which resides the document
+ \SpecialChar LyX
+ now supports updating the whole tree in which resides the document
\begin_inset Foot
status collapsed
status collapsed
\begin_layout Plain Layout
-svn update --accept mine-full $path
+svn update –accept mine-full $path
\end_layout
\end_inset
\end_inset
.
- If 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
+ If this property is detected for a given document \SpecialChar 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 of file use in LyX:
+ This in particular means there are two different modes of file use in \SpecialChar LyX
+:
\end_layout
\begin_layout Itemize
The above mentioned automatic setting of write permissions of the .lyx file
can be set through
\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\SpecialChar \menuseparator
-
-\bar under
-T
-\bar default
-oggle locking property
+Control\SpecialChar menuseparator
+Toggle locking property
\family default
.
This command is active only when the file is not locked on the svn server
\begin_layout Subsubsection
\begin_inset CommandInset label
LatexCommand label
-name "sub:VCS-Revision-Information"
+name "subsec:VCS-Revision-Information"
\end_inset
\end_layout
\begin_layout Itemize
-LyX supports directly:
+\SpecialChar LyX
+ supports directly:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="2">
-<features rotate="0" tabularvalignment="middle">
-<column alignment="center" valignment="top" width="0">
-<column alignment="center" valignment="top" width="0">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
<row>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_inset space ~
\end_inset
---xml
+–xml
\begin_inset space ~
\end_inset
.
Supported flags are:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_deeper
\begin_layout Itemize
-Another---a hacking one---possibility is to use svn keywords
+Another—a hacking one—possibility is to use svn keywords
\begin_inset Foot
status collapsed
\end_inset
.
- In short -- you set file keywords property (e.g.
+ In short – you set file keywords property (e.g.
\family sans
svn propset svn:keywords 'Rev' file.lyx
\family default
-) and then paste keyword TeX code
+) and then paste keyword \SpecialChar TeX
+ code
\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
+This is an easy way how to ensure that \SpecialChar LyX
+ won't break the line in the middle
of keyword tag.
\end_layout
) 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
+ Firstly, the '$' character is used in \SpecialChar TeX
+ world for math equations, so any
+ occurence of math formula
\begin_inset Formula $Rev$
\end_inset
\begin_inset Formula $Rev:59$
\end_inset
- in your LyX document.
+ in your \SpecialChar 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.
+ this approach reliably or let \SpecialChar LyX
+ to support it directly.
\end_layout
\begin_layout Subsection
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.
+ —P.
A.
Rubin
\end_layout
\end_layout
\begin_layout Standard
-In addition to installing LyX, and having access to a Subversion repository,
+In addition to installing \SpecialChar 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
, 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.
+ Operations done outside \SpecialChar 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.
+ is what \SpecialChar LyX
+ itself will use.
\end_layout
\begin_layout Subsubsection
\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.
+Before a \SpecialChar 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.
+ This is done outside \SpecialChar 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.
\family default
in Windows Explorer, right click it, and select
\family sans
-TortoiseSVN\SpecialChar \menuseparator
+TortoiseSVN\SpecialChar menuseparator
Repo-browser
\family default
.
\backslash
new project
\family default
-, this time selecting SVN Checkout\SpecialChar \ldots{}
+, 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
\end_layout
\begin_layout Enumerate
-Create or open your document in LyX and click
+Create or open your document in \SpecialChar LyX
+ and click
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
-Control\SpecialChar \menuseparator
+Control\SpecialChar menuseparator
Register.
\family default
\begin_layout Standard
From this point onward, you should have full functionality in the
\family sans
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Windows is a rather troublesome task.
We will at least offer some hints how to setup the client side but prior
knowledge about ssh and the Windows command line is needed, also be prepared
- for a great deal of frustration\SpecialChar \ldots{}
+ for a great deal of frustration\SpecialChar ldots
\end_layout
status collapsed
\begin_layout Plain Layout
-svn --version
+svn –version
\end_layout
\end_inset
any password from you.
To keep things easy we will use only keys without any additional password
protection etc.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_layout
\begin_layout Standard
-When the collaborators are mixing Linux and Windows environments, LyX will
+When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
+ will
use different line endings inside the .lyx files.
- This is not a problem as far as LyX functionality is concerned, but the
- commit diffs will be huge and merge-conflicts prone.
+ This is not a problem as far as \SpecialChar LyX
+ functionality is concerned, but the commit
+ diffs will be huge and merge-conflicts prone.
Fortunately SVN itself knows
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Subsection
-Further tuning
-\end_layout
+GIT commands in \SpecialChar LyX
-\begin_layout Standard
-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
-As an example you can see how two TortoiseSVN commands could be integrated
- directly:
-\end_layout
+A minimal subset of GIT commands is now supported by \SpecialChar LyX
+.
+ You can find the commands in the
+\family sans
+File\SpecialChar menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\begin_layout Description
-Commit:
-\begin_inset Flex Code
-status collapsed
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ \SpecialChar LyX
+ was tested against GIT 1.7.
+\begin_inset Foot
+status open
\begin_layout Plain Layout
-vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+Windows users please note that you need to ensure that git is on the path.
+ This can be set from within \SpecialChar LyX
+ at
+\family sans
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+Paths\SpecialChar menuseparator
+PATH prefix
+\family default
+.
\end_layout
\end_inset
\end_layout
-\begin_layout Description
-Revert:
+\begin_layout Standard
+One big difference of GIT and the other supported version control systems
+ is the distributed nature of GIT: With traditional version control systems
+ there is one central server which hosts the repository.
+ Users commit their changes to the server, and get updates made by other
+ users from it.
+ With GIT, users commit to a local repository.
+ The local repository can be synchronized with one or more remote repositories
+ using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+pull
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Subsection
-Version control and Document comparison
-\end_layout
-
-\begin_layout Standard
-One of the typical uses of version control is to inspect the changes between
- revisions, usually by creating
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-diff
+push
\end_layout
\end_inset
- dumps.
- While this is useful for plain text files, it is much less useful in the
- case of LyX files, which have more a complicated structure.
- Hence we provide binding to the Document comparison feature.
- There are two ways of calling this feature - either by direct call of
+ GIT commands.
+ \SpecialChar LyX
+ does not interact in any way with remote GIT repositories.
+ It works exclusively with the local repository in a very similar way as
+ with a central CVS or SVN repository.
+ If you use remote GIT repositories you need to do the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-VC_COMPARE
+pull
\end_layout
\end_inset
- LyX function (for details see LyX functions manual) or by icon/menu item
-
-\begin_inset Flex MenuItem
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Compare with older revision...
+push
\end_layout
\end_inset
-.
- One can either compare two chosen revisions of the document or he can simply
- compare the current version of edited text with older revisions (where
- '
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-0
+ operations with your favourite GIT client.
\end_layout
-\end_inset
+\begin_layout Subsubsection
-' revisions back means comparison of the edited file with last commited
- revision).
-
+\family sans
+Register
\end_layout
\begin_layout Standard
-This feature is supported for SVN and RCS though due to the more complicated
- versioning scheme of RCS there is a constraint -- when addressing the revisions
- in dialog, numbers always point to the last number in RCS revision number,
- i.e.
- '35' in '1.2.35'.
+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 Section
-Literate Programming
+\begin_layout Standard
+This command registers in GIT your document ONLY in case you have already
+ the documents directory under GIT control (in particular
+\family typewriter
+.git/index
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
\end_layout
\begin_layout Standard
-Updated by
-\noun on
-Kayvan Sylvan
-\noun default
-(kayvan@sylvan.com)
-\noun on
-,
-\noun default
-original documentation written by
-\noun on
-Edmar Wienskoski Jr.
-
-\noun default
- (edmar-w-jr@technologist.com)
+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
+GIT command that is run:
+\family typewriter
+git add
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man git
+\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
+GIT command:
+\family typewriter
+git commit -q -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+GIT command:
+\family typewriter
+git checkout -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar menuseparator
+Save As
+\family default
+\SpecialChar ldots
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+GIT
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git mv
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the GIT document.
+ The output of
+\family typewriter
+git 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 Subsubsection
+Version Info
+\end_layout
+
+\begin_layout Standard
+\SpecialChar LyX
+ supports GIT hash number of the last commit to the file, author name, date
+ and time of last commit.
+ All those are extracted from
+\family typewriter
+git log -n 1 --pretty=format:%H%n%an%n%ai
+\family default
+.
+ Tree version information is obtained via
+\family typewriter
+git describe --abbrev --dirty --long
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:VCS-Revision-Information"
+
+\end_inset
+
+ for other details.
+\end_layout
+
+\begin_layout Subsection
+Further tuning
+\end_layout
+
+\begin_layout Standard
+With the recent addition of the vc-command function \SpecialChar LyX
+ power users are allowed
+ to create their own commands for revision control.
+\end_layout
+
+\begin_layout Standard
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
+\end_layout
+
+\begin_layout Description
+Commit:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Revert:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Version control and Document comparison
+\end_layout
+
+\begin_layout Standard
+One of the typical uses of version control is to inspect the changes between
+ revisions, usually by creating
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+diff
+\end_layout
+
+\end_inset
+
+ dumps.
+ While this is useful for plain text files, it is much less useful in the
+ case of \SpecialChar LyX
+ files, which have more a complicated structure.
+ Hence we provide binding to the Document comparison feature.
+ There are two ways of calling this feature - either by direct call of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+VC_COMPARE
+\end_layout
+
+\end_inset
+
+ \SpecialChar LyX
+ function (for details see \SpecialChar LyX
+ functions manual) or by icon/menu item
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Compare with older revision...
+\end_layout
+
+\end_inset
+
+.
+ One can either compare two chosen revisions of the document or he can simply
+ compare the current version of edited text with older revisions (where
+ '
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+' revisions back means comparison of the edited file with last commited
+ revision).
+
+\end_layout
+
+\begin_layout Standard
+This feature is supported for SVN and RCS though due to the more complicated
+ versioning scheme of RCS there is a constraint – when addressing the revisions
+ in dialog, numbers always point to the last number in RCS revision number,
+ i.e.
+ '35' in '1.2.35'.
+ We don't currently support GIT addressing of revisions, one can just compare
+ edited document with its revision X steps backs, where X is addressed as
+ HEAD~X.
+\end_layout
+
+\begin_layout Section
+Literate Programming
+\end_layout
+
+\begin_layout Standard
+Updated by
+\noun on
+Kayvan Sylvan
+\noun default
+(kayvan@sylvan.com)
+\noun on
+,
+\noun default
+original documentation written by
+\noun on
+Edmar Wienskoski Jr.
+
+\noun default
+ (edmar-w-jr@technologist.com)
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-The main purpose of this documentation is to show you how to use LyX for
- literate programming, where it is assumed that you are familiar with this
- programming technique, and know what
+The main purpose of this documentation is to show you how to use \SpecialChar LyX
+ for literate
+ programming, where it is assumed that you are familiar with this programming
+ technique, and know what
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-It is also assumed that you are familiar with LyX itself to a point that
- you are comfortable changing your LyX preferences, and X resources file.
- If that is not the case please refer to other LyX documentation to cover
- your specific needs.
+It is also assumed that you are familiar with \SpecialChar LyX
+ itself to a point that you
+ are comfortable changing your \SpecialChar LyX
+ preferences, and X resources file.
+ If that is not the case please refer to other \SpecialChar LyX
+ documentation to cover your
+ specific needs.
\end_layout
\begin_layout Subsection
\end_inset
E.
- Knuth during the development of his TeX typesetting software.
+ Knuth during the development of his \SpecialChar TeX
+ typesetting software.
\end_layout
\begin_layout Quotation
There are three distinguishing characteristics.
In order of importance, they are:
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_layout
\begin_layout Itemize
-It can generate the documentation either in LaTeX or HTML.
+It can generate the documentation either in \SpecialChar LaTeX
+ or HTML.
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Subsection
-LyX and Literate Programming with Noweb
+\SpecialChar LyX
+ and Literate Programming with Noweb
\end_layout
\begin_layout Standard
-The LyX support for Literate Programming is provided by using the generic
- LyX converters mechanism.
+The \SpecialChar LyX
+ support for Literate Programming is provided by using the generic \SpecialChar LyX
+
+ converters mechanism.
This support is provided in a
\begin_inset Quotes eld
\end_inset
\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.
+you will be able to use this new \SpecialChar LyX
+ feature with some other literate programming
+ tool of your choice by just changing your \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-If you have installed Noweb and LyX successfully, whenever you open a new
- document, after you have chosen its document class, use the Document->Settings
- menu to add the
+If you have installed Noweb and \SpecialChar LyX
+ successfully, whenever you open a new document,
+ after you have chosen its document class, use the Document->Settings menu
+ to add the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-LyX enables you to write code with a layout named
+\SpecialChar LyX
+ enables you to write code with a layout named
\begin_inset Flex Noun
status collapsed
\begin_inset space \space{}
\end_inset
-LyX should be prevented from making any special interpretation of what has
+\SpecialChar LyX
+ should be prevented from making any special interpretation of what has
been written.
This is also handled by
\begin_inset Flex Noun
class, and with some code and text on it.
How do I print it? The answer is simple, you select
\family sans
-View\SpecialChar \menuseparator
+View\SpecialChar menuseparator
DVI,
\family default
etc.
\end_layout
\begin_layout Standard
-To help orientate you, I will now explain what happens inside LyX:
+To help orientate you, I will now explain what happens inside \SpecialChar LyX
+:
\end_layout
\begin_layout Enumerate
When the
\family sans
-Update\SpecialChar \menuseparator
+Update\SpecialChar menuseparator
DVI
\family default
- menu option is chosen, a LaTeX file is generated.
+ menu option is chosen, a \SpecialChar LaTeX
+ file is generated.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_deeper
\begin_layout Enumerate
Note that the only difference so far is in the name of the file, no special
- processing is required by LyX.
+ processing is required by \SpecialChar LyX
+.
Given that you formatted the code using the
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Enumerate
-If the document is of any literate class LyX will then use the internal
- LyX to Noweb converter, followed by the Noweb to LaTeX converter
+If the document is of any literate class \SpecialChar LyX
+ will then use the internal \SpecialChar LyX
+ to
+ Noweb converter, followed by the Noweb to \SpecialChar LaTeX
+ converter
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
The converters are defined in the
\family sans
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\family default
panel, under the
\end_inset
- to generate the LaTeX file.
+ to generate the \SpecialChar LaTeX
+ file.
+\begin_inset Separator parbreak
+\end_inset
+
+
\end_layout
\begin_deeper
\end_deeper
\begin_layout Enumerate
-Finally, LaTeX is invoked and the regular post processing continues as in
- a plain document.
+Finally, \SpecialChar LaTeX
+ is invoked and the regular post processing continues as in a plain
+ document.
\end_layout
\begin_layout Standard
\begin_layout Standard
When the build menu option is chosen or the corresponding button in the
- toolbar is pressed, a LaTeX file is generated just like step 1 above.
- Next, LyX invokes the
+ toolbar is pressed, a \SpecialChar LaTeX
+ file is generated just like step 1 above.
+ Next, \SpecialChar LyX
+ invokes the
\family typewriter
Noweb->Program
\family default
\begin_layout Enumerate
The error log parser.
This is a program whose sole purpose is to rewrite error messages in a
- format that LyX understands.
- This makes it possible for LyX to place error boxes in the right places
- in the file buffer.
+ format that \SpecialChar LyX
+ understands.
+ This makes it possible for \SpecialChar LyX
+ to place error boxes in the right places in
+ the file buffer.
\end_layout
\begin_layout Standard
\begin_inset Newline newline
\end_inset
-This basically means that LyX will call
+This basically means that \SpecialChar LyX
+ will call
\begin_inset Quotes eld
\end_inset
\end_inset
(a program or script) with the name of the Noweb file (normally a file
- in the LyX temp directory) and the directory path of the original LyX file.
+ in the \SpecialChar LyX
+ temp directory) and the directory path of the original \SpecialChar LyX
+ file.
\end_layout
\end_layout
\begin_layout Standard
-The build will normally take place in LyX's temporary directory, so the
- files produced by the conversion will be in that directory.
- LyX will copy out what it regards as the `main' file, but the
+The build will normally take place in \SpecialChar LyX
+'s temporary directory, so the files
+ produced by the conversion will be in that directory.
+ \SpecialChar LyX
+ will copy out what it regards as the `main' file, but the
\family typewriter
Noweb->Program
\family default
conversion may produce several files, and so most of these would then be
- deleted when LyX was closed.
+ deleted when \SpecialChar LyX
+ was closed.
This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
the build-script chunk can place the generated files in that location.
\end_layout
\end_layout
\begin_layout Standard
-The last piece of the integration between LyX and noweb is the
+The last piece of the integration between \SpecialChar LyX
+ and noweb is the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout LyX-Code
-#!/bin/shif [ -z "${NOWEB_SOURCE}" ] then
-\end_layout
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-NOWEB_SOURCE=myfile.nwfi[...
-\end_layout
+if [ -z "${NOWEB_SOURCE}" ]
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-code to extract files
+then
\end_layout
\begin_layout LyX-Code
-...
+NOWEB_SOURCE=myfile.nw
+\begin_inset Newline newline
+\end_inset
+
+fi
+\begin_inset Newline newline
+\end_inset
+
+[...
+ code to extract files ...
use NOWEB_OUTPUT_DIR here ...]
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
[...
- code to compile files ...]@
+ code to compile files ...]
+\begin_inset Newline newline
+\end_inset
+
+@
\end_layout
\begin_layout Standard
\emph default
Interestingly, these three files show off the language-indepence of the
- LyX literate programming support since they are written in Python, C and
- Perl respectively.
+ \SpecialChar LyX
+ literate programming support since they are written in Python, C and Perl
+ respectively.
\end_layout
\begin_layout Subsubsection
-Configuring LyX
+Configuring \SpecialChar LyX
+
\end_layout
\begin_layout Standard
All the Literate Programming support is configured by the
\family sans
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\family default
panel in the
.nw
\family default
.
- This tells LyX to create a file with a
+ This tells \SpecialChar LyX
+ to create a file with a
\family typewriter
.nw
\family default
\family default
->
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\family default
This converter performs the
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-There is also a new function implemented in the LyX server, the
+There is also a new function implemented in the \SpecialChar LyX
+ server, the
\begin_inset Quotes eld
\end_inset
It happens that you can define the editor command line invocation in ddd
by accessing the
\family sans
-Edit\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
+Edit\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
Helpers
\family default
dialog and changing the "Edit Sources" entry.
\end_layout
\begin_layout Standard
-I take advantage of the newly created LyX server function and this ddd feature,
+I take advantage of the newly created \SpecialChar LyX
+ server function and this ddd feature,
and set
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
With this, whenever you are using ddd and find a point in the program that
you want to edit, you just press shift-ctrl-V (in the ddd window), and
- ddd will forward this information to LyX through the LyX server and then
- the LyX window will show the same file with the cursor at the same position
- ddd was pointing to.
+ ddd will forward this information to \SpecialChar LyX
+ through the \SpecialChar LyX
+ server and then the
+ \SpecialChar LyX
+ window will show the same file with the cursor at the same position ddd
+ was pointing to.
No more guessing or long scrolling to locate a point in the program back
from debugging !
\end_layout
\begin_layout Standard
-Note however that you must enable the LyX server to get this feature working
+Note however that you must enable the \SpecialChar LyX
+ server to get this feature working
(it is disabled by default).
You can enable it in
\family sans
\family default
) by entering in the
\family sans
-LyXserver pipe
+\SpecialChar LyX
+server pipe
\family default
a path like
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-Read the LyX server documentation in the
+Read the \SpecialChar LyX
+ server documentation in the
\emph on
Customization Manual
\emph default
\end_layout
\begin_layout Standard
-There are six new buttons that can be added to your LyX toolbar.
+There are six new buttons that can be added to your \SpecialChar LyX
+ toolbar.
Five of these buttons are short cuts to layout styles:
\family sans
Standard
\family default
,
\family sans
-LaTeX
+\SpecialChar LaTeX
+
\family default
,
\family sans
-LyX-Code
+\SpecialChar LyX
+-Code
\family default
, and
\family sans
\end_layout
\begin_layout Standard
-LyX has a range of buttons that are available for tool bar customization.
+\SpecialChar LyX
+ has a range of buttons that are available for tool bar customization.
In my toolbar I like to combine the six short cuts above with two more:
One for
\family sans
-View
+Document
\family default
-\SpecialChar \menuseparator
+\SpecialChar menuseparator
\family sans
Update
\family default
-\SpecialChar \menuseparator
+\SpecialChar menuseparator
\family sans
DVI
\family default
and the other for
\family sans
-View\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+View\SpecialChar menuseparator
DVI
\family default
File menu entries.
\end_layout
\begin_layout LyX-Code
- Icon "layout LaTeX"
+ Icon "layout \SpecialChar LaTeX
+"
\end_layout
\begin_layout LyX-Code
- Icon "layout LyX-Code"
+ Icon "layout \SpecialChar LyX
+-Code"
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-There are a number of colors in LyX that can be customized in
+There are a number of colors in \SpecialChar LyX
+ that can be customized in
\family sans
Preferences
\family default
.
- One of the things that bothers people is the LaTeX font color.
- The default color is red, since the chunks uses LaTeX font, and there is
- a lot of chunks in literate documents, you may get tired of seeing everything
+ One of the things that bothers people is the \SpecialChar LaTeX
+ font color.
+ The default color is red, since the chunks uses \SpecialChar LaTeX
+ font, and there is a lot
+ of chunks in literate documents, you may get tired of seeing everything
in red.
You can change it by going to the tabs
\family sans
\end_layout
\begin_layout Subsection
-LyX and knitr/Sweave
+\SpecialChar LyX
+ and knitr/Sweave
\end_layout
\begin_layout Standard
\emph default
example file and in the Sweave manual (menu
\family sans
-Help\SpecialChar \menuseparator
+Help\SpecialChar menuseparator
Specific Manuals
\family default
).
\end_layout
\begin_layout Standard
-You can do everything with LyX that you can do with LaTeX.
- However, LyX cannot support every LaTeX feature directly.
- But you can always use TeX Code.
+You can do everything with \SpecialChar LyX
+ that you can do with \SpecialChar LaTeX
+.
+ However, \SpecialChar LyX
+ cannot support every \SpecialChar LaTeX
+ feature directly.
+ But you can always use \SpecialChar TeX
+ Code.
This chapter shows you some more special things you might want to use.
For other special things you can do with figures, tables, floats, boxes
and notes, have a look at the
\family default
(menu
\family sans
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Modules
\family default
-) and must have the LaTeX-package
+) and must have the \SpecialChar LaTeX
+-package
\series bold
multicol
\series default
\begin_inset space ~
\end_inset
-columns in your text, use the style
+columns in your text, insert a multicolumn inset via the menu
\family sans
-Begin Multiple Columns
-\family default
- where the columns should start.
- The content of the style is the number of the columns, so in this case
- use a
-\begin_inset Quotes eld
+Insert\SpecialChar menuseparator
+Custom
+\begin_inset space ~
\end_inset
-2
-\begin_inset Quotes erd
+Insets\SpecialChar menuseparator
+Multiple
+\begin_inset space ~
\end_inset
-.
- At the point where the columns should end use the style
-\family sans
-End Multiple Columns
+Columns
\family default
- and keep it empty.
+ where the columns should start.
+ Write all text that should be printed in 2
+\begin_inset space ~
+\end_inset
+
+columns into this inset.
\end_layout
\begin_layout Standard
Here is an example:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
\noindent
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\noindent
\series bold
\size small
\begin_inset Newline newline
\end_inset
-by
-\noun on
-Sir Arthur Conan Doyle
+by Sir Arthur Conan Doyle
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
It was in the spring of the year 1894 that all London was interested, and
only withdrawn upon the third of last month.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
+To get 3 or more columns, set the cursor into the multicolumn inset and
+ use the menu
+\family sans
+Insert\SpecialChar menuseparator
+Number
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+
+Columns
+\family default
+.
+ The number of the desired columns is written into that inset (for 3
+\begin_inset space ~
+\end_inset
+
+columns write
+\begin_inset Quotes eld
+\end_inset
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
Here is an example with 3
\begin_inset space ~
\end_inset
columns:
\end_layout
-\begin_layout Begin Multiple Columns
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
3
\end_layout
-\begin_layout Standard
+\end_inset
-\size footnotesize
It can be imagined that my close intimacy with Sherlock Holmes had interested
me deeply in crime, and that after his disappearance I never failed to
read with care the various problems which came before the public.
as they were known to the public at the conclusion of the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
You can also have columns inside columns:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size footnotesize
The Honourable Ronald Adair was the second son of the Earl of Maynooth,
at 427 Park Lane.
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
+\begin_layout Plain Layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
The youth moved in the best society–had, so far as was known, no enemies
on the night of March 30, 1894.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
Ronald Adair was fond of cards–playing continually, but never for such stakes
So much for his recent history as it came out at the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
For more features of multiple columns, have a look at the documentation
- of the LaTeX-package
+ of the \SpecialChar LaTeX
+-package
\series bold
multicol
\series default
\end_layout
\begin_layout Standard
-To add a preface text for multiple columns, add the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-}[
-\end_layout
-
-\begin_layout Standard
-as TeX Code behind the number of columns in the
+To add a preface text for multiple columns, set the cursor into the multicolumn
+ inset and use the menu
\family sans
- Begin Multiple Columns
+Insert\SpecialChar menuseparator
+Preface
\family default
- style.
- Behind the command follows the preface text.
- At the end of the style use the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-]{
-\end_layout
+.
+ Write your preface text into that inset.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-as TeX Code.
- An example with some preface text:
+This is an example with some preface text:
\end_layout
\begin_layout Standard
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
\begin_layout Plain Layout
-
-}[
-\end_layout
-
-\end_inset
-
-And the story continues and continues and continues and continues\SpecialChar \ldots{}
-
-\begin_inset ERT
-status collapsed
+\begin_inset Argument 2
+status open
\begin_layout Plain Layout
+And the story continues and continues and continues and continues\SpecialChar ldots
-]{
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
On the evening of the crime, he returned from the club exactly at ten.
His mother and sister were out spending the evening with a relation.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
You can also use a section heading as the preface if you use a section command
- as TeX Code behind the first TeX Code.
+ as \SpecialChar TeX
+ Code.
For example the command
\end_layout
In this example the preface is a subsubsection:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
-}[
-\end_layout
-
-\end_inset
-
-
+\begin_layout Plain Layout
\begin_inset ERT
status collapsed
\end_inset
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-]{
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
A minute examination of the circumstances served only to make the case more
complex.
No one had heard a shot.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
-If there is less vertical space left on the page at the beginning of the
- multiple columns than needed for 6
+If there is less vertical space than 6
\begin_inset space ~
\end_inset
-text lines, a page break will be inserted before the multiple columns.
+text lines is left on the page at the beginning of the multiple columns,
+ a page break will be inserted before the multiple columns.
Depending on the number of lines of the preface text, you might want to
- change this value.
- It is determined by inserting the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-][number
-\backslash
-baselineskip
-\end_layout
-
-\begin_layout Standard
-as TeX Code behind the preface definition but before the final
-\series bold
-]{
-\series default
- command.
-
-\emph on
-number
-\emph default
- is hereby the number of text lines.
- In this example the space is set to 7
+ change this space.
+ This is done by setting the cursor into the mulitcolumn inset behind the
+ preface (if there is any) and using the menu
+\family sans
+Insert\SpecialChar menuseparator
+Space
\begin_inset space ~
\end_inset
-text lines:
-\end_layout
-
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-}[
-\end_layout
-
+Before
+\begin_inset space ~
\end_inset
+Page
+\begin_inset space ~
+\end_inset
-\begin_inset ERT
-status collapsed
+Break
+\family default
+.
+ Insert into that inset the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
+g.
+\begin_inset space \space{}
+\end_inset
-\backslash
-subsubsection{
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+5cm
+\begin_inset Quotes erd
\end_inset
-This is the sectioning command
+.
\begin_inset Newline newline
\end_inset
-as a preface and
-\begin_inset Newline newline
+In this example the space is set to 7
+\begin_inset space ~
+\end_inset
+
+text lines by using
+\begin_inset Quotes eld
\end_inset
-with multiple text lines
-\begin_inset ERT
-status collapsed
+7
+\backslash
+baselineskip
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+ (where the command
+\series bold
-}
+\backslash
+baselineskip
+\series default
+ needs to be inserted as \SpecialChar TeX
+ code):
\end_layout
-\end_inset
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+\begin_layout Plain Layout
+\begin_inset Argument 3
+status open
+\begin_layout Plain Layout
+7
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-][7
+
\backslash
baselineskip
\end_layout
\end_inset
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-]{
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
On the evening of the crime, he returned from the club exactly at ten.
His mother and sister were out spending the evening with a relation.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_layout
\begin_layout Standard
-in TeX Code changes its value to 3
+in \SpecialChar TeX
+ Code changes its value to 3
\begin_inset space \thinspace{}
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
All day I turned these facts over in my mind, endeavouring to hit upon some
me, and I knocked down several books which he was carrying.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_inset
+\end_layout
+
+\begin_layout Subsubsection
+Column Breaks
+\end_layout
+
+\begin_layout Standard
+A column break can be forced by inserting the command
+\series bold
+
+\backslash
+columnbreak{}
+\series default
+ as \SpecialChar TeX
+ Code to that position in the text where the column should be broken.
+ Note that this leads in most cases to whitespace in the text.
+\begin_inset Newline newline
+\end_inset
+
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+ AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+columnbreak{}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+–a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\series bold
\backslash
-columnsep
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
+\end_inset
+
+cm:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+My observations of No.
+\begin_inset space \space{}
+\end_inset
+
+427 Park Lane did little to clear up the problem in which I was interested.
+ The house was separated from the street by a low wall and railing, the
+ whole not more than five feet high.
+ It was perfectly easy, therefore, for anyone to get into the garden, but
+ the window was entirely inaccessible, since there was no water pipe or
+ anything which could help the most active man to climb it.
+ More puzzled than ever, I retraced my steps to Kensington.
+ I had not been in my study five minutes when the maid entered to say that
+ a person desired to see me.
+ To my astonishment it was none other than my strange old book collector,
+ his sharp, wizened face peering out from a frame of white hair, and his
+ precious volumes, a dozen of them at least, wedged under his right arm.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{10pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Vertical Lines
+\end_layout
+
+\begin_layout Standard
+Between the columns a rule with a width of the length
+\series bold
+
+\backslash
+columnseprule
\series default
- is set to 3
+ is placed.
+ If this rule width is set to 0
\begin_inset space \thinspace{}
\end_inset
-cm:
+pt (this is the default), the rule is suppressed.
+ In the following example the rule is 2
+\begin_inset space \thinspace{}
+\end_inset
+
+pt wide:
\end_layout
\begin_layout Standard
\backslash
setlength{
\backslash
-columnsep}{3cm}
+columnseprule}{2pt}
\end_layout
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
-My observations of No.
-\begin_inset space \space{}
+\begin_inset Quotes eld
\end_inset
-427 Park Lane did little to clear up the problem in which I was interested.
- The house was separated from the street by a low wall and railing, the
- whole not more than five feet high.
- It was perfectly easy, therefore, for anyone to get into the garden, but
- the window was entirely inaccessible, since there was no water pipe or
- anything which could help the most active man to climb it.
- More puzzled than ever, I retraced my steps to Kensington.
- I had not been in my study five minutes when the maid entered to say that
- a person desired to see me.
- To my astonishment it was none other than my strange old book collector,
- his sharp, wizened face peering out from a frame of white hair, and his
- precious volumes, a dozen of them at least, wedged under his right arm.
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
\end_layout
-\begin_layout End Multiple Columns
+\begin_layout Plain Layout
+\size small
+I acknowledged that I was.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
\begin_layout Plain Layout
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
+\begin_inset Quotes erd
+\end_inset
+
-\backslash
-setlength{
-\backslash
-columnsep}{10pt}
\end_layout
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
\end_inset
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Note Note
-status collapsed
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
\begin_layout Plain Layout
-go back to the default
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
+
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+–a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
\end_inset
\end_layout
-\begin_layout Subsubsection
-Vertical Lines
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
-Between the columns a rule with a width of the length
+The rule can be colored by redefining the command
\series bold
\backslash
-columnseprule
+columnseprulecolor
\series default
- is placed.
- If this rule width is set to 0
-\begin_inset space \thinspace{}
+.
+ This is done by inserting the command
+\begin_inset Newline newline
\end_inset
-pt (this is the default), the rule is suppressed.
- In the following example the line is 2
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+as \SpecialChar TeX
+ Code before the multicolumn inset.
+ Replace
+\series bold
+red
+\series default
+ in this command by a color of your choice.
+ You can use all pre- and self-defined colors.
+ See the
+\emph on
+EmbeddedObjects
+\emph default
+ manual, section
+\emph on
+Colored
+\begin_inset space ~
+\end_inset
+
+Tables
+\emph default
+ for more information about pre- and self-defined colors.
+ To go back to the default color insert the command
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+Here is the example with a cyan rule and 1
\begin_inset space \thinspace{}
\end_inset
-pt wide:
+cm column separation:
\end_layout
\begin_layout Standard
\backslash
setlength{
\backslash
-columnseprule}{2pt}
+columnsep}{1cm}
\end_layout
-\end_inset
+\begin_layout Plain Layout
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{cyan}}
\end_layout
-\begin_layout Begin Multiple Columns
-2
+\end_inset
+
+
\end_layout
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
said he, in a strange, croaking voice.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
I acknowledged that I was.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\noun on
The Holy War
\noun default
---a bargain, every one of them.
+–a bargain, every one of them.
With five volumes you could just fill that gap on that second shelf.
It looks untidy, does it not, sir?
\begin_inset Quotes erd
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
columnseprule}{0pt}
\end_layout
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\end_layout
+
\end_inset
\end_inset
-\end_layout
-
-\begin_layout Standard
-\begin_inset Newpage newpage
-\end_inset
-
-
\end_layout
\begin_layout Section
\begin_layout Standard
\noindent
-LaTeX as well as any other text processor uses by default rectangular paragraphs.
+\SpecialChar LaTeX
+ as well as any other text processor uses by default rectangular paragraphs.
For special cases like for example posters, invitation cards or poems you
can modify the paragraph shape to one of your choice.
- This can be done by using the LaTeX-package
+ This can be done by using the \SpecialChar LaTeX
+-package
\series bold
shapepar
\series default
\begin_layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="13" columns="3">
-<features rotate="0" booktabs="true" islongtable="true" longtabularalignment="center">
+<features booktabs="true" islongtable="true" longtabularalignment="center">
<column alignment="center" valignment="middle" width="16col%">
<column alignment="center" valignment="middle" width="40col%">
<column alignment="center" valignment="middle" width="35col%">
\begin_inset Text
\begin_layout Plain Layout
-TeX
+\SpecialChar TeX
+
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-The TeX logo
+The \SpecialChar TeX
+ logo
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-To use a shape for your paragraph, simply select it in LyX's pull-down box
+To use a shape for your paragraph, simply select it in \SpecialChar LyX
+'s pull-down box
for environments in the toolbar.
\end_layout
\family default
shape are fragile, meaning that the calculation of their size can fail,
depending on the amount of text.
- You will then get the LaTeX error
+ You will then get the \SpecialChar LaTeX
+ error
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-For shapes with tips you will maybe see that LaTeX's hyphenation routine
- fails for text in the tips.
+For shapes with tips you will maybe see that \SpecialChar LaTeX
+'s hyphenation routine fails
+ for text in the tips.
Therefore it is often necessary to add hyphenation points
\family sans
(
\end_layout
\begin_layout Standard
-Shapepar paragraphs are always placed on the page that their left border
- touches the left page margin.
+Shapepar paragraphs are either always centered or placed on the page so
+ that their left border touches the left page margin.
You can therefore not use the paragraph dialog to align such paragraphs.
A solution is to put the paragraph into a minipage or parbox and align
the box.
Because if it is too wide and you center the box, the paragraph is not
centered too because it sticks at the left side of the box.
So you might have to play a bit with the width until it fits.
- Here are two triangular paragraphs, the first one is not aligned, the second
- one is centered:
+ Here are two heart-shaped paragraphs, the first one is not aligned, the
+ second one is right-aligned:
\end_layout
\begin_layout Standard
\end_layout
-\begin_layout Triangle up
+\begin_layout Heart
+\noindent
\lang latin
-Lo\SpecialChar \-
+Lo\SpecialChar softhyphen
rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
voluptua.
\end_layout
\begin_layout Standard
-\align center
+\noindent
+\align right
\begin_inset Box Frameless
position "t"
hor_pos "c"
special "none"
height "1in"
height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
status open
-\begin_layout Triangle up
+\begin_layout Heart
+\noindent
\lang latin
-Lo\SpecialChar \-
+Lo\SpecialChar softhyphen
rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
voluptua.
\family default
go to the menu
\family sans
-Te
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-X/LaT
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+TeX/LaTeX\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Set Normal Size
\family default
and select the font size you are using in your document.
\begin_layout Enumerate
Use the menu
\family sans
-Te
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-X/LaT
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX\SpecialChar \menuseparator
+TeX/LaTeX\SpecialChar menuseparator
Shapepar
\family default
to export the shape to coordinates.
\end_layout
\begin_layout Standard
-The coordinates are written into a TeX-file.
- To use it for your LyX document
+The coordinates are written into a \SpecialChar TeX
+ file.
+ To use it for your \SpecialChar LyX
+ document
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Enumerate
-Open in LyX the menu
+Open in \SpecialChar LyX
+ the menu
\family sans
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
+Insert\SpecialChar menuseparator
+File\SpecialChar menuseparator
Child
\begin_inset space ~
\end_inset
\end_inset
-Documentation of the LaTeX-package
+Documentation of the \SpecialChar LaTeX
+-package
\begin_inset CommandInset href
LatexCommand href
name "multicol"
\end_inset
-Documentation of the LaTeX-package
+Documentation of the \SpecialChar LaTeX
+-package
\begin_inset CommandInset href
LatexCommand href
name "shapepar"
projects / lyx.git / blobdiff