X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FCustomization.lyx;h=149590ff19ca9e9dec92c6bfec2f850ec1082271;hb=2b4300a48d88b38d2bb84c575ef55791489263ce;hp=f97cd15e4f2b3da879b81c09d1811223f94d0f7b;hpb=a2e8cb758b70269da40d13d7b272d256a29a022a;p=lyx.git diff --git a/lib/doc/Customization.lyx b/lib/doc/Customization.lyx index f97cd15e4f..149590ff19 100644 --- a/lib/doc/Customization.lyx +++ b/lib/doc/Customization.lyx @@ -1,7 +1,9 @@ -#LyX 2.0 created this file. For more info see http://www.lyx.org/ -\lyxformat 413 +#LyX 2.2 created this file. For more info see http://www.lyx.org/ +\lyxformat 508 \begin_document \begin_header +\save_transient_properties true +\origin /systemlyxdir/doc/ \textclass scrbook \begin_preamble % DO NOT ALTER THIS PREAMBLE!!! @@ -13,15 +15,6 @@ % the documentation team % email: lyx-docs@lists.lyx.org -\usepackage{ifpdf} % part of the hyperref bundle -\ifpdf % if pdflatex is used - - % set fonts for nicer pdf view - \IfFileExists{lmodern.sty} - {\usepackage{lmodern}}{} - -\fi % end if pdflatex is used - % the pages of the TOC is numbered roman % and a pdf-bookmark for the TOC is added \let\myTOC\tableofcontents @@ -30,6 +23,18 @@ \pdfbookmark[1]{\contentsname}{} \myTOC \mainmatter } + +% increase link area for cross-references and autoname them, +\AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}} +\@ifundefined{extrasenglish}{\usepackage[english]{babel}}{} +\@ifpackageloaded{babel}{ + \addto\extrasenglish{% + \renewcommand*{\equationautorefname}[1]{}% + \renewcommand{\sectionautorefname}{sec.\negthinspace}% + \renewcommand{\subsectionautorefname}{sec.\negthinspace}% + \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}% + } +}{} \end_preamble \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading \use_default_options false @@ -37,46 +42,22 @@ logicalmkup \end_modules \maintain_unincluded_children false -\begin_local_layout -Format 35 -InsetLayout Flex:MenuItem -LyxType charstyle -LabelString menu -LatexType command -LatexName menuitem -Font -Family Sans -EndFont -Preamble -\newcommand*{\menuitem}[1]{{\sffamily #1}} -EndPreamble -End -# In case we need to do with sans... -#InsetLayout CharStyle:Code -#Font -#Family Sans -#EndFont -#Preamble -#\renewcommand{\code}[1]{{\sffamily #1}} -#EndPreamble -#End -\end_local_layout \language english \language_package default \inputencoding auto \fontencoding global -\font_roman default -\font_sans default -\font_typewriter default +\font_roman "lmodern" "default" +\font_sans "lmss" "default" +\font_typewriter "lmtt" "default" +\font_math "auto" "auto" \font_default_family default \use_non_tex_fonts false \font_sc false \font_osf false -\font_sf_scale 100 -\font_tt_scale 100 - +\font_sf_scale 100 100 +\font_tt_scale 100 100 \graphics default -\default_output_format default +\default_output_format pdf2 \output_sync 0 \bibtex_command default \index_command default @@ -99,16 +80,26 @@ End \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false" \papersize default \use_geometry false -\use_amsmath 0 -\use_esint 0 -\use_mhchem 0 -\use_mathdots 1 +\use_package amsmath 0 +\use_package amssymb 0 +\use_package cancel 0 +\use_package esint 0 +\use_package mathdots 1 +\use_package mathtools 0 +\use_package mhchem 0 +\use_package stackrel 0 +\use_package stmaryrd 0 +\use_package undertilde 0 \cite_engine basic +\cite_engine_type default +\biblio_style plain \use_bibtopic false \use_indices false \paperorientation portrait \suppress_date false +\justification true \use_refstyle 0 +\notefontcolor #0000ff \branch OutDated \selected 0 \filename_suffix 0 @@ -126,29 +117,31 @@ End \papercolumns 1 \papersides 2 \paperpagestyle headings -\tracking_changes true +\tracking_changes false \output_changes false \html_math_output 0 \html_css_as_file 0 \html_be_strict true -\author -195340706 "Georg Baum" \end_header \begin_body \begin_layout Title -Customizing LyX: Features for the Advanced User +Customizing \SpecialChar LyX +: Features for the Advanced User \end_layout \begin_layout Author -by the LyX Team +by the \SpecialChar LyX + Team \begin_inset Foot status collapsed \begin_layout Plain Layout \noindent -If you have comments or error corrections, please send them to the LyX Documenta -tion mailing list, +If you have comments or error corrections, please send them to the \SpecialChar LyX + Documentatio +n mailing list, \begin_inset CommandInset href LatexCommand href target "lyx-docs@lists.lyx.org" @@ -179,7 +172,7 @@ type "mailto:" \begin_inset Newline newline \end_inset -Version 2.0.x +Version 2.2.x \end_layout \begin_layout Standard @@ -212,10 +205,15 @@ Introduction \end_layout \begin_layout Standard -This manual covers the customization features present in LyX. +This manual covers the customization features present in \SpecialChar LyX +. In it, we discuss issues like keyboard shortcuts, screen previewing options, - printer options, sending commands to LyX via the LyX Server, internationalizati -on, installing new LaTeX classes and LyX layouts, etc. + printer options, sending commands to \SpecialChar LyX + via the \SpecialChar LyX + Server, internationalization, + installing new \SpecialChar LaTeX + classes and \SpecialChar LyX + layouts, etc. We can't possibly hope to touch on everything you can change—our developers add new features faster than we can document them—but we will explain the most common customizations and hopefully point you in the right direction @@ -229,7 +227,8 @@ status collapsed \begin_layout Standard Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document. - By default, this information will not appear in the LaTeX output. + By default, this information will not appear in the \SpecialChar LaTeX + output. \end_layout \end_inset @@ -238,19 +237,22 @@ Information from previous versions of this document that now seems to be \end_layout \begin_layout Chapter -LyX configuration files +\SpecialChar LyX + configuration files \end_layout \begin_layout Standard -This chapter aims to help you to find your way through the LyX configuration +This chapter aims to help you to find your way through the \SpecialChar LyX + configuration files. Before continuing to read this chapter, you should find out where your - LyX library and user directories are by using -\begin_inset Flex MenuItem + \SpecialChar LyX + library and user directories are by using +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Help\SpecialChar \menuseparator +Help\SpecialChar menuseparator About \begin_inset space ~ \end_inset @@ -261,8 +263,9 @@ LyX \end_inset . - The library directory is the place where LyX places its system-wide configurati -on files; the user directory is where you can place your modified versions. + The library directory is the place where \SpecialChar LyX + places its system-wide configuration + files; the user directory is where you can place your modified versions. We will call the former \begin_inset Flex Code status collapsed @@ -274,7 +277,7 @@ LyXDir \end_inset and the latter -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -312,23 +315,27 @@ LyXDir \end_inset and its sub-directories contain a number of files and that can be used - to customize LyX's behavior. - You can change many of these files from within LyX itself through the -\begin_inset Flex MenuItem + to customize \SpecialChar LyX +'s behavior. + You can change many of these files from within \SpecialChar LyX + itself through the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Preferences \end_layout \end_inset dialog. - Most customization that you will want to do in LyX is possible through - this dialog. - However, many other inner aspects of LyX can be customized by modifying - the files in + Most customization that you will want to do in \SpecialChar LyX + is possible through this + dialog. + However, many other inner aspects of \SpecialChar LyX + can be customized by modifying the + files in \begin_inset Flex Code status collapsed @@ -349,7 +356,7 @@ Automatically generated files \begin_layout Standard The files, which are to be found in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -358,7 +365,8 @@ UserDir \end_inset -, are generated when you configure LyX. +, are generated when you configure \SpecialChar LyX +. They contain various default values that are guessed by inspection. In general, it is not a good idea to modify them, since they might be overwritt en at any time. @@ -389,15 +397,18 @@ packages.lst \end_inset - contains the list of packages that have been recognized by LyX. - It is currently unused by the LyX program itself, but the information extracted -, and more, is made available with -\begin_inset Flex MenuItem + contains the list of packages that have been recognized by \SpecialChar LyX +. + It is currently unused by the \SpecialChar LyX + program itself, but the information extracted, + and more, is made available with +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Help\SpecialChar \menuseparator -LaTeX +Help\SpecialChar menuseparator +\SpecialChar LaTeX + \begin_inset space ~ \end_inset @@ -430,8 +441,8 @@ layout/ \end_inset - directories, along with the associated LaTeX document class and their descripti -on. + directories, along with the associated \SpecialChar LaTeX + document class and their description. \end_layout \begin_layout Labeling @@ -469,7 +480,8 @@ status collapsed \end_inset - lists of various sorts of LaTeX-related files found on your system + lists of various sorts of \SpecialChar LaTeX +-related files found on your system \end_layout \begin_layout Labeling @@ -478,7 +490,8 @@ status collapsed status collapsed \begin_layout Plain Layout -doc/LaTeXConfig.lyx +doc/\SpecialChar LaTeX +Config.lyx \end_layout \end_inset @@ -488,13 +501,15 @@ doc/LaTeXConfig.lyx status collapsed \begin_layout Plain Layout -LaTeXConfig.lyx.in +\SpecialChar LaTeX +Config.lyx.in \end_layout \end_inset . - It contains information on your LaTeX configuration. + It contains information on your \SpecialChar LaTeX + configuration. \end_layout \begin_layout Subsection @@ -557,7 +572,8 @@ status collapsed \end_inset - that define the keybindings used in LyX. + that define the keybindings used in \SpecialChar LyX +. If there exists an internationalized version of the bind file named \begin_inset Flex Code status collapsed @@ -597,13 +613,15 @@ doc/ \end_inset - contains LyX documentation files (including the one you are currently reading). + contains \SpecialChar LyX + documentation files (including the one you are currently reading). The file \begin_inset Flex Code status collapsed \begin_layout Plain Layout -LaTeXConfig.lyx +\SpecialChar LaTeX +Config.lyx \end_layout \end_inset @@ -628,11 +646,7 @@ xx \end_inset is the ISO language code. - See chapter -\begin_inset space ~ -\end_inset - - + See \begin_inset CommandInset ref LatexCommand ref reference "cha:Internationalizing-LyX" @@ -655,7 +669,7 @@ examples/ contains example files that explain how to use some features. In the file browser, press the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -679,7 +693,7 @@ images/ \end_inset contains image files that are used by the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -690,7 +704,8 @@ Document dialog. In addition, it also contains the individual icons used in the toolbar - and the banners that can be shown when LyX is launched. + and the banners that can be shown when \SpecialChar LyX + is launched. \end_layout \begin_layout Labeling @@ -705,11 +720,7 @@ kbd/ \end_inset contains keyboard keymapping files. - See Chapter -\begin_inset space ~ -\end_inset - - + See \begin_inset CommandInset ref LatexCommand ref reference "sec:International-Keymap-Stuff" @@ -730,11 +741,7 @@ layouts/ \end_inset - contains the text class and module files described in Chapter -\begin_inset space ~ -\end_inset - - + contains the text class and module files described in \begin_inset CommandInset ref LatexCommand ref reference "cha:Installing-New-Document" @@ -765,7 +772,8 @@ lyx2lyx \end_inset - Python scripts used to convert between LyX versions. + Python scripts used to convert between \SpecialChar LyX + versions. These can be run from the command line if, say, you want to batch-convert files. \end_layout @@ -782,7 +790,7 @@ scripts/ \end_inset contains some files that demonstrate the capabilities of the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -796,7 +804,8 @@ Template \end_inset feature. - Also contains some scripts used by LyX itself. + Also contains some scripts used by \SpecialChar LyX + itself. \end_layout \begin_layout Labeling @@ -810,14 +819,11 @@ templates/ \end_inset - contains the standard LyX template files described in Chapter -\begin_inset space ~ -\end_inset - - + contains the standard \SpecialChar LyX + template files described in \begin_inset CommandInset ref LatexCommand ref -reference "sub:Creating-Templates" +reference "subsec:Creating-Templates" \end_inset @@ -845,7 +851,8 @@ status collapsed \end_inset - that define the user interface to LyX. + that define the user interface to \SpecialChar LyX +. That is, the files define which items appear in which menus and the items appearing on the toolbar. \end_layout @@ -855,8 +862,9 @@ Files you don't want to modify \end_layout \begin_layout Standard -These files are used internally by LyX and you generally do not need to - modify them unless you are a developer. +These files are used internally by \SpecialChar LyX + and you generally do not need to modify + them unless you are a developer. \end_layout \begin_layout Labeling @@ -870,13 +878,14 @@ CREDITS \end_inset - this file contains the list of LyX developers. + this file contains the list of \SpecialChar LyX + developers. The contents are displayed with the menu entry -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Help\SpecialChar \menuseparator +Help\SpecialChar menuseparator About \begin_inset space ~ \end_inset @@ -900,7 +909,8 @@ chkconfig.ltx \end_inset - this is a LaTeX script used during the configuration process. + this is a \SpecialChar LaTeX + script used during the configuration process. Do not run directly. \end_layout @@ -915,12 +925,13 @@ configure.py \end_inset - this is the script that is used to re-configure LyX. + this is a Python script that is used to re-configure \SpecialChar LyX +. It creates configuration files in the directory it was run from. \end_layout \begin_layout Subsection -Other files needing a line or two... +Other files needing a line or two \end_layout \begin_layout Labeling @@ -950,7 +961,7 @@ external_templates \end_inset this file contains the templates available to the new -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -963,7 +974,14 @@ Template \end_inset - feature. + feature, see +\begin_inset CommandInset ref +LatexCommand ref +reference "chap:Including-External-Material" + +\end_inset + +. \end_layout \begin_layout Labeling @@ -977,7 +995,61 @@ languages \end_inset - this file contains a list of all the languages currently supported by LyX. + this file contains a list of all the languages currently supported by \SpecialChar LyX +. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +latexfonts +\end_layout + +\end_inset + + contains information about the supported fonts. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +layouttranslations +\end_layout + +\end_inset + + this file contains translations for internationalized paragraph styles + (see +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:I18n" + +\end_inset + +). +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +unicodesymbols +\end_layout + +\end_inset + + this file contains information about unicode-encoded glyphs and the way + they are supported by \SpecialChar LyX + via \SpecialChar LaTeX +. \end_layout \begin_layout Section @@ -985,8 +1057,10 @@ Your local configuration directory \end_layout \begin_layout Standard -Even if you are using LyX as an unprivileged user, you might want to change - LyX configuration for your own use. +Even if you are using \SpecialChar LyX + as an unprivileged user, you might want to change + \SpecialChar LyX + configuration for your own use. The \begin_inset Flex Code status collapsed @@ -1007,11 +1081,11 @@ user directory \end_inset in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Help\SpecialChar \menuseparator +Help\SpecialChar menuseparator About \begin_inset space ~ \end_inset @@ -1064,11 +1138,11 @@ To make things clearer, let's provide a few examples: \begin_layout Itemize The preferences set in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Preferences \end_layout @@ -1099,17 +1173,18 @@ UserDir \begin_layout Itemize When you reconfigure using -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Reconfigure \end_layout \end_inset -, LyX runs the +, \SpecialChar LyX + runs the \begin_inset Flex Code status collapsed @@ -1133,11 +1208,11 @@ UserDir/layouts \end_inset will be added to the list of classes in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator +Document\SpecialChar menuseparator Settings \end_layout @@ -1147,7 +1222,8 @@ Settings \end_layout \begin_layout Itemize -If you get some updated documentation from LyX ftp site and cannot install +If you get some updated documentation from \SpecialChar LyX + ftp site and cannot install it because you do not have sysadmin rights on your system, you can just copy the files in \begin_inset Flex Code @@ -1160,7 +1236,7 @@ UserDir/doc/ \end_inset and the items in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1173,7 +1249,8 @@ Help \end_layout \begin_layout Section -Running LyX with multiple configurations +Running \SpecialChar LyX + with multiple configurations \end_layout \begin_layout Standard @@ -1186,7 +1263,8 @@ The configuration freedom of the local configuration directory may not suffice \end_layout \begin_layout Standard -Invoking LyX with the command line switch +Invoking \SpecialChar LyX + with the command line switch \begin_inset Flex Code status collapsed @@ -1202,7 +1280,8 @@ status collapsed \emph default instructs the program to read the configuration from that directory, and not from the default directory. - (You can determine the default directory by running LyX without the + (You can determine the default directory by running \SpecialChar LyX + without the \begin_inset Flex Code status collapsed @@ -1212,8 +1291,9 @@ status collapsed \end_inset - switch.) If the specified directory does not exist, LyX offers to create - it for you, just like it does for the default directory on the first time + switch.) If the specified directory does not exist, \SpecialChar LyX + offers to create it + for you, just like it does for the default directory on the first time you run the program. You can modify the configuration options in this additional user directory exactly as you would for the default directory. @@ -1245,7 +1325,8 @@ NewUserDir/layouts which you want available from all your configurations, you must add it to each directory separately. - You can avoid this with the following trick: after LyX creates the additional + You can avoid this with the following trick: after \SpecialChar LyX + creates the additional directory, most of the subdirectories (see above) are empty. If you want the new configuration to mirror an existing one, replace the empty subdirectory with a symbolic link to the matching subdirectory in @@ -1262,11 +1343,11 @@ doc/ subdirectory, however, since it contains a file written by the configuration script (also accessible through -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Reconfigure \end_layout @@ -1306,11 +1387,11 @@ name "sec:Formats" \begin_layout Standard The first step is to define your file formats if they are not already defined. To do so, open the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Preferences \end_layout @@ -1318,30 +1399,29 @@ Preferences dialog. Under -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -File Handling\SpecialChar \menuseparator +File Handling\SpecialChar menuseparator File formats \end_layout \end_inset press the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -New\SpecialChar \ldots{} - +New \end_layout \end_inset button to define your new format. The -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1352,7 +1432,7 @@ Format field contains the name used to identify the format in the GUI. The -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1365,7 +1445,7 @@ Short Name You will also need to enter a file extension. These are all required. The optional -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1376,22 +1456,22 @@ Shortcut field is used to provide a keyboard shortcut on the menus. (For example, pressing -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Alt-V F D +Ctrl+D \end_layout \end_inset will -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -View\SpecialChar \menuseparator -View (Other Formats)\SpecialChar \menuseparator +Document\SpecialChar menuseparator +View (Other Formats)\SpecialChar menuseparator DVI \end_layout @@ -1402,7 +1482,7 @@ DVI \begin_layout Standard A Format can have a -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1412,7 +1492,7 @@ Viewer \end_inset and an -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1423,7 +1503,7 @@ Editor associated with it. For example, you might want to use -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1437,11 +1517,13 @@ Ghostview fields. In defining this command, you can use the four variables listed in the next section. - The viewer is launched when you view an image in LyX or use the -\begin_inset Flex MenuItem + The viewer is launched when you view an image in \SpecialChar LyX + or use the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout +Document\SpecialChar menuseparator View \end_layout @@ -1450,7 +1532,7 @@ View menu. The editor is for example launched when you right-click on an image and choose -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1463,10 +1545,8 @@ Edit externally \end_layout \begin_layout Standard - -\change_inserted -195340706 1329851811 The -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1488,7 +1568,8 @@ target "http://www.iana.org/assignments/media-types/" \end_inset . - Therefore LyX uses the extended list of MIME types as specified by + Therefore \SpecialChar LyX + uses the extended list of MIME types as specified by \begin_inset CommandInset href LatexCommand href name "freedesktop.org" @@ -1501,7 +1582,7 @@ target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec" \begin_layout Standard The -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1510,12 +1591,9 @@ Document format \end_inset - option tells LyX that a format is suitable for document export. - If this is set and if a suitable conversion route exists (see sec. -\begin_inset space \thinspace{} -\end_inset - - + option tells \SpecialChar LyX + that a format is suitable for document export. + If this is set and if a suitable conversion route exists (see \begin_inset CommandInset ref LatexCommand ref reference "sec:Converters" @@ -1523,11 +1601,11 @@ reference "sec:Converters" \end_inset ), the format will appear in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -File\SpecialChar \menuseparator +File\SpecialChar menuseparator Export \end_layout @@ -1535,10 +1613,11 @@ Export menu. The format will also appear in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout +Document\SpecialChar menuseparator View \end_layout @@ -1571,7 +1650,7 @@ pdf \begin_layout Standard The option -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1580,10 +1659,11 @@ Vector graphics format \end_inset - tells LyX that a format can contain vector graphics. + tells \SpecialChar LyX + that a format can contain vector graphics. This information is used to determine the target format of included graphics for -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1594,7 +1674,7 @@ pdflatex export. Included graphics may need to be converted to either -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1604,7 +1684,7 @@ pdf \end_inset , -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1614,7 +1694,7 @@ png \end_inset , or -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1624,7 +1704,7 @@ jpg \end_inset , since -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1635,7 +1715,7 @@ pdflatex cannot handle other image formats. If an included graphic is not already in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1645,7 +1725,7 @@ pdf \end_inset , -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1655,7 +1735,7 @@ png \end_inset , or -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1665,7 +1745,7 @@ jpg \end_inset format, it is converted to -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1675,7 +1755,7 @@ pdf \end_inset if the vector format option is set, and otherwise to -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1692,7 +1772,8 @@ Copiers \end_layout \begin_layout Standard -Since all conversions from one format to another take place in LyX's temporary +Since all conversions from one format to another take place in \SpecialChar LyX +'s temporary directory, it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed. \begin_inset Foot @@ -1711,7 +1792,7 @@ For example, the file may refer to other files—images, for example—using \end_layout \begin_layout Standard -The definitions of the copiers may use four variables: +The definitions of the copiers may use eight variables: \end_layout \begin_layout Labeling @@ -1725,7 +1806,8 @@ $$s \end_inset - The LyX system directory (e. + The \SpecialChar LyX + system directory (e. \begin_inset space \thinspace{} \end_inset @@ -1734,7 +1816,7 @@ g. \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1779,17 +1861,79 @@ $$o \begin_inset Flex Code status collapsed +\begin_layout Plain Layout +$$b +\end_layout + +\end_inset + + The base name (without filename extension) in the \SpecialChar LyX + temporary directory +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$p +\end_layout + +\end_inset + + The full directory path of the \SpecialChar LyX + temporary directory +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$r +\end_layout + +\end_inset + + The full pathname to the original \SpecialChar LyX + file being processed +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +$$f +\end_layout + +\end_inset + + The filename (without any directory path) of the \SpecialChar LyX + file. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + \begin_layout Plain Layout $$l \end_layout \end_inset - The `LaTeX name' + The `\SpecialChar LaTeX + name' \end_layout \begin_layout Standard -The latter should be the filename as it would be used in a LaTeX's +The latter should be the filename as it would be used in a \SpecialChar LaTeX +'s \series bold \backslash @@ -1843,7 +1987,8 @@ cp $FROMFILE /home/you/pdf/$TOFILE \end_inset -Save it in your local LyX directory—say, +Save it in your local \SpecialChar LyX + directory—say, \begin_inset Flex Code status collapsed @@ -1855,29 +2000,29 @@ status collapsed —and make it executable, if you need to do so on your platform. Then, in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Preferences \end_layout \end_inset dialog, select under -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -File Handling\SpecialChar \menuseparator +File Handling\SpecialChar menuseparator File formats \end_layout \end_inset the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1897,7 +2042,7 @@ pdfcopier.sh $$i $$o \end_inset into the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1911,10 +2056,12 @@ Copier \end_layout \begin_layout Standard -Copiers are used by LyX in various of its own conversions. - For example, if appropriate programs are found, LyX will automatically - install copiers for the -\begin_inset Flex MenuItem +Copiers are used by \SpecialChar LyX + in various of its own conversions. + For example, if appropriate programs are found, \SpecialChar LyX + will automatically install + copiers for the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1924,7 +2071,7 @@ HTML \end_inset and -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1942,7 +2089,8 @@ HTML HTML file but various associated files (style files, images, etc.) are also copied. All these files are written to a subdirectory of the directory in which - the original LyX file was found. + the original \SpecialChar LyX + file was found. \begin_inset Foot status collapsed @@ -1972,7 +2120,7 @@ This copier can be customized. \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1986,7 +2134,7 @@ LyXconv \end_inset , so HTML generated from -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -1996,7 +2144,7 @@ status collapsed \end_inset will end up in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2028,13 +2176,13 @@ name "sec:Converters" \begin_layout Standard You can define your own Converters to convert files between different formats. This is done in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator -Preferences\SpecialChar \menuseparator -File Handling\SpecialChar \menuseparator +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator +File Handling\SpecialChar menuseparator Converters \end_layout @@ -2045,7 +2193,7 @@ Converters \begin_layout Standard To define a new converter, select the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2059,7 +2207,7 @@ format \end_inset and -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2074,7 +2222,7 @@ format from the drop-down lists, enter the command needed for the conversion, and then press the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2098,7 +2246,8 @@ $$s \end_inset - The LyX system directory + The \SpecialChar LyX + system directory \end_layout \begin_layout Labeling @@ -2192,7 +2341,7 @@ $$e \begin_layout Standard In the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2219,8 +2368,11 @@ latex \end_inset - This converter runs some form of LaTeX. - This will make LyX's LaTeX error logs available. + This converter runs some form of \SpecialChar LaTeX +. + This will make \SpecialChar LyX +'s \SpecialChar LaTeX + error logs available. \end_layout \begin_layout Labeling @@ -2234,8 +2386,9 @@ needaux \end_inset - Needs the LaTeX -\begin_inset Flex MenuItem + Needs the \SpecialChar LaTeX + +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2252,6 +2405,40 @@ status collapsed \begin_inset Flex Code status collapsed +\begin_layout Plain Layout +nice +\end_layout + +\end_inset + + Needs a +\begin_inset Quotes eld +\end_inset + +nice +\begin_inset Quotes erd +\end_inset + + file from the backend, which in practice means a \SpecialChar LaTeX + file like the one we + would export, without +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +input@path +\end_layout + +\end_inset + +. +\end_layout + +\begin_layout Labeling +\labelwidthstring 00.00.0000 +\begin_inset Flex Code +status collapsed + \begin_layout Plain Layout xml \end_layout @@ -2264,7 +2451,7 @@ xml \begin_layout Standard The following three flags are not really flags at all because they take an argument in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2342,8 +2529,9 @@ resultdir The name of the directory in which the converter will dump the generated files. - LyX will not create this directory, and it does not copy anything into - it, though it will copy this directory to the destination. + \SpecialChar LyX + will not create this directory, and it does not copy anything into it, + though it will copy this directory to the destination. The argument may contain \begin_inset Flex Code status collapsed @@ -2391,25 +2579,37 @@ $$b \begin_layout Standard None of these last three are presently used in any of the converters that - are installed with LyX. + are installed with \SpecialChar LyX +. \end_layout \begin_layout Standard You do not have to define converters for all formats between which you want to convert. - For example, you will note that there is no `LyX to PostScript' converter, - but LyX will export PostScript. - It does so by first creating a LaTeX file (no converter needs to be defined - for this) which is then converted to DVI using the `LaTeX to DVI' converter, + For example, you will note that there is no `\SpecialChar LyX + to PostScript' converter, + but \SpecialChar LyX + will export PostScript. + It does so by first creating a \SpecialChar LaTeX + file (no converter needs to be defined + for this) which is then converted to DVI using the `\SpecialChar LaTeX + to DVI' converter, and finally converting the resulting DVI file to PostScript. - LyX finds such `chains' of converters automatically, and it will always - choose the shortest possible chain. + \SpecialChar LyX + finds such `chains' of converters automatically, and it will always choose + the shortest possible chain. You can, though, still define multiple conversion methods between file formats. - For example, the standard LyX configuration provides three ways to convert - LaTeX to PDF: Directly, using -\begin_inset Flex MenuItem + For example, the standard \SpecialChar LyX + configuration provides five ways to convert + \SpecialChar LaTeX + to PDF: +\end_layout + +\begin_layout Enumerate +Directly, using +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2418,8 +2618,12 @@ pdflatex \end_inset -; via (DVI and) PostScript, using -\begin_inset Flex MenuItem + +\end_layout + +\begin_layout Enumerate +via (DVI and) PostScript, using +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2428,8 +2632,12 @@ ps2pdf \end_inset -; or via DVI, using -\begin_inset Flex MenuItem + +\end_layout + +\begin_layout Enumerate +via DVI, using +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2438,9 +2646,42 @@ dvipdfm \end_inset -. - To define such alternate chains, you must define multiple target `file - formats', as described in section + +\end_layout + +\begin_layout Enumerate +directly using +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Xe\SpecialChar TeX + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Enumerate +directly using +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Lua\SpecialChar TeX + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +To define such alternate chains, you must define multiple target `file formats', + as described in \begin_inset CommandInset ref LatexCommand ref reference "sec:Formats" @@ -2449,7 +2690,7 @@ reference "sec:Formats" . For example, in the standard configuration, the formats named -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2458,71 +2699,146 @@ pdf \end_inset -, -\begin_inset Flex MenuItem + (for +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -pdf2 +ps2pdf \end_layout \end_inset -, and -\begin_inset Flex MenuItem +), +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -pdf3 +pdf2 \end_layout \end_inset - are defined, all of which share the extension -\begin_inset Flex MenuItem + (for +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -.pdf +pdflatex \end_layout \end_inset -, and which correspond to the conversion methods just mentioned. -\end_layout +), +\begin_inset Flex Noun +status collapsed -\begin_layout Chapter -Internationalizing LyX -\begin_inset CommandInset label -LatexCommand label -name "cha:Internationalizing-LyX" +\begin_layout Plain Layout +pdf3 +\end_layout \end_inset + (for +\begin_inset Flex Noun +status collapsed +\begin_layout Plain Layout +dvipdfm \end_layout -\begin_layout Standard -LyX supports using a translated interface. - Last time we checked, LyX provided text in thirty languages. - The language of choice is called your -\emph on -locale -\emph default -. - (For further reading on locale settings, see also the documentation for - locale that comes with your operating system. - For Linux, the manual page for -\begin_inset Flex Code +\end_inset + +), +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -locale(5) +pdf4 \end_layout \end_inset - could be a good place to start). + (for +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Xe\SpecialChar TeX + +\end_layout + +\end_inset + +), and +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +pdf5 +\end_layout + +\end_inset + + (for +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +Lua\SpecialChar TeX + +\end_layout + +\end_inset + +) are defined, all of which share the extension +\begin_inset Flex Noun +status collapsed + +\begin_layout Plain Layout +.pdf +\end_layout + +\end_inset + +, and which correspond to the conversion methods just mentioned. +\end_layout + +\begin_layout Chapter +Internationalizing \SpecialChar LyX + +\begin_inset CommandInset label +LatexCommand label +name "cha:Internationalizing-LyX" + +\end_inset + + +\end_layout + +\begin_layout Standard +\SpecialChar LyX + supports using a translated interface. + Last time we checked, \SpecialChar LyX + provided text in thirty languages. + The language of choice is called your +\emph on +locale +\emph default +. + (For further reading on locale settings, see also the documentation for + locale that comes with your operating system. + For Linux, the manual page for +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +locale(5) +\end_layout + +\end_inset + + could be a good place to start). \end_layout \begin_layout Standard @@ -2541,16 +2857,19 @@ status collapsed \begin_layout Plain Layout If you are a fluent speaker of a language other than English, joining these - teams is a great way to give back to the LyX community! + teams is a great way to give back to the \SpecialChar LyX + community! \end_layout \end_inset - will of course try to fix these shortcomings in future versions of LyX. + will of course try to fix these shortcomings in future versions of \SpecialChar LyX +. \end_layout \begin_layout Section -Translating LyX +Translating \SpecialChar LyX + \end_layout \begin_layout Subsection @@ -2558,7 +2877,8 @@ Translating the graphical user interface (text messages). \end_layout \begin_layout Standard -LyX uses the GNU +\SpecialChar LyX + uses the GNU \begin_inset Flex Code status collapsed @@ -2569,8 +2889,9 @@ gettext \end_inset library to handle the internationalization of the interface. - To have LyX speak your favorite language in all menus and dialogs, you - need a + To have \SpecialChar LyX + speak your favorite language in all menus and dialogs, you need + a \begin_inset Flex Code status collapsed @@ -2616,8 +2937,10 @@ gettext . It is possible to do this just for yourself, but if you're going to do it, you might as well share the results of your labors with the rest of - the LyX community. - Send a message to the LyX developers' list for more information about how + the \SpecialChar LyX + community. + Send a message to the \SpecialChar LyX + developers' list for more information about how to proceed. \end_layout @@ -2626,12 +2949,13 @@ In short, this is what you should do (xx denotes the language code): \end_layout \begin_layout Itemize -Check out the LyX source code. +Check out the \SpecialChar LyX + source code. (See the \begin_inset CommandInset href LatexCommand href name "information on the web" -target "http://www.lyx.org/HowToUseSVN" +target "http://www.lyx.org/HowToUseGIT" \end_inset @@ -2736,7 +3060,20 @@ po \end_inset - files, as well. + files, as well, see +\begin_inset Flex URL +status open + +\begin_layout Plain Layout + +https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html +\backslash +#PO-Mode +\end_layout + +\end_inset + +. \end_layout \end_inset @@ -2849,8 +3186,10 @@ po \end_inset --file could be added to the LyX distribution, so others can use it. - Adding it involves making additional changes to LyX. + file could be added to the \SpecialChar LyX + distribution, so others can use it. + Adding it involves making additional changes to \SpecialChar LyX +. So send an email to the developers' mailing list if you're interested in doing that. \end_layout @@ -2967,7 +3306,8 @@ Of course the context information needs to be stripped off the original message when no translation is used. Therefore you have to put it in double square brackets at the end of the message (see the example above). - The translation mechanism of LyX ensures that everything in double square + The translation mechanism of \SpecialChar LyX + ensures that everything in double square brackets at the end of messages is removed before displaying the message. \end_layout @@ -2977,7 +3317,7 @@ Translating the documentation. \begin_layout Standard The online documentation (in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -2999,8 +3339,10 @@ As of March 2008, at least some of the documents have been translated into \end_inset and the locale is set accordingly, these will be used automagically by - LyX. - LyX looks for translated versions as + \SpecialChar LyX +. + \SpecialChar LyX + looks for translated versions as \begin_inset Flex Code status collapsed @@ -3073,11 +3415,11 @@ Intro.lyx \end_inset ( -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Help\SpecialChar \menuseparator +Help\SpecialChar menuseparator Introduction \end_layout @@ -3112,10 +3454,48 @@ UserDir/doc/xx/ \end_inset directory. +\begin_inset Note Greyedout +status open + +\begin_layout Plain Layout + +\series bold +Note: +\series default + For a complex document with external material (images, etc.), if you make + a copy e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +in a temp dir, beware that the links to external material may be broken + when the document is moved to a different place. + The best way is to retrieve the \SpecialChar LyX + tree from git (see +\begin_inset Flex URL +status collapsed + +\begin_layout Plain Layout + +http://www.lyx.org/HowToUseGIT +\end_layout + +\end_inset + +) and to edit the doc file in place. +\end_layout + +\end_inset + + \end_layout \begin_layout Itemize -Sometimes the original document (from the LyX-team) will be updated. +Sometimes the original document (from the \SpecialChar LyX + team) will be updated. Use the source viewer at \begin_inset CommandInset href LatexCommand href @@ -3553,7 +3933,8 @@ status collapsed \end_inset - marks comments, quotes start and end LaTeX-style commands. + marks comments, quotes start and end \SpecialChar LaTeX +-style commands. To enter quote, you'll need to use \begin_inset Flex Code status collapsed @@ -3939,7 +4320,7 @@ must be escaped with a preceding backslash ( \begin_layout Standard An example of a -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -3951,7 +4332,7 @@ kmap \end_inset statement to cause the symbol -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -3963,7 +4344,7 @@ status collapsed \end_inset to be output for the keystroke -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4115,7 +4496,7 @@ followed by the other, not allowed key, as output. \family default Note that a -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4137,7 +4518,7 @@ char \family default \emph default -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4543,7 +4924,7 @@ kcomb acute umlaut iyIY \begin_layout Standard This allows you to press -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4578,7 +4959,7 @@ A backspace \family default \shape default in this case cancels the last dead key, so if you press -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4639,7 +5020,8 @@ f file maps the strings that the symbols generate to characters in the current font. - The LyX distribution currently includes at least the + The \SpecialChar LyX + distribution currently includes at least the \begin_inset Flex Code status collapsed @@ -4697,7 +5079,7 @@ char_index_in_set \begin_layout Standard For example, in order to map -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4802,9 +5184,10 @@ so-8859-7.cdef \end_layout \begin_layout Standard -If LyX cannot find a mapping for the string produced by the keystroke or - a deadkey sequence, it will check if it looks like an accented char and - try to draw an accent over the character on screen. +If \SpecialChar LyX + cannot find a mapping for the string produced by the keystroke or a + deadkey sequence, it will check if it looks like an accented char and try + to draw an accent over the character on screen. \end_layout \begin_layout Subsection @@ -4830,7 +5213,7 @@ Suppose you happen to need the circumflex character, . You could bind the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4844,7 +5227,7 @@ status collapsed \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4853,7 +5236,8 @@ Shift-6 \end_inset -] to the LyX command +] to the \SpecialChar LyX + command \begin_inset Flex Code status collapsed @@ -4875,7 +5259,7 @@ lyxrc file. Now, whenever you type the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4891,7 +5275,7 @@ status collapsed \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4918,7 +5302,7 @@ status collapsed \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4931,12 +5315,13 @@ status collapsed \begin_inset Quotes erd \end_inset -, however, LyX will complain with a beep, since a +, however, \SpecialChar LyX + will complain with a beep, since a \begin_inset Quotes eld \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4951,7 +5336,7 @@ t never takes a circumflex accent. Hitting -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4964,7 +5349,7 @@ Space Please note this last point! If you bind a key to a dead-key, you'll need to rebind the character on that key to yet another key. Binding the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4978,7 +5363,7 @@ status collapsed \begin_layout Standard One common way to bind dead-keys is to use -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4988,7 +5373,7 @@ Meta- \end_inset , -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -4998,7 +5383,7 @@ Ctrl- \end_inset , and -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5012,7 +5397,7 @@ Shift- \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5030,7 +5415,7 @@ status collapsed \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5048,7 +5433,7 @@ status collapsed \end_inset -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5104,7 +5489,7 @@ Mode_Switch \end_inset acts in some ways just like -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5125,7 +5510,8 @@ usldead_cedilla \end_inset - and then binding this symbolic key to the corresponding LyX command. + and then binding this symbolic key to the corresponding \SpecialChar LyX + command. \begin_inset Foot status collapsed @@ -5156,7 +5542,7 @@ status collapsed files. I have my -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5198,7 +5584,7 @@ usldead_* \end_inset symbolic keys bound such things as -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5212,7 +5598,7 @@ Lock-^ \end_inset and -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5242,7 +5628,7 @@ Mode_Switch \end_inset key: One of the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -5252,7 +5638,8 @@ Ctrl- \end_inset keys, a spare function key, etc. - As for the LyX commands that produce accents, check the entry for + As for the \SpecialChar LyX + commands that produce accents, check the entry for \begin_inset Flex Code status collapsed @@ -5276,12 +5663,13 @@ Saving your Language Configuration \begin_layout Standard You can edit your preferences so that your desired language environment - is automatically configured when LyX starts up, via the -\begin_inset Flex MenuItem + is automatically configured when \SpecialChar LyX + starts up, via the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Edit\SpecialChar \menuseparator +Edit\SpecialChar menuseparator Preferences \end_layout @@ -5299,7 +5687,7 @@ name "cha:Installing-New-Document" \end_inset -\begin_inset Argument +\begin_inset Argument 1 status collapsed \begin_layout Plain Layout @@ -5313,17 +5701,25 @@ Installing New Document Classes \begin_layout Standard In this chapter, we describe the procedures for creating and installing - new LyX layout and template files, as well as offer a refresher on correctly - installing new LaTeX document classes. + new \SpecialChar LyX + layout and template files, as well as offer a refresher on correctly + installing new \SpecialChar LaTeX + document classes. \end_layout \begin_layout Standard First, let us a say a few words about how one ought to think about the relation - between LyX and LaTeX. - The thing to understand is that, in a certain sense, LyX doesn't know anything - about LaTeX. - Indeed, from LyX's point of view, LaTeX is just one of several + between \SpecialChar LyX + and \SpecialChar LaTeX +. + The thing to understand is that, in a certain sense, \SpecialChar LyX + doesn't know anything + about \SpecialChar LaTeX +. + Indeed, from \SpecialChar LyX +'s point of view, \SpecialChar LaTeX + is just one of several \begin_inset Quotes eld \end_inset @@ -5333,9 +5729,11 @@ backend formats in which it is capable of producing output. Other such formats are DocBook, plaintext, and XHTML. - LaTeX is, of course, a particularly important format, but very little of - the information LyX has about LaTeX is actually contained in the program - itself. + \SpecialChar LaTeX + is, of course, a particularly important format, but very little of the + information \SpecialChar LyX + has about \SpecialChar LaTeX + is actually contained in the program itself. \begin_inset Foot status collapsed @@ -5348,7 +5746,8 @@ hardcoded \begin_inset Quotes erd \end_inset - into LyX. + into \SpecialChar LyX +. But the developers generally regard this as a Bad Thing. \end_layout @@ -5365,16 +5764,20 @@ article.cls \end_inset , is contained in `layout files'. - Similarly, LyX itself does not know much about DocBook or XHTML. + Similarly, \SpecialChar LyX + itself does not know much about DocBook or XHTML. What it knows is contained in layout files. \end_layout \begin_layout Standard You can think of the layout file for a given document class as a translation - manual between LyX constructs---paragraphs with their corresponding styles, - certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or - XHTML constructs. - Almost everything LyX knows about + manual between \SpecialChar LyX + constructs—paragraphs with their corresponding styles, + certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX +, DocBook, or XHTML + constructs. + Almost everything \SpecialChar LyX + knows about \begin_inset Flex Code status collapsed @@ -5438,9 +5841,11 @@ stdsections.inc \end_inset - tells LyX how paragraphs that are marked with the Section, Subsection, - etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML - commands and tags. + tells \SpecialChar LyX + how paragraphs that are marked with the Section, Subsection, etc, + styles can be translated into corresponding \SpecialChar LaTeX +, DocBook, and XHTML commands + and tags. The \begin_inset Flex Code status collapsed @@ -5465,38 +5870,54 @@ std*.inc \end_layout \begin_layout Standard -Defining the LyX--LaTeX correspondence is not the only thing layout files - do, though. - Their other job is to define how the LyX constructs themselves will appear +Defining the \SpecialChar LyX +–\SpecialChar LaTeX + correspondence is not the only thing layout files do, though. + Their other job is to define how the \SpecialChar LyX + constructs themselves will appear on-screen. The fact that layout files have these two jobs is often a source of confusion, because they are completely separate. - Telling LyX how to translate a certain paragraph style into LaTeX does - not tell LyX how to display it; conversely, telling LyX how to display - a certain paragraph style does not tell LyX how to translate it into LaTeX - (let alone tell LaTeX how to display it). - So, in general, when you define a new LyX construct, you must always do - two quite separate things: (i) + Telling \SpecialChar LyX + how to translate a certain paragraph style into \SpecialChar LaTeX + does not tell + \SpecialChar LyX + how to display it; conversely, telling \SpecialChar LyX + how to display a certain paragraph + style does not tell \SpecialChar LyX + how to translate it into \SpecialChar LaTeX + (let alone tell \SpecialChar LaTeX + how to + display it). + So, in general, when you define a new \SpecialChar LyX + construct, you must always do two + quite separate things: (i) \begin_inset space ~ \end_inset -tell LyX how to translate it into LaTeX and (ii) +tell \SpecialChar LyX + how to translate it into \SpecialChar LaTeX + and (ii) \begin_inset space ~ \end_inset -tell LyX how to display it. +tell \SpecialChar LyX + how to display it. \end_layout \begin_layout Standard -Much the same is true, of course, as regards LyX's other backend formats, - though XHTML is in some ways different, because in that case LyX +Much the same is true, of course, as regards \SpecialChar LyX +'s other backend formats, though + XHTML is in some ways different, because in that case \SpecialChar LyX + \emph on is \emph default able, to some extent, to use information about how it should display a paragraph on the screen to output information (in the form of CSS) about how the paragraph should be displayed in a browser. - Even in this case, however, the distinction between what LyX does internally + Even in this case, however, the distinction between what \SpecialChar LyX + does internally and how things are rendered externally remains in force, and the two can be controlled separately. See @@ -5510,17 +5931,25 @@ reference "sec:Tags-for-XHTML" \end_layout \begin_layout Section -Installing new LaTeX files +Installing new \SpecialChar LaTeX + files \end_layout \begin_layout Standard -Some installations may not include a LaTeX package or class file that you - would like to use within LyX. - For example, you might need FoilTeX, a package for preparing slides for - overhead projectors. - Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide - a user interface for installing such packages. - For example, with MiKTeX, you start the program +Some installations may not include a \SpecialChar LaTeX + package or class file that you would + like to use within \SpecialChar LyX +. + For example, you might need Foil\SpecialChar TeX +, a package for preparing slides for overhead + projectors. + Modern \SpecialChar LaTeX + distributions like \SpecialChar TeX +Live (2008 or newer) or MiK\SpecialChar TeX + provide a user interface + for installing such packages. + For example, with MiK\SpecialChar TeX +, you start the program \begin_inset Quotes eld \end_inset @@ -5538,9 +5967,10 @@ Manager \end_layout \begin_layout Standard -If your LaTeX distribution does not provide such a `package manager', or - if the package is not available from your distribution, then follow these - steps to install it manually: +If your \SpecialChar LaTeX + distribution does not provide such a `package manager', or if the + package is not available from your distribution, then follow these steps + to install it manually: \end_layout \begin_layout Enumerate @@ -5574,8 +6004,9 @@ status collapsed \begin_inset Quotes erd \end_inset - (is the case for FoilTeX) then open a console, change to the folder of - this file and execute the command + (is the case for Foil\SpecialChar TeX +) then open a console, change to the folder of this + file and execute the command \begin_inset Flex Code status collapsed @@ -5587,19 +6018,26 @@ latex foiltex.ins . You have now unpacked the package and have all files to install it. - Most LaTeX-packages are not packed and you can skip this step. + Most \SpecialChar LaTeX +-packages are not packed and you can skip this step. \end_layout \begin_layout Enumerate Now you need to decide if the package should be available for all users or only for you. +\begin_inset Separator latexpar +\end_inset + + \end_layout \begin_deeper \begin_layout Enumerate On *nix systems (Linux, OSX, etc.), if you want the new package to be available - for all users on your system, then install it in your `local' TeX tree, - otherwise install it in your own `user' TeX tree. + for all users on your system, then install it in your `local' \SpecialChar TeX + tree, otherwise + install it in your own `user' \SpecialChar TeX + tree. Where these trees should be created, if they do not already exist, depends on your system. To find this out, look in the file @@ -5642,7 +6080,8 @@ kpsewhich texmf.cnf \end_inset - The location of the `local' TeX tree is defined by the + The location of the `local' \SpecialChar TeX + tree is defined by the \begin_inset Flex Code status collapsed @@ -5662,8 +6101,11 @@ status collapsed \end_inset -. - The location of the `user' TeX tree is defined by + or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX +Live + distribution. + The location of the `user' \SpecialChar TeX + tree is defined by \begin_inset Flex Code status collapsed @@ -5681,6 +6123,19 @@ status collapsed $HOME/texmf \end_layout +\end_inset + + or +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout + +\family sans +\lang french +$HOME/.texliveXXXX +\end_layout + \end_inset . @@ -5698,8 +6153,9 @@ In general, it is recommended to install in the user tree because your user \begin_layout Enumerate On Windows, if you want the new package to be available for all users on - your system, change to the folder where LaTeX is installed and then change - to the subfolder + your system, change to the folder where \SpecialChar LaTeX + is installed and then change to + the subfolder \begin_inset Flex Code status collapsed @@ -5714,7 +6170,8 @@ latex \end_inset . - (For MiKTeX, this would be by default the folder + (For MiK\SpecialChar TeX +, this would be by default the folder \begin_inset Flex Code status collapsed @@ -5734,7 +6191,7 @@ latex .) \begin_inset Foot -status open +status collapsed \begin_layout Plain Layout Note that this will be the correct path only on English installations. @@ -5777,12 +6234,14 @@ foiltex \end_inset If the package should only available for you or you don't have admin permissions -, do the same, but in the local LaTeX folder. +, do the same, but in the local \SpecialChar LaTeX + folder. E. \begin_inset space \thinspace{} \end_inset -g., for MiKTeX +g., for MiK\SpecialChar TeX + \begin_inset space ~ \end_inset @@ -5885,13 +6344,20 @@ latex \end_deeper \begin_layout Enumerate -Now one only need to tell LaTeX that there are new files. - This depends on the used LaTeX-Distribution: +Now one only need to tell \SpecialChar LaTeX + that there are new files. + This depends on the used \SpecialChar LaTeX +-Distribution: +\begin_inset Separator latexpar +\end_inset + + \end_layout \begin_deeper \begin_layout Enumerate -For TeXLive execute the command +For \SpecialChar TeX +Live execute the command \begin_inset Flex Code status collapsed @@ -5907,7 +6373,8 @@ texhash \end_layout \begin_layout Enumerate -For MiKTeX, if you have installed the package for all users, start the program +For MiK\SpecialChar TeX +, if you have installed the package for all users, start the program \begin_inset Quotes eld \end_inset @@ -5942,21 +6409,24 @@ Settings \end_deeper \begin_layout Enumerate -Finally, you need to tell LyX that there are new packages available. - So, in LyX, use the menu -\begin_inset Flex MenuItem +Finally, you need to tell \SpecialChar LyX + that there are new packages available. + So, in \SpecialChar LyX +, use the menu +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout Tools \family sans -\SpecialChar \menuseparator +\SpecialChar menuseparator Reconfigure \end_layout \end_inset - and then restart LyX. + and then restart \SpecialChar LyX +. \end_layout \begin_layout Standard @@ -5970,29 +6440,18 @@ Slides \begin_inset space ~ \end_inset -(FoilTe -\begin_inset ERT -status collapsed - -\begin_layout Plain Layout - -{} -\end_layout - -\end_inset - -x) +(FoilTex) \end_layout \end_inset will now be available under -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator -Settings\SpecialChar \menuseparator +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator Document Class \end_layout @@ -6003,14 +6462,15 @@ Document Class \end_layout \begin_layout Standard -If you would like to use a LaTeX document class that is not even listed - in the menu -\begin_inset Flex MenuItem +If you would like to use a \SpecialChar LaTeX + document class that is not even listed in the + menu +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator -Settings\SpecialChar \menuseparator +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator Document Class \end_layout @@ -6025,11 +6485,14 @@ Types of layout files \end_layout \begin_layout Standard -This section describes the various sorts of LyX files that contain layout - information. +This section describes the various sorts of \SpecialChar LyX + files that contain layout informati +on. These files describe various paragraph and character styles, determining - how LyX should display them and how they should be translated into LaTeX, - DocBook, XHTML, or whatever output format is being used. + how \SpecialChar LyX + should display them and how they should be translated into \SpecialChar LaTeX +, DocBook, + XHTML, or whatever output format is being used. \end_layout @@ -6037,19 +6500,24 @@ This section describes the various sorts of LyX files that contain layout We shall try to provide a thorough description of the process of writing layout files here. However, there are so many different types of documents supported even - by just LaTeX that we can't hope to cover every different possibility or - problem you might encounter. - The LyX users' list is frequented by people with lots of experience with - layout design who are willing to share what they've learned, so please - feel free to ask questions there. + by just \SpecialChar LaTeX + that we can't hope to cover every different possibility or problem + you might encounter. + The \SpecialChar LyX + users' list is frequented by people with lots of experience with layout + design who are willing to share what they've learned, so please feel free + to ask questions there. \end_layout \begin_layout Standard As you prepare to write a new layout, it is extremely helpful to look at - the layouts distributed with LyX. - If you write a LyX layout for a LaTeX document class that might also be - used by others, or write a module that might be useful to others, then - you should consider posting your layout to the + the layouts distributed with \SpecialChar LyX +. + If you write a \SpecialChar LyX + layout for a \SpecialChar LaTeX + document class that might also be used by + others, or write a module that might be useful to others, then you should + consider posting your layout to the \begin_inset CommandInset href LatexCommand href name "layout section on the LyX wiki" @@ -6057,14 +6525,17 @@ target "http://wiki.lyx.org/Layouts/Layouts" \end_inset - or even to the LyX developers' list, so that it might be included in LyX + or even to the \SpecialChar LyX + developers' list, so that it might be included in \SpecialChar LyX itself. \begin_inset Foot status collapsed \begin_layout Plain Layout -Note that LyX is licensed under the General Public License, so any material - that is contributed to LyX must be similarly licensed. +Note that \SpecialChar LyX + is licensed under the General Public License, so any material + that is contributed to \SpecialChar LyX + must be similarly licensed. \end_layout \end_inset @@ -6076,7 +6547,7 @@ Note that LyX is licensed under the General Public License, so any material Layout modules \begin_inset CommandInset label LatexCommand label -name "sub:Layout-modules" +name "subsec:Layout-modules" \end_inset @@ -6096,9 +6567,10 @@ status collapsed \end_inset - extension and provide LyX with information about document classes. - As of LyX 1.6, however, layout information can also be contained in layout - + extension and provide \SpecialChar LyX + with information about document classes. + Since \SpecialChar LyX + 1.6 layout information can also be contained in layout \emph on modules \emph default @@ -6113,8 +6585,10 @@ status collapsed \end_inset extension. - Modules are to LaTeX packages much as layouts are to LaTeX classes, and - some modules—such as the + Modules are to \SpecialChar LaTeX + packages much as layouts are to \SpecialChar LaTeX + classes, and some modules—such + as the \begin_inset Flex Code status collapsed @@ -6169,11 +6643,11 @@ article.cls requires editing that file. Modules, by contrast, are selected in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator +Document\SpecialChar menuseparator Settings \end_layout @@ -6200,15 +6674,16 @@ layouts/ \end_inset - folder, you will need to reconfigure and then restart LyX for the module - to appear in the menu. + folder, you will need to reconfigure and then restart \SpecialChar LyX + for the module to + appear in the menu. However, changes you make to the module will be seen immediately, if you open -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator +Document\SpecialChar menuseparator Settings \end_layout @@ -6234,7 +6709,8 @@ it is strongly recommended that you not attempt to edit modules while simultaneo usly working on actual documents \emph default . - Though of course the developers strive to keep LyX stable in such situations, + Though of course the developers strive to keep \SpecialChar LyX + stable in such situations, syntax errors and the like in your module file could cause strange behavior. \end_layout @@ -6243,11 +6719,14 @@ Local Layout \end_layout \begin_layout Standard -Modules are to LyX as packages are to LaTeX. +Modules are to \SpecialChar LyX + as packages are to \SpecialChar LaTeX +. Sometimes, however, you find yourself wanting a specific inset or character style just for one document and writing a module that will also be available to other documents makes little sense. - What you need is LyX's + What you need is \SpecialChar LyX +'s \begin_inset Quotes eld \end_inset @@ -6261,8 +6740,8 @@ Local Layout \begin_layout Standard You will find it under \family sans -Document\SpecialChar \menuseparator -Settings\SpecialChar \menuseparator +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator Local Layout \family default . @@ -6283,13 +6762,17 @@ Format tag. Any format is acceptable, but one would normally use the format current at the time. - (In LyX 2.0, the current layout format is 35.) You should be aware that local - layout is not supported by versions of LyX prior to 1.6, so you should not - use it if you want to be able to export your document to LyX 1.5 or earlier + (In \SpecialChar LyX + 2.1, the current layout format is 48.) You should be aware that local + layout is not supported by versions of \SpecialChar LyX + prior to 1.6, so you should not + use it if you want to be able to export your document to \SpecialChar LyX + 1.5 or earlier (without, that is, losing the local layout information). - If you wish to be able to export to 1.6---local layout is supported in 1.6, - though there is no UI for it---then you should use format 11 and, of course, - use only layout constructs that were available in LyX 1.6. + If you wish to be able to export to 1.6—local layout is supported in 1.6, + though there is no UI for it—then you should use format 11 and, of course, + use only layout constructs that were available in \SpecialChar LyX + 1.6. \end_layout \begin_layout Standard @@ -6303,7 +6786,8 @@ Local Layout \end_inset - pane, LyX will enable the + pane, \SpecialChar LyX + will enable the \begin_inset Quotes eld \end_inset @@ -6312,12 +6796,14 @@ Validate \end_inset button at the bottom. - Clicking this button will cause LyX to determine whether what you have - entered is valid layout information for the chosen format. - LyX will report the result but, unfortunately, will not tell you what errors + Clicking this button will cause \SpecialChar LyX + to determine whether what you have entered + is valid layout information for the chosen format. + \SpecialChar LyX + will report the result but, unfortunately, will not tell you what errors there might have been. - These will be written to the terminal, however, if LyX is started from - a terminal. + These will be written to the terminal, however, if \SpecialChar LyX + is started from a terminal. You will not be permitted to save your local layout until you have entered something valid. \end_layout @@ -6332,7 +6818,7 @@ The warnings at the end of the previous section apply here, too. \begin_layout Subsection Layout for -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6346,7 +6832,8 @@ status collapsed \begin_layout Standard There are two situations you are likely to encounter when wanting to support - a new LaTeX document class, involving style ( + a new \SpecialChar LaTeX + document class, involving style ( \begin_inset Flex Code status collapsed @@ -6356,7 +6843,8 @@ status collapsed \end_inset -) files and LaTeX2e class ( +) files and \SpecialChar LaTeX2e + class ( \begin_inset Flex Code status collapsed @@ -6380,7 +6868,7 @@ The easier case is the one in which your new document class is provided document class. For the sake of the example, we'll assume that the style file is called -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6390,7 +6878,7 @@ myclass.sty \end_inset and that it is meant to be used with -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6410,7 +6898,8 @@ status collapsed \begin_layout Plain Layout Of course, which directory is your local directory will vary by platform, - and LyX allows you to specify your local directory on startup, too, using + and \SpecialChar LyX + allows you to specify your local directory on startup, too, using the \begin_inset Flex Code status collapsed @@ -6450,7 +6939,8 @@ myclass.layout \begin_layout LyX-Code \backslash -DeclareLaTeXClass{report} +Declare\SpecialChar LaTeX +Class{report} \end_layout \begin_layout Standard @@ -6460,7 +6950,8 @@ to read \begin_layout LyX-Code \backslash -DeclareLaTeXClass[report, myclass.sty]{report (myclass)} +Declare\SpecialChar LaTeX +Class[report, myclass.sty]{report (myclass)} \end_layout \begin_layout Standard @@ -6486,21 +6977,23 @@ near the top of the file. \end_layout \begin_layout Standard -Start LyX and select -\begin_inset Flex MenuItem +Start \SpecialChar LyX + and select +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Reconfigure \end_layout \end_inset . - Then restart LyX and try creating a new document. + Then restart \SpecialChar LyX + and try creating a new document. You should see " -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6510,11 +7003,11 @@ report (myclass) \end_inset " as a document class option in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator +Document\SpecialChar menuseparator Settings \end_layout @@ -6613,7 +7106,7 @@ reference "sec:TextClass" \begin_layout Standard If -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6651,7 +7144,7 @@ DeclareLyXModule{My Package} \end_layout \begin_layout LyX-Code -Format 21 +Format 35 \begin_inset Newline newline \end_inset @@ -6687,7 +7180,7 @@ reference "sec:TextClass" \begin_layout Subsection Layout for -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6703,7 +7196,7 @@ status collapsed There are two possibilities here. One is that the class file is itself based upon an existing document class. For example, many thesis classes are based upon -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6730,7 +7223,8 @@ in the file. status collapsed \begin_layout Plain Layout -DeclareLaTeXClass +Declare\SpecialChar LaTeX +Class \end_layout \end_inset @@ -6771,7 +7265,8 @@ thesis.layout \end_inset -: LyX assumes that the document class has the same name as the layout file. +: \SpecialChar LyX + assumes that the document class has the same name as the layout file. \end_layout @@ -6783,7 +7278,8 @@ thesis.layout \begin_layout LyX-Code \backslash -DeclareLaTeXClass[thesis,book]{thesis} +Declare\SpecialChar LaTeX +Class[thesis,book]{thesis} \end_layout \begin_layout Standard @@ -6798,7 +7294,8 @@ roll your own layout. We strongly suggest copying an existing layout file which uses a similar - LaTeX class and then modifying it, if you can do so. + \SpecialChar LaTeX + class and then modifying it, if you can do so. At least use an existing file as a starting point so you can find out what items you need to worry about. Again, the specifics are covered below. @@ -6808,7 +7305,7 @@ roll your own Creating templates \begin_inset CommandInset label LatexCommand label -name "sub:Creating-Templates" +name "subsec:Creating-Templates" \end_inset @@ -6824,11 +7321,13 @@ template for it, too. A template acts as a kind of tutorial for your layout, showing how it might be used, though containing dummy content. - You can of course look at the various templates included with LyX for ideas. + You can of course look at the various templates included with \SpecialChar LyX + for ideas. \end_layout \begin_layout Standard -Templates are created just like usual documents: using LyX. +Templates are created just like usual documents: using \SpecialChar LyX +. The only difference is that usual documents contain all possible settings, including the font scheme and the paper size. Usually a user doesn't want a template to overwrite his preferred settings @@ -6858,7 +7357,8 @@ papersize \end_inset - from the template LyX file. + from the template \SpecialChar LyX + file. This can be done with any simple text-editor, for example \begin_inset Flex Code status collapsed @@ -6880,7 +7380,6 @@ notepad \end_inset . - \end_layout \begin_layout Standard @@ -6905,12 +7404,12 @@ LyXDir/templates/ \end_inset to the same place, and redefine the template path in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator -Preferences\SpecialChar \menuseparator +Tools\SpecialChar menuseparator +Preferences\SpecialChar menuseparator Paths \end_layout @@ -6933,20 +7432,21 @@ defaults.lyx . This template is loaded every time you create a new document with -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -File\SpecialChar \menuseparator +File\SpecialChar menuseparator New \end_layout \end_inset in order to provide useful defaults. - To create this template from inside LyX, all you have to do is to open - a document with the correct settings, and use the -\begin_inset Flex MenuItem + To create this template from inside \SpecialChar LyX +, all you have to do is to open a document + with the correct settings, and use the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -6963,10 +7463,12 @@ Upgrading old layout files \end_layout \begin_layout Standard -The format of layout files changes with each LyX release, so old layout - files need to be converted to the new format. - This process has been automated since LyX 1.4: If LyX reads a layout file - in an older format, it automatically calls the script +The format of layout files changes with each \SpecialChar LyX + release, so old layout files + need to be converted to the new format. + If \SpecialChar LyX + reads a layout file in an older format, it automatically calls the + script \begin_inset Flex Code status collapsed @@ -6979,20 +7481,55 @@ layout2layout.py to convert it to a temporary file in current format. The original file is left untouched. If you use the layout file often, then, you may want to convert it permanently, - so that LyX does not have to do so itself every time. + so that \SpecialChar LyX + does not have to do so itself every time. To do this, you can call the converter manually: \end_layout -\begin_layout LyX-Code -mv myclass.layout myclass.old +\begin_layout Enumerate +rename the file +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +myclass.layout \end_layout -\begin_layout LyX-Code +\end_inset + + to +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +myclass.old +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Enumerate +Call the command +\begin_inset Newline newline +\end_inset + + +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout python LyXDir/scripts/layout2layout.py myclass.old myclass.layout \end_layout -\begin_layout Standard -You need to replace +\end_inset + + +\begin_inset Newline newline +\end_inset + +where \begin_inset Flex Code status collapsed @@ -7002,7 +7539,8 @@ LyXDir \end_inset - with the name of your LyX system directory, of course. + is the name of your \SpecialChar LyX + system directory. \end_layout \begin_layout Standard @@ -7021,14 +7559,13 @@ The layout file format \end_layout \begin_layout Standard -When it's finally time to get your hands dirty and create or edit your own - layout file, the following sections describe what you're up against. - Our advice is to go slowly, save and test often, listen to soothing music, - and enjoy one or two of your favorite adult beverages; more if you are - getting particularly stuck. - It's really not that hard, except that the multitude of options can become - overwhelming if you try to do too much in one sitting. - Go have another adult beverage, just for good measure. +The following sections describe how layout files are structured and written. + Our advice is to go slowly, save and test often. + It is really not that hard, except that the multitude of options can become + overwhelming, especially if you try to check out too many at once. + It becomes easier if you use existing layouts of \SpecialChar LyX + as examples/reference + or if you modify an existing layout to your needs. \end_layout \begin_layout Standard @@ -7064,9 +7601,8 @@ StYlE \end_inset are really the same tag. - The possible values are printed in brackets after the feature's name. - The default value if a feature isn't specified inside a text class-description - is typeset + The possible arguments are printed in brackets after the tag's name. + The default argument is typeset \begin_inset Flex Code status collapsed @@ -7111,7 +7647,7 @@ default \end_layout \begin_layout Subsection -The document class declaration +The document class declaration and classification \end_layout \begin_layout Standard @@ -7137,7 +7673,7 @@ status collapsed \end_inset - files should begin with a line like: + files should begin with lines like: \end_layout \begin_layout LyX-Code @@ -7151,12 +7687,22 @@ status collapsed \size small # \backslash -DeclareLaTeXClass{article} +DeclareLaTeXClass{Article (Standard Class)} +\end_layout + +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareCategory{Articles} \end_layout \begin_layout Standard -The second line is used when you (re)configure LyX. - The layout file is read by the LaTeX script +The second and third lines are used when you (re)configure \SpecialChar LyX +. + The layout file is read by the \SpecialChar LaTeX + script \begin_inset Flex Code status collapsed @@ -7177,8 +7723,10 @@ status collapsed \end_inset is ignored. - The first line is just a LaTeX comment, and the second one contains the - declaration of the text class. + The first line is just a \SpecialChar LaTeX + comment, the second one contains the mandatory + declaration of the text class and the third line contains the optional + classification of the class. If these lines appear in a file named \begin_inset Flex Code status collapsed @@ -7199,7 +7747,8 @@ article \end_inset - (the name of the layout file) which uses the LaTeX document class + (the name of the layout file) which uses the \SpecialChar LaTeX + document class \begin_inset Flex Code status collapsed @@ -7214,89 +7763,176 @@ article.cls \begin_inset Quotes eld \end_inset -article +Article (Standard Class) \begin_inset Quotes erd \end_inset that appears above is used as a description of the text class in the -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator +Document\SpecialChar menuseparator Settings \end_layout \end_inset dialog. -\end_layout - -\begin_layout Standard -Let's assume that you wrote your own text class that uses the -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -article.cls -\end_layout - + The category ( +\begin_inset Quotes eld \end_inset - document class, but where you changed the appearance of the section headings. - If you put it in a file -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -myarticle.layout -\end_layout - +Articles +\begin_inset Quotes erd \end_inset -, the header of this file should be: -\end_layout - -\begin_layout LyX-Code - -\size small -#% Do not delete the line below; configure depends on this -\end_layout - -\begin_layout LyX-Code - -\size small -# -\backslash -DeclareLaTeXClass[article]{article (with my own headings)} -\end_layout - -\begin_layout Standard -This declares a text class -\begin_inset Flex Code + in the example) is also used in the +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -myarticle +Document\SpecialChar menuseparator +Settings \end_layout \end_inset -, associated with the LaTeX document class -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -article.cls -\end_layout + dialog: the text classes are grouped by these categories (which are usually + genres, so typical categories are +\begin_inset Quotes eld +\end_inset +Articles +\begin_inset Quotes erd \end_inset - and described as +, \begin_inset Quotes eld \end_inset -article (with my own headings) +Books +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Reports +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Letters +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Presentations +\begin_inset Quotes erd +\end_inset + +, +\begin_inset Quotes eld +\end_inset + +Curricula Vitae +\begin_inset Quotes erd +\end_inset + + etc.). + If no category has been declared, the class will be put in the +\begin_inset Quotes eld +\end_inset + +Uncategorized +\begin_inset Quotes erd +\end_inset + + group. +\end_layout + +\begin_layout Standard +Let's assume that you wrote your own text class that uses the +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +article.cls +\end_layout + +\end_inset + + document class, but where you changed the appearance of the section headings. + If you put it in a file +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +myarticle.layout +\end_layout + +\end_inset + +, the header of this file should be: +\end_layout + +\begin_layout LyX-Code + +\size small +#% Do not delete the line below; configure depends on this +\end_layout + +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareLaTeXClass[article]{Article (with My Own Headings)} +\end_layout + +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareCategory{Articles} +\end_layout + +\begin_layout Standard +This declares a text class +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +myarticle +\end_layout + +\end_inset + +, associated with the \SpecialChar LaTeX + document class +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +article.cls +\end_layout + +\end_inset + + and described as +\begin_inset Quotes eld +\end_inset + +Article (with My Own Headings) \begin_inset Quotes erd \end_inset @@ -7315,7 +7951,15 @@ article (with my own headings) \size small # \backslash -DeclareLaTeXClass[article,foo.sty]{article (with my own headings)} +DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)} +\end_layout + +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareCategory{Articles} \end_layout \begin_layout Standard @@ -7345,7 +7989,15 @@ foo.sty \size small # \backslash -DeclareDocBookClass[article]{SGML (DocBook article)} +DeclareDocBookClass[article]{SGML (DocBook Article)} +\end_layout + +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareCategory{Articles (DocBook)} \end_layout \begin_layout Standard @@ -7365,10 +8017,20 @@ So, to be as explicit as possible, the form of the layout declaration is: DeclareLaTeXClass[class,package.sty]{layout description} \end_layout +\begin_layout LyX-Code + +\size small +# +\backslash +DeclareCategory{category} +\end_layout + \begin_layout Standard -The class need only be specified if the name of the LaTeX class file and - the name of the layout file are different or if there are packages to load. - If the name of the class file is not specified, then LyX will simply assume +The class need only be specified if the name of the \SpecialChar LaTeX + class file and the + name of the layout file are different or if there are packages to load. + If the name of the class file is not specified, then \SpecialChar LyX + will simply assume that it is the same as the name of the layout file. \end_layout @@ -7395,38 +8057,42 @@ UserDir/layouts \end_inset , run -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Tools\SpecialChar \menuseparator +Tools\SpecialChar menuseparator Reconfigure \end_layout \end_inset -, exit LyX and restart. +, exit \SpecialChar LyX + and restart. Then your new text class should be available along with the others. \end_layout \begin_layout Standard Once the layout file is installed, you can edit it and see your changes - without having to reconfigure or to restart LyX. + without having to reconfigure or to restart \SpecialChar LyX +. \begin_inset Foot status collapsed \begin_layout Plain Layout -In versions of LyX prior to 1.6, this was not true. +In versions of \SpecialChar LyX + prior to 1.6, this was not true. As a result, editing layout files was very time consuming, since you had - constantly to restart LyX to see changes. + constantly to restart \SpecialChar LyX + to see changes. \end_layout \end_inset - You can force a reload of the current layout by using the LyX function - -\begin_inset Flex MenuItem + You can force a reload of the current layout by using the \SpecialChar LyX + function +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -7449,7 +8115,7 @@ r. Warning \emph default : -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -7472,14 +8138,17 @@ strongly y working on a document that you care about. Use a test document. Syntax errors and the like in your layout file could cause peculiar behavior. - In particular, such errors could cause LyX to regard the current layout - as invalid and to attempt to switch to some other layout. + In particular, such errors could cause \SpecialChar LyX + to regard the current layout as + invalid and to attempt to switch to some other layout. \begin_inset Foot status collapsed \begin_layout Plain Layout -Really bad syntax errors may even caused LyX to exit. - This is because certain sorts of errors may make LyX unable to read +Really bad syntax errors may even caused \SpecialChar LyX + to exit. + This is because certain sorts of errors may make \SpecialChar LyX + unable to read \emph on any \emph default @@ -7489,8 +8158,10 @@ any \end_inset - The LyX team strives to keep LyX stable in such situations, but safe is - better than sorry. + The \SpecialChar LyX + team strives to keep \SpecialChar LyX + stable in such situations, but safe is better + than sorry. \begin_inset Foot status collapsed @@ -7521,34 +8192,23 @@ DeclareLyXModule[endnotes.sty]{Endnotes} \begin_layout Standard The mandatory argument, in curly brackets, is the name of the module, as it should appear in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator -Settings\SpecialChar \menuseparator +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator Modules \end_layout \end_inset . - The argument in square brackets is optional: It declares any LaTeX packages + The argument in square brackets is optional: It declares any \SpecialChar LaTeX + packages on which the module depends. - Please note that only packages about which LyX knows should be listed in - the square brackets. -\begin_inset Foot -status collapsed - -\begin_layout Plain Layout -The list of such packages is documented only in the source code. -\end_layout - -\end_inset - - LyX will not check for arbitrary packages. It is also possible to use the form -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout @@ -7587,7 +8247,8 @@ The module declaration should then be followed by lines like the following status collapsed \begin_layout Plain Layout -Preferably in English if the module should be published with LyX. +Preferably in English if the module should be published with \SpecialChar LyX +. This description will appear in the list of messages to be translated and will be thus translated with the next interface update. \end_layout @@ -7631,12 +8292,12 @@ theendnotes in TeX code where you \begin_layout Standard The description is used in -\begin_inset Flex MenuItem +\begin_inset Flex Noun status collapsed \begin_layout Plain Layout -Document\SpecialChar \menuseparator -Settings\SpecialChar \menuseparator +Document\SpecialChar menuseparator +Settings\SpecialChar menuseparator Modules \end_layout @@ -7677,11 +8338,7 @@ at least one no \emph default excluded module may be used. - Note that modules are identified here by their -\emph on -filenames -\emph default - without the + Note that modules are identified here by their filenames without the \begin_inset Flex Code status collapsed @@ -7748,26 +8405,47 @@ int \end_inset -] The format of the layout file. +] The format number of the layout file. \end_layout \begin_layout Standard -This tag was introduced with LyX 1.4.0. - Layout files from LyX 1.3.x and earlier don't have an explicit file format - and are considered to be of format 1. - The format for the present version of LyX is format 21. - But each version of LyX is capable of reading earlier versions' layout - files, just as they are capable of reading files produced by earlier versions - of LyX. +This tag was introduced with \SpecialChar LyX + +\begin_inset space ~ +\end_inset + +1.4.0. + Layout files from older \SpecialChar LyX + versions do not have an explicit file format and + are considered to have +\begin_inset Flex Code +status collapsed + +\begin_layout Plain Layout +Format +\begin_inset space ~ +\end_inset + +1 +\end_layout + +\end_inset + +. + The format for the present version of \SpecialChar LyX + is format 59. + But each version of \SpecialChar LyX + is capable of reading earlier versions' layout files, + just as they are capable of reading files produced by earlier versions + of \SpecialChar LyX +. There is, however, no provision for converting to earlier formats. - So LyX 1.6.x will not read layout files in format 21 but only files in format - 11 or earlier. \end_layout \begin_layout Subsection \begin_inset CommandInset label LatexCommand label -name "sub:General-text-class" +name "subsec:General-text-class" \end_inset @@ -7815,7 +8493,7 @@ status collapsed \end_inset - block when this document class is output to XHTML. + block when the document is output to XHTML. Typically, this would be used to output CSS style information, but it can be used for anything that can appear in \begin_inset Flex Code @@ -7854,64 +8532,17 @@ EndPreamble status collapsed \begin_layout Plain Layout -AddToHTMLStyles -\end_layout - -\end_inset - - Adds CSS styling information. - This will either be output in a -\begin_inset Quotes eld -\end_inset - - -\begin_inset Flex Code -status collapsed - -\begin_layout Plain Layout -