From: John R Hudson Date: Thu, 8 Dec 2022 18:49:48 +0000 (+0000) Subject: Move KOMA-script section into new Chapter 3: Document classes X-Git-Tag: 2.4-beta2~255 X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=85a1e9a69f8aaec39b306d991c759bf4d61e466e;p=lyx.git Move KOMA-script section into new Chapter 3: Document classes --- diff --git a/lib/doc/Additional.lyx b/lib/doc/Additional.lyx index d35f01c2de..bac565b94e 100644 --- a/lib/doc/Additional.lyx +++ b/lib/doc/Additional.lyx @@ -2867,5511 +2867,5935 @@ In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX They need to be available on your system in order to use these environments. \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439534 -Articles +\begin_layout Subsection +Koma-Script \end_layout \begin_layout Standard - -\change_inserted 564990737 1670439557 -See also the document classes in the Collections (section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Collections" - -\end_inset - -). +by +\noun on +Bernd Rellermeyer \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439560 -Books +\begin_layout Subsubsection +Overview \end_layout \begin_layout Standard - -\change_inserted 564990737 1670439581 -See also the document classes in the Collections (section +The \SpecialChar LyX + document classes +\emph on +article (koma-script) +\emph default +, +\emph on +report (koma-script) +\emph default +, +\emph on +book +\emph default + +\emph on +(koma-script) +\emph default +, and +\emph on +letter +\emph default + +\emph on +(koma-script) +\emph default + correspond to the \SpecialChar LaTeX + document classes +\family typewriter +scrartcl.cls +\family default +, +\family typewriter +scrreprt.cls +\family default +, +\family typewriter +scrbook.cls +\family default +, and +\family typewriter +scrlettr.cls +\family default +, resp. \begin_inset space ~ \end_inset - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Collections" - -\end_inset - -). +of the Koma-Script family. + They are replacements for the standard document classes +\family typewriter +article.cls +\family default +, +\family typewriter +report.cls +\family default +, +\family typewriter +book.cls +\family default + and +\family typewriter +letter.cls +\family default +, resp., and fit better to European typography conventions in a number of + points. \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439605 -Curricula vitarum +\begin_layout Itemize +Standard character size is 11pt in +\emph on +article (koma-script) +\emph default +, +\emph on +report (koma-script) +\emph default +, and +\emph on +book (koma-script) +\emph default +, and 12pt in +\emph on +letter (koma-script) +\emph default +. \end_layout -\begin_layout Section +\begin_layout Itemize +Headings, labels of the description environment, and a number of elements + of the +\emph on +letter (koma-script) +\emph default + document class are set in a bold sans serif font. +\begin_inset Foot +status collapsed -\change_inserted 564990737 1670439627 -Letters -\end_layout +\begin_layout Plain Layout +There is a big difference between the bold sans serif old cm fonts and new + ec fonts, especially in the appearance of headings. + In comparison, the ec bold sans serif fonts look a bit thin. + Here the \SpecialChar LaTeX + package +\family typewriter +cmsd.sty by +\family default + +\shape smallcaps +Walter Schmidt +\shape default + helps to produce the +\begin_inset Quotes eld +\end_inset -\begin_layout Section +usual +\begin_inset Quotes erd +\end_inset -\change_inserted 564990737 1670439660 -Presentations + appearance when using the ec fonts. \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439661 -Reports -\end_layout +\end_inset -\begin_layout Subsection + The numbering of chapter headings is made in the same way as the numbering + of section headings, that is without the extra line +\begin_inset Quotes eld +\end_inset -\change_inserted 564990737 1670439661 -report -\end_layout +Chapter\SpecialChar ldots -\begin_layout Standard +\begin_inset Quotes erd +\end_inset -\change_inserted 564990737 1670439661 -The document class +. + In addition, the appearance of the headings can be modified by using a + number of options (in \SpecialChar LyX + to be entered in the field \family sans -report +Extra +\begin_inset space ~ +\end_inset + +Options \family default - provides the + of the dialog \family sans -report.cls +Layout\SpecialChar menuseparator +Document \family default - document class for preparing reports. - Like the +). + +\end_layout + +\begin_layout Itemize +The main means in the Koma-Script document classes to design the type area + are the options \family sans -book +BCOR \family default - document class, this provides parts, chapters and sections but does not - provide the paragraph styles needed for a book; like the + and \family sans -article +DIV \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 + (in \SpecialChar LyX + to be entered in the extra class options field in the dialog \family sans -report +Document\SpecialChar menuseparator +Settings \family default - document classes are described in the Collections (section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:Collections" - -\end_inset - ). + They make a clearer modification of page margins possible as do the options + of the dialog +\family sans +Document\SpecialChar menuseparator +Settings +\family default +. + \end_layout -\begin_layout Section - -\change_inserted 564990737 1670439674 -Scripts (drama) +\begin_layout Itemize +The \SpecialChar LaTeX + document classes of the Koma-Script family define a number of additional + commands. + Those part of it which makes sense in \SpecialChar LyX + is implemented in corresponding + paragraph types. \end_layout -\begin_layout Chapter -Supplemental Tools +\begin_layout Standard +Detailed descriptions of the \SpecialChar LaTeX + document classes of the Koma-Script family + can be found in the Koma-Script documentation +\emph on +scrguide +\emph default + (German) and +\emph on +scrguien +\emph default + (English). \end_layout -\begin_layout Section -Customizing Bibliographies with Bib\SpecialChar TeX - or Biblatex +\begin_layout Subsubsection +article (koma-script), report (koma-script), and book (koma-script) \end_layout \begin_layout Standard -The most basic information about how to use Bib\SpecialChar TeX - or +The document classes +\emph on +article (koma-script) +\emph default +, +\emph on +report (koma-script) +\emph default +, and +\emph on +book +\emph default + +\emph on +(koma-script) +\emph default + are implemented in the layout files +\family typewriter +scrartcl.layout +\family default +, +\family typewriter +scrreprt.layout +\family default +, and +\family typewriter +scrbook.layout +\family default +, resp. + They contain all the paragraph types of the corresponding standard document + classes +\emph on +article +\emph default +, +\emph on +report +\emph default +, and +\emph on +book +\emph default +, resp., partly modified, with the exception of the \SpecialChar LyX + specific \family sans -Biblatex +List \family default - with \SpecialChar LyX - is contained in the section +-type, which is replaced by the new +\family sans +Labeling +\family default +-type having the same functionality. + Beside the +\family sans +Labeling +\family default +-Type there is a number of new paragraph types added. + They are \emph on -Bibliography databases +not \emph default - of the + part of \emph on -User's Guide +letter (koma-script) \emph default . - The following subsections explain special bibliography features supported - by \SpecialChar LyX -. -\end_layout - -\begin_layout Subsection -Alternative Citation Styles -\end_layout - -\begin_layout Standard -Standard Bib\SpecialChar TeX - uses numbers (e. -\begin_inset space \thinspace{} -\end_inset - -g. -\begin_inset space \space{} -\end_inset - - -\begin_inset Quotes eld -\end_inset - -[12] -\begin_inset Quotes erd -\end_inset - -) to refer to a cited work. - However, in many scientific disciplines, other citation styles are in use. - The most common one is the author-year style (e. -\begin_inset space \thinspace{} -\end_inset - -g. -\begin_inset space \space{} -\end_inset - - -\begin_inset Quotes eld -\end_inset - -Knuth 1984a -\begin_inset Quotes erd -\end_inset - -). - \SpecialChar LyX - supports three packages that provide this style, -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -biblatex \end_layout -\end_inset +\begin_layout Itemize +\family sans +Addpart, Addchap +\family default , -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib +\family sans +Addsec +\family default +: are equivalents to +\family sans +Part*, Chapter* +\family default + and +\family sans +Section* +\family default +, resp., additionally inserting an entry in the table of contents. + +\family sans +Addpart +\family default + and +\family sans +Addchap +\family default + are not contained in +\emph on +article (koma-script) +\emph default +. \end_layout -\end_inset +\begin_layout Itemize -, and -\begin_inset Flex Code +\family sans +Addchap* +\family default +, +\family sans +Addsec* +\family default +: behave exactly as +\family sans +Addchap +\family default + and +\family sans +Addsec +\family default +, resp., additionally clearing running heads. + +\family sans +Addchap* +\family default + is not contained in +\emph on +article (koma-script) +\emph default +. +\begin_inset Foot status collapsed \begin_layout Plain Layout -jurabib -\end_layout - -\end_inset +There is also an +\family typewriter +\backslash +addpart* +\family default + command in +\emph on +book (koma-script) +\emph default + and in +\emph on +report (koma-script) +\emph default +, but since this is identical to +\family sans +Part* +\family default +, is has not been implemented in \SpecialChar LyX . - Each of these packages has their pros and cons, which cannot be listed - in detail. - If you only want to have simple author-year (or author-numerical) style, - or if you want to use one of the countless style files for -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib \end_layout \end_inset -, then the established -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -natbib \end_layout -\end_inset - - package is probably your choice. - If you look for specific citation styles common in law studies, you might - consider the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -jurabib +\family sans +Minisec +\family default +: generates a heading directly above the following paragraph in the standard + character size without affecting the structure of the document. \end_layout -\end_inset +\begin_layout Itemize - package. - If you want to have full control over the formatting or look for advanced - features such as ibidem, footnote citations, full title citations, advanced - date formats (such as 400 BC) or full localization to other languages than - English, you should definitely consider -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -biblatex +\family sans +Captionabove +\family default + and +\family sans +Captionbelow +\family default + are special captions which respect the different space settings needed + for captions placed above or below an element (if you follow strict typographic + rules, you might want to place table captions always above the table). + You can also use the class option +\family typewriter +tablecaptionsabove +\family default +, which will switch +\family sans +caption +\family default + to +\family sans +captionabove +\family default + for tables and +\family sans +captionbelow +\family default + for figures. + You need at least Koma-Script version 2.8q to use this. \end_layout +\begin_layout Itemize + +\family sans +Dictum +\family default +: can be used to set a bonmot, e. +\begin_inset space \thinspace{} \end_inset -, which exceeds all other packages in terms of features, but is also quite - heavy and more resource-hungry. -\end_layout +g. +\begin_inset space \space{} +\end_inset -\begin_layout Standard -The handling of these packages in \SpecialChar LyX - is basically the same. - Go to -\begin_inset Flex Noun -status collapsed +at the beginning of a chapter. + If you use the optional argument ( +\family sans +Insert\SpecialChar menuseparator +Dictum +\begin_inset space ~ +\end_inset -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings +Author +\family default +), you can insert the dictum's author there. + Dictum and author are separated by a line. + You need at least Koma-Script version 2.8q to use this. + +\family sans +Dictum +\family default + is not contained in +\emph on +article (koma-script) +\emph default +. \end_layout +\begin_layout Standard +The following types, together with the standard types +\family sans +Title +\family default +, +\family sans +Author +\family default +, and +\family sans +Date +\family default +, form the title area of the document. + They must be entered ahead of the first +\begin_inset Quotes eld \end_inset - and select under -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Bibliography -\end_layout - +ordinary +\begin_inset Quotes erd \end_inset - the -\begin_inset Flex Noun + paragraph. +\begin_inset Foot status collapsed \begin_layout Plain Layout -Style Format +The corresponding \SpecialChar LaTeX + commands must appear before the +\family typewriter + +\backslash +maketitle +\family default + command. \end_layout \end_inset - -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Basic (BibTeX) + When such a type is used more than once, the latter usage overwrites the + former one, that means, for every type only the latest usage is valid. + The order of the different types however has, like +\family sans +Title +\family default +, +\family sans +Author +\family default +, and +\family sans +Date +\family default +, no effect on the appearance of the produced document. \end_layout -\end_inset +\begin_layout Itemize +\family sans +Subject +\family default +: produces a centered paragraph above the ordinary title ( +\family sans +Title +\family default , -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Biblatex +\family sans +Author +\family default +, +\family sans +Date +\family default +) for the subject of the document. \end_layout -\end_inset +\begin_layout Itemize +\family sans +Publishers +\family default +: produces a centered paragraph below the ordinary title ( +\family sans +Title +\family default , -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Biblatex (Natbib mode) +\family sans +Author +\family default +, +\family sans +Date +\family default +) for the publishers' name. \end_layout -\end_inset +\begin_layout Itemize +\family sans +Dedication +\family default +: in +\emph on +report (koma-script) +\emph default + and +\emph on +book (koma-script) +\emph default + produces a centered paragraph on its own page behind the title page, or + in +\emph on +article (koma-script) +\emph default + produces a centered paragraph below the ordinary title ( +\family sans +Title +\family default , -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Natbib (BibTeX) +\family sans +Author +\family default +, +\family sans +Date +\family default +, +\family sans +Publishers +\family default +) for a dedication. \end_layout -\end_inset - - or -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Jurabib (BibTeX) +\family sans +Titlehead +\family default +: produces a left aligned paragraph above the ordinary title ( +\family sans +Title +\family default +, +\family sans +Author +\family default +, +\family sans +Date +\family default +, +\family sans +Subject +\family default +) for a document`s head. \end_layout -\end_inset +\begin_layout Itemize - (see sec. -\begin_inset space ~ -\end_inset - -6.5.3 in the User's Guide for more information on these choices). - With all these packages, you will get some extra features in the citation - dialog and you can select the style of the reference ( -\begin_inset Quotes eld -\end_inset - -Knuth 1984 -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset +\family sans +Uppertitleback +\family default +: produces in a double-sided print in +\emph on +report (koma-script) +\emph default + and +\emph on +book (koma-script) +\emph default + a left-aligned paragraph at the top of the title page`s back or has no + effect in a single-sided print or in +\emph on +article (koma-script) +\emph default +. +\end_layout -Knuth (1984) -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Lowertitleback +\family default +: produces in a double-sided print in +\emph on +report (koma-script) +\emph default + and +\emph on +book (koma-script) +\emph default + a left-aligned paragraph at the bottom of the title page`s back or has + no effect in a single-sided print or in +\emph on +article (koma-script) +\emph default +. +\end_layout -Knuth, 1984 -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, +\family sans +Extratitle +\family default +: produces a special \begin_inset Quotes eld \end_inset -1984 +dirty \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 - -\end_inset - - for -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -natbib + page ahead of the actual document containing a paragraph without special + formatting. \end_layout -\end_inset - +\begin_layout Standard +The layout files for the document classes +\emph on +article (koma-script) +\emph default +, +\emph on +report (koma-script) +\emph default +, and +\emph on +book (koma-script) +\emph default + do include the file +\family typewriter +scrmacros.inc +\family default . + This is thought of as a place to define your own types. + Copy scrmacros +\family typewriter +.inc +\family default + in your personal layout directory and edit the file! \end_layout -\begin_layout Subsection -Subdivided Bibliographies +\begin_layout Subsubsection +letter (koma-script) \end_layout -\begin_layout Standard -Sometimes you might need to divide your bibliography into several sections. - If you are for instance a historian, the possibility to separate sources - and scientific works is most likely a -\begin_inset Quotes eld +\begin_layout Description +Note: This section discusses the obsolete +\family sans +KOMA-Script-Letter (v. +\begin_inset space ~ \end_inset -must have -\begin_inset Quotes erd +1) +\family default +, which is not even included anymore in recent KOMA releases. + Please refer to the next section for the current KOMA-Script-Letter class + (v. +\begin_inset space ~ \end_inset -. - Unfortunately, Bib\SpecialChar TeX - itself does not allow you to do this. - But with the help of some \SpecialChar LaTeX - packages, Bib\SpecialChar TeX - can be extended to fit your needs. +2)! \end_layout \begin_layout Standard -\SpecialChar LyX - provides native support for one of these packages, +\noindent +The document class +\emph on +letter (koma-script) +\emph default + is implemented in the layout file \family typewriter -bibtopic +scrlettr.layout +\family default +. + It contains all the paragraph types of the corresponding standard document + class +\emph on +letter +\emph default +, partly modified, with the exception of the \SpecialChar LyX + specific types +\family sans +\SpecialChar LyX +-Code +\family default + and +\family sans +Comment +\family default + and the +\family sans +List +\family default + type, which is replaced by the new +\family sans +Labeling +\family default + type. + In addition, it contains, in contrast to the standard document class, the + standard types +\family sans +\SpecialChar LaTeX + +\family default +, +\family sans +Quotation +\family default +, +\family sans +Quote +\family default +, and +\family sans +Verse \family default . + Furthermore, there are a number of new letter specific types. +\end_layout + +\begin_layout Standard +The appearance of the letter produced by this document class can be controlled + by a number of \SpecialChar LaTeX + commands, which you can put in the \SpecialChar LaTeX + preamble. \begin_inset Foot status collapsed \begin_layout Plain Layout -Available from -\begin_inset Flex URL -status open +For example, the standard appearance of the letter`s heading, consisting + of name and address, is quite self-willed. + An +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout +ordinary +\begin_inset Quotes erd +\end_inset -ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/ + heading is produced by the following \SpecialChar LaTeX + commands in the preamble: \end_layout -\end_inset - +\begin_layout LyX-Code +\backslash +firsthead{ +\backslash +parbox[b]{ +\backslash +textwidth} \end_layout -\end_inset +\begin_layout LyX-Code + { +\backslash +ignorespaces +\backslash +fromname +\backslash - 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 +\backslash -\begin_inset Quotes eld -\end_inset - -Sources -\begin_inset Quotes erd -\end_inset +\backslash +ignorespaces +\backslash +fromaddress}} +\end_layout - and -\begin_inset Quotes eld -\end_inset +\begin_layout LyX-Code -Scientific works -\begin_inset Quotes erd -\end_inset +\backslash +nexthead{ +\backslash +parbox[b]{ +\backslash +textwidth} +\end_layout -, you first need to create two bibliographic databases, e. -\begin_inset space \thinspace{} -\end_inset +\begin_layout LyX-Code + { +\backslash +ignorespaces +\backslash +fromname +\backslash +hfill +\backslash +ignorespaces +\backslash +pagename +\backslash + +\backslash +thepage}} +\end_layout -g. -\begin_inset space \space{} \end_inset - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -sources.bib + A detailed German description of such \SpecialChar LaTeX + commands can be found in the Koma-Script + documentation +\emph on +scrguide +\emph default +. + With it, the letter's author can produce his personal letter layout. \end_layout -\end_inset - +\begin_layout Standard +The types +\family sans +Letter +\family default and -\begin_inset Flex Code -status collapsed +\family sans +Opening +\family default + define the beginning of the letter and must be used in every letter. + To emphasize them in the \SpecialChar LyX + document class, they are marked with the letter + +\shape italic +L +\shape default + or +\shape italic +O +\shape default +, resp. +\begin_inset space ~ +\end_inset -\begin_layout Plain Layout -scientific.bib +in the left margin. + It is possible to write any number of letters in one file. + An +\family sans +Opening +\family default + type produces a new letter using the same addressee and a +\family sans +Letter +\family default + type produces a new addressee. + The types +\family sans +Closing +\family default +, +\family sans +PS +\family default +, +\family sans +CC +\family default +, and +\family sans +Encl +\family default + are ordinary paragraph types and can also be used several times in one + and the same letter. \end_layout -\end_inset +\begin_layout Itemize -. - +\family sans +Letter +\family default +: produces a paragraph for the addressee and implicitly defines the beginning + of the letter. \end_layout -\begin_layout Standard -Go to -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings +\family sans +Opening +\family default +: produces a paragraph for the form of address and implicitly produces a + new letter. \end_layout -\end_inset - - and check under -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Bibliography +\family sans +Closing +\family default +: produces a paragraph for a close. \end_layout -\end_inset - - the option -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Subdivided bibliography +\family sans +PS +\family default +: produces a paragraph for a postscript. \end_layout -\end_inset - -. - Now you can insert multiple Bib\SpecialChar TeX - bibliographies, one for each section of - your bibliography. - Returning to our example: Insert the Bib\SpecialChar TeX - bibliography -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -sources.bib +\family sans +CC +\family default +: produces a paragraph for a distribution list. \end_layout -\end_inset +\begin_layout Itemize - and a second one for the database -\begin_inset Flex Code +\family sans +Encl +\family default +: produces a paragraph for enclosures. +\end_layout + +\begin_layout Standard +The types +\family sans +Name +\family default +, +\family sans +Signature +\family default +, +\family sans +Address +\family default +, +\family sans +Telephone +\family default +, +\family sans +Place +\family default +, +\family sans +Backaddress +\family default +, +\family sans +Specialmail +\family default +, +\family sans +Location +\family default +, +\family sans +Title +\family default +, and +\family sans +Subject +\family default + are input types provided with a label to enter information, which will + be processed by the document class. +\begin_inset Foot status collapsed \begin_layout Plain Layout -scientific.bib +It could be seen as a matter of inconsequence, that the types +\family sans +Letter +\family default + and +\family sans +Opening +\family default + described above are not such input types as well. + Because of the special meaning of those types, however, I have implemented + them as ordinary paragraph types with a one letter mark in the left margin. + Moreover, it would affect my feeling of symmetry, if the +\family sans +Opening +\family default + type and the +\family sans +Closing +\family default + type had such a serious different appearance. \end_layout \end_inset -. - You are free to use the same or different styles for each section. - Additionally, you can choose if the bibliography section should contain - -\begin_inset Quotes eld -\end_inset - -all cited references -\begin_inset Quotes erd -\end_inset - - of the specified database(s) (which is the default), -\begin_inset Quotes eld -\end_inset - -all uncited references -\begin_inset Quotes erd -\end_inset - - or even -\begin_inset Quotes eld -\end_inset + The types must be used ahead of the corresponding +\family sans +Opening +\family default + type. +\end_layout -all references -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +An implementation of these types in a WYSIWYG fashion does not seem to make + sense, because the real appearance of the produced letter does not only + depend on the usage of the particular type, but also on other factors. + For example, a signature entered in the +\family sans +Signature +\family default + type will in the standard behavior appear in the produced letter only, + when in the same letter also a +\family sans +Closing +\family default + type is used. + The entered value of the +\family sans +Telephone +\family default + type will in the standard behavior not appear in the produced letter at + all. + The possibility to design the letter`s heading freely is already indicated + in a footnote above. +\end_layout -. - This might be useful if you would like to separate your bibliography into - three sections: -\begin_inset Quotes eld +\begin_layout Standard +The input types can also be used as empty paragraphs. + This makes sense e. +\begin_inset space \thinspace{} \end_inset -Cited sources -\begin_inset Quotes erd +g. +\begin_inset space \space{} \end_inset -, -\begin_inset Quotes eld -\end_inset +for the +\family sans +Signature +\family default + type. + If the +\family sans +Signature +\family default + type is not used at all, in the standard behavior the value of the +\family sans +Name +\family default + type is used as signature, whereas if an empty +\family sans +Signature +\family default + type is used, no signature value is defined. +\end_layout -Uncited sources -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +By using the input types it is possible to write a letter template, containing + filled input types with your personal dates (name, address, etc.) and empty + input types for other dates you want to enter. +\end_layout -, and -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -Scientific works -\begin_inset Quotes erd -\end_inset +\family sans +Name +\family default +: sender's name, in the standard behavior appears as a centered paragraph + in small caps in the letter`s heading. +\end_layout -. - The titles for the sections can be added as ordinary sections or subsections. - Since -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -bibtopic +\family sans +Signature +\family default +: sender's signature, in the standard behavior appears below the +\family sans +Closing +\family default + type. + If no +\family sans +Signature +\family default + type is used, the value of the +\family sans +Name +\family default + type appears instead. \end_layout -\end_inset +\begin_layout Itemize - removes the bibliography title, you have to manually re-add that, too (as - a chapter* or section*, for instance). +\family sans +Address +\family default +: sender's address, in the standard behavior appears in a centered paragraph + in the letter`s heading below the sender's name. \end_layout -\begin_layout Standard -With +\begin_layout Itemize + \family sans -Biblatex +Telephone \family default -, the procedure is a bit different. - Since +: sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX + variable + \family typewriter -bibtopic + +\backslash +telephonenum \family default - does not work with +. +\end_layout + +\begin_layout Itemize + \family sans -Biblatex +Place \family default -, the aforementioned -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Subdivided bibliography +: place of the letter`s making. \end_layout -\end_inset +\begin_layout Itemize - option is disabled if you use \family sans -Biblatex +Date \family default -. - However, +: date of the letter`s making. + \family sans -Biblatex +Place \family default - provides its own means to generate subdivided bibliographies. - You can either add keywords to bibliography entries via the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -keywords + and +\family sans +Date +\family default +, in the standard behavior, produce the place and the date in a right-aligned + line below the addressee's field. + If an empty +\family sans +Date +\family default + type is used, neither place nor date appear, independent of the value of + the +\family sans +Place +\family default + type. + If no +\family sans +Date +\family default + type is used, the date of the letter `s production is used. \end_layout -\end_inset - - entry option and then filter bibliography sections by keyword (by adding - -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -keyword=mykeyword +\family sans +Backaddress +\family default +: sender`s back address, in the standard behavior appears above the addressee's + field in a small sans serif font. \end_layout -\end_inset - - to the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Options +\family sans +Specialmail +\family default +: special mail information, in the standard behavior appears underlined + above the addressee's field below the back address. \end_layout -\end_inset - - field of the dialog that opens if you left-click on the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Biblatex Generated Bibliography +\family sans +Location +\family default +: additional information, in the standard behavior appears on right side + below the addressee`s field. \end_layout -\end_inset +\begin_layout Itemize - button), or you can filter by entry types (such as -\emph on -book -\emph default - or -\emph on -article -\emph default -) by entering e. -\begin_inset space \thinspace{} -\end_inset - -g. - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -type=book +\family sans +Title +\family default +: the letter's title, in the standard behavior appears in a big, bold, sans + serif font above the subject. \end_layout -\end_inset - - or -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -nottype=collection +\family sans +Subject +\family default +: the letter's subject, in the standard behavior appears in a bold font + above the +\family sans +Opening +\family default + paragraph. \end_layout +\begin_layout Standard +The types +\family sans +Yourref +\family default +, +\family sans +Yourmail +\family default +, +\family sans +Myref +\family default +, +\family sans +Customer +\family default +, and +\family sans +Invoice +\family default + produce a business letter like line above the +\family sans +Title +\family default + line containing the fields +\begin_inset Quotes eld \end_inset - to the mentioned -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Options -\end_layout - +Your ref. +\begin_inset Quotes erd \end_inset - field, or you can create so-called +, \begin_inset Quotes eld \end_inset -Bibliography Categories +Your letter of \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" - +, +\begin_inset Quotes eld \end_inset +Our ref. +\begin_inset Quotes erd +\end_inset -\end_layout - -\begin_layout Standard -Multiple bibliographies, e. -\begin_inset space \thinspace{} +, +\begin_inset Quotes eld \end_inset -g. -\begin_inset space \space{} +Customer no. +\begin_inset Quotes erd \end_inset -a bibliography for each part, chapter, section, subsection or child (sub-documen -t) of the document, are also supported by \SpecialChar LyX -. - In order to enable it, go to -\begin_inset Flex Noun -status collapsed +, +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Bibliography -\end_layout +Invoice no. +\begin_inset Quotes erd +\end_inset +, and +\begin_inset Quotes eld \end_inset - and select the relevant unit (e. -\begin_inset space \thinspace{} +Date +\begin_inset Quotes erd \end_inset -g., +. + For the date field, the value of the +\family sans +Date +\family default + type is used. + If one of these \begin_inset Quotes eld \end_inset -per section +business letter types \begin_inset Quotes erd \end_inset -) in the -\begin_inset Flex Noun -status collapsed + is used, the value of the +\family sans +Place +\family default + type however does not appear, but only the \SpecialChar LaTeX + variable +\family typewriter -\begin_layout Plain Layout -Multiple Bibliographies +\backslash +fromplace +\family default + is set. + The ordinary output of place and date in a right-aligned line below the + addressee`s field is suppressed. + The types are implemented as input types provided with a label and must + be used ahead of the corresponding +\family sans +Opening +\family default + type. \end_layout -\end_inset - - combo box. - Then add a Bib(la)\SpecialChar TeX - bibliography to each unit (e. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Itemize -g., section) of your document. - In the output, a separate bibliography, containing only the references - done in the current unit is generated. +\family sans +Yourref +\family default +: Your ref. \end_layout -\begin_layout Standard -If you use Bib\SpecialChar TeX -, either the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -chapterbib +\family sans +Yourmail +\family default +: Your letter of. \end_layout -\end_inset - - or the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -bibtopic +\family sans +Myref +\family default +: Our ref. \end_layout -\end_inset - - package is used to create multiple bibliographies. - The former package is used if you select -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -per child document -\begin_inset Quotes erd -\end_inset +\family sans +Customer +\family default +: Customer no. +\end_layout - and do -\emph on -not -\emph default - check -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Sectioned Bibliography +\family sans +Invoice +\family default +: Invoice no. \end_layout -\end_inset - -. - In all other cases, -\begin_inset Flex Code -status collapsed +\begin_layout Subsubsection +The new letter class: letter (koma-script v.2) +\end_layout -\begin_layout Plain Layout -bibtopic +\begin_layout Standard +by +\noun on +Jürgen Spitzmüller \end_layout +\begin_layout Standard +\begin_inset VSpace medskip \end_inset - is used. -\begin_inset Foot -status collapsed -\begin_layout Plain Layout -An alternative approach, if you are willing to use some -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -\SpecialChar TeX - Code \end_layout -\end_inset - - (see section -\begin_inset space ~ -\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 - -\begin_layout Plain Layout -bibunits +\begin_layout Standard +\noindent +Koma-Script version 2.8 has introduced a new letter class +\family typewriter +scrlttr2 +\family default + which supersedes the now unsupported +\family typewriter +scrlettr +\family default +. + It has — on the \SpecialChar LaTeX + side — a completely new interface and is not compatible + with the old class. + Therefore, \SpecialChar LyX + supports both, though it is recommended you use the new class. \end_layout +\begin_layout Standard +This class covers the same functionality as +\emph on +letter (koma-script), +\emph default + and a few more. + The basic items are +\family sans +Address +\family default + (receiver's address, same as +\family sans +Letter +\family default + in the old layout), +\family sans +Opening +\family default +, and +\family sans +Closing +\family default +. + +\family sans +NextAddress +\family default + will start a new letter (i. +\begin_inset space \thinspace{} \end_inset - package. -\end_layout - +e. +\begin_inset space \space{} \end_inset - If -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -bibtopic +you can write several letters per document). + New elements are sender's +\family sans +E-Mail +\family default +, +\family sans +URL +\family default +, +\family sans +Fax +\family default +, +\family sans +Bank +\family default + and the possibility to use a +\family sans +Logo +\family default + (via +\family sans +Insert\SpecialChar menuseparator +Graphics +\family default +) in the header. \end_layout -\end_inset - - is used, \SpecialChar LyX - encloses the specified units in -\begin_inset Flex Code +\begin_layout Standard +The biggest improvement is, though, that the letter's layout is configurable + to meet almost any needs. + This can be done via the preamble or with a special style file (Letter + Class Option, extension +\family typewriter +*.lco +\family default +), that will be read in as a class option. +\begin_inset Foot status collapsed \begin_layout Plain Layout -bibtopic +The KOMA package comes with some default +\family typewriter +*.lco +\family default + files. + There is, for instance, a +\family typewriter +DIN.lco +\family default + file that follows german typesetting rules, or a +\family typewriter +KOMAold.lco +\family default + that provides the default layout of the old +\family typewriter +scrlettr +\family default + class. + The latter can be loaded with the class option +\family typewriter +KOMAold +\family default +, inserted via the +\family sans +Layout\SpecialChar menuseparator +Document\SpecialChar menuseparator +Extra Options +\family default + field. \end_layout \end_inset -'s -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -begin{btUnit} + Have a look at the +\emph on +koma-letter2 +\emph default + template that is included in \SpecialChar LyX + for examples. + A detailed description is to be found in the Koma-Script documentation + ( +\emph on +scrguide +\emph default +). \end_layout -\end_inset - - and -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -end{btUnit} +\begin_layout Subsubsection +Problems \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 -btUnit +\begin_layout Standard +Visualizing the Koma-Script document classes in \SpecialChar LyX +, the \SpecialChar LyX + internals cause some + problems. \end_layout -\end_inset - -. - So citations outside a defined unit (e. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Itemize +The chapter number of a +\family sans +Chapter +\family default + type appears on a line of its own above the chapter heading instead of + appearing in the same line ahead of it. + The cause for that is the \SpecialChar LyX + internal behavior for the labeltype +\family sans +Counter_Chapter +\family default + in the layout file. +\end_layout -g., before the first section if you use +\begin_layout Itemize +The headings of the types +\family sans +Addchap +\family default + and +\family sans +Addsec +\family default + are only put in the \begin_inset Quotes eld \end_inset -by section +true \begin_inset Quotes erd \end_inset -) will appear as -\begin_inset Quotes eld + \SpecialChar LaTeX + table of contents, but not in the \SpecialChar LyX + table of contents ( +\family sans +Document\SpecialChar menuseparator +Table +\begin_inset space ~ \end_inset -??? -\begin_inset Quotes erd +of +\begin_inset space ~ \end_inset -. - You can also create your own units by entering -\begin_inset Flex Code -status collapsed +Contents +\family default +). +\end_layout -\begin_layout Plain Layout +\begin_layout Itemize +The paragraphs in a +\emph on +letter +\emph default + document class appear in a skip separation mode, not indented. + This is the standard behavior, no special \SpecialChar LaTeX + commands are needed for that. + But in the +\family sans +Document\SpecialChar menuseparator +Settings +\family default + dialog the corresponding radio button indicates +\family sans +Indent +\family default +. + A +\family sans +Skip +\family default + value always has the effect that extra \SpecialChar LaTeX + commands are inserted in the document + to produce the gap, which is not what is wanted in this case. +\end_layout -\backslash -begin{btUnit} +\begin_layout Section + +\change_inserted 564990737 1670439534 +Articles \end_layout +\begin_layout Standard + +\change_inserted 564990737 1670439557 +See also the document classes in the Collections (section +\begin_inset space ~ \end_inset - and -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Collections" -\backslash -end{btUnit} +\end_inset + +). +\end_layout + +\begin_layout Section + +\change_inserted 564990737 1670439560 +Books \end_layout +\begin_layout Standard + +\change_inserted 564990737 1670439581 +See also the document classes in the Collections (section +\begin_inset space ~ \end_inset - 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 +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Collections" \end_inset -s cannot be nested. - A second limitation is that -\begin_inset Flex Code -status collapsed +). +\end_layout -\begin_layout Plain Layout -bibtopic +\begin_layout Section + +\change_inserted 564990737 1670439605 +Curricula vitarum \end_layout -\end_inset +\begin_layout Section - 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 +\change_inserted 564990737 1670439627 +Letters +\end_layout -g. - -\begin_inset Quotes eld +\begin_layout Section + +\change_inserted 564990737 1670439660 +Presentations +\end_layout + +\begin_layout Section + +\change_inserted 564990737 1670439661 +Reports +\end_layout + +\begin_layout Subsection + +\change_inserted 564990737 1670439661 +report +\end_layout + +\begin_layout Standard + +\change_inserted 564990737 1670439661 +The document class +\family sans +report +\family default + provides the +\family sans +report.cls +\family default + document class for preparing reports. + Like the +\family sans +book +\family default + document class, this provides parts, chapters and sections but does not + provide the paragraph styles needed for a book; like the +\family sans +article +\family default + document class, it provides the abstract paragraph style. + In two-sided mode, it does not start a new chapter on the right hand page. +\end_layout + +\begin_layout Standard + +\change_inserted 564990737 1670439674 +The remaining +\family sans +report +\family default + document classes are described in the Collections (section +\begin_inset space ~ \end_inset -Miller 2014b -\begin_inset Quotes erd + +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Collections" + \end_inset - if two works of this author from 2014 are in the database, even if only - one is cited). +). +\end_layout + +\begin_layout Section + +\change_inserted 564990737 1670439674 +Scripts (drama) +\end_layout + +\begin_layout Chapter +Supplemental Tools +\end_layout + +\begin_layout Section +Customizing Bibliographies with Bib\SpecialChar TeX + or Biblatex \end_layout \begin_layout Standard -If you use +The most basic information about how to use Bib\SpecialChar TeX + or \family sans Biblatex \family default -, the -\begin_inset Flex Code -status collapsed + with \SpecialChar LyX + is contained in the section +\emph on +Bibliography databases +\emph default + of the +\emph on +User's Guide +\emph default +. + The following subsections explain special bibliography features supported + by \SpecialChar LyX +. +\end_layout -\begin_layout Plain Layout -refsection +\begin_layout Subsection +Alternative Citation Styles \end_layout +\begin_layout Standard +Standard Bib\SpecialChar TeX + uses numbers (e. +\begin_inset space \thinspace{} \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 +g. +\begin_inset space \space{} +\end_inset -\begin_layout Plain Layout -\backslash -newrefsection -\end_layout +\begin_inset Quotes eld +\end_inset +[12] +\begin_inset Quotes erd \end_inset - or -\begin_inset Flex Code -status collapsed +) to refer to a cited work. + However, in many scientific disciplines, other citation styles are in use. + The most common one is the author-year style (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Plain Layout +g. +\begin_inset space \space{} +\end_inset -\backslash -newrefsegment -\end_layout +\begin_inset Quotes eld \end_inset -, respectively. - If you also want to control the end of the unit, use the environment +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 -begin{refsection} +biblatex \end_layout \end_inset - \SpecialChar ldots - +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -end{refsection} +natbib \end_layout \end_inset - instead. - Note, though, that +, and \begin_inset Flex Code status collapsed \begin_layout Plain Layout -refsection +jurabib \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 +. + 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 Subsection -General Operation +\begin_layout Plain Layout +natbib \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 +, then the established +\begin_inset Flex Code +status collapsed - 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 +\begin_layout Plain Layout +natbib +\end_layout -e. -\begin_inset space \space{} \end_inset -everything up to and including the + 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 - -\backslash -begin{document} +jurabib \end_layout \end_inset - line as well as the + package. + If you want to have full control over the formatting or look for advanced + features such as ibidem, footnote citations, full title citations, advanced + date formats (such as 400 BC) or full localization to other languages than + English, you should definitely consider \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -end{document} +biblatex \end_layout \end_inset - line must be deleted) or else errors will be generated when you try to - make a DVI file. +, which exceeds all other packages in terms of features, but is also quite + heavy and more resource-hungry. \end_layout \begin_layout Standard -\SpecialChar LyX - allows you to include files quite easily with +The handling of these packages in \SpecialChar LyX + is basically the same. + Go to \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Insert\SpecialChar menuseparator -Child -\begin_inset space ~ +Document\SpecialChar menuseparator +Settings +\end_layout + \end_inset -Document + and select under +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Bibliography \end_layout \end_inset -. - When you click on this selection a small box is inserted into the file - at the current cursor location. - Clicking on the box raises a dialog which allows you to select the file - to be included, and the method of its inclusion. - + the +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Style Format \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 + +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Basic (BibTeX) +\end_layout + \end_inset , -\begin_inset Quotes eld -\end_inset +\begin_inset Flex Noun +status collapsed -input -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +Biblatex +\end_layout -, and -\begin_inset Quotes eld \end_inset -verbatim -\begin_inset Quotes erd -\end_inset +, +\begin_inset Flex Noun +status collapsed -. - The methods -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +Biblatex (Natbib mode) +\end_layout -include -\begin_inset Quotes erd \end_inset - and -\begin_inset Quotes eld -\end_inset +, +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Natbib (BibTeX) +\end_layout -input -\begin_inset Quotes erd \end_inset - are similar in many ways, but there are also some notable differences: + or +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Jurabib (BibTeX) \end_layout -\begin_layout Enumerate -Files that are -\begin_inset Quotes eld \end_inset -included -\begin_inset Quotes erd + (see sec. +\begin_inset space ~ \end_inset - are typeset beginning on a new page, while files that are +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 -inputted +Knuth 1984 \begin_inset Quotes erd \end_inset - are typeset starting on the current page. -\end_layout - -\begin_layout Enumerate +, \begin_inset Quotes eld \end_inset -Included +Knuth (1984) \begin_inset Quotes erd \end_inset - files cannot themselves +, \begin_inset Quotes eld \end_inset -include +Knuth, 1984 \begin_inset Quotes erd \end_inset - further files ( +, \begin_inset Quotes eld \end_inset -grandchilds +1984 \begin_inset Quotes erd \end_inset -). - With -\begin_inset Quotes eld -\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 -input -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +See +\begin_inset Flex URL +status open -, on the other hand, infinite sub-inputting is possible. +\begin_layout Plain Layout + +ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/ \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 +\end_layout -included -\begin_inset Quotes erd \end_inset - files, while maintaining the actual counters (pagination etc.) and references - (please refer to the section -\emph on -Child -\begin_inset space ~ -\end_inset + for +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +natbib +\end_layout -Documents -\emph default - of the -\emph on -Embedded -\begin_inset space ~ \end_inset -Objects -\emph default - manual for details). +. +\end_layout + +\begin_layout Subsection +Subdivided Bibliographies \end_layout \begin_layout Standard -Hence, +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 -include +must have \begin_inset Quotes erd \end_inset - is the preferred method for chapters that are outsourced to child documents, - while +. + 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 +\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 + \begin_inset Quotes eld \end_inset -input +Sources \begin_inset Quotes erd \end_inset - is more suitable for arbitrary file inheritance. -\end_layout - -\begin_layout Standard -A + and \begin_inset Quotes eld \end_inset -verbatim +Scientific works \begin_inset Quotes erd \end_inset - included file allows you to include a file typeset exactly as it appears - in the file, i. +, you first need to create two bibliographic databases, e. \begin_inset space \thinspace{} \end_inset -e. +g. \begin_inset space \space{} \end_inset -in + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -verbatim +sources.bib \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 + and +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Mark -\begin_inset space ~ -\end_inset - -spaces -\begin_inset space ~ -\end_inset - -in -\begin_inset space ~ -\end_inset - -output +scientific.bib \end_layout \end_inset - checkbox typesets a mark to unambiguously define the presence of a space. +. \end_layout \begin_layout Standard -Generally, the master file is converted into a full \SpecialChar LaTeX - file before typesetting, - while the included files are converted to \SpecialChar LaTeX - files that do not have all the - preamble information. -\end_layout +Go to +\begin_inset Flex Noun +status collapsed -\begin_layout Subsection -Cross-References Between Files +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings \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 +\end_inset + + and check under +\begin_inset Flex Noun +status collapsed \begin_layout Plain Layout -This section is somewhat out of date. - Need to describe default master documents and how children are opened when - the master is. - [[FIXME]] +Bibliography \end_layout \end_inset + the option +\begin_inset Flex Noun +status collapsed +\begin_layout Plain Layout +Subdivided bibliography \end_layout -\begin_layout Standard -It is possible to set up cross-references between the different files. - First, open all the files in question: let's call them A and B in a two - file example, where B is included in A. - Let's say you insert a label in A, then want to reference it in B. - Open the cross-reference dialog whilst in document B, and you can select - the -\begin_inset Quotes eld \end_inset -buffer -\begin_inset Quotes erd -\end_inset +. + 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 - to use. +\begin_layout Plain Layout +sources.bib \end_layout -\begin_layout Subsection -Bibliography Lists in all Subdocuments -\end_layout +\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 + and a second one for the database +\begin_inset Flex Code +status collapsed -\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. +\begin_layout Plain Layout +scientific.bib \end_layout -\begin_layout Standard -For child-specific bibliographies, insert bibliography insets within the - child documents, at the place where the bibliography should appear when - the child is compiled separately. - However, the trick is to insert them into a branch ( -\family sans -Insert\SpecialChar menuseparator -Branch\SpecialChar menuseparator -Insert New Branch... -\family default -), e. -\begin_inset space \thinspace{} \end_inset -g. - called +. + 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 -Childonly +all cited references \begin_inset Quotes erd \end_inset -. - Within the children, activate the branch ( -\family sans -Document\SpecialChar menuseparator -Settings...\SpecialChar menuseparator -Branches -\family default -). - Within the master, deactivate the branch ( -\family sans -Document\SpecialChar menuseparator -Settings...\SpecialChar menuseparator -Branches -\family default -). - Now the child's bibliography will be ignored by the master, but considered - by the child. -\end_layout + of the specified database(s) (which is the default), +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -If you need multiple bibliographies (e. -\begin_inset space \thinspace{} +all uncited references +\begin_inset Quotes erd \end_inset -g., one per child in the -\emph on -main document -\emph default -), please refer to sec. -\begin_inset space ~ + or even +\begin_inset Quotes eld \end_inset +all references +\begin_inset Quotes erd +\end_inset -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:Multiple-Bibliographies" +. + 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 -. -\end_layout +, +\begin_inset Quotes eld +\end_inset -\begin_layout Section -\SpecialChar LyX - Archives -\end_layout +Uncited sources +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Users sometimes need to be able to +, and \begin_inset Quotes eld \end_inset -bundle +Scientific works \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 ( +. + The titles for the sections can be added as ordinary sections or subsections. + Since \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpak.py +bibtopic \end_layout \end_inset -) that automates this process. - To use it, you must have either the -\begin_inset Flex Code + removes the bibliography title, you have to manually re-add that, too (as + a chapter* or section*, for instance). +\end_layout + +\begin_layout Standard +With +\family sans +Biblatex +\family default +, the procedure is a bit different. + Since +\family typewriter +bibtopic +\family default + does not work with +\family sans +Biblatex +\family default +, the aforementioned +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -zipfile +Subdivided bibliography \end_layout \end_inset - or + 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 -tarfile +keywords \end_layout \end_inset - python modules installed on your system. - By default, the script prefers the + entry option and then filter bibliography sections by keyword (by adding + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -gzip +keyword=mykeyword \end_layout \end_inset --compressed -\begin_inset Flex Code + to the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -tar +Options \end_layout \end_inset - format on Unix-like systems and the -\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 -zip +Biblatex Generated Bibliography \end_layout \end_inset - format on Windows. -\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 -\SpecialChar LyX -'s configuration process will set the script up to export a `\SpecialChar LyX - Archive', - and this format will then be available under +g. + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -File\SpecialChar menuseparator -Export +type=book \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 + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout --t +nottype=collection \end_layout \end_inset - (for the -\begin_inset Flex Code + to the mentioned +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -tar +Options \end_layout \end_inset - format) or -\begin_inset Flex Code -status collapsed + field, or you can create so-called +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout --z +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 - (for the -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -zip \end_layout +\begin_layout Standard +Multiple bibliographies, e. +\begin_inset space \thinspace{} \end_inset - format) switch to the -\begin_inset Flex Code +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 -\SpecialChar LyX -\SpecialChar menuseparator -\SpecialChar LyX - Archive +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Bibliography \end_layout \end_inset - converter in -\begin_inset Flex Code + and select the relevant unit (e. +\begin_inset space \thinspace{} +\end_inset + +g., +\begin_inset Quotes eld +\end_inset + +per section +\begin_inset Quotes erd +\end_inset + +) in the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -Converters +Multiple Bibliographies \end_layout \end_inset -. - (Make sure you add the switch after the script name, not before it.) -\end_layout + combo box. + Then add a Bib(la)\SpecialChar TeX + bibliography to each unit (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Section -Fancy Headers and Footers +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 -The default page layout is rather plain; for an +If you use Bib\SpecialChar TeX +, either the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -article +chapterbib \end_layout \end_inset - document class, all you get is a centered page number at the bottom of - the page. - This document uses KOMA-script's book class, so it appears to be a bit - fancier. - But to really put on a show, you need to set the document page style to - + or the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +bibtopic +\end_layout + +\end_inset + + package is used to create multiple bibliographies. + The former package is used if you select \begin_inset Quotes eld \end_inset -fancy +per child document \begin_inset Quotes erd \end_inset -, as mentioned in the + and do \emph on -User Guide +not \emph default -. - This section describes the \SpecialChar LaTeX - code you need to insert in your \SpecialChar LaTeX - preamble in - order to get the desired effects. -\end_layout - -\begin_layout Standard -For more information on fancy headers, see the -\begin_inset Flex Code + check +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -fancyhdr +Sectioned Bibliography \end_layout \end_inset - package documentation. - ( -\begin_inset Flex URL +. + In all other cases, +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html +bibtopic \end_layout \end_inset -) -\end_layout + is used. +\begin_inset Foot +status collapsed -\begin_layout Standard -The page header is divided into three fields, not surprisingly labeled -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +An alternative approach, if you are willing to use some +\begin_inset Flex Noun +status collapsed -left -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout +\SpecialChar TeX + Code +\end_layout -, -\begin_inset Quotes eld \end_inset -center -\begin_inset Quotes erd + (see section +\begin_inset space ~ \end_inset -, and -\begin_inset Quotes eld -\end_inset -right -\begin_inset Quotes erd +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Inserting-TeX-Code" + \end_inset -. - The footer is also divided into these three fields. - The \SpecialChar LaTeX - commands to set these fields in the simplest manner are +), is to use the \begin_inset Flex Code status collapsed \begin_layout Plain Layout +bibunits +\end_layout -\backslash -lhead +\end_inset + + package. \end_layout \end_inset -, + If \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -chead +bibtopic \end_layout \end_inset -, + is used, \SpecialChar LyX + encloses the specified units in \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -rhead +bibtopic \end_layout \end_inset -, +'s \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -lfoot +begin{btUnit} \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 Standard + and +\begin_inset Flex Code +status collapsed -\family typewriter +\begin_layout Plain Layout \backslash -lhead{John Q. - DocWriter} +end{btUnit} \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.: -\end_layout - -\begin_layout Standard - -\family typewriter + 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 -\backslash -cfoot{} +\begin_layout Plain Layout +btUnit \end_layout -\begin_layout Standard -Let's get really fancy: lets put the section number with the word -\begin_inset Quotes eld -\end_inset - -Section -\begin_inset Quotes erd \end_inset - (e. +. + So citations outside a defined unit (e. \begin_inset space \thinspace{} \end_inset -g. -\begin_inset space \space{} +g., before the first section if you use +\begin_inset Quotes eld \end_inset -Section 3) in the upper left, the page number (e. -\begin_inset space \thinspace{} +by section +\begin_inset Quotes erd \end_inset -g. -\begin_inset space \space{} +) will appear as +\begin_inset Quotes eld \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_inset Quotes erd +\end_inset -\begin_layout Standard +. + You can also create your own units by entering +\begin_inset Flex Code +status collapsed -\family typewriter +\begin_layout Plain Layout \backslash -lhead{Section -\backslash -thesection} +begin{btUnit} \end_layout -\begin_layout Standard +\end_inset -\family typewriter + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout \backslash -chead{} +end{btUnit} \end_layout -\begin_layout Standard +\end_inset -\family typewriter + as \SpecialChar TeX + code (for instance to work around the mentioned limitation). + Note, though, that +\begin_inset Flex Code +status collapsed -\backslash -rhead{Page -\backslash -thepage} +\begin_layout Plain Layout +btUnit \end_layout -\begin_layout Standard +\end_inset -\family typewriter +s cannot be nested. + A second limitation is that +\begin_inset Flex Code +status collapsed -\backslash -lfoot{John Q. - DocWriter} +\begin_layout Plain Layout +bibtopic \end_layout -\begin_layout Standard +\end_inset -\family typewriter + 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 -\backslash -cfoot{} +g. + +\begin_inset Quotes eld +\end_inset + +Miller 2014b +\begin_inset Quotes erd +\end_inset + + if two works of this author from 2014 are in the database, even if only + one is cited). \end_layout \begin_layout Standard +If you use +\family sans +Biblatex +\family default +, the +\begin_inset Flex Code +status collapsed -\family typewriter - -\backslash -rfoot{ -\backslash -today} +\begin_layout Plain Layout +refsection \end_layout -\begin_layout Standard -The commands +\end_inset + + option is used instead. + If you need specific units, you can start them with the \SpecialChar TeX + code \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -thesection +newrefsection \end_layout \end_inset - and + or \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -thepage +newrefsegment \end_layout \end_inset - access \SpecialChar LaTeX -'s section and page counters, and so print out the current section - and page number. - +, 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 -today +begin{refsection} \end_layout \end_inset - simply prints out today's date. -\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 + \SpecialChar ldots -\family default -like \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -renewcommand{ -\backslash -headrulewidth}{0.4pt} +end{refsection} \end_layout \end_inset - and + instead. + Note, though, that \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -renewcommand{ -\backslash -footrulewidth}{0.4pt} +refsection \end_layout \end_inset - to set the thicknesses. +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 -You can switch the header/footer settings on and off for individual pages - using commands like -\begin_inset Flex Code -status collapsed +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 -\begin_layout Plain Layout +master +\begin_inset Quotes erd +\end_inset -\backslash -thispagestyle{empty} -\end_layout + file which contains the title, authors, abstract, references, etc., plus + the five included files. + It is important to note that each of these files is a full \SpecialChar LyX + file which + can be formatted and printed on its own, as well as included in a master + file. + Each of these files must have the same document class, however—don't attempt + to mix book classes with article classes. + You may also include \SpecialChar LaTeX + files; however, these files must not have their own + preamble (i. +\begin_inset space \thinspace{} +\end_inset +e. +\begin_inset space \space{} \end_inset -, +everything up to and including the \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -thispagestyle{plain} +begin{document} \end_layout \end_inset -, and + line as well as the \begin_inset Flex Code status collapsed \begin_layout Plain Layout \backslash -thispagestyle{fancy} +end{document} \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}}} + line must be deleted) or else errors will be generated when you try to + make a DVI file. \end_layout \begin_layout Standard -\noindent -(you may need to preface this with -\begin_inset Flex Code +\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 -\backslash -usepackage{graphics} +Document \end_layout \end_inset - if you don't include graphics elsewhere in your document). +. + 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 Section -Itemize Bullet Selection -\begin_inset CommandInset label -LatexCommand label -name "sec:bullet" - +\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 -\end_layout +, +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -by -\noun on - Allan Rae -\end_layout +input +\begin_inset Quotes erd +\end_inset -\begin_layout Subsection -Introduction -\end_layout +, and +\begin_inset Quotes eld +\end_inset -\begin_layout Standard -\SpecialChar LyX - provides 216 bullet shapes that can be accessed from a simple dialog. - Using this dialog you can easily specify what bullet shape to use at each - level of an itemized list. - These settings are document-wide so you won't be able to specify different - sets of bullets for different paragraphs. -\begin_inset Foot -status collapsed +verbatim +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -Well, actually you can but you'll have to do it by hand. -\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 Subsection -How it looks + are similar in many ways, but there are also some notable differences: \end_layout -\begin_layout Standard -Open the dialog by selecting the -\begin_inset Flex Noun -status collapsed +\begin_layout Enumerate +Files that are +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings -\end_layout +included +\begin_inset Quotes erd +\end_inset + are typeset beginning on a new page, while files that are +\begin_inset Quotes eld \end_inset - menu item and then select the -\begin_inset Flex Noun -status collapsed +inputted +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -Bullets + are typeset starting on the current page. \end_layout +\begin_layout Enumerate +\begin_inset Quotes eld \end_inset - tab. -\end_layout +Included +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -The dialog provides you with a table of bullet shapes. - A column of buttons on the left of the table provides access to the six - different panels of bullet shapes. - The row of buttons across the top is used to select which bullet depth - you are changing. + files cannot themselves +\begin_inset Quotes eld +\end_inset -\change_deleted 244031559 1603875981 - A text entry under the table shows the currently selected bullet shape's - \SpecialChar LaTeX - equivalent and this can be edited if desired. - If you do modify the text you will also need to specify any needed packages - in the \SpecialChar LaTeX - preamble. -\change_unchanged - -\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 +include +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout + further files ( +\begin_inset Quotes eld +\end_inset -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Button -\end_layout +grandchilds +\begin_inset Quotes erd +\end_inset +). + With +\begin_inset Quotes eld \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +input +\begin_inset Quotes erd +\end_inset -\family roman -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Packages Required +, on the other hand, infinite sub-inputting is possible. \end_layout +\begin_layout Enumerate +\begin_inset Quotes eld \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout +Include +\begin_inset Quotes erd +\end_inset -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Standard -\end_layout + allow for the output of only selected +\begin_inset Quotes eld +\end_inset +included +\begin_inset Quotes erd \end_inset - - -\begin_inset Text -\begin_layout Plain Layout + files, while maintaining the actual counters (pagination etc.) and references + (please refer to the section +\emph on +Child +\begin_inset space ~ +\end_inset -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -base \SpecialChar LaTeX +Documents +\emph default + of the +\emph on +Embedded +\begin_inset space ~ +\end_inset +Objects +\emph default + manual for details). \end_layout +\begin_layout Standard +Hence, +\begin_inset Quotes eld \end_inset - - - - -\begin_inset Text - -\begin_layout Plain Layout -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Maths -\end_layout +include +\begin_inset Quotes erd +\end_inset + is the preferred method for chapters that are outsourced to child documents, + while +\begin_inset Quotes eld \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +input +\begin_inset Quotes erd +\end_inset -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -amssymb.sty + is more suitable for arbitrary file inheritance. \end_layout +\begin_layout Standard +A +\begin_inset Quotes eld \end_inset - - - - -\begin_inset Text -\begin_layout Plain Layout +verbatim +\begin_inset Quotes erd +\end_inset -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding1 -\end_layout + included file allows you to include a file typeset exactly as it appears + in the file, i. +\begin_inset space \thinspace{} +\end_inset +e. +\begin_inset space \space{} \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +in +\begin_inset Flex Code +status collapsed -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty +\begin_layout Plain Layout +verbatim \end_layout \end_inset - - - - -\begin_inset Text -\begin_layout Plain 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 -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding2 -\end_layout +\begin_layout Plain Layout +Mark +\begin_inset space ~ +\end_inset +spaces +\begin_inset space ~ \end_inset - - -\begin_inset Text -\begin_layout Plain Layout +in +\begin_inset space ~ +\end_inset -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty +output \end_layout \end_inset - - - - -\begin_inset Text - -\begin_layout Plain Layout -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding3 + checkbox typesets a mark to unambiguously define the presence of a space. + \end_layout -\end_inset - - -\begin_inset Text - -\begin_layout Plain Layout +\begin_layout Standard +Generally, the master file is converted into a full \SpecialChar LaTeX + file before typesetting, + while the included files are converted to \SpecialChar LaTeX + files that do not have all the + preamble information. +\end_layout -\family typewriter -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -pifont.sty +\begin_layout Subsection +Cross-References Between Files \end_layout -\end_inset - - - - -\begin_inset Text +\begin_layout Standard +\begin_inset Box Shadowbox +position "t" +hor_pos "c" +has_inner_box 1 +inner_pos "t" +use_parbox 0 +use_makebox 0 +width "100col%" +special "none" +height "1in" +height_special "totalheight" +thickness "0.4pt" +separation "3pt" +shadowsize "4pt" +framecolor "black" +backgroundcolor "none" +status open \begin_layout Plain Layout - -\family sans -\series medium -\shape up -\size normal -\emph off -\bar no -\noun off -\color none -Ding4 +This section is somewhat out of date. + Need to describe default master documents and how children are opened when + the master is. + [[FIXME]] \end_layout \end_inset - - -\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 +\begin_layout Standard +It is possible to set up cross-references between the different files. + First, open all the files in question: let's call them A and B in a two + file example, where B is included in A. + Let's say you insert a label in A, then want to reference it in B. + Open the cross-reference dialog whilst in document B, and you can select + the +\begin_inset Quotes eld \end_inset - - - +buffer +\begin_inset Quotes erd \end_inset + to use. +\end_layout +\begin_layout Subsection +Bibliography Lists in all Subdocuments \end_layout \begin_layout Standard -\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 +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 Plain Layout -\SpecialChar LyX - doesn't restrict your use since you may be editing locally and exporting - elsewhere. +\begin_layout Standard +For the main document, you just insert a bibliography inset at the place + where the main bibliography has to appear (within the master file or within + a child). + If the bibliography inset is in the master file, the references will be + inherited by all children, so they are available in the citation dialog + within each child. \end_layout +\begin_layout Standard +For child-specific bibliographies, insert bibliography insets within the + child documents, at the place where the bibliography should appear when + the child is compiled separately. + However, the trick is to insert them into a branch ( +\family sans +Insert\SpecialChar menuseparator +Branch\SpecialChar menuseparator +Insert New Branch... +\family default +), e. +\begin_inset space \thinspace{} \end_inset +g. + called +\begin_inset Quotes eld +\end_inset -\end_layout - -\begin_layout Subsection -How to use it -\end_layout +Childonly +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Select which bullet depth you want to change then select the bullet shape - and size. - Any changes will not be visible in \SpecialChar LyX -, but are visible when viewing the document. +. + Within the children, activate the branch ( +\family sans +Document\SpecialChar menuseparator +Settings...\SpecialChar menuseparator +Branches +\family default +). + Within the master, deactivate the branch ( +\family sans +Document\SpecialChar menuseparator +Settings...\SpecialChar menuseparator +Branches +\family default +). + Now the child's bibliography will be ignored by the master, but considered + by the child. \end_layout \begin_layout Standard -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 +If you need multiple bibliographies (e. +\begin_inset space \thinspace{} +\end_inset -\begin_layout Plain Layout -If you +g., one per child in the \emph on -really +main document \emph default - want to have multiple sets of paragraphs with different sets of bullets - in each, then you're going to have to get your hands dirty with \SpecialChar TeX - code. - The bullet selection dialog can help though because it provides you with - the \SpecialChar LaTeX - code for a wide range of bullet shapes. - To make your own custom paragraphs you have the following options: -\end_layout - -\begin_layout Plain Layout -\begin_inset ERT -status open - -\begin_layout Plain Layout +), please refer to sec. +\begin_inset space ~ +\end_inset -\backslash -let -\backslash -savelabelitemi= -\backslash -labelitemi -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Multiple-Bibliographies" \end_inset +. +\end_layout +\begin_layout Section +\SpecialChar LyX + Archives \end_layout -\begin_layout Plain Layout -\begin_inset ERT -status open +\begin_layout Standard +Users sometimes need to be able to +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout +bundle +\begin_inset Quotes erd +\end_inset + a \SpecialChar LyX + file together with all the images (and other files) on which it depends, + either for sending to a publisher or for sharing with a co-author. + \SpecialChar LyX + includes a Python script ( +\begin_inset Flex Code +status collapsed -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -small -\backslash -( -\backslash -sharp -\backslash -)} +\begin_layout Plain Layout +lyxpak.py \end_layout \end_inset - -\end_layout - -\begin_layout Itemize -Use the \SpecialChar LaTeX - command +) that automates this process. + To use it, you must have either the \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -renewcommand{}{} +zipfile \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 - -\backslash -let -\backslash -savelabelitemi= -\backslash -labelitemi -\end_layout - -\begin_layout LyX-Code - -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -small -\backslash -( -\backslash -sharp -\backslash -)} -\end_layout - -\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 + or +\begin_inset Flex Code +status collapsed \begin_layout Plain Layout - - -\backslash -( -\backslash -star -\backslash -) +tarfile \end_layout \end_inset + python modules installed on your system. + By default, the script prefers the +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +gzip \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 - -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 +-compressed +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -\SpecialChar TeX - Code +tar \end_layout \end_inset -. - For example, this item was started with + format on Unix-like systems and the \begin_inset Flex Code status collapsed \begin_layout Plain Layout - -\backslash -( -\backslash -star -\backslash -) +zip \end_layout \end_inset -. + format on Windows. \end_layout -\begin_layout Plain Layout -\begin_inset ERT -status open +\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 - - -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -savelabelitemi} +File\SpecialChar menuseparator +Export \end_layout \end_inset - -\end_layout - -\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 +\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 -\backslash -renewcommand -\backslash -labelitemi[0]{ -\backslash -savelabelitemi} +\begin_layout Plain Layout +-t \end_layout \end_inset - -\end_layout - -\begin_layout Chapter -\SpecialChar LyX - and the World Wide Web -\end_layout - -\begin_layout Standard -\SpecialChar LyX - has long supported the export of documents to various web-friendly formats, - such as HTML. - Before version 2.0, however, HTML export was always accomplished by the - use of external converters. -\begin_inset Foot + (for the +\begin_inset Flex Code 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. +tar \end_layout \end_inset - These fall into two large groups: there are converters that use \SpecialChar LaTeX - as an - intermediate format, such as + format) or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -htlatex +-z \end_layout \end_inset -, + (for the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -html2latex +zip \end_layout \end_inset -, and + format) switch to the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -plastex +\SpecialChar LyX +\SpecialChar menuseparator +\SpecialChar LyX + Archive \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, + converter in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +Converters \end_layout \end_inset . - All of these have different advantages and disadvantages. - + (Make sure you add the switch after the script name, not before it.) +\end_layout + +\begin_layout Section +Fancy Headers and Footers \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 +The default page layout is rather plain; for an \begin_inset Flex Code status collapsed \begin_layout Plain Layout -aux +article \end_layout \end_inset - files, counters, and references, and can often make use of the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -bbl -\end_layout + 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 - files generated by Bib\SpecialChar TeX +, as mentioned in the +\emph on +User Guide +\emph default . - 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 + 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 +For more information on fancy headers, see the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -htlatex +fancyhdr \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. -\end_layout - -\begin_layout Standard -Alex Fernandez's -\begin_inset Flex Code + package documentation. + ( +\begin_inset Flex URL status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er + +https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html \end_layout \end_inset - ( -\begin_inset CommandInset href -LatexCommand href -name "http://pinchito.es/elyxer/" -target "http://pinchito.es/elyxer/" -literal "false" +) +\end_layout +\begin_layout Standard +The page header is divided into three fields, not surprisingly labeled +\begin_inset Quotes eld \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 +left +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -htlatex -\end_layout +, +\begin_inset Quotes eld +\end_inset +center +\begin_inset Quotes erd \end_inset -; this reflects the limitations of HTML. -\begin_inset Foot -status collapsed +, and +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout -That said, +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 -e\SpecialChar LyX -er + +\backslash +lhead \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. +, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +chead \end_layout \end_inset - More importantly (as of version 1.1.1, at least), +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er + +\backslash +rhead \end_layout \end_inset - has limited support for math macros and no support for user-defined paragraph - or character styles. - These limitations make +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -e\SpecialChar LyX -er + +\backslash +lfoot \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. +, etc. + Suppose you wish to put your name in the upper left hand corner of each + page. + Simply insert the following command in the preamble: \end_layout \begin_layout Standard -As of this writing, XHTML output remains under development and should probably - be regarded as -\begin_inset Quotes eld -\end_inset -experimental -\begin_inset Quotes erd +\family typewriter + +\backslash +lhead{John Q. + DocWriter} +\end_layout + +\begin_layout Standard +You will now see your name in the upper left. + If a field has a default entry that you would like to get rid of (often + the page number appears in the central footer) simply include a command + with a blank argument, e. +\begin_inset space \thinspace{} \end_inset -. -\begin_inset Foot -status collapsed +g.: +\end_layout -\begin_layout Plain Layout -The file -\begin_inset Flex Code -status collapsed +\begin_layout Standard -\begin_layout Plain Layout -development/HTML/HTML.notes +\family typewriter + +\backslash +cfoot{} \end_layout +\begin_layout Standard +Let's get really fancy: lets put the section number with the word +\begin_inset Quotes eld \end_inset -, 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" - +Section +\begin_inset Quotes erd \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" + (e. +\begin_inset space \thinspace{} +\end_inset +g. +\begin_inset space \space{} \end_inset -. -\end_layout +Section 3) in the upper left, the page number (e. +\begin_inset space \thinspace{} +\end_inset +g. +\begin_inset space \space{} \end_inset - Still, the developers have chosen this approach because it has several - potential advantages over the other two. +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 -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 -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 +\family typewriter -\end_inset +\backslash +lhead{Section +\backslash +thesection} +\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 +\begin_layout Standard -Chapter 1 -\begin_inset Quotes erd -\end_inset +\family typewriter - or -\begin_inset Quotes eld -\end_inset +\backslash +chead{} +\end_layout +\begin_layout Standard -\lang ngerman -Kapitel -\lang english - 1 -\begin_inset Quotes erd -\end_inset +\family typewriter -, depending upon the language in effect at the time. - +\backslash +rhead{Page +\backslash +thepage} \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. +\family typewriter + +\backslash +lfoot{John Q. + DocWriter} \end_layout \begin_layout Standard -The remainder of this chapter contains more detailed information on XHTML - output, its limitations, and ways to work around those limitations. -\end_layout -\begin_layout Section -Math Output in XHTML +\family typewriter + +\backslash +cfoot{} \end_layout \begin_layout Standard -\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 +\family typewriter -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 +\backslash +rfoot{ +\backslash +today} +\end_layout -If \SpecialChar LyX - is unable to render a formula as MathML—for example, if the formula - uses the +\begin_layout Standard +The commands \begin_inset Flex Code status collapsed \begin_layout Plain Layout -xymatrix + +\backslash +thesection \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 +thepage \end_layout -\begin_layout Itemize -HTML -\begin_inset Newline newline \end_inset -As mentioned above, + 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 -elyxer + +\backslash +today \end_layout \end_inset - outputs math as HTML, styled by CSS. -\begin_inset Foot -status collapsed + simply prints out today's date. +\end_layout -\begin_layout Plain Layout -\SpecialChar LyX - has borrowed some of the CSS for its HTML output from +\begin_layout Standard +The thicknesses of the horizontal rules drawn beneath the header and above + the footer can also be modified. + If you don't want one of the rules, set its thickness to 0. + The header rule has a default thickness of 0.4pt, the footer rule is 0pt. + Use commands +\family typewriter + +\family default +like \begin_inset Flex Code status collapsed \begin_layout Plain Layout -elyxer + +\backslash +renewcommand{ +\backslash +headrulewidth}{0.4pt} \end_layout \end_inset -. + and +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\backslash +renewcommand{ +\backslash +footrulewidth}{0.4pt} \end_layout \end_inset - For simple formulae, this can work quite well, though with more complicated - formulae it tends to break down. - Still, this method has the advantage that it is very widely supported and - so it may be appropriate for documents that contain only a little, fairly - simple math. -\begin_inset Newline newline -\end_inset + to set the thicknesses. +\end_layout -If Lyx is unable to render a formula as HTML—for example, if the formula - uses the +\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 -xymatrix -\end_layout - -\end_inset - package or ERT—then it will instead output the formula as an image. - +\backslash +thispagestyle{empty} \end_layout -\begin_layout Itemize -Images -\begin_inset Newline newline \end_inset -Like +, \begin_inset Flex Code status collapsed \begin_layout Plain Layout -htlatex + +\backslash +thispagestyle{plain} \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 +, and +\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. + +\backslash +thispagestyle{fancy} \end_layout \end_inset - The advantage to this method is that the images are simply generated by - \SpecialChar LaTeX -, so they are very accurate. - The disadvantage, as mentioned earlier, is that these are bitmapped images, - so they do not scale terribly well, and one cannot copy them, etc. -\begin_inset Newline newline -\end_inset +. + 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 -The size of the images can be controlled by setting the -\begin_inset Quotes eld -\end_inset +\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 -Math Images Scaling -\begin_inset Quotes erd -\end_inset +\begin_layout Standard - parameter under -\begin_inset Flex Noun -status collapsed +\family typewriter -\begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Formats +\backslash +lhead{ +\backslash +resizebox{1in}{!}{ +\backslash +includegraphics{logo.eps}}} \end_layout -\end_inset - -. -\begin_inset Foot +\begin_layout Standard +\noindent +(you may need to preface this with +\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 +usepackage{graphics} \end_layout \end_inset + if you don't include graphics elsewhere in your document). +\end_layout + +\begin_layout Section +Itemize Bullet Selection +\begin_inset CommandInset label +LatexCommand label +name "sec:bullet" -\begin_inset Newline newline \end_inset -If \SpecialChar LyX - for some reason fails to create an image for a formula (e.g., if a required - \SpecialChar LaTeX - package is not installed), then it will fall back to outputing the raw - \SpecialChar LaTeX -. + \end_layout -\begin_layout Itemize -\SpecialChar LaTeX - -\begin_inset Newline newline -\end_inset - -Finally, \SpecialChar LyX - will happily output math as \SpecialChar LaTeX -. - As well as being the output of last resort, this method can be used with - such tools as -\begin_inset CommandInset href -LatexCommand href -name "jsMath" -target "http://www.math.union.edu/~dpvc/jsMath/" -literal "false" - -\end_inset - -, 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 -span +\begin_layout Standard +by +\noun on + Allan Rae \end_layout -\end_inset +\begin_layout Subsection +Introduction +\end_layout - (for inline formulas) or -\begin_inset Flex Code +\begin_layout Standard +\SpecialChar LyX + provides 216 bullet shapes that can be accessed from a simple dialog. + Using this dialog you can easily specify what bullet shape to use at each + level of an itemized list. + These settings are document-wide so you won't be able to specify different + sets of bullets for different paragraphs. +\begin_inset Foot status collapsed \begin_layout Plain Layout -div +Well, actually you can but you'll have to do it by hand. \end_layout \end_inset - (for displayed formulas) with -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -class='math' \end_layout -\end_inset - -, as is required for jsMath. +\begin_layout Subsection +How it looks \end_layout \begin_layout Standard -One of these output methods must be selected under +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 -. - By default, \SpecialChar LyX - outputs MathML. - This is a document-wide setting, therefore. -\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 + menu item and then select the +\begin_inset Flex Noun 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 - -. +Bullets \end_layout \end_inset - -\end_layout - -\begin_layout Section -Bibliography and Citations + tab. \end_layout \begin_layout Standard -XHTML output fully supports bibliographies and citations. - -\end_layout +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 -\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 -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. +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 -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: +\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 \end_layout -\begin_layout Quote -Jason Stanley, -\begin_inset Quotes eld \end_inset + + +\begin_inset Text -Context and Logical Form -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout -, in -\emph on -Language in Context: Selected Essays -\emph default - (Oxford: Oxford University Press, 2007), pp. - 30–68. +\family roman +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Packages Required \end_layout -\begin_layout Quote -Jason Stanley, -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text -Semantics in Context -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout -, in -\emph on -Language in Context: Selected Essays -\emph default - (Oxford: Oxford University Press, 2007), pp. - 201–30. +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Standard \end_layout -\begin_layout Standard -This should be fixed before long. -\end_layout +\end_inset + + +\begin_inset Text -\begin_layout Standard -There is no support at present for sectioned bibliographies. - If you have multiple bibliographies, then \SpecialChar LyX - will print the same bibliography - over and over. -\end_layout +\begin_layout Plain Layout -\begin_layout Section -Indexes -\end_layout +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +base \SpecialChar LaTeX -\begin_layout Standard -\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 -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_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Maths \end_layout \end_inset + + +\begin_inset Text - We'll describe how they are handled using the subsection headings from - that section. +\begin_layout Plain Layout + +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +amssymb.sty \end_layout -\begin_layout Itemize -Grouping Index Entries (aka, sub-entries): \SpecialChar LyX - makes an effort to support these, - but the entries must be separated by -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text - ! -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout -, 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. +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding1 \end_layout -\begin_layout Itemize -Page Ranges: There is no support at all for page ranges, since these make - no sense with XHMTL. - Instead, you will just get two index entries, one at either end. +\end_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 -\begin_layout Itemize -Cross-referencing: There is no support for cross-referencing. - If \SpecialChar LyX - finds an entry containing the -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text -|see\SpecialChar ldots +\begin_layout Plain Layout + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding2 +\end_layout -\begin_inset Quotes erd \end_inset + + +\begin_inset Text - construct, it is just dropped, and the rest is treated as an ordinary index - entry. -\end_layout +\begin_layout Plain 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. +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout -\begin_layout Itemize -Index Entry Layout: You can format entries by using the text style dialog, - or by using any other method available within \SpecialChar LyX - itself. - There is no support for constructs like: -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text -entry|textbf -\begin_inset Quotes erd -\end_inset +\begin_layout Plain Layout -. - Indeed, if \SpecialChar LyX - finds a pipe symbol, `|', in an entry, it will delete it and - everything that follows it. +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding3 \end_layout -\begin_layout Itemize -Multiple Indexes: There is no support for multiple indexes. - Rather, all index entries will be printed as one large index. - To avoid our printing several versions of the index, we print only the - main index, so make sure you have one. -\end_layout +\end_inset + + +\begin_inset Text -\begin_layout Section -Nomenclature and Glossary -\end_layout +\begin_layout Plain Layout -\begin_layout Standard -There is at present no support for glossaries. - Adding it would be fairly trivial, and welcome. +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \end_layout -\begin_layout Chapter +\end_inset + + + + +\begin_inset Text -\change_inserted 1075283030 1616534180 -DocBook Output +\begin_layout Plain Layout + +\family sans +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +Ding4 \end_layout -\begin_layout Standard +\end_inset + + +\begin_inset Text -\change_inserted 1075283030 1616534386 -Apart from HTML, \SpecialChar LyX - can generate documents in the DocBook XML vocabulary. - With versions 2.3 and before, only select templates could be used to generate - DocBook documents (only version 4). - Starting with \SpecialChar LyX - 2.4, most \SpecialChar LyX - layouts can generate valid DocBook documents (only - version 5). - This feature is built into \SpecialChar LyX - and does not require the use of external tools. +\begin_layout Plain Layout + +\family typewriter +\series medium +\shape up +\size normal +\emph off +\bar no +\noun off +\color none +pifont.sty \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. -\end_layout +\end_inset -\begin_layout Standard -\change_inserted 1075283030 1616534475 -Most \SpecialChar LyX - features are supported with DocBook, like math output. -\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. -\end_layout - -\begin_layout Itemize - -\change_inserted 1075283030 1616534852 -Bibliographies and citations are implemented, including with an external - BibTeX file. - Bibliography entries are not prerendered when the detailed information - are available, but rather output with the standard DocBook constructs. - The external DocBook processor is expected to handle the rendering of entries. -\end_layout - -\begin_layout 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 Itemize - -\change_inserted 1075283030 1616534884 -Glossaries are implemented. \end_layout \begin_layout Standard +\SpecialChar LyX + doesn't stop you using bullets from packages you don't have. + If you get errors from \SpecialChar LaTeX + when you try to view or print the file, then it + is likely you are missing a package. +\begin_inset Foot +status collapsed -\change_inserted 1075283030 1616534894 -Two major parameters can be set at the document level. -\end_layout - -\begin_layout Itemize - -\change_inserted 1075283030 1616534948 -Format for tables: \SpecialChar LyX - can generate tables either as HTML (default value) or - CALS, depending on the user's requirements. - Most DocBook processors accept both formats. +\begin_layout Plain Layout +\SpecialChar LyX + doesn't restrict your use since you may be editing locally and exporting + elsewhere. \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: -\end_layout +\end_inset -\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) \end_layout -\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 +\begin_layout Subsection +How to use it \end_layout -\begin_layout Itemize - -\change_inserted 1075283030 1616620405 -With the -\family typewriter -mml -\family default - prefix: similar to the -\family typewriter -m -\family default - option, but with -\family typewriter -mml +\begin_layout Standard +Select which bullet depth you want to change then select the bullet shape + and size. + Any changes will not be visible in \SpecialChar LyX +, but are visible when viewing the document. \end_layout \begin_layout Standard +You can reset a bullet shape to the default simply by clicking your right + mouse button on the appropriate bullet depth button. +\begin_inset Foot +status open -\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 +\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 -\begin_layout Section -Introduction -\end_layout +\begin_layout Plain Layout +\begin_inset ERT +status open -\begin_layout Standard -The `\SpecialChar LyX - server' allows other programs to talk to \SpecialChar LyX -, invoke \SpecialChar LyX - commands, and retrieve - information about the \SpecialChar LyX - internal state. - This is only intended for advanced users, but they should find it useful. - It is by writing to the \SpecialChar LyX - server, for example, that bibliography managers, - such as JabRef, are able to -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout -push -\begin_inset Quotes erd -\end_inset - citations to \SpecialChar LyX -. +\backslash +let +\backslash +savelabelitemi= +\backslash +labelitemi \end_layout -\begin_layout Section -Starting the \SpecialChar LyX - Server -\begin_inset CommandInset label -LatexCommand label -name "sec:Starting-the-Server" - \end_inset \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 -UserDir -\end_layout - -\end_inset - -, (except on Windows, where -\emph on -local -\emph default - named pipes are special objects located in -\begin_inset Flex Code -status collapsed +\begin_inset ERT +status open \begin_layout Plain Layout -\backslash \backslash -. +renewcommand \backslash -pipe +labelitemi[0]{ +\backslash +small +\backslash +( +\backslash +sharp +\backslash +)} \end_layout \end_inset -) and have the names -\begin_inset Quotes eld -\end_inset +\end_layout +\begin_layout Itemize +Use the \SpecialChar LaTeX + command \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxpipe.in + +\backslash +renewcommand{}{} \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_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset +\begin_deeper +\begin_layout LyX-Code +\backslash +let +\backslash +savelabelitemi= +\backslash +labelitemi +\end_layout -\begin_inset Flex Code -status collapsed +\begin_layout LyX-Code -\begin_layout Plain Layout -lyxpipe.out +\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_inset Quotes erd -\end_inset +\begin_layout Itemize +\begin_inset Argument item:1 +status open -. - External programs write into -\begin_inset Flex Code -status collapsed +\begin_layout Plain Layout +\begin_inset ERT +status open \begin_layout Plain Layout -lyxpipe.in + + +\backslash +( +\backslash +star +\backslash +) \end_layout \end_inset - and read back data from -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -lyxpipe.out \end_layout \end_inset -. - The stem of the pipe names can be defined in the + Specify each individual entry by starting each item with the bullet shape + enclosed in a +\begin_inset Quotes eld +\end_inset + +Custom Item +\begin_inset Quotes erd +\end_inset + + inset (available at +\family sans +Insert\SpecialChar menuseparator +Custom Item +\family default +) and set as \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences +\SpecialChar TeX + Code \end_layout \end_inset - dialog, for example +. + For example, this item was started with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -"/home/myhome/lyxpipe" + +\backslash +( +\backslash +star +\backslash +) \end_layout \end_inset -, or -\begin_inset Flex Code -status collapsed +. +\end_layout \begin_layout Plain Layout -" -\backslash +\begin_inset ERT +status open + +\begin_layout Plain Layout + \backslash -. +renewcommand \backslash -pipe +labelitemi[0]{ \backslash -lyxpipe" +savelabelitemi} \end_layout \end_inset - on Windows (where any working path instead of lyxpipe can be used, for - example -\begin_inset Flex Code -status collapsed + +\end_layout \begin_layout Plain Layout -" -\backslash +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 -. -\backslash -pipe -\backslash -my +renewcommand \backslash -lyx +labelitemi[0]{ \backslash -pipe" +savelabelitemi} \end_layout \end_inset - would also work). - You -\emph on -must -\emph default - configure this manually in order for the server to start. + +\end_layout + +\begin_layout Chapter +\SpecialChar LyX + and the World Wide Web \end_layout \begin_layout Standard \SpecialChar LyX - will add the ' -\begin_inset Flex Code + 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 -.in +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 -' and ' + 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 -.out +htlatex \end_layout \end_inset -' to create the pipes. - If one of the pipes already exists, \SpecialChar LyX - will assume that another \SpecialChar LyX - process - is already running and will not start the server. - On POSIX (Unix like) systems, if for some other reason, an unused -\begin_inset Quotes eld -\end_inset - -stale -\begin_inset Quotes erd -\end_inset +, +\begin_inset Flex Code +status collapsed - 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 +\begin_layout Plain Layout +html2latex +\end_layout -stale -\begin_inset Quotes erd \end_inset - pipes should not be possible. -\end_layout - -\begin_layout Standard -To have several \SpecialChar LyX - processes with servers at the same time, you have to use - different configurations, perhaps by using separate user directories, each - with its own +, and \begin_inset Flex Code status collapsed \begin_layout Plain Layout -preferences +plastex \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 +, 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 -lyx -dbg lyxserver +e\SpecialChar LyX +er \end_layout \end_inset . + All of these have different advantages and disadvantages. + \end_layout \begin_layout Standard -You can find a complete example client written in C++ in the source distribution - as +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 -development/lyxserver/server_monitor.cpp +aux \end_layout \end_inset -. -\end_layout - -\begin_layout Standard -Another useful tool is the command-line based client found in + files, counters, and references, and can often make use of the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -src/client/lyxclient +bbl \end_layout \end_inset + files generated by Bib\SpecialChar TeX . -\end_layout - -\begin_layout Section -Normal communication -\end_layout - -\begin_layout Standard -To issue a \SpecialChar LyX - call, the client writes a line of ASCII text into the input - pipe. - This line has the following format: -\end_layout - -\begin_layout Quote -LYXCMD: -\emph on -clientname -\emph default -: + 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 -function +Embedded Objects \emph default -: -\emph on -argument -\end_layout - -\begin_layout Description -clientname is a name that the client can choose arbitrarily. - Its only use is that \SpecialChar LyX - will echo it if it sends an answer—so a client can - dispatch results from different requesters. -\end_layout + manual will not export with +\begin_inset Flex Code +status collapsed -\begin_layout Description -function is the function you want \SpecialChar LyX - to perform. - It is the same as the commands you'd use in the minibuffer. +\begin_layout Plain Layout +htlatex \end_layout -\begin_layout Description -argument is an optional argument which is meaningful only to some functions - (for instance, the -\begin_inset Quotes eld -\end_inset - -self-insert -\begin_inset Quotes erd \end_inset - LFUN will insert the argument as text at the cursor position). +, 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 -The answer from \SpecialChar LyX - will arrive in the output pipe and be of the form -\end_layout +Alex Fernandez's +\begin_inset Flex Code +status collapsed -\begin_layout Quote -INFO: -\emph on -clientname -\emph default -: -\emph on -function -\emph default -: -\emph on -data +\begin_layout Plain Layout +e\SpecialChar LyX +er \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 + ( +\begin_inset CommandInset href +LatexCommand href +name "http://pinchito.es/elyxer/" +target "http://pinchito.es/elyxer/" +literal "false" + \end_inset -, will return information about the internal state of \SpecialChar LyX -, while other will - return an empty data-response. - This means that the command execution went fine. -\end_layout +) 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 Standard -In case of errors, the response from \SpecialChar LyX - will have this form +\begin_layout Plain Layout +htlatex \end_layout -\begin_layout Quote -ERROR: -\emph on -clientname -\emph default -: -\emph on -function -\emph default -: -\emph on -error message -\end_layout +\end_inset -\begin_layout Standard -where the -\emph on -error message -\emph default - should contain an explanation of why the command failed. -\end_layout +; this reflects the limitations of HTML. +\begin_inset Foot +status collapsed -\begin_layout Standard -Examples: +\begin_layout Plain Layout +That said, +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout -\begin_layout LyX-Code -echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in -\begin_inset Newline newline \end_inset -echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in -\begin_inset Newline newline -\end_inset + 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 -read a <~/.lyxpipe.out -\begin_inset Newline newline \end_inset -echo $a -\end_layout + More importantly (as of version 1.1.1, at least), +\begin_inset Flex Code +status collapsed -\begin_layout Subsection -AppleScript (Mac OS X) +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout -\begin_layout Standard -Since \SpecialChar LyX - 2.1, \SpecialChar LyX - supports basic interactions with AppleScript for normal communicatio -n through the command run. - This command takes a direct argument (the -\series bold -function -\series default - to perform) and an optional argument. - It either returns the output of the function or triggers an error with - the error message and code. -\end_layout +\end_inset -\begin_layout Standard -Example: -\end_layout + 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 LyX-Code -tell application "\SpecialChar LyX -" +\begin_layout Plain Layout +e\SpecialChar LyX +er \end_layout -\begin_layout LyX-Code - try -\end_layout +\end_inset -\begin_layout LyX-Code - -- Stores the current file name into f + 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 LyX-Code - set f to (run "server-get-filename" with argument "") -\end_layout +\begin_layout Standard +As of this writing, XHTML output remains under development and should probably + be regarded as +\begin_inset Quotes eld +\end_inset -\begin_layout LyX-Code - on error the error_message number the error_number -\end_layout +experimental +\begin_inset Quotes erd +\end_inset -\begin_layout LyX-Code - display dialog "Error: " & the error_number & ". - " ¬ -\end_layout +. +\begin_inset Foot +status collapsed -\begin_layout LyX-Code - & the error_message buttons {"OK"} default button 1 -\end_layout +\begin_layout Plain Layout +The file +\begin_inset Flex Code +status collapsed -\begin_layout LyX-Code - end try +\begin_layout Plain Layout +development/HTML/HTML.notes \end_layout -\begin_layout LyX-Code -end tell -\end_layout +\end_inset -\begin_layout Section -Notification -\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" -\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 -notify -\begin_inset Quotes erd +, 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 . - The format of the string \SpecialChar LyX - sends is as follows: \end_layout -\begin_layout Quote -\begin_inset Flex Code +\end_inset + + Still, the developers have chosen this approach because it has several + potential advantages over the other two. +\end_layout + +\begin_layout Standard +These advantages are primarily due to the fact that the XHTML output routines, + since they are part of \SpecialChar LyX +, know everything \SpecialChar LyX + knows about the document being + exported. +\begin_inset Foot status collapsed \begin_layout Plain Layout -NOTIFY: +Another advantage is that, since these routines are internal to \SpecialChar LyX +, they are + immune to changes in \SpecialChar LyX +'s file format, or to changes in the semantics of + existing insets. \end_layout \end_inset + So they know about the table of contents (as displayed in the outline), + about the counters associated with different paragraph styles, and about + user-defined styles. + The XHTML output routines know what \SpecialChar LyX + knows about internationalization, + too, so they will output +\begin_inset Quotes eld +\end_inset -\emph on -key-sequence -\end_layout - -\begin_layout Standard -where -\emph on -key-sequence -\emph default - is the printed representation of the key sequence that was actually typed - by the user. -\end_layout +Chapter 1 +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -This mechanism can be used to extend \SpecialChar LyX -'s command set and implement macros. - Bind some key sequence to + or \begin_inset Quotes eld \end_inset -notify + +\lang ngerman +Kapitel +\lang english + 1 \begin_inset Quotes erd \end_inset -. - Then start a client that listens on the output pipe, dispatches the command - according to the sequence, and starts a function that may use \SpecialChar LyX - calls and - \SpecialChar LyX - requests to issue a command or a series of commands to \SpecialChar LyX -. -\end_layout - -\begin_layout Section -The simple \SpecialChar LyX - Server Protocol +, depending upon the language in effect at the time. + \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: +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 -clientname +automatically \emph default -: -\emph on -protocol message + 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 -where +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 -protocol message +Customization \emph default - can be -\begin_inset Quotes eld -\end_inset +manual for the details. +\end_layout -hello -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +The remainder of this chapter contains more detailed information on XHTML + output, its limitations, and ways to work around those limitations. +\end_layout - or -\begin_inset Quotes eld -\end_inset +\begin_layout Section +Math Output in XHTML +\end_layout -bye -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +\SpecialChar LyX + offers four choices for how math is rendered. + These have various advantages and disadvantages: +\end_layout -. - If -\begin_inset Quotes eld +\begin_layout Itemize +MathML +\begin_inset Newline newline \end_inset -hello -\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 - 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 +If \SpecialChar LyX + is unable to render a formula as MathML—for example, if the formula + uses the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +xymatrix +\end_layout -bye -\begin_inset Quotes erd \end_inset - sent from \SpecialChar LyX - will inform clients that \SpecialChar LyX - is closing. + package or ERT—then it will instead output the formula as an image. + \end_layout -\begin_layout Section -Reverse DVI/PDF search -\end_layout +\begin_layout Itemize +HTML +\begin_inset Newline newline +\end_inset -\begin_layout Standard -Some DVI/PDF viewers -\begin_inset Foot +As mentioned above, +\begin_inset Flex Code 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. +elyxer \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 + outputs math as HTML, styled by CSS. +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +\SpecialChar LyX + has borrowed some of the CSS for its HTML output from \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxclient +elyxer \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 + For simple formulae, this can work quite well, though with more complicated + formulae it tends to break down. + Still, this method has the advantage that it is very widely supported and + so it may be appropriate for documents that contain only a little, fairly + simple math. +\begin_inset Newline newline \end_inset +If Lyx is unable to render a formula as HTML—for example, if the formula + uses the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +xymatrix +\end_layout + +\end_inset + package or ERT—then it will instead output the formula as an image. + \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" +\begin_layout Itemize +Images +\begin_inset Newline newline \end_inset -. - Alternatively, you can also enable the feature by checking -\family sans -Synchronize with Output -\family default - in -\begin_inset Flex Noun +Like +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Formats +htlatex \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 +, \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/Update +Instant preview does +\emph on +not +\emph default +have to be on for images to be output, however. \end_layout \end_inset - Toolbar. -\end_layout + The advantage to this method is that the images are simply generated by + \SpecialChar LaTeX +, so they are very accurate. + The disadvantage, as mentioned earlier, is that these are bitmapped images, + so they do not scale terribly well, and one cannot copy them, etc. +\begin_inset Newline newline +\end_inset -\begin_layout Standard -If you need a different setting, you can select or input a custom macro - from the drop down box just below +The size of the images can be controlled by setting the +\begin_inset Quotes eld +\end_inset + +Math Images Scaling +\begin_inset Quotes erd +\end_inset + + parameter under \begin_inset Flex Noun status collapsed \begin_layout Plain Layout Document\SpecialChar menuseparator Settings\SpecialChar menuseparator -Output\SpecialChar menuseparator -Synchronize with Output +Formats \end_layout \end_inset . -\end_layout - -\begin_layout Standard -Note that the method -\begin_inset Flex Code +\begin_inset Foot status collapsed \begin_layout Plain Layout - -\backslash -synctex=1 +For those who want to know, this controls the resolution of the image in + dots per inch and is based upon a default of 75 dpi. \end_layout \end_inset - enables gzip compression. - If your viewer does not support it, you should instead use -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -synctex=-1 -\end_layout +\begin_inset Newline newline \end_inset +If \SpecialChar LyX + for some reason fails to create an image for a formula (e.g., if a required + \SpecialChar LaTeX + package is not installed), then it will fall back to outputing the raw + \SpecialChar LaTeX . \end_layout -\begin_layout Standard -Please also note that including the -\begin_inset Flex Code -status collapsed +\begin_layout Itemize +\SpecialChar LaTeX -\begin_layout Plain Layout -srcltx -\end_layout +\begin_inset Newline newline +\end_inset + +Finally, \SpecialChar LyX + will happily output math as \SpecialChar LaTeX +. + As well as being the output of last resort, this method can be used with + such tools as +\begin_inset CommandInset href +LatexCommand href +name "jsMath" +target "http://www.math.union.edu/~dpvc/jsMath/" +literal "false" \end_inset - package or +, 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 -src-specials +span \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 + (for inline formulas) or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -srcltx +div \end_layout \end_inset - package or + (for displayed formulas) with \begin_inset Flex Code status collapsed \begin_layout Plain Layout -src-specials +class='math' \end_layout \end_inset -. - +, as is required for jsMath. \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 - +One of these output methods must be selected under +\begin_inset Flex Noun +status collapsed -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:configuring-viewers" +\begin_layout Plain Layout +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Formats +\end_layout \end_inset -, where the necessary configuration steps in your viewer – needed both with - the automatic and the manual setup – are described. -\end_layout - -\begin_layout Subsection -Manual setup +. + By default, \SpecialChar LyX + outputs MathML. + This is a document-wide setting, therefore. \end_layout \begin_layout Standard -\SpecialChar LaTeX - provides several different methods for reverse search. - Some are built-in in the -\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 -latex/pdflatex +That said, since \SpecialChar LyX + falls back to images if the inset contains ERT, then one + can force output as an image by putting some harmless ERT into the math, + for example: +\begin_inset Formula $a=b\relax$ +\end_inset + +. \end_layout \end_inset - program, some are provided by external packages. - Your choice depends on whether your \SpecialChar LaTeX - distribution already provides a given - method (the built-in methods are rather new) and whether your viewer can - cope with it. - The available methods are described in the following. + \end_layout -\begin_layout Subsubsection* -Built-in DVI-search via src-specials (DVI only) +\begin_layout Section +Bibliography and Citations \end_layout \begin_layout Standard -This method provides the DVI file with the necessary information for reverse - search. - It is available in \SpecialChar LaTeX - since quite some time (any somewhat recent \SpecialChar LaTeX - distribution - should include it), and it works reliably. - To enable it, change the -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -La -\family sans -TeX -\family default - (plain)->DVI +XHTML output fully supports bibliographies and citations. + \end_layout -\end_inset - - or -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -La -\family sans -TeX -\family default - (plain)->DraftDVI +\begin_layout 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 +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 +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 - converter 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 -Converters +, 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 - to -\begin_inset Flex Code -status collapsed +Semantics in Context +\begin_inset Quotes erd +\end_inset -\begin_layout Plain Layout -latex -src-specials $$i +, in +\emph on +Language in Context: Selected Essays +\emph default + (Oxford: Oxford University Press, 2007), pp. + 201–30. \end_layout -\end_inset +\begin_layout Standard +This should be fixed before long. +\end_layout -. - If this doesn't work, check if your \SpecialChar TeX - engine needs different options (the - syntax might differ in some distributions). +\begin_layout Standard +There is no support at present for sectioned bibliographies. + If you have multiple bibliographies, then \SpecialChar LyX + will print the same bibliography + over and over. \end_layout -\begin_layout Subsubsection* -External Packages (PDFSync and scrltx) +\begin_layout Section +Indexes \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: +\SpecialChar LyX + will happily export indexes as XHTML, but with certain limitations at the + moment. \end_layout -\begin_layout Itemize -\begin_inset Flex Code +\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 - -\backslash -usepackage{pdfsync} +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 - for reverse PDF search, + We'll describe how they are handled using the subsection headings from + that section. \end_layout \begin_layout Itemize -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout - -\backslash -usepackage[active]{srcltx} -\end_layout +Grouping Index Entries (aka, sub-entries): \SpecialChar LyX + makes an effort to support these, + but the entries must be separated by +\begin_inset Quotes eld +\end_inset + ! +\begin_inset Quotes erd \end_inset - for reverse DVI search. +, 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 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 +\begin_layout Itemize +Page Ranges: There is no support at all for page ranges, since these make + no sense with XHMTL. + Instead, you will just get two index entries, one at either end. \end_layout -\begin_layout LyX-Code - -\backslash -usepackage{ifpdf} -\begin_inset Newline newline +\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 +|see\SpecialChar ldots -\backslash -ifpdf -\begin_inset Newline newline +\begin_inset Quotes erd \end_inset - -\backslash -usepackage{pdfsync} -\begin_inset Newline newline -\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 -\backslash -else -\begin_inset Newline newline +\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 - -\backslash -usepackage[active]{srcltx} -\begin_inset Newline newline +entry|textbf +\begin_inset Quotes erd \end_inset +. + Indeed, if \SpecialChar LyX + finds a pipe symbol, `|', in an entry, it will delete it and + everything that follows it. +\end_layout -\backslash -fi +\begin_layout Itemize +Multiple Indexes: There is no support for multiple indexes. + Rather, all index entries will be printed as one large index. + To avoid our printing several versions of the index, we print only the + main index, so make sure you have one. \end_layout -\begin_layout Standard -This way, you can preview the file as either DVI or PDF (pdflatex) and the - right package will be used. +\begin_layout Section +Nomenclature and Glossary \end_layout \begin_layout Standard -Note that PDFSync might affect the output layout of your document. - It is therefore advised to disable PDFsync for final documents. +There is at present no support for glossaries. + Adding it would be fairly trivial, and welcome. \end_layout -\begin_layout Subsubsection* -Built-in reverse search via Sync\SpecialChar TeX - (DVI and PDF) +\begin_layout Chapter + +\change_inserted 1075283030 1616534180 +DocBook Output \end_layout \begin_layout Standard -Recent versions of -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -(pdf)latex +\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 - have built-in support for both PDF and DVI reverse search. - This so-called +\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 -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 +Customization \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. +manual for the details. \end_layout -\begin_layout Plain Layout -The generation of the required info can be forced by changing the converter - "\SpecialChar LaTeX - (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters - from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding - the -synctex=1 switch). +\begin_layout Standard + +\change_inserted 1075283030 1616534475 +Most \SpecialChar LyX + features are supported with DocBook, like math output. \end_layout -\end_inset +\begin_layout Itemize - 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. +\change_inserted 1075283030 1616534741 +Math output is performed mostly in MathML (the major exception being constructio +ns not supported by \SpecialChar LyX +, i.e. + ERTs). + All formulae are also available in raw \SpecialChar TeX + in the DocBook output for further + processing. \end_layout -\begin_layout Standard -To enable Sync\SpecialChar TeX - for DVI output, change the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -La -\family sans -TeX -\family default - (plain) -> DVI +\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 -\end_inset - - or -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -La -\family sans -TeX +\change_inserted 1075283030 1616534863 +Indexes are supported, including multiple indices. + Grouping (with +\family typewriter +! \family default - (plain) -> DraftDVI +), 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 - - converter in -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -Converters +\change_inserted 1075283030 1616534884 +Glossaries are implemented. \end_layout -\end_inset - - to -\begin_inset Flex Code -status collapsed +\begin_layout Standard -\begin_layout Plain Layout -latex -synctex=1 $$i +\change_inserted 1075283030 1616534894 +Two major parameters can be set at the document level. \end_layout -\end_inset - -, and for PDF output, change the -\begin_inset Flex Noun -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout -La -\family sans -TeX -\family default - (pdflatex) -> 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 +\begin_layout Itemize - converter to -\begin_inset Flex Code -status collapsed +\change_inserted 1075283030 1616535006 +MathML prefix: in DocBook, MathML is included within its own name space, + unlike HTML. + The implication is that there must be an indication of the tags belonging + to the MathML standard. + Three choices are offered: +\end_layout -\begin_layout Plain Layout -pdflatex -synctex=1 $$i +\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) \end_layout -\end_inset +\begin_layout Itemize -. - 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 +\change_inserted 1075283030 1616535090 +With the +\family typewriter +m +\family default + prefix (default): the MathML name space is defined at the document level + (using the +\family typewriter +xmlns:m +\family default + attribute on the root element). + Each MathML is prefixed with +\family typewriter +m +\family default +: for instance, +\family typewriter +m:math +\end_layout -\begin_layout Plain Layout -Note that the option -\begin_inset Flex Code -status collapsed +\begin_layout Itemize -\begin_layout Plain Layout --synctex=1 +\change_inserted 1075283030 1616620405 +With the +\family typewriter +mml +\family default + prefix: similar to the +\family typewriter +m +\family default + option, but with +\family typewriter +mml \end_layout -\end_inset +\begin_layout Standard - option enables gzip compression. - If your viewer does not support it, you should instead use -\begin_inset Flex Code -status collapsed +\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 -\begin_layout Plain Layout --synctex=-1 \end_layout -\end_inset +\end_deeper +\begin_layout Chapter +The \SpecialChar LyX + Server +\end_layout -. +\begin_layout Section +Introduction \end_layout +\begin_layout Standard +The `\SpecialChar LyX + server' allows other programs to talk to \SpecialChar LyX +, invoke \SpecialChar LyX + commands, and retrieve + information about the \SpecialChar LyX + internal state. + This is only intended for advanced users, but they should find it useful. + It is by writing to the \SpecialChar LyX + server, for example, that bibliography managers, + such as JabRef, are able to +\begin_inset Quotes eld \end_inset +push +\begin_inset Quotes erd +\end_inset + citations to \SpecialChar LyX +. \end_layout -\begin_layout Subsection -Configuring and using specific viewers +\begin_layout Section +Starting the \SpecialChar LyX + Server \begin_inset CommandInset label LatexCommand label -name "subsec:configuring-viewers" +name "sec:Starting-the-Server" \end_inset \end_layout -\begin_layout Subsubsection* -Xdvi (all platforms) -\end_layout - \begin_layout Standard -If you use +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 -xdvi +UserDir \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 +, (except on Windows, where +\emph on +local +\emph default + named pipes are special objects located in \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxclient -\end_layout -\end_inset +\backslash - program. - Just setup your document as described above (reverse search is triggered - by Ctrl-click or Alt-click on Mac OSX, respectively). +\backslash +. +\backslash +pipe \end_layout -\begin_layout Standard -However, if for whatever reason you want to use the named pipe instead of - the socket for communicating with \SpecialChar LyX -, simply change the DVI viewer in -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats -\end_layout +\end_inset +) and have the names +\begin_inset Quotes eld \end_inset - to -\begin_inset Foot -status collapsed -\begin_layout Plain Layout -On Mac OSX you have to use \begin_inset Flex Code status collapsed \begin_layout Plain Layout -DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l" +lyxpipe.in \end_layout \end_inset -\end_layout - +\begin_inset Quotes erd \end_inset - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -xdvi -editor "lyxeditor.sh %f %l" -\end_layout - + and +\begin_inset Quotes eld \end_inset -, where + \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.sh +lyxpipe.out \end_layout \end_inset - 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 +\begin_inset Quotes erd \end_inset -LYXPIPE="/path/to/lyxpipe" -\begin_inset Newline newline -\end_inset +. + External programs write into +\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 +lyxpipe.in +\end_layout -echo "$COMMAND" > "${LYXPIPE}".in || exit -\begin_inset Newline newline \end_inset -read TMP < "${LYXPIPE}".out || exit -\end_layout - -\begin_layout Standard -where + and read back data from \begin_inset Flex Code status collapsed \begin_layout Plain Layout -/path/to/lyxpipe +lyxpipe.out \end_layout \end_inset - is the LyXServer pipe path specified in +. + The stem of the pipe names can be defined in the \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Preferences\SpecialChar menuseparator -Paths +Tools\SpecialChar menuseparator +Preferences \end_layout \end_inset -. -\begin_inset Foot + dialog, for example +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -In the +"/home/myhome/lyxpipe" +\end_layout + +\end_inset + +, or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -development/tools +" +\backslash + +\backslash +. +\backslash +pipe +\backslash +lyxpipe" \end_layout \end_inset - folder of a source distribution you can find a + on Windows (where any working path instead of lyxpipe can be used, for + example \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor +" +\backslash + +\backslash +. +\backslash +pipe +\backslash +my +\backslash +lyx +\backslash +pipe" \end_layout \end_inset - script which is able to locate the + would also work). + You \emph on -lyxpipe +must \emph default - based on your preferences. + configure this manually in order for the server to start. \end_layout -\end_inset - +\begin_layout Standard +\SpecialChar LyX + will add the ' +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +.in \end_layout -\begin_layout Subsubsection* -MacDviX (Mac OSX) -\end_layout +\end_inset -\begin_layout Standard -At the end of +' and ' \begin_inset Flex Code status collapsed \begin_layout Plain Layout -/Applications/MacDviX_Folder/calleditor.script +.out \end_layout \end_inset -, add the following lines: -\end_layout - -\begin_layout LyX-Code -/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1 -\begin_inset Newline newline +' 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 -exit 1 -\end_layout +stale +\begin_inset Quotes erd +\end_inset -\begin_layout Standard -Modify the lines accordingly if you install \SpecialChar LyX - somewhere else than in the - Applications folder. -\end_layout + 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 -\begin_layout Standard -Reverse search is triggered by Alt-click (OPTION-click). -\end_layout +stale +\begin_inset Quotes erd +\end_inset -\begin_layout Subsubsection* -Skim (Mac OSX) + pipes should not be possible. \end_layout \begin_layout Standard -Enter +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 -open -a Skim.app $$i +preferences \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) + file, for each process. \end_layout -\end_inset - -, and then in -\begin_inset Flex Noun +\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 -Skim\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -Sync +lyx -dbg lyxserver \end_layout \end_inset - choose -\begin_inset Flex Noun -status collapsed - -\begin_layout Plain Layout -custom +. \end_layout -\end_inset - - preset and enter command -\begin_inset Flex Noun +\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 -/Applications/\SpecialChar LyX -.app/Contents/MacOS/lyxeditor +development/lyxserver/server_monitor.cpp \end_layout \end_inset @@ -8380,5844 +8804,5346 @@ status collapsed \end_layout \begin_layout Standard -Reverse search is triggered by COMMAND-SHIFT-click -\end_layout +Another useful tool is the command-line based client found in +\begin_inset Flex Code +status collapsed -\begin_layout Subsubsection* -Evince (GNOME) +\begin_layout Plain Layout +src/client/lyxclient \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. +. \end_layout -\begin_layout Subsubsection* -Okular (KDE) +\begin_layout Section +Normal communication \end_layout \begin_layout Standard -Go to -\begin_inset Flex Noun -status collapsed +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 Plain Layout -Settings\SpecialChar menuseparator -Configure Okular\SpecialChar menuseparator -Editor +\begin_layout Quote +LYXCMD: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +argument \end_layout +\begin_layout Description +clientname is a name that the client can choose arbitrarily. + Its only use is that \SpecialChar LyX + will echo it if it sends an answer—so a client can + dispatch results from different requesters. +\end_layout + +\begin_layout Description +function is the function you want \SpecialChar LyX + to perform. + It is the same as the commands you'd use in the minibuffer. +\end_layout + +\begin_layout Description +argument is an optional argument which is meaningful only to some functions + (for instance, the +\begin_inset Quotes eld \end_inset - and select LyX +self-insert \begin_inset Quotes erd \end_inset - as editor. - This inserts the appropriate command ( -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -lyxclient -g %f %l + LFUN will insert the argument as text at the cursor position). \end_layout -\end_inset +\begin_layout Standard +The answer from \SpecialChar LyX + will arrive in the output pipe and be of the form +\end_layout -). +\begin_layout Quote +INFO: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +data \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 +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 -Browse +font-state \begin_inset Quotes erd \end_inset - mode (i. -\begin_inset space \thinspace{} -\end_inset - -e., the hand symbol is clicked). -\change_unchanged +, will return information about the internal state of \SpecialChar LyX +, while other will + return an empty data-response. + This means that the command execution went fine. +\end_layout +\begin_layout Standard +In case of errors, the response from \SpecialChar LyX + will have this form \end_layout -\begin_layout Subsubsection* -Qpdfview (Unix) +\begin_layout Quote +ERROR: +\emph on +clientname +\emph default +: +\emph on +function +\emph default +: +\emph on +error message \end_layout \begin_layout Standard -Qpdfview supports Sync\SpecialChar TeX - since version 0.3.5. - Go to -\begin_inset Flex Noun -status collapsed +where the +\emph on +error message +\emph default + should contain an explanation of why the command failed. +\end_layout -\begin_layout Plain Layout -Edit\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Behavior +\begin_layout Standard +Examples: \end_layout +\begin_layout LyX-Code +echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in +\begin_inset Newline newline \end_inset -, click on the input field of the -\begin_inset Quotes eld +echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in +\begin_inset Newline newline \end_inset -Source editor -\begin_inset Quotes erd +read a <~/.lyxpipe.out +\begin_inset Newline newline \end_inset - item and add the command -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -lyxclient -g %1 %2 +echo $a \end_layout -\end_inset +\begin_layout Subsection +AppleScript (Mac OS X) +\end_layout -. +\begin_layout Standard +Since \SpecialChar LyX + 2.1, \SpecialChar LyX + supports basic interactions with AppleScript for normal communicatio +n through the command run. + This command takes a direct argument (the +\series bold +function +\series default + to perform) and an optional argument. + It either returns the output of the function or triggers an error with + the error message and code. \end_layout \begin_layout Standard -Reverse search is triggered by double-click or, in more recent versions, - by context menu. +Example: \end_layout -\begin_layout Subsubsection* -YAP (Windows) +\begin_layout LyX-Code +tell application "\SpecialChar LyX +" \end_layout -\begin_layout Standard -Launch yap, choose its -\begin_inset Flex Noun -status collapsed +\begin_layout LyX-Code + try +\end_layout -\begin_layout Plain Layout -View\SpecialChar menuseparator -Options +\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 - menu and select the -\begin_inset Quotes eld -\end_inset +\begin_layout LyX-Code + on error the error_message number the error_number +\end_layout -Inverse DVI Search -\begin_inset Quotes erd -\end_inset +\begin_layout LyX-Code + display dialog "Error: " & the error_number & ". + " ¬ +\end_layout - tab. - Click on the -\begin_inset Quotes eld -\end_inset +\begin_layout LyX-Code + & the error_message buttons {"OK"} default button 1 +\end_layout -New\SpecialChar ldots +\begin_layout LyX-Code + end try +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout LyX-Code +end tell +\end_layout - button and, in the window that opens, enter -\begin_inset Quotes eld -\end_inset +\begin_layout Section +Notification +\end_layout +\begin_layout Standard \SpecialChar LyX - Editor -\begin_inset Quotes erd -\end_inset - - (or any other name you like) in the + 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 -Name: +notify \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 +. + The format of the string \SpecialChar LyX + sends is as follows: +\end_layout - to open a file dialog and navigate to the directory containing the batch - file +\begin_layout Quote \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.bat +NOTIFY: \end_layout \end_inset - (see below). - Select -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -lyxeditor.bat +\emph on +key-sequence \end_layout -\end_inset - - and then specify the program arguments as -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -%f %l +\begin_layout Standard +where +\emph on +key-sequence +\emph default + is the printed representation of the key sequence that was actually typed + by the user. \end_layout +\begin_layout Standard +This mechanism can be used to extend \SpecialChar LyX +'s command set and implement macros. + Bind some key sequence to +\begin_inset Quotes eld +\end_inset + +notify +\begin_inset Quotes erd \end_inset . - The -\begin_inset Flex Code -status collapsed + 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 Plain Layout -lyxeditor.bat +\begin_layout Section +The simple \SpecialChar LyX + Server Protocol \end_layout -\end_inset +\begin_layout Standard +\SpecialChar LyX + implements a simple protocol that can be used for session management. + All messages are of the form +\end_layout - wrapper is used for communicating with \SpecialChar LyX - through the +\begin_layout Quote +LYXSRV: \emph on -lyxpipe +clientname \emph default - and is as follows: +: +\emph on +protocol message \end_layout -\begin_layout LyX-Code -@echo off -\begin_inset Newline newline +\begin_layout Standard +where +\emph on +protocol message +\emph default + can be +\begin_inset Quotes eld \end_inset -echo LYXCMD:revdvi:server-goto-file-row:%~1 %2> -\backslash +hello +\begin_inset Quotes erd +\end_inset -\backslash -. -\backslash -pipe -\backslash -lyxpipe.in -\begin_inset Newline newline + or +\begin_inset Quotes eld \end_inset -type -\backslash +bye +\begin_inset Quotes erd +\end_inset -\backslash . -\backslash -pipe -\backslash -lyxpipe.out + If +\begin_inset Quotes eld +\end_inset + +hello +\begin_inset Quotes erd +\end_inset + + is received from a client, \SpecialChar LyX + will report back to inform the client that + it's listening to it's messages, while +\begin_inset Quotes eld +\end_inset + +bye +\begin_inset Quotes erd +\end_inset + + sent from \SpecialChar LyX + will inform clients that \SpecialChar LyX + is closing. +\end_layout + +\begin_layout Section +Reverse DVI/PDF search \end_layout \begin_layout Standard -Make sure that the \SpecialChar LyX -Server pipe path you specified in \SpecialChar LyX - is -\begin_inset Flex Code +Some DVI/PDF viewers +\begin_inset Foot status collapsed \begin_layout Plain Layout - -\backslash - -\backslash -. -\backslash -pipe -\backslash -lyxpipe +The following viewers offer the reverse PDF search feature: Okular on KDE/Linux, + Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows. \end_layout \end_inset -, otherwise change the + provide +\emph on +reverse search +\emph default + facility (also called +\emph on +inverse search +\emph default +). + This means that you can tell \SpecialChar LyX + to put the cursor to a specific line in the + document by clicking at the respective position in the DVI/PDF output. + To achieve this, the viewer must be able to communicate with \SpecialChar LyX +. + This is done via the \SpecialChar LyX + server either by using the named pipe ( +\emph on +lyxpipe +\emph default +), or the UNIX domain socket ( +\emph on +lyxsocket +\emph default +) that \SpecialChar LyX + creates in its temporary directory (this is the way the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.bat +lyxclient \end_layout \end_inset - wrapper accordingly. + program communicates with \SpecialChar LyX +). + In some cases, you need a helper script that mediates between the viewer + and \SpecialChar LyX +, in others, the viewer can communicate with \SpecialChar LyX + directly. + This depends on the selected viewer and on your operating system. + The same applies to the way viewers need to be configured and the way the + reverse search is actually performed. + In what follows, we will thus describe how to setup reverse search for + specific viewers. + Before we turn to this, though, we will explain what needs to be done generally + to enable reverse search in the DVI/PDF output. \end_layout -\begin_layout Standard -In yap, reverse search is triggered by double-click. -\end_layout +\begin_layout Subsection +Automatic setup +\begin_inset CommandInset label +LatexCommand label +name "subsec:rev-search" -\begin_layout Subsubsection* -SumatraPDF (Windows) -\end_layout +\end_inset -\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_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 - in the viewer setting in +. + Alternatively, you can also enable the feature by checking +\family sans +Synchronize with Output +\family default + in \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats\SpecialChar menuseparator -PDF (pdflatex) +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Formats \end_layout \end_inset -, where +. + In such a case \SpecialChar LyX + will automatically insert the necessary Sync\SpecialChar TeX + macro (for + PDF) or load the srcltx package (for DVI) respectively. + This option can be easily reached also on \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.bat +View/Update \end_layout \end_inset - is the previous wrapper. - If SumatraPDF.exe is not in your command PATH, use its full file name. -\end_layout - -\begin_layout Standard -Reverse search is triggered by double-click. -\end_layout - -\begin_layout Subsubsection* -YAP (Cygwin) + Toolbar. \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 +If you need a different setting, you can select or input a custom macro + from the drop down box just below \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -View\SpecialChar menuseparator -Options +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Output\SpecialChar menuseparator +Synchronize with Output \end_layout \end_inset - menu and select the -\begin_inset Quotes eld -\end_inset - -Inverse DVI Search -\begin_inset Quotes erd -\end_inset +. +\end_layout - tab. - Click on the -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +Note that the method +\begin_inset Flex Code +status collapsed -New\SpecialChar ldots +\begin_layout Plain Layout -\begin_inset Quotes erd -\end_inset +\backslash +synctex=1 +\end_layout - button and, in the window that opens, enter -\begin_inset Quotes eld \end_inset -\SpecialChar LyX - Editor -\begin_inset Quotes erd -\end_inset + enables gzip compression. + If your viewer does not support it, you should instead use +\begin_inset Flex Code +status collapsed - (or any other name you like) in the -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout -Name: -\begin_inset Quotes erd -\end_inset +\backslash +synctex=-1 +\end_layout - field. - Now click on the button labeled -\begin_inset Quotes eld \end_inset -\SpecialChar ldots - -\begin_inset Quotes erd -\end_inset +. +\end_layout - to open a file dialog and navigate to the directory containing the +\begin_layout Standard +Please also note that including the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.exe +srcltx \end_layout \end_inset - program (which is installed by default on Cygwin along with the \SpecialChar LyX - executable). - Select + package or \begin_inset Flex Code status collapsed \begin_layout Plain Layout -lyxeditor.exe +src-specials \end_layout \end_inset - and then specify the program arguments as + sometimes has an undesired impact on the typesetting. + Thus, you should switch output synchronization off for the final typesetting + if you use the \begin_inset Flex Code status collapsed \begin_layout Plain Layout --g %f %l +srcltx \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 + package or \begin_inset Flex Code status collapsed \begin_layout Plain Layout --g +src-specials \end_layout \end_inset - 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. +In case you need some more special settings that are not covered by the + automatic settings, read the next section about how to set up output synchroniz +ation manually. + If the automatic setup suits your needs, you can readily jump to section +\begin_inset space ~ +\end_inset + + +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:configuring-viewers" + +\end_inset + +, where the necessary configuration steps in your viewer – needed both with + the automatic and the manual setup – are described. \end_layout -\begin_layout Subsubsection* -SumatraPDF (Cygwin) +\begin_layout Subsection +Manual setup \end_layout \begin_layout Standard -In order to use SumatraPDF for inverse search, enter +\SpecialChar LaTeX + provides several different methods for reverse search. + Some are built-in in the \begin_inset Flex Code status collapsed \begin_layout Plain Layout -SumatraPDF -inverse-search "lyxeditor -g %f %l" +latex/pdflatex \end_layout \end_inset - in the viewer setting in + program, some are provided by external packages. + Your choice depends on whether your \SpecialChar LaTeX + distribution already provides a given + method (the built-in methods are rather new) and whether your viewer can + cope with it. + The available methods are described in the following. +\end_layout + +\begin_layout Subsubsection* +Built-in DVI-search via src-specials (DVI only) +\end_layout + +\begin_layout Standard +This method provides the DVI file with the necessary information for reverse + search. + It is available in \SpecialChar LaTeX + since quite some time (any somewhat recent \SpecialChar LaTeX + distribution + should include it), and it works reliably. + To enable it, change the \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Preferences\SpecialChar menuseparator -File Handling\SpecialChar menuseparator -File formats\SpecialChar menuseparator -PDF (pdflatex) +La +\family sans +TeX +\family default + (plain)->DVI \end_layout \end_inset -. - If SumatraPDF.exe is not in your command PATH, use its full posix path. - The -\begin_inset Flex Code + or +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout --g +La +\family sans +TeX +\family default + (plain)->DraftDVI \end_layout \end_inset - enables communication via the -\emph on -lyxsocket -\emph default -. - Again, omit the -\begin_inset Flex Code + converter in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout --g +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +Converters \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. + to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latex -src-specials $$i \end_layout -\begin_layout Standard -Reverse search is triggered by double-click. +\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 Section -Forward search +\begin_layout Subsubsection* +External Packages (PDFSync and scrltx) \end_layout \begin_layout Standard -Forward search is, as the name implies, in a sense the -\begin_inset Quotes eld -\end_inset - -opposite -\begin_inset Quotes erd -\end_inset +The packages +\emph on +pdfsync +\emph default + and +\emph on +scrltx +\emph default + provide reverse search facility for PDF output (via pdflatex) and DVI output, + respectively. + In order to enable it, load the packages in the \SpecialChar LyX + preamble: +\end_layout - 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 +\begin_layout Itemize +\begin_inset Flex Code status collapsed \begin_layout Plain Layout -Navigate\SpecialChar menuseparator -Forward search + +\backslash +usepackage{pdfsync} \end_layout \end_inset - (or select -\begin_inset Flex Noun -status collapsed + for reverse PDF search, +\end_layout + +\begin_layout Itemize +\begin_inset Flex Code +status collapsed \begin_layout Plain Layout -Forward search + +\backslash +usepackage[active]{srcltx} \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. + for reverse DVI search. \end_layout \begin_layout Standard -To make forward search possible, you first need to provide the generated - output PDF/DVI file with additional information about the \SpecialChar TeX - sources. - This can be done via the methods described in the section -\begin_inset CommandInset ref -LatexCommand ref -reference "subsec:rev-search" - -\end_inset - -. +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 Standard -Additionally, you need to configure \SpecialChar LyX - for using your viewers in -\begin_inset Flex Noun -status collapsed +\begin_layout LyX-Code + +\backslash +usepackage{ifpdf} +\begin_inset Newline newline +\end_inset -\begin_layout Plain Layout -Tools\SpecialChar menuseparator -Preferences\SpecialChar menuseparator -Output\SpecialChar menuseparator -General -\end_layout +\backslash +ifpdf +\begin_inset Newline newline \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 + +\backslash +usepackage{pdfsync} +\begin_inset Newline newline +\end_inset -\begin_layout Itemize -\noindent -\begin_inset Flex Code -status collapsed -\begin_layout Plain Layout -$$n -\end_layout +\backslash +else +\begin_inset Newline newline +\end_inset + +\backslash +usepackage[active]{srcltx} +\begin_inset Newline newline \end_inset -: row number -\end_layout -\begin_layout Itemize -\noindent -\begin_inset Flex Code -status collapsed +\backslash +fi +\end_layout -\begin_layout Plain Layout -$$t +\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 -: name of the (temporary) exported .tex file (without path) +\begin_layout Subsubsection* +Built-in reverse search via Sync\SpecialChar TeX + (DVI and PDF) \end_layout -\begin_layout Itemize -\noindent +\begin_layout Standard +Recent versions of \begin_inset Flex Code status collapsed \begin_layout Plain Layout -$$f +(pdf)latex \end_layout \end_inset -: name of the (temporary) exported .tex file (including path) -\end_layout + have built-in support for both PDF and DVI reverse search. + This so-called +\emph on +Sync\SpecialChar TeX -\begin_layout Itemize -\noindent -\begin_inset Flex Code +\emph default + facility is basically the result of the integration of the PDFSync package + to the pdftex program and its merge with the +\emph on +scr-specials +\emph default + approach. + You need at least \SpecialChar TeX +Live 2008 or a recent Mik\SpecialChar TeX + distribution in order to use + it. +\begin_inset Foot status collapsed \begin_layout Plain Layout -$$o +For some reason, Mik\SpecialChar TeX + does not understand/obey the command \SpecialChar LyX + inserts into + the preamble when you check the "Enable Forward/Reverse Search" button + in the toolbar and does not generate the necessary info. +\end_layout + +\begin_layout Plain Layout +The generation of the required info can be forced by changing the converter + "\SpecialChar LaTeX + (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters + from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding + the -synctex=1 switch). \end_layout \end_inset -: name of the exported output file (either dvi or pdf, depending on which - one exists in the temporary directory) + Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix, + Skim on the Mac, SumatraPDF on Windows; see the next section for details) + already provide Sync\SpecialChar TeX + support. \end_layout \begin_layout Standard -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 +To enable Sync\SpecialChar TeX + for DVI output, change the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -You might want to set -\begin_inset Flex Code +La +\family sans +TeX +\family default + (plain) -> DVI +\end_layout + +\end_inset + + or +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -okular --unique +La +\family sans +TeX +\family default + (plain) -> DraftDVI \end_layout \end_inset - in + converter in \begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar menuseparator Preferences\SpecialChar menuseparator File Handling\SpecialChar menuseparator -File -\begin_inset space ~ -\end_inset - -Formats +Converters \end_layout \end_inset + to +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +latex -synctex=1 $$i \end_layout \end_inset -, qpdfview, and SumatraPDF -\begin_inset Foot +, and for PDF output, change the +\begin_inset Flex Noun 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" +La +\family sans +TeX +\family default + (pdflatex) -> PDF (pdflatex) +\end_layout \end_inset + converter to +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +pdflatex -synctex=1 $$i \end_layout \end_inset . - Others, such as evince + Should your viewer not be considered in the following description, or in + case of missing success, please check the documentation of your viewer + whether the viewer needs to be configured for the use with Sync\SpecialChar TeX +. \begin_inset Foot status collapsed \begin_layout Plain Layout -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 +Note that the option +\begin_inset Flex Code +status collapsed - for details. +\begin_layout Plain Layout +-synctex=1 \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 + option enables gzip compression. + If your viewer does not support it, you should instead use +\begin_inset Flex Code +status collapsed -g. - xpdf – allow at least to reload the document and jump to a specific page - of the file, so you can at least navigate -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout +-synctex=-1 +\end_layout -near -\begin_inset Quotes erd \end_inset . - This latter functionality is provided by an external call of synctex (see - the predefined example configurations). - \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 -\end_layout +\begin_layout Subsection +Configuring and using specific viewers +\begin_inset CommandInset label +LatexCommand label +name "subsec:configuring-viewers" -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -by -\noun on -Peter Sütterlin -\end_layout -\begin_layout Subsection +\end_layout -\change_deleted 564990737 1669742044 -Introduction +\begin_layout Subsubsection* +Xdvi (all platforms) \end_layout \begin_layout Standard - -\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 +If you use +\begin_inset Flex Code status collapsed \begin_layout Plain Layout - -https://www.aanda.org/ +xdvi \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 +, you don't need to do anything else for performing a reverse DVI search, + as \SpecialChar LyX + already provides the necessary hooks for automatically using the +\begin_inset Flex Code +status collapsed -\begin_layout Standard +\begin_layout Plain Layout +lyxclient +\end_layout -\change_deleted 564990737 1669742044 -\begin_inset VSpace medskip \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 -\align center - -\change_deleted 564990737 1669742044 -\begin_inset Flex URL +However, if for whatever reason you want to use the named pipe instead of + the socket for communicating with \SpecialChar LyX +, simply change the DVI viewer in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout - -ftp://ftp.edpsciences.org/pub/aa/readme.html +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats \end_layout \end_inset + to +\begin_inset Foot +status collapsed -\end_layout +\begin_layout Plain Layout +On Mac OSX you have to use +\begin_inset Flex Code +status collapsed -\begin_layout Standard +\begin_layout Plain Layout +DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l" +\end_layout -\change_deleted 564990737 1669742044 -\begin_inset VSpace medskip \end_inset \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -A manual comes together with that package, and this text is not meant to - replace the original manual but is merely a short guide in how to realize - the correct form of your paper. -\end_layout - -\begin_layout Standard +\begin_inset Flex Code +status collapsed -\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 -. +\begin_layout Plain Layout +xdvi -editor "lyxeditor.sh %f %l" \end_layout -\begin_layout Subsection - -\change_deleted 564990737 1669742044 -Getting started -\end_layout +\end_inset -\begin_layout Standard +, where +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -It is recommended you start from the example template distributed with \SpecialChar LyX -. - If you are not using a template, note the following settings: +\begin_layout Plain Layout +lyxeditor.sh \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 -Select -\family sans -article (A&A) -\family default - in the -\family sans -Document\SpecialChar menuseparator -Settings -\family default - dialog (OK, that one was obvious). + is a suitable script. + For example, a minimal shell script is the following one: \end_layout -\begin_layout Itemize +\begin_layout LyX-Code +#!/bin/sh +\begin_inset Newline newline +\end_inset -\change_deleted 564990737 1669742044 -Don't change the option -\family sans -Page -\begin_inset space ~ +LYXPIPE="/path/to/lyxpipe" +\begin_inset Newline newline \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 +COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2" +\begin_inset Newline newline +\end_inset -\begin_layout Subsection +echo "$COMMAND" > "${LYXPIPE}".in || exit +\begin_inset Newline newline +\end_inset -\change_deleted 564990737 1669742044 -The header block +read TMP < "${LYXPIPE}".out || exit \end_layout \begin_layout Standard +where +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -First thing to enter is the header information. - It consists of seven entries, of which some are optional. - They are +\begin_layout Plain Layout +/path/to/lyxpipe \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + is the LyXServer pipe path specified in +\begin_inset Flex Noun +status collapsed -\family sans -Title -\family default -: [required] +\begin_layout Plain Layout +Preferences\SpecialChar menuseparator +Paths \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 +. +\begin_inset Foot +status collapsed -\family sans -Subtitle -\family default -: [optional] +\begin_layout Plain Layout +In the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +development/tools \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + folder of a source distribution you can find a +\begin_inset Flex Code +status collapsed -\family sans -Author -\family default -: [required] +\begin_layout Plain Layout +lyxeditor \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\end_inset -\family sans -Address -\family default -: [required] + script which is able to locate the +\emph on +lyxpipe +\emph default + based on your preferences. \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 -\family sans -Offprints -\family default -: [optional] if more than one author: whom to contact for offprint requests. \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\begin_layout Subsubsection* +MacDviX (Mac OSX) +\end_layout -\family sans -Mail -\family default -: [optional] mail address for contacts. -\end_layout - -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\begin_layout Standard +At the end of +\begin_inset Flex Code +status collapsed -\family sans -Date -\family default -: [required]. - Suggested format is -\family typewriter -Received: ; Accepted +\begin_layout Plain Layout +/Applications/MacDviX_Folder/calleditor.script \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -There is no need to issue the -\family typewriter +\end_inset -\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. +, add the following lines: \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669742044 -If you want to place footnotes in the header block, e. -\begin_inset space \thinspace{} +\begin_layout LyX-Code +/Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1 +\begin_inset Newline newline \end_inset -g. -\begin_inset space \space{} -\end_inset +exit 1 +\end_layout -to state your present address, just use the standard footnote via the menu - -\family sans -Insert\SpecialChar menuseparator -Footnote. +\begin_layout Standard +Modify the lines accordingly if you install \SpecialChar LyX + somewhere else than in the + Applications folder. +\end_layout -\family default - \SpecialChar LyX - will automagically use the term -\family typewriter +\begin_layout Standard +Reverse search is triggered by Alt-click (OPTION-click). +\end_layout -\backslash -thanks{} -\family default - in that case. +\begin_layout Subsubsection* +Skim (Mac OSX) \end_layout \begin_layout Standard +Enter +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Under -\family sans -Edit\SpecialChar menuseparator -Text Style -\family default -, you'll find two insets which are relevant for the titling: +\begin_layout Plain Layout +open -a Skim.app $$i \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + to the viewer setting in +\begin_inset Flex Noun +status collapsed -\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 Plain Layout +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats\SpecialChar menuseparator +PDF (pdflatex) \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 +, and then in +\begin_inset Flex Noun +status collapsed -\family sans -Email -\family default - to supply an email address for fast contact. +\begin_layout Plain Layout +Skim\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +Sync \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -In addition to these topics, the macros use one additional \SpecialChar LaTeX - command that - has no counterpart in \SpecialChar LyX -: -\end_layout + choose +\begin_inset Flex Noun +status collapsed -\begin_layout Itemize +\begin_layout Plain Layout +custom +\end_layout -\change_deleted 564990737 1669742044 +\end_inset -\family typewriter + preset and enter command +\begin_inset Flex Noun +status collapsed -\backslash -and -\family default - to separate different names for more than one author and institute, respectivel -y. +\begin_layout Plain Layout +/Applications/\SpecialChar LyX +.app/Contents/MacOS/lyxeditor \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -The appropriate command has to be entered in \SpecialChar LyX - and marked as \SpecialChar LaTeX - code. - See the examples. - +. \end_layout -\begin_layout Subsection +\begin_layout Standard +Reverse search is triggered by COMMAND-SHIFT-click +\end_layout -\change_deleted 564990737 1669742044 -The abstract +\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 1669742044 -The abstract should immediately follow the header block. - With version 5 the abstract environment was changed to a command, and there - is now a restriction to only one paragraph. - In addition, it should contain an entry with the keywords. - This is done via the paragraph style -\family sans -Keywords -\family default -. - Refer to the example paper. -\end_layout +\end_inset -\begin_layout Subsection + for details. +\end_layout -\change_deleted 564990737 1669742044 -Supported environments +\begin_layout Subsubsection* +Okular (KDE) \end_layout \begin_layout Standard +Go to +\begin_inset Flex Noun +status collapsed -\change_deleted 564990737 1669742044 -The A&A paper layout supports the following environments for structuring - your text: +\begin_layout Plain Layout +Settings\SpecialChar menuseparator +Configure Okular\SpecialChar menuseparator +Editor \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 - -\family sans -Standard -\end_layout +\end_inset -\begin_layout Itemize + and select LyX +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669742044 + as editor. + This inserts the appropriate command ( +\begin_inset Flex Code +status collapsed -\family sans -Section +\begin_layout Plain Layout +lyxclient -g %f %l \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\end_inset -\family sans -Subsection +). \end_layout -\begin_layout Itemize +\begin_layout Standard +Reverse search is triggered by SHIFT-click. -\change_deleted 564990737 1669742044 +\change_inserted -712698321 1578211026 + Note that this only works if Okular is in +\begin_inset Quotes eld +\end_inset -\family sans -Subsubsection -\end_layout +Browse +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize + mode (i. +\begin_inset space \thinspace{} +\end_inset -\change_deleted 564990737 1669742044 +e., the hand symbol is clicked). +\change_unchanged -\family sans -Itemize \end_layout -\begin_layout Itemize +\begin_layout Subsubsection* +Qpdfview (Unix) +\end_layout -\change_deleted 564990737 1669742044 +\begin_layout Standard +Qpdfview supports Sync\SpecialChar TeX + since version 0.3.5. + Go to +\begin_inset Flex Noun +status collapsed -\family sans -Enumerate +\begin_layout Plain Layout +Edit\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Behavior \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 +, click on the input field of the +\begin_inset Quotes eld +\end_inset -\family sans -Description +Source editor +\begin_inset Quotes erd +\end_inset + + item and add the command +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lyxclient -g %1 %2 \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 +. +\end_layout -\family sans -Caption +\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 1669742044 +\begin_layout Standard +Launch yap, choose its +\begin_inset Flex Noun +status collapsed -\family sans -Abstract +\begin_layout Plain Layout +View\SpecialChar menuseparator +Options \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + menu and select the +\begin_inset Quotes eld +\end_inset -\family sans -Acknowledgment -\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 1669742044 +New\SpecialChar ldots -\family sans -Bibliography -\end_layout +\begin_inset Quotes erd +\end_inset -\begin_layout Itemize + button and, in the window that opens, enter +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 +\SpecialChar LyX + Editor +\begin_inset Quotes erd +\end_inset -\family sans -\SpecialChar LaTeX + (or any other name you like) in the +\begin_inset Quotes eld +\end_inset + +Name: +\begin_inset Quotes erd +\end_inset + + field. + Now click on the button labeled +\begin_inset Quotes eld +\end_inset + +\SpecialChar ldots + +\begin_inset Quotes erd +\end_inset + + to open a file dialog and navigate to the directory containing the batch + file +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +lyxeditor.bat \end_layout -\begin_layout Subsection +\end_inset -\change_deleted 564990737 1669742044 -Commands not supported by \SpecialChar LyX + (see below). + Select +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lyxeditor.bat +\end_layout + +\end_inset + + and then specify the program arguments as +\begin_inset Flex Code +status collapsed +\begin_layout Plain Layout +%f %l \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -Some commands are not yet supported by the -\family sans -paper (A&A) -\family default - layout for \SpecialChar LyX . - Some have already been mentioned. - For the sake of completeness, they are listed all together here: + The +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +lyxeditor.bat \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 + wrapper is used for communicating with \SpecialChar LyX + through the +\emph on +lyxpipe +\emph default + and is as follows: +\end_layout -\family typewriter +\begin_layout LyX-Code +@echo off +\begin_inset Newline newline +\end_inset +echo LYXCMD:revdvi:server-goto-file-row:%~1 %2> \backslash -and -\end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669742044 +\backslash +. +\backslash +pipe +\backslash +lyxpipe.in +\begin_inset Newline newline +\end_inset -\family typewriter +type +\backslash \backslash -authorrunning +. +\backslash +pipe +\backslash +lyxpipe.out \end_layout -\begin_layout Itemize +\begin_layout Standard +Make sure that the \SpecialChar LyX +Server pipe path you specified in \SpecialChar LyX + is +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 +\begin_layout Plain Layout -\family typewriter +\backslash \backslash -object{} +. +\backslash +pipe +\backslash +lyxpipe \end_layout -\begin_layout Itemize +\end_inset -\change_deleted 564990737 1669742044 +, otherwise change the +\begin_inset Flex Code +status collapsed -\family typewriter +\begin_layout Plain Layout +lyxeditor.bat +\end_layout -\backslash -titlerunning{} +\end_inset + + wrapper accordingly. \end_layout \begin_layout Standard +In yap, reverse search is triggered by double-click. +\end_layout -\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 Subsubsection* +SumatraPDF (Windows) \end_layout -\begin_layout Subsection +\begin_layout Standard +In order to use SumatraPDF for inverse search, enter +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Figure and Table Floats +\begin_layout Plain Layout +SumatraPDF -inverse-search "lyxeditor.bat "%f" %l" \end_layout -\begin_layout Standard +\end_inset -\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 + in the viewer setting in +\begin_inset Flex Noun +status collapsed -Settings. +\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 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 +, where +\begin_inset Flex Code +status collapsed -\begin_layout Enumerate +\begin_layout Plain Layout +lyxeditor.bat +\end_layout -\change_deleted 564990737 1669742044 -Create a wide figure float: -\family sans -Insert\SpecialChar menuseparator -Float\SpecialChar menuseparator -Figure -\family default -, then right click in the figure and select -\family sans -Span -\begin_inset space ~ \end_inset -columns -\family default -. + is the previous wrapper. + If SumatraPDF.exe is not in your command PATH, use its full file name. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Enter your caption text. +\begin_layout Standard +Reverse search is triggered by double-click. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669742044 -Press -\family sans -Return -\family default - to move the cursor above the caption. +\begin_layout Subsubsection* +YAP (Cygwin) \end_layout -\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 1669742044 -Insert your figure +\begin_layout Plain Layout +View\SpecialChar menuseparator +Options \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 ~ + menu and select the +\begin_inset Quotes eld \end_inset -Fill -\family default -. -\end_layout - -\begin_layout Enumerate +Inverse DVI Search +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669742044 -Switch to \SpecialChar LaTeX - mode: -\family sans -M-c -\begin_inset space ~ + tab. + Click on the +\begin_inset Quotes eld \end_inset -t -\family default -. -\end_layout +New\SpecialChar ldots -\begin_layout Enumerate +\begin_inset Quotes erd +\end_inset -\change_deleted 564990737 1669742044 -Enter -\family typewriter + button and, in the window that opens, enter +\begin_inset Quotes eld +\end_inset -\backslash -parbox[b]{55mm}{ -\family default -. - -\series bold -Do not close the brace! -\end_layout +\SpecialChar LyX + Editor +\begin_inset Quotes erd +\end_inset -\begin_layout Enumerate + (or any other name you like) in the +\begin_inset Quotes eld +\end_inset -\change_deleted 564990737 1669742044 -Position the cursor behind the caption text, switch to \SpecialChar LaTeX - mode and insert - the closing brace: -\family sans -M-c -\begin_inset space ~ +Name: +\begin_inset Quotes erd \end_inset -t -\family default - -\family typewriter -} -\family default -. -\end_layout + field. + Now click on the button labeled +\begin_inset Quotes eld +\end_inset -\begin_layout Standard +\SpecialChar ldots -\change_deleted 564990737 1669742044 -Also, refer to the figures in the example paper. -\end_layout +\begin_inset Quotes erd +\end_inset -\begin_layout Subsection + to open a file dialog and navigate to the directory containing the +\begin_inset Flex Code +status collapsed -\change_deleted 564990737 1669742044 -Referee layout +\begin_layout Plain Layout +lyxeditor.exe \end_layout -\begin_layout Standard +\end_inset -\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. + 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 -\begin_layout Subsection +\end_inset -\change_deleted 564990737 1669742044 -The example paper + and then specify the program arguments as +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +-g %f %l \end_layout -\begin_layout Standard +\end_inset -\change_deleted 564990737 1669742044 -The -\family sans -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 + In this way, you will be using the +\emph on +lyxsocket +\emph default + for communicating with \SpecialChar LyX . - Use it for inspiration, and compare the original \SpecialChar LaTeX - code with \SpecialChar LyX - way of writing. + 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 Section -AAS\SpecialChar TeX +\end_inset + option and be sure to specify the \SpecialChar LyX +Server pipe path in the \SpecialChar LyX + preferences. \end_layout \begin_layout Standard -by -\noun on -Mike Ressler +In yap, reverse search is triggered by double-click. \end_layout -\begin_layout Subsection -Introduction +\begin_layout Subsubsection* +SumatraPDF (Cygwin) \end_layout \begin_layout Standard -AAS\SpecialChar TeX - is a set of macros produced by the American Astronomical Society to - facilitate electronic manuscript submission to the three journals they - publish: the Astrophysical Journal (including the Letters and Supplement), - the Astronomical Journal, and the Publications of the Astronomical Society - of the Pacific. - \SpecialChar LyX - has proven to be an excellent tool for generating these documents, especially - given its equation, citation, and figure handling capabilities. - \SpecialChar LyX - requires version 5.0 (or higher) of these macros; preferably 6.0, which - is the version described here, or higher. - Versions prior to 5.0 are intended for use with \SpecialChar LaTeX -2.09 and are fundamentally - incompatible with \SpecialChar LyX -. - The AAS\SpecialChar TeX - package may be downloaded from the AAS\SpecialChar TeX - Web site +In order to use SumatraPDF for inverse search, enter +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +SumatraPDF -inverse-search "lyxeditor -g %f %l" \end_layout -\begin_layout Standard -\begin_inset VSpace medskip \end_inset - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Flex URL + in the viewer setting in +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout - -https://aas.org/aastex/aastex-downloads +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File formats\SpecialChar menuseparator +PDF (pdflatex) \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 Plain Layout +-g \end_layout -\begin_layout Standard -\begin_inset VSpace medskip \end_inset + 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 -\begin_layout Standard -A complete user guide is contained in that package and you should familiarize - yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX -. - \SpecialChar LyX - will not reduce the need to figure out all the AAS\SpecialChar TeX - commands, it will only - reduce the drudgery of typing everything in. - It is your responsibility to ensure that the final exported \SpecialChar LaTeX - document conforms - completely to the requirements of the journal to which you are submitting - your paper. -\end_layout +\end_inset -\begin_layout Subsection -Starting a New Paper + option if you want to use the +\emph on +lyxpipe +\emph default +, and be sure to specify the \SpecialChar LyX +Server pipe path in the \SpecialChar LyX + preferences. \end_layout \begin_layout Standard -I strongly suggest that you start with the AAS\SpecialChar TeX - template file. - Click on -\family sans -File\SpecialChar menuseparator -New from -\family default - -\family sans -Template -\family default -, enter the new file name, then choose the -\family typewriter -aastex6.lyx -\family default - template. - This will show the most common fields found in a manuscript. - Simply overwrite the existing text (including the brackets, -\family typewriter -<> -\family default -) with the correct information. - Many of the AAS\SpecialChar TeX - commands and environments can be implemented directly in - \SpecialChar LyX -, but some cannot. - For commands such as these, the \SpecialChar LaTeX - code must be entered directly and marked - as such. - Such commands are referred to as \SpecialChar TeX - code, or Evil Red Text. - I tried to minimize the amount of \SpecialChar TeX - code needed in an AAS\SpecialChar TeX - document. +Reverse search is triggered by double-click. \end_layout -\begin_layout Subsection -Finishing Your Paper +\begin_layout Section +Forward search \end_layout \begin_layout Standard -When the paper is finished to your satisfaction and previews/prints correctly, - there are a few +Forward search is, as the name implies, in a sense the \begin_inset Quotes eld \end_inset -postprocessing +opposite \begin_inset Quotes erd \end_inset - actions which need to be done before you submit it to the journals. - + of reverse search. + It allows you to let the viewer jump to a given position from within \SpecialChar LyX +. + If forward search is set up (as described in what follows), you can put + the cursor anywhere in your \SpecialChar LyX + document, and hit +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Navigate\SpecialChar menuseparator +Forward search \end_layout -\begin_layout Enumerate -Export your paper as a \SpecialChar LaTeX - file ( -\family sans -File\SpecialChar menuseparator -Export\SpecialChar menuseparator -\SpecialChar LaTeX +\end_inset -\family default -). - -\end_layout + (or select +\begin_inset Flex Noun +status collapsed -\begin_layout Enumerate -Edit the resulting -\family typewriter -.tex -\family default - file with your favorite text editor +\begin_layout Plain Layout +Forward search \end_layout -\begin_deeper -\begin_layout Enumerate -remove the comment lines before the -\family typewriter +\end_inset -\backslash -documentclass -\family default - command + 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 -remove the -\family typewriter - -\backslash -usepackage...{fontenc} -\family default - line if it appears (usually just after -\family typewriter +\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" -\backslash -documentclass -\family default -}; also remove the -\family typewriter +\end_inset -\backslash -secnumdepth -\family default - line if it appears. +. \end_layout -\begin_layout Enumerate -remove everything between (and including) the -\family typewriter +\begin_layout Standard +Additionally, you need to configure \SpecialChar LyX + for using your viewers in +\begin_inset Flex Noun +status collapsed -\backslash -makeatletter -\family default - and -\family typewriter +\begin_layout Plain Layout +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +Output\SpecialChar menuseparator +General +\end_layout -\backslash -makeatother -\family default - commands, except for any commands you specifically put into the \SpecialChar LaTeX - preamble - (which should appear immediately after the -\begin_inset Quotes eld \end_inset -User specified \SpecialChar LaTeX - commands -\begin_inset Quotes erd -\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 - comment in the -\family typewriter -.tex -\family default - file). +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$n \end_layout -\end_deeper -\begin_layout Enumerate -Run the resulting file through \SpecialChar LaTeX - to make sure it still processes correctly. -\end_layout +\end_inset -\begin_layout Enumerate -Reread the journal requirements to make sure your filenames and formats - are correct. +: row number \end_layout -\begin_layout Enumerate -Submit it. -\end_layout +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed -\begin_layout Subsection -Comments On Specific Commands +\begin_layout Plain Layout +$$t \end_layout -\begin_layout Standard -I will not describe the detailed usage of the individual AAS\SpecialChar TeX - commands: the - AAS\SpecialChar TeX - User Guide ( -\family typewriter -aasguide.tex -\family default -) gives a good description of each. - Thus it's probably easiest for me to go down the list as found in the guide - and offer comments where necessary. - So let's begin \SpecialChar ldots +\end_inset +: name of the (temporary) exported .tex file (without path) \end_layout -\begin_layout Subsubsection -Things that work as expected +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$f \end_layout -\begin_layout Standard -Because they work as you might expect, I simply list them and the section - they are found in: -\family typewriter +\end_inset -\backslash -documentclass -\family default - (2.1.1), -\family typewriter +: name of the (temporary) exported .tex file (including path) +\end_layout -\backslash -begin{document} -\family default - (2.2), -\family typewriter +\begin_layout Itemize +\noindent +\begin_inset Flex Code +status collapsed -\backslash -title -\family default - (2.3), -\family typewriter +\begin_layout Plain Layout +$$o +\end_layout -\backslash -author -\family default - (2.3), -\family typewriter +\end_inset -\backslash -affil -\family default - (2.3), -\family typewriter +: name of the exported output file (either dvi or pdf, depending on which + one exists in the temporary directory) +\end_layout -\backslash -abstract -\family default - (2.4), -\family typewriter +\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 -\backslash -keywords -\family default - (2.5), -\family typewriter +\begin_layout Plain Layout +You might want to set +\begin_inset Flex Code +status collapsed -\backslash -section -\family default - (2.7), -\family typewriter +\begin_layout Plain Layout +okular --unique +\end_layout -\backslash -subsection -\family default - (2.7), -\family typewriter +\end_inset -\backslash -subsubsection -\family default - (2.7), -\family typewriter + in +\begin_inset Flex Noun +status collapsed -\backslash -paragraph -\family default - (2.7), -\family typewriter +\begin_layout Plain Layout +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator +File +\begin_inset space ~ +\end_inset -\backslash -facility -\family default - (2.10), -\family typewriter +Formats +\end_layout -\backslash -begin{displaymath} -\family default - (2.12), -\family typewriter +\end_inset -\backslash -begin{equation} -\family default - (2.12), -\family typewriter -\backslash -begin{eqnarray} -\family default - (2.12), -\family typewriter +\end_layout -\backslash -begin{mathletters} -\family default - (2.12), -\family typewriter +\end_inset -\backslash -begin{thebibliography} -\family default - (2.13.1), -\family typewriter +, qpdfview, and SumatraPDF +\begin_inset Foot +status collapsed -\backslash -bibitem -\family default - (2.13.2), all the cite commands and their variations (2.13.2), the generic - graphicx figure commands (2.14.1), -\family typewriter +\begin_layout 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" -\backslash -begin{table} -\family default - (2.15.4), -\family typewriter +\end_inset -\backslash -begin{tabular} -\family default - (2.15.4), -\family typewriter -\backslash -caption -\family default - (2.15.4), -\family typewriter +\end_layout -\backslash -label -\family default - (2.15.4, amongst other places), -\family typewriter +\end_inset -\backslash -tablerefs -\family default - (2.15.5), -\family typewriter +. + Others, such as evince +\begin_inset Foot +status collapsed -\backslash -tablecomments -\family default - (2.15.5), -\family typewriter +\begin_layout Plain Layout +Forward search with evince can be achieved by means of third party helper + scripts. + Please refer to +\begin_inset CommandInset href +LatexCommand href +target "https://wiki.lyx.org/LyX/SyncTeX" +literal "false" -\backslash -url -\family default - (2.17.4), -\family typewriter +\end_inset -\backslash -end{document} -\family default - (2.18). + for details. \end_layout -\begin_layout Standard -The following style options also work correctly: -\family typewriter -longabstract -\family default - (2.4), -\family typewriter -preprint -\family default - (3.2.1), -\family typewriter -preprint2 -\family default - (3.2.2), -\family typewriter -eqsecnum -\family default - (3.3), -\family typewriter -flushrt -\family default - (3.4). - Simply put them in the -\family sans -Options -\family default - box in -\family sans -Layout\SpecialChar menuseparator -Document -\family default +\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 + +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 Subsubsection -Things that work, but require more comment +\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 Standard -The following items work, but require a little more discussion: +\begin_layout Chapter +Special Document Classes \end_layout -\begin_layout Itemize -These items are reserved for use by the journal editors, but you can put - them into the \SpecialChar LaTeX - preamble if you feel compelled to do so: -\family typewriter +\begin_layout Section -\backslash -received -\family default -, -\family typewriter +\change_deleted 564990737 1669742044 +A&A Paper +\end_layout -\backslash -revised -\family default -, -\family typewriter +\begin_layout Standard -\backslash -accepted -\family default -, -\family typewriter +\change_deleted 564990737 1669742044 +by +\noun on +Peter Sütterlin +\end_layout -\backslash -ccc -\family default -, -\family typewriter +\begin_layout Subsection -\backslash -cpright -\family default - (all from 2.1.3) +\change_deleted 564990737 1669742044 +Introduction \end_layout -\begin_layout Itemize -These items may be placed in the \SpecialChar LaTeX - preamble, and are included as blanks in - the template file: -\family typewriter +\begin_layout Standard -\backslash -slugcomment -\family default - (2.1.4), -\family typewriter +\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 -\backslash -shorttitle -\family default - (2.1.5), -\family typewriter +\begin_layout Plain Layout -\backslash -shortauthors -\family default - (2.1.5) +https://www.aanda.org/ \end_layout -\begin_layout Itemize +\end_inset +) using Version 5.01 of the document class \family typewriter - -\backslash -email +aa.cls \family default - (2.3) – can only be used -\begin_inset Quotes eld -\end_inset +. + This package can be downloaded from the ftp site +\end_layout -standalone -\begin_inset Quotes erd +\begin_layout Standard + +\change_deleted 564990737 1669742044 +\begin_inset VSpace medskip \end_inset -, not in the middle of a paragraph. - Use \SpecialChar TeX - code if you need to embed it. -\end_layout -\begin_layout Itemize +\end_layout -\family typewriter +\begin_layout Standard +\align center -\backslash -and -\family default - (2.3) – will have extra {} after it. - This should not cause an error. -\end_layout +\change_deleted 564990737 1669742044 +\begin_inset Flex URL +status collapsed -\begin_layout Itemize +\begin_layout Plain Layout -\family typewriter +ftp://ftp.edpsciences.org/pub/aa/readme.html +\end_layout -\backslash -notetoeditor -\family default - (2.6) – can only be used -\begin_inset Quotes eld \end_inset -standalone -\begin_inset Quotes erd -\end_inset -, not in the middle of a paragraph. - Use \SpecialChar TeX - code if you need to embed it. \end_layout -\begin_layout Itemize - -\family typewriter +\begin_layout Standard -\backslash -placetable -\family default - (2.8) – can't insert a cross-reference tag, you must type the tag name by - hand -\end_layout +\change_deleted 564990737 1669742044 +\begin_inset VSpace medskip +\end_inset -\begin_layout Itemize -\family typewriter +\end_layout -\backslash -placefigure -\family default - (2.8) – same as for -\family typewriter +\begin_layout Standard -\backslash -placetable +\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 Itemize +\begin_layout Standard +\change_deleted 564990737 1669742044 +Please note that the publisher of the journal was changed from Springer + to EDP Sciences starting January 1, 2001. + That change involved also some slight changes to the style files, namely + the removal of the thesaurus command. + The \SpecialChar LyX + class aa supports the newest version of these style files, V 5.01. + If you have an older version installed, please upgrade. + For compatibility, the old (version 4) layout has been kept as +\family sans +article (A&A V4) +\family default +. + Please refer to the comments in \family typewriter - -\backslash -acknowledgements +\SpecialChar LyX +Dir/layouts/aapaper.layout \family default - (2.9) – will have extra {} after it. - This should not cause an error. +. \end_layout -\begin_layout Itemize +\begin_layout Subsection -\family typewriter +\change_deleted 564990737 1669742044 +Getting started +\end_layout -\backslash -appendix -\family default - (2.11) – will have extra {} after it. - This should not cause an error. +\begin_layout Standard + +\change_deleted 564990737 1669742044 +It is recommended you start from the example template distributed with \SpecialChar LyX +. + If you are not using a template, note the following settings: \end_layout \begin_layout Itemize -\family typewriter - -\backslash -figcaption +\change_deleted 564990737 1669742044 +Select +\family sans +article (A&A) \family default - (2.14.2) – you can insert an optional filename argument by placing the cursor - at the beginning of the text and selecting + in the \family sans -Insert\SpecialChar menuseparator -Short Title +Document\SpecialChar menuseparator +Settings \family default -. - -\begin_inset Quotes eld -\end_inset + dialog (OK, that one was obvious). +\end_layout -Short Title -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - inserts an optional argument of the type needed by -\family typewriter +\change_deleted 564990737 1669742044 +Don't change the option +\family sans +Page +\begin_inset space ~ +\end_inset -\backslash -figcaption +style +\family default +: Leave it set to +\family sans +default \family default . - Hopefully it will be renamed someday. + The whole layout is done by the macros, you shouldn't change anything. \end_layout -\begin_layout Itemize +\begin_layout Subsection -\family typewriter +\change_deleted 564990737 1669742044 +The header block +\end_layout -\backslash -objectname -\family default - (2.17.1) – same as -\family typewriter +\begin_layout Standard -\backslash -figcaption -\family default - for the catalog ID optional parameter +\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 -\family typewriter - -\backslash -dataset -\family default - (2.17.1) – same as -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -figcaption +\family sans +Title \family default - for the catalog ID optional parameter -\end_layout - -\begin_layout Subsubsection -Things not implemented, use \SpecialChar TeX - code +: [required] \end_layout -\begin_layout Standard +\begin_layout Itemize -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -eqnum +\family sans +Subtitle \family default - (2.12), -\family typewriter +: [optional] +\end_layout -\backslash -setcounter{equation} -\family default - (2.12), Journal name abbreviations (2.13.4), -\family typewriter +\begin_layout Itemize -\backslash -figurenum -\family default - (2.14.1), -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -epsscale +\family sans +Author \family default - (2.14.1), -\family typewriter +: [required] +\end_layout -\backslash -plotone -\family default - (2.14.1), -\family typewriter +\begin_layout Itemize -\backslash -plottwo -\family default - (2.14.1), -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -tablenum +\family sans +Address \family default - (2.15.4), -\family typewriter +: [required] +\end_layout -\backslash -tableline -\family default - (2.15.4, insert it as the first element in the lefthand cell after where - you want it. - Don't use any of \SpecialChar LyX -'s rules in the table), -\family typewriter +\begin_layout Itemize -\backslash -tablenotemark -\family default - (2.15.5), -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -tablenotetext +\family sans +Offprints \family default - (2.15.5), much of Misc (2.17, except -\family typewriter +: [optional] if more than one author: whom to contact for offprint requests. +\end_layout -\backslash -objectname -\family default -, -\family typewriter +\begin_layout Itemize -\backslash -dataset -\family default -, -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -url +\family sans +Mail \family default -, and -\family typewriter +: [optional] mail address for contacts. +\end_layout -\backslash -email -\family default -; see above), -\family typewriter +\begin_layout Itemize -\backslash -singlespace -\family default - (3.1), -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -doublespace +\family sans +Date \family default - (3.1), +: [required]. + Suggested format is \family typewriter +Received: ; Accepted +\end_layout -\backslash -onecolumn -\family default - (3.2), +\begin_layout Standard + +\change_deleted 564990737 1669742044 +There is no need to issue the \family typewriter \backslash -twocolumn +maketitle \family default - (3.2) -\end_layout - -\begin_layout Subsubsection -Things that cannot be implemented + command, this is done automatically by \SpecialChar LyX + when the header is finished. + Although the order of the single header entries doesn't matter it is advised + to keep the above sequence, just to get the best optics and meets the layout + of the real document. \end_layout \begin_layout Standard -\SpecialChar ldots - at least in any meaningful sort of way, so I suggest ignoring them. - They are the references environment (2.13.3), and the deluxetable environment - (2.15). - If you really, really need to use deluxetable, I suggest editing it in - a separate file with a text editor, then using + +\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 Insert\SpecialChar menuseparator -Child -\begin_inset space ~ -\end_inset +Footnote. -Document \family default - to include it in your \SpecialChar LyX - document. - See the + \SpecialChar LyX + will automagically use the term \family typewriter -aas_sample.lyx + +\backslash +thanks{} \family default - file to see an example of this. + in that case. \end_layout -\begin_layout Subsection -FAQs, Tips, Tricks, and Other Ruminations -\end_layout +\begin_layout Standard -\begin_layout Subsubsection -Getting \SpecialChar LyX - and AAS\SpecialChar TeX - to cooperate +\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: \end_layout -\begin_layout Standard -It can be a bit tricky to get \SpecialChar LyX - to recognize a new layout and document class. - When all else fails, do this: -\end_layout +\begin_layout Itemize -\begin_layout Enumerate -Make certain that \SpecialChar LaTeX - can find AAS\SpecialChar TeX -. - Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX - distribution into a - directory completely unrelated to \SpecialChar LaTeX - or AAS\SpecialChar TeX - and run \SpecialChar LaTeX - on -\family typewriter -sample.tex -\family default -. -\end_layout +\change_deleted 564990737 1669742044 -\begin_layout Enumerate -Make certain that +\family sans +Institute \family typewriter -aastex.layout + \family default - appears in \SpecialChar LyX -'s -\family typewriter -layouts +to mark corresponding author\SpecialChar breakableslash +institute pairs. + The institutes are numbered sequentially as they appear in the +\family sans +Address \family default - folder + field, so you have to put a marker to each author. \end_layout -\begin_layout Enumerate -Rerun +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + \family sans -Tools\SpecialChar menuseparator -Reconfigure +Email \family default - in \SpecialChar LyX -, then restart \SpecialChar LyX -. + to supply an email address for fast contact. \end_layout -\begin_layout Enumerate -Open a regular new file, not from a template. - Does AAS\SpecialChar TeX - appear in the class list in -\family sans -Document\SpecialChar menuseparator -Settings +\begin_layout Standard + +\change_deleted 564990737 1669742044 +In addition to these topics, the macros use one additional \SpecialChar LaTeX + command that + has no counterpart in \SpecialChar LyX +: +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669742044 + +\family typewriter + +\backslash +and \family default -? + to separate different names for more than one author and institute, respectivel +y. \end_layout \begin_layout Standard -If you get a warning from an existing AAS\SpecialChar TeX - document about not being able - to find the AAS\SpecialChar TeX - layout or a message about -\begin_inset Quotes eld -\end_inset - -You should not mix title layouts with normal ones -\begin_inset Quotes erd -\end_inset -, things haven't been installed correctly. +\change_deleted 564990737 1669742044 +The appropriate command has to be entered in \SpecialChar LyX + and marked as \SpecialChar LaTeX + code. + See the examples. + \end_layout -\begin_layout Subsubsection -\SpecialChar LaTeX - error processing a table +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +The abstract \end_layout \begin_layout Standard -\SpecialChar LyX -, by default, attempts to center the table caption/title. - This seems to produce a bad interaction in AAS\SpecialChar TeX - so you should click somewhere - in the caption/title, then select -\family sans -Edit\SpecialChar menuseparator -Paragraph -\begin_inset space ~ -\end_inset -Settings -\family default -, then set the -\family sans -Alignment -\family default - to +\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 -Block +Keywords \family default . - This took care of it for me. + Refer to the example paper. \end_layout -\begin_layout Subsubsection -References +\begin_layout Subsection + +\change_deleted 564990737 1669742044 +Supported environments \end_layout \begin_layout Standard -A couple of things: 1) I have noticed some funny spacing in the reference - entries in the text. - When you enter the bibliography item data, make sure their is -\emph on -no -\emph default - space between the last author and the parenthesis setting off the year; - -\emph on -e. -\begin_inset space \thinspace{} -\end_inset -g. -\begin_inset space \space{} -\end_inset +\change_deleted 564990737 1669742044 +The A&A paper layout supports the following environments for structuring + your text: +\end_layout +\begin_layout Itemize + +\change_deleted 564990737 1669742044 -\emph default -type -\family typewriter -Ressler(1992) -\family default -, not -\family typewriter -Ressler (1992) -\family default -. - 2) Entering the references at all is not obvious. - The easiest thing is to start typing your first reference at the end of - the document, then mark it as type \family sans -References -\family default -. - That will put a small gray box in front of what you just typed. - Click on the box to fill in the rest of the information. - For new references, go to the end of an existing reference and press return. - That will create a new line with its own box, etc. +Standard \end_layout -\begin_layout Subsubsection -Including EPS files -\end_layout +\begin_layout Itemize -\begin_layout Standard -Even though AAS\SpecialChar TeX - provides its own figure commands ( -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -plotone -\family default -, for example), I much prefer \SpecialChar LaTeX -'s standard figure commands (with the default - graphicx). - You can insert the -\family typewriter +\family sans +Section +\end_layout -\backslash -plotone -\family default -, etc. -\begin_inset space ~ -\end_inset +\begin_layout Itemize -commands as \SpecialChar TeX - code into a Figure Float box if you desire, but I never have - much luck getting the layout right. - With the standard graphics, \SpecialChar LyX - will insert a -\family typewriter +\change_deleted 564990737 1669742044 -\backslash -usepackage{graphicx} -\family default - command into the \SpecialChar LaTeX - preamble and handle the figures in the standard \SpecialChar LaTeX2e - way, - interspersing the figures in the text. - I believe ApJ accepts figures exactly this way now; AJ might still use - the -\begin_inset Quotes eld -\end_inset +\family sans +Subsection +\end_layout -stack everything at the end -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - technique. -\end_layout +\change_deleted 564990737 1669742044 -\begin_layout Subsubsection -Things I could have done, but didn't +\family sans +Subsubsection \end_layout -\begin_layout Standard -There are a few -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -pretty -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669742044 - things I could have implemented, but chose not to. - For instance, I saw no point in double-spacing the text in the \SpecialChar LyX - window, - even though it is double-spaced in the paper manuscript. - Also, I chose not to make separate layouts for the preprint and preprint2 - styles. - Since I assume you will spend most of your time in the plain manuscript - mode anyway, I decided not to chew up more disk space with this. - -\end_layout - -\begin_layout Subsection -Final Caveat +\family sans +Itemize \end_layout -\begin_layout Standard -Your mileage may vary. - I've now had papers published by both ApJ and AJ that have had 98% of the - effort done in \SpecialChar LyX -; the last 2% was the \SpecialChar LaTeX - post-processing and a few cleanups. - I have had no trouble with the submission process, and I'm sure the journals - were never aware that there might be a difference. - So, go forth and publish! -\end_layout +\begin_layout Itemize -\begin_layout Section -Broadway -\end_layout +\change_deleted 564990737 1669742044 -\begin_layout Standard -by -\shape smallcaps -Garst Reese +\family sans +Enumerate \end_layout -\begin_layout Subsection -Introduction -\end_layout +\begin_layout Itemize -\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 +\change_deleted 564990737 1669742044 -\begin_layout Subsection -Special problems +\family sans +Description \end_layout -\begin_layout Standard -The same as in Hollywood. -\end_layout +\begin_layout Itemize -\begin_layout Subsection -Special features -\end_layout +\change_deleted 564990737 1669742044 -\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 Subsection -Paper size and Margins +Caption \end_layout -\begin_layout Standard -USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in -\end_layout +\begin_layout Itemize -\begin_layout Subsection -Environments -\end_layout +\change_deleted 564990737 1669742044 -\begin_layout Standard -The following environments are available. - You can use broadway.bind to get the bind keys shown at the right. +\family sans +Abstract \end_layout \begin_layout Itemize -\family sans -Standard -\begin_inset Newline newline -\end_inset - +\change_deleted 564990737 1669742044 -\family default -You should not have to use this, but it is here for anything that does not - fit otherwise. +\family sans +Acknowledgment \end_layout \begin_layout Itemize -\family sans -Narrative -\begin_inset space \hfill{} -\end_inset - -M-z n -\begin_inset Newline newline -\end_inset - +\change_deleted 564990737 1669742044 -\family default -Used to describe stage setting and the action. - First use of speaker names in all CAPs. +\family sans +Bibliography \end_layout \begin_layout Itemize -\family sans -ACT -\begin_inset space \hfill{} -\end_inset - -M-z a -\begin_inset Newline newline -\end_inset +\change_deleted 564990737 1669742044 +\family sans +\SpecialChar LaTeX -\family default -Automatically numbered. - On screen it will be arabic, but will print as Roman. \end_layout -\begin_layout Itemize +\begin_layout Subsection -\family sans -ACT* -\begin_inset space \hfill{} -\end_inset +\change_deleted 564990737 1669742044 +Commands not supported by \SpecialChar LyX -M-z S at -\begin_inset Newline newline -\end_inset +\end_layout +\begin_layout Standard -\family default -Subtitle for +\change_deleted 564990737 1669742044 +Some commands are not yet supported by the \family sans -ACT. - +paper (A&A) \family default - It is just centered text. + 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 -\family sans -SCENE -\begin_inset space \hfill{} -\end_inset - -M-z S-S -\begin_inset Newline newline -\end_inset +\change_deleted 564990737 1669742044 +\family typewriter -\family default -Not automatically numbered. - You supply the number. - This is because I couldn't figure out how. +\backslash +and \end_layout \begin_layout Itemize -\family sans -AT_RISE: -\begin_inset space \hfill{} -\end_inset - -M-z S-R -\begin_inset Newline newline -\end_inset +\change_deleted 564990737 1669742044 +\family typewriter -\family default -A special case of Narrative to describe the setting and action as the curtain - rises. +\backslash +authorrunning \end_layout \begin_layout Itemize -\family sans -Speaker -\begin_inset space \hfill{} -\end_inset - -M-z s -\begin_inset Newline newline -\end_inset +\change_deleted 564990737 1669742044 +\family typewriter -\family default -The speaker's (actor's) title, centered in all CAPS. +\backslash +object{} \end_layout \begin_layout Itemize -\family sans -Parenthetical -\begin_inset space \hfill{} -\end_inset - -M-z p -\begin_inset Newline newline -\end_inset +\change_deleted 564990737 1669742044 +\family typewriter -\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 -. +\backslash +titlerunning{} \end_layout -\begin_layout Itemize - -\family sans -Dialogue -\begin_inset space \hfill{} -\end_inset +\begin_layout Standard -M-z d -\begin_inset Newline newline -\end_inset +\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 -\family default -What the Speaker says. +\change_deleted 564990737 1669742044 +Figure and Table Floats \end_layout -\begin_layout Itemize +\begin_layout Standard +\change_deleted 564990737 1669742044 +\SpecialChar LyX + provides support for the necessary float environments \family sans -CURTAIN -\begin_inset space \hfill{} -\end_inset - -M-z S-C -\begin_inset Newline newline -\end_inset - - +figure, figure*, table \family default -The curtain comes down. -\end_layout - -\begin_layout Itemize - + and \family sans -Title -\begin_inset space \hfill{} +table* +\family default +, therefore we won't tell much about it here. + Refer to the +\emph on +User's +\begin_inset space ~ \end_inset -M-z S-T -\end_layout - -\begin_layout Itemize - +Guide +\emph default +. + Just remember that tables should be left-aligned. + For that, select the table and change the alignment in \family sans -Author -\begin_inset space \hfill{} +Edit\SpecialChar menuseparator +Paragraph +\begin_inset space ~ \end_inset -M-z S-A +Settings. \end_layout -\begin_layout Itemize +\begin_layout Standard + +\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 Enumerate +\change_deleted 564990737 1669742044 +Create a wide figure float: \family sans -Right_Address -\begin_inset space \hfill{} +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 -M-z r +columns +\family default +. \end_layout -\begin_layout Standard -Hello there. -\end_layout +\begin_layout Enumerate -\begin_layout Section -Dinbrief +\change_deleted 564990737 1669742044 +Enter your caption text. \end_layout -\begin_layout Standard -The document class +\begin_layout Enumerate + +\change_deleted 564990737 1669742044 +Press \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 +Return \family default - for you to use as a starting point. + to move the cursor above the caption. \end_layout -\begin_layout Section -Elsevier Journals +\begin_layout Enumerate + +\change_deleted 564990737 1669742044 +Insert your figure \end_layout -\begin_layout Standard -See the \SpecialChar LyX - template file -\family typewriter -elsarticle.lyx +\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 + +Fill \family default . - It contains all infos you need. \end_layout -\begin_layout Section -Foils [aka +\begin_layout Enumerate + +\change_deleted 564990737 1669742044 +Switch to \SpecialChar LaTeX + mode: \family sans -Foil\SpecialChar TeX +M-c +\begin_inset space ~ +\end_inset +t \family default -] -\begin_inset CommandInset label -LatexCommand label -name "sec:foiltex" - -\end_inset +. +\end_layout +\begin_layout Enumerate -\end_layout +\change_deleted 564990737 1669742044 +Enter +\family typewriter -\begin_layout Standard -by -\noun on -Allan Rae +\backslash +parbox[b]{55mm}{ +\family default +. + +\series bold +Do not close the brace! \end_layout -\begin_layout Subsection -Introduction -\end_layout +\begin_layout Enumerate -\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 +\change_deleted 564990737 1669742044 +Position the cursor behind the caption text, switch to \SpecialChar LaTeX + mode and insert + the closing brace: \family sans -Foil\SpecialChar TeX +M-c +\begin_inset space ~ +\end_inset +t \family default - slides class. - This section documents the latter. + +\family typewriter +} +\family default +. \end_layout \begin_layout Standard -I'm going to say this again, nice and clear, so that there's no misunderstanding -: -\end_layout -\begin_layout Standard -\begin_inset VSpace bigskip -\end_inset +\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 -\align center - -\size large -This section documents the class -\begin_inset Quotes eld -\end_inset - +\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 -FoilTeX +Document\SpecialChar menuseparator +Settings \family default - -\begin_inset Quotes erd -\end_inset - - -\emph on -only. + dialog. + Just enter the string +\family typewriter +referee +\family default + there. \end_layout -\begin_layout Standard -\begin_inset VSpace bigskip -\end_inset - +\begin_layout Subsection +\change_deleted 564990737 1669742044 +The example paper \end_layout \begin_layout Standard -If you're looking for the documentation for -\begin_inset Quotes eld -\end_inset - +\change_deleted 564990737 1669742044 +The \family sans -slides (default) +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 +. + Use it for inspiration, and compare the original \SpecialChar LaTeX + code with \SpecialChar LyX + way of writing. +\end_layout -\begin_inset Quotes erd -\end_inset - -, check out section -\begin_inset space ~ -\end_inset +\begin_layout Section +AAS\SpecialChar TeX +\end_layout -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:slitex" +\begin_layout Standard +by +\noun on +Mike Ressler +\end_layout -\end_inset +\begin_layout Subsection +Introduction +\end_layout -. - If your machine doesn't have the -\family sans -foils -\family default - class -\family sans -FoilTeX -\family default - installed, you'll probably have to use the default -\family sans -slides -\family default - class, which isn't quite as good as -\family sans -foils. +\begin_layout Standard +AAS\SpecialChar TeX + is a set of macros produced by the American Astronomical Society to + facilitate electronic manuscript submission to the three journals they + publish: the Astrophysical Journal (including the Letters and Supplement), + the Astronomical Journal, and the Publications of the Astronomical Society + of the Pacific. + \SpecialChar LyX + has proven to be an excellent tool for generating these documents, especially + given its equation, citation, and figure handling capabilities. + \SpecialChar LyX + requires version 5.0 (or higher) of these macros; preferably 6.0, which + is the version described here, or higher. + Versions prior to 5.0 are intended for use with \SpecialChar LaTeX +2.09 and are fundamentally + incompatible with \SpecialChar LyX +. + The AAS\SpecialChar TeX + package may be downloaded from the AAS\SpecialChar TeX + Web site \end_layout \begin_layout Standard -The -\family sans -foils -\family default - class is designed for use with version -\begin_inset space ~ +\begin_inset VSpace medskip \end_inset -2.1 of the -\family sans -foils.cls -\family default - \SpecialChar LaTeX - class file which is now an integral part of \SpecialChar LaTeX2e -. -\end_layout -\begin_layout Subsection -Getting Started \end_layout \begin_layout Standard -Obviously, to use this document class, you need to select -\family sans -FoilTeX -\family default - from the -\family sans -Class -\family default - entry in the -\family sans -Document -\begin_inset space ~ -\end_inset +\align center +\begin_inset Flex URL +status collapsed -Layout -\family default - dialog. - There are some settings in the -\family sans -Document -\begin_inset space ~ -\end_inset +\begin_layout Plain Layout -Layout -\family default - dialog that you should know about that are specific to this class: +https://aas.org/aastex/aastex-downloads \end_layout -\begin_layout Itemize -Don't change the options -\family sans -Sides -\family default - and -\family sans -Columns -\family default - on the -\family sans -Document -\begin_inset space ~ \end_inset -Layout -\family default - dialog. - They're ignored by the -\family sans -foils -\family default - class. + \end_layout -\begin_layout Itemize -The default font size is 20 -\begin_inset space \thinspace{} +\begin_layout Standard +\begin_inset VSpace medskip \end_inset -pt with the other options being 17 -\begin_inset space \thinspace{} -\end_inset -pt, 25 -\begin_inset space \thinspace{} -\end_inset +\end_layout -pt and 30 -\begin_inset space \thinspace{} -\end_inset +\begin_layout Standard +A complete user guide is contained in that package and you should familiarize + yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX +. + \SpecialChar LyX + will not reduce the need to figure out all the AAS\SpecialChar TeX + commands, it will only + reduce the drudgery of typing everything in. + It is your responsibility to ensure that the final exported \SpecialChar LaTeX + document conforms + completely to the requirements of the journal to which you are submitting + your paper. +\end_layout -pt. +\begin_layout Subsection +Starting a New Paper \end_layout -\begin_layout Itemize -The default font is +\begin_layout Standard +I strongly suggest that you start with the AAS\SpecialChar TeX + template file. + Click on \family sans -sans +File\SpecialChar menuseparator +New from \family default \family sans -serif +Template \family default - but all math equations are still typeset in the usual roman font. +, enter the new file name, then choose the +\family typewriter +aastex6.lyx +\family default + template. + This will show the most common fields found in a manuscript. + Simply overwrite the existing text (including the brackets, +\family typewriter +<> +\family default +) with the correct information. + Many of the AAS\SpecialChar TeX + commands and environments can be implemented directly in + \SpecialChar LyX +, but some cannot. + For commands such as these, the \SpecialChar LaTeX + code must be entered directly and marked + as such. + Such commands are referred to as \SpecialChar TeX + code, or Evil Red Text. + I tried to minimize the amount of \SpecialChar TeX + code needed in an AAS\SpecialChar TeX + document. \end_layout -\begin_layout Itemize +\begin_layout Subsection +Finishing Your Paper +\end_layout -\family sans -Foil\SpecialChar TeX +\begin_layout Standard +When the paper is finished to your satisfaction and previews/prints correctly, + there are a few +\begin_inset Quotes eld +\end_inset -\family default - supports A4 and Letter paper sizes as well as a special size for working - with 35 -\begin_inset space \thinspace{} +postprocessing +\begin_inset Quotes erd \end_inset -mm slides. - It doesn't support A5, B5, legal or executive paper sizes. + actions which need to be done before you submit it to the journals. + \end_layout -\begin_layout Itemize -Don't bother changing the +\begin_layout Enumerate +Export your paper as a \SpecialChar LaTeX + file ( \family sans -Float Placement -\family default - settings because they are ignored anyway. - All floats appear where they are defined in the text. -\end_layout +File\SpecialChar menuseparator +Export\SpecialChar menuseparator +\SpecialChar LaTeX -\begin_layout Itemize -The -\family sans -Pagestyle \family default - setting behaves a bit differently for this class. +). -\family sans -Foil\SpecialChar TeX +\end_layout +\begin_layout Enumerate +Edit the resulting +\family typewriter +.tex \family default - provides extensive footer and header capabilities including a user-defined - logo. - See section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:foilfoot" - -\end_inset - - for more details. - The title page is treated differently to all other pages in the document - and is -\emph on -always -\emph default - unnumbered and -\emph on -always -\emph default - has the logo centered at the bottom of the page (if one is defined). - The possible page style choices and what they do are as follows: + file with your favorite text editor \end_layout \begin_deeper -\begin_layout Labeling -\labelwidthstring MMMMMMM +\begin_layout Enumerate +remove the comment lines before the +\family typewriter -\family sans -\series bold -empty +\backslash +documentclass \family default -\series default - The final output contains no page numbers, or other headers or footers - (except footnotes of course). - + command \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMM +\begin_layout Enumerate +remove the +\family typewriter -\family sans -\series bold -plain +\backslash +usepackage...{fontenc} \family default -\series default - The final output contains page numbers centered at the bottom of the page. - No other headings or footers (other than footnotes). -\end_layout + line if it appears (usually just after +\family typewriter -\begin_layout Labeling -\labelwidthstring MMMMMMM +\backslash +documentclass +\family default +}; also remove the +\family typewriter -\series bold -foilheadings -\series default - Page numbers in lower right corner. - Additional headers and footers are also shown. - This is also the default. +\backslash +secnumdepth +\family default + line if it appears. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMM +\begin_layout Enumerate +remove everything between (and including) the +\family typewriter -\series bold -fancy -\series default - Gives you access to the -\family sans -fancyheadings +\backslash +makeatletter \family default - package although its use with -\family sans -Foil\SpecialChar TeX + and +\family typewriter +\backslash +makeatother \family default - is discouraged by the writer of the -\family sans -Foil\SpecialChar TeX + commands, except for any commands you specifically put into the \SpecialChar LaTeX + preamble + (which should appear immediately after the +\begin_inset Quotes eld +\end_inset + +User specified \SpecialChar LaTeX + commands +\begin_inset Quotes erd +\end_inset + comment in the +\family typewriter +.tex \family default - package because of some potential page layout clashes. + file). \end_layout \end_deeper -\begin_layout Subsubsection -Extra Options +\begin_layout Enumerate +Run the resulting file through \SpecialChar LaTeX + to make sure it still processes correctly. \end_layout -\begin_layout Standard -The following options may be used in the extra class options in the -\family sans -Document\SpecialChar menuseparator -Settings -\family default - dialog. +\begin_layout Enumerate +Reread the journal requirements to make sure your filenames and formats + are correct. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMx - -\series bold -35mmSlide -\series default - This sets up the page layout for 7.33 -\begin_inset space \thinspace{} -\end_inset - -in by 11 -\begin_inset space \thinspace{} -\end_inset - -in paper, which is about the same aspect ratio as a 35 -\begin_inset space \thinspace{} -\end_inset +\begin_layout Enumerate +Submit it. +\end_layout -mm slide, making it a bit easier to work with this medium. +\begin_layout Subsection +Comments On Specific Commands \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMx +\begin_layout Standard +I will not describe the detailed usage of the individual AAS\SpecialChar TeX + commands: the + AAS\SpecialChar TeX + User Guide ( +\family typewriter +aasguide.tex +\family default +) gives a good description of each. + Thus it's probably easiest for me to go down the list as found in the guide + and offer comments where necessary. + So let's begin \SpecialChar ldots -\series bold -headrule -\series default - Places a rule across the page below the header on every page except the - title page. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMx - -\series bold -footrule -\series default - Places a rule across the page above the footer on every page except the - title page. +\begin_layout Subsubsection +Things that work as expected \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMx +\begin_layout Standard +Because they work as you might expect, I simply list them and the section + they are found in: +\family typewriter -\series bold -dvips -\series default - This is automatically set each time you create a new -\family sans -foils +\backslash +documentclass \family default - document. - This option tells -\family sans -Foil\SpecialChar TeX + (2.1.1), +\family typewriter +\backslash +begin{document} \family default - to use the dvips driver to rotate those pages that are set as landscape - foils. -\end_layout - -\begin_layout Labeling -\labelwidthstring MMMMMMx + (2.2), +\family typewriter -\series bold -landscape -\series default - Simply changes the page dimensions to those of a landscape page but doesn't - do any rotation. - Thus if you use this option you need to use an external program to rotate - each page or feed your paper through your printer as landscape. - Note that this option effectively reverses the roles of the -\family sans -Foilhead +\backslash +title \family default - and -\family sans -Rotatefoilhead + (2.3), +\family typewriter + +\backslash +author \family default - environments (don't worry these are described in the next section). -\end_layout + (2.3), +\family typewriter -\begin_layout Labeling -\labelwidthstring MMMMMMx +\backslash +affil +\family default + (2.3), +\family typewriter -\series bold -leqno -\series default - Equation numbers on the left. -\end_layout +\backslash +abstract +\family default + (2.4), +\family typewriter -\begin_layout Labeling -\labelwidthstring MMMMMMx +\backslash +keywords +\family default + (2.5), +\family typewriter -\series bold -fleqn -\series default - Flush-left equations. -\end_layout +\backslash +section +\family default + (2.7), +\family typewriter -\begin_layout Subsection -Supported Environments -\end_layout +\backslash +subsection +\family default + (2.7), +\family typewriter -\begin_layout Standard -Most of the environments commonly supported in other classes are also supported - by the -\family sans -foils +\backslash +subsubsection \family default - class. - There are several additional environments provided by -\family sans -Foil\SpecialChar TeX + (2.7), +\family typewriter +\backslash +paragraph \family default - as well as a couple added by \SpecialChar LyX -. - The following environments are shared with other classes: -\end_layout + (2.7), +\family typewriter -\begin_layout Standard -\begin_inset Flex Multiple Columns -status open +\backslash +facility +\family default + (2.10), +\family typewriter -\begin_layout Itemize +\backslash +begin{displaymath} +\family default + (2.12), +\family typewriter -\family sans -Standard -\end_layout +\backslash +begin{equation} +\family default + (2.12), +\family typewriter -\begin_layout Itemize +\backslash +begin{eqnarray} +\family default + (2.12), +\family typewriter -\family sans -Itemize -\end_layout +\backslash +begin{mathletters} +\family default + (2.12), +\family typewriter -\begin_layout Itemize +\backslash +begin{thebibliography} +\family default + (2.13.1), +\family typewriter -\family sans -Enumerate -\end_layout +\backslash +bibitem +\family default + (2.13.2), all the cite commands and their variations (2.13.2), the generic + graphicx figure commands (2.14.1), +\family typewriter -\begin_layout Itemize +\backslash +begin{table} +\family default + (2.15.4), +\family typewriter -\family sans -Description -\end_layout +\backslash +begin{tabular} +\family default + (2.15.4), +\family typewriter -\begin_layout Itemize +\backslash +caption +\family default + (2.15.4), +\family typewriter -\family sans -List -\end_layout +\backslash +label +\family default + (2.15.4, amongst other places), +\family typewriter -\begin_layout Itemize +\backslash +tablerefs +\family default + (2.15.5), +\family typewriter -\family sans -\SpecialChar LyX --Code -\end_layout +\backslash +tablecomments +\family default + (2.15.5), +\family typewriter -\begin_layout Itemize +\backslash +url +\family default + (2.17.4), +\family typewriter -\family sans -Verse +\backslash +end{document} +\family default + (2.18). \end_layout -\begin_layout Itemize - +\begin_layout Standard +The following style options also work correctly: +\family typewriter +longabstract +\family default + (2.4), +\family typewriter +preprint +\family default + (3.2.1), +\family typewriter +preprint2 +\family default + (3.2.2), +\family typewriter +eqsecnum +\family default + (3.3), +\family typewriter +flushrt +\family default + (3.4). + Simply put them in the \family sans -Quote +Options +\family default + box in +\family sans +Layout\SpecialChar menuseparator +Document +\family default +. \end_layout -\begin_layout Itemize +\begin_layout Subsubsection +Things that work, but require more comment +\end_layout -\family sans -Quotation +\begin_layout Standard +The following items work, but require a little more discussion: \end_layout \begin_layout Itemize +These items are reserved for use by the journal editors, but you can put + them into the \SpecialChar LaTeX + preamble if you feel compelled to do so: +\family typewriter -\family sans -TitleAuthor -\end_layout +\backslash +received +\family default +, +\family typewriter -\begin_layout Itemize +\backslash +revised +\family default +, +\family typewriter -\family sans -Date -\end_layout +\backslash +accepted +\family default +, +\family typewriter -\begin_layout Itemize +\backslash +ccc +\family default +, +\family typewriter -\family sans -Abstract +\backslash +cpright +\family default + (all from 2.1.3) \end_layout \begin_layout Itemize +These items may be placed in the \SpecialChar LaTeX + preamble, and are included as blanks in + the template file: +\family typewriter -\family sans -Bibliography -\end_layout +\backslash +slugcomment +\family default + (2.1.4), +\family typewriter -\begin_layout Itemize +\backslash +shorttitle +\family default + (2.1.5), +\family typewriter -\family sans -Address +\backslash +shortauthors +\family default + (2.1.5) \end_layout \begin_layout Itemize -\family sans -RightAddress -\end_layout +\family typewriter +\backslash +email +\family default + (2.3) – can only be used +\begin_inset Quotes eld \end_inset +standalone +\begin_inset Quotes erd +\end_inset +, not in the middle of a paragraph. + Use \SpecialChar TeX + code if you need to embed it. \end_layout -\begin_layout Standard -That is, all the major environments apart from the sectioning environments. - Since foils are essentially self-contained sections, with a title and body, - -\family sans -Foil\SpecialChar TeX +\begin_layout Itemize + +\family typewriter +\backslash +and \family default - provides specific commands for starting new foils and these are: + (2.3) – will have extra {} after it. + This should not cause an error. \end_layout \begin_layout Itemize -\family sans -Foilhead -\end_layout +\family typewriter -\begin_layout Itemize +\backslash +notetoeditor +\family default + (2.6) – can only be used +\begin_inset Quotes eld +\end_inset -\family sans -Rotatefoilhead -\end_layout - -\begin_layout Standard -\SpecialChar LyX - also provides slightly modified versions of these two environments called: -\end_layout - -\begin_layout Itemize - -\family sans -ShortFoilhead +standalone +\begin_inset Quotes erd +\end_inset + +, not in the middle of a paragraph. + Use \SpecialChar TeX + code if you need to embed it. \end_layout \begin_layout Itemize -\family sans -ShortRotatefoilhead -\end_layout - -\begin_layout Standard -and the differences will be explained in the next section. -\end_layout - -\begin_layout Standard -Since foils are often used in presenting ideas or new theorems and such - -\family sans -Foil\SpecialChar TeX +\family typewriter +\backslash +placetable \family default - also provides a comprehensive box of goodies for presenting them: + (2.8) – can't insert a cross-reference tag, you must type the tag name by + hand \end_layout -\begin_layout Standard -\begin_inset Flex Multiple Columns -status open - \begin_layout Itemize -\family sans -Theorem -\end_layout +\family typewriter -\begin_layout Itemize +\backslash +placefigure +\family default + (2.8) – same as for +\family typewriter -\family sans -Lemma +\backslash +placetable \end_layout \begin_layout Itemize -\family sans -Corollary -\end_layout - -\begin_layout Itemize +\family typewriter -\family sans -Proposition +\backslash +acknowledgements +\family default + (2.9) – will have extra {} after it. + This should not cause an error. \end_layout \begin_layout Itemize -\family sans -Definition -\end_layout - -\begin_layout Itemize +\family typewriter -\family sans -Proof +\backslash +appendix +\family default + (2.11) – will have extra {} after it. + This should not cause an error. \end_layout \begin_layout Itemize +\family typewriter + +\backslash +figcaption +\family default + (2.14.2) – you can insert an optional filename argument by placing the cursor + at the beginning of the text and selecting \family sans -Theorem* -\end_layout +Insert\SpecialChar menuseparator +Short Title +\family default +. + +\begin_inset Quotes eld +\end_inset -\begin_layout Itemize +Short Title +\begin_inset Quotes erd +\end_inset -\family sans -Lemma* + inserts an optional argument of the type needed by +\family typewriter + +\backslash +figcaption +\family default +. + Hopefully it will be renamed someday. \end_layout \begin_layout Itemize -\family sans -Corollary* -\end_layout +\family typewriter -\begin_layout Itemize +\backslash +objectname +\family default + (2.17.1) – same as +\family typewriter -\family sans -Proposition* +\backslash +figcaption +\family default + for the catalog ID optional parameter \end_layout \begin_layout Itemize -\family sans -Definition* -\end_layout +\family typewriter -\end_inset +\backslash +dataset +\family default + (2.17.1) – same as +\family typewriter +\backslash +figcaption +\family default + for the catalog ID optional parameter +\end_layout +\begin_layout Subsubsection +Things not implemented, use \SpecialChar TeX + code \end_layout \begin_layout Standard -The starred versions are unnumbered while the unstarred versions are numbered. - There are also two list environments added by \SpecialChar LyX - and these are: -\end_layout -\begin_layout Itemize +\family typewriter -\family sans -TickList -\end_layout +\backslash +eqnum +\family default + (2.12), +\family typewriter -\begin_layout Itemize +\backslash +setcounter{equation} +\family default + (2.12), Journal name abbreviations (2.13.4), +\family typewriter -\family sans -CrossList -\end_layout +\backslash +figurenum +\family default + (2.14.1), +\family typewriter -\begin_layout Standard +\backslash +epsscale +\family default + (2.14.1), +\family typewriter -\family sans -Foil\SpecialChar TeX +\backslash +plotone +\family default + (2.14.1), +\family typewriter +\backslash +plottwo \family default - provides some powerful header and footer capabilities that are best set - in the preamble although they may be set at any point in a document. - If you want to change these settings in your document the best place to - do so is at the very top of a foil, i. -\begin_inset space \thinspace{} -\end_inset + (2.14.1), +\family typewriter -e. -\emph on +\backslash +tablenum +\family default + (2.15.4), +\family typewriter -\begin_inset space \space{} -\end_inset +\backslash +tableline +\family default + (2.15.4, insert it as the first element in the lefthand cell after where + you want it. + Don't use any of \SpecialChar LyX +'s rules in the table), +\family typewriter +\backslash +tablenotemark +\family default + (2.15.5), +\family typewriter -\emph default -straight after the foilhead. -\end_layout +\backslash +tablenotetext +\family default + (2.15.5), much of Misc (2.17, except +\family typewriter -\begin_layout Standard -For this purpose, the following command styles are provided [ -\shape smallcaps -Martin Vermeer -\shape default -]: -\end_layout +\backslash +objectname +\family default +, +\family typewriter -\begin_layout Standard -\begin_inset Flex Multiple Columns -status open +\backslash +dataset +\family default +, +\family typewriter -\begin_layout Itemize +\backslash +url +\family default +, and +\family typewriter -\family sans -My -\begin_inset space ~ -\end_inset +\backslash +email +\family default +; see above), +\family typewriter -Logo -\end_layout - -\begin_layout Itemize - -\family sans -Restriction -\end_layout +\backslash +singlespace +\family default + (3.1), +\family typewriter -\begin_layout Itemize +\backslash +doublespace +\family default + (3.1), +\family typewriter -\family sans -Right -\begin_inset space ~ -\end_inset +\backslash +onecolumn +\family default + (3.2), +\family typewriter -Footer +\backslash +twocolumn +\family default + (3.2) \end_layout -\begin_layout Itemize - -\family sans -Right -\begin_inset space ~ -\end_inset - -Header +\begin_layout Subsubsection +Things that cannot be implemented \end_layout -\begin_layout Itemize - +\begin_layout Standard +\SpecialChar ldots + at least in any meaningful sort of way, so I suggest ignoring them. + They are the references environment (2.13.3), and the deluxetable environment + (2.15). + If you really, really need to use deluxetable, I suggest editing it in + a separate file with a text editor, then using \family sans -Left +Insert\SpecialChar menuseparator +Child \begin_inset space ~ \end_inset -Header +Document +\family default + to include it in your \SpecialChar LyX + document. + See the +\family typewriter +aas_sample.lyx +\family default + file to see an example of this. \end_layout -\begin_deeper -\begin_layout Plain Layout -\begin_inset space ~ -\end_inset - - +\begin_layout Subsection +FAQs, Tips, Tricks, and Other Ruminations \end_layout -\end_deeper -\end_inset - - +\begin_layout Subsubsection +Getting \SpecialChar LyX + and AAS\SpecialChar TeX + to cooperate \end_layout \begin_layout Standard -There are also a few commands provided by -\family sans -Foil\SpecialChar TeX +It can be a bit tricky to get \SpecialChar LyX + to recognize a new layout and document class. + When all else fails, do this: +\end_layout +\begin_layout Enumerate +Make certain that \SpecialChar LaTeX + can find AAS\SpecialChar TeX +. + Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX + distribution into a + directory completely unrelated to \SpecialChar LaTeX + or AAS\SpecialChar TeX + and run \SpecialChar LaTeX + on +\family typewriter +sample.tex \family default - that aren't directly supported by \SpecialChar LyX - but I'll tell you what they do and how - to use them in section -\begin_inset space ~ -\end_inset - - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:unsuppfoils" - -\end_inset - . \end_layout -\begin_layout Subsection -Building a Set of Foils -\end_layout - -\begin_layout Standard -This section will give a simple introduction to using the different environments - to build a set of foils. - If you want to see an example set of foils, take a look at the +\begin_layout Enumerate +Make certain that \family typewriter -Foils.lyx +aastex.layout \family default - file you find in \SpecialChar LyX + appears in \SpecialChar LyX 's \family typewriter -examples +layouts \family default - folder. -\end_layout - -\begin_layout Subsubsection -Give It a Title Page + folder \end_layout -\begin_layout Standard -Unlike other classes that provide -\family sans -Title -\family default -, -\family sans -Author -\family default -, -\family sans -Date -\family default - and -\family sans -Abstract -\family default - environments, -\family sans -foils -\family default - creates the title on a page of its own. - If you leave out the +\begin_layout Enumerate +Rerun \family sans -Date +Tools\SpecialChar menuseparator +Reconfigure \family default - environment \SpecialChar LaTeX - will substitute the current date (every time you regenerate - the output). + in \SpecialChar LyX +, then restart \SpecialChar LyX +. \end_layout -\begin_layout Subsubsection -Start a New Foil +\begin_layout Enumerate +Open a regular new file, not from a template. + Does AAS\SpecialChar TeX + appear in the class list in +\family sans +Document\SpecialChar menuseparator +Settings +\family default +? \end_layout \begin_layout Standard -As I mentioned earlier, there are four ways of starting a new foil. - For portrait foils you should use -\family sans -Foilhead -\family default - or -\family sans -ShortFoilhead. +If you get a warning from an existing AAS\SpecialChar TeX + document about not being able + to find the AAS\SpecialChar TeX + layout or a message about +\begin_inset Quotes eld +\end_inset -\family default - The difference between these two environments is the amount of space between - the title of the foil (the foilhead) and the body of the foil. +You should not mix title layouts with normal ones +\begin_inset Quotes erd +\end_inset + +, things haven't been installed correctly. +\end_layout + +\begin_layout Subsubsection +\SpecialChar LaTeX + error processing a table \end_layout \begin_layout Standard -Landscape foils are generated using the -\family sans -Rotatefoilhead -\family default - and +\SpecialChar LyX +, by default, attempts to center the table caption/title. + This seems to produce a bad interaction in AAS\SpecialChar TeX + so you should click somewhere + in the caption/title, then select \family sans -ShortRotatefoilhead -\family default - environments. - Again the only difference is the spacing between foilhead and body. - Both of the short versions have 0.5 +Edit\SpecialChar menuseparator +Paragraph \begin_inset space ~ \end_inset -inches less separation between the foilhead and the body. - -\end_layout - -\begin_layout Standard -One problem with the support for landscape foils is the requirement that - you have to use the -\family typewriter -dvips +Settings \family default - driver to generate the PostScript output otherwise the foils won't be rotated. - It is possible to get landscape foils even if you haven't got the -\family typewriter -dvips +, then set the +\family sans +Alignment \family default - driver provided you can feed your foils sideways through your printer ;-) + to +\family sans +Block +\family default +. + This took care of it for me. \end_layout \begin_layout Subsubsection -Theorems, Lemmas, Proofs and more +References \end_layout \begin_layout Standard -You can't have two of the same type of these environments directly following - each other. - If you use a normal paragraph break, , you will just be extending the previous - environment as if you had merged the two environments together. - Rather than that, you need to insert a so-called separator. - Please refer to the section entitled -\emph on -Separate Nestings -\emph default - in the -\emph on -User's Guide -\emph default -. -\end_layout - -\begin_layout Subsubsection -Lists -\end_layout - -\begin_layout Standard -You get all the commonly supported list styles found in other classes as - well as two new ones. - I'll only describe the new ones here. - If you want to find out more about the other list environments check out - the +A couple of things: 1) I have noticed some funny spacing in the reference + entries in the text. + When you enter the bibliography item data, make sure their is \emph on -User's Guide. - +no \emph default - If you intend to use itemized lists you might also want to read about the + space between the last author and the parenthesis setting off the year; -\family sans -Itemize -\begin_inset space ~ -\end_inset - -Bullet -\begin_inset space ~ -\end_inset - -Selection -\family default - dialog described above in section -\begin_inset space ~ +\emph on +e. +\begin_inset space \thinspace{} \end_inset - -\begin_inset CommandInset ref -LatexCommand ref -reference "sec:bullet" - +g. +\begin_inset space \space{} \end_inset -. -\end_layout -\begin_layout Standard -The two new list styles, -\family sans -TickList +\emph default +type +\family typewriter +Ressler(1992) \family default - and -\family sans -CrossList +, not +\family typewriter +Ressler (1992) \family default -, are designed to make it easier for you to create lists of do's and don'ts - or right and wrong by providing dedicated environments that use a tick - or a cross as the label of the list. - These lists are in fact dedicated variants of the +. + 2) Entering the references at all is not obvious. + The easiest thing is to start typing your first reference at the end of + the document, then mark it as type \family sans -Itemize -\family default - environment. - They do however require that you have the -\family typewriter -psnfss +References \family default - packages installed. +. + That will put a small gray box in front of what you just typed. + Click on the box to fill in the rest of the information. + For new references, go to the end of an existing reference and press return. + That will create a new line with its own box, etc. \end_layout \begin_layout Subsubsection -Figures and Tables +Including EPS files \end_layout \begin_layout Standard +Even though AAS\SpecialChar TeX + provides its own figure commands ( +\family typewriter -\family sans -Foil\SpecialChar TeX +\backslash +plotone +\family default +, for example), I much prefer \SpecialChar LaTeX +'s standard figure commands (with the default + graphicx). + You can insert the +\family typewriter +\backslash +plotone \family default - redefines the floating tables and figures so that they appear exactly where - they are in the text rather than pushing them to the top of the page or - to some user specified location. - In fact if you change the float placement settings they are simply ignored. -\end_layout +, etc. +\begin_inset space ~ +\end_inset -\begin_layout Subsubsection -Page Headers and Footers -\begin_inset CommandInset label -LatexCommand label -name "sec:foilfoot" +commands as \SpecialChar TeX + code into a Figure Float box if you desire, but I never have + much luck getting the layout right. + With the standard graphics, \SpecialChar LyX + will insert a +\family typewriter + +\backslash +usepackage{graphicx} +\family default + command into the \SpecialChar LaTeX + preamble and handle the figures in the standard \SpecialChar LaTeX2e + way, + interspersing the figures in the text. + I believe ApJ accepts figures exactly this way now; AJ might still use + the +\begin_inset Quotes eld +\end_inset +stack everything at the end +\begin_inset Quotes erd \end_inset + technique. +\end_layout +\begin_layout Subsubsection +Things I could have done, but didn't \end_layout \begin_layout Standard - -\family sans -My -\begin_inset space ~ -\end_inset - -Logo -\family default - and -\family sans -Restriction -\family default - are two commands used to control the left-footer text string. - The first is meant to allow you to include a graphic logo on your foils - and defaults to +There are a few \begin_inset Quotes eld \end_inset --Typeset by -\family sans -Foil\SpecialChar TeX - -\family default -- +pretty \begin_inset Quotes erd \end_inset -. - While the second is meant to provide a classification for the audience, + things I could have implemented, but chose not to. + For instance, I saw no point in double-spacing the text in the \SpecialChar LyX + window, + even though it is double-spaced in the paper manuscript. + Also, I chose not to make separate layouts for the preprint and preprint2 + styles. + Since I assume you will spend most of your time in the plain manuscript + mode anyway, I decided not to chew up more disk space with this. -\emph on -e. -\begin_inset space \thinspace{} -\end_inset - -g. -\emph default - -\begin_inset space \space{} -\end_inset +\end_layout -Confidential. - It is empty by default. +\begin_layout Subsection +Final Caveat \end_layout \begin_layout Standard -The remaining page corners can be filled by -\family sans -Right -\begin_inset space ~ -\end_inset - -Footer -\family default - (which defaults to page numbers), -\family sans -Right -\begin_inset space ~ -\end_inset +Your mileage may vary. + I've now had papers published by both ApJ and AJ that have had 98% of the + effort done in \SpecialChar LyX +; the last 2% was the \SpecialChar LaTeX + post-processing and a few cleanups. + I have had no trouble with the submission process, and I'm sure the journals + were never aware that there might be a difference. + So, go forth and publish! +\end_layout -Header -\family default - (top right) and -\family sans -Left -\begin_inset space ~ -\end_inset +\begin_layout Section +Broadway +\end_layout -Header -\family default - (top left). +\begin_layout Standard +by +\shape smallcaps +Garst Reese \end_layout \begin_layout Subsection -Unsupported -\family sans -Foil\SpecialChar TeX +Introduction +\end_layout -\family default - Goodies -\begin_inset CommandInset label -LatexCommand label -name "sec:unsuppfoils" +\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 -\end_inset +\begin_layout Subsection +Special problems +\end_layout +\begin_layout Standard +The same as in Hollywood. +\end_layout +\begin_layout Subsection +Special features \end_layout \begin_layout Standard -All the commands mentioned below need to be set in a +Insert the \family sans -\SpecialChar LaTeX - +Speaker \family default - environment or as -\family sans -\SpecialChar TeX - -\family default - within another environment. + 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 -Lengths +\begin_layout Subsection +Paper size and Margins \end_layout \begin_layout Standard -All lengths are adjusted using the -\family typewriter - -\backslash -setlength{ -\family default -\emph on -lengthname -\family typewriter -\emph default -}{ -\family default -\emph on -newlength -\family typewriter -\emph default -} -\family default - command. - Where -\emph on -lengthname -\emph default - should be replaced by the name given to the length you want to change and - -\emph on -newlength -\emph default - is the length value. - All lengths should be specified in units of length such as inches ( -\family typewriter -in -\family default -), millimeters ( -\family typewriter -mm -\family default -) or points ( -\family typewriter -pt -\family default -) or relative to some document or font-based length such as -\family typewriter +USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in +\end_layout -\backslash -textwidth -\family default -. - +\begin_layout Subsection +Environments \end_layout \begin_layout Standard -It's possible to change the spacing between a foilhead and the body of the - foil by adjusting the length specified by -\family typewriter +The following environments are available. + You can use broadway.bind to get the bind keys shown at the right. +\end_layout -\backslash -foilheadskip -\family default -. - For example, to make -\emph on -all -\emph default - foilheads 0.5 -\begin_inset space \space{} +\begin_layout Itemize + +\family sans +Standard +\begin_inset Newline newline \end_inset -in closer to their bodies put the following in the preamble: -\family typewriter -\backslash -setlength{ -\backslash -foilheadskip}{-0.5in} +\family default +You should not have to use this, but it is here for anything that does not + fit otherwise. \end_layout -\begin_layout Standard -The spacings around floats can be adjusted by setting these lengths: -\end_layout +\begin_layout Itemize -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +\family sans +Narrative +\begin_inset space \hfill{} +\end_inset + +M-z n +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -abovefloatskip \family default - Separation between the text and the top of the float +Used to describe stage setting and the action. + First use of speaker names in all CAPs. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM - -\family typewriter +\begin_layout Itemize -\backslash -abovecaptionskip -\family default - Separation between the float and the caption -\end_layout +\family sans +ACT +\begin_inset space \hfill{} +\end_inset -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +M-z a +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -belowcaptionskip \family default - Separation between the caption and the following text +Automatically numbered. + On screen it will be arabic, but will print as Roman. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +\begin_layout Itemize + +\family sans +ACT* +\begin_inset space \hfill{} +\end_inset + +M-z S at +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -captionwidth \family default - You can make the captions narrower than the surrounding text by adjusting - this length. - Best done relative to -\family typewriter +Subtitle for +\family sans +ACT. -\backslash -textwidth \family default -. + It is just centered text. \end_layout -\begin_layout Standard -There are also several title page related lengths that you may find useful - if you have a long title or several authors: -\end_layout +\begin_layout Itemize -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +\family sans +SCENE +\begin_inset space \hfill{} +\end_inset + +M-z S-S +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -abovetitleskip \family default - Separation from headers to -\family sans -Title +Not automatically numbered. + You supply the number. + This is because I couldn't figure out how. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM - -\family typewriter +\begin_layout Itemize -\backslash -titleauthorskip -\family default - between -\family sans -Title -\family default - and \family sans -Author -\family default - environments -\end_layout +AT_RISE: +\begin_inset space \hfill{} +\end_inset -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +M-z S-R +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -authorauthorskip -\family default - between multiple -\family sans -Author \family default - lines +A special case of Narrative to describe the setting and action as the curtain + rises. \end_layout -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM - -\family typewriter +\begin_layout Itemize -\backslash -authordateskip -\family default - between the -\family sans -Author -\family default - and the \family sans -Date -\end_layout +Speaker +\begin_inset space \hfill{} +\end_inset -\begin_layout Labeling -\labelwidthstring MMMMMMMMMMM +M-z s +\begin_inset Newline newline +\end_inset -\family typewriter -\backslash -dateabstractskip \family default - between the +The speaker's (actor's) title, centered in all CAPS. +\end_layout + +\begin_layout Itemize + \family sans -Date -\family default - and the -\family sans -Abstract -\end_layout +Parenthetical +\begin_inset space \hfill{} +\end_inset -\begin_layout Standard -The last length related command affects all the list environments. - If you place -\family typewriter +M-z p +\begin_inset Newline newline +\end_inset -\backslash -zerolistvertdimens -\family default - -\emph on -inside -\emph default - a list environment then all the vertical spacing between the list items - is removed. - Note that this is a command not a length so it doesn't require -\family typewriter -\backslash -setlength \family default - like the stuff mentioned above. -\end_layout - -\begin_layout Subsubsection -Headers and Footers +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 -The -\family typewriter - -\backslash -LogoOn -\family default - and -\family typewriter +\begin_layout Itemize -\backslash -LogoOff -\family default - commands control whether the logo in the \family sans -MyLogo -\family default - definition appear on a given page. - If you put -\family typewriter +Dialogue +\begin_inset space \hfill{} +\end_inset -\backslash -LogoOff -\family default - in the preamble then none of the foils will have the logo on them. - If you don't want the logo on a particular page place the -\family typewriter +M-z d +\begin_inset Newline newline +\end_inset -\backslash -LogoOff -\family default - directly after the foilhead of that page and the -\family typewriter -\backslash -LogoOn \family default - directly after the next foilhead. +What the Speaker says. \end_layout -\begin_layout Standard -If you decide to use the -\family sans -fancy -\family default - page style setting in the +\begin_layout Itemize + \family sans -Document -\begin_inset space ~ +CURTAIN +\begin_inset space \hfill{} +\end_inset + +M-z S-C +\begin_inset Newline newline \end_inset -Layout -\family default - dialog you should probably add -\family typewriter -\backslash -let -\backslash -headwidth -\backslash -textwidth -\family default - to your preamble so headers and footers on landscape pages are correctly - placed when rotated. - This is due to some clashes between the page layouts provided by the -\family sans -fancyheadings -\family default - package and the -\family sans -foils \family default - class. +The curtain comes down. \end_layout -\begin_layout Section -Hollywood (Hollywood spec scripts) -\end_layout +\begin_layout Itemize -\begin_layout Standard -by -\shape smallcaps -Garst Reese -\end_layout +\family sans +Title +\begin_inset space \hfill{} +\end_inset -\begin_layout Subsection -Introduction +M-z S-T \end_layout -\begin_layout Standard -Getting the format of a Hollywood script right is a -\begin_inset Quotes eld +\begin_layout Itemize + +\family sans +Author +\begin_inset space \hfill{} \end_inset -rite of passage. -\begin_inset Quotes erd +M-z S-A +\end_layout + +\begin_layout Itemize + +\family sans +Right_Address +\begin_inset space \hfill{} \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. +M-z r \end_layout -\begin_layout Subsection -Special problems +\begin_layout Standard +Hello there. +\end_layout + +\begin_layout Section +Dinbrief \end_layout \begin_layout Standard -Speakers' lines should NEVER break in mid-sentence. - If a speaker's lines continue over a page break, repeat the +The document class \family sans -Speaker +dinbrief \family default - title followed by (Cont'd). + can be used to type letters according to German conventions. + A template file is included in +\family typewriter +.../lyx/share/templates +\family default + for you to use as a starting point. \end_layout -\begin_layout Subsection -Special features +\begin_layout Section +Elsevier Journals \end_layout \begin_layout Standard -Insert the -\family sans -Speaker +See the \SpecialChar LyX + template file +\family typewriter +elsarticle.lyx \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. +. + It contains all infos you need. \end_layout -\begin_layout Subsection -Paper size and Margins +\begin_layout Section +Foils [aka +\family sans +Foil\SpecialChar TeX + +\family default +] +\begin_inset CommandInset label +LatexCommand label +name "sec:foiltex" + +\end_inset + + \end_layout \begin_layout Standard -USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in +by +\noun on +Allan Rae \end_layout \begin_layout Subsection -Environments +Introduction \end_layout \begin_layout Standard -The following environments are available. - You can use hollywood.bind to get the bind keys shown at the right. +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 latter. \end_layout -\begin_layout Itemize +\begin_layout Standard +I'm going to say this again, nice and clear, so that there's no misunderstanding +: +\end_layout -\family sans -Standard -\begin_inset Newline newline +\begin_layout Standard +\begin_inset VSpace bigskip \end_inset -\family default -Used where nothing else works. - Try to avoid it. \end_layout -\begin_layout Itemize +\begin_layout Standard +\align center -\family sans -FADE_IN -\family default -: -\begin_inset space \hfill{} +\size large +This section documents the class +\begin_inset Quotes eld \end_inset \family sans -M-z S-I +FoilTeX \family default -\begin_inset Newline newline +\begin_inset Quotes erd \end_inset -Usually followed by something like -\begin_inset Quotes eld -\end_inset + +\emph on +only. +\end_layout -on Sally waking up. -\begin_inset Quotes erd +\begin_layout Standard +\begin_inset VSpace bigskip \end_inset \end_layout -\begin_layout Itemize - -\family sans -INT: -\begin_inset space \hfill{} -\end_inset - -M-z i -\begin_inset Newline newline +\begin_layout Standard +If you're looking for the documentation for +\begin_inset Quotes eld \end_inset +\family sans +slides (default) \family default -Introduces a new INTERIOR camera set-up. - Always followed by DAY or NIGHT, or something similar to define the lighting - required. - Everthing on this line in CAPS. -\end_layout - -\begin_layout Itemize -\family sans -EXT: -\begin_inset space \hfill{} +\begin_inset Quotes erd \end_inset -M-z e -\begin_inset Newline newline +, check out section +\begin_inset space ~ \end_inset -\family default -Introduces a new EXTERIOR camera set-up. - Everthing on this line in CAPS. -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:slitex" -\begin_layout Itemize +\end_inset +. + If your machine doesn't have the \family sans -Speaker -\begin_inset space \hfill{} -\end_inset +foils +\family default + class +\family sans +FoilTeX +\family default + installed, you'll probably have to use the default +\family sans +slides +\family default + class, which isn't quite as good as +\family sans +foils. +\end_layout -M-z s -\begin_inset Newline newline +\begin_layout Standard +The +\family sans +foils +\family default + class is designed for use with version +\begin_inset space ~ \end_inset - +2.1 of the +\family sans +foils.cls \family default -The character speaking. + \SpecialChar LaTeX + class file which is now an integral part of \SpecialChar LaTeX2e +. \end_layout -\begin_layout Itemize +\begin_layout Subsection +Getting Started +\end_layout +\begin_layout Standard +Obviously, to use this document class, you need to select \family sans -Parenthetical -\begin_inset space \hfill{} +FoilTeX +\family default + from the +\family sans +Class +\family default + entry in the +\family sans +Document +\begin_inset space ~ \end_inset -M-z p -\begin_inset Newline newline +Layout +\family default + dialog. + There are some settings in the +\family sans +Document +\begin_inset space ~ \end_inset - +Layout \family default -Instructions to the speaker. - The () are automatically inserted. + dialog that you should know about that are specific to this class: \end_layout \begin_layout Itemize - +Don't change the options \family sans -Dialogue -\begin_inset space \hfill{} -\end_inset - -M-z d -\begin_inset Newline newline +Sides +\family default + and +\family sans +Columns +\family default + on the +\family sans +Document +\begin_inset space ~ \end_inset - +Layout \family default -What the + dialog. + They're ignored by the \family sans -Speaker +foils \family default - says. + class. \end_layout \begin_layout Itemize - -\family sans -Transition -\begin_inset space \hfill{} +The default font size is 20 +\begin_inset space \thinspace{} \end_inset -M-z t -\begin_inset Newline newline +pt with the other options being 17 +\begin_inset space \thinspace{} \end_inset - -\family default -Camera movement instruction. - e. +pt, 25 \begin_inset space \thinspace{} \end_inset -g. -\begin_inset space \space{} +pt and 30 +\begin_inset space \thinspace{} \end_inset -CUT TO: +pt. \end_layout \begin_layout Itemize - +The default font is \family sans -FADE OUT: -\begin_inset space \hfill{} -\end_inset - -M-z S-I +sans +\family default + +\family sans +serif +\family default + but all math equations are still typeset in the usual roman font. \end_layout \begin_layout Itemize \family sans -Author -\begin_inset space \hfill{} +Foil\SpecialChar TeX + +\family default + supports A4 and Letter paper sizes as well as a special size for working + with 35 +\begin_inset space \thinspace{} \end_inset -M-z S-A +mm slides. + It doesn't support A5, B5, legal or executive paper sizes. \end_layout \begin_layout Itemize - +Don't bother changing the \family sans -Title -\begin_inset space \hfill{} -\end_inset - -M-z S-T +Float Placement +\family default + settings because they are ignored anyway. + All floats appear where they are defined in the text. \end_layout \begin_layout Itemize - +The \family sans -Right_Address -\begin_inset space \hfill{} -\end_inset - -M-z r -\end_layout +Pagestyle +\family default + setting behaves a bit differently for this class. + +\family sans +Foil\SpecialChar TeX -\begin_layout Subsection -Script jargon -\end_layout +\family default + provides extensive footer and header capabilities including a user-defined + logo. + See section +\begin_inset space ~ +\end_inset -\begin_layout Itemize -(O.S) — off screen -\end_layout -\begin_layout Itemize -(V.0) — voice over -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:foilfoot" -\begin_layout Itemize -b. -\begin_inset space \thinspace{} \end_inset -g. - — background + for more details. + The title page is treated differently to all other pages in the document + and is +\emph on +always +\emph default + unnumbered and +\emph on +always +\emph default + has the logo centered at the bottom of the page (if one is defined). + The possible page style choices and what they do are as follows: \end_layout -\begin_layout Itemize -C.U. - — close-up -\end_layout - -\begin_layout Itemize -PAN — camera movement -\end_layout - -\begin_layout Itemize -INSERT — cut to close-up of -\end_layout - -\begin_layout Section +\begin_deeper +\begin_layout Labeling +\labelwidthstring MMMMMMM -\change_deleted 564990737 1669755802 -ijmpc and ijmpd +\family sans +\series bold +empty +\family default +\series default + The final output contains no page numbers, or other headers or footers + (except footnotes of course). + \end_layout -\begin_layout Standard +\begin_layout Labeling +\labelwidthstring MMMMMMM -\change_deleted 564990737 1669755802 -by -\noun on -Panayotis Papasotiriou +\family sans +\series bold +plain +\family default +\series default + The final output contains page numbers centered at the bottom of the page. + No other headings or footers (other than footnotes). \end_layout -\begin_layout Subsection +\begin_layout Labeling +\labelwidthstring MMMMMMM -\change_deleted 564990737 1669755802 -Overview +\series bold +foilheadings +\series default + Page numbers in lower right corner. + Additional headers and footers are also shown. + This is also the default. \end_layout -\begin_layout Standard +\begin_layout Labeling +\labelwidthstring MMMMMMM -\change_deleted 564990737 1669755802 -The ijmpc package is a set of macros that facilitates electronic manuscript - submission to the -\emph on -International Journal of Modern Physics C -\emph default -. - Similarly, the ijmpd package is for creating manuscripts to be submitted - to the -\emph on -International Journal of Modern Physics D -\emph default -. - Both journals are published by World Scientific. - The corresponding document classes are named -\family typewriter -ws-ijmpc.cls -\family default - and -\family typewriter -ws-ijmpd.cls +\series bold +fancy +\series default + Gives you access to the +\family sans +fancyheadings \family default -, respectively. - These files, together with instructions for the authors, can be downloaded - from the sites -\begin_inset Flex URL -status collapsed + package although its use with +\family sans +Foil\SpecialChar TeX -\begin_layout Plain Layout +\family default + is discouraged by the writer of the +\family sans +Foil\SpecialChar TeX -http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml +\family default + package because of some potential page layout clashes. \end_layout -\end_inset - - and -\begin_inset Flex URL -status collapsed - -\begin_layout Plain Layout +\end_deeper +\begin_layout Subsubsection +Extra Options +\end_layout -http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml +\begin_layout Standard +The following options may be used in the extra class options in the +\family sans +Document\SpecialChar menuseparator +Settings +\family default + dialog. \end_layout +\begin_layout Labeling +\labelwidthstring MMMMMMx + +\series bold +35mmSlide +\series default + This sets up the page layout for 7.33 +\begin_inset space \thinspace{} \end_inset -. - Both packages are modified versions of the standard -\begin_inset Quotes eld +in by 11 +\begin_inset space \thinspace{} \end_inset -article -\begin_inset Quotes erd +in paper, which is about the same aspect ratio as a 35 +\begin_inset space \thinspace{} \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. +mm slide, making it a bit easier to work with this medium. \end_layout -\begin_layout Subsection +\begin_layout Labeling +\labelwidthstring MMMMMMx -\change_deleted 564990737 1669755802 -Writing a paper +\series bold +headrule +\series default + Places a rule across the page below the header on every page except the + title page. \end_layout -\begin_layout Standard +\begin_layout Labeling +\labelwidthstring MMMMMMx -\change_deleted 564990737 1669755802 -As usual, the easiest way to write a paper is to start with a template. - Click on +\series bold +footrule +\series default + Places a rule across the page above the footer on every page except the + title page. +\end_layout + +\begin_layout Labeling +\labelwidthstring MMMMMMx + +\series bold +dvips +\series default + This is automatically set each time you create a new \family sans -File\SpecialChar menuseparator -New from +foils \family default - + document. + This option tells \family sans -Template -\family default -, then choose the -\family typewriter -ijmpc.lyx -\family default - or -\family typewriter -ijmpd.lyx -\family default - template. - This will give an (almost) empty document that includes the most common - fields found in a manuscript. - Simply overwrite the existing text (including the brackets, -\family typewriter -<> -\family default -) with your text. - You should keep in mind the following remarks. -\end_layout - -\begin_layout Enumerate +Foil\SpecialChar TeX -\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. +\family default + to use the dvips driver to rotate those pages that are set as landscape + foils. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -The language of the document should not be changed. - Before previewing your paper, be sure that the babel package is not used. - To do this, click on -\begin_inset Info -type "menu" -arg "dialog-show document" -\end_inset +\begin_layout Labeling +\labelwidthstring MMMMMMx - +\series bold +landscape +\series default + Simply changes the page dimensions to those of a landscape page but doesn't + do any rotation. + Thus if you use this option you need to use an external program to rotate + each page or feed your paper through your printer as landscape. + Note that this option effectively reverses the roles of the \family sans -\SpecialChar menuseparator -Language +Foilhead \family default -, and select -\begin_inset Quotes eld -\end_inset - -None -\begin_inset Quotes erd -\end_inset - - as + and \family sans -Language Package +Rotatefoilhead \family default -. + environments (don't worry these are described in the next section). \end_layout -\begin_layout Enumerate +\begin_layout Labeling +\labelwidthstring MMMMMMx -\change_deleted 564990737 1669755802 -The -\begin_inset Quotes eld -\end_inset +\series bold +leqno +\series default + Equation numbers on the left. +\end_layout -Keywords -\begin_inset Quotes erd -\end_inset +\begin_layout Labeling +\labelwidthstring MMMMMMx - style must be used to define keywords. +\series bold +fleqn +\series default + Flush-left equations. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -The ijmpc package provides a style named -\begin_inset Quotes eld -\end_inset +\begin_layout Subsection +Supported Environments +\end_layout -Classification Codes -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +Most of the environments commonly supported in other classes are also supported + by the +\family sans +foils +\family default + class. + There are several additional environments provided by +\family sans +Foil\SpecialChar TeX -, which can be used to define classification codes, such as PACS numbers. - Note that this facility is not supported by the ijmpd package. +\family default + as well as a couple added by \SpecialChar LyX +. + The following environments are shared with other classes: \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -Several new environments are available: -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +\begin_inset Flex Multiple Columns +status open -Definition -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Standard +\end_layout -Step -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Itemize +\end_layout -Example -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Enumerate +\end_layout -Remark -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Description +\end_layout -Notation -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +List +\end_layout -Theorem -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +\SpecialChar LyX +-Code +\end_layout -Proof -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Verse +\end_layout -Corollary -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Quote +\end_layout -Lemma -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Quotation +\end_layout -Proposition -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +TitleAuthor +\end_layout -Prop -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Date +\end_layout -Question -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, -\begin_inset Quotes eld -\end_inset +\family sans +Abstract +\end_layout -Claim -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -, and -\begin_inset Quotes eld -\end_inset +\family sans +Bibliography +\end_layout -Conjecture -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -. - 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. +\family sans +Address \end_layout -\begin_layout Enumerate +\begin_layout Itemize -\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 +\family sans +RightAddress +\end_layout -g. -\begin_inset space \space{} \end_inset -\begin_inset Quotes eld -\end_inset +\end_layout -See Ref. -\begin_inset space \space{} -\end_inset +\begin_layout Standard +That is, all the major environments apart from the sectioning environments. + Since foils are essentially self-contained sections, with a title and body, + +\family sans +Foil\SpecialChar TeX +\family default + provides specific commands for starting new foils and these are: +\end_layout -\family typewriter +\begin_layout Itemize -\backslash -refcite{key} -\family default +\family sans +Foilhead +\end_layout -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize -. +\family sans +Rotatefoilhead \end_layout -\begin_layout Enumerate +\begin_layout Standard +\SpecialChar LyX + also provides slightly modified versions of these two environments called: +\end_layout -\change_deleted 564990737 1669755802 -There is no -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -Acknowledgments -\begin_inset Quotes erd -\end_inset +\family sans +ShortFoilhead +\end_layout - section in both packages. - To put acknowledgments, just use the -\begin_inset Quotes eld -\end_inset +\begin_layout Itemize -Section* -\begin_inset Quotes erd -\end_inset - - environment. +\family sans +ShortRotatefoilhead \end_layout -\begin_layout Enumerate +\begin_layout Standard +and the differences will be explained in the next section. +\end_layout -\change_deleted 564990737 1669755802 -Appendices may be added to the paper, -\emph on -after -\emph default - the Acknowledgments and -\shape italic -before -\shape default - the References. - \SpecialChar LyX - provides a special environment, called -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +Since foils are often used in presenting ideas or new theorems and such + +\family sans +Foil\SpecialChar TeX -Appendices Section -\begin_inset Quotes erd -\end_inset +\family default + also provides a comprehensive box of goodies for presenting them: +\end_layout - 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 +\begin_layout Standard +\begin_inset Flex Multiple Columns +status open -Appendix -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - 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 +\family sans +Theorem +\end_layout -Appendix -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - environment. - \SpecialChar LyX - will number each appendix with capital letters, as required by both journals. - Note that -\begin_inset Quotes eld -\end_inset +\family sans +Lemma +\end_layout -Appendices Section -\begin_inset Quotes erd -\end_inset +\begin_layout Itemize - -\emph on -must -\emph default - be present before the first appendix; if not, all appendices will be numbered - as normal sections in the output. +\family sans +Corollary \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -The ijmpc and the ijmpd packages use the -\family typewriter -tbl -\family default - command to implement table captions. - As a result, a table created by \SpecialChar LyX - is printed correctly, but its caption - is ignored. - However, you can use some \SpecialChar TeX - code to overcome this problem, so that captions - are printed as expected. - To do so, create a float table as usual, remove the caption, and replace - it with the \SpecialChar TeX - code -\family typewriter +\begin_layout Itemize -\backslash -tbl{ -\emph on -your table caption -\emph default -}{ -\family default - (sic); you must also the \SpecialChar TeX - code -\family typewriter -} -\family default - immediately after the tabular material. - Study the example table included in the template files to see how this - trick is implemented. - Alternatively, If you need table captions, you should implement the whole - table float in a -\family typewriter -.tex -\family default - file, then include this file to the \SpecialChar LyX - document ( \family sans -Insert\SpecialChar menuseparator -File\SpecialChar menuseparator -Child -\begin_inset space ~ -\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. +Proposition \end_layout -\begin_layout Subsection +\begin_layout Itemize -\change_deleted 564990737 1669755802 -Preparing a paper for submission +\family sans +Definition \end_layout -\begin_layout Standard +\begin_layout Itemize -\change_deleted 564990737 1669755802 -Before you submit your paper you must export the \SpecialChar LyX - document as a \SpecialChar LaTeX - file ( \family sans -File\SpecialChar menuseparator -Export\SpecialChar menuseparator -\SpecialChar LaTeX +Proof +\end_layout -\family default -) -\begin_inset Foot -status open +\begin_layout Itemize -\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. +\family sans +Theorem* \end_layout -\end_inset +\begin_layout Itemize -, then make the following changes to the resulting -\family typewriter -.tex -\family default - file. +\family sans +Lemma* \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1669755802 -Remove the comment lines before the -\family typewriter +\begin_layout Itemize -\backslash -documentclass -\family default - command. +\family sans +Corollary* \end_layout -\begin_layout Enumerate +\begin_layout Itemize -\change_deleted 564990737 1669755802 -Remove everything between (and including) the -\family typewriter +\family sans +Proposition* +\end_layout -\backslash -makeatletter -\family default - and -\family typewriter +\begin_layout Itemize -\backslash -makeatother -\family default - commands, except for any commands you specifically put into the \SpecialChar LaTeX - preamble. +\family sans +Definition* \end_layout -\begin_layout Standard +\end_inset -\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 Section - -\change_deleted 564990737 1669801478 -iopart +\begin_layout Standard +The starred versions are unnumbered while the unstarred versions are numbered. + There are also two list environments added by \SpecialChar LyX + and these are: \end_layout -\begin_layout Standard +\begin_layout Itemize -\change_deleted 564990737 1669801478 -by -\noun on -Uwe Stöhr +\family sans +TickList \end_layout -\begin_layout Subsection +\begin_layout Itemize -\change_deleted 564990737 1669801478 -Overview +\family sans +CrossList \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 +\family sans +Foil\SpecialChar TeX -\begin_layout Plain Layout +\family default + provides some powerful header and footer capabilities that are best set + in the preamble although they may be set at any point in a document. + If you want to change these settings in your document the best place to + do so is at the very top of a foil, i. +\begin_inset space \thinspace{} +\end_inset -ftp://ftp.iop.org/pub/journals/latex2e -\end_layout +e. +\emph on +\begin_inset space \space{} \end_inset -. -\end_layout -\begin_layout Subsection +\emph default +straight after the foilhead. +\end_layout -\change_deleted 564990737 1669801478 -Writing a paper +\begin_layout Standard +For this purpose, the following command styles are provided [ +\shape smallcaps +Martin Vermeer +\shape default +]: \end_layout \begin_layout Standard +\begin_inset Flex Multiple Columns +status open + +\begin_layout Itemize -\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: +My +\begin_inset space ~ +\end_inset + +Logo \end_layout \begin_layout Itemize -\change_deleted 564990737 1669801478 -To be able to compile your document to a PDF, PS, or DVI, ensure that the - no AMS packages are loaded in \family sans -Document\SpecialChar menuseparator -Settings\SpecialChar menuseparator -Math Options -\family default -! +Restriction \end_layout \begin_layout Itemize -\change_deleted 564990737 1669801478 +\family sans +Right +\begin_inset space ~ +\end_inset -\size normal -The title environment defines the kind of your paper. - So use one of the following environments for the title: +Footer \end_layout -\begin_deeper \begin_layout Itemize -\change_deleted 564990737 1669801478 - \family sans -\size normal -Title -\family default - for a Paper +Right +\begin_inset space ~ +\end_inset + +Header \end_layout \begin_layout Itemize -\change_deleted 564990737 1669801478 - \family sans -\size normal -Review -\family default - for a Review +Left +\begin_inset space ~ +\end_inset + +Header \end_layout -\begin_layout Itemize +\begin_deeper +\begin_layout Plain Layout +\begin_inset space ~ +\end_inset -\change_deleted 564990737 1669801478 -\family sans -\size normal -Topical -\family default - for a Topical review \end_layout -\begin_layout Itemize +\end_deeper +\end_inset -\change_deleted 564990737 1669801478 -\family sans -\size normal -Comment -\family default - for a Comment \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669801478 - +\begin_layout Standard +There are also a few commands provided by \family sans -\size normal -Note +Foil\SpecialChar TeX + \family default - for a Note -\end_layout + that aren't directly supported by \SpecialChar LyX + but I'll tell you what they do and how + to use them in section +\begin_inset space ~ +\end_inset -\begin_layout Itemize -\change_deleted 564990737 1669801478 +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:unsuppfoils" -\family sans -\size normal -Paper -\family default - for a Paper (same as Title) -\end_layout +\end_inset -\begin_layout Itemize +. +\end_layout -\change_deleted 564990737 1669801478 +\begin_layout Subsection +Building a Set of Foils +\end_layout -\family sans -\size normal -Prelim +\begin_layout Standard +This section will give a simple introduction to using the different environments + to build a set of foils. + If you want to see an example set of foils, take a look at the +\family typewriter +Foils.lyx \family default - for a Preliminary communication + file you find in \SpecialChar LyX +'s +\family typewriter +examples +\family default + folder. \end_layout -\begin_layout Itemize - -\change_deleted 564990737 1669801478 +\begin_layout Subsubsection +Give It a Title Page +\end_layout +\begin_layout Standard +Unlike other classes that provide \family sans -\size normal -Rapid +Title \family default - for a Rapid communication -\end_layout - -\begin_layout Itemize - -\change_deleted 564990737 1669801478 - +, \family sans -\size normal -Letter +Author \family default - 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 -Letter +Date \family default - can have an optional short title. -\end_layout - -\begin_layout Itemize - -\change_deleted 564990737 1669801478 -There is a general title environment + and \family sans -Article +Abstract \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. + environments, +\family sans +foils +\family default + creates the title on a page of its own. + If you leave out the +\family sans +Date +\family default + environment \SpecialChar LaTeX + will substitute the current date (every time you regenerate + the output). \end_layout -\begin_layout Standard - -\change_deleted 564990737 1669801478 -For more informations like hints for special table and formula formatting, - look at the IOP author guidelines. -\change_unchanged - +\begin_layout Subsubsection +Start a New Foil \end_layout -\begin_layout Section +\begin_layout Standard +As I mentioned earlier, there are four ways of starting a new foil. + For portrait foils you should use +\family sans +Foilhead +\family default + or +\family sans +ShortFoilhead. -\change_deleted 564990737 1670317155 -Kluwer +\family default + The difference between these two environments is the amount of space between + the title of the foil (the foilhead) and the body of the foil. \end_layout \begin_layout Standard - -\change_deleted 564990737 1670317155 -by -\noun on -Panayotis Papasotiriou +Landscape foils are generated using the +\family sans +Rotatefoilhead +\family default + and +\family sans +ShortRotatefoilhead +\family default + environments. + Again the only difference is the spacing between foilhead and body. + Both of the short versions have 0.5 +\begin_inset space ~ +\end_inset + +inches less separation between the foilhead and the body. + \end_layout -\begin_layout Subsection +\begin_layout Standard +One problem with the support for landscape foils is the requirement that + you have to use the +\family typewriter +dvips +\family default + driver to generate the PostScript output otherwise the foils won't be rotated. + It is possible to get landscape foils even if you haven't got the +\family typewriter +dvips +\family default + driver provided you can feed your foils sideways through your printer ;-) +\end_layout -\change_deleted 564990737 1670317155 -Overview +\begin_layout Subsubsection +Theorems, Lemmas, Proofs and more \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 +You can't have two of the same type of these environments directly following + each other. + If you use a normal paragraph break, , you will just be extending the previous + environment as if you had merged the two environments together. + Rather than that, you need to insert a so-called separator. + Please refer to the section entitled \emph on -Astrophysics and Space Science +Separate Nestings \emph default - and + in the \emph on -Solar Physics +User's Guide \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 - -\end_inset - -). - The Kluwer package may be downloaded from the site -\begin_inset Flex URL -status collapsed - -\begin_layout Plain Layout - -http://www.wkap.nl/kaphtml.htm/STYLEFILES +. \end_layout -\end_inset - -. - A complete user guide is contained in that package (but it can also be - downloaded separately). +\begin_layout Subsubsection +Lists \end_layout \begin_layout Standard +You get all the commonly supported list styles found in other classes as + well as two new ones. + I'll only describe the new ones here. + If you want to find out more about the other list environments check out + the +\emph on +User's Guide. -\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 +\emph default + If you intend to use itemized lists you might also want to read about the + +\family sans +Itemize +\begin_inset space ~ \end_inset -peculiar -\begin_inset Quotes erd +Bullet +\begin_inset space ~ \end_inset - commands of the package (see +Selection +\family default + dialog described above in section \begin_inset space ~ \end_inset \begin_inset CommandInset ref LatexCommand ref -reference "subsec:kluwer_peculiarities" +reference "sec:bullet" \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 - -\change_deleted 564990737 1670317155 -Writing a paper +. \end_layout \begin_layout Standard - -\change_deleted 564990737 1670317155 -The easiest way to write a paper is to start with the Kluwer template file. - Click on +The two new list styles, \family sans -File\SpecialChar menuseparator -New from +TickList \family default - + and \family sans -Template +CrossList \family default -, then choose the -\family typewriter -kluwer.lyx +, are designed to make it easier for you to create lists of do's and don'ts + or right and wrong by providing dedicated environments that use a tick + or a cross as the label of the list. + These lists are in fact dedicated variants of the +\family sans +Itemize \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, + environment. + They do however require that you have the \family typewriter -<> +psnfss \family default -) with the correct information. + packages installed. \end_layout -\begin_layout Subsection - -\change_deleted 564990737 1670317155 -Preparing a paper for submission +\begin_layout Subsubsection +Figures and Tables \end_layout \begin_layout Standard -\change_deleted 564990737 1670317155 -As in the AAS\SpecialChar TeX - package, before you submit your paper to a journal you must - -\begin_inset Quotes eld -\end_inset - -postprocess -\begin_inset Quotes erd -\end_inset - - it as follows. -\end_layout - -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -Export your paper as a \SpecialChar LaTeX - file. - To do this, click on \family sans -File\SpecialChar menuseparator -Export\SpecialChar menuseparator -\SpecialChar LaTeX +Foil\SpecialChar TeX \family default -. - + redefines the floating tables and figures so that they appear exactly where + they are in the text rather than pushing them to the top of the page or + to some user specified location. + In fact if you change the float placement settings they are simply ignored. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -Edit the resulting -\family typewriter -.tex -\family default - file with a text editor and make the following changes -\end_layout +\begin_layout Subsubsection +Page Headers and Footers +\begin_inset CommandInset label +LatexCommand label +name "sec:foilfoot" -\begin_deeper -\begin_layout Enumerate +\end_inset -\change_deleted 564990737 1670317155 -remove the comment lines before the -\family typewriter -\backslash -documentclass -\family default - command, \end_layout -\begin_layout Enumerate +\begin_layout Standard -\change_deleted 564990737 1670317155 -remove everything between (and including) the -\family typewriter +\family sans +My +\begin_inset space ~ +\end_inset -\backslash -makeatletter +Logo \family default and -\family typewriter - -\backslash -makeatother +\family sans +Restriction \family default - commands, except for any commands you specifically put into the \SpecialChar LaTeX - preamble. -\end_layout + are two commands used to control the left-footer text string. + The first is meant to allow you to include a graphic logo on your foils + and defaults to +\begin_inset Quotes eld +\end_inset -\begin_layout Standard +-Typeset by +\family sans +Foil\SpecialChar TeX -\change_deleted 564990737 1670317155 -Save the resulting -\family typewriter -.tex \family default - file. -\end_layout +- +\begin_inset Quotes erd +\end_inset -\end_deeper -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -Run the -\family typewriter -.tex -\family default - file through \SpecialChar LaTeX - as many times as necessary (usually up to three). -\end_layout - -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -View the resulting -\family typewriter -.dvi -\family default - document using, e. +. + While the second is meant to provide a classification for the audience, + +\emph on +e. \begin_inset space \thinspace{} \end_inset g. +\emph default + \begin_inset space \space{} \end_inset - -\family sans -xdvi -\family default -, and check if everything is OK (it should, if you didn't make any mistake). +Confidential. + It is empty by default. \end_layout -\begin_layout Subsection +\begin_layout Standard +The remaining page corners can be filled by +\family sans +Right +\begin_inset space ~ +\end_inset -\change_deleted 564990737 1670317155 -\begin_inset Quotes eld +Footer +\family default + (which defaults to page numbers), +\family sans +Right +\begin_inset space ~ \end_inset -Peculiarities -\begin_inset Quotes erd +Header +\family default + (top right) and +\family sans +Left +\begin_inset space ~ \end_inset - of the Kluwer package +Header +\family default + (top left). +\end_layout + +\begin_layout Subsection +Unsupported +\family sans +Foil\SpecialChar TeX + +\family default + Goodies \begin_inset CommandInset label LatexCommand label -name "subsec:kluwer_peculiarities" +name "sec:unsuppfoils" \end_inset @@ -14225,556 +14151,457 @@ name "subsec:kluwer_peculiarities" \end_layout \begin_layout Standard +All the commands mentioned below need to be set in a +\family sans +\SpecialChar LaTeX -\change_deleted 564990737 1670317155 -The Kluwer package has the following -\begin_inset Quotes eld -\end_inset - -peculiarities -\begin_inset Quotes erd -\end_inset +\family default + environment or as +\family sans +\SpecialChar TeX -. +\family default + within another environment. \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -It is possible to write multiple articles in the same \SpecialChar LaTeX - file -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -I can't imagine any good reason to do this. +\begin_layout Subsubsection +Lengths \end_layout -\end_inset - -. - Each article must be included in the environment -\begin_inset Quotes eld -\end_inset - -article -\begin_inset Quotes erd -\end_inset +\begin_layout Standard +All lengths are adjusted using the +\family typewriter -. - Unfortunately, this environment cannot be omitted, even if you write just - one article. - Therefore, each article starts with the command +\backslash +setlength{ +\family default +\emph on +lengthname +\family typewriter +\emph default +}{ +\family default +\emph on +newlength +\family typewriter +\emph default +} +\family default + command. + Where +\emph on +lengthname +\emph default + should be replaced by the name given to the length you want to change and + +\emph on +newlength +\emph default + is the length value. + All lengths should be specified in units of length such as inches ( +\family typewriter +in +\family default +), millimeters ( +\family typewriter +mm +\family default +) or points ( +\family typewriter +pt +\family default +) or relative to some document or font-based length such as \family typewriter \backslash -begin{article} +textwidth \family default - and, obviously, ends with the command +. + +\end_layout + +\begin_layout Standard +It's possible to change the spacing between a foilhead and the body of the + foil by adjusting the length specified by \family typewriter \backslash -end{article} +foilheadskip \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 + For example, to make +\emph on +all +\emph default + foilheads 0.5 +\begin_inset space \space{} \end_inset -\SpecialChar TeX - code -\begin_inset Quotes erd -\end_inset +in closer to their bodies put the following in the preamble: +\family typewriter -). +\backslash +setlength{ +\backslash +foilheadskip}{-0.5in} \end_layout -\begin_layout Enumerate - -\change_deleted 564990737 1670317155 -Information given at the beginning of the article (i. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Standard +The spacings around floats can be adjusted by setting these lengths: +\end_layout -e. -\begin_inset space \space{} -\end_inset +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -title, subtitle, author, institution, running title, running author, abstract - and keywords) must be included in an environment called -\begin_inset Quotes eld -\end_inset +\family typewriter -opening -\begin_inset Quotes erd -\end_inset +\backslash +abovefloatskip +\family default + Separation between the text and the top of the float +\end_layout -. - This is not implemented in \SpecialChar LyX -, so you must enter title, subtitle etc. -\begin_inset space ~ -\end_inset +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -between two \SpecialChar TeX - code lines ( \family typewriter \backslash -begin{opening} +abovecaptionskip \family default - and + Separation between the float and the caption +\end_layout + +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM + \family typewriter \backslash -end{opening} +belowcaptionskip \family default -). + Separation between the caption and the following text \end_layout -\begin_layout Enumerate +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -\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{ +captionwidth \family default -\emph on -author(s) + You can make the captions narrower than the surrounding text by adjusting + this length. + Best done relative to \family typewriter -\emph default -}{ -\family default -\emph on -year -\family typewriter -\emph default -} + +\backslash +textwidth \family default . \end_layout \begin_layout Standard +There are also several title page related lengths that you may find useful + if you have a long title or several authors: +\end_layout + +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -\change_deleted 564990737 1670317155 -The \family typewriter -kluwer.lyx + +\backslash +abovetitleskip \family default - template takes care of all these -\begin_inset Quotes eld -\end_inset + Separation from headers to +\family sans +Title +\end_layout -peculiarities -\begin_inset Quotes erd -\end_inset +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -. - If you start a new paper using this template you don't need to do anything - special. - Just +\family typewriter + +\backslash +titleauthorskip +\family default + between +\family sans +Title +\family default + and +\family sans +Author +\family default + environments \end_layout -\begin_layout Enumerate +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -\change_deleted 564990737 1670317155 -don't delete the \SpecialChar TeX - code included in the template, and +\family typewriter + +\backslash +authorauthorskip +\family default + between multiple +\family sans +Author +\family default + lines \end_layout -\begin_layout Enumerate +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -\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 +\family typewriter -\begin_layout Section -Koma-Script +\backslash +authordateskip +\family default + between the +\family sans +Author +\family default + and the +\family sans +Date \end_layout -\begin_layout Standard -by -\noun on -Bernd Rellermeyer -\end_layout +\begin_layout Labeling +\labelwidthstring MMMMMMMMMMM -\begin_layout Subsection -Overview +\family typewriter + +\backslash +dateabstractskip +\family default + between the +\family sans +Date +\family default + and the +\family sans +Abstract \end_layout \begin_layout Standard -The \SpecialChar LyX - document classes -\emph on -article (koma-script) -\emph default -, -\emph on -report (koma-script) -\emph default -, -\emph on -book -\emph default - -\emph on -(koma-script) -\emph default -, and -\emph on -letter -\emph default +The last length related command affects all the list environments. + If you place +\family typewriter + +\backslash +zerolistvertdimens +\family default \emph on -(koma-script) +inside \emph default - correspond to the \SpecialChar LaTeX - document classes + a list environment then all the vertical spacing between the list items + is removed. + Note that this is a command not a length so it doesn't require \family typewriter -scrartcl.cls + +\backslash +setlength \family default -, + like the stuff mentioned above. +\end_layout + +\begin_layout Subsubsection +Headers and Footers +\end_layout + +\begin_layout Standard +The \family typewriter -scrreprt.cls + +\backslash +LogoOn \family default -, + and \family typewriter -scrbook.cls + +\backslash +LogoOff \family default -, and + commands control whether the logo in the +\family sans +MyLogo +\family default + definition appear on a given page. + If you put \family typewriter -scrlettr.cls + +\backslash +LogoOff \family default -, resp. + in the preamble then none of the foils will have the logo on them. + If you don't want the logo on a particular page place the +\family typewriter + +\backslash +LogoOff +\family default + directly after the foilhead of that page and the +\family typewriter + +\backslash +LogoOn +\family default + directly after the next foilhead. +\end_layout + +\begin_layout Standard +If you decide to use the +\family sans +fancy +\family default + page style setting in the +\family sans +Document \begin_inset space ~ \end_inset -of the Koma-Script family. - They are replacements for the standard document classes -\family typewriter -article.cls +Layout \family default -, + dialog you should probably add \family typewriter -report.cls + +\backslash +let +\backslash +headwidth +\backslash +textwidth \family default -, -\family typewriter -book.cls + to your preamble so headers and footers on landscape pages are correctly + placed when rotated. + This is due to some clashes between the page layouts provided by the +\family sans +fancyheadings \family default - and -\family typewriter -letter.cls + package and the +\family sans +foils \family default -, resp., and fit better to European typography conventions in a number of - points. + class. \end_layout -\begin_layout Itemize -Standard character size is 11pt in -\emph on -article (koma-script) -\emph default -, -\emph on -report (koma-script) -\emph default -, and -\emph on -book (koma-script) -\emph default -, and 12pt in -\emph on -letter (koma-script) -\emph default -. -\end_layout - -\begin_layout Itemize -Headings, labels of the description environment, and a number of elements - of the -\emph on -letter (koma-script) -\emph default - document class are set in a bold sans serif font. -\begin_inset Foot -status collapsed +\begin_layout Section +Hollywood (Hollywood spec scripts) +\end_layout -\begin_layout Plain Layout -There is a big difference between the bold sans serif old cm fonts and new - ec fonts, especially in the appearance of headings. - In comparison, the ec bold sans serif fonts look a bit thin. - Here the \SpecialChar LaTeX - package -\family typewriter -cmsd.sty by -\family default - +\begin_layout Standard +by \shape smallcaps -Walter Schmidt -\shape default - helps to produce the -\begin_inset Quotes eld -\end_inset - -usual -\begin_inset Quotes erd -\end_inset - - appearance when using the ec fonts. +Garst Reese \end_layout -\end_inset +\begin_layout Subsection +Introduction +\end_layout - The numbering of chapter headings is made in the same way as the numbering - of section headings, that is without the extra line +\begin_layout Standard +Getting the format of a Hollywood script right is a \begin_inset Quotes eld \end_inset -Chapter\SpecialChar ldots - +rite of passage. \begin_inset Quotes erd \end_inset -. - In addition, the appearance of the headings can be modified by using a - number of options (in \SpecialChar LyX - to be entered in the field -\family sans -Extra -\begin_inset space ~ -\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 -Options -\family default - of the dialog -\family sans -Layout\SpecialChar menuseparator -Document -\family default -). - +\begin_layout Subsection +Special problems \end_layout -\begin_layout Itemize -The main means in the Koma-Script document classes to design the type area - are the options -\family sans -BCOR -\family default - and -\family sans -DIV -\family default - (in \SpecialChar LyX - to be entered in the extra class options field in the dialog +\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 -Document\SpecialChar menuseparator -Settings +Speaker \family default -). - They make a clearer modification of page margins possible as do the options - of the dialog + title followed by (Cont'd). +\end_layout + +\begin_layout Subsection +Special features +\end_layout + +\begin_layout Standard +Insert the \family sans -Document\SpecialChar menuseparator -Settings +Speaker \family default -. - + names as labels then cross-reference the label to insert the name. + The cross-reference dialog will show the current cast of characters. + You can use this to insert the speaker name in narratives also. \end_layout -\begin_layout Itemize -The \SpecialChar LaTeX - document classes of the Koma-Script family define a number of additional - commands. - Those part of it which makes sense in \SpecialChar LyX - is implemented in corresponding - paragraph types. +\begin_layout Subsection +Paper size and Margins \end_layout \begin_layout Standard -Detailed descriptions of the \SpecialChar LaTeX - document classes of the Koma-Script family - can be found in the Koma-Script documentation -\emph on -scrguide -\emph default - (German) and -\emph on -scrguien -\emph default - (English). +USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in \end_layout \begin_layout Subsection -article (koma-script), report (koma-script), and book (koma-script) +Environments \end_layout \begin_layout Standard -The document classes -\emph on -article (koma-script) -\emph default -, -\emph on -report (koma-script) -\emph default -, and -\emph on -book -\emph default - -\emph on -(koma-script) -\emph default - are implemented in the layout files -\family typewriter -scrartcl.layout -\family default -, -\family typewriter -scrreprt.layout -\family default -, and -\family typewriter -scrbook.layout -\family default -, resp. - They contain all the paragraph types of the corresponding standard document - classes -\emph on -article -\emph default -, -\emph on -report -\emph default -, and -\emph on -book -\emph default -, resp., partly modified, with the exception of the \SpecialChar LyX - specific -\family sans -List -\family default --type, which is replaced by the new -\family sans -Labeling -\family default --type having the same functionality. - Beside the -\family sans -Labeling -\family default --Type there is a number of new paragraph types added. - They are -\emph on -not -\emph default - part of -\emph on -letter (koma-script) -\emph default -. +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 -Addpart, Addchap -\family default -, -\family sans -Addsec -\family default -: are equivalents to -\family sans -Part*, Chapter* -\family default - and -\family sans -Section* -\family default -, resp., additionally inserting an entry in the table of contents. - -\family sans -Addpart -\family default - and -\family sans -Addchap +Standard +\begin_inset Newline newline +\end_inset + + \family default - are not contained in -\emph on -article (koma-script) -\emph default -. +Used where nothing else works. + Try to avoid it. \end_layout \begin_layout Itemize \family sans -Addchap* -\family default -, -\family sans -Addsec* -\family default -: behave exactly as -\family sans -Addchap +FADE_IN \family default - and +: +\begin_inset space \hfill{} +\end_inset + + \family sans -Addsec +M-z S-I \family default -, resp., additionally clearing running heads. - -\family sans -Addchap* -\family default - is not contained in -\emph on -article (koma-script) -\emph default -. -\begin_inset Foot -status collapsed -\begin_layout Plain Layout -There is also an -\family typewriter +\begin_inset Newline newline +\end_inset -\backslash -addpart* -\family default - command in -\emph on -book (koma-script) -\emph default - and in -\emph on -report (koma-script) -\emph default -, but since this is identical to -\family sans -Part* -\family default -, is has not been implemented in \SpecialChar LyX -. -\end_layout +Usually followed by something like +\begin_inset Quotes eld +\end_inset +on Sally waking up. +\begin_inset Quotes erd \end_inset @@ -14783,1273 +14610,1446 @@ Part* \begin_layout Itemize \family sans -Minisec +INT: +\begin_inset space \hfill{} +\end_inset + +M-z i +\begin_inset Newline newline +\end_inset + + \family default -: generates a heading directly above the following paragraph in the standard - character size without affecting the structure of the document. +Introduces a new INTERIOR camera set-up. + Always followed by DAY or NIGHT, or something similar to define the lighting + required. + Everthing on this line in CAPS. \end_layout \begin_layout Itemize \family sans -Captionabove -\family default - and -\family sans -Captionbelow -\family default - are special captions which respect the different space settings needed - for captions placed above or below an element (if you follow strict typographic - rules, you might want to place table captions always above the table). - You can also use the class option -\family typewriter -tablecaptionsabove -\family default -, which will switch -\family sans -caption -\family default - to -\family sans -captionabove -\family default - for tables and -\family sans -captionbelow +EXT: +\begin_inset space \hfill{} +\end_inset + +M-z e +\begin_inset Newline newline +\end_inset + + \family default - for figures. - You need at least Koma-Script version 2.8q to use this. +Introduces a new EXTERIOR camera set-up. + Everthing on this line in CAPS. \end_layout \begin_layout Itemize \family sans -Dictum -\family default -: can be used to set a bonmot, e. -\begin_inset space \thinspace{} +Speaker +\begin_inset space \hfill{} \end_inset -g. -\begin_inset space \space{} +M-z s +\begin_inset Newline newline \end_inset -at the beginning of a chapter. - If you use the optional argument ( -\family sans -Insert\SpecialChar menuseparator -Dictum -\begin_inset space ~ -\end_inset -Author -\family default -), you can insert the dictum's author there. - Dictum and author are separated by a line. - You need at least Koma-Script version 2.8q to use this. - -\family sans -Dictum \family default - is not contained in -\emph on -article (koma-script) -\emph default -. +The character speaking. \end_layout -\begin_layout Standard -The following types, together with the standard types -\family sans -Title -\family default -, -\family sans -Author -\family default -, and +\begin_layout Itemize + \family sans -Date -\family default -, form the title area of the document. - They must be entered ahead of the first -\begin_inset Quotes eld +Parenthetical +\begin_inset space \hfill{} \end_inset -ordinary -\begin_inset Quotes erd +M-z p +\begin_inset Newline newline \end_inset - paragraph. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -The corresponding \SpecialChar LaTeX - commands must appear before the -\family typewriter -\backslash -maketitle \family default - command. +Instructions to the speaker. + The () are automatically inserted. \end_layout -\end_inset +\begin_layout Itemize - When such a type is used more than once, the latter usage overwrites the - former one, that means, for every type only the latest usage is valid. - The order of the different types however has, like -\family sans -Title -\family default -, \family sans -Author +Dialogue +\begin_inset space \hfill{} +\end_inset + +M-z d +\begin_inset Newline newline +\end_inset + + \family default -, and +What the \family sans -Date +Speaker \family default -, no effect on the appearance of the produced document. + says. \end_layout \begin_layout Itemize \family sans -Subject +Transition +\begin_inset space \hfill{} +\end_inset + +M-z t +\begin_inset Newline newline +\end_inset + + \family default -: produces a centered paragraph above the ordinary title ( +Camera movement instruction. + e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +CUT TO: +\end_layout + +\begin_layout Itemize + \family sans -Title -\family default -, +FADE OUT: +\begin_inset space \hfill{} +\end_inset + +M-z S-I +\end_layout + +\begin_layout Itemize + \family sans Author -\family default -, -\family sans -Date -\family default -) for the subject of the document. +\begin_inset space \hfill{} +\end_inset + +M-z S-A \end_layout \begin_layout Itemize -\family sans -Publishers -\family default -: produces a centered paragraph below the ordinary title ( \family sans Title -\family default -, -\family sans -Author -\family default -, -\family sans -Date -\family default -) for the publishers' name. +\begin_inset space \hfill{} +\end_inset + +M-z S-T \end_layout \begin_layout Itemize \family sans -Dedication -\family default -: in -\emph on -report (koma-script) -\emph default - and -\emph on -book (koma-script) -\emph default - produces a centered paragraph on its own page behind the title page, or - in -\emph on -article (koma-script) -\emph default - produces a centered paragraph below the ordinary title ( -\family sans -Title -\family default -, -\family sans -Author -\family default -, -\family sans -Date -\family default -, -\family sans -Publishers -\family default -) for a dedication. +Right_Address +\begin_inset space \hfill{} +\end_inset + +M-z r +\end_layout + +\begin_layout Subsection +Script jargon \end_layout \begin_layout Itemize +(O.S) — off screen +\end_layout -\family sans -Titlehead -\family default -: produces a left aligned paragraph above the ordinary title ( -\family sans -Title -\family default -, -\family sans -Author -\family default -, -\family sans -Date -\family default -, -\family sans -Subject -\family default -) for a document`s head. +\begin_layout Itemize +(V.0) — voice over \end_layout \begin_layout Itemize +b. +\begin_inset space \thinspace{} +\end_inset -\family sans -Uppertitleback -\family default -: produces in a double-sided print in -\emph on -report (koma-script) -\emph default - and -\emph on -book (koma-script) -\emph default - a left-aligned paragraph at the top of the title page`s back or has no - effect in a single-sided print or in -\emph on -article (koma-script) -\emph default -. +g. + — background \end_layout \begin_layout Itemize +C.U. + — close-up +\end_layout -\family sans -Lowertitleback -\family default -: produces in a double-sided print in -\emph on -report (koma-script) -\emph default - and -\emph on -book (koma-script) -\emph default - a left-aligned paragraph at the bottom of the title page`s back or has - no effect in a single-sided print or in -\emph on -article (koma-script) -\emph default -. +\begin_layout Itemize +PAN — camera movement \end_layout \begin_layout Itemize +INSERT — cut to close-up of +\end_layout -\family sans -Extratitle -\family default -: produces a special -\begin_inset Quotes eld -\end_inset +\begin_layout Section -dirty -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1669755802 +ijmpc and ijmpd +\end_layout - page ahead of the actual document containing a paragraph without special - formatting. +\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 -The layout files for the document classes -\emph on -article (koma-script) -\emph default -, + +\change_deleted 564990737 1669755802 +The ijmpc package is a set of macros that facilitates electronic manuscript + submission to the \emph on -report (koma-script) +International Journal of Modern Physics C \emph default -, and +. + Similarly, the ijmpd package is for creating manuscripts to be submitted + to the \emph on -book (koma-script) +International Journal of Modern Physics D \emph default - do include the file +. + Both journals are published by World Scientific. + The corresponding document classes are named \family typewriter -scrmacros.inc +ws-ijmpc.cls \family default -. - This is thought of as a place to define your own types. - Copy scrmacros + and \family typewriter -.inc +ws-ijmpd.cls \family default - in your personal layout directory and edit the file! +, 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 Subsection -letter (koma-script) +\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 Description -Note: This section discusses the obsolete -\family sans -KOMA-Script-Letter (v. -\begin_inset space ~ \end_inset -1) -\family default -, which is not even included anymore in recent KOMA releases. - Please refer to the next section for the current KOMA-Script-Letter class - (v. -\begin_inset space ~ +. + Both packages are modified versions of the standard +\begin_inset Quotes eld \end_inset -2)! +article +\begin_inset Quotes erd +\end_inset + + package, and they are almost (but not exactly) identical. + Most of their features are supported by \SpecialChar LyX +. + I have used \SpecialChar LyX + successfully to write articles submitted to both journals + without any problem. +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669755802 +Writing a paper \end_layout \begin_layout Standard -\noindent -The document class -\emph on -letter (koma-script) -\emph default - is implemented in the layout file -\family typewriter -scrlettr.layout -\family default -. - It contains all the paragraph types of the corresponding standard document - class -\emph on -letter -\emph default -, partly modified, with the exception of the \SpecialChar LyX - specific types + +\change_deleted 564990737 1669755802 +As usual, the easiest way to write a paper is to start with a template. + Click on \family sans -\SpecialChar LyX --Code +File\SpecialChar menuseparator +New from \family default - and + \family sans -Comment +Template \family default - and the -\family sans -List +, then choose the +\family typewriter +ijmpc.lyx \family default - type, which is replaced by the new -\family sans -Labeling + or +\family typewriter +ijmpd.lyx \family default - type. - In addition, it contains, in contrast to the standard document class, the - standard types -\family sans -\SpecialChar LaTeX - + template. + This will give an (almost) empty document that includes the most common + fields found in a manuscript. + Simply overwrite the existing text (including the brackets, +\family typewriter +<> \family default -, +) with your text. + You should keep in mind the following remarks. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +\SpecialChar LyX + won't let you change the font size and the page style of the document, + because such modifications are not allowed by both packages. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +The language of the document should not be changed. + Before previewing your paper, be sure that the babel package is not used. + To do this, click on +\begin_inset Info +type "menu" +arg "dialog-show document" +\end_inset + + \family sans -Quotation +\SpecialChar menuseparator +Language \family default -, +, and select +\begin_inset Quotes eld +\end_inset + +None +\begin_inset Quotes erd +\end_inset + + as \family sans -Quote +Language Package \family default +. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +The +\begin_inset Quotes eld +\end_inset + +Keywords +\begin_inset Quotes erd +\end_inset + + 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 + +Classification Codes +\begin_inset Quotes erd +\end_inset + +, which can be used to define classification codes, such as PACS numbers. + Note that this facility is not supported by the ijmpd package. +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +Several new environments are available: +\begin_inset Quotes eld +\end_inset + +Definition +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Step +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Example +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Remark +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Notation +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Theorem +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Proof +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Corollary +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Lemma +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Proposition +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Prop +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Question +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Claim +\begin_inset Quotes erd +\end_inset + , and -\family sans -Verse +\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 +refcite +\family default + command, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + + +\begin_inset Quotes eld +\end_inset + +See Ref. +\begin_inset space \space{} +\end_inset + + +\family typewriter + +\backslash +refcite{key} \family default + +\begin_inset Quotes erd +\end_inset + . - Furthermore, there are a number of new letter specific types. \end_layout -\begin_layout Standard -The appearance of the letter produced by this document class can be controlled - by a number of \SpecialChar LaTeX - commands, which you can put in the \SpecialChar LaTeX - preamble. -\begin_inset Foot -status collapsed +\begin_layout Enumerate -\begin_layout Plain Layout -For example, the standard appearance of the letter`s heading, consisting - of name and address, is quite self-willed. - An +\change_deleted 564990737 1669755802 +There is no \begin_inset Quotes eld \end_inset -ordinary +Acknowledgments \begin_inset Quotes erd \end_inset - heading is produced by the following \SpecialChar LaTeX - commands in the preamble: -\end_layout + section in both packages. + To put acknowledgments, just use the +\begin_inset Quotes eld +\end_inset -\begin_layout LyX-Code +Section* +\begin_inset Quotes erd +\end_inset -\backslash -firsthead{ -\backslash -parbox[b]{ -\backslash -textwidth} + environment. \end_layout -\begin_layout LyX-Code - { -\backslash -ignorespaces -\backslash -fromname -\backslash +\begin_layout Enumerate -\backslash - -\backslash -ignorespaces -\backslash -fromaddress}} -\end_layout +\change_deleted 564990737 1669755802 +Appendices may be added to the paper, +\emph on +after +\emph default + the Acknowledgments and +\shape italic +before +\shape default + the References. + \SpecialChar LyX + provides a special environment, called +\begin_inset Quotes eld +\end_inset -\begin_layout LyX-Code +Appendices Section +\begin_inset Quotes erd +\end_inset -\backslash -nexthead{ -\backslash -parbox[b]{ -\backslash -textwidth} -\end_layout + 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 -\begin_layout LyX-Code - { -\backslash -ignorespaces -\backslash -fromname -\backslash -hfill -\backslash -ignorespaces -\backslash -pagename -\backslash - -\backslash -thepage}} -\end_layout +Appendix +\begin_inset Quotes erd +\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 +\end_inset +Appendix +\begin_inset Quotes erd \end_inset - A detailed German description of such \SpecialChar LaTeX - commands can be found in the Koma-Script - documentation + 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 + + \emph on -scrguide +must \emph default -. - With it, the letter's author can produce his personal letter layout. + be present before the first appendix; if not, all appendices will be numbered + as normal sections in the output. \end_layout -\begin_layout Standard -The types -\family sans -Letter -\family default - and -\family sans -Opening +\begin_layout Enumerate + +\change_deleted 564990737 1669755802 +The ijmpc and the ijmpd packages use the +\family typewriter +tbl \family default - define the beginning of the letter and must be used in every letter. - To emphasize them in the \SpecialChar LyX - document class, they are marked with the letter - -\shape italic -L -\shape default - or -\shape italic -O -\shape default -, resp. -\begin_inset space ~ -\end_inset + 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 -in the left margin. - It is possible to write any number of letters in one file. - An -\family sans -Opening +\backslash +tbl{ +\emph on +your table caption +\emph default +}{ \family default - type produces a new letter using the same addressee and a -\family sans -Letter + (sic); you must also the \SpecialChar TeX + code +\family typewriter +} \family default - type produces a new addressee. - The types -\family sans -Closing + 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 -PS +Insert\SpecialChar menuseparator +File\SpecialChar menuseparator +Child +\begin_inset space ~ +\end_inset + +Document \family default -, -\family sans -CC +). + Details on how to create a table float can be found in the files +\family typewriter +ws-ijmpc.tex \family default -, and + and +\family typewriter +ws-ijmpd.tex +\family default +, included in the corresponding packages. +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669755802 +Preparing a paper for submission +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1669755802 +Before you submit your paper you must export the \SpecialChar LyX + document as a \SpecialChar LaTeX + file ( \family sans -Encl +File\SpecialChar menuseparator +Export\SpecialChar menuseparator +\SpecialChar LaTeX + \family default - are ordinary paragraph types and can also be used several times in one - and the same letter. +) +\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 Itemize +\end_inset -\family sans -Letter +, then make the following changes to the resulting +\family typewriter +.tex \family default -: produces a paragraph for the addressee and implicitly defines the beginning - of the letter. + file. \end_layout -\begin_layout Itemize +\begin_layout Enumerate -\family sans -Opening +\change_deleted 564990737 1669755802 +Remove the comment lines before the +\family typewriter + +\backslash +documentclass \family default -: produces a paragraph for the form of address and implicitly produces a - new letter. + command. \end_layout -\begin_layout Itemize +\begin_layout Enumerate -\family sans -Closing +\change_deleted 564990737 1669755802 +Remove everything between (and including) the +\family typewriter + +\backslash +makeatletter \family default -: produces a paragraph for a close. + and +\family typewriter + +\backslash +makeatother +\family default + commands, except for any commands you specifically put into the \SpecialChar LaTeX + preamble. \end_layout -\begin_layout Itemize +\begin_layout Standard -\family sans -PS +\change_deleted 564990737 1669755802 +The modified +\family typewriter +.tex \family default -: produces a paragraph for a postscript. + 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 Itemize +\begin_layout Section -\family sans -CC -\family default -: produces a paragraph for a distribution list. +\change_deleted 564990737 1669801478 +iopart \end_layout -\begin_layout Itemize +\begin_layout Standard -\family sans -Encl -\family default -: produces a paragraph for enclosures. +\change_deleted 564990737 1669801478 +by +\noun on +Uwe Stöhr +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669801478 +Overview \end_layout \begin_layout Standard -The types -\family sans -Name -\family default -, -\family sans -Signature -\family default -, -\family sans -Address -\family default -, -\family sans -Telephone -\family default -, -\family sans -Place -\family default -, -\family sans -Backaddress -\family default -, -\family sans -Specialmail -\family default -, -\family sans -Location -\family default -, -\family sans -Title -\family default -, and -\family sans -Subject -\family default - are input types provided with a label to enter information, which will - be processed by the document class. -\begin_inset Foot + +\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 -It could be seen as a matter of inconsequence, that the types -\family sans -Letter -\family default - and -\family sans -Opening -\family default - described above are not such input types as well. - Because of the special meaning of those types, however, I have implemented - them as ordinary paragraph types with a one letter mark in the left margin. - Moreover, it would affect my feeling of symmetry, if the -\family sans -Opening -\family default - type and the -\family sans -Closing -\family default - type had such a serious different appearance. + +ftp://ftp.iop.org/pub/journals/latex2e \end_layout \end_inset - The types must be used ahead of the corresponding -\family sans -Opening -\family default - type. +. +\end_layout + +\begin_layout Subsection + +\change_deleted 564990737 1669801478 +Writing a paper \end_layout \begin_layout Standard -An implementation of these types in a WYSIWYG fashion does not seem to make - sense, because the real appearance of the produced letter does not only - depend on the usage of the particular type, but also on other factors. - For example, a signature entered in the -\family sans -Signature -\family default - type will in the standard behavior appear in the produced letter only, - when in the same letter also a + +\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 -Closing +File\SpecialChar menuseparator +New From Template \family default - type is used. - The entered value of the + The template explains how to use the special text environments. + Here are the most important advices: +\end_layout + +\begin_layout Itemize + +\change_deleted 564990737 1669801478 +To be able to compile your document to a PDF, PS, or DVI, ensure that the + no AMS packages are loaded in \family sans -Telephone +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator +Math Options \family default - type will in the standard behavior not appear in the produced letter at - all. - The possibility to design the letter`s heading freely is already indicated - in a footnote above. +! \end_layout -\begin_layout Standard -The input types can also be used as empty paragraphs. - This makes sense e. -\begin_inset space \thinspace{} -\end_inset +\begin_layout Itemize -g. -\begin_inset space \space{} -\end_inset +\change_deleted 564990737 1669801478 -for the -\family sans -Signature -\family default - type. - If the -\family sans -Signature -\family default - type is not used at all, in the standard behavior the value of the -\family sans -Name -\family default - type is used as signature, whereas if an empty -\family sans -Signature -\family default - type is used, no signature value is defined. +\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 Standard -By using the input types it is possible to write a letter template, containing - filled input types with your personal dates (name, address, etc.) and empty - input types for other dates you want to enter. +\begin_deeper +\begin_layout Itemize + +\change_deleted 564990737 1669801478 + +\family sans +\size normal +Title +\family default + for a Paper \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Name +\size normal +Review \family default -: sender's name, in the standard behavior appears as a centered paragraph - in small caps in the letter`s heading. + for a Review \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Signature -\family default -: sender's signature, in the standard behavior appears below the -\family sans -Closing -\family default - type. - If no -\family sans -Signature -\family default - type is used, the value of the -\family sans -Name +\size normal +Topical \family default - type appears instead. + for a Topical review \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Address +\size normal +Comment \family default -: sender's address, in the standard behavior appears in a centered paragraph - in the letter`s heading below the sender's name. + for a Comment \end_layout \begin_layout Itemize -\family sans -Telephone -\family default -: sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX - variable - -\family typewriter +\change_deleted 564990737 1669801478 -\backslash -telephonenum +\family sans +\size normal +Note \family default -. + for a Note \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Place +\size normal +Paper \family default -: place of the letter`s making. + for a Paper (same as Title) \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Date -\family default -: date of the letter`s making. - -\family sans -Place -\family default - and -\family sans -Date -\family default -, in the standard behavior, produce the place and the date in a right-aligned - line below the addressee's field. - If an empty -\family sans -Date -\family default - type is used, neither place nor date appear, independent of the value of - the -\family sans -Place -\family default - type. - If no -\family sans -Date +\size normal +Prelim \family default - type is used, the date of the letter `s production is used. + for a Preliminary communication \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Backaddress +\size normal +Rapid \family default -: sender`s back address, in the standard behavior appears above the addressee's - field in a small sans serif font. + for a Rapid communication \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 + \family sans -Specialmail +\size normal +Letter \family default -: special mail information, in the standard behavior appears underlined - above the addressee's field below the back address. + 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 -Location +Letter \family default -: additional information, in the standard behavior appears on right side - below the addressee`s field. + can have an optional short title. \end_layout \begin_layout Itemize +\change_deleted 564990737 1669801478 +There is a general title environment \family sans -Title +Article \family default -: the letter's title, in the standard behavior appears in a big, bold, sans - serif font above the subject. + 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 Itemize +\begin_layout Standard + +\change_deleted 564990737 1669801478 +For more informations like hints for special table and formula formatting, + look at the IOP author guidelines. +\change_unchanged -\family sans -Subject -\family default -: the letter's subject, in the standard behavior appears in a bold font - above the -\family sans -Opening -\family default - paragraph. +\end_layout + +\begin_layout Section + +\change_deleted 564990737 1670317155 +Kluwer \end_layout \begin_layout Standard -The types -\family sans -Yourref -\family default -, -\family sans -Yourmail -\family default -, -\family sans -Myref -\family default -, -\family sans -Customer -\family default -, and -\family sans -Invoice -\family default - produce a business letter like line above the -\family sans -Title -\family default - line containing the fields -\begin_inset Quotes eld -\end_inset -Your ref. -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1670317155 +by +\noun on +Panayotis Papasotiriou +\end_layout -, -\begin_inset Quotes eld -\end_inset +\begin_layout Subsection -Your letter of -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1670317155 +Overview +\end_layout -, -\begin_inset Quotes eld -\end_inset +\begin_layout Standard -Our ref. -\begin_inset Quotes erd -\end_inset +\change_deleted 564990737 1670317155 +The Kluwer package is a set of macros produced by Kluwer Academic Publishers + that facilitates electronic manuscript submission to the journals they + publish. + Most known of them (at least in my domain of interest) are +\emph on +Astrophysics and Space Science +\emph default + and +\emph on +Solar Physics +\emph default +, but there are many others (see a complete list at +\begin_inset Flex URL +status collapsed -, -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout -Customer no. -\begin_inset Quotes erd -\end_inset +http://www.wkap.nl/jrnllist.htm/JRNLHOME +\end_layout -, -\begin_inset Quotes eld \end_inset -Invoice no. -\begin_inset Quotes erd -\end_inset +). + The Kluwer package may be downloaded from the site +\begin_inset Flex URL +status collapsed -, and -\begin_inset Quotes eld -\end_inset +\begin_layout Plain Layout + +http://www.wkap.nl/kaphtml.htm/STYLEFILES +\end_layout -Date -\begin_inset Quotes erd \end_inset . - For the date field, the value of the -\family sans -Date -\family default - type is used. - If one of these + A complete user guide is contained in that package (but it can also be + downloaded separately). +\end_layout + +\begin_layout Standard + +\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 -business letter types +peculiar \begin_inset Quotes erd \end_inset - is used, the value of the -\family sans -Place -\family default - type however does not appear, but only the \SpecialChar LaTeX - variable -\family typewriter - -\backslash -fromplace -\family default - is set. - The ordinary output of place and date in a right-aligned line below the - addressee`s field is suppressed. - The types are implemented as input types provided with a label and must - be used ahead of the corresponding -\family sans -Opening -\family default - type. -\end_layout + commands of the package (see +\begin_inset space ~ +\end_inset -\begin_layout Itemize -\family sans -Yourref -\family default -: Your ref. -\end_layout +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:kluwer_peculiarities" -\begin_layout Itemize +\end_inset -\family sans -Yourmail -\family default -: Your letter of. +). + 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 Itemize +\begin_layout Subsection -\family sans -Myref -\family default -: Our ref. +\change_deleted 564990737 1670317155 +Writing a paper \end_layout -\begin_layout Itemize +\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 -Customer +File\SpecialChar menuseparator +New from \family default -: Customer no. -\end_layout - -\begin_layout Itemize - + \family sans -Invoice +Template \family default -: Invoice no. +, then choose the +\family typewriter +kluwer.lyx +\family default + template. + This will give an (almost) empty document that includes the most common + fields found in a manuscript and a short description of their use. + As in most templates, simply overwrite the existing text (including the + brackets, +\family typewriter +<> +\family default +) with the correct information. \end_layout \begin_layout Subsection -The new letter class: letter (koma-script v.2) -\end_layout -\begin_layout Standard -by -\noun on -Jürgen Spitzmüller +\change_deleted 564990737 1670317155 +Preparing a paper for submission \end_layout \begin_layout Standard -\begin_inset VSpace medskip + +\change_deleted 564990737 1670317155 +As in the AAS\SpecialChar TeX + package, before you submit your paper to a journal you must + +\begin_inset Quotes eld \end_inset +postprocess +\begin_inset Quotes erd +\end_inset + it as follows. \end_layout -\begin_layout Standard -\noindent -Koma-Script version 2.8 has introduced a new letter class -\family typewriter -scrlttr2 -\family default - which supersedes the now unsupported -\family typewriter -scrlettr -\family default -. - It has — on the \SpecialChar LaTeX - side — a completely new interface and is not compatible - with the old class. - Therefore, \SpecialChar LyX - supports both, though it is recommended you use the new class. -\end_layout +\begin_layout Enumerate -\begin_layout Standard -This class covers the same functionality as -\emph on -letter (koma-script), -\emph default - and a few more. - The basic items are -\family sans -Address -\family default - (receiver's address, same as -\family sans -Letter -\family default - in the old layout), -\family sans -Opening -\family default -, and +\change_deleted 564990737 1670317155 +Export your paper as a \SpecialChar LaTeX + file. + To do this, click on \family sans -Closing +File\SpecialChar menuseparator +Export\SpecialChar menuseparator +\SpecialChar LaTeX + \family default . -\family sans -NextAddress -\family default - will start a new letter (i. -\begin_inset space \thinspace{} -\end_inset +\end_layout -e. -\begin_inset space \space{} -\end_inset +\begin_layout Enumerate -you can write several letters per document). - New elements are sender's -\family sans -E-Mail -\family default -, -\family sans -URL -\family default -, -\family sans -Fax -\family default -, -\family sans -Bank -\family default - and the possibility to use a -\family sans -Logo -\family default - (via -\family sans -Insert\SpecialChar menuseparator -Graphics +\change_deleted 564990737 1670317155 +Edit the resulting +\family typewriter +.tex \family default -) in the header. + file with a text editor and make the following changes \end_layout -\begin_layout Standard -The biggest improvement is, though, that the letter's layout is configurable - to meet almost any needs. - This can be done via the preamble or with a special style file (Letter - Class Option, extension +\begin_deeper +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +remove the comment lines before the \family typewriter -*.lco + +\backslash +documentclass \family default -), that will be read in as a class option. -\begin_inset Foot -status collapsed + command, +\end_layout -\begin_layout Plain Layout -The KOMA package comes with some default +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +remove everything between (and including) the \family typewriter -*.lco + +\backslash +makeatletter \family default - files. - There is, for instance, a + and \family typewriter -DIN.lco + +\backslash +makeatother \family default - file that follows german typesetting rules, or a + commands, except for any commands you specifically put into the \SpecialChar LaTeX + preamble. +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1670317155 +Save the resulting \family typewriter -KOMAold.lco +.tex \family default - that provides the default layout of the old + file. +\end_layout + +\end_deeper +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +Run the \family typewriter -scrlettr +.tex \family default - class. - The latter can be loaded with the class option + 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 -KOMAold +.dvi \family default -, inserted via the + document using, e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + + \family sans -Layout\SpecialChar menuseparator -Document\SpecialChar menuseparator -Extra Options +xdvi \family default - field. +, and check if everything is OK (it should, if you didn't make any mistake). \end_layout +\begin_layout Subsection + +\change_deleted 564990737 1670317155 +\begin_inset Quotes eld +\end_inset + +Peculiarities +\begin_inset Quotes erd +\end_inset + + of the Kluwer package +\begin_inset CommandInset label +LatexCommand label +name "subsec:kluwer_peculiarities" + \end_inset - Have a look at the -\emph on -koma-letter2 -\emph default - template that is included in \SpecialChar LyX - for examples. - A detailed description is to be found in the Koma-Script documentation - ( -\emph on -scrguide -\emph default -). -\end_layout -\begin_layout Subsection -Problems \end_layout \begin_layout Standard -Visualizing the Koma-Script document classes in \SpecialChar LyX -, the \SpecialChar LyX - internals cause some - problems. + +\change_deleted 564990737 1670317155 +The Kluwer package has the following +\begin_inset Quotes eld +\end_inset + +peculiarities +\begin_inset Quotes erd +\end_inset + +. \end_layout -\begin_layout Itemize -The chapter number of a -\family sans -Chapter -\family default - type appears on a line of its own above the chapter heading instead of - appearing in the same line ahead of it. - The cause for that is the \SpecialChar LyX - internal behavior for the labeltype -\family sans -Counter_Chapter -\family default - in the layout file. +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +It is possible to write multiple articles in the same \SpecialChar LaTeX + file +\begin_inset Foot +status collapsed + +\begin_layout Plain Layout +I can't imagine any good reason to do this. \end_layout -\begin_layout Itemize -The headings of the types -\family sans -Addchap +\end_inset + +. + 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 +begin{article} \family default - and -\family sans -Addsec + and, obviously, ends with the command +\family typewriter + +\backslash +end{article} \family default - are only put in the +. + 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 -true +\SpecialChar TeX + code \begin_inset Quotes erd \end_inset - \SpecialChar LaTeX - table of contents, but not in the \SpecialChar LyX - table of contents ( -\family sans -Document\SpecialChar menuseparator -Table -\begin_inset space ~ +). +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +Information given at the beginning of the article (i. +\begin_inset space \thinspace{} \end_inset -of +e. +\begin_inset space \space{} +\end_inset + +title, subtitle, author, institution, running title, running author, abstract + and keywords) must be included in an environment called +\begin_inset Quotes eld +\end_inset + +opening +\begin_inset Quotes erd +\end_inset + +. + This is not implemented in \SpecialChar LyX +, so you must enter title, subtitle etc. \begin_inset space ~ \end_inset -Contents +between two \SpecialChar TeX + code lines ( +\family typewriter + +\backslash +begin{opening} +\family default + and +\family typewriter + +\backslash +end{opening} \family default ). \end_layout -\begin_layout Itemize -The paragraphs in a +\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 -letter +author(s) +\family typewriter \emph default - document class appear in a skip separation mode, not indented. - This is the standard behavior, no special \SpecialChar LaTeX - commands are needed for that. - But in the -\family sans -Document\SpecialChar menuseparator -Settings +}{ \family default - dialog the corresponding radio button indicates -\family sans -Indent +\emph on +year +\family typewriter +\emph default +} \family default . - A -\family sans -Skip +\end_layout + +\begin_layout Standard + +\change_deleted 564990737 1670317155 +The +\family typewriter +kluwer.lyx \family default - value always has the effect that extra \SpecialChar LaTeX - commands are inserted in the document - to produce the gap, which is not what is wanted in this case. + template takes care of all these +\begin_inset Quotes eld +\end_inset + +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 +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +don't delete the \SpecialChar TeX + code included in the template, and +\end_layout + +\begin_layout Enumerate + +\change_deleted 564990737 1670317155 +copy the example bibliography item included in the template and modify it + as necessary to enter new bibliography items. \end_layout \begin_layout Section