From: John R Hudson Date: Wed, 14 Dec 2022 09:19:48 +0000 (+0000) Subject: Move Slides (SliTeX) section in Additional.lyx to Chapter 3 Document classes X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=0d50b62f73ec3fa1c33b3bc59dd180de14511f64;p=features.git Move Slides (SliTeX) section in Additional.lyx to Chapter 3 Document classes --- diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx index 01e5f5ab5e..f836af0c6c 100644 --- a/lib/doc/Additional.lyx +++ b/lib/doc/Additional.lyx @@ -8940,78 +8940,28 @@ foils class. \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439661 -Reports -\end_layout - \begin_layout Subsection +Slides [aka +\noun on +Sli\SpecialChar TeX -\change_inserted 564990737 1670439661 -report -\end_layout - -\begin_layout Standard - -\change_inserted 564990737 1670439661 -The document class -\family sans -report -\family default - provides the -\family sans -report.cls -\family default - document class for preparing reports. - Like the -\family sans -book -\family default - document class, this provides parts, chapters and sections but does not - provide the paragraph styles needed for a book; like the -\family sans -article -\family default - document class, it provides the abstract paragraph style. - In two-sided mode, it does not start a new chapter on the right hand page. -\end_layout - -\begin_layout Standard - -\change_inserted 564990737 1670439674 -The remaining -\family sans -report -\family default - document classes are described in the Collections (section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Collections" +\noun default +] +\begin_inset CommandInset label +LatexCommand label +name "sec:slitex" \end_inset -). -\end_layout - -\begin_layout Section - -\change_inserted 564990737 1670439674 -Scripts (drama) -\end_layout -\begin_layout Subsection -Broadway \end_layout \begin_layout Standard by -\shape smallcaps -Garst Reese +\noun on +John Weiss +\noun default + \end_layout \begin_layout Subsubsection @@ -9019,1087 +8969,1032 @@ Introduction \end_layout \begin_layout Standard -Broadway is for writing plays. - The format is more decorative than Hollywood, and much less standardized. - This format should be suitable for workshops. -\end_layout +This section describes how to use \SpecialChar LyX + to make slides for overhead projectors. + There are two document classes that can do this: the default slides class + and the +\family sans +Foil\SpecialChar TeX -\begin_layout Subsubsection -Special problems +\family default + slides class. + This section documents the former. \end_layout \begin_layout Standard -The same as in Hollywood. +I'm going to say this again, nice and clear, so that there's no misunderstanding +: \end_layout -\begin_layout Subsubsection -Special features +\begin_layout Standard +\begin_inset VSpace bigskip +\end_inset + + \end_layout \begin_layout Standard -Insert the +\align center + +\size large +This section documents the class +\begin_inset Quotes eld +\end_inset + + \family sans -Speaker +slides (default) \family default - names as labels then cross-reference the label to insert the name. - The cross-reference dialog will show the current cast of characters. -\end_layout -\begin_layout Subsubsection -Paper size and Margins +\begin_inset Quotes erd +\end_inset + + +\emph on +only. \end_layout \begin_layout Standard -USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in -\end_layout +\begin_inset VSpace bigskip +\end_inset + -\begin_layout Subsubsection -Environments \end_layout \begin_layout Standard -The following environments are available. - You can use broadway.bind to get the bind keys shown at the right. -\end_layout +If you're looking for the documentation for +\begin_inset Quotes eld +\end_inset -\begin_layout Itemize \family sans -Standard -\begin_inset Newline newline +slides (Foil\SpecialChar TeX +) +\family default + +\begin_inset Quotes erd \end_inset +, check out section +\begin_inset space ~ +\end_inset -\family default -You should not have to use this, but it is here for anything that does not - fit otherwise. -\end_layout -\begin_layout Itemize +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:foiltex" -\family sans -Narrative -\begin_inset space \hfill{} \end_inset -M-z n -\begin_inset Newline newline +. + The +\family sans +foils +\family default + class [ +\begin_inset Quotes eld \end_inset +\family sans +slides (Foil\SpecialChar TeX +) \family default -Used to describe stage setting and the action. - First use of speaker names in all CAPs. -\end_layout -\begin_layout Itemize +\begin_inset Quotes erd +\end_inset +] is actually somewhat better than the default \family sans -ACT -\begin_inset space \hfill{} -\end_inset +slides +\family default + class, +\begin_inset Foot +status collapsed -M-z a -\begin_inset Newline newline -\end_inset +\begin_layout Plain Layout +\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_inset -\family default -Automatically numbered. - On screen it will be arabic, but will print as Roman. + which this section documents. \end_layout -\begin_layout Itemize +\begin_layout Standard +This class is the \SpecialChar LaTeX2e + improvement of the old +\noun on +Sli\SpecialChar TeX -\family sans -ACT* -\begin_inset space \hfill{} +\noun default + package. + Every \SpecialChar LaTeX2e + distribution includes this class [which I'll just refer to as +\begin_inset Quotes eld \end_inset -M-z S at -\begin_inset Newline newline -\end_inset +\family sans +slides +\family default + +\begin_inset Quotes erd +\end_inset + from now on], so you're bound to have it. + As I noted earlier, there are other classes, such as +\family sans +foils \family default -Subtitle for +, which also produce slides for overhead projectors and do a better job + at it. + However, there are some things which \family sans -ACT. - +slides \family default - It is just centered text. + can do which the others can't, such as generate overlays. + Read on to learn more! \end_layout -\begin_layout Itemize - -\family sans -SCENE -\begin_inset space \hfill{} -\end_inset +\begin_layout Subsubsection +Getting Started +\begin_inset CommandInset label +LatexCommand label +name "sec:slidesetup" -M-z S-S -\begin_inset Newline newline \end_inset -\family default -Not automatically numbered. - You supply the number. - This is because I couldn't figure out how. \end_layout -\begin_layout Itemize +\begin_layout Standard +Obviously, to use this document class, you need to select +\begin_inset Quotes eld +\end_inset + \family sans -AT_RISE: -\begin_inset space \hfill{} -\end_inset +slides (default) +\family default -M-z S-R -\begin_inset Newline newline +\begin_inset Quotes erd \end_inset - + from the class list in the +\family sans +Document\SpecialChar menuseparator +Settings \family default -A special case of Narrative to describe the setting and action as the curtain - rises. + dialog. + There are some other special things you should know about this class: \end_layout \begin_layout Itemize - +Don't bother changing the options \family sans -Speaker -\begin_inset space \hfill{} -\end_inset - -M-z s -\begin_inset Newline newline -\end_inset - - +Sides and Columns \family default -The speaker's (actor's) title, centered in all CAPS. +. + They're not supported by the +\family sans +slides +\family default + class, anyways. \end_layout \begin_layout Itemize - +The option \family sans -Parenthetical -\begin_inset space \hfill{} +Page +\begin_inset space ~ \end_inset -M-z p -\begin_inset Newline newline -\end_inset +style +\family default + behaves a bit differently for this class. + The possible choices and what they do are as follows: +\end_layout +\begin_deeper +\begin_layout Description -\family default -Instructions to the speaker. - The parentheses are automatically inserted. - The ( will appear on screen, but both will be in the printed play. - This environment is only used within \family sans -Dialogue +plain \family default -. + The final output contains page numbers in the lower right corner. \end_layout -\begin_layout Itemize +\begin_layout Description \family sans -Dialogue -\begin_inset space \hfill{} -\end_inset - -M-z d -\begin_inset Newline newline -\end_inset - - +headings \family default -What the Speaker says. + Like +\family sans +plain +\family default +, but also prints out any time markers you've put in. + This is the default. \end_layout -\begin_layout Itemize +\begin_layout Description \family sans -CURTAIN -\begin_inset space \hfill{} -\end_inset - -M-z S-C -\begin_inset Newline newline -\end_inset - - +empty \family default -The curtain comes down. + The final output contains no page numbers, time markers, or alignment markers. \end_layout +\end_deeper \begin_layout Itemize - +The \family sans -Title -\begin_inset space \hfill{} +slides +\family default + class has an extra option: +\family typewriter +clock +\family default +. + To use it, put +\begin_inset Quotes eld \end_inset -M-z S-T -\end_layout -\begin_layout Itemize +\family typewriter +clock +\family default -\family sans -Author -\begin_inset space \hfill{} +\begin_inset Quotes erd \end_inset -M-z S-A + in the extra class options. \end_layout -\begin_layout Itemize - +\begin_deeper +\begin_layout Standard +Using this options allows you to add time markers to \family sans -Right_Address -\begin_inset space \hfill{} +Note +\family default +s. + See section +\begin_inset space ~ \end_inset -M-z r -\end_layout - -\begin_layout Standard -Hello there. -\end_layout -\begin_layout Subsection -Hollywood (Hollywood spec scripts) -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:slideNote" -\begin_layout Standard -by -\shape smallcaps -Garst Reese -\end_layout +\end_inset -\begin_layout Subsubsection -Introduction + for more details. \end_layout +\end_deeper \begin_layout Standard -Getting the format of a Hollywood script right is a +You can also use the template file \begin_inset Quotes eld \end_inset -rite of passage. -\begin_inset Quotes erd -\end_inset - It is designed to make the readers focus on content and to be easy and - familiar for the actors to read. - Each page of a script should be one minute of film. - Nothing goes in a script that you cannot see or hear on screen. - The courier 12 pt font should be used throughout. - No italics. -\end_layout +\family typewriter +slides.lyx +\family default -\begin_layout Subsubsection -Special problems -\end_layout +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Speakers' lines should NEVER break in mid-sentence. - If a speaker's lines continue over a page break, repeat the + to automatically set up a document to use the \family sans -Speaker +slides \family default - title followed by (Cont'd). -\end_layout + class [using +\family sans +File\SpecialChar menuseparator +New +\begin_inset space ~ +\end_inset -\begin_layout Subsubsection -Special features -\end_layout +from +\begin_inset space ~ +\end_inset -\begin_layout Standard -Insert the -\family sans -Speaker +Template \family default - names as labels then cross-reference the label to insert the name. - The cross-reference dialog will show the current cast of characters. - You can use this to insert the speaker name in narratives also. + to open your new document]. + The template file also contains some examples of the special paragraph + environments used by this class. + I'll describe those next. \end_layout \begin_layout Subsubsection -Paper size and Margins -\end_layout - -\begin_layout Standard -USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in +Paragraph Environments \end_layout -\begin_layout Subsubsection -Environments +\begin_layout Paragraph +Supported Environments \end_layout \begin_layout Standard -The following environments are available. - You can use hollywood.bind to get the bind keys shown at the right. -\end_layout - -\begin_layout Itemize - +The first thing you'll notice when you start up a new \family sans -Standard -\begin_inset Newline newline -\end_inset - - +slides \family default -Used where nothing else works. - Try to avoid it. -\end_layout + document is the font size and type: it's the equivalent of the size +\begin_inset Quotes eld +\end_inset -\begin_layout Itemize \family sans -FADE_IN +Largest \family default -: -\begin_inset space \hfill{} -\end_inset +\begin_inset Quotes erd +\end_inset + in the \family sans -M-z S-I -\family default - -\begin_inset Newline newline +Sans +\begin_inset space ~ \end_inset -Usually followed by something like +Serif +\family default + font. + This is also what's used in the output. + Think of this as a \begin_inset Quotes eld \end_inset -on Sally waking up. +visual cue \begin_inset Quotes erd \end_inset - + to remind you that this is a slide. + Your final slides will use a larger font; ergo, you'll have less space. + Of course, the larger default screen font isn't WYSIWYG, only a reminder. \end_layout -\begin_layout Itemize - +\begin_layout Standard +The next thing that becomes obvious is the changes to the paragraph environment + pull-down box [at the far-left end of the toolbar]. + Most of the paragraph environments you're used to seeing are missing. + There are also five new ones. + That's because the \family sans -INT: -\begin_inset space \hfill{} -\end_inset - -M-z i -\begin_inset Newline newline -\end_inset - - +slides \family default -Introduces a new INTERIOR camera set-up. - Always followed by DAY or NIGHT, or something similar to define the lighting - required. - Everthing on this line in CAPS. + class itself only supports certain paragraph environments: \end_layout \begin_layout Itemize \family sans -EXT: -\begin_inset space \hfill{} -\end_inset - -M-z e -\begin_inset Newline newline -\end_inset - - -\family default -Introduces a new EXTERIOR camera set-up. - Everthing on this line in CAPS. +Standard \end_layout \begin_layout Itemize \family sans -Speaker -\begin_inset space \hfill{} -\end_inset - -M-z s -\begin_inset Newline newline -\end_inset - - -\family default -The character speaking. +Itemize \end_layout \begin_layout Itemize \family sans -Parenthetical -\begin_inset space \hfill{} -\end_inset - -M-z p -\begin_inset Newline newline -\end_inset - - -\family default -Instructions to the speaker. - The () are automatically inserted. +Enumerate \end_layout \begin_layout Itemize \family sans -Dialogue -\begin_inset space \hfill{} -\end_inset - -M-z d -\begin_inset Newline newline -\end_inset +Description +\end_layout +\begin_layout Itemize -\family default -What the \family sans -Speaker -\family default - says. +List \end_layout \begin_layout Itemize \family sans -Transition -\begin_inset space \hfill{} -\end_inset - -M-z t -\begin_inset Newline newline -\end_inset - - -\family default -Camera movement instruction. - e. -\begin_inset space \thinspace{} -\end_inset - -g. -\begin_inset space \space{} -\end_inset - -CUT TO: +Quotation \end_layout \begin_layout Itemize \family sans -FADE OUT: -\begin_inset space \hfill{} -\end_inset - -M-z S-I +Quote \end_layout \begin_layout Itemize \family sans -Author -\begin_inset space \hfill{} -\end_inset - -M-z S-A +Verse \end_layout \begin_layout Itemize \family sans -Title -\begin_inset space \hfill{} -\end_inset - -M-z S-T +Caption \end_layout \begin_layout Itemize \family sans -Right_Address -\begin_inset space \hfill{} -\end_inset - -M-z r +\SpecialChar LyX +-Code \end_layout -\begin_layout Subsubsection -Script jargon +\begin_layout Standard +All of the other standard environments, including the section-heading environmen +ts, aren't used in the +\family sans +slides +\family default + class. \end_layout -\begin_layout Itemize -(O.S) — off screen +\begin_layout Standard +On the other hand, you'll notice the following new environments: \end_layout \begin_layout Itemize -(V.0) — voice over + +\family sans +Slide \end_layout \begin_layout Itemize -b. -\begin_inset space \thinspace{} -\end_inset -g. - — background +\family sans +Overlay \end_layout \begin_layout Itemize -C.U. - — close-up + +\family sans +Note \end_layout \begin_layout Itemize -PAN — camera movement + +\family sans +InvisibleText \end_layout \begin_layout Itemize -INSERT — cut to close-up of -\end_layout -\begin_layout Chapter -Installation +\family sans +VisibleText \end_layout \begin_layout Standard -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 Rev\SpecialChar TeX - 4 Web Site -\begin_inset Flex URL -status collapsed - -\begin_layout Plain Layout - -http://publish.aps.org/revtex4/ -\end_layout +These five are kind of quirky, due to a +\begin_inset Quotes eld +\end_inset +feature +\begin_inset Quotes erd \end_inset + in \SpecialChar LyX . - 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{} + 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 -e. -\begin_inset space \space{} +\SpecialChar LaTeX + magic. +\begin_inset Quotes erd \end_inset -not the directory where you installed the class file.) Then, if you reconfigure - \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 Rev\SpecialChar TeX - 4 document - using -\family typewriter -tex2lyx -\family default -, or to use the -\family sans -Revtex -\begin_inset space ~ +\begin_layout Paragraph +Quirks of the New Environments +\begin_inset CommandInset label +LatexCommand label +name "sec:slideQuirk" + \end_inset -4 -\family default - template, found in the templates directory. -\end_layout -\begin_layout Chapter -Preamble Matter \end_layout \begin_layout Standard -Optional arguments to -\family typewriter - -\backslash -documentclass +All five of the new paragraph environments are somewhat quirky due to inherent + 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 \family default -, like -\begin_inset Quotes eld -\end_inset + environment isn't a paragraph environment as described in the +\emph on +User's Guide +\emph default +. + +\end_layout -preprint -\begin_inset Quotes erd -\end_inset - - and +\begin_layout Standard +You should consider +\family sans +Slide +\family default +, +\family sans +Overlay +\family default +, and +\family sans +Note +\family default + to be \begin_inset Quotes eld \end_inset -aps +pseudo-environments. \begin_inset Quotes erd \end_inset -, go in the -\family sans -Extra -\begin_inset space ~ + They look like a section heading or a +\begin_inset Quotes eld \end_inset -Options -\family default - field in the + \family sans -Document -\begin_inset space ~ +Caption +\family default +, +\begin_inset Quotes erd \end_inset -Layout + but really begin a [and, if necessary, end the previous] paragraph environment. + Likewise, treat +\family sans +InvisibleText \family default - dialog, as usual. - Remember that in Rev\SpecialChar TeX -, at least one optional argument is required! -\end_layout - -\begin_layout Standard -Other preamble matter, like -\family typewriter - -\backslash -draft + and +\family sans +VisibleText \family default - etc. -\begin_inset space ~ + as +\begin_inset Quotes eld \end_inset -goes in the -\family sans -\SpecialChar LaTeX - -\begin_inset space ~ +pseudo-commands. +\begin_inset Quotes erd \end_inset -Preamble -\family default - dialog, also as usual. -\end_layout - -\begin_layout Chapter -Layouts + These two perform some action. \end_layout \begin_layout Standard -The layouts basically correspond to the commands in Rev\SpecialChar TeX -4.0. - For example, the Email layout corresponds to -\family typewriter - -\backslash -email{} +A common feature of all five environments, +\family sans +Slide \family default -. - Note that (at least as of Rev\SpecialChar TeX - 4.0 Beta), the +, \family sans -Address +Overlay +\family default +, +\family sans +Note +\family default +, +\family sans +InvisibleText \family default and \family sans -Affiliation +VisibleText \family default - layouts are exactly equivalent, so you shouldn't need to use both. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -In case you're curious, both were included so that -\family typewriter -tex2lyx +, is a rather long-ish label. + The text following this label — ordinarily the contents of the paragraph + environment — is utterly irrelevant for +\family sans +Slide \family default - would be able to translate both -\family typewriter - -\backslash -address +, +\family sans +Overlay +\family default +, +\family sans +Note +\family default +, +\family sans +InvisibleText \family default and -\family typewriter - -\backslash -affiliation +\family sans +VisibleText \family default . -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Chapter -Important Notes -\end_layout - -\begin_layout Standard -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 -. + \SpecialChar LyX + completely ignores it. + In fact, you can leave these five environments completely empty. + \end_layout \begin_layout Standard -In Rev\SpecialChar TeX -, the -\family typewriter - -\backslash -thanks -\family default - command goes +While you don't \emph on -outside +have \emph default - the -\family typewriter - -\backslash -author + to put any text after the rather long-ish label, you might want to. + This could be a short description of the contents of the +\family sans +Slide \family default - command. - The \SpecialChar LyX - equivalent is that there is a separate Thanks layout. - Do -\emph on -not -\emph default - write footnotes in the +, for example. + In that case, enter your descriptive comment and hit \family sans -Author +Return \family default - layout, or weird things may happen. - See the Rev\SpecialChar TeX - 4 documentation for more details. + as you normally would. \end_layout \begin_layout Standard -Also, the -\family sans -Author -\begin_inset space ~ -\end_inset - -Email -\family default -, -\family sans -Author -\begin_inset space ~ -\end_inset +If, on the other hand, you don't want to enter any descriptive text, you'll + 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 -URL -\family default -, and -\family sans -Thanks -\family default - layouts must be placed +\begin_layout Itemize +Start entering the text that will \emph on -in between +follow \emph default - the + the new \family sans -Author +Slide \family default - layout and the corresponding +, \family sans -Address +Overlay \family default - (or equivalent +, \family sans -Affiliation +Note \family default -) layout. - If you put the +, \family sans -Thanks +InvisibleText \family default - after the + or \family sans -Address +VisibleText \family default -, the \SpecialChar LaTeX - won't compile. +. + \end_layout -\begin_layout Chapter -Supplemental Tools +\begin_layout Itemize +Now move to the beginning of that paragraph. + \end_layout -\begin_layout Section -Customizing Bibliographies with Bib\SpecialChar TeX - or Biblatex +\begin_layout Itemize +Next, hit +\family sans +Return +\family default +. + \end_layout -\begin_layout Standard -The most basic information about how to use Bib\SpecialChar TeX +\begin_layout Itemize +Finally, change this new, empty paragraph to a +\family sans +Slide +\family default +, +\family sans +Overlay +\family default +, +\family sans +Note +\family default +, +\family sans +InvisibleText +\family default or \family sans -Biblatex +VisibleText \family default - with \SpecialChar LyX - is contained in the section -\emph on -Bibliography databases -\emph default - of the -\emph on -User's Guide -\emph default -. - The following subsections explain special bibliography features supported - by \SpecialChar LyX . + \end_layout -\begin_layout Subsection -Alternative Citation Styles +\begin_layout Standard +Some future version of \SpecialChar LyX + will, hopefully, resolve this quirkiness\SpecialChar ldots + +\end_layout + +\begin_layout Subsubsection +Making a Presentation with +\family sans +Slide +\family default +, +\family sans +Overlay +\family default + and +\family sans +Note +\end_layout + +\begin_layout Paragraph +Using the +\family sans +Slide +\family default + Environment \end_layout \begin_layout Standard -Standard Bib\SpecialChar TeX - uses numbers (e. -\begin_inset space \thinspace{} -\end_inset +If you're expecting this section to teach you how to actually make a presentatio +n, you'll be sorely disappointed. + Naturally, I'll describe all of the ways the +\family sans +slides +\family default + class can assist you in preparing the materials for a presentation. + Filling in the contents, however, is up to you. + [Then again, that +\emph on +is +\emph default + the \SpecialChar LyX + philosophy.] +\end_layout -g. -\begin_inset space \space{} +\begin_layout Standard +Choosing the +\family sans +Slide +\family default + environment [in the manner described in section +\begin_inset space ~ \end_inset -\begin_inset Quotes eld -\end_inset +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:slideQuirk" -[12] -\begin_inset Quotes erd \end_inset -) to refer to a cited work. - However, in many scientific disciplines, other citation styles are in use. - The most common one is the author-year style (e. -\begin_inset space \thinspace{} +] tells \SpecialChar LyX + to begin a new slide [duh]. + The label for this environment/ +\begin_inset Quotes erd \end_inset -g. -\begin_inset space \space{} +pseudo-command +\begin_inset Quotes erd \end_inset - + is an \begin_inset Quotes eld \end_inset -Knuth 1984a +ASCII line, \begin_inset Quotes erd \end_inset -). - \SpecialChar LyX - supports three packages that provide this style, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -biblatex -\end_layout - + in cool blue, followed by the label, +\begin_inset Quotes eld \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib -\end_layout - +NewSlide: +\begin_inset Quotes erd \end_inset -, and -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -jurabib +. + Any text or paragraph environments that follow this one go on the new slide. + It's that simple. \end_layout -\end_inset +\begin_layout Standard +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 +\family default + dialog). + In fact, you'll want to, once you finish entering the contents of one slide. + If you've entered more text than can physically fit on a slide, the extra + overflows onto a new slide. + I don't recommend doing this, however, since the overflow slide won't have + any page number on it. + Furthermore, it may interfere with any +\family sans +Overlay +\family default + you've made to accompany the oversized +\family sans +Slide +\family default . - Each of these packages has their pros and cons, which cannot be listed - in detail. - If you only want to have simple author-year (or author-numerical) style, - or if you want to use one of the countless style files for -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib \end_layout +\begin_layout Standard +The +\family sans +Overlay +\family default + and +\family sans +Note +\family default + environments work the same way as the +\family sans +Slide +\family default + environment. + They both create an +\begin_inset Quotes eld \end_inset -, then the established -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib -\end_layout - +ASCII line +\begin_inset Quotes erd \end_inset - package is probably your choice. - If you look for specific citation styles common in law studies, you might - consider the -\begin_inset Flex Code -status collapsed + followed by a label [ +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -jurabib -\end_layout +NewOverlay: +\begin_inset Quotes erd +\end_inset + and +\begin_inset Quotes eld \end_inset - package. - If you want to have full control over the formatting or look for advanced - features such as ibidem, footnote citations, full title citations, advanced - date formats (such as 400 BC) or full localization to other languages than - English, you should definitely consider -\begin_inset Flex Code -status collapsed +NewNote: +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -biblatex -\end_layout +, respectively]. + The color is a stunning magenta instead of blue, and the +\begin_inset Quotes eld +\end_inset +ASCII line +\begin_inset Quotes erd \end_inset -, which exceeds all other packages in terms of features, but is also quite - heavy and more resource-hungry. + will look different, in style and in length. + The label fonts of all three also differ from one another. \end_layout \begin_layout Standard -The handling of these packages in \SpecialChar LyX - is basically the same. - Go to -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings -\end_layout - -\end_inset - - and select under -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Bibliography +As with a +\family sans +Slide +\family default +, if the contents of a +\family sans +Note +\family default + or +\family sans +Overlay +\family default + exceed the physical size of a slide or sheet of paper, the extra will overflow + onto a new sheet. + Again, you should avoid this. + It defeats the whole purpose of +\family sans +Note +\family default +s and +\family sans +Overlay +\family default +s. \end_layout -\end_inset - - the -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Style Format +\begin_layout Paragraph +Using +\family sans +Overlay +\family default + with +\family sans +Slide \end_layout -\end_inset - - -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Basic (BibTeX) +\begin_layout Standard +The idea behind an +\family sans +Overlay +\family default + is a slide that sits atop another slide. + Perhaps you wish to discuss a figure on the main +\family sans +Slide +\family default + before displaying the text associated with it. + One way to accomplish this is tape a flap of dark paper over the part of + the +\family sans +Slide +\family default + you want to display later. + This method fails, however, if you wish to overlap one graph with another, + for example. + You would then have to fumble while speaking to align the two separate, + overlapping +\family sans +Slide +\family default +s to align the two graphs. + The use of an +\family sans +Overlay +\family default + environment in both cases makes life much easier. \end_layout +\begin_layout Standard +Each +\family sans +Overlay +\family default + receives the page number of its +\begin_inset Quotes eld \end_inset -, -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Biblatex -\end_layout - +parent +\begin_inset Quotes erd \end_inset -, -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Biblatex (Natbib mode) -\end_layout - + +\family sans +Slide +\family default +, appended by +\begin_inset Quotes eld \end_inset -, -\begin_inset Flex Noun -status collapsed -\begin_layout Plain Layout -Natbib (BibTeX) -\end_layout +\family typewriter +-a +\family default +\begin_inset Quotes erd \end_inset - or -\begin_inset Flex Noun +. +\begin_inset Foot status collapsed \begin_layout Plain Layout -Jurabib (BibTeX) -\end_layout - +Presumably, mutliple +\family sans +Overlay +\family default +s would have +\begin_inset Quotes eld \end_inset - (see sec. -\begin_inset space ~ -\end_inset -6.5.3 in the User's Guide for more information on these choices). - With all these packages, you will get some extra features in the citation - dialog and you can select the style of the reference ( -\begin_inset Quotes eld -\end_inset +\family typewriter +-a +\family default -Knuth 1984 \begin_inset Quotes erd \end_inset @@ -10107,15 +10002,11 @@ Knuth 1984 \begin_inset Quotes eld \end_inset -Knuth (1984) -\begin_inset Quotes erd -\end_inset -, -\begin_inset Quotes eld -\end_inset +\family typewriter +-b +\family default -Knuth, 1984 \begin_inset Quotes erd \end_inset @@ -10123,2323 +10014,2280 @@ Knuth, 1984 \begin_inset Quotes eld \end_inset -1984 -\begin_inset Quotes erd -\end_inset - - etc.). - Note that either package needs specifically designed style files. - They all ship their own, but there are lots of additional style files, - and there is even an interactive style file builder -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -See -\begin_inset Flex URL -status open - -\begin_layout Plain Layout - -ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/ -\end_layout - -\end_inset - -\end_layout +\family typewriter +-c +\family default +\begin_inset Quotes erd \end_inset - for -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib -\end_layout - +, etc. +\begin_inset space ~ \end_inset +appended to the page number of the parent +\family sans +Slide +\family default . + \end_layout -\begin_layout Subsection -Subdivided Bibliographies -\end_layout +\end_inset -\begin_layout Standard -Sometimes you might need to divide your bibliography into several sections. - If you are for instance a historian, the possibility to separate sources - and scientific works is most likely a + Clearly, you want the contents of both the +\family sans +Slide +\family default + and the +\family sans +Overlay +\family default + to each fit on a single physical slide! You should probably consider an + +\family sans +Overlay +\family default + as \begin_inset Quotes eld \end_inset -must have +part of \begin_inset Quotes erd \end_inset -. - Unfortunately, Bib\SpecialChar TeX - itself does not allow you to do this. - But with the help of some \SpecialChar LaTeX - packages, Bib\SpecialChar TeX - can be extended to fit your needs. -\end_layout - -\begin_layout Standard -\SpecialChar LyX - provides native support for one of these packages, -\family typewriter -bibtopic + a +\family sans +Slide \family default . -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -Available from -\begin_inset Flex URL -status open - -\begin_layout Plain Layout - -ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/ -\end_layout - -\end_inset - - -\end_layout - -\end_inset - - The advantage of this package (compared to other packages such as -\family typewriter -multibib -\family default -) is that you don't need to define new citation commands. - Instead, you need to prepare different bibliographic databases which include - the entries for the different sections of the bibliography. - For example: If you want to divide your bibliography into the sections + Indeed, the \SpecialChar LyX -\begin_inset Quotes eld -\end_inset - -Sources -\begin_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset - -Scientific works -\begin_inset Quotes erd -\end_inset - -, you first need to create two bibliographic databases, e. -\begin_inset space \thinspace{} -\end_inset - -g. -\begin_inset space \space{} -\end_inset - - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -sources.bib -\end_layout - -\end_inset - - and -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -scientific.bib -\end_layout - -\end_inset - +\family sans +slides +\family default + class provides a visual cue for this: the label at the start of an +\family sans +Overlay +\family default + is shorter than that at the start of a +\family sans +Slide +\family default . - + Lastly, when you generate printable output, you'll find alignment markers + in all four corners of both the +\family sans +Overlay +\family default + page and its parent +\family sans +Slide +\family default +. + These will assist you in lining up the two physical slides. \end_layout \begin_layout Standard -Go to -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings -\end_layout - -\end_inset - - and check under -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Bibliography -\end_layout - -\end_inset - - the option -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Subdivided bibliography -\end_layout - -\end_inset - +The major problem in overlaying two slides is aligning the contents of the + two transparencies. + How much space should you leave for that graph on the second slide? Worse + still, what if you want a graph and a sentence on second slide, but there + is text on the main transparency that goes in between them? You could try + and insert vertical space of the right size. + The better way is to use +\family sans +InvisibleText +\family default + and +\family sans +VisibleText +\family default . - Now you can insert multiple Bib\SpecialChar TeX - bibliographies, one for each section of - your bibliography. - Returning to our example: Insert the Bib\SpecialChar TeX - bibliography -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -sources.bib \end_layout +\begin_layout Standard +As their names imply, +\family sans +InvisibleText +\family default + and +\family sans +VisibleText +\family default + are two command-like paragraph environments that make all subsequent text + invisible and visible, respectively. + Note from section +\begin_inset space ~ \end_inset - and a second one for the database -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -scientific.bib -\end_layout - -\end_inset - -. - You are free to use the same or different styles for each section. - Additionally, you can choose if the bibliography section should contain - -\begin_inset Quotes eld -\end_inset - -all cited references -\begin_inset Quotes erd -\end_inset - of the specified database(s) (which is the default), -\begin_inset Quotes eld -\end_inset +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:slideQuirk" -all uncited references -\begin_inset Quotes erd \end_inset - or even + that you don't place anything +\emph on +into +\emph default + these two environments, however. + When you create an +\family sans +InvisibleText +\family default +, it inserts a centered, sky-blue label into the page reading \begin_inset Quotes eld \end_inset -all references + \begin_inset Quotes erd \end_inset . - This might be useful if you would like to separate your bibliography into - three sections: -\begin_inset Quotes eld -\end_inset - -Cited sources -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -Uncited sources -\begin_inset Quotes erd -\end_inset + For paragraphs following this label, the parts of the +\family sans +Slide +\family default + [or +\family sans +Overlay +\family default +; it doesn't matter which] where they would be contain instead blank space. + +\end_layout -, and +\begin_layout Standard +For +\family sans +VisibleText +\family default +, the corresponding centered label is \begin_inset Quotes eld \end_inset -Scientific works + \begin_inset Quotes erd \end_inset + in blazing green. + Paragraphs following this label behave normally. + Note that the beginning of a new +\family sans +Slide +\family default +, +\family sans +Overlay +\family default +, or +\family sans +Note +\family default + automatically shuts off an +\family sans +InvisibleText +\family default +. + It's therefore not necessary to use +\family sans +VisibleText +\family default + at the end of a +\family sans +Slide +\family default . - The titles for the sections can be added as ordinary sections or subsections. - Since -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -bibtopic \end_layout -\end_inset +\begin_layout Standard +By now, it should be obvious how to create overlay transparencies using + the proper combination of +\family sans +InvisibleText +\family default + and +\family sans +VisibleText +\family default + on a +\family sans +Slide +\family default + and +\family sans +Overlay +\family default +: +\end_layout - removes the bibliography title, you have to manually re-add that, too (as - a chapter* or section*, for instance). +\begin_layout Enumerate +Create a +\family sans +Slide +\family default +, including everything that will appear on it, whether on the main slide + or on the +\family sans +Overlay +\family default +. \end_layout -\begin_layout Standard -With +\begin_layout Enumerate +Before each figure or paragraph that will appear only on the \family sans -Biblatex +Overlay \family default -, the procedure is a bit different. - Since -\family typewriter -bibtopic +, insert an +\family sans +InvisibleText \family default - does not work with + environment. + If necessary, insert a \family sans -Biblatex +VisibleText \family default -, the aforementioned -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Subdivided bibliography + environment after the +\family sans +Overlay +\family default +-only text. \end_layout -\end_inset +\begin_layout Enumerate +Start an +\family sans +Overlay +\family default + immediately following the +\family sans +Slide +\family default +. +\end_layout - option is disabled if you use +\begin_layout Enumerate +Copy the contents of this \family sans -Biblatex +Slide +\family default + into the +\family sans +Overlay \family default . - However, +\end_layout + +\begin_layout Enumerate +Within the \family sans -Biblatex +Overlay \family default - provides its own means to generate subdivided bibliographies. - You can either add keywords to bibliography entries via the -\begin_inset Flex Code -status collapsed +, change all of the +\family sans +InvisibleText +\family default + lines to +\family sans +VisibleText +\family default + and vice-versa. +\end_layout -\begin_layout Plain Layout -keywords +\begin_layout Standard +That's it. + You've just made an +\family sans +Overlay +\family default +. \end_layout -\end_inset - - entry option and then filter bibliography sections by keyword (by adding +\begin_layout Standard +There's one problem with the way I've designed the \SpecialChar LyX -\begin_inset Flex Code +\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 \SpecialChar LaTeX + codes. +\begin_inset Foot status collapsed \begin_layout Plain Layout -keyword=mykeyword +The commands of interest are: \end_layout -\end_inset - - to the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Options +\family typewriter +{ +\backslash +invisible \SpecialChar ldots + } \end_layout -\end_inset +\begin_layout Itemize - field of the dialog that opens if you left-click on the -\begin_inset Flex Noun -status collapsed +\family typewriter +{ +\backslash +visible \SpecialChar ldots + } +\end_layout \begin_layout Plain Layout -Biblatex Generated Bibliography -\end_layout +\SpecialChar ldots +and need to be marked as \SpecialChar TeX +. + The text whose +\begin_inset Quotes eld +\end_inset +visibility +\begin_inset Quotes erd \end_inset - button), or you can filter by entry types (such as -\emph on -book -\emph default + you wish to change goes in between the brackets [and after the +\family typewriter + +\backslash +invisible +\family default or +\family typewriter + +\backslash +visible +\family default + command]. + If you don't know how to mark text as \SpecialChar TeX +, see the appropriate section of + the \emph on -article +User's Guide \emph default -) by entering e. -\begin_inset space \thinspace{} -\end_inset - -g. - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -type=book +. \end_layout \end_inset - or -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -nottype=collection \end_layout +\begin_layout Paragraph +Using +\family sans +Note +\family default + with +\family sans +Slide +\family default + +\begin_inset CommandInset label +LatexCommand label +name "sec:slideNote" + \end_inset - to the mentioned -\begin_inset Flex Noun -status collapsed -\begin_layout Plain Layout -Options \end_layout +\begin_layout Standard +Like an +\family sans +Overlay +\family default +, a +\family sans +Note +\family default + is associated with a +\begin_inset Quotes eld \end_inset - field, or you can create so-called +parent +\begin_inset Quotes erd +\end_inset + + +\family sans +Slide +\family default +. + Here, too, the \SpecialChar LyX + +\family sans +slides +\family default + class provides visual cues. + The label for a +\family sans +Note +\family default + is shorter than that of a +\family sans +Slide +\family default + [yet longer than that of an +\family sans +Overlay +\family default +] and, like the label of an +\family sans +Overlay +\family default + is shockingly magenta. + Additionally, the printed +\family sans +Note +\family default + has the page number of its \begin_inset Quotes eld \end_inset -Bibliography Categories +parent \begin_inset Quotes erd \end_inset - to which you can assign individual entries. - Please refer to the Biblatex manual, section -\emph on -Subdivided Bibliographies -\emph default -, for details. -\end_layout + +\family sans +Slide +\family default +, appended by +\begin_inset Quotes eld +\end_inset -\begin_layout Subsection -Multiple Bibliographies -\begin_inset CommandInset label -LatexCommand label -name "subsec:Multiple-Bibliographies" +\family typewriter +- +\family default +1 +\begin_inset Quotes erd \end_inset +, +\begin_inset Quotes eld +\end_inset -\end_layout -\begin_layout Standard -Multiple bibliographies, e. -\begin_inset space \thinspace{} +\family typewriter +- +\family default +2 +\begin_inset Quotes erd \end_inset -g. -\begin_inset space \space{} +, +\begin_inset Quotes eld \end_inset -a bibliography for each part, chapter, section, subsection or child (sub-documen -t) of the document, are also supported by \SpecialChar LyX -. - In order to enable it, go to -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Bibliography -\end_layout +\family typewriter +- +\family default +3 +\begin_inset Quotes erd \end_inset - and select the relevant unit (e. -\begin_inset space \thinspace{} -\end_inset +, etc. + You can have multiple +\family sans +Note +\family default +s associated with a single +\family sans +Slide +\family default +, and, as with +\family sans +Slide +\family default + and +\family sans +Overlay +\family default +, you'll probably want to break up long +\family sans +Note +\family default +s so that they fit on a single sheet of paper. +\end_layout -g., +\begin_layout Standard +The purpose of a +\family sans +Note +\family default + is obvious: it contains anything additional you might want to say about + a +\family sans +Slide +\family default +. + It could also be used as a sheet of reminders for a particular +\family sans +Slide +\family default +. + In the case of the latter, you might want to make use of time markers. + Currently, the \SpecialChar LyX + +\family sans +slides +\family default + class has no \begin_inset Quotes eld \end_inset -per section +native \begin_inset Quotes erd \end_inset -) in the -\begin_inset Flex Noun -status collapsed + support for time markers, a +\noun on +Sli\SpecialChar TeX -\begin_layout Plain Layout -Multiple Bibliographies +\noun default + feature. + So, you'll have to resort to using the \SpecialChar LaTeX + codes. \end_layout +\begin_layout Standard +To use time markers, you'll need to specify the extra class option +\begin_inset Quotes eld \end_inset - combo box. - Then add a Bib(la)\SpecialChar TeX - bibliography to each unit (e. -\begin_inset space \thinspace{} -\end_inset - -g., section) of your document. - In the output, a separate bibliography, containing only the references - done in the current unit is generated. -\end_layout -\begin_layout Standard -If you use Bib\SpecialChar TeX -, either the -\begin_inset Flex Code -status collapsed +\family typewriter +clock +\family default -\begin_layout Plain Layout -chapterbib -\end_layout +\begin_inset Quotes erd +\end_inset + [see section +\begin_inset space ~ \end_inset - or the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -bibtopic -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:slidesetup" \end_inset - package is used to create multiple bibliographies. - The former package is used if you select +]. + This option turns on timing marks, which will appear in the lower-left-hand + corner of every +\family sans +Note +\family default + you generate. + To set what appears in the time marker, you use the \SpecialChar LaTeX + commands \begin_inset Quotes eld \end_inset -per child document -\begin_inset Quotes erd -\end_inset - and do -\emph on -not -\emph default - check -\begin_inset Flex Noun -status collapsed +\family typewriter -\begin_layout Plain Layout -Sectioned Bibliography -\end_layout +\backslash +settime{} +\family default +\begin_inset Quotes erd \end_inset -. - In all other cases, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -bibtopic -\end_layout - + and +\begin_inset Quotes eld \end_inset - is used. -\begin_inset Foot -status collapsed -\begin_layout Plain Layout -An alternative approach, if you are willing to use some -\begin_inset Flex Noun -status collapsed +\family typewriter -\begin_layout Plain Layout -\SpecialChar TeX - Code -\end_layout +\backslash +addtime{} +\family default +\begin_inset Quotes erd \end_inset - (see section -\begin_inset space ~ +. + The arguments of both commands are time measured in seconds. + +\begin_inset Quotes eld \end_inset -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Inserting-TeX-Code" - -\end_inset - -), is to use the -\begin_inset Flex Code -status collapsed +\family typewriter -\begin_layout Plain Layout -bibunits -\end_layout +\backslash +settime{} +\family default +\begin_inset Quotes erd \end_inset - package. -\end_layout - + sets the time marker to a given time. + +\begin_inset Quotes eld \end_inset - If -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -bibtopic -\end_layout - -\end_inset - is used, \SpecialChar LyX - encloses the specified units in -\begin_inset Flex Code -status collapsed +\family typewriter -\begin_layout Plain Layout -bibtopic -\end_layout +\backslash +addtime{} +\family default +\begin_inset Quotes erd \end_inset -'s -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout + increments the time marker by the specified amount. + Using time markers and +\family sans +Note +\family default +s in this fashion, you can remind yourself how much time to spend on a particula +r +\family sans +Slide +\family default +. +\end_layout -\backslash -begin{btUnit} +\begin_layout Standard +There's one last feature to describe. + Clearly, you'd like to print out all of your +\family sans +Slide +\family default +s and +\family sans +Overlay +\family default +s on transparencies while printing all of your +\family sans +Note +\family default +s on plain paper. + However, a +\family sans +Note +\family default + +\emph on +must +\emph default + follow the +\family sans +Slide +\family default + with which it is associated. + What's a person to do? \end_layout +\begin_layout Standard +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 +\begin_inset Quotes eld \end_inset - and -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\family typewriter \backslash -end{btUnit} -\end_layout +onlyslides{ +\backslash +slides} +\family default +\begin_inset Quotes erd \end_inset - in order to create the units. - Note that this approach has some limitations. - First, every citation reference has to be inside some -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -btUnit -\end_layout - + will cause the output to contain only the +\family sans +Slide +\family default +s and +\family sans +Overlay +\family default +s. + Correspondingly, the command +\begin_inset Quotes eld \end_inset -. - So citations outside a defined unit (e. -\begin_inset space \thinspace{} -\end_inset -g., before the first section if you use -\begin_inset Quotes eld -\end_inset +\family typewriter + +\backslash +onlynotes{ +\backslash +notes} +\family default -by section \begin_inset Quotes erd \end_inset -) will appear as + prevents the output of anything but +\family sans +Note +\family default +s. + I'd advise placing both commands in the preamble and initially comment + both out. + You can then preview your entire presentation as you write. + When you're done writing, you can then uncomment one of the two to select + what you want to print. + I like to uncomment \begin_inset Quotes eld \end_inset -??? -\begin_inset Quotes erd -\end_inset - -. - You can also create your own units by entering -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\family typewriter \backslash -begin{btUnit} -\end_layout +onlyslides{ +\backslash +slides} +\family default +\begin_inset Quotes erd \end_inset - and -\begin_inset Flex Code -status collapsed + , print to a file with +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -\backslash -end{btUnit} -\end_layout +\family typewriter +-slides +\family default +\begin_inset Quotes erd \end_inset - as \SpecialChar TeX - code (for instance to work around the mentioned limitation). - Note, though, that -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -btUnit -\end_layout - + in its name, comment it back out, then uncomment +\begin_inset Quotes eld \end_inset -s cannot be nested. - A second limitation is that -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -bibtopic -\end_layout +\family typewriter -\end_inset +\backslash +onlynotes{ +\backslash +notes} +\family default - always processes all references of a bibliography database, even if they - are not cited. - This can result in odd labels (e. -\begin_inset space \thinspace{} +\begin_inset Quotes erd \end_inset -g. - + and print to a \begin_inset Quotes eld \end_inset -Miller 2014b + +\family typewriter +*-notes.ps +\family default + \begin_inset Quotes erd \end_inset - if two works of this author from 2014 are in the database, even if only - one is cited). + file. + I can then send either file to a printer, loading transparencies or plain + paper as appropriate. \end_layout \begin_layout Standard -If you use -\family sans -Biblatex -\family default -, the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -refsection -\end_layout - +You can also provide other arguments to the +\begin_inset Quotes eld \end_inset - option is used instead. - If you need specific units, you can start them with the \SpecialChar TeX - code -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\family typewriter \backslash -newrefsection -\end_layout +onlyslides{} +\family default +\begin_inset Quotes erd \end_inset - or -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -newrefsegment -\end_layout - + and +\begin_inset Quotes eld \end_inset -, respectively. - If you also want to control the end of the unit, use the environment -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\family typewriter \backslash -begin{refsection} -\end_layout +onlynotes{} +\family default +\begin_inset Quotes erd \end_inset - \SpecialChar ldots - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout + commands. + See a good \SpecialChar LaTeX + book for details. +\end_layout -\backslash -end{refsection} +\begin_layout Subsubsection +The +\family sans +slides +\family default + Class Template File \end_layout +\begin_layout Standard +I have also provided a template file, +\begin_inset Quotes eld \end_inset - instead. - Note, though, that -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -refsection -\end_layout +\family typewriter +slides.lyx +\family default +\begin_inset Quotes erd \end_inset -s cannot be nested. - In addition to the individual bibliography of the current unit, +, with the \family sans -Biblatex +slides \family default - also provides an easy way to output all bibliographies, subsequently, at - one place (e. -\begin_inset space \thinspace{} + class. + To use it, begin your new presentation with +\family sans +File\SpecialChar menuseparator +New +\begin_inset space ~ \end_inset -g., at the end of the document). - Select -\begin_inset Quotes eld +from +\begin_inset space ~ +\end_inset + +Template +\family default +. + Your new \SpecialChar LyX + presentation file will contain an example +\family sans +Slide +\family default + – +\family sans +Overlay +\family default + – +\family sans +Note +\family default + triplet. + The +\family sans +Slide +\family default + and +\family sans +Overlay +\family default + additionally contain an example of the use of +\family sans +InvisibleText +\family default + and +\family sans +VisibleText +\family default +. + Lastly, the preamble will contain: +\end_layout + +\begin_layout LyX-Code +% Uncomment to print out only slides and overlays +\end_layout + +\begin_layout LyX-Code +% +\end_layout + +\begin_layout LyX-Code +% +\backslash +onlyslides{ +\backslash +slides} +\begin_inset Newline newline \end_inset -all reference units -\begin_inset Quotes erd -\end_inset + +\end_layout - from the Content combo box of the Bib(la)TeX inset dialog in order to achieve - this. - Please refer to the -\family sans -Biblatex -\family default - manual for more information on this topic. +\begin_layout LyX-Code +% Uncomment to print out only notes \end_layout -\begin_layout Section -Multipart Documents +\begin_layout LyX-Code +% \end_layout -\begin_layout Subsection -General Operation +\begin_layout LyX-Code +% +\backslash +onlynotes{ +\backslash +notes} \end_layout \begin_layout Standard -When you are working on a large file with many sections, it is often convenient - to break up the document into several files, or perhaps you have something - where a table may change from time to time, but the preceding text does - not. - In these cases, you should seriously consider using multipart documents. - For example, scientific papers often have five major sections: the introduction -, observations, results, discussion, and conclusion. - Each of these could be its own separate \SpecialChar LyX - file, with one +One final thing: I created this class to support the \SpecialChar LaTeX2e + \begin_inset Quotes eld \end_inset -master + +\noun on +Sli\SpecialChar TeX + +\noun default + emulation \begin_inset Quotes erd \end_inset - file which contains the title, authors, abstract, references, etc., plus - the five included files. - It is important to note that each of these files is a full \SpecialChar LyX - file which - can be formatted and printed on its own, as well as included in a master - file. - Each of these files must have the same document class, however—don't attempt - to mix book classes with article classes. - You may also include \SpecialChar LaTeX - files; however, these files must not have their own - preamble (i. -\begin_inset space \thinspace{} + 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 \SpecialChar LaTeX2e + classes for creating presentations, such as the +\family sans +Foils +\family default + class [see section +\begin_inset space ~ \end_inset -e. -\begin_inset space \space{} + +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:foiltex" + \end_inset -everything up to and including the -\begin_inset Flex Code -status collapsed +] or the +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -\backslash -begin{document} -\end_layout +\family typewriter +seminar +\family default +\begin_inset Quotes erd \end_inset - line as well as the -\begin_inset Flex Code + 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 -\backslash -end{document} \end_layout \end_inset - line must be deleted) or else errors will be generated when you try to - make a DVI file. + I know nothing about these other classes. + Try them out to see what sort of alternative they provide. \end_layout -\begin_layout Standard -\SpecialChar LyX - allows you to include files quite easily with -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Insert\SpecialChar menuseparator -Child -\begin_inset space ~ -\end_inset +\begin_layout Section -Document +\change_inserted 564990737 1670439661 +Reports \end_layout -\end_inset +\begin_layout Subsection -. - When you click on this selection a small box is inserted into the file - at the current cursor location. - Clicking on the box raises a dialog which allows you to select the file - to be included, and the method of its inclusion. - +\change_inserted 564990737 1670439661 +report \end_layout \begin_layout Standard -The file selection box should by now be obvious. - The three inclusion methods are -\begin_inset Quotes eld -\end_inset -include -\begin_inset Quotes erd -\end_inset +\change_inserted 564990737 1670439661 +The document class +\family sans +report +\family default + provides the +\family sans +report.cls +\family default + document class for preparing reports. + Like the +\family sans +book +\family default + document class, this provides parts, chapters and sections but does not + provide the paragraph styles needed for a book; like the +\family sans +article +\family default + document class, it provides the abstract paragraph style. + In two-sided mode, it does not start a new chapter on the right hand page. +\end_layout -, -\begin_inset Quotes eld -\end_inset +\begin_layout Standard -input -\begin_inset Quotes erd +\change_inserted 564990737 1670439674 +The remaining +\family sans +report +\family default + document classes are described in the Collections (section +\begin_inset space ~ \end_inset -, and -\begin_inset Quotes eld -\end_inset -verbatim -\begin_inset Quotes erd -\end_inset +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Collections" -. - The methods -\begin_inset Quotes eld \end_inset -include -\begin_inset Quotes erd -\end_inset +). +\end_layout - and -\begin_inset Quotes eld -\end_inset +\begin_layout Section -input -\begin_inset Quotes erd -\end_inset +\change_inserted 564990737 1670439674 +Scripts (drama) +\end_layout - are similar in many ways, but there are also some notable differences: +\begin_layout Subsection +Broadway \end_layout -\begin_layout Enumerate -Files that are -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +by +\shape smallcaps +Garst Reese +\end_layout -included -\begin_inset Quotes erd -\end_inset +\begin_layout Subsubsection +Introduction +\end_layout - are typeset beginning on a new page, while files that are -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +Broadway is for writing plays. + The format is more decorative than Hollywood, and much less standardized. + This format should be suitable for workshops. +\end_layout -inputted -\begin_inset Quotes erd -\end_inset +\begin_layout Subsubsection +Special problems +\end_layout - are typeset starting on the current page. +\begin_layout Standard +The same as in Hollywood. \end_layout -\begin_layout Enumerate -\begin_inset Quotes eld -\end_inset +\begin_layout Subsubsection +Special features +\end_layout -Included -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +Insert the +\family sans +Speaker +\family default + names as labels then cross-reference the label to insert the name. + The cross-reference dialog will show the current cast of characters. +\end_layout + +\begin_layout Subsubsection +Paper size and Margins +\end_layout - files cannot themselves -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in +\end_layout -include -\begin_inset Quotes erd -\end_inset +\begin_layout Subsubsection +Environments +\end_layout - further files ( -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +The following environments are available. + You can use broadway.bind to get the bind keys shown at the right. +\end_layout -grandchilds -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -). - With -\begin_inset Quotes eld +\family sans +Standard +\begin_inset Newline newline \end_inset -input -\begin_inset Quotes erd -\end_inset -, on the other hand, infinite sub-inputting is possible. +\family default +You should not have to use this, but it is here for anything that does not + fit otherwise. \end_layout -\begin_layout Enumerate -\begin_inset Quotes eld -\end_inset - -Include -\begin_inset Quotes erd -\end_inset - - allow for the output of only selected -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -included -\begin_inset Quotes erd +\family sans +Narrative +\begin_inset space \hfill{} \end_inset - files, while maintaining the actual counters (pagination etc.) and references - (please refer to the section -\emph on -Child -\begin_inset space ~ +M-z n +\begin_inset Newline newline \end_inset -Documents -\emph default - of the -\emph on -Embedded -\begin_inset space ~ -\end_inset -Objects -\emph default - manual for details). +\family default +Used to describe stage setting and the action. + First use of speaker names in all CAPs. \end_layout -\begin_layout Standard -Hence, -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -include -\begin_inset Quotes erd +\family sans +ACT +\begin_inset space \hfill{} \end_inset - is the preferred method for chapters that are outsourced to child documents, - while -\begin_inset Quotes eld +M-z a +\begin_inset Newline newline \end_inset -input -\begin_inset Quotes erd -\end_inset - is more suitable for arbitrary file inheritance. +\family default +Automatically numbered. + On screen it will be arabic, but will print as Roman. \end_layout -\begin_layout Standard -A -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -verbatim -\begin_inset Quotes erd +\family sans +ACT* +\begin_inset space \hfill{} \end_inset - included file allows you to include a file typeset exactly as it appears - in the file, i. -\begin_inset space \thinspace{} +M-z S at +\begin_inset Newline newline \end_inset -e. -\begin_inset space \space{} -\end_inset -in -\begin_inset Flex Code -status collapsed +\family default +Subtitle for +\family sans +ACT. -\begin_layout Plain Layout -verbatim +\family default + It is just centered text. \end_layout -\end_inset - - mode, with the characters set in a fixed-width typewriter font. - Normally, spaces in this file are invisible, though two consecutive spaces - are conserved, unlike \SpecialChar LyX -'s normal treatment of spaces. - However, setting the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Mark -\begin_inset space ~ +\family sans +SCENE +\begin_inset space \hfill{} \end_inset -spaces -\begin_inset space ~ +M-z S-S +\begin_inset Newline newline \end_inset -in -\begin_inset space ~ -\end_inset -output +\family default +Not automatically numbered. + You supply the number. + This is because I couldn't figure out how. \end_layout +\begin_layout Itemize + +\family sans +AT_RISE: +\begin_inset space \hfill{} \end_inset - checkbox typesets a mark to unambiguously define the presence of a space. - -\end_layout +M-z S-R +\begin_inset Newline newline +\end_inset -\begin_layout Standard -Generally, the master file is converted into a full \SpecialChar LaTeX - file before typesetting, - while the included files are converted to \SpecialChar LaTeX - files that do not have all the - preamble information. -\end_layout -\begin_layout Subsection -Cross-References Between Files +\family default +A special case of Narrative to describe the setting and action as the curtain + rises. \end_layout -\begin_layout Standard -\begin_inset Box Shadowbox -position "t" -hor_pos "c" -has_inner_box 1 -inner_pos "t" -use_parbox 0 -use_makebox 0 -width "100col%" -special "none" -height "1in" -height_special "totalheight" -thickness "0.4pt" -separation "3pt" -shadowsize "4pt" -framecolor "black" -backgroundcolor "none" -status open +\begin_layout Itemize -\begin_layout Plain Layout -This section is somewhat out of date. - Need to describe default master documents and how children are opened when - the master is. - [[FIXME]] -\end_layout +\family sans +Speaker +\begin_inset space \hfill{} +\end_inset +M-z s +\begin_inset Newline newline \end_inset +\family default +The speaker's (actor's) title, centered in all CAPS. \end_layout -\begin_layout Standard -It is possible to set up cross-references between the different files. - First, open all the files in question: let's call them A and B in a two - file example, where B is included in A. - Let's say you insert a label in A, then want to reference it in B. - Open the cross-reference dialog whilst in document B, and you can select - the -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -buffer -\begin_inset Quotes erd +\family sans +Parenthetical +\begin_inset space \hfill{} \end_inset - to use. -\end_layout - -\begin_layout Subsection -Bibliography Lists in all Subdocuments -\end_layout +M-z p +\begin_inset Newline newline +\end_inset -\begin_layout Standard -If you work with child documents, you might want to have only one main bibliogra -phy at the end, but still be able to have a selected bibliography for the - child if you output it on its own. - Here is how to achieve this. -\end_layout -\begin_layout Standard -For the main document, you just insert a bibliography inset at the place - where the main bibliography has to appear (within the master file or within - a child). - If the bibliography inset is in the master file, the references will be - inherited by all children, so they are available in the citation dialog - within each child. +\family default +Instructions to the speaker. + The parentheses are automatically inserted. + The ( will appear on screen, but both will be in the printed play. + This environment is only used within +\family sans +Dialogue +\family default +. \end_layout -\begin_layout Standard -For child-specific bibliographies, insert bibliography insets within the - child documents, at the place where the bibliography should appear when - the child is compiled separately. - However, the trick is to insert them into a branch ( +\begin_layout Itemize + \family sans -Insert\SpecialChar menuseparator -Branch\SpecialChar menuseparator -Insert New Branch... -\family default -), e. -\begin_inset space \thinspace{} +Dialogue +\begin_inset space \hfill{} \end_inset -g. - called -\begin_inset Quotes eld +M-z d +\begin_inset Newline newline \end_inset -Childonly -\begin_inset Quotes erd -\end_inset -. - Within the children, activate the branch ( -\family sans -Document\SpecialChar menuseparator -Settings...\SpecialChar menuseparator -Branches \family default -). - Within the master, deactivate the branch ( +What the Speaker says. +\end_layout + +\begin_layout Itemize + \family sans -Document\SpecialChar menuseparator -Settings...\SpecialChar menuseparator -Branches +CURTAIN +\begin_inset space \hfill{} +\end_inset + +M-z S-C +\begin_inset Newline newline +\end_inset + + \family default -). - Now the child's bibliography will be ignored by the master, but considered - by the child. +The curtain comes down. \end_layout -\begin_layout Standard -If you need multiple bibliographies (e. -\begin_inset space \thinspace{} +\begin_layout Itemize + +\family sans +Title +\begin_inset space \hfill{} \end_inset -g., one per child in the -\emph on -main document -\emph default -), please refer to sec. -\begin_inset space ~ +M-z S-T +\end_layout + +\begin_layout Itemize + +\family sans +Author +\begin_inset space \hfill{} \end_inset +M-z S-A +\end_layout -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Multiple-Bibliographies" +\begin_layout Itemize +\family sans +Right_Address +\begin_inset space \hfill{} \end_inset -. +M-z r \end_layout -\begin_layout Section -\SpecialChar LyX - Archives +\begin_layout Standard +Hello there. +\end_layout + +\begin_layout Subsection +Hollywood (Hollywood spec scripts) \end_layout \begin_layout Standard -Users sometimes need to be able to +by +\shape smallcaps +Garst Reese +\end_layout + +\begin_layout Subsubsection +Introduction +\end_layout + +\begin_layout Standard +Getting the format of a Hollywood script right is a \begin_inset Quotes eld \end_inset -bundle +rite of passage. \begin_inset Quotes erd \end_inset - a \SpecialChar LyX - file together with all the images (and other files) on which it depends, - either for sending to a publisher or for sharing with a co-author. - \SpecialChar LyX - includes a Python script ( -\begin_inset Flex Code -status collapsed + It is designed to make the readers focus on content and to be easy and + familiar for the actors to read. + Each page of a script should be one minute of film. + Nothing goes in a script that you cannot see or hear on screen. + The courier 12 pt font should be used throughout. + No italics. +\end_layout -\begin_layout Plain Layout -lyxpak.py +\begin_layout Subsubsection +Special problems \end_layout -\end_inset +\begin_layout Standard +Speakers' lines should NEVER break in mid-sentence. + If a speaker's lines continue over a page break, repeat the +\family sans +Speaker +\family default + title followed by (Cont'd). +\end_layout -) that automates this process. - To use it, you must have either the -\begin_inset Flex Code -status collapsed +\begin_layout Subsubsection +Special features +\end_layout -\begin_layout Plain Layout -zipfile +\begin_layout Standard +Insert the +\family sans +Speaker +\family default + names as labels then cross-reference the label to insert the name. + The cross-reference dialog will show the current cast of characters. + You can use this to insert the speaker name in narratives also. \end_layout -\end_inset +\begin_layout Subsubsection +Paper size and Margins +\end_layout - or -\begin_inset Flex Code -status collapsed +\begin_layout Standard +USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in +\end_layout -\begin_layout Plain Layout -tarfile +\begin_layout Subsubsection +Environments +\end_layout + +\begin_layout Standard +The following environments are available. + You can use hollywood.bind to get the bind keys shown at the right. \end_layout +\begin_layout Itemize + +\family sans +Standard +\begin_inset Newline newline \end_inset - python modules installed on your system. - By default, the script prefers the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -gzip +\family default +Used where nothing else works. + Try to avoid it. \end_layout +\begin_layout Itemize + +\family sans +FADE_IN +\family default +: +\begin_inset space \hfill{} \end_inset --compressed -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -tar -\end_layout +\family sans +M-z S-I +\family default +\begin_inset Newline newline \end_inset - format on Unix-like systems and the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -zip -\end_layout +Usually followed by something like +\begin_inset Quotes eld +\end_inset +on Sally waking up. +\begin_inset Quotes erd \end_inset - format on Windows. + \end_layout -\begin_layout Standard -\SpecialChar LyX -'s configuration process will set the script up to export a `\SpecialChar LyX - Archive', - and this format will then be available under -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -File\SpecialChar menuseparator -Export -\end_layout +\family sans +INT: +\begin_inset space \hfill{} +\end_inset +M-z i +\begin_inset Newline newline \end_inset -. + +\family default +Introduces a new INTERIOR camera set-up. + Always followed by DAY or NIGHT, or something similar to define the lighting + required. + Everthing on this line in CAPS. \end_layout -\begin_layout Standard -Independently of the platform, the generation of a particular archive format - can be forced by adding either the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout --t -\end_layout +\family sans +EXT: +\begin_inset space \hfill{} +\end_inset +M-z e +\begin_inset Newline newline \end_inset - (for the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -tar +\family default +Introduces a new EXTERIOR camera set-up. + Everthing on this line in CAPS. \end_layout -\end_inset - - format) or -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout --z -\end_layout +\family sans +Speaker +\begin_inset space \hfill{} +\end_inset +M-z s +\begin_inset Newline newline \end_inset - (for the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -zip +\family default +The character speaking. \end_layout -\end_inset - - format) switch to the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -\SpecialChar LyX -\SpecialChar menuseparator -\SpecialChar LyX - Archive -\end_layout +\family sans +Parenthetical +\begin_inset space \hfill{} +\end_inset +M-z p +\begin_inset Newline newline \end_inset - converter in -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -Converters +\family default +Instructions to the speaker. + The () are automatically inserted. \end_layout +\begin_layout Itemize + +\family sans +Dialogue +\begin_inset space \hfill{} +\end_inset + +M-z d +\begin_inset Newline newline \end_inset -. - (Make sure you add the switch after the script name, not before it.) -\end_layout -\begin_layout Section -Fancy Headers and Footers +\family default +What the +\family sans +Speaker +\family default + says. \end_layout -\begin_layout Standard -The default page layout is rather plain; for an -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -article -\end_layout +\family sans +Transition +\begin_inset space \hfill{} +\end_inset +M-z t +\begin_inset Newline newline \end_inset - document class, all you get is a centered page number at the bottom of - the page. - This document uses KOMA-script's book class, so it appears to be a bit - fancier. - But to really put on a show, you need to set the document page style to - -\begin_inset Quotes eld + +\family default +Camera movement instruction. + e. +\begin_inset space \thinspace{} \end_inset -fancy -\begin_inset Quotes erd +g. +\begin_inset space \space{} \end_inset -, as mentioned in the -\emph on -User Guide -\emph default -. - This section describes the \SpecialChar LaTeX - code you need to insert in your \SpecialChar LaTeX - preamble in - order to get the desired effects. +CUT TO: \end_layout -\begin_layout Standard -For more information on fancy headers, see the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -fancyhdr -\end_layout +\begin_layout Itemize +\family sans +FADE OUT: +\begin_inset space \hfill{} \end_inset - package documentation. - ( -\begin_inset Flex URL -status collapsed - -\begin_layout Plain Layout - -https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html +M-z S-I \end_layout +\begin_layout Itemize + +\family sans +Author +\begin_inset space \hfill{} \end_inset -) +M-z S-A \end_layout -\begin_layout Standard -The page header is divided into three fields, not surprisingly labeled -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -left -\begin_inset Quotes erd +\family sans +Title +\begin_inset space \hfill{} \end_inset -, -\begin_inset Quotes eld -\end_inset +M-z S-T +\end_layout -center -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, and -\begin_inset Quotes eld +\family sans +Right_Address +\begin_inset space \hfill{} \end_inset -right -\begin_inset Quotes erd -\end_inset +M-z r +\end_layout -. - The footer is also divided into these three fields. - The \SpecialChar LaTeX - commands to set these fields in the simplest manner are -\begin_inset Flex Code -status collapsed +\begin_layout Subsubsection +Script jargon +\end_layout -\begin_layout Plain Layout +\begin_layout Itemize +(O.S) — off screen +\end_layout -\backslash -lhead +\begin_layout Itemize +(V.0) — voice over \end_layout +\begin_layout Itemize +b. +\begin_inset space \thinspace{} \end_inset -, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -chead +g. + — background \end_layout -\end_inset - -, -\begin_inset Flex Code -status collapsed +\begin_layout Itemize +C.U. + — close-up +\end_layout -\begin_layout Plain Layout +\begin_layout Itemize +PAN — camera movement +\end_layout -\backslash -rhead +\begin_layout Itemize +INSERT — cut to close-up of \end_layout -\end_inset +\begin_layout Chapter +Installation +\end_layout -, -\begin_inset Flex Code +\begin_layout Standard +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 Rev\SpecialChar TeX + 4 Web Site +\begin_inset Flex URL status collapsed \begin_layout Plain Layout -\backslash -lfoot +http://publish.aps.org/revtex4/ \end_layout \end_inset -, etc. - Suppose you wish to put your name in the upper left hand corner of each - page. - Simply insert the following command in the preamble: +. + 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 + +e. +\begin_inset space \space{} +\end_inset + +not the directory where you installed the class file.) Then, if you reconfigure + \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 Rev\SpecialChar TeX + 4 document + using \family typewriter +tex2lyx +\family default +, or to use the +\family sans +Revtex +\begin_inset space ~ +\end_inset -\backslash -lhead{John Q. - DocWriter} +4 +\family default + template, found in the templates directory. \end_layout -\begin_layout Standard -You will now see your name in the upper left. - If a field has a default entry that you would like to get rid of (often - the page number appears in the central footer) simply include a command - with a blank argument, e. -\begin_inset space \thinspace{} -\end_inset - -g.: +\begin_layout Chapter +Preamble Matter \end_layout \begin_layout Standard - +Optional arguments to \family typewriter \backslash -cfoot{} -\end_layout - -\begin_layout Standard -Let's get really fancy: lets put the section number with the word +documentclass +\family default +, like \begin_inset Quotes eld \end_inset -Section +preprint \begin_inset Quotes erd \end_inset - (e. -\begin_inset space \thinspace{} + and +\begin_inset Quotes eld \end_inset -g. -\begin_inset space \space{} +aps +\begin_inset Quotes erd \end_inset -Section 3) in the upper left, the page number (e. -\begin_inset space \thinspace{} +, go in the +\family sans +Extra +\begin_inset space ~ \end_inset -g. -\begin_inset space \space{} +Options +\family default + field in the +\family sans +Document +\begin_inset space ~ \end_inset -Page 4) in the upper right, your name in the lower left, and the date in - the lower right. - The following commands should now appear in the preamble: +Layout +\family default + dialog, as usual. + Remember that in Rev\SpecialChar TeX +, at least one optional argument is required! \end_layout \begin_layout Standard - +Other preamble matter, like \family typewriter \backslash -lhead{Section -\backslash -thesection} -\end_layout +draft +\family default + etc. +\begin_inset space ~ +\end_inset -\begin_layout Standard +goes in the +\family sans +\SpecialChar LaTeX -\family typewriter +\begin_inset space ~ +\end_inset -\backslash -chead{} +Preamble +\family default + dialog, also as usual. \end_layout -\begin_layout Standard - -\family typewriter - -\backslash -rhead{Page -\backslash -thepage} +\begin_layout Chapter +Layouts \end_layout \begin_layout Standard - +The layouts basically correspond to the commands in Rev\SpecialChar TeX +4.0. + For example, the Email layout corresponds to \family typewriter \backslash -lfoot{John Q. - DocWriter} -\end_layout - -\begin_layout Standard +email{} +\family default +. + Note that (at least as of Rev\SpecialChar TeX + 4.0 Beta), the +\family sans +Address +\family default + and +\family sans +Affiliation +\family default + layouts are exactly equivalent, so you shouldn't need to use both. +\begin_inset Foot +status collapsed +\begin_layout Plain Layout +In case you're curious, both were included so that +\family typewriter +tex2lyx +\family default + would be able to translate both \family typewriter \backslash -cfoot{} -\end_layout - -\begin_layout Standard - +address +\family default + and \family typewriter \backslash -rfoot{ -\backslash -today} +affiliation +\family default +. \end_layout -\begin_layout Standard -The commands -\begin_inset Flex Code -status collapsed +\end_inset -\begin_layout Plain Layout -\backslash -thesection \end_layout -\end_inset +\begin_layout Chapter +Important Notes +\end_layout - and -\begin_inset Flex Code -status collapsed +\begin_layout Standard +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 Plain Layout +\begin_layout Standard +In Rev\SpecialChar TeX +, the +\family typewriter \backslash -thepage +thanks +\family default + command goes +\emph on +outside +\emph default + the +\family typewriter + +\backslash +author +\family default + command. + The \SpecialChar LyX + equivalent is that there is a separate Thanks layout. + Do +\emph on +not +\emph default + write footnotes in the +\family sans +Author +\family default + layout, or weird things may happen. + See the Rev\SpecialChar TeX + 4 documentation for more details. \end_layout +\begin_layout Standard +Also, the +\family sans +Author +\begin_inset space ~ \end_inset - access \SpecialChar LaTeX -'s section and page counters, and so print out the current section - and page number. - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout +Email +\family default +, +\family sans +Author +\begin_inset space ~ +\end_inset -\backslash -today +URL +\family default +, and +\family sans +Thanks +\family default + layouts must be placed +\emph on +in between +\emph default + the +\family sans +Author +\family default + layout and the corresponding +\family sans +Address +\family default + (or equivalent +\family sans +Affiliation +\family default +) layout. + If you put the +\family sans +Thanks +\family default + after the +\family sans +Address +\family default +, the \SpecialChar LaTeX + won't compile. \end_layout -\end_inset +\begin_layout Chapter +Supplemental Tools +\end_layout - simply prints out today's date. +\begin_layout Section +Customizing Bibliographies with Bib\SpecialChar TeX + or Biblatex \end_layout \begin_layout Standard -The thicknesses of the horizontal rules drawn beneath the header and above - the footer can also be modified. - If you don't want one of the rules, set its thickness to 0. - The header rule has a default thickness of 0.4pt, the footer rule is 0pt. - Use commands -\family typewriter - +The most basic information about how to use Bib\SpecialChar TeX + or +\family sans +Biblatex \family default -like -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout + with \SpecialChar LyX + is contained in the section +\emph on +Bibliography databases +\emph default + of the +\emph on +User's Guide +\emph default +. + The following subsections explain special bibliography features supported + by \SpecialChar LyX +. +\end_layout -\backslash -renewcommand{ -\backslash -headrulewidth}{0.4pt} +\begin_layout Subsection +Alternative Citation Styles \end_layout +\begin_layout Standard +Standard Bib\SpecialChar TeX + uses numbers (e. +\begin_inset space \thinspace{} \end_inset - and -\begin_inset Flex Code -status collapsed +g. +\begin_inset space \space{} +\end_inset -\begin_layout Plain Layout -\backslash -renewcommand{ -\backslash -footrulewidth}{0.4pt} -\end_layout +\begin_inset Quotes eld +\end_inset +[12] +\begin_inset Quotes erd \end_inset - to set the thicknesses. -\end_layout +) to refer to a cited work. + However, in many scientific disciplines, other citation styles are in use. + The most common one is the author-year style (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Standard -You can switch the header/footer settings on and off for individual pages - using commands like -\begin_inset Flex Code -status collapsed +g. +\begin_inset space \space{} +\end_inset -\begin_layout Plain Layout -\backslash -thispagestyle{empty} -\end_layout +\begin_inset Quotes eld +\end_inset +Knuth 1984a +\begin_inset Quotes erd \end_inset -, +). + \SpecialChar LyX + supports three packages that provide this style, \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -thispagestyle{plain} +biblatex \end_layout \end_inset -, and +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -thispagestyle{fancy} +natbib \end_layout \end_inset -. - Simply insert them in the text on the page you want changed and mark them - as \SpecialChar TeX - code. - In fact, title pages are marked as plain by default, while following pages - are marked fancy when using the global fancy setting. -\end_layout - -\begin_layout Standard -As a final example, it is possible to include an image in the header or - footer. - Suppose you want to put a company logo in the upper lefthand corner. - You might try something like -\end_layout - -\begin_layout Standard - -\family typewriter - -\backslash -lhead{ -\backslash -resizebox{1in}{!}{ -\backslash -includegraphics{logo.eps}}} -\end_layout - -\begin_layout Standard -\noindent -(you may need to preface this with +, and \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -usepackage{graphics} -\end_layout - -\end_inset - - if you don't include graphics elsewhere in your document). +jurabib \end_layout -\begin_layout Section -Itemize Bullet Selection -\begin_inset CommandInset label -LatexCommand label -name "sec:bullet" - \end_inset - -\end_layout - -\begin_layout Standard -by -\noun on - Allan Rae -\end_layout - -\begin_layout Subsection -Introduction -\end_layout - -\begin_layout Standard -\SpecialChar LyX - provides 216 bullet shapes that can be accessed from a simple dialog. - Using this dialog you can easily specify what bullet shape to use at each - level of an itemized list. - These settings are document-wide so you won't be able to specify different - sets of bullets for different paragraphs. -\begin_inset Foot +. + Each of these packages has their pros and cons, which cannot be listed + in detail. + If you only want to have simple author-year (or author-numerical) style, + or if you want to use one of the countless style files for +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Well, actually you can but you'll have to do it by hand. +natbib \end_layout \end_inset - -\end_layout - -\begin_layout Subsection -How it looks -\end_layout - -\begin_layout Standard -Open the dialog by selecting the -\begin_inset Flex Noun +, then the established +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings +natbib \end_layout \end_inset - menu item and then select the -\begin_inset Flex Noun + package is probably your choice. + If you look for specific citation styles common in law studies, you might + consider the +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Bullets -\end_layout - -\end_inset - - tab. -\end_layout - -\begin_layout Standard -The dialog provides you with a table of bullet shapes. - A column of buttons on the left of the table provides access to the six - different panels of bullet shapes. - The row of buttons across the top is used to select which bullet depth - you are changing. - -\change_deleted 244031559 1603875981 - A text entry under the table shows the currently selected bullet shape's - \SpecialChar LaTeX - equivalent and this can be edited if desired. - If you do modify the text you will also need to specify any needed packages - in the \SpecialChar LaTeX - preamble. -\change_unchanged - -\end_layout - -\begin_layout Standard -The six panels are divided up by the packages they require. - The following table shows the mappings from button name to \SpecialChar LaTeX - package. -\end_layout - -\begin_layout Standard -\align center -\begin_inset Tabular - - - - - - -\begin_inset Text - -\begin_layout Plain Layout - -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Button +jurabib \end_layout \end_inset - - -\begin_inset Text -\begin_layout Plain Layout + package. + If you want to have full control over the formatting or look for advanced + features such as ibidem, footnote citations, full title citations, advanced + date formats (such as 400 BC) or full localization to other languages than + English, you should definitely consider +\begin_inset Flex Code +status collapsed -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Packages Required +\begin_layout Plain Layout +biblatex \end_layout \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout +, which exceeds all other packages in terms of features, but is also quite + heavy and more resource-hungry. +\end_layout -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Standard +\begin_layout Standard +The handling of these packages in \SpecialChar LyX + is basically the same. + Go to +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings \end_layout \end_inset - - -\begin_inset Text + + and select under +\begin_inset Flex Noun +status collapsed \begin_layout Plain Layout +Bibliography +\end_layout -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -base \SpecialChar LaTeX +\end_inset + + the +\begin_inset Flex Noun +status collapsed +\begin_layout Plain Layout +Style Format \end_layout \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout + +\begin_inset Flex Noun +status collapsed -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Maths +\begin_layout Plain Layout +Basic (BibTeX) \end_layout \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +, +\begin_inset Flex Noun +status collapsed -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -amssymb.sty +\begin_layout Plain Layout +Biblatex \end_layout \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout +, +\begin_inset Flex Noun +status collapsed -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding1 +\begin_layout Plain Layout +Biblatex (Natbib mode) \end_layout \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +, +\begin_inset Flex Noun +status collapsed -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty +\begin_layout Plain Layout +Natbib (BibTeX) \end_layout \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout + or +\begin_inset Flex Noun +status collapsed -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding2 +\begin_layout Plain Layout +Jurabib (BibTeX) \end_layout \end_inset - - -\begin_inset Text -\begin_layout Plain Layout + (see sec. +\begin_inset space ~ +\end_inset -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty -\end_layout +6.5.3 in the User's Guide for more information on these choices). + With all these packages, you will get some extra features in the citation + dialog and you can select the style of the reference ( +\begin_inset Quotes eld +\end_inset +Knuth 1984 +\begin_inset Quotes erd \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout +, +\begin_inset Quotes eld +\end_inset -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding3 -\end_layout +Knuth (1984) +\begin_inset Quotes erd +\end_inset +, +\begin_inset Quotes eld \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +Knuth, 1984 +\begin_inset Quotes erd +\end_inset -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty -\end_layout +, +\begin_inset Quotes eld +\end_inset +1984 +\begin_inset Quotes erd \end_inset - - - - -\begin_inset Text + + etc.). + Note that either package needs specifically designed style files. + They all ship their own, but there are lots of additional style files, + and there is even an interactive style file builder +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +See +\begin_inset Flex URL +status open \begin_layout Plain Layout -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding4 +ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/ \end_layout \end_inset - - -\begin_inset Text -\begin_layout Plain Layout -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty \end_layout \end_inset - - - - -\end_inset - - -\end_layout -\begin_layout Standard -\SpecialChar LyX - doesn't stop you using bullets from packages you don't have. - If you get errors from \SpecialChar LaTeX - when you try to view or print the file, then it - is likely you are missing a package. -\begin_inset Foot + for +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -\SpecialChar LyX - doesn't restrict your use since you may be editing locally and exporting - elsewhere. +natbib \end_layout \end_inset - +. \end_layout \begin_layout Subsection -How to use it +Subdivided Bibliographies \end_layout \begin_layout Standard -Select which bullet depth you want to change then select the bullet shape - and size. - Any changes will not be visible in \SpecialChar LyX -, but are visible when viewing the document. +Sometimes you might need to divide your bibliography into several sections. + If you are for instance a historian, the possibility to separate sources + and scientific works is most likely a +\begin_inset Quotes eld +\end_inset + +must have +\begin_inset Quotes erd +\end_inset + +. + Unfortunately, Bib\SpecialChar TeX + itself does not allow you to do this. + But with the help of some \SpecialChar LaTeX + packages, Bib\SpecialChar TeX + can be extended to fit your needs. \end_layout \begin_layout Standard -You can reset a bullet shape to the default simply by clicking your right - mouse button on the appropriate bullet depth button. +\SpecialChar LyX + provides native support for one of these packages, +\family typewriter +bibtopic +\family default +. \begin_inset Foot -status open - -\begin_layout Plain Layout -If you -\emph on -really -\emph default - want to have multiple sets of paragraphs with different sets of bullets - in each, then you're going to have to get your hands dirty with \SpecialChar TeX - code. - The bullet selection dialog can help though because it provides you with - the \SpecialChar LaTeX - code for a wide range of bullet shapes. - To make your own custom paragraphs you have the following options: -\end_layout +status collapsed \begin_layout Plain Layout -\begin_inset ERT +Available from +\begin_inset Flex URL status open \begin_layout Plain Layout - -\backslash -let -\backslash -savelabelitemi= -\backslash -labelitemi +ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/ \end_layout \end_inset @@ -12447,5020 +12295,5020 @@ labelitemi \end_layout -\begin_layout Plain Layout -\begin_inset ERT -status open +\end_inset -\begin_layout Plain Layout + The advantage of this package (compared to other packages such as +\family typewriter +multibib +\family default +) is that you don't need to define new citation commands. + Instead, you need to prepare different bibliographic databases which include + the entries for the different sections of the bibliography. + For example: If you want to divide your bibliography into the sections + +\begin_inset Quotes eld +\end_inset +Sources +\begin_inset Quotes erd +\end_inset -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -small -\backslash -( -\backslash -sharp -\backslash -)} -\end_layout + and +\begin_inset Quotes eld +\end_inset + +Scientific works +\begin_inset Quotes erd +\end_inset +, you first need to create two bibliographic databases, e. +\begin_inset space \thinspace{} \end_inset +g. +\begin_inset space \space{} +\end_inset -\end_layout -\begin_layout Itemize -Use the \SpecialChar LaTeX - command \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -renewcommand{}{} +sources.bib \end_layout \end_inset - to specify a new bullet shape for a given depth. - You'll also need to save the current bullet shape so you can restore it - again afterwards. - In this itemized list the following \SpecialChar LaTeX - code was used to change the bullet - used for the first depth. -\end_layout - -\begin_deeper -\begin_layout LyX-Code + and +\begin_inset Flex Code +status collapsed -\backslash -let -\backslash -savelabelitemi= -\backslash -labelitemi +\begin_layout Plain Layout +scientific.bib \end_layout -\begin_layout LyX-Code - -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -small -\backslash -( -\backslash -sharp -\backslash -)} -\end_layout +\end_inset -\end_deeper -\begin_layout Itemize -Note that the itemize depth is specified in Roman numerals as part of the +. -\family typewriter - -\backslash -labelitem -\family default - command. \end_layout -\begin_layout Itemize -\begin_inset Argument item:1 -status open - -\begin_layout Plain Layout -\begin_inset ERT -status open +\begin_layout Standard +Go to +\begin_inset Flex Noun +status collapsed \begin_layout Plain Layout - - -\backslash -( -\backslash -star -\backslash -) +Document\SpecialChar menuseparator +Settings \end_layout \end_inset + and check under +\begin_inset Flex Noun +status collapsed +\begin_layout Plain Layout +Bibliography \end_layout \end_inset - Specify each individual entry by starting each item with the bullet shape - enclosed in a -\begin_inset Quotes eld -\end_inset + the option +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Subdivided bibliography +\end_layout -Custom Item -\begin_inset Quotes erd \end_inset - inset (available at -\family sans -Insert\SpecialChar menuseparator -Custom Item -\family default -) and set as -\begin_inset Flex Noun +. + Now you can insert multiple Bib\SpecialChar TeX + bibliographies, one for each section of + your bibliography. + Returning to our example: Insert the Bib\SpecialChar TeX + bibliography +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -\SpecialChar TeX - Code +sources.bib \end_layout \end_inset -. - For example, this item was started with + and a second one for the database \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -( -\backslash -star -\backslash -) +scientific.bib \end_layout \end_inset . -\end_layout + You are free to use the same or different styles for each section. + Additionally, you can choose if the bibliography section should contain + +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -\begin_inset ERT -status open +all cited references +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout + of the specified database(s) (which is the default), +\begin_inset Quotes eld +\end_inset +all uncited references +\begin_inset Quotes erd +\end_inset -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -savelabelitemi} -\end_layout + or even +\begin_inset Quotes eld +\end_inset +all references +\begin_inset Quotes erd \end_inset +. + This might be useful if you would like to separate your bibliography into + three sections: +\begin_inset Quotes eld +\end_inset -\end_layout +Cited sources +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -You'll also need to revert the labelitem back to its previous setting for - the global bullet shape settings to remain in effect. - The way used here was: -\end_layout +, +\begin_inset Quotes eld +\end_inset -\begin_layout LyX-Code +Uncited sources +\begin_inset Quotes erd +\end_inset -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -savelabelitemi} -\end_layout +, and +\begin_inset Quotes eld +\end_inset +Scientific works +\begin_inset Quotes erd \end_inset +. + The titles for the sections can be added as ordinary sections or subsections. + Since +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +bibtopic \end_layout -\begin_layout Chapter -\SpecialChar LyX - and the World Wide Web +\end_inset + + removes the bibliography title, you have to manually re-add that, too (as + a chapter* or section*, for instance). \end_layout \begin_layout Standard -\SpecialChar LyX - has long supported the export of documents to various web-friendly formats, - such as HTML. - Before version 2.0, however, HTML export was always accomplished by the - use of external converters. -\begin_inset Foot +With +\family sans +Biblatex +\family default +, the procedure is a bit different. + Since +\family typewriter +bibtopic +\family default + does not work with +\family sans +Biblatex +\family default +, the aforementioned +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -For details on the use of external converters with \SpecialChar LyX -, see the -\emph on -Converters -\emph default - section of the Customization manual. +Subdivided bibliography \end_layout \end_inset - These fall into two large groups: there are converters that use \SpecialChar LaTeX - as an - intermediate format, such as + option is disabled if you use +\family sans +Biblatex +\family default +. + However, +\family sans +Biblatex +\family default + provides its own means to generate subdivided bibliographies. + You can either add keywords to bibliography entries via the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -htlatex +keywords \end_layout \end_inset -, + entry option and then filter bibliography sections by keyword (by adding + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -html2latex +keyword=mykeyword \end_layout \end_inset -, and -\begin_inset Flex Code + to the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -plastex +Options \end_layout \end_inset -, relying upon \SpecialChar LyX - to produce the \SpecialChar LaTeX -; and there is a converter that works directly - on \SpecialChar LyX - files, -\begin_inset Flex Code + field of the dialog that opens if you left-click on the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +Biblatex Generated Bibliography \end_layout \end_inset -. - All of these have different advantages and disadvantages. - -\end_layout + button), or you can filter by entry types (such as +\emph on +book +\emph default + or +\emph on +article +\emph default +) by entering e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Standard -The \SpecialChar LaTeX --based converters have the advantage that, in principle, they know everythin -g about the exported document that \SpecialChar LaTeX - does. - Such converters do not care, for example, if a certain block of code was - produced by \SpecialChar LyX - or was Evil Red Text. - These converters know about +g. + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -aux +type=book \end_layout \end_inset - files, counters, and references, and can often make use of the + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -bbl +nottype=collection \end_layout \end_inset - files generated by Bib\SpecialChar TeX -. - On the other hand, \SpecialChar LaTeX - is a very hard language to parse—it is sometimes said - that only \SpecialChar TeX - itself understands \SpecialChar TeX -—and \SpecialChar LaTeX --based converters will often choke on - what seem to be quite simple constructs; complex ones can throw them completely -, and as of this writing, for example, the -\emph on -Embedded Objects -\emph default - manual will not export with -\begin_inset Flex Code + to the mentioned +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -htlatex +Options \end_layout \end_inset -, though the others will. - The other issue concerns how math is handled. - These converters typically convert the formulae into little pictures that - are then linked from the HTML document. - Since these are actually generated by \SpecialChar LaTeX -, they are accurate. - But they do not scale well, and just getting them to look as if they are - actually meant to be in your document—so that the font sizes seem to be - roughly the same—can be a challenge. + field, or you can create so-called +\begin_inset Quotes eld +\end_inset + +Bibliography Categories +\begin_inset Quotes erd +\end_inset + + to which you can assign individual entries. + Please refer to the Biblatex manual, section +\emph on +Subdivided Bibliographies +\emph default +, for details. +\end_layout + +\begin_layout Subsection +Multiple Bibliographies +\begin_inset CommandInset label +LatexCommand label +name "subsec:Multiple-Bibliographies" + +\end_inset + + \end_layout \begin_layout Standard -Alex Fernandez's -\begin_inset Flex Code +Multiple bibliographies, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +a bibliography for each part, chapter, section, subsection or child (sub-documen +t) of the document, are also supported by \SpecialChar LyX +. + In order to enable it, go to +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography \end_layout \end_inset - ( -\begin_inset CommandInset href -LatexCommand href -name "http://pinchito.es/elyxer/" -target "http://pinchito.es/elyxer/" -literal "false" - + and select the relevant unit (e. +\begin_inset space \thinspace{} \end_inset -) solves some of these problems. - In particular, the formulae it produces scale perfectly, since it renders - math using a combination of HTML and CSS rather than converting the formulae - to images. - But even moderately complex formula are rendered less well than with -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -htlatex -\end_layout - +g., +\begin_inset Quotes eld \end_inset -; this reflects the limitations of HTML. -\begin_inset Foot -status collapsed +per section +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -That said, -\begin_inset Flex Code +) in the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +Multiple Bibliographies \end_layout \end_inset - can also use jsMath and MathJax for equations, but this setting is only - available globally and requires one to have access to a server that runs - the backend. -\end_layout - + combo box. + Then add a Bib(la)\SpecialChar TeX + bibliography to each unit (e. +\begin_inset space \thinspace{} \end_inset - More importantly (as of version 1.1.1, at least), +g., section) of your document. + In the output, a separate bibliography, containing only the references + done in the current unit is generated. +\end_layout + +\begin_layout Standard +If you use Bib\SpecialChar TeX +, either the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +chapterbib \end_layout \end_inset - has limited support for math macros and no support for user-defined paragraph - or character styles. - These limitations make + or the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +bibtopic \end_layout \end_inset - unsuitable for many of the documents \SpecialChar LyX - users produce. - In principle, of course, these problems could be solved, but the \SpecialChar LyX - developers - have decided to follow a different path and have made \SpecialChar LyX - itself capable of - writing XHTML, just as it is capable of writing \SpecialChar LaTeX -, DocBook, and plaintext. -\end_layout - -\begin_layout Standard -As of this writing, XHTML output remains under development and should probably - be regarded as + package is used to create multiple bibliographies. + The former package is used if you select \begin_inset Quotes eld \end_inset -experimental +per child document \begin_inset Quotes erd \end_inset -. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -The file -\begin_inset Flex Code + and do +\emph on +not +\emph default + check +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -development/HTML/HTML.notes +Sectioned Bibliography \end_layout \end_inset -, which can be found in the \SpecialChar LyX - source tree or -\begin_inset CommandInset href -LatexCommand href -name "accessed online" -target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master" -literal "false" - -\end_inset - -, usually contains up-to-date information about the state of XHTML output. - See also the list of XHTML bugs on -\begin_inset CommandInset href -LatexCommand href -name "the bug tracker" -target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1" -literal "false" - -\end_inset - . + In all other cases, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +bibtopic \end_layout \end_inset - Still, the developers have chosen this approach because it has several - potential advantages over the other two. -\end_layout - -\begin_layout Standard -These advantages are primarily due to the fact that the XHTML output routines, - since they are part of \SpecialChar LyX -, know everything \SpecialChar LyX - knows about the document being - exported. + is used. \begin_inset Foot status collapsed \begin_layout Plain Layout -Another advantage is that, since these routines are internal to \SpecialChar LyX -, they are - immune to changes in \SpecialChar LyX -'s file format, or to changes in the semantics of - existing insets. -\end_layout +An alternative approach, if you are willing to use some +\begin_inset Flex Noun +status collapsed -\end_inset +\begin_layout Plain Layout +\SpecialChar TeX + Code +\end_layout - So they know about the table of contents (as displayed in the outline), - about the counters associated with different paragraph styles, and about - user-defined styles. - The XHTML output routines know what \SpecialChar LyX - knows about internationalization, - too, so they will output -\begin_inset Quotes eld \end_inset -Chapter 1 -\begin_inset Quotes erd + (see section +\begin_inset space ~ \end_inset - or -\begin_inset Quotes eld -\end_inset +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Inserting-TeX-Code" -\lang ngerman -Kapitel -\lang english - 1 -\begin_inset Quotes erd \end_inset -, depending upon the language in effect at the time. - -\end_layout - -\begin_layout Standard -Quite generally, the output routines know what \SpecialChar LyX - knows about document layout, - that is, about how the document is to be rendered on screen. - We use this information when we output the document as XHTML. - In particular, \SpecialChar LyX - -\emph on -automatically -\emph default - generates CSS style information corresponding to the layout information - it uses to render the document on screen: if section headings are supposed - to be sans-serif and bold as seen in \SpecialChar LyX -, then (by default) they will be sans-seri -f and bold when viewed in a web browser, too. - And this is true not just for pre-defined styles, like Section, but for - any style, including user-defined styles. - Indeed, the XHTML output routines make no distinction between user-defined - paragraph and -\change_deleted 244031559 1603876931 -character -\change_inserted 244031559 1603876940 -text -\change_unchanged - styles and \SpecialChar LyX -'s own pre-defined styles: in each case, everything \SpecialChar LyX - knows about - the styles is contained in the layout files. - And much the same is true as regards pre-defined textual insets, such as - footnotes, and various custom insets. - -\end_layout - -\begin_layout Standard -The result is that XHTML output can be customized and extended in exactly - the same way \SpecialChar LaTeX - output can be customized and extended: through layout files - and modules. - See chapter five of the -\emph on -Customization -\emph default -manual for the details. -\end_layout +), is to use the +\begin_inset Flex Code +status collapsed -\begin_layout Standard -The remainder of this chapter contains more detailed information on XHTML - output, its limitations, and ways to work around those limitations. +\begin_layout Plain Layout +bibunits \end_layout -\begin_layout Section -Math Output in XHTML -\end_layout +\end_inset -\begin_layout Standard -\SpecialChar LyX - offers four choices for how math is rendered. - These have various advantages and disadvantages: + package. \end_layout -\begin_layout Itemize -MathML -\begin_inset Newline newline -\end_inset - -MathML is a dialect of XML designed specifically for mathematics on the - web, and it typically renders very well in browsers that support it. - The disadvantage is that not all browsers support MathML, and support is - not complete even in the Gecko-based browsers, such as Firefox. -\begin_inset Newline newline \end_inset -If \SpecialChar LyX - is unable to render a formula as MathML—for example, if the formula - uses the + If \begin_inset Flex Code status collapsed \begin_layout Plain Layout -xymatrix +bibtopic \end_layout \end_inset - package or ERT—then it will instead output the formula as an image. - + is used, \SpecialChar LyX + encloses the specified units in +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +bibtopic \end_layout -\begin_layout Itemize -HTML -\begin_inset Newline newline \end_inset -As mentioned above, +'s \begin_inset Flex Code status collapsed \begin_layout Plain Layout -elyxer + +\backslash +begin{btUnit} \end_layout \end_inset - outputs math as HTML, styled by CSS. -\begin_inset Foot + and +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -\SpecialChar LyX - has borrowed some of the CSS for its HTML output from + +\backslash +end{btUnit} +\end_layout + +\end_inset + + in order to create the units. + Note that this approach has some limitations. + First, every citation reference has to be inside some \begin_inset Flex Code status collapsed \begin_layout Plain Layout -elyxer +btUnit \end_layout \end_inset . -\end_layout + So citations outside a defined unit (e. +\begin_inset space \thinspace{} +\end_inset +g., before the first section if you use +\begin_inset Quotes eld \end_inset - For simple formulae, this can work quite well, though with more complicated - formulae it tends to break down. - Still, this method has the advantage that it is very widely supported and - so it may be appropriate for documents that contain only a little, fairly - simple math. -\begin_inset Newline newline +by section +\begin_inset Quotes erd \end_inset -If Lyx is unable to render a formula as HTML—for example, if the formula - uses the +) will appear as +\begin_inset Quotes eld +\end_inset + +??? +\begin_inset Quotes erd +\end_inset + +. + You can also create your own units by entering \begin_inset Flex Code status collapsed \begin_layout Plain Layout -xymatrix + +\backslash +begin{btUnit} \end_layout \end_inset - package or ERT—then it will instead output the formula as an image. - + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +end{btUnit} \end_layout -\begin_layout Itemize -Images -\begin_inset Newline newline \end_inset -Like + as \SpecialChar TeX + code (for instance to work around the mentioned limitation). + Note, though, that \begin_inset Flex Code status collapsed \begin_layout Plain Layout -htlatex +btUnit \end_layout \end_inset -, \SpecialChar LyX - will output formulae as images, the very same images, in fact, that are - used for instant preview. -\begin_inset Foot +s cannot be nested. + A second limitation is that +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Instant preview does -\emph on -not -\emph default -have to be on for images to be output, however. +bibtopic \end_layout \end_inset - The advantage to this method is that the images are simply generated by - \SpecialChar LaTeX -, so they are very accurate. - The disadvantage, as mentioned earlier, is that these are bitmapped images, - so they do not scale terribly well, and one cannot copy them, etc. -\begin_inset Newline newline + always processes all references of a bibliography database, even if they + are not cited. + This can result in odd labels (e. +\begin_inset space \thinspace{} \end_inset -The size of the images can be controlled by setting the +g. + \begin_inset Quotes eld \end_inset -Math Images Scaling +Miller 2014b \begin_inset Quotes erd \end_inset - parameter under -\begin_inset Flex Noun + if two works of this author from 2014 are in the database, even if only + one is cited). +\end_layout + +\begin_layout Standard +If you use +\family sans +Biblatex +\family default +, the +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Formats +refsection \end_layout \end_inset -. -\begin_inset Foot + option is used instead. + If you need specific units, you can start them with the \SpecialChar TeX + code +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -For those who want to know, this controls the resolution of the image in - dots per inch and is based upon a default of 75 dpi. + +\backslash +newrefsection \end_layout \end_inset + or +\begin_inset Flex Code +status collapsed -\begin_inset Newline newline -\end_inset +\begin_layout Plain Layout -If \SpecialChar LyX - for some reason fails to create an image for a formula (e.g., if a required - \SpecialChar LaTeX - package is not installed), then it will fall back to outputing the raw - \SpecialChar LaTeX -. +\backslash +newrefsegment \end_layout -\begin_layout Itemize -\SpecialChar LaTeX +\end_inset + +, respectively. + If you also want to control the end of the unit, use the environment +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +begin{refsection} +\end_layout -\begin_inset Newline newline \end_inset -Finally, \SpecialChar LyX - will happily output math as \SpecialChar LaTeX -. - As well as being the output of last resort, this method can be used with - such tools as -\begin_inset CommandInset href -LatexCommand href -name "jsMath" -target "http://www.math.union.edu/~dpvc/jsMath/" -literal "false" + \SpecialChar ldots + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +end{refsection} +\end_layout \end_inset -, which uses JavaScript to render \SpecialChar LaTeX - embedded in HTML documents. - \SpecialChar LyX - wraps the \SpecialChar LaTeX - in either a + instead. + Note, though, that \begin_inset Flex Code status collapsed -\begin_layout Plain Layout -span -\end_layout +\begin_layout Plain Layout +refsection +\end_layout + +\end_inset + +s cannot be nested. + In addition to the individual bibliography of the current unit, +\family sans +Biblatex +\family default + also provides an easy way to output all bibliographies, subsequently, at + one place (e. +\begin_inset space \thinspace{} +\end_inset + +g., at the end of the document). + Select +\begin_inset Quotes eld +\end_inset + +all reference units +\begin_inset Quotes erd +\end_inset + + from the Content combo box of the Bib(la)TeX inset dialog in order to achieve + this. + Please refer to the +\family sans +Biblatex +\family default + manual for more information on this topic. +\end_layout + +\begin_layout Section +Multipart Documents +\end_layout + +\begin_layout Subsection +General Operation +\end_layout + +\begin_layout Standard +When you are working on a large file with many sections, it is often convenient + to break up the document into several files, or perhaps you have something + where a table may change from time to time, but the preceding text does + not. + In these cases, you should seriously consider using multipart documents. + For example, scientific papers often have five major sections: the introduction +, observations, results, discussion, and conclusion. + Each of these could be its own separate \SpecialChar LyX + file, with one +\begin_inset Quotes eld +\end_inset + +master +\begin_inset Quotes erd +\end_inset + + file which contains the title, authors, abstract, references, etc., plus + the five included files. + It is important to note that each of these files is a full \SpecialChar LyX + file which + can be formatted and printed on its own, as well as included in a master + file. + Each of these files must have the same document class, however—don't attempt + to mix book classes with article classes. + You may also include \SpecialChar LaTeX + files; however, these files must not have their own + preamble (i. +\begin_inset space \thinspace{} +\end_inset +e. +\begin_inset space \space{} \end_inset - (for inline formulas) or +everything up to and including the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -div + +\backslash +begin{document} \end_layout \end_inset - (for displayed formulas) with + line as well as the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -class='math' + +\backslash +end{document} \end_layout \end_inset -, as is required for jsMath. + line must be deleted) or else errors will be generated when you try to + make a DVI file. \end_layout \begin_layout Standard -One of these output methods must be selected under +\SpecialChar LyX + allows you to include files quite easily with \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Formats +Insert\SpecialChar menuseparator +Child +\begin_inset space ~ +\end_inset + +Document \end_layout \end_inset . - By default, \SpecialChar LyX - outputs MathML. - This is a document-wide setting, therefore. + When you click on this selection a small box is inserted into the file + at the current cursor location. + Clicking on the box raises a dialog which allows you to select the file + to be included, and the method of its inclusion. + \end_layout \begin_layout Standard -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 +The file selection box should by now be obvious. + The three inclusion methods are +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -That said, since \SpecialChar LyX - falls back to images if the inset contains ERT, then one - can force output as an image by putting some harmless ERT into the math, - for example: -\begin_inset Formula $a=b\relax$ +include +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +input +\begin_inset Quotes erd +\end_inset + +, and +\begin_inset Quotes eld +\end_inset + +verbatim +\begin_inset Quotes erd \end_inset . -\end_layout + The methods +\begin_inset Quotes eld +\end_inset +include +\begin_inset Quotes erd \end_inset + and +\begin_inset Quotes eld +\end_inset -\end_layout +input +\begin_inset Quotes erd +\end_inset -\begin_layout Section -Bibliography and Citations + are similar in many ways, but there are also some notable differences: \end_layout -\begin_layout Standard -XHTML output fully supports bibliographies and citations. - -\end_layout +\begin_layout Enumerate +Files that are +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -Citation labels are generated by the same machinery that generates \SpecialChar LyX -'s on-screen - labels, so the labels will look in the output much as they do in \SpecialChar LyX -, though - better. - If you are using numerical citations, then \SpecialChar LyX - will output numerical labels, - such as [1] or [17], rather than simply showing the citation key in square - brackets, as it does on-screen. - If you are using author-year citations, then \SpecialChar LyX - will add lowercase letters - to the years, just as Bib\SpecialChar TeX - does, if it finds more than one citation for - a given author-year combination. - The labels will be printed with the bibliography entries. - Note that there is, at present, no way to customize the appearance of the - labels, for example, to choose between square brackets and parentheses. -\end_layout +included +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Bibliography output is handled by the same machinery that handles the presentati -on of reference information in the citation dialog, so you will see in the - XHTML output pretty much what you would see if you were to look at a given - entry in the citation dialog. - The formatting can be customized in your layout file or, preferably, in - a module. - See the -\emph on -Customization -\emph default - manual for the details. -\end_layout + are typeset beginning on a new page, while files that are +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -The main defect at present is that cross-referenced information is printed - with every entry with which it is associated. - So you can see things like this: +inputted +\begin_inset Quotes erd +\end_inset + + are typeset starting on the current page. \end_layout -\begin_layout Quote -Jason Stanley, +\begin_layout Enumerate \begin_inset Quotes eld \end_inset -Context and Logical Form +Included \begin_inset Quotes erd \end_inset -, in -\emph on -Language in Context: Selected Essays -\emph default - (Oxford: Oxford University Press, 2007), pp. - 30–68. -\end_layout + files cannot themselves +\begin_inset Quotes eld +\end_inset -\begin_layout Quote -Jason Stanley, +include +\begin_inset Quotes erd +\end_inset + + further files ( \begin_inset Quotes eld \end_inset -Semantics in Context +grandchilds \begin_inset Quotes erd \end_inset -, in -\emph on -Language in Context: Selected Essays -\emph default - (Oxford: Oxford University Press, 2007), pp. - 201–30. -\end_layout +). + With +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -This should be fixed before long. -\end_layout +input +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -There is no support at present for sectioned bibliographies. - If you have multiple bibliographies, then \SpecialChar LyX - will print the same bibliography - over and over. +, on the other hand, infinite sub-inputting is possible. \end_layout -\begin_layout Section -Indexes -\end_layout +\begin_layout Enumerate +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -\SpecialChar LyX - will happily export indexes as XHTML, but with certain limitations at the - moment. -\end_layout +Include +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Index export will be most reliable when you do not attempt to use the fancy - constructs that are described in the section on indexes in the + allow for the output of only selected +\begin_inset Quotes eld +\end_inset + +included +\begin_inset Quotes erd +\end_inset + + files, while maintaining the actual counters (pagination etc.) and references + (please refer to the section \emph on -User's Guide +Child +\begin_inset space ~ +\end_inset + +Documents \emph default -. -\begin_inset Foot -status collapsed + of the +\emph on +Embedded +\begin_inset space ~ +\end_inset -\begin_layout Plain Layout -The main issue here is that \SpecialChar LyX - itself does not really handle these. - It just lets you enter what you would have to enter in raw \SpecialChar LaTeX -. +Objects +\emph default + manual for details). \end_layout +\begin_layout Standard +Hence, +\begin_inset Quotes eld \end_inset - We'll describe how they are handled using the subsection headings from - that section. -\end_layout +include +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize -Grouping Index Entries (aka, sub-entries): \SpecialChar LyX - makes an effort to support these, - but the entries must be separated by + is the preferred method for chapters that are outsourced to child documents, + while \begin_inset Quotes eld \end_inset - ! +input \begin_inset Quotes erd \end_inset -, that is, there must be spaces around the exclamation point. - This is because it is otherwise too difficult to check for escaped exclamation - points, ones in math, and so forth. -\end_layout - -\begin_layout Itemize -Page Ranges: There is no support at all for page ranges, since these make - no sense with XHMTL. - Instead, you will just get two index entries, one at either end. + is more suitable for arbitrary file inheritance. \end_layout -\begin_layout Itemize -Cross-referencing: There is no support for cross-referencing. - If \SpecialChar LyX - finds an entry containing the +\begin_layout Standard +A \begin_inset Quotes eld \end_inset -|see\SpecialChar ldots - +verbatim \begin_inset Quotes erd \end_inset - construct, it is just dropped, and the rest is treated as an ordinary index - entry. -\end_layout - -\begin_layout Itemize -Index Entry Order: \SpecialChar LyX - does support attempts to fix the sorting order. - It will take what is before the first `@' it finds and use that for sorting, - taking what follows the first `@' to be the actual entry. - At present, \SpecialChar LyX - does not check for escaped `@', so do not try to index email - addresses. -\end_layout - -\begin_layout Itemize -Index Entry Layout: You can format entries by using the text style dialog, - or by using any other method available within \SpecialChar LyX - itself. - There is no support for constructs like: -\begin_inset Quotes eld + included file allows you to include a file typeset exactly as it appears + in the file, i. +\begin_inset space \thinspace{} \end_inset -entry|textbf -\begin_inset Quotes erd +e. +\begin_inset space \space{} \end_inset -. - Indeed, if \SpecialChar LyX - finds a pipe symbol, `|', in an entry, it will delete it and - everything that follows it. -\end_layout +in +\begin_inset Flex Code +status collapsed -\begin_layout Itemize -Multiple Indexes: There is no support for multiple indexes. - Rather, all index entries will be printed as one large index. - To avoid our printing several versions of the index, we print only the - main index, so make sure you have one. +\begin_layout Plain Layout +verbatim \end_layout -\begin_layout Section -Nomenclature and Glossary -\end_layout +\end_inset -\begin_layout Standard -There is at present no support for glossaries. - Adding it would be fairly trivial, and welcome. -\end_layout + mode, with the characters set in a fixed-width typewriter font. + Normally, spaces in this file are invisible, though two consecutive spaces + are conserved, unlike \SpecialChar LyX +'s normal treatment of spaces. + However, setting the +\begin_inset Flex Noun +status collapsed -\begin_layout Chapter +\begin_layout Plain Layout +Mark +\begin_inset space ~ +\end_inset -\change_inserted 1075283030 1616534180 -DocBook Output -\end_layout +spaces +\begin_inset space ~ +\end_inset -\begin_layout Standard +in +\begin_inset space ~ +\end_inset -\change_inserted 1075283030 1616534386 -Apart from HTML, \SpecialChar LyX - can generate documents in the DocBook XML vocabulary. - With versions 2.3 and before, only select templates could be used to generate - DocBook documents (only version 4). - Starting with \SpecialChar LyX - 2.4, most \SpecialChar LyX - layouts can generate valid DocBook documents (only - version 5). - This feature is built into \SpecialChar LyX - and does not require the use of external tools. +output \end_layout -\begin_layout Standard +\end_inset -\change_inserted 1075283030 1616534437 -The result is that the DocBook output can be customized and extended in - exactly the same way \SpecialChar LaTeX - output can be customized and extended: through layout - files and modules. - See chapter five of the -\emph on -Customization -\emph default -manual for the details. + checkbox typesets a mark to unambiguously define the presence of a space. + \end_layout \begin_layout Standard - -\change_inserted 1075283030 1616534475 -Most \SpecialChar LyX - features are supported with DocBook, like math output. +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 Itemize - -\change_inserted 1075283030 1616534741 -Math output is performed mostly in MathML (the major exception being constructio -ns not supported by \SpecialChar LyX -, i.e. - ERTs). - All formulae are also available in raw \SpecialChar TeX - in the DocBook output for further - processing. +\begin_layout Subsection +Cross-References Between Files \end_layout -\begin_layout Itemize +\begin_layout Standard +\begin_inset Box Shadowbox +position "t" +hor_pos "c" +has_inner_box 1 +inner_pos "t" +use_parbox 0 +use_makebox 0 +width "100col%" +special "none" +height "1in" +height_special "totalheight" +thickness "0.4pt" +separation "3pt" +shadowsize "4pt" +framecolor "black" +backgroundcolor "none" +status open -\change_inserted 1075283030 1616534852 -Bibliographies and citations are implemented, including with an external - BibTeX file. - Bibliography entries are not prerendered when the detailed information - are available, but rather output with the standard DocBook constructs. - The external DocBook processor is expected to handle the rendering of entries. +\begin_layout Plain Layout +This section is somewhat out of date. + Need to describe default master documents and how children are opened when + the master is. + [[FIXME]] \end_layout -\begin_layout Itemize - -\change_inserted 1075283030 1616534863 -Indexes are supported, including multiple indices. - Grouping (with -\family typewriter -! -\family default -), page ranges, and cross-references ( -\family typewriter -|see -\family default -) are supported, with the exception of the same symbols escaped. - Entry order ( -\family typewriter -@ -\family default -) and layout ( -\family typewriter -|mathbf -\family default -) are not supported. - There is no support for escaping of index entries. -\end_layout +\end_inset -\begin_layout Itemize -\change_inserted 1075283030 1616534884 -Glossaries are implemented. \end_layout \begin_layout Standard +It is possible to set up cross-references between the different files. + First, open all the files in question: let's call them A and B in a two + file example, where B is included in A. + Let's say you insert a label in A, then want to reference it in B. + Open the cross-reference dialog whilst in document B, and you can select + the +\begin_inset Quotes eld +\end_inset -\change_inserted 1075283030 1616534894 -Two major parameters can be set at the document level. -\end_layout - -\begin_layout Itemize +buffer +\begin_inset Quotes erd +\end_inset -\change_inserted 1075283030 1616534948 -Format for tables: \SpecialChar LyX - can generate tables either as HTML (default value) or - CALS, depending on the user's requirements. - Most DocBook processors accept both formats. + to use. \end_layout -\begin_layout Itemize - -\change_inserted 1075283030 1616535006 -MathML prefix: in DocBook, MathML is included within its own name space, - unlike HTML. - The implication is that there must be an indication of the tags belonging - to the MathML standard. - Three choices are offered: +\begin_layout Subsection +Bibliography Lists in all Subdocuments \end_layout -\begin_deeper -\begin_layout Itemize - -\change_inserted 1075283030 1616535044 -Inline: the MathML name space is defined for each formula (using the -\family typewriter -xmlns -\family default - attribute on each formula) +\begin_layout Standard +If you work with child documents, you might want to have only one main bibliogra +phy at the end, but still be able to have a selected bibliography for the + child if you output it on its own. + Here is how to achieve this. \end_layout -\begin_layout Itemize +\begin_layout Standard +For the main document, you just insert a bibliography inset at the place + where the main bibliography has to appear (within the master file or within + a child). + If the bibliography inset is in the master file, the references will be + inherited by all children, so they are available in the citation dialog + within each child. +\end_layout -\change_inserted 1075283030 1616535090 -With the -\family typewriter -m -\family default - prefix (default): the MathML name space is defined at the document level - (using the -\family typewriter -xmlns:m -\family default - attribute on the root element). - Each MathML is prefixed with -\family typewriter -m +\begin_layout Standard +For child-specific bibliographies, insert bibliography insets within the + child documents, at the place where the bibliography should appear when + the child is compiled separately. + However, the trick is to insert them into a branch ( +\family sans +Insert\SpecialChar menuseparator +Branch\SpecialChar menuseparator +Insert New Branch... \family default -: for instance, -\family typewriter -m:math -\end_layout +), e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Itemize +g. + called +\begin_inset Quotes eld +\end_inset -\change_inserted 1075283030 1616620405 -With the -\family typewriter -mml +Childonly +\begin_inset Quotes erd +\end_inset + +. + Within the children, activate the branch ( +\family sans +Document\SpecialChar menuseparator +Settings...\SpecialChar menuseparator +Branches \family default - prefix: similar to the -\family typewriter -m +). + Within the master, deactivate the branch ( +\family sans +Document\SpecialChar menuseparator +Settings...\SpecialChar menuseparator +Branches \family default - option, but with -\family typewriter -mml +). + Now the child's bibliography will be ignored by the master, but considered + by the child. \end_layout \begin_layout Standard +If you need multiple bibliographies (e. +\begin_inset space \thinspace{} +\end_inset -\change_inserted 1075283030 1616620470 -This option is especially useful if you want \SpecialChar LyX - to match your personal style - or to work with buggy software that only accepts one prefix for MathML. -\change_unchanged +g., one per child in the +\emph on +main document +\emph default +), please refer to sec. +\begin_inset space ~ +\end_inset -\end_layout -\end_deeper -\begin_layout Chapter -The \SpecialChar LyX - Server +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Multiple-Bibliographies" + +\end_inset + +. \end_layout \begin_layout Section -Introduction +\SpecialChar LyX + Archives \end_layout \begin_layout Standard -The `\SpecialChar LyX - server' allows other programs to talk to \SpecialChar LyX -, invoke \SpecialChar LyX - commands, and retrieve - information about the \SpecialChar LyX - internal state. - This is only intended for advanced users, but they should find it useful. - It is by writing to the \SpecialChar LyX - server, for example, that bibliography managers, - such as JabRef, are able to +Users sometimes need to be able to \begin_inset Quotes eld \end_inset -push +bundle \begin_inset Quotes erd \end_inset - citations to \SpecialChar LyX -. -\end_layout + a \SpecialChar LyX + file together with all the images (and other files) on which it depends, + either for sending to a publisher or for sharing with a co-author. + \SpecialChar LyX + includes a Python script ( +\begin_inset Flex Code +status collapsed -\begin_layout Section -Starting the \SpecialChar LyX - Server -\begin_inset CommandInset label -LatexCommand label -name "sec:Starting-the-Server" +\begin_layout Plain Layout +lyxpak.py +\end_layout \end_inset +) that automates this process. + To use it, you must have either the +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +zipfile \end_layout -\begin_layout Standard -The \SpecialChar LyX - server works through the use of a pair of named pipes. - These are usually located in +\end_inset + + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -UserDir +tarfile \end_layout \end_inset -, (except on Windows, where -\emph on -local -\emph default - named pipes are special objects located in + python modules installed on your system. + By default, the script prefers the \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash - -\backslash -. -\backslash -pipe +gzip \end_layout \end_inset -) and have the names -\begin_inset Quotes eld -\end_inset - - +-compressed \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpipe.in +tar \end_layout \end_inset + format on Unix-like systems and the +\begin_inset Flex Code +status collapsed -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +zip +\end_layout - and -\begin_inset Quotes eld \end_inset + format on Windows. +\end_layout +\begin_layout Standard +\SpecialChar LyX +'s configuration process will set the script up to export a `\SpecialChar LyX + Archive', + and this format will then be available under \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpipe.out +File\SpecialChar menuseparator +Export \end_layout \end_inset +. +\end_layout + +\begin_layout Standard +Independently of the platform, the generation of a particular archive format + can be forced by adding either the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-t +\end_layout -\begin_inset Quotes erd \end_inset -. - External programs write into + (for the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpipe.in +tar \end_layout \end_inset - and read back data from + format) or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpipe.out +-z \end_layout \end_inset -. - The stem of the pipe names can be defined in the -\begin_inset Flex Noun + (for the +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences +zip \end_layout \end_inset - dialog, for example + format) switch to the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -"/home/myhome/lyxpipe" +\SpecialChar LyX +\SpecialChar menuseparator +\SpecialChar LyX + Archive \end_layout \end_inset -, or + converter in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -" -\backslash +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +Converters +\end_layout + +\end_inset -\backslash . -\backslash -pipe -\backslash -lyxpipe" + (Make sure you add the switch after the script name, not before it.) \end_layout -\end_inset +\begin_layout Section +Fancy Headers and Footers +\end_layout - on Windows (where any working path instead of lyxpipe can be used, for - example +\begin_layout Standard +The default page layout is rather plain; for an \begin_inset Flex Code status collapsed \begin_layout Plain Layout -" -\backslash - -\backslash -. -\backslash -pipe -\backslash -my -\backslash -lyx -\backslash -pipe" +article \end_layout \end_inset - would also work). - You + document class, all you get is a centered page number at the bottom of + the page. + This document uses KOMA-script's book class, so it appears to be a bit + fancier. + But to really put on a show, you need to set the document page style to + +\begin_inset Quotes eld +\end_inset + +fancy +\begin_inset Quotes erd +\end_inset + +, as mentioned in the \emph on -must +User Guide \emph default - configure this manually in order for the server to start. +. + 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 -\SpecialChar LyX - will add the ' +For more information on fancy headers, see the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -.in +fancyhdr \end_layout \end_inset -' and ' -\begin_inset Flex Code + package documentation. + ( +\begin_inset Flex URL status collapsed \begin_layout Plain Layout -.out + +https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html \end_layout \end_inset -' to create the pipes. - If one of the pipes already exists, \SpecialChar LyX - will assume that another \SpecialChar LyX - process - is already running and will not start the server. - On POSIX (Unix like) systems, if for some other reason, an unused +) +\end_layout + +\begin_layout Standard +The page header is divided into three fields, not surprisingly labeled \begin_inset Quotes eld \end_inset -stale +left \begin_inset Quotes erd \end_inset - pipe is left in existence when \SpecialChar LyX - closes, then \SpecialChar LyX - will try to delete it. - If this fails for some reason, you will need to delete the pipes manually - and then restart \SpecialChar LyX -. - On Windows, pipes are deleted by the OS on program termination or crash, - so +, \begin_inset Quotes eld \end_inset -stale +center \begin_inset Quotes erd \end_inset - pipes should not be possible. -\end_layout +, and +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -To have several \SpecialChar LyX - processes with servers at the same time, you have to use - different configurations, perhaps by using separate user directories, each - with its own +right +\begin_inset Quotes erd +\end_inset + +. + The footer is also divided into these three fields. + The \SpecialChar LaTeX + commands to set these fields in the simplest manner are \begin_inset Flex Code status collapsed \begin_layout Plain Layout -preferences + +\backslash +lhead \end_layout \end_inset - file, for each process. -\end_layout - -\begin_layout Standard -If you are developing a client program, you might find it useful to enable - debugging information from the \SpecialChar LyX - server. - Do this by starting \SpecialChar LyX - as +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyx -dbg lyxserver + +\backslash +chead \end_layout \end_inset -. -\end_layout - -\begin_layout Standard -You can find a complete example client written in C++ in the source distribution - as +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -development/lyxserver/server_monitor.cpp + +\backslash +rhead \end_layout \end_inset -. -\end_layout - -\begin_layout Standard -Another useful tool is the command-line based client found in +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -src/client/lyxclient + +\backslash +lfoot \end_layout \end_inset -. +, etc. + Suppose you wish to put your name in the upper left hand corner of each + page. + Simply insert the following command in the preamble: \end_layout -\begin_layout Section -Normal communication +\begin_layout Standard + +\family typewriter + +\backslash +lhead{John Q. + DocWriter} \end_layout \begin_layout Standard -To issue a \SpecialChar LyX - call, the client writes a line of ASCII text into the input - pipe. - This line has the following format: -\end_layout +You will now see your name in the upper left. + If a field has a default entry that you would like to get rid of (often + the page number appears in the central footer) simply include a command + with a blank argument, e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Quote -LYXCMD: -\emph on -clientname -\emph default -: -\emph on -function -\emph default -: -\emph on -argument +g.: \end_layout -\begin_layout Description -clientname is a name that the client can choose arbitrarily. - Its only use is that \SpecialChar LyX - will echo it if it sends an answer—so a client can - dispatch results from different requesters. -\end_layout +\begin_layout Standard -\begin_layout Description -function is the function you want \SpecialChar LyX - to perform. - It is the same as the commands you'd use in the minibuffer. +\family typewriter + +\backslash +cfoot{} \end_layout -\begin_layout Description -argument is an optional argument which is meaningful only to some functions - (for instance, the +\begin_layout Standard +Let's get really fancy: lets put the section number with the word \begin_inset Quotes eld \end_inset -self-insert +Section \begin_inset Quotes erd \end_inset - LFUN will insert the argument as text at the cursor position). -\end_layout + (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Standard -The answer from \SpecialChar LyX - will arrive in the output pipe and be of the form -\end_layout +g. +\begin_inset space \space{} +\end_inset -\begin_layout Quote -INFO: -\emph on -clientname -\emph default -: -\emph on -function -\emph default -: -\emph on -data +Section 3) in the upper left, the page number (e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +Page 4) in the upper right, your name in the lower left, and the date in + the lower right. + The following commands should now appear in the preamble: \end_layout \begin_layout Standard -where -\emph on -clientname -\emph default - and -\emph on -function -\emph default - are just echoed from the command request, while -\emph on -data -\emph default - is more or less useful information filled according to how the command - execution worked out. - Some commands, such as -\begin_inset Quotes eld -\end_inset -font-state -\begin_inset Quotes erd -\end_inset +\family typewriter -, 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. +\backslash +lhead{Section +\backslash +thesection} \end_layout \begin_layout Standard -In case of errors, the response from \SpecialChar LyX - will have this form -\end_layout -\begin_layout Quote -ERROR: -\emph on -clientname -\emph default -: -\emph on -function -\emph default -: -\emph on -error message +\family typewriter + +\backslash +chead{} \end_layout \begin_layout Standard -where the -\emph on -error message -\emph default - should contain an explanation of why the command failed. + +\family typewriter + +\backslash +rhead{Page +\backslash +thepage} \end_layout \begin_layout Standard -Examples: -\end_layout -\begin_layout LyX-Code -echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in -\begin_inset Newline newline -\end_inset +\family typewriter -echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in -\begin_inset Newline newline -\end_inset +\backslash +lfoot{John Q. + DocWriter} +\end_layout -read a <~/.lyxpipe.out -\begin_inset Newline newline -\end_inset +\begin_layout Standard -echo $a -\end_layout +\family typewriter -\begin_layout Subsection -AppleScript (Mac OS X) +\backslash +cfoot{} \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. + +\family typewriter + +\backslash +rfoot{ +\backslash +today} \end_layout \begin_layout Standard -Example: -\end_layout +The commands +\begin_inset Flex Code +status collapsed -\begin_layout LyX-Code -tell application "\SpecialChar LyX -" -\end_layout +\begin_layout Plain Layout -\begin_layout LyX-Code - try +\backslash +thesection \end_layout -\begin_layout LyX-Code - -- Stores the current file name into f -\end_layout +\end_inset -\begin_layout LyX-Code - set f to (run "server-get-filename" with argument "") -\end_layout + and +\begin_inset Flex Code +status collapsed -\begin_layout LyX-Code - on error the error_message number the error_number -\end_layout +\begin_layout Plain Layout -\begin_layout LyX-Code - display dialog "Error: " & the error_number & ". - " ¬ +\backslash +thepage \end_layout -\begin_layout LyX-Code - & the error_message buttons {"OK"} default button 1 -\end_layout +\end_inset -\begin_layout LyX-Code - end try -\end_layout + access \SpecialChar LaTeX +'s section and page counters, and so print out the current section + and page number. + +\begin_inset Flex Code +status collapsed -\begin_layout LyX-Code -end tell +\begin_layout Plain Layout + +\backslash +today \end_layout -\begin_layout Section -Notification +\end_inset + + simply prints out today's date. \end_layout \begin_layout Standard -\SpecialChar LyX - can notify clients of events going on asynchronously. - Currently it will only do this if the user binds a key sequence with the - function -\begin_inset Quotes eld +The thicknesses of the horizontal rules drawn beneath the header and above + the footer can also be modified. + If you don't want one of the rules, set its thickness to 0. + The header rule has a default thickness of 0.4pt, the footer rule is 0pt. + Use commands +\family typewriter + +\family default +like +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +renewcommand{ +\backslash +headrulewidth}{0.4pt} +\end_layout + \end_inset -notify -\begin_inset Quotes erd + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +renewcommand{ +\backslash +footrulewidth}{0.4pt} +\end_layout + \end_inset -. - The format of the string \SpecialChar LyX - sends is as follows: + to set the thicknesses. \end_layout -\begin_layout Quote +\begin_layout Standard +You can switch the header/footer settings on and off for individual pages + using commands like \begin_inset Flex Code status collapsed \begin_layout Plain Layout -NOTIFY: + +\backslash +thispagestyle{empty} \end_layout \end_inset +, +\begin_inset Flex Code +status collapsed -\emph on -key-sequence -\end_layout +\begin_layout Plain Layout -\begin_layout Standard -where -\emph on -key-sequence -\emph default - is the printed representation of the key sequence that was actually typed - by the user. +\backslash +thispagestyle{plain} \end_layout -\begin_layout Standard -This mechanism can be used to extend \SpecialChar LyX -'s command set and implement macros. - Bind some key sequence to -\begin_inset Quotes eld \end_inset -notify -\begin_inset Quotes erd +, and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +thispagestyle{fancy} +\end_layout + \end_inset . - Then start a client that listens on the output pipe, dispatches the command - according to the sequence, and starts a function that may use \SpecialChar LyX - calls and - \SpecialChar LyX - requests to issue a command or a series of commands to \SpecialChar LyX -. + Simply insert them in the text on the page you want changed and mark them + as \SpecialChar TeX + code. + In fact, title pages are marked as plain by default, while following pages + are marked fancy when using the global fancy setting. \end_layout -\begin_layout Section -The simple \SpecialChar LyX - Server Protocol +\begin_layout Standard +As a final example, it is possible to include an image in the header or + footer. + Suppose you want to put a company logo in the upper lefthand corner. + You might try something like \end_layout \begin_layout Standard -\SpecialChar LyX - implements a simple protocol that can be used for session management. - All messages are of the form -\end_layout -\begin_layout Quote -LYXSRV: -\emph on -clientname -\emph default -: -\emph on -protocol message +\family typewriter + +\backslash +lhead{ +\backslash +resizebox{1in}{!}{ +\backslash +includegraphics{logo.eps}}} \end_layout \begin_layout Standard -where -\emph on -protocol message -\emph default - can be -\begin_inset Quotes eld -\end_inset +\noindent +(you may need to preface this with +\begin_inset Flex Code +status collapsed -hello -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout - or -\begin_inset Quotes eld -\end_inset +\backslash +usepackage{graphics} +\end_layout -bye -\begin_inset Quotes erd \end_inset -. - If -\begin_inset Quotes eld -\end_inset + if you don't include graphics elsewhere in your document). +\end_layout -hello -\begin_inset Quotes erd -\end_inset +\begin_layout Section +Itemize Bullet Selection +\begin_inset CommandInset label +LatexCommand label +name "sec:bullet" - is received from a client, \SpecialChar LyX - will report back to inform the client that - it's listening to it's messages, while -\begin_inset Quotes eld \end_inset -bye -\begin_inset Quotes erd -\end_inset - sent from \SpecialChar LyX - will inform clients that \SpecialChar LyX - is closing. \end_layout -\begin_layout Section -Reverse DVI/PDF search +\begin_layout Standard +by +\noun on + Allan Rae +\end_layout + +\begin_layout Subsection +Introduction \end_layout \begin_layout Standard -Some DVI/PDF viewers +\SpecialChar LyX + provides 216 bullet shapes that can be accessed from a simple dialog. + Using this dialog you can easily specify what bullet shape to use at each + level of an itemized list. + These settings are document-wide so you won't be able to specify different + sets of bullets for different paragraphs. \begin_inset Foot status collapsed \begin_layout Plain Layout -The following viewers offer the reverse PDF search feature: Okular on KDE/Linux, - Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows. +Well, actually you can but you'll have to do it by hand. \end_layout \end_inset - provide -\emph on -reverse search -\emph default - facility (also called -\emph on -inverse search -\emph default -). - This means that you can tell \SpecialChar LyX - to put the cursor to a specific line in the - document by clicking at the respective position in the DVI/PDF output. - To achieve this, the viewer must be able to communicate with \SpecialChar LyX -. - This is done via the \SpecialChar LyX - server either by using the named pipe ( -\emph on -lyxpipe -\emph default -), or the UNIX domain socket ( -\emph on -lyxsocket -\emph default -) that \SpecialChar LyX - creates in its temporary directory (this is the way the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -lyxclient -\end_layout - -\end_inset - program communicates with \SpecialChar LyX -). - In some cases, you need a helper script that mediates between the viewer - and \SpecialChar LyX -, in others, the viewer can communicate with \SpecialChar LyX - directly. - This depends on the selected viewer and on your operating system. - The same applies to the way viewers need to be configured and the way the - reverse search is actually performed. - In what follows, we will thus describe how to setup reverse search for - specific viewers. - Before we turn to this, though, we will explain what needs to be done generally - to enable reverse search in the DVI/PDF output. \end_layout \begin_layout Subsection -Automatic setup -\begin_inset CommandInset label -LatexCommand label -name "subsec:rev-search" - -\end_inset - - +How it looks \end_layout \begin_layout Standard -In most cases \SpecialChar LyX - will do the work for you by pressing the following button - in the toolbar: -\begin_inset Info -type "icon" -arg "buffer-toggle-output-sync" -\end_inset - -. - Alternatively, you can also enable the feature by checking -\family sans -Synchronize with Output -\family default - in +Open the dialog by selecting the \begin_inset Flex Noun status collapsed \begin_layout Plain Layout Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Formats +Settings \end_layout \end_inset -. - In such a case \SpecialChar LyX - will automatically insert the necessary Sync\SpecialChar TeX - macro (for - PDF) or load the srcltx package (for DVI) respectively. - This option can be easily reached also on -\begin_inset Flex Code + menu item and then select the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -View/Update +Bullets \end_layout \end_inset - Toolbar. + tab. \end_layout \begin_layout Standard -If you need a different setting, you can select or input a custom macro - from the drop down box just below -\begin_inset Flex Noun -status collapsed +The dialog provides you with a table of bullet shapes. + A column of buttons on the left of the table provides access to the six + different panels of bullet shapes. + The row of buttons across the top is used to select which bullet depth + you are changing. + +\change_deleted 244031559 1603875981 + A text entry under the table shows the currently selected bullet shape's + \SpecialChar LaTeX + equivalent and this can be edited if desired. + If you do modify the text you will also need to specify any needed packages + in the \SpecialChar LaTeX + preamble. +\change_unchanged + +\end_layout + +\begin_layout Standard +The six panels are divided up by the packages they require. + The following table shows the mappings from button name to \SpecialChar LaTeX + package. +\end_layout + +\begin_layout Standard +\align center +\begin_inset Tabular + + + + + + +\begin_inset Text \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Output\SpecialChar menuseparator -Synchronize with Output + +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Button \end_layout \end_inset + + +\begin_inset Text -. +\begin_layout Plain Layout + +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Packages Required \end_layout -\begin_layout Standard -Note that the method -\begin_inset Flex Code -status collapsed +\end_inset + + + + +\begin_inset Text \begin_layout Plain Layout -\backslash -synctex=1 +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Standard \end_layout \end_inset - - enables gzip compression. - If your viewer does not support it, you should instead use -\begin_inset Flex Code -status collapsed + + +\begin_inset Text \begin_layout Plain Layout -\backslash -synctex=-1 +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +base \SpecialChar LaTeX + \end_layout \end_inset - -. -\end_layout - -\begin_layout Standard -Please also note that including the -\begin_inset Flex Code -status collapsed + + + + +\begin_inset Text \begin_layout Plain Layout -srcltx + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Maths \end_layout \end_inset - - package or -\begin_inset Flex Code -status collapsed + + +\begin_inset Text \begin_layout Plain Layout -src-specials + +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +amssymb.sty \end_layout \end_inset - - sometimes has an undesired impact on the typesetting. - Thus, you should switch output synchronization off for the final typesetting - if you use the -\begin_inset Flex Code -status collapsed + + + + +\begin_inset Text \begin_layout Plain Layout -srcltx + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding1 \end_layout \end_inset - - package or -\begin_inset Flex Code -status collapsed + + +\begin_inset Text \begin_layout Plain Layout -src-specials -\end_layout -\end_inset - -. - +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout -\begin_layout Standard -In case you need some more special settings that are not covered by the - automatic settings, read the next section about how to set up output synchroniz -ation manually. - If the automatic setup suits your needs, you can readily jump to section -\begin_inset space ~ \end_inset + + + + +\begin_inset Text +\begin_layout Plain Layout -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:configuring-viewers" +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding2 +\end_layout \end_inset + + +\begin_inset Text -, where the necessary configuration steps in your viewer – needed both with - the automatic and the manual setup – are described. -\end_layout +\begin_layout Plain Layout -\begin_layout Subsection -Manual setup +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout -\begin_layout Standard -\SpecialChar LaTeX - provides several different methods for reverse search. - Some are built-in in the -\begin_inset Flex Code -status collapsed +\end_inset + + + + +\begin_inset Text \begin_layout Plain Layout -latex/pdflatex + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding3 \end_layout \end_inset + + +\begin_inset Text - program, some are provided by external packages. - Your choice depends on whether your \SpecialChar LaTeX - distribution already provides a given - method (the built-in methods are rather new) and whether your viewer can - cope with it. - The available methods are described in the following. -\end_layout +\begin_layout Plain Layout -\begin_layout Subsubsection* -Built-in DVI-search via src-specials (DVI only) +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout -\begin_layout Standard -This method provides the DVI file with the necessary information for reverse - search. - It is available in \SpecialChar LaTeX - since quite some time (any somewhat recent \SpecialChar LaTeX - distribution - should include it), and it works reliably. - To enable it, change the -\begin_inset Flex Noun -status collapsed +\end_inset + + + + +\begin_inset Text \begin_layout Plain Layout -La + \family sans -TeX -\family default - (plain)->DVI +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding4 \end_layout \end_inset - - or -\begin_inset Flex Noun -status collapsed + + +\begin_inset Text \begin_layout Plain Layout -La -\family sans -TeX -\family default - (plain)->DraftDVI + +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout \end_inset + + + - converter in -\begin_inset Flex Noun -status collapsed +\end_inset -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -Converters -\end_layout -\end_inset +\end_layout - to -\begin_inset Flex Code +\begin_layout Standard +\SpecialChar LyX + doesn't stop you using bullets from packages you don't have. + If you get errors from \SpecialChar LaTeX + when you try to view or print the file, then it + is likely you are missing a package. +\begin_inset Foot status collapsed \begin_layout Plain Layout -latex -src-specials $$i +\SpecialChar LyX + doesn't restrict your use since you may be editing locally and exporting + elsewhere. \end_layout \end_inset -. - If this doesn't work, check if your \SpecialChar TeX - engine needs different options (the - syntax might differ in some distributions). + \end_layout -\begin_layout Subsubsection* -External Packages (PDFSync and scrltx) +\begin_layout Subsection +How to use it \end_layout \begin_layout Standard -The packages -\emph on -pdfsync -\emph default - and -\emph on -scrltx -\emph default - provide reverse search facility for PDF output (via pdflatex) and DVI output, - respectively. - In order to enable it, load the packages in the \SpecialChar LyX - preamble: +Select which bullet depth you want to change then select the bullet shape + and size. + Any changes will not be visible in \SpecialChar LyX +, but are visible when viewing the document. \end_layout -\begin_layout Itemize -\begin_inset Flex Code -status collapsed +\begin_layout Standard +You can reset a bullet shape to the default simply by clicking your right + mouse button on the appropriate bullet depth button. +\begin_inset Foot +status open \begin_layout Plain Layout - -\backslash -usepackage{pdfsync} -\end_layout - -\end_inset - - for reverse PDF search, +If you +\emph on +really +\emph default + want to have multiple sets of paragraphs with different sets of bullets + in each, then you're going to have to get your hands dirty with \SpecialChar TeX + code. + The bullet selection dialog can help though because it provides you with + the \SpecialChar LaTeX + code for a wide range of bullet shapes. + To make your own custom paragraphs you have the following options: \end_layout -\begin_layout Itemize -\begin_inset Flex Code -status collapsed +\begin_layout Plain Layout +\begin_inset ERT +status open \begin_layout Plain Layout + \backslash -usepackage[active]{srcltx} +let +\backslash +savelabelitemi= +\backslash +labelitemi \end_layout \end_inset - for reverse DVI search. -\end_layout -\begin_layout Standard -If you want to be able to perform both DVI and PDF reverse searches, you - can also insert in the preamble the following lines \end_layout -\begin_layout LyX-Code +\begin_layout Plain Layout +\begin_inset ERT +status open -\backslash -usepackage{ifpdf} -\begin_inset Newline newline -\end_inset +\begin_layout Plain Layout \backslash -ifpdf -\begin_inset Newline newline -\end_inset - - +renewcommand \backslash -usepackage{pdfsync} -\begin_inset Newline newline -\end_inset - - +labelitemi[0]{ \backslash -else -\begin_inset Newline newline -\end_inset - - +small \backslash -usepackage[active]{srcltx} -\begin_inset Newline newline -\end_inset - - +( \backslash -fi +sharp +\backslash +)} \end_layout -\begin_layout Standard -This way, you can preview the file as either DVI or PDF (pdflatex) and the - right package will be used. -\end_layout +\end_inset -\begin_layout Standard -Note that PDFSync might affect the output layout of your document. - It is therefore advised to disable PDFsync for final documents. -\end_layout -\begin_layout Subsubsection* -Built-in reverse search via Sync\SpecialChar TeX - (DVI and PDF) \end_layout -\begin_layout Standard -Recent versions of +\begin_layout Itemize +Use the \SpecialChar LaTeX + command \begin_inset Flex Code status collapsed \begin_layout Plain Layout -(pdf)latex + +\backslash +renewcommand{}{} \end_layout \end_inset - have built-in support for both PDF and DVI reverse search. - This so-called -\emph on -Sync\SpecialChar TeX - -\emph default - facility is basically the result of the integration of the PDFSync package - to the pdftex program and its merge with the -\emph on -scr-specials -\emph default - approach. - You need at least \SpecialChar TeX -Live 2008 or a recent Mik\SpecialChar TeX - distribution in order to use - it. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -For some reason, Mik\SpecialChar TeX - does not understand/obey the command \SpecialChar LyX - inserts into - the preamble when you check the "Enable Forward/Reverse Search" button - in the toolbar and does not generate the necessary info. + to specify a new bullet shape for a given depth. + You'll also need to save the current bullet shape so you can restore it + again afterwards. + In this itemized list the following \SpecialChar LaTeX + code was used to change the bullet + used for the first depth. \end_layout -\begin_layout Plain Layout -The generation of the required info can be forced by changing the converter - "\SpecialChar LaTeX - (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters - from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding - the -synctex=1 switch). +\begin_deeper +\begin_layout LyX-Code + +\backslash +let +\backslash +savelabelitemi= +\backslash +labelitemi \end_layout -\end_inset +\begin_layout LyX-Code - Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix, - Skim on the Mac, SumatraPDF on Windows; see the next section for details) - already provide Sync\SpecialChar TeX - support. +\backslash +renewcommand +\backslash +labelitemi[0]{ +\backslash +small +\backslash +( +\backslash +sharp +\backslash +)} \end_layout -\begin_layout Standard -To enable Sync\SpecialChar TeX - for DVI output, change the -\begin_inset Flex Noun -status collapsed +\end_deeper +\begin_layout Itemize +Note that the itemize depth is specified in Roman numerals as part of the + +\family typewriter -\begin_layout Plain Layout -La -\family sans -TeX +\backslash +labelitem \family default - (plain) -> DVI + command. \end_layout -\end_inset +\begin_layout Itemize +\begin_inset Argument item:1 +status open - or -\begin_inset Flex Noun -status collapsed +\begin_layout Plain Layout +\begin_inset ERT +status open \begin_layout Plain Layout -La -\family sans -TeX -\family default - (plain) -> DraftDVI + + +\backslash +( +\backslash +star +\backslash +) \end_layout \end_inset - converter in -\begin_inset Flex Noun -status collapsed -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -Converters \end_layout \end_inset - to -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -latex -synctex=1 $$i -\end_layout + Specify each individual entry by starting each item with the bullet shape + enclosed in a +\begin_inset Quotes eld +\end_inset +Custom Item +\begin_inset Quotes erd \end_inset -, and for PDF output, change the + inset (available at +\family sans +Insert\SpecialChar menuseparator +Custom Item +\family default +) and set as \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -La -\family sans -TeX -\family default - (pdflatex) -> PDF (pdflatex) +\SpecialChar TeX + Code \end_layout \end_inset - converter to +. + For example, this item was started with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -pdflatex -synctex=1 $$i + +\backslash +( +\backslash +star +\backslash +) \end_layout \end_inset . - Should your viewer not be considered in the following description, or in - case of missing success, please check the documentation of your viewer - whether the viewer needs to be configured for the use with Sync\SpecialChar TeX -. -\begin_inset Foot -status collapsed +\end_layout \begin_layout Plain Layout -Note that the option -\begin_inset Flex Code -status collapsed +\begin_inset ERT +status open \begin_layout Plain Layout --synctex=1 -\end_layout - -\end_inset - option enables gzip compression. - If your viewer does not support it, you should instead use -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout --synctex=-1 +\backslash +renewcommand +\backslash +labelitemi[0]{ +\backslash +savelabelitemi} \end_layout \end_inset -. + \end_layout -\end_inset +\begin_layout Plain Layout +You'll also need to revert the labelitem back to its previous setting for + the global bullet shape settings to remain in effect. + The way used here was: +\end_layout +\begin_layout LyX-Code +\backslash +renewcommand +\backslash +labelitemi[0]{ +\backslash +savelabelitemi} \end_layout -\begin_layout Subsection -Configuring and using specific viewers -\begin_inset CommandInset label -LatexCommand label -name "subsec:configuring-viewers" - \end_inset \end_layout -\begin_layout Subsubsection* -Xdvi (all platforms) +\begin_layout Chapter +\SpecialChar LyX + and the World Wide Web \end_layout \begin_layout Standard -If you use -\begin_inset Flex Code +\SpecialChar LyX + has long supported the export of documents to various web-friendly formats, + such as HTML. + Before version 2.0, however, HTML export was always accomplished by the + use of external converters. +\begin_inset Foot status collapsed \begin_layout Plain Layout -xdvi +For details on the use of external converters with \SpecialChar LyX +, see the +\emph on +Converters +\emph default + section of the Customization manual. \end_layout \end_inset -, you don't need to do anything else for performing a reverse DVI search, - as \SpecialChar LyX - already provides the necessary hooks for automatically using the + These fall into two large groups: there are converters that use \SpecialChar LaTeX + as an + intermediate format, such as \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxclient +htlatex \end_layout \end_inset - program. - Just setup your document as described above (reverse search is triggered - by Ctrl-click or Alt-click on Mac OSX, respectively). -\end_layout - -\begin_layout Standard -However, if for whatever reason you want to use the named pipe instead of - the socket for communicating with \SpecialChar LyX -, simply change the DVI viewer in -\begin_inset Flex Noun +, +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats +html2latex \end_layout \end_inset - to -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -On Mac OSX you have to use +, and \begin_inset Flex Code status collapsed \begin_layout Plain Layout -DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l" +plastex \end_layout \end_inset +, relying upon \SpecialChar LyX + to produce the \SpecialChar LaTeX +; and there is a converter that works directly + on \SpecialChar LyX + files, +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout \end_inset +. + All of these have different advantages and disadvantages. +\end_layout + +\begin_layout Standard +The \SpecialChar LaTeX +-based converters have the advantage that, in principle, they know everythin +g about the exported document that \SpecialChar LaTeX + does. + Such converters do not care, for example, if a certain block of code was + produced by \SpecialChar LyX + or was Evil Red Text. + These converters know about \begin_inset Flex Code status collapsed \begin_layout Plain Layout -xdvi -editor "lyxeditor.sh %f %l" +aux \end_layout \end_inset -, where + files, counters, and references, and can often make use of the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.sh -\end_layout - -\end_inset - - is a suitable script. - For example, a minimal shell script is the following one: +bbl \end_layout -\begin_layout LyX-Code -#!/bin/sh -\begin_inset Newline newline \end_inset -LYXPIPE="/path/to/lyxpipe" -\begin_inset Newline newline -\end_inset + files generated by Bib\SpecialChar TeX +. + On the other hand, \SpecialChar LaTeX + is a very hard language to parse—it is sometimes said + that only \SpecialChar TeX + itself understands \SpecialChar TeX +—and \SpecialChar LaTeX +-based converters will often choke on + what seem to be quite simple constructs; complex ones can throw them completely +, and as of this writing, for example, the +\emph on +Embedded Objects +\emph default + manual will not export with +\begin_inset Flex Code +status collapsed -COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2" -\begin_inset Newline newline -\end_inset +\begin_layout Plain Layout +htlatex +\end_layout -echo "$COMMAND" > "${LYXPIPE}".in || exit -\begin_inset Newline newline \end_inset -read TMP < "${LYXPIPE}".out || exit +, though the others will. + The other issue concerns how math is handled. + These converters typically convert the formulae into little pictures that + are then linked from the HTML document. + Since these are actually generated by \SpecialChar LaTeX +, they are accurate. + But they do not scale well, and just getting them to look as if they are + actually meant to be in your document—so that the font sizes seem to be + roughly the same—can be a challenge. \end_layout \begin_layout Standard -where +Alex Fernandez's \begin_inset Flex Code status collapsed \begin_layout Plain Layout -/path/to/lyxpipe +e\SpecialChar LyX +er \end_layout \end_inset - is the LyXServer pipe path specified in -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -Paths -\end_layout + ( +\begin_inset CommandInset href +LatexCommand href +name "http://pinchito.es/elyxer/" +target "http://pinchito.es/elyxer/" +literal "false" \end_inset -. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -In the +) solves some of these problems. + In particular, the formulae it produces scale perfectly, since it renders + math using a combination of HTML and CSS rather than converting the formulae + to images. + But even moderately complex formula are rendered less well than with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -development/tools +htlatex \end_layout \end_inset - folder of a source distribution you can find a -\begin_inset Flex Code +; this reflects the limitations of HTML. +\begin_inset Foot status collapsed \begin_layout Plain Layout -lyxeditor -\end_layout - -\end_inset +That said, +\begin_inset Flex Code +status collapsed - script which is able to locate the -\emph on -lyxpipe -\emph default - based on your preferences. +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout \end_inset - -\end_layout - -\begin_layout Subsubsection* -MacDviX (Mac OSX) + can also use jsMath and MathJax for equations, but this setting is only + available globally and requires one to have access to a server that runs + the backend. \end_layout -\begin_layout Standard -At the end of +\end_inset + + More importantly (as of version 1.1.1, at least), \begin_inset Flex Code status collapsed \begin_layout Plain Layout -/Applications/MacDviX_Folder/calleditor.script +e\SpecialChar LyX +er \end_layout \end_inset -, add the following lines: + has limited support for math macros and no support for user-defined paragraph + or character styles. + These limitations make +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout -\begin_layout LyX-Code -/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1 -\begin_inset Newline newline \end_inset -exit 1 + 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 -Modify the lines accordingly if you install \SpecialChar LyX - somewhere else than in the - Applications folder. -\end_layout +As of this writing, XHTML output remains under development and should probably + be regarded as +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -Reverse search is triggered by Alt-click (OPTION-click). -\end_layout +experimental +\begin_inset Quotes erd +\end_inset -\begin_layout Subsubsection* -Skim (Mac OSX) -\end_layout +. +\begin_inset Foot +status collapsed -\begin_layout Standard -Enter +\begin_layout Plain Layout +The file \begin_inset Flex Code status collapsed \begin_layout Plain Layout -open -a Skim.app $$i +development/HTML/HTML.notes \end_layout \end_inset - to the viewer setting in -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats\SpecialChar menuseparator -PDF (pdflatex) -\end_layout +, which can be found in the \SpecialChar LyX + source tree or +\begin_inset CommandInset href +LatexCommand href +name "accessed online" +target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master" +literal "false" \end_inset -, and then in -\begin_inset Flex Noun -status collapsed +, usually contains up-to-date information about the state of XHTML output. + See also the list of XHTML bugs on +\begin_inset CommandInset href +LatexCommand href +name "the bug tracker" +target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1" +literal "false" -\begin_layout Plain Layout -Skim\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -Sync +\end_inset + +. \end_layout \end_inset - choose -\begin_inset Flex Noun + Still, the developers have chosen this approach because it has several + potential advantages over the other two. +\end_layout + +\begin_layout Standard +These advantages are primarily due to the fact that the XHTML output routines, + since they are part of \SpecialChar LyX +, know everything \SpecialChar LyX + knows about the document being + exported. +\begin_inset Foot status collapsed \begin_layout Plain Layout -custom +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 - preset and enter command -\begin_inset Flex Noun -status collapsed + So they know about the table of contents (as displayed in the outline), + about the counters associated with different paragraph styles, and about + user-defined styles. + The XHTML output routines know what \SpecialChar LyX + knows about internationalization, + too, so they will output +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -/Applications/\SpecialChar LyX -.app/Contents/MacOS/lyxeditor -\end_layout +Chapter 1 +\begin_inset Quotes erd +\end_inset + or +\begin_inset Quotes eld \end_inset -. + +\lang ngerman +Kapitel +\lang english + 1 +\begin_inset Quotes erd +\end_inset + +, depending upon the language in effect at the time. + \end_layout \begin_layout Standard -Reverse search is triggered by COMMAND-SHIFT-click +Quite generally, the output routines know what \SpecialChar LyX + knows about document layout, + that is, about how the document is to be rendered on screen. + We use this information when we output the document as XHTML. + In particular, \SpecialChar LyX + +\emph on +automatically +\emph default + generates CSS style information corresponding to the layout information + it uses to render the document on screen: if section headings are supposed + to be sans-serif and bold as seen in \SpecialChar LyX +, then (by default) they will be sans-seri +f and bold when viewed in a web browser, too. + And this is true not just for pre-defined styles, like Section, but for + any style, including user-defined styles. + Indeed, the XHTML output routines make no distinction between user-defined + paragraph and +\change_deleted 244031559 1603876931 +character +\change_inserted 244031559 1603876940 +text +\change_unchanged + styles and \SpecialChar LyX +'s own pre-defined styles: in each case, everything \SpecialChar LyX + knows about + the styles is contained in the layout files. + And much the same is true as regards pre-defined textual insets, such as + footnotes, and various custom insets. + \end_layout -\begin_layout Subsubsection* -Evince (GNOME) +\begin_layout Standard +The result is that XHTML output can be customized and extended in exactly + the same way \SpecialChar LaTeX + output can be customized and extended: through layout files + and modules. + See chapter five of the +\emph on +Customization +\emph default +manual for the details. \end_layout \begin_layout Standard -Reverse search with evince does not work out of the box, but it can be achieved - by means of some third party helper scripts. - Please refer to -\begin_inset CommandInset href -LatexCommand href -target "https://wiki.lyx.org/LyX/SyncTeX" -literal "false" - -\end_inset - - for details. +The remainder of this chapter contains more detailed information on XHTML + output, its limitations, and ways to work around those limitations. \end_layout -\begin_layout Subsubsection* -Okular (KDE) +\begin_layout Section +Math Output in XHTML \end_layout \begin_layout Standard -Go to -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Settings\SpecialChar menuseparator -Configure Okular\SpecialChar menuseparator -Editor +\SpecialChar LyX + offers four choices for how math is rendered. + These have various advantages and disadvantages: \end_layout +\begin_layout Itemize +MathML +\begin_inset Newline newline \end_inset - and select LyX -\begin_inset Quotes erd +MathML is a dialect of XML designed specifically for mathematics on the + web, and it typically renders very well in browsers that support it. + The disadvantage is that not all browsers support MathML, and support is + not complete even in the Gecko-based browsers, such as Firefox. +\begin_inset Newline newline \end_inset - as editor. - This inserts the appropriate command ( +If \SpecialChar LyX + is unable to render a formula as MathML—for example, if the formula + uses the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxclient -g %f %l +xymatrix \end_layout \end_inset -). + package or ERT—then it will instead output the formula as an image. + \end_layout -\begin_layout Standard -Reverse search is triggered by SHIFT-click. - -\change_inserted -712698321 1578211026 - Note that this only works if Okular is in -\begin_inset Quotes eld -\end_inset - -Browse -\begin_inset Quotes erd -\end_inset - - mode (i. -\begin_inset space \thinspace{} +\begin_layout Itemize +HTML +\begin_inset Newline newline \end_inset -e., the hand symbol is clicked). -\change_unchanged +As mentioned above, +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +elyxer \end_layout -\begin_layout Subsubsection* -Qpdfview (Unix) -\end_layout +\end_inset -\begin_layout Standard -Qpdfview supports Sync\SpecialChar TeX - since version 0.3.5. - Go to -\begin_inset Flex Noun + outputs math as HTML, styled by CSS. +\begin_inset Foot status collapsed \begin_layout Plain Layout -Edit\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Behavior +\SpecialChar LyX + has borrowed some of the CSS for its HTML output from +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +elyxer \end_layout \end_inset -, click on the input field of the -\begin_inset Quotes eld +. +\end_layout + \end_inset -Source editor -\begin_inset Quotes erd + For simple formulae, this can work quite well, though with more complicated + formulae it tends to break down. + Still, this method has the advantage that it is very widely supported and + so it may be appropriate for documents that contain only a little, fairly + simple math. +\begin_inset Newline newline \end_inset - item and add the command +If Lyx is unable to render a formula as HTML—for example, if the formula + uses the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxclient -g %1 %2 +xymatrix \end_layout \end_inset -. + package or ERT—then it will instead output the formula as an image. + \end_layout -\begin_layout Standard -Reverse search is triggered by double-click or, in more recent versions, - by context menu. -\end_layout +\begin_layout Itemize +Images +\begin_inset Newline newline +\end_inset -\begin_layout Subsubsection* -YAP (Windows) +Like +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +htlatex \end_layout -\begin_layout Standard -Launch yap, choose its -\begin_inset Flex Noun +\end_inset + +, \SpecialChar LyX + will output formulae as images, the very same images, in fact, that are + used for instant preview. +\begin_inset Foot status collapsed \begin_layout Plain Layout -View\SpecialChar menuseparator -Options +Instant preview does +\emph on +not +\emph default +have to be on for images to be output, however. \end_layout \end_inset - menu and select the + The advantage to this method is that the images are simply generated by + \SpecialChar LaTeX +, so they are very accurate. + The disadvantage, as mentioned earlier, is that these are bitmapped images, + so they do not scale terribly well, and one cannot copy them, etc. +\begin_inset Newline newline +\end_inset + +The size of the images can be controlled by setting the \begin_inset Quotes eld \end_inset -Inverse DVI Search +Math Images Scaling \begin_inset Quotes erd \end_inset - tab. - Click on the -\begin_inset Quotes eld -\end_inset + parameter under +\begin_inset Flex Noun +status collapsed -New\SpecialChar ldots +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Formats +\end_layout -\begin_inset Quotes erd \end_inset - button and, in the window that opens, enter -\begin_inset Quotes eld -\end_inset +. +\begin_inset Foot +status collapsed -\SpecialChar LyX - Editor -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +For those who want to know, this controls the resolution of the image in + dots per inch and is based upon a default of 75 dpi. +\end_layout - (or any other name you like) in the -\begin_inset Quotes eld \end_inset -Name: -\begin_inset Quotes erd -\end_inset - field. - Now click on the button labeled -\begin_inset Quotes eld +\begin_inset Newline newline \end_inset -\SpecialChar ldots +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_inset Quotes erd -\end_inset +\begin_layout Itemize +\SpecialChar LaTeX - to open a file dialog and navigate to the directory containing the batch - file -\begin_inset Flex Code -status collapsed +\begin_inset Newline newline +\end_inset -\begin_layout Plain Layout -lyxeditor.bat -\end_layout +Finally, \SpecialChar LyX + will happily output math as \SpecialChar LaTeX +. + As well as being the output of last resort, this method can be used with + such tools as +\begin_inset CommandInset href +LatexCommand href +name "jsMath" +target "http://www.math.union.edu/~dpvc/jsMath/" +literal "false" \end_inset - (see below). - Select +, which uses JavaScript to render \SpecialChar LaTeX + embedded in HTML documents. + \SpecialChar LyX + wraps the \SpecialChar LaTeX + in either a \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.bat +span \end_layout \end_inset - and then specify the program arguments as + (for inline formulas) or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -%f %l +div \end_layout \end_inset -. - The + (for displayed formulas) with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.bat +class='math' \end_layout \end_inset - wrapper is used for communicating with \SpecialChar LyX - through the -\emph on -lyxpipe -\emph default - and is as follows: +, as is required for jsMath. \end_layout -\begin_layout LyX-Code -@echo off -\begin_inset Newline newline -\end_inset +\begin_layout Standard +One of these output methods must be selected under +\begin_inset Flex Noun +status collapsed -echo LYXCMD:revdvi:server-goto-file-row:%~1 %2> -\backslash +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Formats +\end_layout -\backslash -. -\backslash -pipe -\backslash -lyxpipe.in -\begin_inset Newline newline \end_inset -type -\backslash - -\backslash . -\backslash -pipe -\backslash -lyxpipe.out + By default, \SpecialChar LyX + outputs MathML. + This is a document-wide setting, therefore. \end_layout \begin_layout Standard -Make sure that the \SpecialChar LyX -Server pipe path you specified in \SpecialChar LyX - is -\begin_inset Flex Code +Eventually, \SpecialChar LyX + will offer the user the option to select an alternate output + method for a particular inset, say, one that isn't being rendered very + well by MathML. +\begin_inset Foot status collapsed \begin_layout Plain Layout +That said, since \SpecialChar LyX + falls back to images if the inset contains ERT, then one + can force output as an image by putting some harmless ERT into the math, + for example: +\begin_inset Formula $a=b\relax$ +\end_inset -\backslash - -\backslash . -\backslash -pipe -\backslash -lyxpipe \end_layout \end_inset -, otherwise change the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -lyxeditor.bat \end_layout -\end_inset +\begin_layout Section +Bibliography and Citations +\end_layout - wrapper accordingly. +\begin_layout Standard +XHTML output fully supports bibliographies and citations. + +\end_layout + +\begin_layout Standard +Citation labels are generated by the same machinery that generates \SpecialChar LyX +'s on-screen + labels, so the labels will look in the output much as they do in \SpecialChar LyX +, though + better. + If you are using numerical citations, then \SpecialChar LyX + will output numerical labels, + such as [1] or [17], rather than simply showing the citation key in square + brackets, as it does on-screen. + If you are using author-year citations, then \SpecialChar LyX + will add lowercase letters + to the years, just as Bib\SpecialChar TeX + does, if it finds more than one citation for + a given author-year combination. + The labels will be printed with the bibliography entries. + Note that there is, at present, no way to customize the appearance of the + labels, for example, to choose between square brackets and parentheses. \end_layout \begin_layout Standard -In yap, reverse search is triggered by double-click. -\end_layout - -\begin_layout Subsubsection* -SumatraPDF (Windows) +Bibliography output is handled by the same machinery that handles the presentati +on of reference information in the citation dialog, so you will see in the + XHTML output pretty much what you would see if you were to look at a given + entry in the citation dialog. + The formatting can be customized in your layout file or, preferably, in + a module. + See the +\emph on +Customization +\emph default + manual for the details. \end_layout \begin_layout Standard -In order to use SumatraPDF for inverse search, enter -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -SumatraPDF -inverse-search "lyxeditor.bat "%f" %l" +The main defect at present is that cross-referenced information is printed + with every entry with which it is associated. + So you can see things like this: \end_layout +\begin_layout Quote +Jason Stanley, +\begin_inset Quotes eld \end_inset - in the viewer setting in -\begin_inset Flex Noun -status collapsed +Context and Logical Form +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats\SpecialChar menuseparator -PDF (pdflatex) +, in +\emph on +Language in Context: Selected Essays +\emph default + (Oxford: Oxford University Press, 2007), pp. + 30–68. \end_layout +\begin_layout Quote +Jason Stanley, +\begin_inset Quotes eld \end_inset -, where -\begin_inset Flex Code -status collapsed +Semantics in Context +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -lyxeditor.bat +, in +\emph on +Language in Context: Selected Essays +\emph default + (Oxford: Oxford University Press, 2007), pp. + 201–30. \end_layout -\end_inset - - is the previous wrapper. - If SumatraPDF.exe is not in your command PATH, use its full file name. +\begin_layout Standard +This should be fixed before long. \end_layout \begin_layout Standard -Reverse search is triggered by double-click. +There is no support at present for sectioned bibliographies. + If you have multiple bibliographies, then \SpecialChar LyX + will print the same bibliography + over and over. \end_layout -\begin_layout Subsubsection* -YAP (Cygwin) +\begin_layout Section +Indexes \end_layout \begin_layout Standard -First of all, make sure that yap is your default DVI viewer in the Windows - environment, then launch it, choose its -\begin_inset Flex Noun +\SpecialChar LyX + will happily export indexes as XHTML, but with certain limitations at the + moment. +\end_layout + +\begin_layout Standard +Index export will be most reliable when you do not attempt to use the fancy + constructs that are described in the section on indexes in the +\emph on +User's Guide +\emph default +. +\begin_inset Foot status collapsed \begin_layout Plain Layout -View\SpecialChar menuseparator -Options +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 - menu and select the + We'll describe how they are handled using the subsection headings from + that section. +\end_layout + +\begin_layout Itemize +Grouping Index Entries (aka, sub-entries): \SpecialChar LyX + makes an effort to support these, + but the entries must be separated by \begin_inset Quotes eld \end_inset -Inverse DVI Search + ! \begin_inset Quotes erd \end_inset - tab. - Click on the -\begin_inset Quotes eld -\end_inset - -New\SpecialChar ldots +, that is, there must be spaces around the exclamation point. + This is because it is otherwise too difficult to check for escaped exclamation + points, ones in math, and so forth. +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize +Page Ranges: There is no support at all for page ranges, since these make + no sense with XHMTL. + Instead, you will just get two index entries, one at either end. +\end_layout - button and, in the window that opens, enter +\begin_layout Itemize +Cross-referencing: There is no support for cross-referencing. + If \SpecialChar LyX + finds an entry containing the \begin_inset Quotes eld \end_inset -\SpecialChar LyX - Editor +|see\SpecialChar ldots + \begin_inset Quotes erd \end_inset - (or any other name you like) in the -\begin_inset Quotes eld -\end_inset + construct, it is just dropped, and the rest is treated as an ordinary index + entry. +\end_layout -Name: -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize +Index Entry Order: \SpecialChar LyX + does support attempts to fix the sorting order. + It will take what is before the first `@' it finds and use that for sorting, + taking what follows the first `@' to be the actual entry. + At present, \SpecialChar LyX + does not check for escaped `@', so do not try to index email + addresses. +\end_layout - field. - Now click on the button labeled +\begin_layout Itemize +Index Entry Layout: You can format entries by using the text style dialog, + or by using any other method available within \SpecialChar LyX + itself. + There is no support for constructs like: \begin_inset Quotes eld \end_inset -\SpecialChar ldots - +entry|textbf \begin_inset Quotes erd \end_inset - to open a file dialog and navigate to the directory containing the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -lyxeditor.exe +. + Indeed, if \SpecialChar LyX + finds a pipe symbol, `|', in an entry, it will delete it and + everything that follows it. \end_layout -\end_inset +\begin_layout Itemize +Multiple Indexes: There is no support for multiple indexes. + Rather, all index entries will be printed as one large index. + To avoid our printing several versions of the index, we print only the + main index, so make sure you have one. +\end_layout - program (which is installed by default on Cygwin along with the \SpecialChar LyX - executable). - Select -\begin_inset Flex Code -status collapsed +\begin_layout Section +Nomenclature and Glossary +\end_layout -\begin_layout Plain Layout -lyxeditor.exe +\begin_layout Standard +There is at present no support for glossaries. + Adding it would be fairly trivial, and welcome. \end_layout -\end_inset +\begin_layout Chapter - and then specify the program arguments as -\begin_inset Flex Code -status collapsed +\change_inserted 1075283030 1616534180 +DocBook Output +\end_layout -\begin_layout Plain Layout --g %f %l +\begin_layout Standard + +\change_inserted 1075283030 1616534386 +Apart from HTML, \SpecialChar LyX + can generate documents in the DocBook XML vocabulary. + With versions 2.3 and before, only select templates could be used to generate + DocBook documents (only version 4). + Starting with \SpecialChar LyX + 2.4, most \SpecialChar LyX + layouts can generate valid DocBook documents (only + version 5). + This feature is built into \SpecialChar LyX + and does not require the use of external tools. \end_layout -\end_inset +\begin_layout Standard -. - In this way, you will be using the -\emph on -lyxsocket -\emph default - for communicating with \SpecialChar LyX -. - If, for whatever reason, you want to use the +\change_inserted 1075283030 1616534437 +The result is that the DocBook output can be customized and extended in + exactly the same way \SpecialChar LaTeX + output can be customized and extended: through layout + files and modules. + See chapter five of the \emph on -lyxpipe +Customization \emph default -, omit the -\begin_inset Flex Code -status collapsed +manual for the details. +\end_layout + +\begin_layout Standard + +\change_inserted 1075283030 1616534475 +Most \SpecialChar LyX + features are supported with DocBook, like math output. +\end_layout -\begin_layout Plain Layout --g +\begin_layout Itemize + +\change_inserted 1075283030 1616534741 +Math output is performed mostly in MathML (the major exception being constructio +ns not supported by \SpecialChar LyX +, i.e. + ERTs). + All formulae are also available in raw \SpecialChar TeX + in the DocBook output for further + processing. \end_layout -\end_inset +\begin_layout Itemize - option and be sure to specify the \SpecialChar LyX -Server pipe path in the \SpecialChar LyX - preferences. +\change_inserted 1075283030 1616534852 +Bibliographies and citations are implemented, including with an external + BibTeX file. + Bibliography entries are not prerendered when the detailed information + are available, but rather output with the standard DocBook constructs. + The external DocBook processor is expected to handle the rendering of entries. \end_layout -\begin_layout Standard -In yap, reverse search is triggered by double-click. +\begin_layout Itemize + +\change_inserted 1075283030 1616534863 +Indexes are supported, including multiple indices. + Grouping (with +\family typewriter +! +\family default +), page ranges, and cross-references ( +\family typewriter +|see +\family default +) are supported, with the exception of the same symbols escaped. + Entry order ( +\family typewriter +@ +\family default +) and layout ( +\family typewriter +|mathbf +\family default +) are not supported. + There is no support for escaping of index entries. \end_layout -\begin_layout Subsubsection* -SumatraPDF (Cygwin) +\begin_layout Itemize + +\change_inserted 1075283030 1616534884 +Glossaries are implemented. \end_layout \begin_layout Standard -In order to use SumatraPDF for inverse search, enter -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -SumatraPDF -inverse-search "lyxeditor -g %f %l" +\change_inserted 1075283030 1616534894 +Two major parameters can be set at the document level. \end_layout -\end_inset - - in the viewer setting in -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats\SpecialChar menuseparator -PDF (pdflatex) +\change_inserted 1075283030 1616534948 +Format for tables: \SpecialChar LyX + can generate tables either as HTML (default value) or + CALS, depending on the user's requirements. + Most DocBook processors accept both formats. \end_layout -\end_inset - -. - If SumatraPDF.exe is not in your command PATH, use its full posix path. - The -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout --g +\change_inserted 1075283030 1616535006 +MathML prefix: in DocBook, MathML is included within its own name space, + unlike HTML. + The implication is that there must be an indication of the tags belonging + to the MathML standard. + Three choices are offered: \end_layout -\end_inset +\begin_deeper +\begin_layout Itemize - enables communication via the -\emph on -lyxsocket -\emph default -. - Again, omit the -\begin_inset Flex Code -status collapsed +\change_inserted 1075283030 1616535044 +Inline: the MathML name space is defined for each formula (using the +\family typewriter +xmlns +\family default + attribute on each formula) +\end_layout -\begin_layout Plain Layout --g +\begin_layout Itemize + +\change_inserted 1075283030 1616535090 +With the +\family typewriter +m +\family default + prefix (default): the MathML name space is defined at the document level + (using the +\family typewriter +xmlns:m +\family default + attribute on the root element). + Each MathML is prefixed with +\family typewriter +m +\family default +: for instance, +\family typewriter +m:math \end_layout -\end_inset +\begin_layout Itemize - option if you want to use the -\emph on -lyxpipe -\emph default -, and be sure to specify the \SpecialChar LyX -Server pipe path in the \SpecialChar LyX - preferences. +\change_inserted 1075283030 1616620405 +With the +\family typewriter +mml +\family default + prefix: similar to the +\family typewriter +m +\family default + option, but with +\family typewriter +mml \end_layout \begin_layout Standard -Reverse search is triggered by double-click. + +\change_inserted 1075283030 1616620470 +This option is especially useful if you want \SpecialChar LyX + to match your personal style + or to work with buggy software that only accepts one prefix for MathML. +\change_unchanged + +\end_layout + +\end_deeper +\begin_layout Chapter +The \SpecialChar LyX + Server \end_layout \begin_layout Section -Forward search +Introduction \end_layout \begin_layout Standard -Forward search is, as the name implies, in a sense the +The `\SpecialChar LyX + server' allows other programs to talk to \SpecialChar LyX +, invoke \SpecialChar LyX + commands, and retrieve + information about the \SpecialChar LyX + internal state. + This is only intended for advanced users, but they should find it useful. + It is by writing to the \SpecialChar LyX + server, for example, that bibliography managers, + such as JabRef, are able to \begin_inset Quotes eld \end_inset -opposite +push \begin_inset Quotes erd \end_inset - of reverse search. - It allows you to let the viewer jump to a given position from within \SpecialChar LyX + citations to \SpecialChar LyX . - If forward search is set up (as described in what follows), you can put - the cursor anywhere in your \SpecialChar LyX - document, and hit -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Navigate\SpecialChar menuseparator -Forward search \end_layout +\begin_layout Section +Starting the \SpecialChar LyX + Server +\begin_inset CommandInset label +LatexCommand label +name "sec:Starting-the-Server" + \end_inset - (or select -\begin_inset Flex Noun + +\end_layout + +\begin_layout Standard +The \SpecialChar LyX + server works through the use of a pair of named pipes. + These are usually located in +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Forward search +UserDir \end_layout \end_inset - in the context menu via right mouse click), and then the viewer will jump - to that position as well. - This implies, of course, that your viewer supports this function. -\end_layout +, (except on Windows, where +\emph on +local +\emph default + named pipes are special objects located in +\begin_inset Flex Code +status collapsed -\begin_layout Standard -To make forward search possible, you first need to provide the generated - output PDF/DVI file with additional information about the \SpecialChar TeX - sources. - This can be done via the methods described in the section -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:rev-search" +\begin_layout Plain Layout -\end_inset +\backslash +\backslash . +\backslash +pipe \end_layout -\begin_layout Standard -Additionally, you need to configure \SpecialChar LyX - for using your viewers in -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -Output\SpecialChar menuseparator -General -\end_layout +\end_inset +) and have the names +\begin_inset Quotes eld \end_inset -. - We provide a range of tested configurations for some viewers, which you - can select from the drop down list. - If none of these configurations suits you, you have to find out and enter - a suitable configuration yourself. - The definition syntax uses the following placeholders: -\end_layout -\begin_layout Itemize -\noindent \begin_inset Flex Code status collapsed \begin_layout Plain Layout -$$n +lyxpipe.in \end_layout \end_inset -: row number -\end_layout - -\begin_layout Itemize -\noindent -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -$$t -\end_layout +\begin_inset Quotes erd +\end_inset + and +\begin_inset Quotes eld \end_inset -: name of the (temporary) exported .tex file (without path) -\end_layout -\begin_layout Itemize -\noindent \begin_inset Flex Code status collapsed \begin_layout Plain Layout -$$f +lyxpipe.out \end_layout \end_inset -: name of the (temporary) exported .tex file (including path) -\end_layout -\begin_layout Itemize -\noindent +\begin_inset Quotes erd +\end_inset + +. + External programs write into \begin_inset Flex Code status collapsed \begin_layout Plain Layout -$$o +lyxpipe.in \end_layout \end_inset -: name of the exported output file (either dvi or pdf, depending on which - one exists in the temporary directory) -\end_layout - -\begin_layout Standard -Note that only some of the viewers provide full and usable forward search - functionality out of the box, among them yap, xdvi, okular -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -You might want to set + and read back data from \begin_inset Flex Code status collapsed \begin_layout Plain Layout -okular --unique +lyxpipe.out \end_layout \end_inset - in +. + The stem of the pipe names can be defined in the \begin_inset Flex Noun status collapsed \begin_layout Plain Layout Tools\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File -\begin_inset space ~ -\end_inset - -Formats -\end_layout - -\end_inset - - +Preferences \end_layout \end_inset -, qpdfview, and SumatraPDF -\begin_inset Foot + dialog, for example +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -SumatraPDF can also use DDE commands through the external program CMCDDE - — downloadable from -\begin_inset CommandInset href -LatexCommand href -target "http://www.istri.fr/spip/zip/CMCDDE.zip" -literal "false" - -\end_inset - - +"/home/myhome/lyxpipe" \end_layout \end_inset -. - Others, such as evince -\begin_inset Foot +, or +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Forward search with evince can be achieved by means of third party helper - scripts. - Please refer to -\begin_inset CommandInset href -LatexCommand href -target "https://wiki.lyx.org/LyX/SyncTeX" -literal "false" - -\end_inset +" +\backslash - for details. +\backslash +. +\backslash +pipe +\backslash +lyxpipe" \end_layout \end_inset -, require some extra tools in order to use forward search. - While many of the widespread PDF viewers (most notably Adobe Reader) do - not support forward search at all, some other viewers – e. -\begin_inset space \thinspace{} -\end_inset - -g. - xpdf – allow at least to reload the document and jump to a specific page - of the file, so you can at least navigate -\begin_inset Quotes eld -\end_inset + on Windows (where any working path instead of lyxpipe can be used, for + example +\begin_inset Flex Code +status collapsed -near -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +" +\backslash +\backslash . - This latter functionality is provided by an external call of synctex (see - the predefined example configurations). - +\backslash +pipe +\backslash +my +\backslash +lyx +\backslash +pipe" \end_layout -\begin_layout Standard -Forward search works both with DVI and PDF output. - \SpecialChar LyX - simply checks which preview format you have used before (i. -\begin_inset space \thinspace{} \end_inset -e., which format is already there in the temporary directory) and chooses - the appropriate configuration for the respective format. -\end_layout - -\begin_layout Chapter -Special Document Classes -\end_layout - -\begin_layout Section - -\change_deleted 564990737 1669742044 -A&A Paper + would also work). + You +\emph on +must +\emph default + configure this manually in order for the server to start. \end_layout \begin_layout Standard +\SpecialChar LyX + will add the ' +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -by -\noun on -Peter Sütterlin -\end_layout - -\begin_layout Subsection - -\change_deleted 564990737 1669742044 -Introduction +\begin_layout Plain Layout +.in \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -This section describes how \SpecialChar LyX - can be used to write articles for submission - to the scientific journal -\emph on -Astronomy and Astrophysics -\emph default - ( -\begin_inset Flex URL +' and ' +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -https://www.aanda.org/ +.out \end_layout \end_inset -) using Version 5.01 of the document class -\family typewriter -aa.cls -\family default -. - This package can be downloaded from the ftp site -\end_layout +' to create the pipes. + If one of the pipes already exists, \SpecialChar LyX + will assume that another \SpecialChar LyX + process + is already running and will not start the server. + On POSIX (Unix like) systems, if for some other reason, an unused +\begin_inset Quotes eld +\end_inset -\begin_layout Standard +stale +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669742044 -\begin_inset VSpace medskip + pipe is left in existence when \SpecialChar LyX + closes, then \SpecialChar LyX + will try to delete it. + If this fails for some reason, you will need to delete the pipes manually + and then restart \SpecialChar LyX +. + On Windows, pipes are deleted by the OS on program termination or crash, + so +\begin_inset Quotes eld \end_inset +stale +\begin_inset Quotes erd +\end_inset + pipes should not be possible. \end_layout \begin_layout Standard -\align center - -\change_deleted 564990737 1669742044 -\begin_inset Flex URL +To have several \SpecialChar LyX + processes with servers at the same time, you have to use + different configurations, perhaps by using separate user directories, each + with its own +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -ftp://ftp.edpsciences.org/pub/aa/readme.html -\end_layout - -\end_inset - - +preferences \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -\begin_inset VSpace medskip -\end_inset - +\end_inset + file, for each process. \end_layout \begin_layout Standard +If you are developing a client program, you might find it useful to enable + debugging information from the \SpecialChar LyX + server. + Do this by starting \SpecialChar LyX + as +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -A manual comes together with that package, and this text is not meant to - replace the original manual but is merely a short guide in how to realize - the correct form of your paper. - +\begin_layout Plain Layout +lyx -dbg lyxserver \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -Please note that the publisher of the journal was changed from Springer - to EDP Sciences starting January 1, 2001. - That change involved also some slight changes to the style files, namely - the removal of the thesaurus command. - The \SpecialChar LyX - class aa supports the newest version of these style files, V 5.01. - If you have an older version installed, please upgrade. - For compatibility, the old (version 4) layout has been kept as -\family sans -article (A&A V4) -\family default -. - Please refer to the comments in -\family typewriter -\SpecialChar LyX -Dir/layouts/aapaper.layout -\family default . \end_layout -\begin_layout Subsection +\begin_layout Standard +You can find a complete example client written in C++ in the source distribution + as +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Getting started +\begin_layout Plain Layout +development/lyxserver/server_monitor.cpp \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -It is recommended you start from the example template distributed with \SpecialChar LyX . - If you are not using a template, note the following settings: \end_layout -\begin_layout Itemize +\begin_layout Standard +Another useful tool is the command-line based client found in +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Select -\family sans -article (A&A) -\family default - in the -\family sans -Document\SpecialChar menuseparator -Settings -\family default - dialog (OK, that one was obvious). +\begin_layout Plain Layout +src/client/lyxclient \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 -Don't change the option -\family sans -Page -\begin_inset space ~ \end_inset -style -\family default -: Leave it set to -\family sans -default -\family default . - The whole layout is done by the macros, you shouldn't change anything. \end_layout -\begin_layout Subsection - -\change_deleted 564990737 1669742044 -The header block +\begin_layout Section +Normal communication \end_layout \begin_layout Standard - -\change_deleted 564990737 1669742044 -First thing to enter is the header information. - It consists of seven entries, of which some are optional. - They are +To issue a \SpecialChar LyX + call, the client writes a line of ASCII text into the input + pipe. + This line has the following format: \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Title -\family default -: [required] +\begin_layout Quote +LYXCMD: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +argument \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Subtitle -\family default -: [optional] +\begin_layout Description +clientname is a name that the client can choose arbitrarily. + Its only use is that \SpecialChar LyX + will echo it if it sends an answer—so a client can + dispatch results from different requesters. \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Author -\family default -: [required] +\begin_layout Description +function is the function you want \SpecialChar LyX + to perform. + It is the same as the commands you'd use in the minibuffer. \end_layout -\begin_layout Itemize +\begin_layout Description +argument is an optional argument which is meaningful only to some functions + (for instance, the +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +self-insert +\begin_inset Quotes erd +\end_inset -\family sans -Address -\family default -: [required] + LFUN will insert the argument as text at the cursor position). \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Offprints -\family default -: [optional] if more than one author: whom to contact for offprint requests. +\begin_layout Standard +The answer from \SpecialChar LyX + will arrive in the output pipe and be of the form \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Mail -\family default -: [optional] mail address for contacts. +\begin_layout Quote +INFO: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +data \end_layout -\begin_layout Itemize +\begin_layout Standard +where +\emph on +clientname +\emph default + and +\emph on +function +\emph default + are just echoed from the command request, while +\emph on +data +\emph default + is more or less useful information filled according to how the command + execution worked out. + Some commands, such as +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +font-state +\begin_inset Quotes erd +\end_inset -\family sans -Date -\family default -: [required]. - Suggested format is -\family typewriter -Received: ; Accepted +, will return information about the internal state of \SpecialChar LyX +, while other will + return an empty data-response. + This means that the command execution went fine. \end_layout \begin_layout Standard +In case of errors, the response from \SpecialChar LyX + will have this form +\end_layout -\change_deleted 564990737 1669742044 -There is no need to issue the -\family typewriter +\begin_layout Quote +ERROR: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +error message +\end_layout -\backslash -maketitle -\family default - command, this is done automatically by \SpecialChar LyX - when the header is finished. - Although the order of the single header entries doesn't matter it is advised - to keep the above sequence, just to get the best optics and meets the layout - of the real document. +\begin_layout Standard +where the +\emph on +error message +\emph default + should contain an explanation of why the command failed. \end_layout \begin_layout Standard +Examples: +\end_layout -\change_deleted 564990737 1669742044 -If you want to place footnotes in the header block, e. -\begin_inset space \thinspace{} +\begin_layout LyX-Code +echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in +\begin_inset Newline newline \end_inset -g. -\begin_inset space \space{} +echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in +\begin_inset Newline newline \end_inset -to state your present address, just use the standard footnote via the menu - -\family sans -Insert\SpecialChar menuseparator -Footnote. +read a <~/.lyxpipe.out +\begin_inset Newline newline +\end_inset -\family default - \SpecialChar LyX - will automagically use the term -\family typewriter +echo $a +\end_layout -\backslash -thanks{} -\family default - in that case. +\begin_layout Subsection +AppleScript (Mac OS X) \end_layout \begin_layout Standard - -\change_deleted 564990737 1669742044 -Under -\family sans -Edit\SpecialChar menuseparator -Text Style -\family default -, you'll find two insets which are relevant for the titling: +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 Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Institute -\family typewriter - -\family default -to mark corresponding author\SpecialChar breakableslash -institute pairs. - The institutes are numbered sequentially as they appear in the -\family sans -Address -\family default - field, so you have to put a marker to each author. +\begin_layout Standard +Example: \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Email -\family default - to supply an email address for fast contact. +\begin_layout LyX-Code +tell application "\SpecialChar LyX +" \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -In addition to these topics, the macros use one additional \SpecialChar LaTeX - command that - has no counterpart in \SpecialChar LyX -: +\begin_layout LyX-Code + try \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family typewriter - -\backslash -and -\family default - to separate different names for more than one author and institute, respectivel -y. +\begin_layout LyX-Code + -- Stores the current file name into f \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -The appropriate command has to be entered in \SpecialChar LyX - and marked as \SpecialChar LaTeX - code. - See the examples. - +\begin_layout LyX-Code + set f to (run "server-get-filename" with argument "") \end_layout -\begin_layout Subsection - -\change_deleted 564990737 1669742044 -The abstract +\begin_layout LyX-Code + on error the error_message number the error_number \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -The abstract should immediately follow the header block. - With version 5 the abstract environment was changed to a command, and there - is now a restriction to only one paragraph. - In addition, it should contain an entry with the keywords. - This is done via the paragraph style -\family sans -Keywords -\family default -. - Refer to the example paper. +\begin_layout LyX-Code + display dialog "Error: " & the error_number & ". + " ¬ \end_layout -\begin_layout Subsection +\begin_layout LyX-Code + & the error_message buttons {"OK"} default button 1 +\end_layout -\change_deleted 564990737 1669742044 -Supported environments +\begin_layout LyX-Code + end try \end_layout -\begin_layout Standard +\begin_layout LyX-Code +end tell +\end_layout -\change_deleted 564990737 1669742044 -The A&A paper layout supports the following environments for structuring - your text: +\begin_layout Section +Notification \end_layout -\begin_layout Itemize +\begin_layout Standard +\SpecialChar LyX + can notify clients of events going on asynchronously. + Currently it will only do this if the user binds a key sequence with the + function +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +notify +\begin_inset Quotes erd +\end_inset -\family sans -Standard +. + The format of the string \SpecialChar LyX + sends is as follows: \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\begin_layout Quote +\begin_inset Flex Code +status collapsed -\family sans -Section +\begin_layout Plain Layout +NOTIFY: \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 -\family sans -Subsection +\emph on +key-sequence \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Subsubsection +\begin_layout Standard +where +\emph on +key-sequence +\emph default + is the printed representation of the key sequence that was actually typed + by the user. \end_layout -\begin_layout Itemize +\begin_layout Standard +This mechanism can be used to extend \SpecialChar LyX +'s command set and implement macros. + Bind some key sequence to +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +notify +\begin_inset Quotes erd +\end_inset -\family sans -Itemize +. + Then start a client that listens on the output pipe, dispatches the command + according to the sequence, and starts a function that may use \SpecialChar LyX + calls and + \SpecialChar LyX + requests to issue a command or a series of commands to \SpecialChar LyX +. \end_layout -\begin_layout Itemize +\begin_layout Section +The simple \SpecialChar LyX + Server Protocol +\end_layout -\change_deleted 564990737 1669742044 +\begin_layout Standard +\SpecialChar LyX + implements a simple protocol that can be used for session management. + All messages are of the form +\end_layout -\family sans -Enumerate +\begin_layout Quote +LYXSRV: +\emph on +clientname +\emph default +: +\emph on +protocol message \end_layout -\begin_layout Itemize +\begin_layout Standard +where +\emph on +protocol message +\emph default + can be +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +hello +\begin_inset Quotes erd +\end_inset -\family sans -Description -\end_layout + or +\begin_inset Quotes eld +\end_inset -\begin_layout Itemize +bye +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669742044 +. + If +\begin_inset Quotes eld +\end_inset -\family sans -Caption -\end_layout +hello +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize + 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 -\change_deleted 564990737 1669742044 +bye +\begin_inset Quotes erd +\end_inset -\family sans -Abstract + sent from \SpecialChar LyX + will inform clients that \SpecialChar LyX + is closing. \end_layout -\begin_layout Itemize +\begin_layout Section +Reverse DVI/PDF search +\end_layout -\change_deleted 564990737 1669742044 +\begin_layout Standard +Some DVI/PDF viewers +\begin_inset Foot +status collapsed -\family sans -Acknowledgment +\begin_layout Plain Layout +The following viewers offer the reverse PDF search feature: Okular on KDE/Linux, + Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows. \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + provide +\emph on +reverse search +\emph default + facility (also called +\emph on +inverse search +\emph default +). + This means that you can tell \SpecialChar LyX + to put the cursor to a specific line in the + document by clicking at the respective position in the DVI/PDF output. + To achieve this, the viewer must be able to communicate with \SpecialChar LyX +. + This is done via the \SpecialChar LyX + server either by using the named pipe ( +\emph on +lyxpipe +\emph default +), or the UNIX domain socket ( +\emph on +lyxsocket +\emph default +) that \SpecialChar LyX + creates in its temporary directory (this is the way the +\begin_inset Flex Code +status collapsed -\family sans -Bibliography +\begin_layout Plain Layout +lyxclient \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -\SpecialChar LaTeX +\end_inset + program communicates with \SpecialChar LyX +). + In some cases, you need a helper script that mediates between the viewer + and \SpecialChar LyX +, in others, the viewer can communicate with \SpecialChar LyX + directly. + This depends on the selected viewer and on your operating system. + The same applies to the way viewers need to be configured and the way the + reverse search is actually performed. + In what follows, we will thus describe how to setup reverse search for + specific viewers. + Before we turn to this, though, we will explain what needs to be done generally + to enable reverse search in the DVI/PDF output. \end_layout \begin_layout Subsection +Automatic setup +\begin_inset CommandInset label +LatexCommand label +name "subsec:rev-search" + +\end_inset -\change_deleted 564990737 1669742044 -Commands not supported by \SpecialChar LyX \end_layout \begin_layout Standard +In most cases \SpecialChar LyX + will do the work for you by pressing the following button + in the toolbar: +\begin_inset Info +type "icon" +arg "buffer-toggle-output-sync" +\end_inset -\change_deleted 564990737 1669742044 -Some commands are not yet supported by the +. + Alternatively, you can also enable the feature by checking \family sans -paper (A&A) +Synchronize with Output \family default - layout for \SpecialChar LyX -. - Some have already been mentioned. - For the sake of completeness, they are listed all together here: -\end_layout - -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family typewriter - -\backslash -and -\end_layout - -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family typewriter + in +\begin_inset Flex Noun +status collapsed -\backslash -authorrunning +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Formats \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\end_inset -\family typewriter +. + 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 -\backslash -object{} +\begin_layout Plain Layout +View/Update \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family typewriter +\end_inset -\backslash -titlerunning{} + Toolbar. \end_layout \begin_layout Standard +If you need a different setting, you can select or input a custom macro + from the drop down box just below +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1669742044 -If you want to use any of these commands, you have to enter them yourself. - -\series bold -Do not forget to mark them as \SpecialChar LaTeX - code! +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Output\SpecialChar menuseparator +Synchronize with Output \end_layout -\begin_layout Subsection +\end_inset -\change_deleted 564990737 1669742044 -Figure and Table Floats +. \end_layout \begin_layout Standard +Note that the method +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -\SpecialChar LyX - provides support for the necessary float environments -\family sans -figure, figure*, table -\family default - and -\family sans -table* -\family default -, therefore we won't tell much about it here. - Refer to the -\emph on -User's -\begin_inset space ~ -\end_inset +\begin_layout Plain Layout + +\backslash +synctex=1 +\end_layout -Guide -\emph default -. - Just remember that tables should be left-aligned. - For that, select the table and change the alignment in -\family sans -Edit\SpecialChar menuseparator -Paragraph -\begin_inset space ~ \end_inset -Settings. -\end_layout + enables gzip compression. + If your viewer does not support it, you should instead use +\begin_inset Flex Code +status collapsed -\begin_layout Standard +\begin_layout Plain Layout -\change_deleted 564990737 1669742044 -There is only one special thing: the figures with caption besides the figure. - To create such a figure, you have to do the following: +\backslash +synctex=-1 \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Create a wide figure float: -\family sans -Insert\SpecialChar menuseparator -Float\SpecialChar menuseparator -Figure -\family default -, then right click in the figure and select -\family sans -Span -\begin_inset space ~ \end_inset -columns -\family default . \end_layout -\begin_layout Enumerate +\begin_layout Standard +Please also note that including the +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Enter your caption text. +\begin_layout Plain Layout +srcltx \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Press -\family sans -Return -\family default - to move the cursor above the caption. -\end_layout +\end_inset -\begin_layout Enumerate + package or +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Insert your figure +\begin_layout Plain Layout +src-specials \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Position the cursor behind the figure and insert a horizontal fill: -\family sans -Insert\SpecialChar menuseparator -Special -\begin_inset space ~ \end_inset -Character\SpecialChar menuseparator -Horizontal -\begin_inset space ~ -\end_inset + sometimes has an undesired impact on the typesetting. + Thus, you should switch output synchronization off for the final typesetting + if you use the +\begin_inset Flex Code +status collapsed -Fill -\family default -. +\begin_layout Plain Layout +srcltx \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Switch to \SpecialChar LaTeX - mode: -\family sans -M-c -\begin_inset space ~ \end_inset -t -\family default -. -\end_layout + package or +\begin_inset Flex Code +status collapsed -\begin_layout Enumerate +\begin_layout Plain Layout +src-specials +\end_layout -\change_deleted 564990737 1669742044 -Enter -\family typewriter +\end_inset -\backslash -parbox[b]{55mm}{ -\family default . -\series bold -Do not close the brace! \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Position the cursor behind the caption text, switch to \SpecialChar LaTeX - mode and insert - the closing brace: -\family sans -M-c +\begin_layout Standard +In case you need some more special settings that are not covered by the + automatic settings, read the next section about how to set up output synchroniz +ation manually. + If the automatic setup suits your needs, you can readily jump to section \begin_inset space ~ \end_inset -t -\family default - -\family typewriter -} -\family default -. -\end_layout -\begin_layout Standard +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:configuring-viewers" -\change_deleted 564990737 1669742044 -Also, refer to the figures in the example paper. +\end_inset + +, where the necessary configuration steps in your viewer – needed both with + the automatic and the manual setup – are described. \end_layout \begin_layout Subsection - -\change_deleted 564990737 1669742044 -Referee layout +Manual setup \end_layout \begin_layout Standard +\SpecialChar LaTeX + provides several different methods for reverse search. + Some are built-in in the +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -For submission, the paper has to be formated in a special double-spacing - layout. - For this purpose, you have to give the option -\family typewriter -referee -\family default - to the document class. - This must be done using the custom class options field in the -\family sans -Document\SpecialChar menuseparator -Settings -\family default - dialog. - Just enter the string -\family typewriter -referee -\family default - there. +\begin_layout Plain Layout +latex/pdflatex \end_layout -\begin_layout Subsection +\end_inset -\change_deleted 564990737 1669742044 -The example paper + program, some are provided by external packages. + Your choice depends on whether your \SpecialChar LaTeX + distribution already provides a given + method (the built-in methods are rather new) and whether your viewer can + cope with it. + The available methods are described in the following. +\end_layout + +\begin_layout Subsubsection* +Built-in DVI-search via src-specials (DVI only) \end_layout \begin_layout Standard +This method provides the DVI file with the necessary information for reverse + search. + It is available in \SpecialChar LaTeX + since quite some time (any somewhat recent \SpecialChar LaTeX + distribution + should include it), and it works reliably. + To enable it, change the +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1669742044 -The +\begin_layout Plain Layout +La \family sans -Examples +TeX \family default - directory contains an example paper written with \SpecialChar LyX -. - It is the example paper from the original macro package, translated to - \SpecialChar LyX -. - Use it for inspiration, and compare the original \SpecialChar LaTeX - code with \SpecialChar LyX - way of writing. + (plain)->DVI \end_layout -\begin_layout Section -Dinbrief -\end_layout +\end_inset -\begin_layout Standard -The document class + or +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +La \family sans -dinbrief -\family default - can be used to type letters according to German conventions. - A template file is included in -\family typewriter -.../lyx/share/templates +TeX \family default - for you to use as a starting point. + (plain)->DraftDVI \end_layout -\begin_layout Section -Elsevier Journals -\end_layout +\end_inset -\begin_layout Standard -See the \SpecialChar LyX - template file -\family typewriter -elsarticle.lyx -\family default -. - It contains all infos you need. + converter in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +Converters \end_layout -\begin_layout Section +\end_inset -\change_deleted 564990737 1669755802 -ijmpc and ijmpd + to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latex -src-specials $$i \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669755802 -by -\noun on -Panayotis Papasotiriou +. + 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 Subsection - -\change_deleted 564990737 1669755802 -Overview +\begin_layout Subsubsection* +External Packages (PDFSync and scrltx) \end_layout \begin_layout Standard - -\change_deleted 564990737 1669755802 -The ijmpc package is a set of macros that facilitates electronic manuscript - submission to the -\emph on -International Journal of Modern Physics C -\emph default -. - Similarly, the ijmpd package is for creating manuscripts to be submitted - to the +The packages \emph on -International Journal of Modern Physics D +pdfsync \emph default -. - Both journals are published by World Scientific. - The corresponding document classes are named -\family typewriter -ws-ijmpc.cls -\family default and -\family typewriter -ws-ijmpd.cls -\family default -, respectively. - These files, together with instructions for the authors, can be downloaded - from the sites -\begin_inset Flex URL +\emph on +scrltx +\emph default + provide reverse search facility for PDF output (via pdflatex) and DVI output, + respectively. + In order to enable it, load the packages in the \SpecialChar LyX + preamble: +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml +\backslash +usepackage{pdfsync} \end_layout \end_inset - and -\begin_inset Flex URL + for reverse PDF search, +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml +\backslash +usepackage[active]{srcltx} \end_layout \end_inset -. - Both packages are modified versions of the standard -\begin_inset Quotes eld + for reverse DVI search. +\end_layout + +\begin_layout Standard +If you want to be able to perform both DVI and PDF reverse searches, you + can also insert in the preamble the following lines +\end_layout + +\begin_layout LyX-Code + +\backslash +usepackage{ifpdf} +\begin_inset Newline newline \end_inset -article -\begin_inset Quotes erd + +\backslash +ifpdf +\begin_inset Newline newline \end_inset - package, and they are almost (but not exactly) identical. - Most of their features are supported by \SpecialChar LyX -. - I have used \SpecialChar LyX - successfully to write articles submitted to both journals - without any problem. -\end_layout + +\backslash +usepackage{pdfsync} +\begin_inset Newline newline +\end_inset -\begin_layout Subsection -\change_deleted 564990737 1669755802 -Writing a paper +\backslash +else +\begin_inset Newline newline +\end_inset + + +\backslash +usepackage[active]{srcltx} +\begin_inset Newline newline +\end_inset + + +\backslash +fi \end_layout \begin_layout Standard - -\change_deleted 564990737 1669755802 -As usual, the easiest way to write a paper is to start with a template. - Click on -\family sans -File\SpecialChar menuseparator -New from -\family default - -\family sans -Template -\family default -, then choose the -\family typewriter -ijmpc.lyx -\family default - or -\family typewriter -ijmpd.lyx -\family default - template. - This will give an (almost) empty document that includes the most common - fields found in a manuscript. - Simply overwrite the existing text (including the brackets, -\family typewriter -<> -\family default -) with your text. - You should keep in mind the following remarks. +This way, you can preview the file as either DVI or PDF (pdflatex) and the + right package will be used. \end_layout -\begin_layout Enumerate +\begin_layout Standard +Note that PDFSync might affect the output layout of your document. + It is therefore advised to disable PDFsync for final documents. +\end_layout -\change_deleted 564990737 1669755802 -\SpecialChar LyX - won't let you change the font size and the page style of the document, - because such modifications are not allowed by both packages. +\begin_layout Subsubsection* +Built-in reverse search via Sync\SpecialChar TeX + (DVI and PDF) \end_layout -\begin_layout Enumerate +\begin_layout Standard +Recent versions of +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669755802 -The language of the document should not be changed. - Before previewing your paper, be sure that the babel package is not used. - To do this, click on -\begin_inset Info -type "menu" -arg "dialog-show document" -\end_inset +\begin_layout Plain Layout +(pdf)latex +\end_layout - -\family sans -\SpecialChar menuseparator -Language -\family default -, and select -\begin_inset Quotes eld \end_inset -None -\begin_inset Quotes erd -\end_inset + have built-in support for both PDF and DVI reverse search. + This so-called +\emph on +Sync\SpecialChar TeX - as -\family sans -Language Package -\family default -. -\end_layout +\emph default + facility is basically the result of the integration of the PDFSync package + to the pdftex program and its merge with the +\emph on +scr-specials +\emph default + approach. + You need at least \SpecialChar TeX +Live 2008 or a recent Mik\SpecialChar TeX + distribution in order to use + it. +\begin_inset Foot +status collapsed -\begin_layout Enumerate +\begin_layout Plain Layout +For some reason, Mik\SpecialChar TeX + does not understand/obey the command \SpecialChar LyX + inserts into + the preamble when you check the "Enable Forward/Reverse Search" button + in the toolbar and does not generate the necessary info. +\end_layout -\change_deleted 564990737 1669755802 -The -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +The generation of the required info can be forced by changing the converter + "\SpecialChar LaTeX + (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters + from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding + the -synctex=1 switch). +\end_layout -Keywords -\begin_inset Quotes erd \end_inset - style must be used to define keywords. + Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix, + Skim on the Mac, SumatraPDF on Windows; see the next section for details) + already provide Sync\SpecialChar TeX + support. \end_layout -\begin_layout Enumerate +\begin_layout Standard +To enable Sync\SpecialChar TeX + for DVI output, change the +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1669755802 -The ijmpc package provides a style named -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +La +\family sans +TeX +\family default + (plain) -> DVI +\end_layout -Classification Codes -\begin_inset Quotes erd \end_inset -, which can be used to define classification codes, such as PACS numbers. - Note that this facility is not supported by the ijmpd package. -\end_layout + or +\begin_inset Flex Noun +status collapsed -\begin_layout Enumerate +\begin_layout Plain Layout +La +\family sans +TeX +\family default + (plain) -> DraftDVI +\end_layout -\change_deleted 564990737 1669755802 -Several new environments are available: -\begin_inset Quotes eld \end_inset -Definition -\begin_inset Quotes erd -\end_inset + converter in +\begin_inset Flex Noun +status collapsed -, -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +Converters +\end_layout -Step -\begin_inset Quotes erd \end_inset -, -\begin_inset Quotes eld -\end_inset + to +\begin_inset Flex Code +status collapsed -Example -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +latex -synctex=1 $$i +\end_layout -, -\begin_inset Quotes eld \end_inset -Remark -\begin_inset Quotes erd -\end_inset +, and for PDF output, change the +\begin_inset Flex Noun +status collapsed -, -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +La +\family sans +TeX +\family default + (pdflatex) -> PDF (pdflatex) +\end_layout -Notation -\begin_inset Quotes erd \end_inset -, -\begin_inset Quotes eld -\end_inset + converter to +\begin_inset Flex Code +status collapsed -Theorem -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +pdflatex -synctex=1 $$i +\end_layout -, -\begin_inset Quotes eld \end_inset -Proof -\begin_inset Quotes erd -\end_inset +. + Should your viewer not be considered in the following description, or in + case of missing success, please check the documentation of your viewer + whether the viewer needs to be configured for the use with Sync\SpecialChar TeX +. +\begin_inset Foot +status collapsed -, -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +Note that the option +\begin_inset Flex Code +status collapsed -Corollary -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +-synctex=1 +\end_layout -, -\begin_inset Quotes eld \end_inset -Lemma -\begin_inset Quotes erd -\end_inset + option enables gzip compression. + If your viewer does not support it, you should instead use +\begin_inset Flex Code +status collapsed -, -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +-synctex=-1 +\end_layout -Proposition -\begin_inset Quotes erd \end_inset -, -\begin_inset Quotes eld -\end_inset +. +\end_layout -Prop -\begin_inset Quotes erd \end_inset -, -\begin_inset Quotes eld -\end_inset -Question -\begin_inset Quotes erd -\end_inset +\end_layout -, -\begin_inset Quotes eld -\end_inset +\begin_layout Subsection +Configuring and using specific viewers +\begin_inset CommandInset label +LatexCommand label +name "subsec:configuring-viewers" -Claim -\begin_inset Quotes erd \end_inset -, and -\begin_inset Quotes eld -\end_inset -Conjecture -\begin_inset Quotes erd -\end_inset +\end_layout -. - Their use is more or less obvious. - \SpecialChar LyX - supports all these environments; it will use the proper label, text style, - and numbering scheme for each of them. +\begin_layout Subsubsection* +Xdvi (all platforms) \end_layout -\begin_layout Enumerate +\begin_layout Standard +If you use +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669755802 -Both packages use basic citations; the natbib package should not be used. - In \SpecialChar LyX -, citation references are shown as usual; in the output, citations are - shown as superscripts. - If you want to use a citation as normal text, you should use the -\family typewriter -refcite -\family default - command, e. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Plain Layout +xdvi +\end_layout -g. -\begin_inset space \space{} \end_inset +, you don't need to do anything else for performing a reverse DVI search, + as \SpecialChar LyX + already provides the necessary hooks for automatically using the +\begin_inset Flex Code +status collapsed -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +lyxclient +\end_layout -See Ref. -\begin_inset space \space{} \end_inset + program. + Just setup your document as described above (reverse search is triggered + by Ctrl-click or Alt-click on Mac OSX, respectively). +\end_layout -\family typewriter +\begin_layout Standard +However, if for whatever reason you want to use the named pipe instead of + the socket for communicating with \SpecialChar LyX +, simply change the DVI viewer in +\begin_inset Flex Noun +status collapsed -\backslash -refcite{key} -\family default +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats +\end_layout -\begin_inset Quotes erd \end_inset -. -\end_layout + to +\begin_inset Foot +status collapsed -\begin_layout Enumerate +\begin_layout Plain Layout +On Mac OSX you have to use +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669755802 -There is no -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l" +\end_layout -Acknowledgments -\begin_inset Quotes erd \end_inset - section in both packages. - To put acknowledgments, just use the -\begin_inset Quotes eld -\end_inset -Section* -\begin_inset Quotes erd +\end_layout + \end_inset - environment. + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +xdvi -editor "lyxeditor.sh %f %l" \end_layout -\begin_layout Enumerate +\end_inset + +, where +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lyxeditor.sh +\end_layout -\change_deleted 564990737 1669755802 -Appendices may be added to the paper, -\emph on -after -\emph default - the Acknowledgments and -\shape italic -before -\shape default - the References. - \SpecialChar LyX - provides a special environment, called -\begin_inset Quotes eld \end_inset -Appendices Section -\begin_inset Quotes erd + is a suitable script. + For example, a minimal shell script is the following one: +\end_layout + +\begin_layout LyX-Code +#!/bin/sh +\begin_inset Newline newline \end_inset - which marks the beginning of the appendices. - This environment should be left blank; it just sends a \SpecialChar LaTeX - command, but nothing - is really printed. - In \SpecialChar LyX -, the word -\begin_inset Quotes eld +LYXPIPE="/path/to/lyxpipe" +\begin_inset Newline newline \end_inset -Appendix -\begin_inset Quotes erd +COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2" +\begin_inset Newline newline \end_inset - is printed with blue letters, as a signal that all sections after that - point are appendices. - To write an appendix, use the -\begin_inset Quotes eld +echo "$COMMAND" > "${LYXPIPE}".in || exit +\begin_inset Newline newline \end_inset -Appendix -\begin_inset Quotes erd -\end_inset +read TMP < "${LYXPIPE}".out || exit +\end_layout + +\begin_layout Standard +where +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +/path/to/lyxpipe +\end_layout - environment. - \SpecialChar LyX - will number each appendix with capital letters, as required by both journals. - Note that -\begin_inset Quotes eld \end_inset -Appendices Section -\begin_inset Quotes erd + is the LyXServer pipe path specified in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +Paths +\end_layout + \end_inset - -\emph on -must -\emph default - be present before the first appendix; if not, all appendices will be numbered - as normal sections in the output. +. +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +In the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +development/tools \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1669755802 -The ijmpc and the ijmpd packages use the -\family typewriter -tbl -\family default - command to implement table captions. - As a result, a table created by \SpecialChar LyX - is printed correctly, but its caption - is ignored. - However, you can use some \SpecialChar TeX - code to overcome this problem, so that captions - are printed as expected. - To do so, create a float table as usual, remove the caption, and replace - it with the \SpecialChar TeX - code -\family typewriter + folder of a source distribution you can find a +\begin_inset Flex Code +status collapsed -\backslash -tbl{ +\begin_layout Plain Layout +lyxeditor +\end_layout + +\end_inset + + script which is able to locate the \emph on -your table caption +lyxpipe \emph default -}{ -\family default - (sic); you must also the \SpecialChar TeX - code -\family typewriter -} -\family default - immediately after the tabular material. - Study the example table included in the template files to see how this - trick is implemented. - Alternatively, If you need table captions, you should implement the whole - table float in a -\family typewriter -.tex -\family default - file, then include this file to the \SpecialChar LyX - document ( -\family sans -Insert\SpecialChar menuseparator -File\SpecialChar menuseparator -Child -\begin_inset space ~ + based on your preferences. +\end_layout + \end_inset -Document -\family default -). - Details on how to create a table float can be found in the files -\family typewriter -ws-ijmpc.tex -\family default - and -\family typewriter -ws-ijmpd.tex -\family default -, included in the corresponding packages. -\end_layout -\begin_layout Subsection +\end_layout -\change_deleted 564990737 1669755802 -Preparing a paper for submission +\begin_layout Subsubsection* +MacDviX (Mac OSX) \end_layout \begin_layout Standard - -\change_deleted 564990737 1669755802 -Before you submit your paper you must export the \SpecialChar LyX - document as a \SpecialChar LaTeX - file ( -\family sans -File\SpecialChar menuseparator -Export\SpecialChar menuseparator -\SpecialChar LaTeX - -\family default -) -\begin_inset Foot -status open +At the end of +\begin_inset Flex Code +status collapsed \begin_layout Plain Layout -Actually you have the choice between \SpecialChar LaTeX - (plain) and pdflatex. - If you intend to use pdflatex to prepare the paper, you should use the - pdflatex option so that included graphics are converted to PDF format, - ready for use by pdflatex. +/Applications/MacDviX_Folder/calleditor.script \end_layout \end_inset -, then make the following changes to the resulting -\family typewriter -.tex -\family default - file. +, add the following lines: \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -Remove the comment lines before the -\family typewriter +\begin_layout LyX-Code +/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1 +\begin_inset Newline newline +\end_inset -\backslash -documentclass -\family default - command. +exit 1 \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -Remove everything between (and including) the -\family typewriter +\begin_layout Standard +Modify the lines accordingly if you install \SpecialChar LyX + somewhere else than in the + Applications folder. +\end_layout -\backslash -makeatletter -\family default - and -\family typewriter +\begin_layout Standard +Reverse search is triggered by Alt-click (OPTION-click). +\end_layout -\backslash -makeatother -\family default - commands, except for any commands you specifically put into the \SpecialChar LaTeX - preamble. +\begin_layout Subsubsection* +Skim (Mac OSX) \end_layout \begin_layout Standard +Enter +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669755802 -The modified -\family typewriter -.tex -\family default - file should be saved and processed through \SpecialChar LaTeX - as many times as necessary. - You may also want to check the resulting -\family typewriter -.dvi -\family default - document. -\change_unchanged - +\begin_layout Plain Layout +open -a Skim.app $$i \end_layout -\begin_layout Section +\end_inset -\change_deleted 564990737 1669801478 -iopart + to the viewer setting in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats\SpecialChar menuseparator +PDF (pdflatex) \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669801478 -by -\noun on -Uwe Stöhr +, and then in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Skim\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +Sync \end_layout -\begin_layout Subsection +\end_inset -\change_deleted 564990737 1669801478 -Overview + choose +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +custom \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669801478 -The iopart package provides a document class to create electronic manuscript - submission to the journals published by the Institute of Physics. - Instructions for the authors how to create a paper using the iopart class - can be downloaded together with the iopart package from the site -\begin_inset Flex URL + preset and enter command +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout - -ftp://ftp.iop.org/pub/journals/latex2e +/Applications/\SpecialChar LyX +.app/Contents/MacOS/lyxeditor \end_layout \end_inset @@ -17468,892 +17316,851 @@ ftp://ftp.iop.org/pub/journals/latex2e . \end_layout -\begin_layout Subsection +\begin_layout Standard +Reverse search is triggered by COMMAND-SHIFT-click +\end_layout -\change_deleted 564990737 1669801478 -Writing a paper +\begin_layout Subsubsection* +Evince (GNOME) \end_layout \begin_layout Standard +Reverse search with evince does not work out of the box, but it can be achieved + by means of some third party helper scripts. + Please refer to +\begin_inset CommandInset href +LatexCommand href +target "https://wiki.lyx.org/LyX/SyncTeX" +literal "false" -\change_deleted 564990737 1669801478 -The easiest way to write a paper is to start with the template -\emph on -IOP-article.lyx -\emph default - that is available via -\family sans -File\SpecialChar menuseparator -New From Template -\family default - The template explains how to use the special text environments. - Here are the most important advices: -\end_layout - -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669801478 -To be able to compile your document to a PDF, PS, or DVI, ensure that the - no AMS packages are loaded in -\family sans -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Math Options -\family default -! + for details. \end_layout -\begin_layout Itemize +\begin_layout Subsubsection* +Okular (KDE) +\end_layout -\change_deleted 564990737 1669801478 +\begin_layout Standard +Go to +\begin_inset Flex Noun +status collapsed -\size normal -The title environment defines the kind of your paper. - So use one of the following environments for the title: +\begin_layout Plain Layout +Settings\SpecialChar menuseparator +Configure Okular\SpecialChar menuseparator +Editor \end_layout -\begin_deeper -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669801478 + and select LyX +\begin_inset Quotes erd +\end_inset -\family sans -\size normal -Title -\family default - for a Paper -\end_layout + as editor. + This inserts the appropriate command ( +\begin_inset Flex Code +status collapsed -\begin_layout Itemize +\begin_layout Plain Layout +lyxclient -g %f %l +\end_layout -\change_deleted 564990737 1669801478 +\end_inset -\family sans -\size normal -Review -\family default - for a Review +). \end_layout -\begin_layout Itemize +\begin_layout Standard +Reverse search is triggered by SHIFT-click. -\change_deleted 564990737 1669801478 +\change_inserted -712698321 1578211026 + Note that this only works if Okular is in +\begin_inset Quotes eld +\end_inset -\family sans -\size normal -Topical -\family default - for a Topical review -\end_layout +Browse +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize + mode (i. +\begin_inset space \thinspace{} +\end_inset -\change_deleted 564990737 1669801478 +e., the hand symbol is clicked). +\change_unchanged -\family sans -\size normal -Comment -\family default - for a Comment \end_layout -\begin_layout Itemize +\begin_layout Subsubsection* +Qpdfview (Unix) +\end_layout -\change_deleted 564990737 1669801478 +\begin_layout Standard +Qpdfview supports Sync\SpecialChar TeX + since version 0.3.5. + Go to +\begin_inset Flex Noun +status collapsed -\family sans -\size normal -Note -\family default - for a Note +\begin_layout Plain Layout +Edit\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Behavior \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669801478 +\end_inset -\family sans -\size normal -Paper -\family default - for a Paper (same as Title) -\end_layout +, click on the input field of the +\begin_inset Quotes eld +\end_inset -\begin_layout Itemize +Source editor +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669801478 + item and add the command +\begin_inset Flex Code +status collapsed -\family sans -\size normal -Prelim -\family default - for a Preliminary communication +\begin_layout Plain Layout +lyxclient -g %1 %2 \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669801478 +. +\end_layout -\family sans -\size normal -Rapid -\family default - for a Rapid communication +\begin_layout Standard +Reverse search is triggered by double-click or, in more recent versions, + by context menu. \end_layout -\begin_layout Itemize +\begin_layout Subsubsection* +YAP (Windows) +\end_layout -\change_deleted 564990737 1669801478 +\begin_layout Standard +Launch yap, choose its +\begin_inset Flex Noun +status collapsed -\family sans -\size normal -Letter -\family default - for a Letter to the editor +\begin_layout Plain Layout +View\SpecialChar menuseparator +Options \end_layout -\end_deeper -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669801478 + menu and select the +\begin_inset Quotes eld +\end_inset -\size normal -All title environments except of -\family sans -Letter -\family default - can have an optional short title. -\end_layout +Inverse DVI Search +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize + tab. + Click on the +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669801478 -There is a general title environment -\family sans -Article -\family default - which is not directly supported by \SpecialChar LyX -. - This can be used as \SpecialChar TeX - code when your document doesn't fit into one of the - other title types. -\end_layout +New\SpecialChar ldots -\begin_layout Standard +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669801478 -For more informations like hints for special table and formula formatting, - look at the IOP author guidelines. -\change_unchanged + button and, in the window that opens, enter +\begin_inset Quotes eld +\end_inset + +\SpecialChar LyX + Editor +\begin_inset Quotes erd +\end_inset -\end_layout + (or any other name you like) in the +\begin_inset Quotes eld +\end_inset -\begin_layout Section +Name: +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1670317155 -Kluwer -\end_layout + field. + Now click on the button labeled +\begin_inset Quotes eld +\end_inset -\begin_layout Standard +\SpecialChar ldots -\change_deleted 564990737 1670317155 -by -\noun on -Panayotis Papasotiriou -\end_layout +\begin_inset Quotes erd +\end_inset -\begin_layout Subsection + to open a file dialog and navigate to the directory containing the batch + file +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1670317155 -Overview +\begin_layout Plain Layout +lyxeditor.bat \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1670317155 -The Kluwer package is a set of macros produced by Kluwer Academic Publishers - that facilitates electronic manuscript submission to the journals they - publish. - Most known of them (at least in my domain of interest) are -\emph on -Astrophysics and Space Science -\emph default - and -\emph on -Solar Physics -\emph default -, but there are many others (see a complete list at -\begin_inset Flex URL + (see below). + Select +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -http://www.wkap.nl/jrnllist.htm/JRNLHOME +lyxeditor.bat \end_layout \end_inset -). - The Kluwer package may be downloaded from the site -\begin_inset Flex URL + and then specify the program arguments as +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -http://www.wkap.nl/kaphtml.htm/STYLEFILES +%f %l \end_layout \end_inset . - A complete user guide is contained in that package (but it can also be - downloaded separately). -\end_layout + The +\begin_inset Flex Code +status collapsed -\begin_layout Standard +\begin_layout Plain Layout +lyxeditor.bat +\end_layout -\change_deleted 564990737 1670317155 -\SpecialChar LyX - supports many features of the package but not everything. - However, the \SpecialChar TeX - code needed is reduced to some -\begin_inset Quotes eld \end_inset -peculiar -\begin_inset Quotes erd -\end_inset + wrapper is used for communicating with \SpecialChar LyX + through the +\emph on +lyxpipe +\emph default + and is as follows: +\end_layout - commands of the package (see -\begin_inset space ~ +\begin_layout LyX-Code +@echo off +\begin_inset Newline newline \end_inset +echo LYXCMD:revdvi:server-goto-file-row:%~1 %2> +\backslash -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:kluwer_peculiarities" - +\backslash +. +\backslash +pipe +\backslash +lyxpipe.in +\begin_inset Newline newline \end_inset -). - I have recently used \SpecialChar LyX - to write an article submitted to the -\emph on -Astrophysics and Space Science -\emph default - without any problem. -\end_layout - -\begin_layout Subsection +type +\backslash -\change_deleted 564990737 1670317155 -Writing a paper +\backslash +. +\backslash +pipe +\backslash +lyxpipe.out \end_layout \begin_layout Standard +Make sure that the \SpecialChar LyX +Server pipe path you specified in \SpecialChar LyX + is +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1670317155 -The easiest way to write a paper is to start with the Kluwer template file. - Click on -\family sans -File\SpecialChar menuseparator -New from -\family default - -\family sans -Template -\family default -, then choose the -\family typewriter -kluwer.lyx -\family default - template. - This will give an (almost) empty document that includes the most common - fields found in a manuscript and a short description of their use. - As in most templates, simply overwrite the existing text (including the - brackets, -\family typewriter -<> -\family default -) with the correct information. -\end_layout +\begin_layout Plain Layout -\begin_layout Subsection +\backslash -\change_deleted 564990737 1670317155 -Preparing a paper for submission +\backslash +. +\backslash +pipe +\backslash +lyxpipe \end_layout -\begin_layout Standard - -\change_deleted 564990737 1670317155 -As in the AAS\SpecialChar TeX - package, before you submit your paper to a journal you must - -\begin_inset Quotes eld \end_inset -postprocess -\begin_inset Quotes erd -\end_inset +, otherwise change the +\begin_inset Flex Code +status collapsed - it as follows. +\begin_layout Plain Layout +lyxeditor.bat \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -Export your paper as a \SpecialChar LaTeX - file. - To do this, click on -\family sans -File\SpecialChar menuseparator -Export\SpecialChar menuseparator -\SpecialChar LaTeX + wrapper accordingly. +\end_layout -\family default -. - +\begin_layout Standard +In yap, reverse search is triggered by double-click. \end_layout -\begin_layout Enumerate +\begin_layout Subsubsection* +SumatraPDF (Windows) +\end_layout -\change_deleted 564990737 1670317155 -Edit the resulting -\family typewriter -.tex -\family default - file with a text editor and make the following changes +\begin_layout Standard +In order to use SumatraPDF for inverse search, enter +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +SumatraPDF -inverse-search "lyxeditor.bat "%f" %l" \end_layout -\begin_deeper -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -remove the comment lines before the -\family typewriter + in the viewer setting in +\begin_inset Flex Noun +status collapsed -\backslash -documentclass -\family default - command, +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats\SpecialChar menuseparator +PDF (pdflatex) \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -remove everything between (and including) the -\family typewriter +, where +\begin_inset Flex Code +status collapsed -\backslash -makeatletter -\family default - and -\family typewriter +\begin_layout Plain Layout +lyxeditor.bat +\end_layout + +\end_inset -\backslash -makeatother -\family default - commands, except for any commands you specifically put into the \SpecialChar LaTeX - preamble. + is the previous wrapper. + If SumatraPDF.exe is not in your command PATH, use its full file name. \end_layout \begin_layout Standard +Reverse search is triggered by double-click. +\end_layout -\change_deleted 564990737 1670317155 -Save the resulting -\family typewriter -.tex -\family default - file. +\begin_layout Subsubsection* +YAP (Cygwin) \end_layout -\end_deeper -\begin_layout Enumerate +\begin_layout Standard +First of all, make sure that yap is your default DVI viewer in the Windows + environment, then launch it, choose its +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1670317155 -Run the -\family typewriter -.tex -\family default - file through \SpecialChar LaTeX - as many times as necessary (usually up to three). +\begin_layout Plain Layout +View\SpecialChar menuseparator +Options \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -View the resulting -\family typewriter -.dvi -\family default - document using, e. -\begin_inset space \thinspace{} + menu and select the +\begin_inset Quotes eld \end_inset -g. -\begin_inset space \space{} +Inverse DVI Search +\begin_inset Quotes erd \end_inset + tab. + Click on the +\begin_inset Quotes eld +\end_inset -\family sans -xdvi -\family default -, and check if everything is OK (it should, if you didn't make any mistake). -\end_layout +New\SpecialChar ldots -\begin_layout Subsection +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1670317155 + button and, in the window that opens, enter \begin_inset Quotes eld \end_inset -Peculiarities +\SpecialChar LyX + Editor \begin_inset Quotes erd \end_inset - of the Kluwer package -\begin_inset CommandInset label -LatexCommand label -name "subsec:kluwer_peculiarities" + (or any other name you like) in the +\begin_inset Quotes eld +\end_inset + +Name: +\begin_inset Quotes erd +\end_inset + + field. + Now click on the button labeled +\begin_inset Quotes eld +\end_inset + +\SpecialChar ldots +\begin_inset Quotes erd \end_inset + to open a file dialog and navigate to the directory containing the +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +lyxeditor.exe \end_layout -\begin_layout Standard +\end_inset + + program (which is installed by default on Cygwin along with the \SpecialChar LyX + executable). + Select +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lyxeditor.exe +\end_layout -\change_deleted 564990737 1670317155 -The Kluwer package has the following -\begin_inset Quotes eld \end_inset -peculiarities -\begin_inset Quotes erd + and then specify the program arguments as +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-g %f %l +\end_layout + \end_inset . + In this way, you will be using the +\emph on +lyxsocket +\emph default + for communicating with \SpecialChar LyX +. + If, for whatever reason, you want to use the +\emph on +lyxpipe +\emph default +, omit the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-g \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -It is possible to write multiple articles in the same \SpecialChar LaTeX - file -\begin_inset Foot + option and be sure to specify the \SpecialChar LyX +Server pipe path in the \SpecialChar LyX + preferences. +\end_layout + +\begin_layout Standard +In yap, reverse search is triggered by double-click. +\end_layout + +\begin_layout Subsubsection* +SumatraPDF (Cygwin) +\end_layout + +\begin_layout Standard +In order to use SumatraPDF for inverse search, enter +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -I can't imagine any good reason to do this. +SumatraPDF -inverse-search "lyxeditor -g %f %l" \end_layout \end_inset -. - Each article must be included in the environment -\begin_inset Quotes eld -\end_inset + in the viewer setting in +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats\SpecialChar menuseparator +PDF (pdflatex) +\end_layout -article -\begin_inset Quotes erd \end_inset . - Unfortunately, this environment cannot be omitted, even if you write just - one article. - Therefore, each article starts with the command -\family typewriter + If SumatraPDF.exe is not in your command PATH, use its full posix path. + The +\begin_inset Flex Code +status collapsed -\backslash -begin{article} -\family default - and, obviously, ends with the command -\family typewriter +\begin_layout Plain Layout +-g +\end_layout -\backslash -end{article} -\family default -. - Although this can be implemented in \SpecialChar LyX -, I didn't included it, since it looks - ugly and can confuse the novice user. - Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX - code (the - well-known -\begin_inset Quotes eld \end_inset -\SpecialChar TeX - code -\begin_inset Quotes erd + enables communication via the +\emph on +lyxsocket +\emph default +. + Again, omit the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-g +\end_layout + \end_inset -). + option if you want to use the +\emph on +lyxpipe +\emph default +, and be sure to specify the \SpecialChar LyX +Server pipe path in the \SpecialChar LyX + preferences. \end_layout -\begin_layout Enumerate +\begin_layout Standard +Reverse search is triggered by double-click. +\end_layout -\change_deleted 564990737 1670317155 -Information given at the beginning of the article (i. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Section +Forward search +\end_layout -e. -\begin_inset space \space{} +\begin_layout Standard +Forward search is, as the name implies, in a sense the +\begin_inset Quotes eld \end_inset -title, subtitle, author, institution, running title, running author, abstract - and keywords) must be included in an environment called -\begin_inset Quotes eld +opposite +\begin_inset Quotes erd \end_inset -opening -\begin_inset Quotes erd + of reverse search. + It allows you to let the viewer jump to a given position from within \SpecialChar LyX +. + If forward search is set up (as described in what follows), you can put + the cursor anywhere in your \SpecialChar LyX + document, and hit +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Navigate\SpecialChar menuseparator +Forward search +\end_layout + \end_inset -. - This is not implemented in \SpecialChar LyX -, so you must enter title, subtitle etc. -\begin_inset space ~ -\end_inset + (or select +\begin_inset Flex Noun +status collapsed -between two \SpecialChar TeX - code lines ( -\family typewriter +\begin_layout Plain Layout +Forward search +\end_layout -\backslash -begin{opening} -\family default - and -\family typewriter +\end_inset -\backslash -end{opening} -\family default -). + in the context menu via right mouse click), and then the viewer will jump + to that position as well. + This implies, of course, that your viewer supports this function. \end_layout -\begin_layout Enumerate +\begin_layout Standard +To make forward search possible, you first need to provide the generated + output PDF/DVI file with additional information about the \SpecialChar TeX + sources. + This can be done via the methods described in the section +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:rev-search" -\change_deleted 564990737 1670317155 -According to the user manual, the label of each bibliography item must be - written as -\family typewriter +\end_inset -\backslash -protect -\backslash -citeauthoryear{ -\family default -\emph on -author(s) -\family typewriter -\emph default -}{ -\family default -\emph on -year -\family typewriter -\emph default -} -\family default . \end_layout \begin_layout Standard +Additionally, you need to configure \SpecialChar LyX + for using your viewers in +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1670317155 -The -\family typewriter -kluwer.lyx -\family default - template takes care of all these -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +Output\SpecialChar menuseparator +General +\end_layout -peculiarities -\begin_inset Quotes erd \end_inset . - If you start a new paper using this template you don't need to do anything - special. - Just + We provide a range of tested configurations for some viewers, which you + can select from the drop down list. + If none of these configurations suits you, you have to find out and enter + a suitable configuration yourself. + The definition syntax uses the following placeholders: \end_layout -\begin_layout Enumerate +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1670317155 -don't delete the \SpecialChar TeX - code included in the template, and +\begin_layout Plain Layout +$$n \end_layout -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -copy the example bibliography item included in the template and modify it - as necessary to enter new bibliography items. +: row number \end_layout -\begin_layout Section -Paper +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$t \end_layout -\begin_layout Standard -The document class -\family sans -paper -\family default - provides an alternative to the standard -\family sans -article -\family default - class. - It provides similar functionality, but you might prefer this layout with - sans serif sections, headings, and more. +\end_inset + +: name of the (temporary) exported .tex file (without path) \end_layout -\begin_layout Section -Springer Journals ( -\family sans -svjour -\family default -) +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$f \end_layout -\begin_layout Standard -by -\noun on -Martin Vermeer +\end_inset + +: name of the (temporary) exported .tex file (including path) \end_layout -\begin_layout Subsection -Description +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$o +\end_layout + +\end_inset + +: name of the exported output file (either dvi or pdf, depending on which + one exists in the temporary directory) \end_layout \begin_layout Standard -These are the layout files for some of the journal formats used by Springer - Verlag and listed on -\begin_inset Flex URL +Note that only some of the viewers provide full and usable forward search + functionality out of the box, among them yap, xdvi, okular +\begin_inset Foot status collapsed \begin_layout Plain Layout +You might want to set +\begin_inset Flex Code +status collapsed -http://www.springer.de/author/tex/help-journals.html +\begin_layout Plain Layout +okular --unique \end_layout \end_inset -, 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 -svjour.inc -\family default -, which journal-specific layout files (such as, e. -\begin_inset space \thinspace{} +\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 -g. -\begin_inset space \space{} +Formats +\end_layout + \end_inset -\family typewriter -svjog.layout -\family default - for Journal of Geodesy) can include. \end_layout -\begin_layout Standard -This means that implementing support for any other Springer journal on this - list is as simple as writing your own -\family typewriter -sv -\family default - -\family typewriter -.layout -\family default - file following the outline given in -\family typewriter -svjog.layout -\family default -. - -\end_layout +\end_inset -\begin_layout Standard -It is reasonably well tested only for the Journal of Geodesy. - -\family typewriter -svjour -\family default - and -\family typewriter -svjog -\family default - come with the standard \SpecialChar LyX - distribution. - Install the relevant class file (downloaded from Springer) in a proper - directory, reconfigure \SpecialChar LaTeX - (in the te\SpecialChar TeX - case by running -\family typewriter -texhash -\family default -, as root if necessary — doesn't \SpecialChar LyX - take care of this?), reconfigure \SpecialChar LyX - and - it should work. -\end_layout +, qpdfview, and SumatraPDF +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +SumatraPDF can also use DDE commands through the external program CMCDDE + — downloadable from +\begin_inset CommandInset href +LatexCommand href +target "http://www.istri.fr/spip/zip/CMCDDE.zip" +literal "false" + +\end_inset -\begin_layout Subsection -New styles -\end_layout -\begin_layout Standard -A large number of theorem-like styles — -\family sans -Claim, Conjecture, -\family default - -\family sans -\SpecialChar ldots -Theorem -\family default -. \end_layout -\begin_layout Standard +\end_inset -\family sans -Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX -_Title, Author_Running, Institute, - Mail, Offprints, Keywords, Acknowledgements, Acknowledgement -\family default . - See the Springer class file documentation for details. -\end_layout + Others, such as evince +\begin_inset Foot +status collapsed -\begin_layout Subsection -Supported journals -\end_layout +\begin_layout Plain Layout +Forward search with evince can be achieved by means of third party helper + scripts. + Please refer to +\begin_inset CommandInset href +LatexCommand href +target "https://wiki.lyx.org/LyX/SyncTeX" +literal "false" -\begin_layout Itemize +\end_inset -\emph on -Journal of Geodesy -\emph default -: -\family typewriter -svjog.layout -\family default - — Martin Vermeer + for details. \end_layout -\begin_layout Itemize +\end_inset -\emph on -Probability Theory and Related Fields -\emph default -: -\family typewriter -svprobth.layout -\family default - — Jean-Marc Lasgouttes -\end_layout +, require some extra tools in order to use forward search. + While many of the widespread PDF viewers (most notably Adobe Reader) do + not support forward search at all, some other viewers – e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Standard -Add your own, it isn't so hard! -\end_layout +g. + xpdf – allow at least to reload the document and jump to a specific page + of the file, so you can at least navigate +\begin_inset Quotes eld +\end_inset -\begin_layout Subsection -Credits +near +\begin_inset Quotes erd +\end_inset + +. + This latter functionality is provided by an external call of synctex (see + the predefined example configurations). + \end_layout \begin_layout Standard -These files are partly based on the older -\family typewriter -ejour2.layout -\family default -, 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 -ejour2 -\family default - layout, are now defunct. - Jean-Marc Lasgouttes helped out big in making me find my way around the +Forward search works both with DVI and PDF output. \SpecialChar LyX - layout file mechanism. -\end_layout + simply checks which preview format you have used before (i. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Subsection -Bugs +e., which format is already there in the temporary directory) and chooses + the appropriate configuration for the respective format. \end_layout -\begin_layout Standard -Probably. - But probably less than in the old hacked-\SpecialChar LaTeX - -\family typewriter -ejour2 -\family default -. +\begin_layout Chapter +Special Document Classes \end_layout \begin_layout Section -Slides [aka -\noun on -Sli\SpecialChar TeX - -\noun default -] -\begin_inset CommandInset label -LatexCommand label -name "sec:slitex" - -\end_inset - +\change_deleted 564990737 1669742044 +A&A Paper \end_layout \begin_layout Standard + +\change_deleted 564990737 1669742044 by \noun on -John Weiss -\noun default - +Peter Sütterlin \end_layout \begin_layout Subsection + +\change_deleted 564990737 1669742044 Introduction \end_layout \begin_layout Standard -This section describes how to use \SpecialChar LyX - to make slides for overhead projectors. - There are two document classes that can do this: the default slides class - and the -\family sans -Foil\SpecialChar TeX -\family default - slides class. - This section documents the former. +\change_deleted 564990737 1669742044 +This section describes how \SpecialChar LyX + can be used to write articles for submission + to the scientific journal +\emph on +Astronomy and Astrophysics +\emph default + ( +\begin_inset Flex URL +status collapsed + +\begin_layout Plain Layout + +https://www.aanda.org/ \end_layout -\begin_layout Standard -I'm going to say this again, nice and clear, so that there's no misunderstanding -: +\end_inset + +) using Version 5.01 of the document class +\family typewriter +aa.cls +\family default +. + This package can be downloaded from the ftp site \end_layout \begin_layout Standard -\begin_inset VSpace bigskip + +\change_deleted 564990737 1669742044 +\begin_inset VSpace medskip \end_inset @@ -18362,2031 +18169,2224 @@ I'm going to say this again, nice and clear, so that there's no misunderstanding \begin_layout Standard \align center -\size large -This section documents the class -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +\begin_inset Flex URL +status collapsed +\begin_layout Plain Layout -\family sans -slides (default) -\family default +ftp://ftp.edpsciences.org/pub/aa/readme.html +\end_layout -\begin_inset Quotes erd \end_inset - -\emph on -only. + \end_layout \begin_layout Standard -\begin_inset VSpace bigskip + +\change_deleted 564990737 1669742044 +\begin_inset VSpace medskip \end_inset \end_layout \begin_layout Standard -If you're looking for the documentation for -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +A manual comes together with that package, and this text is not meant to + replace the original manual but is merely a short guide in how to realize + the correct form of your paper. + +\end_layout + +\begin_layout Standard +\change_deleted 564990737 1669742044 +Please note that the publisher of the journal was changed from Springer + to EDP Sciences starting January 1, 2001. + That change involved also some slight changes to the style files, namely + the removal of the thesaurus command. + The \SpecialChar LyX + class aa supports the newest version of these style files, V 5.01. + If you have an older version installed, please upgrade. + For compatibility, the old (version 4) layout has been kept as \family sans -slides (Foil\SpecialChar TeX -) +article (A&A V4) \family default +. + Please refer to the comments in +\family typewriter +\SpecialChar LyX +Dir/layouts/aapaper.layout +\family default +. +\end_layout -\begin_inset Quotes erd -\end_inset - -, check out section -\begin_inset space ~ -\end_inset - +\begin_layout Subsection -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:foiltex" +\change_deleted 564990737 1669742044 +Getting started +\end_layout -\end_inset +\begin_layout Standard -. - The -\family sans -foils -\family default - class [ -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +It is recommended you start from the example template distributed with \SpecialChar LyX +. + If you are not using a template, note the following settings: +\end_layout +\begin_layout Itemize +\change_deleted 564990737 1669742044 +Select \family sans -slides (Foil\SpecialChar TeX -) +article (A&A) +\family default + in the +\family sans +Document\SpecialChar menuseparator +Settings \family default + dialog (OK, that one was obvious). +\end_layout -\begin_inset Quotes erd +\begin_layout Itemize + +\change_deleted 564990737 1669742044 +Don't change the option +\family sans +Page +\begin_inset space ~ \end_inset -] is actually somewhat better than the default +style +\family default +: Leave it set to \family sans -slides +default \family default - class, -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -\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. +. + The whole layout is done by the macros, you shouldn't change anything. \end_layout -\end_inset +\begin_layout Subsection - which this section documents. +\change_deleted 564990737 1669742044 +The header block \end_layout \begin_layout Standard -This class is the \SpecialChar LaTeX2e - improvement of the old -\noun on -Sli\SpecialChar TeX -\noun default - package. - Every \SpecialChar LaTeX2e - distribution includes this class [which I'll just refer to as -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +First thing to enter is the header information. + It consists of seven entries, of which some are optional. + They are +\end_layout +\begin_layout Itemize + +\change_deleted 564990737 1669742044 \family sans -slides +Title \family default +: [required] +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize + +\change_deleted 564990737 1669742044 - from now on], so you're bound to have it. - As I noted earlier, there are other classes, such as -\family sans -foils -\family default -, which also produce slides for overhead projectors and do a better job - at it. - However, there are some things which \family sans -slides +Subtitle \family default - can do which the others can't, such as generate overlays. - Read on to learn more! +: [optional] \end_layout -\begin_layout Subsection -Getting Started -\begin_inset CommandInset label -LatexCommand label -name "sec:slidesetup" - -\end_inset +\begin_layout Itemize +\change_deleted 564990737 1669742044 +\family sans +Author +\family default +: [required] \end_layout -\begin_layout Standard -Obviously, to use this document class, you need to select -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize +\change_deleted 564990737 1669742044 \family sans -slides (default) +Address \family default +: [required] +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize + +\change_deleted 564990737 1669742044 - from the class list in the \family sans -Document\SpecialChar menuseparator -Settings +Offprints \family default - dialog. - There are some other special things you should know about this class: +: [optional] if more than one author: whom to contact for offprint requests. \end_layout \begin_layout Itemize -Don't bother changing the options -\family sans -Sides and Columns -\family default -. - They're not supported by the + +\change_deleted 564990737 1669742044 + \family sans -slides +Mail \family default - class, anyways. +: [optional] mail address for contacts. \end_layout \begin_layout Itemize -The option -\family sans -Page -\begin_inset space ~ -\end_inset -style +\change_deleted 564990737 1669742044 + +\family sans +Date \family default - behaves a bit differently for this class. - The possible choices and what they do are as follows: +: [required]. + Suggested format is +\family typewriter +Received: ; Accepted \end_layout -\begin_deeper -\begin_layout Description +\begin_layout Standard -\family sans -plain +\change_deleted 564990737 1669742044 +There is no need to issue the +\family typewriter + +\backslash +maketitle \family default - The final output contains page numbers in the lower right corner. + command, this is done automatically by \SpecialChar LyX + when the header is finished. + Although the order of the single header entries doesn't matter it is advised + to keep the above sequence, just to get the best optics and meets the layout + of the real document. \end_layout -\begin_layout Description +\begin_layout Standard + +\change_deleted 564990737 1669742044 +If you want to place footnotes in the header block, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset +to state your present address, just use the standard footnote via the menu + \family sans -headings +Insert\SpecialChar menuseparator +Footnote. + \family default - Like -\family sans -plain + \SpecialChar LyX + will automagically use the term +\family typewriter + +\backslash +thanks{} \family default -, but also prints out any time markers you've put in. - This is the default. + in that case. \end_layout -\begin_layout Description +\begin_layout Standard +\change_deleted 564990737 1669742044 +Under \family sans -empty +Edit\SpecialChar menuseparator +Text Style \family default - The final output contains no page numbers, time markers, or alignment markers. +, you'll find two insets which are relevant for the titling: \end_layout -\end_deeper \begin_layout Itemize -The -\family sans -slides -\family default - class has an extra option: -\family typewriter -clock -\family default -. - To use it, put -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +\family sans +Institute \family typewriter -clock + +\family default +to mark corresponding author\SpecialChar breakableslash +institute pairs. + The institutes are numbered sequentially as they appear in the +\family sans +Address \family default + field, so you have to put a marker to each author. +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - in the extra class options. -\end_layout +\change_deleted 564990737 1669742044 -\begin_deeper -\begin_layout Standard -Using this options allows you to add time markers to \family sans -Note +Email \family default -s. - See section -\begin_inset space ~ -\end_inset + to supply an email address for fast contact. +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669742044 +In addition to these topics, the macros use one additional \SpecialChar LaTeX + command that + has no counterpart in \SpecialChar LyX +: +\end_layout +\begin_layout Itemize -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:slideNote" +\change_deleted 564990737 1669742044 -\end_inset +\family typewriter - for more details. +\backslash +and +\family default + to separate different names for more than one author and institute, respectivel +y. \end_layout -\end_deeper \begin_layout Standard -You can also use the template file -\begin_inset Quotes eld -\end_inset - -\family typewriter -slides.lyx -\family default +\change_deleted 564990737 1669742044 +The appropriate command has to be entered in \SpecialChar LyX + and marked as \SpecialChar LaTeX + code. + See the examples. + +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Subsection - to automatically set up a document to use the -\family sans -slides -\family default - class [using -\family sans -File\SpecialChar menuseparator -New -\begin_inset space ~ -\end_inset +\change_deleted 564990737 1669742044 +The abstract +\end_layout -from -\begin_inset space ~ -\end_inset +\begin_layout Standard -Template +\change_deleted 564990737 1669742044 +The abstract should immediately follow the header block. + With version 5 the abstract environment was changed to a command, and there + is now a restriction to only one paragraph. + In addition, it should contain an entry with the keywords. + This is done via the paragraph style +\family sans +Keywords \family default - to open your new document]. - The template file also contains some examples of the special paragraph - environments used by this class. - I'll describe those next. +. + Refer to the example paper. \end_layout \begin_layout Subsection -Paragraph Environments -\end_layout -\begin_layout Subsubsection -Supported Environments +\change_deleted 564990737 1669742044 +Supported environments \end_layout \begin_layout Standard -The first thing you'll notice when you start up a new -\family sans -slides -\family default - document is the font size and type: it's the equivalent of the size -\begin_inset Quotes eld -\end_inset +\change_deleted 564990737 1669742044 +The A&A paper layout supports the following environments for structuring + your text: +\end_layout -\family sans -Largest -\family default +\begin_layout Itemize -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669742044 - in the \family sans -Sans -\begin_inset space ~ -\end_inset +Standard +\end_layout -Serif -\family default - font. - This is also what's used in the output. - Think of this as a -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -visual cue -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669742044 - to remind you that this is a slide. - Your final slides will use a larger font; ergo, you'll have less space. - Of course, the larger default screen font isn't WYSIWYG, only a reminder. +\family sans +Section \end_layout -\begin_layout Standard -The next thing that becomes obvious is the changes to the paragraph environment - pull-down box [at the far-left end of the toolbar]. - Most of the paragraph environments you're used to seeing are missing. - There are also five new ones. - That's because the +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + \family sans -slides -\family default - class itself only supports certain paragraph environments: +Subsection \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -Standard +Subsubsection \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans Itemize \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans Enumerate \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans Description \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -List +Caption \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -Quotation +Abstract \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -Quote +Acknowledgment \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -Verse +Bibliography \end_layout \begin_layout Itemize +\change_deleted 564990737 1669742044 + \family sans -Caption +\SpecialChar LaTeX + +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +Commands not supported by \SpecialChar LyX + +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669742044 +Some commands are not yet supported by the +\family sans +paper (A&A) +\family default + layout for \SpecialChar LyX +. + Some have already been mentioned. + For the sake of completeness, they are listed all together here: +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + +\family typewriter + +\backslash +and +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + +\family typewriter + +\backslash +authorrunning +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + +\family typewriter + +\backslash +object{} \end_layout \begin_layout Itemize -\family sans -\SpecialChar LyX --Code +\change_deleted 564990737 1669742044 + +\family typewriter + +\backslash +titlerunning{} +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669742044 +If you want to use any of these commands, you have to enter them yourself. + +\series bold +Do not forget to mark them as \SpecialChar LaTeX + code! +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +Figure and Table Floats +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669742044 +\SpecialChar LyX + provides support for the necessary float environments +\family sans +figure, figure*, table +\family default + and +\family sans +table* +\family default +, therefore we won't tell much about it here. + Refer to the +\emph on +User's +\begin_inset space ~ +\end_inset + +Guide +\emph default +. + Just remember that tables should be left-aligned. + For that, select the table and change the alignment in +\family sans +Edit\SpecialChar menuseparator +Paragraph +\begin_inset space ~ +\end_inset + +Settings. \end_layout \begin_layout Standard -All of the other standard environments, including the section-heading environmen -ts, aren't used in the -\family sans -slides -\family default - class. -\end_layout -\begin_layout Standard -On the other hand, you'll notice the following new environments: +\change_deleted 564990737 1669742044 +There is only one special thing: the figures with caption besides the figure. + To create such a figure, you have to do the following: \end_layout -\begin_layout Itemize +\begin_layout Enumerate +\change_deleted 564990737 1669742044 +Create a wide figure float: \family sans -Slide +Insert\SpecialChar menuseparator +Float\SpecialChar menuseparator +Figure +\family default +, then right click in the figure and select +\family sans +Span +\begin_inset space ~ +\end_inset + +columns +\family default +. \end_layout -\begin_layout Itemize +\begin_layout Enumerate -\family sans -Overlay +\change_deleted 564990737 1669742044 +Enter your caption text. \end_layout -\begin_layout Itemize +\begin_layout Enumerate +\change_deleted 564990737 1669742044 +Press \family sans -Note +Return +\family default + to move the cursor above the caption. \end_layout -\begin_layout Itemize +\begin_layout Enumerate -\family sans -InvisibleText +\change_deleted 564990737 1669742044 +Insert your figure \end_layout -\begin_layout Itemize +\begin_layout Enumerate +\change_deleted 564990737 1669742044 +Position the cursor behind the figure and insert a horizontal fill: \family sans -VisibleText -\end_layout - -\begin_layout Standard -These five are kind of quirky, due to a -\begin_inset Quotes eld +Insert\SpecialChar menuseparator +Special +\begin_inset space ~ \end_inset -feature -\begin_inset Quotes erd +Character\SpecialChar menuseparator +Horizontal +\begin_inset space ~ \end_inset - in \SpecialChar LyX +Fill +\family default . - 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 - -\SpecialChar LaTeX - magic. -\begin_inset Quotes erd -\end_inset - - \end_layout -\begin_layout Subsubsection -Quirks of the New Environments -\begin_inset CommandInset label -LatexCommand label -name "sec:slideQuirk" +\begin_layout Enumerate +\change_deleted 564990737 1669742044 +Switch to \SpecialChar LaTeX + mode: +\family sans +M-c +\begin_inset space ~ \end_inset - -\end_layout - -\begin_layout Standard -All five of the new paragraph environments are somewhat quirky due to inherent - 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 +t \family default - environment isn't a paragraph environment as described in the -\emph on -User's Guide -\emph default . - \end_layout -\begin_layout Standard -You should consider -\family sans -Slide -\family default -, -\family sans -Overlay -\family default -, and -\family sans -Note -\family default - to be -\begin_inset Quotes eld -\end_inset +\begin_layout Enumerate -pseudo-environments. -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669742044 +Enter +\family typewriter - They look like a section heading or a -\begin_inset Quotes eld -\end_inset +\backslash +parbox[b]{55mm}{ +\family default +. + +\series bold +Do not close the brace! +\end_layout +\begin_layout Enumerate +\change_deleted 564990737 1669742044 +Position the cursor behind the caption text, switch to \SpecialChar LaTeX + mode and insert + the closing brace: \family sans -Caption -\family default -, -\begin_inset Quotes erd +M-c +\begin_inset space ~ \end_inset - but really begin a [and, if necessary, end the previous] paragraph environment. - Likewise, treat -\family sans -InvisibleText +t \family default - and -\family sans -VisibleText + +\family typewriter +} \family default - as -\begin_inset Quotes eld -\end_inset +. +\end_layout -pseudo-commands. -\begin_inset Quotes erd -\end_inset +\begin_layout Standard - These two perform some action. +\change_deleted 564990737 1669742044 +Also, refer to the figures in the example paper. +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +Referee layout \end_layout \begin_layout Standard -A common feature of all five environments, -\family sans -Slide -\family default -, -\family sans -Overlay -\family default -, -\family sans -Note -\family default -, -\family sans -InvisibleText -\family default - and -\family sans -VisibleText -\family default -, is a rather long-ish label. - The text following this label — ordinarily the contents of the paragraph - environment — is utterly irrelevant for -\family sans -Slide -\family default -, -\family sans -Overlay + +\change_deleted 564990737 1669742044 +For submission, the paper has to be formated in a special double-spacing + layout. + For this purpose, you have to give the option +\family typewriter +referee \family default -, + to the document class. + This must be done using the custom class options field in the \family sans -Note +Document\SpecialChar menuseparator +Settings \family default -, -\family sans -InvisibleText + dialog. + Just enter the string +\family typewriter +referee \family default - and + there. +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +The example paper +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669742044 +The \family sans -VisibleText +Examples \family default + directory contains an example paper written with \SpecialChar LyX . + It is the example paper from the original macro package, translated to \SpecialChar LyX - completely ignores it. - In fact, you can leave these five environments completely empty. - +. + Use it for inspiration, and compare the original \SpecialChar LaTeX + code with \SpecialChar LyX + way of writing. +\end_layout + +\begin_layout Section +Dinbrief \end_layout \begin_layout Standard -While you don't -\emph on -have -\emph default - to put any text after the rather long-ish label, you might want to. - This could be a short description of the contents of the +The document class \family sans -Slide +dinbrief \family default -, for example. - In that case, enter your descriptive comment and hit -\family sans -Return + can be used to type letters according to German conventions. + A template file is included in +\family typewriter +.../lyx/share/templates \family default - as you normally would. + for you to use as a starting point. +\end_layout + +\begin_layout Section +Elsevier Journals \end_layout \begin_layout Standard -If, on the other hand, you don't want to enter any descriptive text, you'll - 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: +See the \SpecialChar LyX + template file +\family typewriter +elsarticle.lyx +\family default +. + It contains all infos you need. \end_layout -\begin_layout Itemize -Start entering the text that will +\begin_layout Section + +\change_deleted 564990737 1669755802 +ijmpc and ijmpd +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669755802 +by +\noun on +Panayotis Papasotiriou +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669755802 +Overview +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669755802 +The ijmpc package is a set of macros that facilitates electronic manuscript + submission to the \emph on -follow +International Journal of Modern Physics C \emph default - the new -\family sans -Slide -\family default -, -\family sans -Overlay -\family default -, -\family sans -Note -\family default -, -\family sans -InvisibleText +. + Similarly, the ijmpd package is for creating manuscripts to be submitted + to the +\emph on +International Journal of Modern Physics D +\emph default +. + Both journals are published by World Scientific. + The corresponding document classes are named +\family typewriter +ws-ijmpc.cls \family default - or -\family sans -VisibleText + and +\family typewriter +ws-ijmpd.cls \family default -. - +, respectively. + These files, together with instructions for the authors, can be downloaded + from the sites +\begin_inset Flex URL +status collapsed + +\begin_layout Plain Layout + +http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml \end_layout -\begin_layout Itemize -Now move to the beginning of that paragraph. - +\end_inset + + and +\begin_inset Flex URL +status collapsed + +\begin_layout Plain Layout + +http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml \end_layout -\begin_layout Itemize -Next, hit -\family sans -Return -\family default +\end_inset + . - + Both packages are modified versions of the standard +\begin_inset Quotes eld +\end_inset + +article +\begin_inset Quotes erd +\end_inset + + package, and they are almost (but not exactly) identical. + Most of their features are supported by \SpecialChar LyX +. + I have used \SpecialChar LyX + successfully to write articles submitted to both journals + without any problem. \end_layout -\begin_layout Itemize -Finally, change this new, empty paragraph to a -\family sans -Slide -\family default -, +\begin_layout Subsection + +\change_deleted 564990737 1669755802 +Writing a paper +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669755802 +As usual, the easiest way to write a paper is to start with a template. + Click on \family sans -Overlay +File\SpecialChar menuseparator +New from \family default -, + \family sans -Note +Template \family default -, -\family sans -InvisibleText +, then choose the +\family typewriter +ijmpc.lyx \family default or -\family sans -VisibleText +\family typewriter +ijmpd.lyx \family default -. - + template. + This will give an (almost) empty document that includes the most common + fields found in a manuscript. + Simply overwrite the existing text (including the brackets, +\family typewriter +<> +\family default +) with your text. + You should keep in mind the following remarks. \end_layout -\begin_layout Standard -Some future version of \SpecialChar LyX - will, hopefully, resolve this quirkiness\SpecialChar ldots +\begin_layout Enumerate +\change_deleted 564990737 1669755802 +\SpecialChar LyX + won't let you change the font size and the page style of the document, + because such modifications are not allowed by both packages. \end_layout -\begin_layout Subsection -Making a Presentation with -\family sans -Slide -\family default -, -\family sans -Overlay -\family default - and -\family sans -Note -\end_layout +\begin_layout Enumerate -\begin_layout Subsubsection -Using the +\change_deleted 564990737 1669755802 +The language of the document should not be changed. + Before previewing your paper, be sure that the babel package is not used. + To do this, click on +\begin_inset Info +type "menu" +arg "dialog-show document" +\end_inset + + \family sans -Slide +\SpecialChar menuseparator +Language \family default - Environment -\end_layout +, and select +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -If you're expecting this section to teach you how to actually make a presentatio -n, you'll be sorely disappointed. - Naturally, I'll describe all of the ways the +None +\begin_inset Quotes erd +\end_inset + + as \family sans -slides +Language Package \family default - class can assist you in preparing the materials for a presentation. - Filling in the contents, however, is up to you. - [Then again, that -\emph on -is -\emph default - the \SpecialChar LyX - philosophy.] +. \end_layout -\begin_layout Standard -Choosing the -\family sans -Slide -\family default - environment [in the manner described in section -\begin_inset space ~ +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +The +\begin_inset Quotes eld \end_inset +Keywords +\begin_inset Quotes erd +\end_inset -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:slideQuirk" + style must be used to define keywords. +\end_layout + +\begin_layout Enumerate +\change_deleted 564990737 1669755802 +The ijmpc package provides a style named +\begin_inset Quotes eld \end_inset -] tells \SpecialChar LyX - to begin a new slide [duh]. - The label for this environment/ +Classification Codes \begin_inset Quotes erd \end_inset -pseudo-command +, which can be used to define classification codes, such as PACS numbers. + Note that this facility is not supported by the ijmpd package. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +Several new environments are available: +\begin_inset Quotes eld +\end_inset + +Definition \begin_inset Quotes erd \end_inset - is an +, \begin_inset Quotes eld \end_inset -ASCII line, +Step \begin_inset Quotes erd \end_inset - in cool blue, followed by the label, +, \begin_inset Quotes eld \end_inset -NewSlide: +Example \begin_inset Quotes erd \end_inset -. - Any text or paragraph environments that follow this one go on the new slide. - It's that simple. -\end_layout - -\begin_layout Standard -Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX +, +\begin_inset Quotes eld +\end_inset - (this can be specified in the -\family sans -Paragraph Layout -\family default - dialog). - In fact, you'll want to, once you finish entering the contents of one slide. - If you've entered more text than can physically fit on a slide, the extra - overflows onto a new slide. - I don't recommend doing this, however, since the overflow slide won't have - any page number on it. - Furthermore, it may interfere with any -\family sans -Overlay -\family default - you've made to accompany the oversized -\family sans -Slide -\family default -. -\end_layout +Remark +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -The -\family sans -Overlay -\family default - and -\family sans -Note -\family default - environments work the same way as the -\family sans -Slide -\family default - environment. - They both create an +, \begin_inset Quotes eld \end_inset -ASCII line +Notation \begin_inset Quotes erd \end_inset - followed by a label [ +, \begin_inset Quotes eld \end_inset -NewOverlay: +Theorem \begin_inset Quotes erd \end_inset - and +, \begin_inset Quotes eld \end_inset -NewNote: +Proof \begin_inset Quotes erd \end_inset -, respectively]. - The color is a stunning magenta instead of blue, and the +, \begin_inset Quotes eld \end_inset -ASCII line +Corollary \begin_inset Quotes erd \end_inset - will look different, in style and in length. - The label fonts of all three also differ from one another. -\end_layout +, +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -As with a -\family sans -Slide -\family default -, if the contents of a -\family sans -Note -\family default - or -\family sans -Overlay -\family default - exceed the physical size of a slide or sheet of paper, the extra will overflow - onto a new sheet. - Again, you should avoid this. - It defeats the whole purpose of -\family sans -Note -\family default -s and -\family sans -Overlay -\family default -s. -\end_layout +Lemma +\begin_inset Quotes erd +\end_inset -\begin_layout Subsubsection -Using -\family sans -Overlay -\family default - with -\family sans -Slide -\end_layout +, +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -The idea behind an -\family sans -Overlay -\family default - is a slide that sits atop another slide. - Perhaps you wish to discuss a figure on the main -\family sans -Slide -\family default - before displaying the text associated with it. - One way to accomplish this is tape a flap of dark paper over the part of - the -\family sans -Slide -\family default - you want to display later. - This method fails, however, if you wish to overlap one graph with another, - for example. - You would then have to fumble while speaking to align the two separate, - overlapping -\family sans -Slide -\family default -s to align the two graphs. - The use of an -\family sans -Overlay -\family default - environment in both cases makes life much easier. -\end_layout +Proposition +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Each -\family sans -Overlay -\family default - receives the page number of its +, \begin_inset Quotes eld \end_inset -parent +Prop \begin_inset Quotes erd \end_inset - -\family sans -Slide -\family default -, appended by +, \begin_inset Quotes eld \end_inset +Question +\begin_inset Quotes erd +\end_inset -\family typewriter --a -\family default +, +\begin_inset Quotes eld +\end_inset +Claim \begin_inset Quotes erd \end_inset -. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -Presumably, mutliple -\family sans -Overlay -\family default -s would have +, and \begin_inset Quotes eld \end_inset +Conjecture +\begin_inset Quotes erd +\end_inset + +. + Their use is more or less obvious. + \SpecialChar LyX + supports all these environments; it will use the proper label, text style, + and numbering scheme for each of them. +\end_layout + +\begin_layout Enumerate +\change_deleted 564990737 1669755802 +Both packages use basic citations; the natbib package should not be used. + In \SpecialChar LyX +, citation references are shown as usual; in the output, citations are + shown as superscripts. + If you want to use a citation as normal text, you should use the \family typewriter --a +refcite \family default - -\begin_inset Quotes erd + command, e. +\begin_inset space \thinspace{} \end_inset -, -\begin_inset Quotes eld +g. +\begin_inset space \space{} \end_inset -\family typewriter --b -\family default - -\begin_inset Quotes erd +\begin_inset Quotes eld \end_inset -, -\begin_inset Quotes eld +See Ref. +\begin_inset space \space{} \end_inset \family typewriter --c + +\backslash +refcite{key} \family default \begin_inset Quotes erd \end_inset -, etc. -\begin_inset space ~ -\end_inset - -appended to the page number of the parent -\family sans -Slide -\family default . - \end_layout +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +There is no +\begin_inset Quotes eld \end_inset - Clearly, you want the contents of both the -\family sans -Slide -\family default - and the -\family sans -Overlay -\family default - to each fit on a single physical slide! You should probably consider an - -\family sans -Overlay -\family default - as +Acknowledgments +\begin_inset Quotes erd +\end_inset + + section in both packages. + To put acknowledgments, just use the \begin_inset Quotes eld \end_inset -part of +Section* \begin_inset Quotes erd \end_inset - a -\family sans -Slide -\family default -. - Indeed, the \SpecialChar LyX - -\family sans -slides -\family default - class provides a visual cue for this: the label at the start of an -\family sans -Overlay -\family default - is shorter than that at the start of a -\family sans -Slide -\family default -. - Lastly, when you generate printable output, you'll find alignment markers - in all four corners of both the -\family sans -Overlay -\family default - page and its parent -\family sans -Slide -\family default -. - These will assist you in lining up the two physical slides. + environment. \end_layout -\begin_layout Standard -The major problem in overlaying two slides is aligning the contents of the - two transparencies. - How much space should you leave for that graph on the second slide? Worse - still, what if you want a graph and a sentence on second slide, but there - is text on the main transparency that goes in between them? You could try - and insert vertical space of the right size. - The better way is to use -\family sans -InvisibleText -\family default - and -\family sans -VisibleText -\family default -. -\end_layout +\begin_layout Enumerate -\begin_layout Standard -As their names imply, -\family sans -InvisibleText -\family default - and -\family sans -VisibleText -\family default - are two command-like paragraph environments that make all subsequent text - invisible and visible, respectively. - Note from section -\begin_inset space ~ +\change_deleted 564990737 1669755802 +Appendices may be added to the paper, +\emph on +after +\emph default + the Acknowledgments and +\shape italic +before +\shape default + the References. + \SpecialChar LyX + provides a special environment, called +\begin_inset Quotes eld \end_inset +Appendices Section +\begin_inset Quotes erd +\end_inset -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:slideQuirk" + which marks the beginning of the appendices. + This environment should be left blank; it just sends a \SpecialChar LaTeX + command, but nothing + is really printed. + In \SpecialChar LyX +, the word +\begin_inset Quotes eld +\end_inset +Appendix +\begin_inset Quotes erd \end_inset - that you don't place anything -\emph on -into -\emph default - these two environments, however. - When you create an -\family sans -InvisibleText -\family default -, it inserts a centered, sky-blue label into the page reading + is printed with blue letters, as a signal that all sections after that + point are appendices. + To write an appendix, use the \begin_inset Quotes eld \end_inset - +Appendix \begin_inset Quotes erd \end_inset -. - For paragraphs following this label, the parts of the -\family sans -Slide -\family default - [or -\family sans -Overlay -\family default -; it doesn't matter which] where they would be contain instead blank space. - -\end_layout - -\begin_layout Standard -For -\family sans -VisibleText -\family default -, the corresponding centered label is + environment. + \SpecialChar LyX + will number each appendix with capital letters, as required by both journals. + Note that \begin_inset Quotes eld \end_inset - +Appendices Section \begin_inset Quotes erd \end_inset - in blazing green. - Paragraphs following this label behave normally. - Note that the beginning of a new -\family sans -Slide -\family default -, -\family sans -Overlay -\family default -, or -\family sans -Note -\family default - automatically shuts off an -\family sans -InvisibleText + +\emph on +must +\emph default + be present before the first appendix; if not, all appendices will be numbered + as normal sections in the output. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +The ijmpc and the ijmpd packages use the +\family typewriter +tbl \family default -. - It's therefore not necessary to use -\family sans -VisibleText + command to implement table captions. + As a result, a table created by \SpecialChar LyX + is printed correctly, but its caption + is ignored. + However, you can use some \SpecialChar TeX + code to overcome this problem, so that captions + are printed as expected. + To do so, create a float table as usual, remove the caption, and replace + it with the \SpecialChar TeX + code +\family typewriter + +\backslash +tbl{ +\emph on +your table caption +\emph default +}{ \family default - at the end of a -\family sans -Slide + (sic); you must also the \SpecialChar TeX + code +\family typewriter +} \family default -. -\end_layout - -\begin_layout Standard -By now, it should be obvious how to create overlay transparencies using - the proper combination of -\family sans -InvisibleText + immediately after the tabular material. + Study the example table included in the template files to see how this + trick is implemented. + Alternatively, If you need table captions, you should implement the whole + table float in a +\family typewriter +.tex \family default - and + file, then include this file to the \SpecialChar LyX + document ( \family sans -VisibleText +Insert\SpecialChar menuseparator +File\SpecialChar menuseparator +Child +\begin_inset space ~ +\end_inset + +Document \family default - on a -\family sans -Slide +). + Details on how to create a table float can be found in the files +\family typewriter +ws-ijmpc.tex \family default and -\family sans -Overlay +\family typewriter +ws-ijmpd.tex \family default -: +, included in the corresponding packages. \end_layout -\begin_layout Enumerate -Create a -\family sans -Slide -\family default -, including everything that will appear on it, whether on the main slide - or on the -\family sans -Overlay -\family default -. +\begin_layout Subsection + +\change_deleted 564990737 1669755802 +Preparing a paper for submission \end_layout -\begin_layout Enumerate -Before each figure or paragraph that will appear only on the -\family sans -Overlay -\family default -, insert an -\family sans -InvisibleText -\family default - environment. - If necessary, insert a -\family sans -VisibleText -\family default - environment after the +\begin_layout Standard + +\change_deleted 564990737 1669755802 +Before you submit your paper you must export the \SpecialChar LyX + document as a \SpecialChar LaTeX + file ( \family sans -Overlay +File\SpecialChar menuseparator +Export\SpecialChar menuseparator +\SpecialChar LaTeX + \family default --only text. +) +\begin_inset Foot +status open + +\begin_layout Plain Layout +Actually you have the choice between \SpecialChar LaTeX + (plain) and pdflatex. + If you intend to use pdflatex to prepare the paper, you should use the + pdflatex option so that included graphics are converted to PDF format, + ready for use by pdflatex. \end_layout -\begin_layout Enumerate -Start an -\family sans -Overlay -\family default - immediately following the -\family sans -Slide +\end_inset + +, then make the following changes to the resulting +\family typewriter +.tex \family default -. + file. \end_layout \begin_layout Enumerate -Copy the contents of this -\family sans -Slide -\family default - into the -\family sans -Overlay + +\change_deleted 564990737 1669755802 +Remove the comment lines before the +\family typewriter + +\backslash +documentclass \family default -. + command. \end_layout \begin_layout Enumerate -Within the -\family sans -Overlay -\family default -, change all of the -\family sans -InvisibleText + +\change_deleted 564990737 1669755802 +Remove everything between (and including) the +\family typewriter + +\backslash +makeatletter \family default - lines to -\family sans -VisibleText + and +\family typewriter + +\backslash +makeatother \family default - and vice-versa. + commands, except for any commands you specifically put into the \SpecialChar LaTeX + preamble. \end_layout \begin_layout Standard -That's it. - You've just made an -\family sans -Overlay + +\change_deleted 564990737 1669755802 +The modified +\family typewriter +.tex \family default -. + file should be saved and processed through \SpecialChar LaTeX + as many times as necessary. + You may also want to check the resulting +\family typewriter +.dvi +\family default + document. +\change_unchanged + \end_layout -\begin_layout Standard -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 \SpecialChar LaTeX - codes. -\begin_inset Foot -status collapsed +\begin_layout Section -\begin_layout Plain Layout -The commands of interest are: +\change_deleted 564990737 1669801478 +iopart \end_layout -\begin_layout Itemize +\begin_layout Standard -\family typewriter -{ -\backslash -invisible \SpecialChar ldots - } +\change_deleted 564990737 1669801478 +by +\noun on +Uwe Stöhr \end_layout -\begin_layout Itemize +\begin_layout Subsection -\family typewriter -{ -\backslash -visible \SpecialChar ldots - } +\change_deleted 564990737 1669801478 +Overview \end_layout +\begin_layout Standard + +\change_deleted 564990737 1669801478 +The iopart package provides a document class to create electronic manuscript + submission to the journals published by the Institute of Physics. + Instructions for the authors how to create a paper using the iopart class + can be downloaded together with the iopart package from the site +\begin_inset Flex URL +status collapsed + \begin_layout Plain Layout -\SpecialChar ldots -and need to be marked as \SpecialChar TeX -. - The text whose -\begin_inset Quotes eld -\end_inset -visibility -\begin_inset Quotes erd +ftp://ftp.iop.org/pub/journals/latex2e +\end_layout + \end_inset - you wish to change goes in between the brackets [and after the -\family typewriter +. +\end_layout -\backslash -invisible +\begin_layout Subsection + +\change_deleted 564990737 1669801478 +Writing a paper +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669801478 +The easiest way to write a paper is to start with the template +\emph on +IOP-article.lyx +\emph default + that is available via +\family sans +File\SpecialChar menuseparator +New From Template \family default - or -\family typewriter + The template explains how to use the special text environments. + Here are the most important advices: +\end_layout -\backslash -visible +\begin_layout Itemize + +\change_deleted 564990737 1669801478 +To be able to compile your document to a PDF, PS, or DVI, ensure that the + no AMS packages are loaded in +\family sans +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Math Options \family default - command]. - 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 -. +! \end_layout -\end_inset +\begin_layout Itemize +\change_deleted 564990737 1669801478 +\size normal +The title environment defines the kind of your paper. + So use one of the following environments for the title: \end_layout -\begin_layout Subsubsection -Using +\begin_deeper +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Note +\size normal +Title \family default - with + for a Paper +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Slide +\size normal +Review \family default + for a Review +\end_layout -\begin_inset CommandInset label -LatexCommand label -name "sec:slideNote" - -\end_inset +\begin_layout Itemize +\change_deleted 564990737 1669801478 +\family sans +\size normal +Topical +\family default + for a Topical review \end_layout -\begin_layout Standard -Like an +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Overlay +\size normal +Comment \family default -, a + for a Comment +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans +\size normal Note \family default - is associated with a -\begin_inset Quotes eld -\end_inset + for a Note +\end_layout -parent -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize + +\change_deleted 564990737 1669801478 - -\family sans -Slide -\family default -. - Here, too, the \SpecialChar LyX - -\family sans -slides -\family default - class provides visual cues. - The label for a \family sans -Note +\size normal +Paper \family default - is shorter than that of a + for a Paper (same as Title) +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Slide +\size normal +Prelim \family default - [yet longer than that of an + for a Preliminary communication +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Overlay +\size normal +Rapid \family default -] and, like the label of an + for a Rapid communication +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + \family sans -Overlay +\size normal +Letter \family default - is shockingly magenta. - Additionally, the printed + for a Letter to the editor +\end_layout + +\end_deeper +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + +\size normal +All title environments except of \family sans -Note +Letter \family default - has the page number of its -\begin_inset Quotes eld -\end_inset + can have an optional short title. +\end_layout -parent -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - +\change_deleted 564990737 1669801478 +There is a general title environment \family sans -Slide +Article \family default -, appended by -\begin_inset Quotes eld -\end_inset + which is not directly supported by \SpecialChar LyX +. + This can be used as \SpecialChar TeX + code when your document doesn't fit into one of the + other title types. +\end_layout +\begin_layout Standard -\family typewriter -- -\family default -1 -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669801478 +For more informations like hints for special table and formula formatting, + look at the IOP author guidelines. +\change_unchanged -, -\begin_inset Quotes eld -\end_inset +\end_layout +\begin_layout Section -\family typewriter -- -\family default -2 -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1670317155 +Kluwer +\end_layout -, -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +\change_deleted 564990737 1670317155 +by +\noun on +Panayotis Papasotiriou +\end_layout -\family typewriter -- -\family default -3 -\begin_inset Quotes erd -\end_inset +\begin_layout Subsection -, etc. - You can have multiple -\family sans -Note -\family default -s associated with a single -\family sans -Slide -\family default -, and, as with -\family sans -Slide -\family default +\change_deleted 564990737 1670317155 +Overview +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1670317155 +The Kluwer package is a set of macros produced by Kluwer Academic Publishers + that facilitates electronic manuscript submission to the journals they + publish. + Most known of them (at least in my domain of interest) are +\emph on +Astrophysics and Space Science +\emph default and -\family sans -Overlay -\family default -, you'll probably want to break up long -\family sans -Note -\family default -s so that they fit on a single sheet of paper. +\emph on +Solar Physics +\emph default +, but there are many others (see a complete list at +\begin_inset Flex URL +status collapsed + +\begin_layout Plain Layout + +http://www.wkap.nl/jrnllist.htm/JRNLHOME \end_layout -\begin_layout Standard -The purpose of a -\family sans -Note -\family default - is obvious: it contains anything additional you might want to say about - a -\family sans -Slide -\family default -. - It could also be used as a sheet of reminders for a particular -\family sans -Slide -\family default -. - In the case of the latter, you might want to make use of time markers. - Currently, the \SpecialChar LyX - -\family sans -slides -\family default - class has no -\begin_inset Quotes eld \end_inset -native -\begin_inset Quotes erd -\end_inset +). + The Kluwer package may be downloaded from the site +\begin_inset Flex URL +status collapsed - support for time markers, a -\noun on -Sli\SpecialChar TeX +\begin_layout Plain Layout -\noun default - feature. - So, you'll have to resort to using the \SpecialChar LaTeX - codes. +http://www.wkap.nl/kaphtml.htm/STYLEFILES \end_layout -\begin_layout Standard -To use time markers, you'll need to specify the extra class option -\begin_inset Quotes eld \end_inset +. + A complete user guide is contained in that package (but it can also be + downloaded separately). +\end_layout + +\begin_layout Standard -\family typewriter -clock -\family default +\change_deleted 564990737 1670317155 +\SpecialChar LyX + supports many features of the package but not everything. + However, the \SpecialChar TeX + code needed is reduced to some +\begin_inset Quotes eld +\end_inset +peculiar \begin_inset Quotes erd \end_inset - [see section + commands of the package (see \begin_inset space ~ \end_inset \begin_inset CommandInset ref LatexCommand ref -reference "sec:slidesetup" +reference "subsec:kluwer_peculiarities" \end_inset -]. - This option turns on timing marks, which will appear in the lower-left-hand - corner of every -\family sans -Note -\family default - you generate. - To set what appears in the time marker, you use the \SpecialChar LaTeX - commands -\begin_inset Quotes eld -\end_inset +). + I have recently used \SpecialChar LyX + to write an article submitted to the +\emph on +Astrophysics and Space Science +\emph default + without any problem. +\end_layout +\begin_layout Subsection -\family typewriter +\change_deleted 564990737 1670317155 +Writing a paper +\end_layout -\backslash -settime{} +\begin_layout Standard + +\change_deleted 564990737 1670317155 +The easiest way to write a paper is to start with the Kluwer template file. + Click on +\family sans +File\SpecialChar menuseparator +New from +\family default + +\family sans +Template +\family default +, then choose the +\family typewriter +kluwer.lyx +\family default + template. + This will give an (almost) empty document that includes the most common + fields found in a manuscript and a short description of their use. + As in most templates, simply overwrite the existing text (including the + brackets, +\family typewriter +<> \family default +) with the correct information. +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Subsection - and +\change_deleted 564990737 1670317155 +Preparing a paper for submission +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1670317155 +As in the AAS\SpecialChar TeX + package, before you submit your paper to a journal you must + \begin_inset Quotes eld \end_inset +postprocess +\begin_inset Quotes erd +\end_inset -\family typewriter + it as follows. +\end_layout -\backslash -addtime{} -\family default +\begin_layout Enumerate -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1670317155 +Export your paper as a \SpecialChar LaTeX + file. + To do this, click on +\family sans +File\SpecialChar menuseparator +Export\SpecialChar menuseparator +\SpecialChar LaTeX +\family default . - The arguments of both commands are time measured in seconds. -\begin_inset Quotes eld -\end_inset +\end_layout +\begin_layout Enumerate +\change_deleted 564990737 1670317155 +Edit the resulting \family typewriter - -\backslash -settime{} +.tex \family default + file with a text editor and make the following changes +\end_layout -\begin_inset Quotes erd -\end_inset - - sets the time marker to a given time. - -\begin_inset Quotes eld -\end_inset - +\begin_deeper +\begin_layout Enumerate +\change_deleted 564990737 1670317155 +remove the comment lines before the \family typewriter \backslash -addtime{} +documentclass \family default + command, +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Enumerate - increments the time marker by the specified amount. - Using time markers and -\family sans -Note +\change_deleted 564990737 1670317155 +remove everything between (and including) the +\family typewriter + +\backslash +makeatletter \family default -s in this fashion, you can remind yourself how much time to spend on a particula -r -\family sans -Slide + and +\family typewriter + +\backslash +makeatother \family default -. + commands, except for any commands you specifically put into the \SpecialChar LaTeX + preamble. \end_layout \begin_layout Standard -There's one last feature to describe. - Clearly, you'd like to print out all of your -\family sans -Slide -\family default -s and -\family sans -Overlay + +\change_deleted 564990737 1670317155 +Save the resulting +\family typewriter +.tex \family default -s on transparencies while printing all of your -\family sans -Note + file. +\end_layout + +\end_deeper +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +Run the +\family typewriter +.tex \family default -s on plain paper. - However, a -\family sans -Note + file through \SpecialChar LaTeX + as many times as necessary (usually up to three). +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +View the resulting +\family typewriter +.dvi \family default - -\emph on -must -\emph default - follow the + document using, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + + \family sans -Slide +xdvi \family default - with which it is associated. - What's a person to do? +, and check if everything is OK (it should, if you didn't make any mistake). \end_layout -\begin_layout Standard -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 +\begin_layout Subsection + +\change_deleted 564990737 1670317155 \begin_inset Quotes eld \end_inset +Peculiarities +\begin_inset Quotes erd +\end_inset -\family typewriter - -\backslash -onlyslides{ -\backslash -slides} -\family default + of the Kluwer package +\begin_inset CommandInset label +LatexCommand label +name "subsec:kluwer_peculiarities" -\begin_inset Quotes erd \end_inset - will cause the output to contain only the -\family sans -Slide -\family default -s and -\family sans -Overlay -\family default -s. - Correspondingly, the command + +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1670317155 +The Kluwer package has the following \begin_inset Quotes eld \end_inset +peculiarities +\begin_inset Quotes erd +\end_inset -\family typewriter +. +\end_layout -\backslash -onlynotes{ -\backslash -notes} -\family default +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +It is possible to write multiple articles in the same \SpecialChar LaTeX + file +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +I can't imagine any good reason to do this. +\end_layout -\begin_inset Quotes erd \end_inset - prevents the output of anything but -\family sans -Note -\family default -s. - I'd advise placing both commands in the preamble and initially comment - both out. - You can then preview your entire presentation as you write. - When you're done writing, you can then uncomment one of the two to select - what you want to print. - I like to uncomment +. + Each article must be included in the environment \begin_inset Quotes eld \end_inset +article +\begin_inset Quotes erd +\end_inset +. + Unfortunately, this environment cannot be omitted, even if you write just + one article. + Therefore, each article starts with the command \family typewriter \backslash -onlyslides{ +begin{article} +\family default + and, obviously, ends with the command +\family typewriter + \backslash -slides} +end{article} \family default +. + Although this can be implemented in \SpecialChar LyX +, I didn't included it, since it looks + ugly and can confuse the novice user. + Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX + code (the + well-known +\begin_inset Quotes eld +\end_inset +\SpecialChar TeX + code \begin_inset Quotes erd \end_inset - , print to a file with -\begin_inset Quotes eld -\end_inset +). +\end_layout +\begin_layout Enumerate -\family typewriter --slides -\family default +\change_deleted 564990737 1670317155 +Information given at the beginning of the article (i. +\begin_inset space \thinspace{} +\end_inset -\begin_inset Quotes erd +e. +\begin_inset space \space{} \end_inset - in its name, comment it back out, then uncomment +title, subtitle, author, institution, running title, running author, abstract + and keywords) must be included in an environment called \begin_inset Quotes eld \end_inset +opening +\begin_inset Quotes erd +\end_inset + +. + This is not implemented in \SpecialChar LyX +, so you must enter title, subtitle etc. +\begin_inset space ~ +\end_inset +between two \SpecialChar TeX + code lines ( \family typewriter \backslash -onlynotes{ -\backslash -notes} +begin{opening} \family default + and +\family typewriter -\begin_inset Quotes erd -\end_inset +\backslash +end{opening} +\family default +). +\end_layout - and print to a -\begin_inset Quotes eld -\end_inset +\begin_layout Enumerate +\change_deleted 564990737 1670317155 +According to the user manual, the label of each bibliography item must be + written as +\family typewriter +\backslash +protect +\backslash +citeauthoryear{ +\family default +\emph on +author(s) \family typewriter -*-notes.ps +\emph default +}{ \family default - -\begin_inset Quotes erd -\end_inset - - file. - I can then send either file to a printer, loading transparencies or plain - paper as appropriate. +\emph on +year +\family typewriter +\emph default +} +\family default +. \end_layout \begin_layout Standard -You can also provide other arguments to the -\begin_inset Quotes eld -\end_inset - +\change_deleted 564990737 1670317155 +The \family typewriter - -\backslash -onlyslides{} +kluwer.lyx \family default + template takes care of all these +\begin_inset Quotes eld +\end_inset +peculiarities \begin_inset Quotes erd \end_inset - and -\begin_inset Quotes eld -\end_inset +. + If you start a new paper using this template you don't need to do anything + special. + Just +\end_layout +\begin_layout Enumerate -\family typewriter +\change_deleted 564990737 1670317155 +don't delete the \SpecialChar TeX + code included in the template, and +\end_layout -\backslash -onlynotes{} +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +copy the example bibliography item included in the template and modify it + as necessary to enter new bibliography items. +\end_layout + +\begin_layout Section +Paper +\end_layout + +\begin_layout Standard +The document class +\family sans +paper +\family default + provides an alternative to the standard +\family sans +article \family default + class. + It provides similar functionality, but you might prefer this layout with + sans serif sections, headings, and more. +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Section +Springer Journals ( +\family sans +svjour +\family default +) +\end_layout - commands. - See a good \SpecialChar LaTeX - book for details. +\begin_layout Standard +by +\noun on +Martin Vermeer \end_layout \begin_layout Subsection -The -\family sans -slides -\family default - Class Template File +Description \end_layout \begin_layout Standard -I have also provided a template file, -\begin_inset Quotes eld -\end_inset +These are the layout files for some of the journal formats used by Springer + Verlag and listed on +\begin_inset Flex URL +status collapsed +\begin_layout Plain Layout -\family typewriter -slides.lyx -\family default +http://www.springer.de/author/tex/help-journals.html +\end_layout -\begin_inset Quotes erd \end_inset -, with the -\family sans -slides +, 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 +svjour.inc \family default - class. - To use it, begin your new presentation with -\family sans -File\SpecialChar menuseparator -New -\begin_inset space ~ +, which journal-specific layout files (such as, e. +\begin_inset space \thinspace{} \end_inset -from -\begin_inset space ~ +g. +\begin_inset space \space{} \end_inset -Template + +\family typewriter +svjog.layout \family default -. - Your new \SpecialChar LyX - presentation file will contain an example -\family sans -Slide + for Journal of Geodesy) can include. +\end_layout + +\begin_layout Standard +This means that implementing support for any other Springer journal on this + list is as simple as writing your own +\family typewriter +sv \family default - – -\family sans -Overlay + +\family typewriter +.layout \family default - – -\family sans -Note + file following the outline given in +\family typewriter +svjog.layout \family default - triplet. - The -\family sans -Slide +. + +\end_layout + +\begin_layout Standard +It is reasonably well tested only for the Journal of Geodesy. + +\family typewriter +svjour \family default and -\family sans -Overlay +\family typewriter +svjog \family default - additionally contain an example of the use of + come with the standard \SpecialChar LyX + distribution. + Install the relevant class file (downloaded from Springer) in a proper + directory, reconfigure \SpecialChar LaTeX + (in the te\SpecialChar TeX + case by running +\family typewriter +texhash +\family default +, as root if necessary — doesn't \SpecialChar LyX + take care of this?), reconfigure \SpecialChar LyX + and + it should work. +\end_layout + +\begin_layout Subsection +New styles +\end_layout + +\begin_layout Standard +A large number of theorem-like styles — \family sans -InvisibleText +Claim, Conjecture, \family default - and + \family sans -VisibleText +\SpecialChar ldots +Theorem \family default . - Lastly, the preamble will contain: \end_layout -\begin_layout LyX-Code -% Uncomment to print out only slides and overlays +\begin_layout Standard + +\family sans +Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX +_Title, Author_Running, Institute, + Mail, Offprints, Keywords, Acknowledgements, Acknowledgement +\family default +. + See the Springer class file documentation for details. \end_layout -\begin_layout LyX-Code -% +\begin_layout Subsection +Supported journals \end_layout -\begin_layout LyX-Code -% -\backslash -onlyslides{ -\backslash -slides} -\begin_inset Newline newline -\end_inset +\begin_layout Itemize - +\emph on +Journal of Geodesy +\emph default +: +\family typewriter +svjog.layout +\family default + — Martin Vermeer \end_layout -\begin_layout LyX-Code -% Uncomment to print out only notes +\begin_layout Itemize + +\emph on +Probability Theory and Related Fields +\emph default +: +\family typewriter +svprobth.layout +\family default + — Jean-Marc Lasgouttes \end_layout -\begin_layout LyX-Code -% +\begin_layout Standard +Add your own, it isn't so hard! \end_layout -\begin_layout LyX-Code -% -\backslash -onlynotes{ -\backslash -notes} +\begin_layout Subsection +Credits \end_layout \begin_layout Standard -One final thing: I created this class to support the \SpecialChar LaTeX2e - -\begin_inset Quotes eld -\end_inset - - -\noun on -Sli\SpecialChar TeX - -\noun default - emulation -\begin_inset Quotes erd -\end_inset - - 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 \SpecialChar LaTeX2e - classes for creating presentations, such as the -\family sans -Foils +These files are partly based on the older +\family typewriter +ejour2.layout \family default - class [see section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:foiltex" - -\end_inset - -] or the -\begin_inset Quotes eld -\end_inset - - +, 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 -seminar +ejour2 \family default - -\begin_inset Quotes erd -\end_inset - - 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 - + layout, are now defunct. + Jean-Marc Lasgouttes helped out big in making me find my way around the + \SpecialChar LyX + layout file mechanism. \end_layout -\end_inset +\begin_layout Subsection +Bugs +\end_layout - I know nothing about these other classes. - Try them out to see what sort of alternative they provide. +\begin_layout Standard +Probably. + But probably less than in the old hacked-\SpecialChar LaTeX + +\family typewriter +ejour2 +\family default +. \end_layout \begin_layout Chapter