X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FIntro.lyx;h=dcbb73719aca624d6c02f5513c223f24c959f10f;hb=2d0941919f3bd77ad2f7032e97e80ca95c878eb5;hp=a5c71d228bfca220ee7be064271338fd525e78de;hpb=2507381b6e9b50cb6f7dca391dc0b04d0a255089;p=lyx.git diff --git a/lib/doc/Intro.lyx b/lib/doc/Intro.lyx index a5c71d228b..dcbb73719a 100644 --- a/lib/doc/Intro.lyx +++ b/lib/doc/Intro.lyx @@ -1,155 +1,242 @@ -#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/ -\lyxformat 245 +#LyX 2.4 created this file. For more info see https://www.lyx.org/ +\lyxformat 614 \begin_document \begin_header -\textclass book +\save_transient_properties true +\origin /systemlyxdir/doc/ +\textclass article +\begin_preamble +% DO NOT ALTER THIS PREAMBLE!!! +% +%This preamble is designed to ensure that the document prints +% out as advertised. If you mess with this preamble, +% parts of the document may not print out as expected. If you +% have problems LaTeXing this file, please contact +% the documentation team +% email: lyx-docs@lists.lyx.org + +% the pages of the TOC is numbered roman +% and a pdf-bookmark for the TOC is added +\pagenumbering{roman} +\let\myTOC\tableofcontents +\renewcommand\tableofcontents{% + \pdfbookmark[1]{\contentsname}{} + \myTOC + \cleardoublepage + \pagenumbering{arabic} } +\end_preamble +\use_default_options false +\maintain_unincluded_children no \language english -\inputencoding default -\fontscheme default +\language_package default +\inputencoding utf8 +\fontencoding auto +\font_roman "palatino" "default" +\font_sans "helvet" "default" +\font_typewriter "courier" "default" +\font_math "auto" "auto" +\font_default_family default +\use_non_tex_fonts false +\font_sc true +\font_roman_osf false +\font_sans_osf false +\font_typewriter_osf false +\font_sf_scale 100 100 +\font_tt_scale 100 100 +\use_microtype false +\use_dash_ligatures false \graphics default -\paperfontsize default +\default_output_format pdf2 +\output_sync 0 +\bibtex_command default +\index_command default +\paperfontsize 12 \spacing single -\papersize default +\use_hyperref true +\pdf_title "Introduction to LyX" +\pdf_author "LyX Team" +\pdf_subject "LyX-documentation Intro" +\pdf_keywords "LyX, documentation" +\pdf_bookmarks true +\pdf_bookmarksnumbered true +\pdf_bookmarksopen true +\pdf_bookmarksopenlevel 2 +\pdf_breaklinks true +\pdf_pdfborder false +\pdf_colorlinks true +\pdf_backref false +\pdf_pdfusetitle false +\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false" +\papersize a4 \use_geometry false -\use_amsmath 0 +\use_package amsmath 1 +\use_package amssymb 1 +\use_package cancel 1 +\use_package esint 1 +\use_package mathdots 1 +\use_package mathtools 1 +\use_package mhchem 1 +\use_package stackrel 1 +\use_package stmaryrd 1 +\use_package undertilde 1 \cite_engine basic +\cite_engine_type default +\biblio_style plain \use_bibtopic false +\use_indices false \paperorientation portrait -\secnumdepth 2 +\suppress_date false +\justification true +\use_refstyle 0 +\use_minted 0 +\use_lineno 0 +\index Index +\shortcut idx +\color #008000 +\end_index +\secnumdepth 3 \tocdepth 2 \paragraph_separation indent -\defskip medskip -\quotes_language english +\paragraph_indentation default +\is_math_indent 0 +\math_numbering_side default +\quotes_style english +\dynamic_quotes 0 \papercolumns 1 -\papersides 2 +\papersides 1 \paperpagestyle default -\tracking_changes false -\output_changes true +\tablestyle default +\tracking_changes true +\output_changes false +\change_bars false +\postpone_fragile_content false +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false +\docbook_table_output 0 +\docbook_mathml_prefix 1 +\author -584632292 "Richard Kimberly Heck" \end_header \begin_body \begin_layout Title -Introduction to LyX +Introduction to \SpecialChar LyX + \end_layout \begin_layout Author -by the LyX Team +by the \SpecialChar LyX + Team \begin_inset Foot status collapsed -\begin_layout Standard -Principal maintainer of this file is -\noun on -John Weiss -\noun default -. - If you have comments or error corrections, please send them to the LyX - Documentation mailing list, . -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -\begin_inset LatexCommand \tableofcontents{} +\begin_layout Plain Layout +\noindent +If you have comments on or corrections to this documentation, + please send them to the \SpecialChar LyX + Documentation mailing list: + +\begin_inset CommandInset href +LatexCommand href +target "lyx-docs@lists.lyx.org" +type "mailto:" +literal "false" \end_inset \end_layout -\begin_layout Chapter -The Philosophy of LyX -\end_layout - -\begin_layout Quote -\begin_inset Quotes eld -\end_inset - -Uncle Cosmo, why do they call this a word processor? -\begin_inset Quotes erd \end_inset \end_layout -\begin_layout Quote -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +\begin_inset CommandInset toc +LatexCommand tableofcontents -It's simple, Skyler. - You've seen what food processors do to food, right? -\begin_inset Quotes erd \end_inset \end_layout -\begin_layout Quote - -\hfill ---- Jeff MacNelly in -\begin_inset Quotes eld -\end_inset - -Shoe -\begin_inset Quotes erd -\end_inset +\begin_layout Section +The Philosophy of \SpecialChar LyX - \end_layout -\begin_layout Section -What is LyX? +\begin_layout Subsection +What is \SpecialChar LyX +? \end_layout \begin_layout Standard -LyX is a document preparation system. - It excels at letting you create complex technical and scientific articles - with mathematics, cross-references, bibliographies, indices, etc. - It is very good at documents of any length in which the usual processing - abilities are required: automatic sectioning and pagination, spellchecking, - and so forth. - It can also be used to write a letter to your mom, though granted, there - are probably simpler programs available for that. - It is definitely not the best tool for creating banners, flyers, or advertiseme -nts (we'll explain why later), though with some effort all these can be - done, too. - Some examples of what it is used for: memos, letters, dissertations and - theses, lecture notes, seminar notebooks, conference proceedings, software - documentation, books (on PostgreSQL, remote sensing, cryptology, fictional - novels, poetry, and even a children's book or two), articles in refereed - scientific journals, scripts for plays and movies, business proposals \SpecialChar \ldots{} - - you get the idea. +\SpecialChar LyX + is a document preparation system. + It excels at letting you create complex technical and scientific articles with mathematics, + cross-references, + bibliographies, + indexes, + etc. + It is very good for working with documents of any length in which the usual processing abilities are required: + automatic sectioning and pagination, + spell checking and so forth. + It can also be used to write a letter to your mom, + though granted, + there are probably simpler programs available for that. + It is definitely not the best tool for creating banners, + flyers, + or advertisements (we'll explain why later), + though with some effort all these can be done, + too. + Here are some examples of what it is used for: + memos, + letters, + dissertations and theses, + lecture notes, + seminar notebooks, + conference proceedings, + software documentation, + books, + articles in refereed scientific journals, + scripts for plays and movies, + business proposals, + presentations \SpecialChar ldots + \end_layout \begin_layout Standard -LyX is a program that provides a modern approach to writing documents with - a computer by using a markup language paradigm, an approach that breaks - with the obsolete tradition of the +\SpecialChar LyX + is a program that provides a modern approach to writing documents with a computer by using a markup language paradigm, + an approach that breaks with the obsolete tradition of the \begin_inset Quotes eld \end_inset -typewriter concept. +typewriter concept \begin_inset Quotes erd \end_inset - It is designed for authors who want professional output quickly with a - minimum of effort without becoming specialists in typesetting. - The job of typesetting is done mostly by the computer, not the author; - with LyX, the author can concentrate on the contents of her writing. +. + It is designed for authors who want professional output quickly with a minimum of effort and without becoming specialists in typesetting. + The job of typesetting is done mostly by the computer, + not the author; + with \SpecialChar LyX +, + the author can concentrate on the contents of his writing. \end_layout \begin_layout Standard -Part of the initial challenge of using LyX comes from the change in thinking - that you, the user, must make. - At one time, all we had for creating documents were typewriters, so we - all learned certain tricks to get around their limitations. - Underlining, which is little more than overstriking with the +Part of the initial challenge of using \SpecialChar LyX + comes from the change in thinking that you, + the user, + must make. + At one time, + all we had for creating documents were typewriters, + so we all learned certain tricks to get around their limitations. + Underlining, + which is little more than overstriking with the \begin_inset Quotes eld \end_inset @@ -157,23 +244,26 @@ _ \begin_inset Quotes erd \end_inset - character, became a way to emphasize text. - You were forced to figure out column sizes and tab stops, and set them, + character, + became a way to emphasize text. + You were forced to figure out column sizes and tab stops, + and set them, before creating a table. The same applied for letters and other right justified text. Hyphenation at the end of a line required a careful eye and a lot of foresight. \end_layout \begin_layout Standard -In other words, we've all been trained to worry about the little details - of which character goes where. - Consequently, almost all word processors have this mentality. +In other words, + we've all been trained to worry about the little details of which character goes where. + Consequently, + almost all word processors have this mentality. They still use tab stops for adding whitespace. - You still need to worry about exactly where on the page something will - appear. - Emphasizing text means changing a font, similar to changing the typewriter - wheel. - This is the underlying philosophy of a WYSIWYG word processor: + You still need to worry about exactly where on the page something will appear. + Emphasizing text means changing a font, + similar to changing the typewriter wheel. + This is the underlying philosophy of a WYSIWYG word processor: + \begin_inset Quotes eld \end_inset @@ -182,7 +272,8 @@ What You See Is What You Get \end_inset . - Unfortunately, that paradigm often results in + Unfortunately, + that paradigm often results in \begin_inset Quotes eld \end_inset @@ -194,24 +285,29 @@ What You See Is All You Get \end_layout \begin_layout Standard -This is where LyX differs from an ordinary word processor. +This is where \SpecialChar LyX + differs from an ordinary word processor. You don't concern yourself with what character goes where. - You tell LyX + You tell \SpecialChar LyX + \emph on what you're doing \emph default - and LyX takes care of the rest, following a set of rules called a + and \SpecialChar LyX + takes care of the rest, + following a set of rules called a \emph on -style. +style \emph default - +. \begin_inset Foot status collapsed -\begin_layout Standard -To be fair, most recent versions of the most popular office suites now have - some sort of style sheets which follow a similar markup method. - However, our experience is that they are still rarely used in practice. +\begin_layout Plain Layout +To be fair, + most recent versions of the most popular office suites now have some sort of style sheets which follow a similar markup method. + However, + our experience is that they are still rarely used in practice. \end_layout \end_inset @@ -221,96 +317,136 @@ To be fair, most recent versions of the most popular office suites now have \begin_layout Standard Suppose you are writing a report. - To begin your report, you want a section called + To begin your report, + you want a section called \begin_inset Quotes eld \end_inset -Introduction\SpecialChar \@. +Introduction\SpecialChar endofsentence \begin_inset Quotes erd \end_inset - So, you go into whatever menu it is in your word processor that changes - font sizes and decide on a new font size. + So, + you go into whatever menu it is in your word processor that changes font sizes and decide on a new font size. Then you turn on bold face. - Then you type, + Then you type, + \begin_inset Quotes eld \end_inset -1.\InsetSpace ~ -\InsetSpace ~ +1. +\begin_inset space ~ +\end_inset + + +\begin_inset space ~ +\end_inset + Introduction \begin_inset Quotes erd \end_inset . - Of course, if you later decide that this section belongs someplace else - in the document, or if you insert a new section before it, you need to - change the numbering for this and all following sections, as well as any - entry in the table of contents. - + Of course, + if you later decide that this section belongs someplace else in the document or if you insert a new section before it, + you need to change the numbering for this and all following sections, + as well as any entry in the table of contents. \end_layout \begin_layout Standard -In LyX, you go to the pull-down on the far left of the button bar and select - +In \SpecialChar LyX +, + you go to the pull-down on the far left of the button bar and select \family sans Section \family default -, and type +, + and type \begin_inset Quotes eld \end_inset -Introduction\SpecialChar \@. - +Introduction \begin_inset Quotes erd \end_inset - +. \end_layout \begin_layout Standard -Yes, that's all. - If you cut and paste the section, it will automatically be renumbered --- +Yes, + that's all. + If you cut and paste the section, + it will automatically be renumbered — everywhere. - And if you enter references to that section correctly (by inserting cross-refer -ence tags), LyX will automatically update them all throughout the file so - that you never, ever type a section number. + And if you enter references to that section correctly (by inserting cross-reference tags), + \SpecialChar LyX + will automatically update them all throughout the file so that you never, + ever type a section number. \end_layout \begin_layout Standard Now let's look at the problem of consistency. - Five days later, you reopen your report and start Section\InsetSpace ~ + Five days later, + you reopen your report and start Section +\begin_inset space ~ +\end_inset + 4. - However, you forget that you were using 18pt bold instead of 16pt, so you - type in the heading for Section\InsetSpace ~ -4 in a different font that what you used - for Section\InsetSpace ~ + However, + you forget that you were using 18 +\begin_inset space \thinspace{} +\end_inset + +pt bold instead of 16 +\begin_inset space \thinspace{} +\end_inset + +pt, + so you type in the heading for Section +\begin_inset space ~ +\end_inset + +4 in a different font from the one you used for Section +\begin_inset space ~ +\end_inset + 1. - That problem doesn't even exist in LyX. - The computer takes care of all that silly bookkeeping about which thing - has what size font, not you. - After all, that's what a computer is good at. + That problem doesn't even exist in \SpecialChar LyX +. + The computer takes care of all that silly bookkeeping about which thing has what size font, + not you. + After all, + that's what a computer is good at. \end_layout \begin_layout Standard Here's another example. Suppose you're making a list. - In other word processors, a list is just a bunch of tab stops and newlines. - You need to figure out where to put the label for each list item, what - that label should be, how many blank lines to put between each item, and - so on. - Under LyX, you have only two concerns: what kind of list is this, and what - do I want to put in it. - That's it. + In other word processors, + a list is just a bunch of tab stops and newlines. + You need to figure out where to put the label for each list item, + what that label should be, + how many blank lines to put between each item, + and so on. + Under \SpecialChar LyX +, + you have only two concerns: + what kind of list is this, + and what do I want to put in it? + That is it. \end_layout \begin_layout Standard -So, the basic idea behind LyX is: specify +So, + the basic idea behind \SpecialChar LyX + is: + specify \emph on what \emph default - you're doing, not + you're doing, + not \emph on how \emph default @@ -323,7 +459,8 @@ What You See Is What You Get, \begin_inset Quotes erd \end_inset - the LyX model is + the \SpecialChar LyX + model is \begin_inset Quotes eld \end_inset @@ -344,50 +481,31 @@ WYSIWYM. \end_inset It's a powerful idea that greatly simplifies the mechanics of writing documents. - This is also why LyX isn't so good for creating posters and flyers---in - this case, you + This is also why \SpecialChar LyX + isn't so good for creating posters and flyers. + In this case, + you \emph on do \emph default - want to specify exactly where everything goes, because there are no functional - units like paragraphs, sections, etc. - This doesn't mean LyX is missing some cool function. - It simply means that it isn't the right tool for the job --- you don't - use a screwdriver to drive in nails (unless your screwdriver comes with - a lifetime warranty). -\end_layout - -\begin_layout Section -Differences between LyX and Other Word -\newline -Processors -\begin_inset OptArg -status collapsed - -\begin_layout Standard -LyX and Other Word Processors -\end_layout - -\end_inset - - -\begin_inset Foot -status collapsed - -\begin_layout Standard -No, we're not trying to start (or win) a word processor holy war here. - But we do think it's important to describe LyX's features. - And one of LyX's main features, WYSIWYM, is a fundamentally different concept - than the one that most of people have about word processing. + want to specify exactly where everything goes, + because there are no functional units like paragraphs, + sections, + etc. + This doesn't mean \SpecialChar LyX + is missing some cool function. + It simply means that it isn't the right tool for the job — + you don't use a screwdriver to drive in nails. \end_layout -\end_inset - - +\begin_layout Subsection +Differences between \SpecialChar LyX + and Other Word Processors \end_layout \begin_layout Standard -Here's a list of things you won't find in LyX: +Here's a list of things you won't find in \SpecialChar LyX +: \end_layout \begin_layout Itemize @@ -399,8 +517,15 @@ Tab stops \end_layout \begin_layout Itemize -Extra whitespace (i.e. - hitting +Extra whitespace (e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +hitting \family sans Enter \family default @@ -412,17 +537,24 @@ Space \end_layout \begin_layout Standard -Tab stops, along with a ruler showing you the position of things on the - page, are useless in LyX. - The program worries about where things go on the page, not you. - Extra whitespace is similar; LyX adds them where necessary, depending on - context. +Tab stops, + along with a ruler showing you the position of things on the page, + are useless in \SpecialChar LyX +. + The program worries about where things go on the page, + not you. + Extra whitespace is similar; + \SpecialChar LyX + adds it where necessary, + depending on context. Not being able to type two blank lines in a row will be annoying at first, but it makes more sense once you're thinking in WYSIWYM terms. \end_layout \begin_layout Standard -Here are some things that exist in LyX, but aren't used as you might think: +Here are some things that exist in \SpecialChar LyX +, + but aren't used as you might think: \end_layout \begin_layout Itemize @@ -434,12 +566,22 @@ Page breaks \end_layout \begin_layout Itemize -Line spacing (i.e. - single spaced, double spaced, etc.) +Line spacing (e. +\begin_inset space \thinspace{} +\end_inset + +g. +\begin_inset space \space{} +\end_inset + +single spaced, + double spaced, + etc.) \end_layout \begin_layout Itemize -Whitespace, horizontal and vertical +Whitespace, + horizontal and vertical \end_layout \begin_layout Itemize @@ -447,45 +589,58 @@ Fonts and font sizes \end_layout \begin_layout Itemize -Typefaces (bold, italic, underline, etc.) +Typefaces (bold, + italic, + underline, + etc.) \end_layout \begin_layout Standard -Although they exist in LyX, you generally don't need them. - LyX will take care of these things for you, depending on what you're doing. - Different parts of the document are automatically set in a different typeface - and font size. - Paragraph indenting is context dependent; different types of paragraphs - get indented differently. - Page breaks get handled automatically, as well. - In general, the space between lines, between words, and between paragraphs - is variable, set by LyX. +Although they exist in \SpecialChar LyX +, + you generally don't need them. + \SpecialChar LyX + will take care of these things for you, + depending on what you're doing. + Different parts of the document are automatically set in a different typeface and font size. + Paragraph indenting is context dependent; + different types of paragraphs get indented differently. + Page breaks get handled automatically, + as well. + In general, + the space between lines, + between words, + and between paragraphs is variable, + set by \SpecialChar LyX +. \begin_inset Foot status collapsed -\begin_layout Standard -There are ways to adjust all of these (only some of which require knowledge - of LaTeX), either for a whole document or for a specific location in a - document. +\begin_layout Plain Layout +There are ways to adjust all of these (only some of which require knowledge of \SpecialChar LaTeX +), + either for a whole document or for a specific location in a document. See the \emph on User's Guide \emph default and/or the \emph on -Extended Features +Additional Features \emph default manual for details. \end_layout \end_inset - + \end_layout \begin_layout Standard -Lastly, there are a few areas where we believe LyX (and LaTeX) surpasses - many word processors: +Lastly, + there are a few areas where we believe \SpecialChar LyX + (and \SpecialChar LaTeX +) surpasses many word processors: \end_layout \begin_layout Itemize @@ -509,79 +664,62 @@ Cross-referencing \end_layout \begin_layout Standard -Granted, many modern word processors can handle mathematical symbols, tables, - and hyphenation, and many have moved towards style definitions and the - WYSIWYM concept. - However, they've only recently been able to do so, whereas LyX is built - upon the LaTeX document preparation system. - LaTeX has been around for over 15 years, and +Granted, + many modern word processors can handle mathematical symbols, + tables, + and hyphenation, + and many have moved towards style definitions and the WYSIWYM concept. + However, + they've only recently been able to do so, + whereas \SpecialChar LyX + is built upon the \SpecialChar LaTeX + document preparation system. + \SpecialChar LaTeX + has been around since 1985, + and \emph on works \emph default . \end_layout -\begin_layout Section -What the heck -\emph on -is -\emph default - LaTeX (and why do I care)? +\begin_layout Subsection +What is \SpecialChar LaTeX +? \end_layout \begin_layout Standard -LaTeX is a document preparation system designed by Leslie Lamport in 1985. +\SpecialChar LaTeX + is a document preparation system designed by Leslie Lamport in 1985. \begin_inset Foot status collapsed -\begin_layout Standard +\begin_layout Plain Layout The source for the info in this section is -\begin_inset Quotes eld -\end_inset - - \emph on -A Guide to LaTeX2e +A Guide to \SpecialChar LaTeX2e + \emph default , -\begin_inset Quotes erd -\end_inset - - by Helmut Kopka and Patrick Daly, which has an entry in the bibliography - of the + by Helmut Kopka and Patrick Daly, + which has an entry in the bibliography of the \emph on User's Guide \emph default -\SpecialChar \@. +\SpecialChar endofsentence \end_layout \end_inset - It, in turn, was built up from a typesetting language called TeX, created - by Donald Knuth in 1984. - -\begin_inset Quotes eld -\end_inset - -TeX -\begin_inset Quotes erd -\end_inset - - is pronounced like -\begin_inset Quotes eld -\end_inset - -blech! -\begin_inset Quotes erd -\end_inset - - which is how many people feel about it. - However, most folks don't understand just what TeX is. - TeX takes a sequence of typesetting commands, written in a script in an - ASCII file, and executes them. - It's a bit more complicated than a typewriter, but not nearly as involved - as an actual printing press; however, many of the + It was built up from a typesetting language called \SpecialChar TeX +, + created by Donald Knuth in 1984. + \SpecialChar TeX + takes a sequence of typesetting commands, + written in a script in an ASCII file, + and executes them. + Many of the \begin_inset Quotes eld \end_inset @@ -589,9 +727,15 @@ tricks \begin_inset Quotes erd \end_inset - of the printing trade were modeled by Knuth as computer algorithms and - incorporated into TeX, thus its excellent printed appearance. - In any case, what comes directly out of TeX is the so-called + of the printing trade were modeled by Knuth as computer algorithms and incorporated into \SpecialChar TeX +, + hence its excellent printed appearance. + What comes directly out of \SpecialChar TeX + is the portable document format +\emph on +pdf +\emph default + or the so-called \begin_inset Quotes eld \end_inset @@ -599,75 +743,76 @@ device independent \begin_inset Quotes erd \end_inset - format file, or -\family typewriter -dvi -\family default - for short. - You can then feed the -\family typewriter -dvi -\family default - file to anything that understands -\family typewriter -dvi -\family default -, or converts -\family typewriter + format file +\emph on dvi -\family default - to other formats like PostScript®, PDF, etc. +\emph default +. + The dvi format is often used for previews and can later be converted to other formats like PostScript. \end_layout \begin_layout Standard -If it weren't for one other feature, all TeX would be is a typesetting engine. - However, TeX also allows you to define macros. - This is where the action begins. -\end_layout - -\begin_layout Standard -Most people who use TeX are actually using a macro package which Knuth created - to hide a lot of the typesetting details. - This is what most people think of when they think of TeX\SpecialChar \@. - Ordinary users - don't work with raw TeX, which are the bare-bones typesetting commands. - People creating new macro-packages do that. +\SpecialChar TeX + isn't only a typesetting engine; + it also allows you to define macros. + Most people who use \SpecialChar TeX + are actually using a macro package which Knuth created to hide a lot of the typesetting details. This is where Leslie Lamport enters our story. - He wanted a macro package that was more user-oriented and less typesetter-orien -ted, a set of commands that consistently typeset things like sections or - tables or math formulae in a uniform, consistent fashion with as little - fuss as possible. - This is how LaTeX was born. + He wanted a macro package that was more user- and less typesetter-oriented, + with a set of commands that consistently typeset things like sections, + tables or math formulas in a uniform, + consistent fashion. + This is how \SpecialChar LaTeX + was born. \end_layout \begin_layout Standard -Now, in parallel with the development and growth of LaTeX, other folks were - creating their own custom macro packages for TeX, ones to make slides or - articles for math journals and so on. - Some used the raw TeX facilities to do this, others began modifying LaTeX. - To try and unify this mess, a team of LaTeX-nicians (including Lamport, - of course) began to work on LaTeX2e, the current version of LaTeX, during - the late 1980's. - This new version of LaTeX has commands which provide an easier-to-use interface - to TeX's macro-creating commands (remember TeX?), aid in the use of new - fonts, and so on. - In fact, LaTeX is quite an extensive language in its own right! Users around - the world have been creating their own add-ons for LaTeX beyond the standard - ones. +Now, + in parallel with the development and growth of \SpecialChar LaTeX +, + other folks were creating their own custom macro packages for \SpecialChar TeX +, + ones to make slides or articles for math journals and so on. + Some used the raw \SpecialChar TeX + facilities to do this, + others began modifying \SpecialChar LaTeX +. + To try and unify this mess, + a team of \SpecialChar LaTeX +-nicians began to work on \SpecialChar LaTeX2e +, + the current version of \SpecialChar LaTeX +, + during the late 1980's. + This new version of \SpecialChar LaTeX + has commands which provide an easier-to-use interface to \SpecialChar TeX +'s macro-creating commands, + aid in the use of new fonts, + and so on. + In fact, + \SpecialChar LaTeX + is quite an extensive language in its own right! + Users around the world have been creating their own add-ons for \SpecialChar LaTeX + beyond the standard ones. \end_layout \begin_layout Standard -There are two ways to extend LaTeX: classes and styles. +There are two ways to extend \SpecialChar LaTeX +: + classes and styles. A \emph on class \emph default - is a set of LaTeX (and TeX) macros describing a new type of document, like - a book, or an article. - There are classes for slides, for physics and math journals\SpecialChar \ldots{} - many universities - even have a class for their thesis format! A + is a set of \SpecialChar LaTeX + macros describing a new type of document, + like a book, + or an article. + There are classes for slides, + for physics and math journals\SpecialChar ldots + many universities even have a class for their thesis format. + A \emph on style \emph default @@ -677,328 +822,296 @@ style behavior \emph default that any document can use. - For example, LyX controls page margins and line spacing using two different - LaTeX style-files designed for these purposes. - There are style-files for a whole slew of things: printing labels or envelopes, - changing indentation behavior, adding new fonts, manipulating graphics, - designing fancy page headings, customizing bibliographies, altering the - location and appearance of footnotes, tables, and figures, customizing - lists, et cetera. + For example, + \SpecialChar LyX + controls page margins and line spacing using two different \SpecialChar LaTeX + style-files designed for these purposes. + There are style-files for a whole slew of things: + printing labels or envelopes, + changing indentation behavior, + adding new fonts, + manipulating graphics, + designing fancy page headings, + customizing bibliographies, + altering the location and appearance of footnotes, + tables, + and figures, + customizing lists, + etc. \end_layout \begin_layout Standard -Here's a summary: +Here is a summary: \end_layout -\begin_layout List -\labelwidthstring 00.00.0000 -TeX: Typesetting language with macro capability. +\begin_layout Description +\SpecialChar TeX +: + Typesetting language with macro capability. \end_layout -\begin_layout List -\labelwidthstring 00.00.0000 -LaTeX: Macro package built upon TeX\SpecialChar \@. +\begin_layout Description +\SpecialChar LaTeX +: + Macro package built upon \SpecialChar TeX +\SpecialChar endofsentence \end_layout -\begin_layout List -\labelwidthstring 00.00.0000 -classes: Descriptions of a type of document, using LaTeX\SpecialChar \@. +\begin_layout Description +classes: + Descriptions of types of document used with \SpecialChar LaTeX +\SpecialChar endofsentence \end_layout -\begin_layout List -\labelwidthstring 00.00.0000 -styles: Alters the default behavior of LaTeX in some way. +\begin_layout Description +styles: + Descriptions of the default behavior of particular elements of \SpecialChar LaTeX +. \end_layout -\begin_layout List -\labelwidthstring 00.00.0000 -LyX: Visual, WYSIWYM word-processor that uses LaTeX in all its glory to - do its printing. +\begin_layout Description +\SpecialChar LyX +: + Visual, + WYSIWYM document processor that uses \SpecialChar LaTeX + to do its typesetting. \end_layout \begin_layout Standard -The idea of this section was to try and explain +This section attempts to explain the difference between \SpecialChar LyX + and a word processor. + Simply put, + \SpecialChar LaTeX + is the difference. + By using \SpecialChar LaTeX + as its backend, + \SpecialChar LyX + helps you to think more about \emph on -why + what \emph default - LyX works somewhat differently from other word processors. - The reason is simple: LyX uses LaTeX as its printing backend. - Just like LaTeX, LyX focuses on the context of your writing --- + (as in the \emph on -what +words +\emph default +) you write. + The computer then handles +\emph on +how \emph default - you are typing. - The computer then handles how it should look. + they should look. +\end_layout + +\begin_layout Section +Navigating the Documentation \end_layout \begin_layout Standard -Oh --- one last thing. - LaTeX is pronounced like TeX is. - It rhymes with +To make it easier to answer your questions and describe all of the features of \SpecialChar LyX +, + the documentation has been split up into several different files. + Each one has its own purpose, + as described below. + Before you go ploughing into any of those files, + however, + you should read this chapter thoroughly, + since it contains a lot of useful information and commentary that can save you some time. +\end_layout + +\begin_layout Standard +Hopefully, + the development of \SpecialChar LyX + will never stop; + so some of the documentation may be incomplete or a bit out of date, + though we try to keep up-to-date. + Like the rest of \SpecialChar LyX +, + the manuals are the work of a group of volunteers who have \begin_inset Quotes eld \end_inset -hey blech. +Real Jobs \begin_inset Quotes erd \end_inset +, + families, + dishes to clean, + +\emph on +et cetera +\emph default +. + If you want to help out, + be sure to read Section +\begin_inset space ~ +\end_inset -\begin_inset Foot -status collapsed -\begin_layout Standard -or -\begin_inset Quotes eld -\end_inset +\begin_inset CommandInset ref +LatexCommand ref +reference "sec:Contrib" +nolink "false" -ha blech -\begin_inset Quotes erd \end_inset -, depending on how you pronounce your -\begin_inset Quotes eld -\end_inset + in addition to the rest of this document. +\end_layout + +\begin_layout Standard +Also, + please do us a favor: + if anything in these manuals confuses you, + is unclear, + or wrong, + don't hesitate to let us know! + You can reach the current document maintainers by emailing +\begin_inset CommandInset href +LatexCommand href +target "lyx-docs@lists.lyx.org" +type "mailto:" +literal "false" -a -\begin_inset Quotes erd \end_inset -s\SpecialChar \ldots{} +. + +\change_inserted -584632292 1610248366 \end_layout -\end_inset +\begin_layout Subsection - Usually. - Lamport says in his book, though, that -\begin_inset Quotes eld -\end_inset +\change_inserted -584632292 1610248375 +Where To Get Help +\end_layout +\begin_layout Standard +If you have questions that are not obviously answered in the documentation and need help fast, + there is an active users' mailing list which you can reach at +\begin_inset CommandInset href +LatexCommand href +target "lyx-users@lists.lyx.org" +type "mailto:" +literal "false" -\emph on -lay -\emph default --tecks is also possible -\begin_inset Quotes erd \end_inset . - -\begin_inset Quotes eld -\end_inset -LyX, -\begin_inset Quotes erd -\end_inset +\change_inserted -584632292 1610248524 + You do not have to register to post, + but you may wish to do so. + See +\begin_inset CommandInset href +LatexCommand href +name "the LyX website" +target "https://www.lyx.org/MailingLists" +literal "false" - on the other hand, is pronounced -\begin_inset Quotes eld \end_inset -licks. -\begin_inset Quotes erd -\end_inset + for further information. + LyX also has a +\begin_inset CommandInset href +LatexCommand href +target "http://wiki.lyx.org/" +literal "false" - Or -\begin_inset Quotes eld \end_inset -lucks, -\begin_inset Quotes erd -\end_inset + that will answer many questions about how to get LyX to do various things. +\change_unchanged - or -\begin_inset Quotes eld -\end_inset +\end_layout -looks, -\begin_inset Quotes erd -\end_inset +\begin_layout Subsection +The Format of the Manuals +\end_layout - depending on what country you're from \SpecialChar \ldots{} - but numerous holy wars and flame - fests have been started over this issue on the LyX mailing lists, so please - just pronounce it however you please. - Just don't pronounce it -\begin_inset Quotes eld -\end_inset +\begin_layout Standard +Some of you may have printed out the manuals. + Others may be reading them within \SpecialChar LyX +. + There are some differences between the \SpecialChar LyX +-file and the printed version. + In \SpecialChar LyX +, + the title is simply at the top of the document, + not formatted on a separate page as in some of the printed versions. + Nor are any of the footnotes or the Table of Contents fully visible. + To open a footnote, + which looks like this: + +\begin_inset Graphics + filename clipart/footnote.png + scale 95 -word -\begin_inset Quotes erd \end_inset -. - -\family typewriter -:-) -\end_layout +, + click on it with the left mouse button. + For the Table of Contents, + either click on the grey box or click on the +\family sans +Navigate +\family default + menu, + where the contents are displayed automatically\SpecialChar endofsentence -\begin_layout Chapter -Navigating the Documentation \end_layout \begin_layout Standard -To make it easier to answer your questions and describe all of the features - of LyX, the documentation has been split up into several different files. - Each one has its own purpose, as described below. - Before you go plowing into any of those files, however, you should read - this chapter thoroughly first, since it contains a lot of useful information - and commentary that can save you some time. -\end_layout +In the printed manuals, + all cross-references appear as the actual numbers for a chapter, + section, + subsection, + and so on. + In the \SpecialChar LyX +-file, + however, + all cross-references appear as light-grey boxes like the following: + +\begin_inset Graphics + filename clipart/reference.png + scale 95 -\begin_layout Standard -Although LyX is now well past the -\begin_inset Quotes eld \end_inset -version 1.0 -\begin_inset Quotes erd +. + If you click on such a box with the left mouse button, + a dialog box will appear containing a list of all the cross-references in the document. + You can go to the referenced section by right-clicking on the box or by clicking the button +\family sans +Go +\begin_inset space ~ \end_inset - mark, some of the documentation may be incomplete or a bit out of date, - though we try to keep up. - Like the rest of LyX, the manuals are the work of a group of volunteers - who have -\begin_inset Quotes eld +to +\begin_inset space ~ \end_inset -Real Jobs -\begin_inset Quotes erd -\end_inset - -, families, dishes to clean, kitty litter to dispose of, et cetera. - If you want to help out, be sure to read Section\InsetSpace ~ - -\begin_inset LatexCommand \ref{sec:Contrib} - -\end_inset - - in addition to the rest of this document.) -\end_layout - -\begin_layout Standard -Also, please do us a favor---if anything in these manuals confuses you, - is unclear, or wrong, don't hesitate to let us know! You can reach the - current document maintainers by mailing to -\family typewriter -lyx-docs@lists.lyx.org -\family default -. - If you have questions which are not obviously answered in the documentation, - and need help fast, there is an active users' mailing list which you can - reach at -\family typewriter -lyx-users@lists.lyx.org -\family default -. -\end_layout - -\begin_layout Section -The Format of the Manuals -\end_layout - -\begin_layout Standard -Some of you may have printed out the manual(s). - Others may be reading it online, within LyX as a file. - For those reading online, there are some differences from the printed version. - First, the title is simply at the top of the document, not formatted on - a separate page as in some of the printed versions. - Nor are any of the footnotes or the Table of Contents visible. - To open a footnote, which looks like this, -\begin_inset Foot -status collapsed - -\begin_layout Standard -Hi! -\end_layout - -\begin_layout Standard -To close me, click on the grey box on the top left of this box, the one - with the word -\begin_inset Quotes eld -\end_inset - -foot -\begin_inset Quotes erd -\end_inset - - in it. -\end_layout - -\end_inset - - click on it with the left mouse button. - For the Table of Contents, either click on the grey box, or click on the - -\family sans -\bar under -N -\bar default -avigate +Label \family default - menu, where the contents are displayed automatically\SpecialChar \@. - (Try it!) -\end_layout - -\begin_layout Standard -In the printed manuals, all cross-references appear as the actual numbers - for a chapter, section, subsection, and so on. - Online, however, all cross-references appear as a grey box like the following: - -\begin_inset LatexCommand \ref{sec:Contrib} - -\end_inset - -. - (The printed manuals show a number instead.) If you click on that box with - the left mouse button, a dialog box will appear containing a list of all - the cross-references in the document. - This introduction has only one named -\begin_inset Quotes eld -\end_inset - -sec:Contrib -\begin_inset Quotes erd -\end_inset - -. - You can go to the section the referred to by clicking the button labeled - "Go to reference". + in the opened dialog. Going back to where you came from is just as easy. - Clicking on -\begin_inset Quotes eld -\end_inset - -Go back -\begin_inset Quotes erd -\end_inset - - or typing + Click on \family sans -C-< -\family default - will take you back to your earlier location. - (What does -\begin_inset Quotes eld +Go +\begin_inset space ~ \end_inset - -\family sans -C-< +Back \family default - -\begin_inset Quotes erd -\end_inset - - mean? See below.) + to go back to your earlier location. \end_layout \begin_layout Standard -Now that we've cleared up some of the differences between the printed and - online versions of this file, we can start looking at the format of this - document. +Now that we've cleared up some of the differences between the printed and \SpecialChar LyX +-file versions of this file, + we can start looking at the format of this document. You'll occasionally notice things in different fonts: \end_layout @@ -1007,8 +1120,11 @@ Now that we've cleared up some of the differences between the printed and \emph on Emphasized Style \emph default - is used for general emphasis, generic arguments, book titles, names of - sections of other manuals, and notes from the authors. + is used for general emphasis, + generic arguments, + book titles, + names of sections of other manuals, + and notes from the authors. \end_layout \begin_layout Itemize @@ -1016,7 +1132,9 @@ Emphasized Style \family typewriter Typewriter \family default - is used for program and file names, LaTeX code, and LyX code and functions. + is used for program and file names, + \SpecialChar LyX + code and functions. \end_layout \begin_layout Itemize @@ -1024,8 +1142,10 @@ Typewriter \family sans Sans Serif \family default - is used for menu, button, or dialog box names, and the names of keyboard - keys. + is used for menu, + button, + or dialog box names, + and the names of keyboard keys. \end_layout \begin_layout Itemize @@ -1036,31 +1156,18 @@ Noun Style is used for people's names. \end_layout -\begin_layout Standard -For menu accelerator keys and other more obscure keybindings, you'll probably - get referred to the -\emph on -Key Bindings -\emph default - section of the -\begin_inset Quotes eld -\end_inset - - -\emph on -Extended Features Manual -\emph default +\begin_layout Itemize -\begin_inset Quotes erd -\end_inset +\series bold +Bold +\series default + is used for \SpecialChar LaTeX + code +\end_layout - (the file -\family typewriter -Extended.lyx -\family default -). - When we do need to reference keys, we'll use the following prefixing convention -: +\begin_layout Standard +When we do need to reference keys, + we'll use the following prefixing convention: \end_layout \begin_layout Itemize @@ -1069,7 +1176,7 @@ Extended.lyx \family sans -C- +Ctrl+ \family default \begin_inset Quotes erd @@ -1077,7 +1184,7 @@ C- indicates the \family sans -Control- +Control \family default key. \end_layout @@ -1088,7 +1195,7 @@ Control- \family sans -S- +Shift+ \family default \begin_inset Quotes erd @@ -1096,7 +1203,7 @@ S- indicates the \family sans -Shift- +Shift \family default key. \end_layout @@ -1107,7 +1214,7 @@ Shift- \family sans -M- +Alt+ \family default \begin_inset Quotes erd @@ -1115,13 +1222,13 @@ M- indicates the \family sans -Meta- +Alt \family default - key, which on some keyboards will be the + ( \family sans -Alt- +Meta \family default - key. +) key. \end_layout \begin_layout Itemize @@ -1136,7 +1243,7 @@ F1 \begin_inset Quotes erd \end_inset - \SpecialChar \ldots{} + \SpecialChar ldots \begin_inset Quotes eld \end_inset @@ -1215,7 +1322,8 @@ Down \begin_inset Quotes erd \end_inset -: self-explanatory. +: + self-explanatory. \end_layout \begin_layout Itemize @@ -1290,7 +1398,12 @@ PageDown \begin_inset Quotes erd \end_inset -: these are the 6 keys that appear above the cursor keys on many PC keyboards. +: + these are the 6 +\begin_inset space ~ +\end_inset + +keys that appear above the cursor keys on many PC keyboards. \begin_inset Quotes eld \end_inset @@ -1373,7 +1486,9 @@ Enter, \end_inset still others have two keys. - LyX treats all of them as the same key, so we'll use + \SpecialChar LyX + treats all of them as the same key, + so we'll use \family sans Return \family default @@ -1385,235 +1500,707 @@ Enter \end_layout \begin_layout Standard -You'll also see something like -\begin_inset Quotes eld +The list with the currently set shortcuts can be found in the +\family sans +Help +\family default + menu under +\family sans +Shortcuts +\family default +. +\end_layout + +\begin_layout Subsection +Units used in the Manuals +\end_layout + +\begin_layout Standard +To understand the units described in this documentation, + Table +\begin_inset space ~ \end_inset -(See -\emph on -\begin_inset Quotes els +\begin_inset CommandInset ref +LatexCommand ref +reference "tab:Units" +nolink "false" + \end_inset -Extended -\emph default + explains all units available in \SpecialChar LyX +. +\end_layout + +\begin_layout Standard +\begin_inset Float table +placement document +alignment document +wide false +sideways false +status open + +\begin_layout Plain Layout +\begin_inset Caption Standard + +\begin_layout Plain Layout +\begin_inset CommandInset label +LatexCommand label +name "tab:Units" -\begin_inset Quotes ers \end_inset -) -\begin_inset Quotes erd +Units +\end_layout + \end_inset - from time to time. - We've listed the possible default keybindings for a function in its entry - in the -\begin_inset Quotes eld + +\end_layout + +\begin_layout Plain Layout +\begin_inset VSpace medskip \end_inset -\emph on -Extended Features Manual -\emph default -, -\begin_inset Quotes erd +\end_layout + +\begin_layout Plain Layout +\align center +\begin_inset Tabular + + + + + + +\begin_inset Text + +\begin_layout Plain Layout +unit +\end_layout + \end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +name/description +\end_layout - so check there, too. - Note that there are two different keybinding maps in common use in the - LyX community: the -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +mm +\end_layout -CUA -\begin_inset Quotes erd \end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +millimeter +\end_layout - style which is the default and familiar to those coming from the PC world, - and the -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +cm +\end_layout -emacs -\begin_inset Quotes erd \end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +centimeter +\end_layout - style, which is common with those who -\begin_inset Quotes eld \end_inset + + + + +\begin_inset Text -grew up -\begin_inset Quotes erd +\begin_layout Plain Layout +in +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +inch (1 +\begin_inset space \thinspace{} +\end_inset + +in = 2.54 +\begin_inset space \thinspace{} \end_inset - on Unix systems and use the Emacs editor. - Unless specifically noted, the keybindings in the documentation are from - the default CUA map. - If you like Emacs, you should be smart enough to read the documentation - and figure out the bindings on your own. +cm) \end_layout -\begin_layout Section -The Manuals +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +pt \end_layout -\begin_layout Standard -The following list describes the contents of each of the files in the documentat -ion: +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +point (72.27 +\begin_inset space \thinspace{} +\end_inset + +pt = 1 +\begin_inset space \thinspace{} +\end_inset + +in) \end_layout -\begin_layout Description +\end_inset + + + + +\begin_inset Text -\emph on -Introduction +\begin_layout Plain Layout +pc \end_layout -\begin_deeper -\begin_layout Standard -This file. +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +pica (1 +\begin_inset space \thinspace{} +\end_inset + +pc = 12 +\begin_inset space \thinspace{} +\end_inset + +pt) \end_layout -\end_deeper -\begin_layout Description +\end_inset + + + + +\begin_inset Text -\emph on -Tutorial +\begin_layout Plain Layout +sp \end_layout -\begin_deeper -\begin_layout Standard -If you are new to LyX, and have never used LaTeX before, you should start - here. - If you think LaTeX is the stuff they make condoms out of, then you definitely - need to reread Chapter 1, then read the -\emph on -Tutorial -\emph default -. - Note that after you read the -\emph on -Tutorial -\emph default -, you'll probably still think LaTeX is some stretchy substance --- but you - -\emph on -will -\emph default - know how to use LyX. +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +scaled point (65536 +\begin_inset space \thinspace{} +\end_inset + +sp = 1 +\begin_inset space \thinspace{} +\end_inset + +pt) \end_layout -\begin_layout Standard -If you +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +bp +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +big point (72 +\begin_inset space \thinspace{} +\end_inset + +bp = 1 +\begin_inset space \thinspace{} +\end_inset + +in) +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +dd +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +didot (72 +\begin_inset space \thinspace{} +\end_inset + +dd +\begin_inset Formula $\approx$ +\end_inset + + 37.6 +\begin_inset space \thinspace{} +\end_inset + +mm) +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +cc +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +cicero (1 +\begin_inset space \thinspace{} +\end_inset + +cc = 12 +\begin_inset space \thinspace{} +\end_inset + +dd) +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +Scale% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of original image width +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +text% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of text width +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +col% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of column width +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +page% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of paper width +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +line% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of line width +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +theight% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of text height +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +pheight% +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +% of paper height +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +ex +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +height of letter \emph on -have +x \emph default - used LaTeX before, you should still read the + in current font +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +em +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +width of letter \emph on -Tutorial +M \emph default -, starting with the section on -\begin_inset Quotes eld + in current font +\end_layout + \end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +mu +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +math unit (1 +\begin_inset space \thinspace{} +\end_inset + +mu = 1/18 +\begin_inset space \thinspace{} +\end_inset + +em) +\end_layout + +\end_inset + + + + +\end_inset + + +\end_layout -LyX for LaTeX users. -\begin_inset Quotes erd \end_inset - (Skimming the rest of the document wouldn't hurt, either.) + +\end_layout + +\begin_layout Subsection +The Manuals \end_layout \begin_layout Standard -If, at any time, you find yourself feeling a bit clueless with respect to - LyX, try perusing the -\emph on -Tutorial -\emph default - before diving into any of the other manuals. - It's a good springboard. +The following list describes the contents of the basic documentation files that you find in the +\family sans +Help +\family default + menu: \end_layout -\end_deeper \begin_layout Description +Introduction This file. +\end_layout +\begin_layout Description +Tutorial If you are new to \SpecialChar LyX +, + and have never used \SpecialChar LaTeX + before, + you should start here. + If you have used \SpecialChar LaTeX + before, + you should still read the \emph on -User's\InsetSpace ~ -Guide +Tutorial +\emph default +, + starting with the section on +\begin_inset Quotes eld +\end_inset + +\SpecialChar LyX + for \SpecialChar LaTeX + users. +\begin_inset Quotes erd +\end_inset + + (Skimming through the rest of the document wouldn't hurt, + either.) \end_layout -\begin_deeper -\begin_layout Standard -The primary documentation. +\begin_layout Description +User's +\begin_inset space ~ +\end_inset + +Guide The primary documentation. We'll cover \emph on most \emph default - of the basic operation and available features of LyX here. - The main manual assumes that you've read the + of the basic operation and available features of \SpecialChar LyX + here. + The main manual assumes that you have read the \emph on Tutorial \emph default . \end_layout -\end_deeper \begin_layout Description +Embedded +\begin_inset space ~ +\end_inset +Objects Extension of the \emph on -Extended\InsetSpace ~ -Features +User's Guide +\emph default +. + Documents in detail how to use tables, + graphics, + floats, + notes, + program listings and boxes. + It also includes many tricks of the \SpecialChar LaTeX + masters. \end_layout -\begin_deeper -\begin_layout Standard -Extension of the +\begin_layout Description +Math Extension of the \emph on User's Guide \emph default . - Documents how to use raw LaTeX commands, additional layouts, and special-purpos -e editing features, and includes some of the (rather bizarre, but nifty) - tricks of the LaTeX masters. + Documents in detail how to typeset any kind of formula. \end_layout -\end_deeper \begin_layout Description +Additional +\begin_inset space ~ +\end_inset +Features Extension of the \emph on -Customization -\end_layout - -\begin_deeper -\begin_layout Standard -A description of advanced LyX features, including how to customize the overall - behavior of LyX\SpecialChar \@. - This includes such things as keybindings, internationalization, - and configuration files. - Don't even think of going in here until you read the -\emph on -Tutorial +User's Guide \emph default . + Documents how to use raw \SpecialChar LaTeX + commands, + additional layouts and special-purpose editing features. \end_layout -\end_deeper \begin_layout Description +Customization A description of advanced \SpecialChar LyX + features, + including how to customize the overall behavior of \SpecialChar LyX +\SpecialChar endofsentence + This includes such things as keybindings, + internationalization and configuration files. + It also includes information about layout files, + which are needed to get \SpecialChar LyX + to support \SpecialChar LaTeX + classes or packages. +\end_layout -\emph on -LaTeX\InsetSpace ~ -configuration +\begin_layout Description +Shortcuts Tables of the currently defined \SpecialChar LyX + shortcuts. \end_layout -\begin_deeper -\begin_layout Standard -LyX investigates your system upon installation. - This file contains info on what LyX learned about your installation. +\begin_layout Description +\SpecialChar LaTeX + +\begin_inset space ~ +\end_inset + +Configuration A report produced by \SpecialChar LyX + about your system. + This file contains information on what \SpecialChar LyX + learned about your installation. Check it to see if you're missing something you might like to have. \end_layout -\end_deeper \begin_layout Standard These files will reference one another as necessary. - For example, the + For example, + the \emph on User's Guide \emph default @@ -1621,8 +2208,8 @@ User's Guide \emph on some \emph default - information on installation and customization, but refers the reader to - the + information on installation and customization, + but refers the reader to the \emph on Customization Manual \emph default @@ -1642,12 +2229,14 @@ We'll state again an important point: \begin_layout Standard \align center -If you are new to LyX, read the +If you are new to \SpecialChar LyX +, + read the \emph on Tutorial \emph default . - Now\SpecialChar \@. + Now\SpecialChar endofsentence \end_layout @@ -1659,264 +2248,200 @@ Tutorial \end_layout \begin_layout Standard -Otherwise, you could needlessly frustrate yourself. - LyX does all that you need a word processor to do, but using a different - approach. +Otherwise, + you could needlessly frustrate yourself. \end_layout -\begin_layout Chapter -\begin_inset LatexCommand \label{sec:Contrib} +\begin_layout Section +Contributing to the \SpecialChar LyX + Project +\begin_inset CommandInset label +LatexCommand label +name "sec:Contrib" \end_inset -Contributing to the LyX Project + \end_layout -\begin_layout Section -Contributing to LyX +\begin_layout Subsection +Contributing to \SpecialChar LyX + \end_layout \begin_layout Standard -LyX is mostly written in C++ (the LaTeX importer is written in Perl). - It is a large project, and as a result it is not free from bugs, or the - need for improvements in the source code. +\SpecialChar LyX + is mostly written in C++ (the \SpecialChar LaTeX + importer is written in Python). + It is a large project, + and as a result it is not free from bugs, + or the need for improvements in the source code. \end_layout -\begin_layout Subsection +\begin_layout Subsubsection Reporting a bug \end_layout \begin_layout Standard -While using LyX, you may find behaviour which you consider a bug. - Crashes, though rare, can happen. - User interface problems are considered major bugs by the LyX team: especially - helpful are indications of parts of the LyX interface you find confusing, +While using \SpecialChar LyX +, + you may find behavior which you consider a bug. + Crashes, + though rare, + can happen. + User interface problems are considered major bugs by the \SpecialChar LyX + team: + especially helpful are indications of parts of the \SpecialChar LyX + interface you find confusing, or unclear. \end_layout \begin_layout Standard -LyX has a bug tracking system, which you can find at -\family typewriter - -\begin_inset LatexCommand \htmlurl[LyX bug tracker]{http://bugzilla.lyx.org/} - +\SpecialChar LyX + has a bug tracking system, + which you can find at +\begin_inset Newline newline \end_inset -\family default -. - You should check the bug tracker before reporting any bugs, in case it - has already been reported. - If you have a comment on an existing bug, or wish to report a new bug, - you may either use the bug tracker, or send an e-mail to the development - mailing list, -\family typewriter -lyx-devel@lists.lyx.org -\family default -. - Archives of this list are linked from the main LyX website, -\family typewriter - -\begin_inset LatexCommand \htmlurl[LyX website]{http://www.lyx.org/} +\begin_inset CommandInset href +LatexCommand href +target "https://www.lyx.org/trac/wiki/BugTrackerHome" \end_inset - -\family default . -\end_layout - -\begin_layout Standard -A good (useful) bug report will at a minimum include the version of LyX - you are having the problem with. - Accurate, detailed descriptions are preferred - the more time developers - have to spend to pinpoint the source of a bug, the less time they have - for other improvements. - Mention the system and system version you are running LyX with. - Give the versions of the libraries you have installed on your system, and, - if relevant, the versions of external programs that LyX uses. - If it's a compilation or configuration problem, include the file -\family typewriter -config.log -\family default -, and mention which compiler you are using. + You should check the bug tracker before reporting any bugs, + in case it has already been reported. + If you have a comment on an existing bug, + or wish to report a new bug, + you may either use the bug tracker, + or send an e-mail to the development mailing list, -\end_layout - -\begin_layout Standard -If you can make LyX crash, please take the time to produce a backtrace with - a non-stripped lyx executable. - The one built in the source directory is per default not stripped, while - the installed binary is stripped. - So, run LyX from gdb by typing, for example, -\begin_inset Quotes eld -\end_inset - - -\family typewriter -\size small -gdb /users/steve/lyx-1.0.x/src/lyx -\family default -\size default - -\begin_inset Quotes erd -\end_inset - - and then -\begin_inset Quotes eld -\end_inset - - -\family typewriter -\size small -run -\family default -\size default +\begin_inset CommandInset href +LatexCommand href +target "lyx-devel@lists.lyx.org" +type "mailto:" +literal "false" -\begin_inset Quotes erd \end_inset . - Make LyX crash and you'll return to gdb. - Use -\begin_inset Quotes eld -\end_inset - - -\family typewriter -\size small -bt -\family default -\size default + Archives of this list are linked from the main \SpecialChar LyX + website, + +\begin_inset CommandInset href +LatexCommand href +target "http://www.lyx.org" -\begin_inset Quotes erd \end_inset - to produce a backtrace and include the output in the bug report -\begin_inset Foot -status collapsed +. +\end_layout \begin_layout Standard -if you want to be thorough, use the -\begin_inset Quotes eld -\end_inset - - -\family typewriter -info locals -\family default - -\begin_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset - - +A useful bug report will at a minimum include the version of \SpecialChar LyX + you are having the problem with. + Accurate, + detailed descriptions are preferred — + the more time developers have to spend to pinpoint the source of a bug, + the less time they have for other improvements. + Mention the system and system version on which you are running \SpecialChar LyX +. + Give the versions of the libraries you have installed on your system, + and, + if relevant, + the versions of external programs that \SpecialChar LyX + uses. + If it's a compilation or configuration problem, + include the file \family typewriter -up +config.log \family default - -\begin_inset Quotes erd -\end_inset - - commands to print out the values of local variables at a few stack levels. -\end_layout - -\end_inset - -. - If possible, then a description of a way to reproduce the bug is more important - than a backtrace, because then we have the possibility to roll our own - backtrace. - If the bug is not easily reproducible, a backtrace is essential, because - then that might be all we've got. +, + and mention which compiler you are using. \end_layout -\begin_layout Subsection +\begin_layout Subsubsection Contributing fixes and new features \end_layout \begin_layout Standard -If you have made changes to LyX's source that you think should become part - of LyX, send your changes as a diff file (in unified format) to the development - list referenced above, along with a change log, and a description of what - your patch does. +If you have made changes to \SpecialChar LyX +'s source that you think should become part of \SpecialChar LyX +, + send your changes as a diff file (in unified format) to the development list referenced above, + along with a change log, + and a description of what your patch does. \end_layout -\begin_layout Section +\begin_layout Subsection Contributing to the Documentation \end_layout \begin_layout Standard -LyX's documentation is extensive; however LyX is under constant development, +\SpecialChar LyX +'s documentation is extensive; + however \SpecialChar LyX + is under constant development, and each new release adds new features. You may find some documentation needs improvement. - This section describes what to do if you find an error, or have some suggestion -s for improving the documentation. + This section describes what to do if you find an error, + or have some suggestions for improving the documentation. \end_layout -\begin_layout Subsection +\begin_layout Subsubsection Reporting Errors in the Manuals \end_layout \begin_layout Standard -If you find a problem with the documentation, send a message to the mailing - list -\family typewriter -lyx-docs@lists.lyx.org -\family default +If you find a problem with the documentation, + send a message to the mailing list +\begin_inset CommandInset href +LatexCommand href +target "lyx-docs@lists.lyx.org" +type "mailto:" +literal "false" + +\end_inset + . The documentation team will make any necessary fixes. \end_layout -\begin_layout Subsection +\begin_layout Subsubsection Joining the Documentation Team. \end_layout \begin_layout Standard -The LyX Documentation Project, like anything else in the LyX project, can - always use assistance! If you're interested in contributing to the Documentatio -n Project, you need to do the following assignment -\emph on -first -\emph default -: +The \SpecialChar LyX + Documentation Project, + like anything else in the \SpecialChar LyX + project, + can always use assistance! + If you're interested in contributing to the Documentation Project, + you need to do the following: \end_layout \begin_layout Enumerate -Get the latest LyX source code. - Untar it. -\begin_inset Foot -status collapsed +Get the latest \SpecialChar LyX + source code from +\begin_inset Newline newline +\end_inset -\begin_layout Standard -The more adventurous can grab the latest documentation anonymously from - the LyX CVS repository - it is contained in the -\family typewriter -lyxdoc -\family default - module. -\end_layout + +\begin_inset CommandInset href +LatexCommand href +target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master " \end_inset - You will find a directory inside the main tree called -\family typewriter -lib/doc/ -\family default -. - Inside that directory is a file called -\family typewriter -DocStyle.lyx -\family default -. - Read it; it's the style sheet for the documentation. + \end_layout \begin_layout Enumerate -Next, read the +Next, + read the \emph on User's Guide \emph default @@ -1924,12 +2449,10 @@ User's Guide \emph on Tutorial \emph default -. - -\end_layout -\begin_deeper -\begin_layout Standard +\begin_inset Newline newline +\end_inset + The point of this exercise is to give you ideas. The \emph on @@ -1939,28 +2462,31 @@ Tutorial \emph on User's Guide \emph default - is likely to be the most up-to-date of all of the documentation. - You should be able to glean some insights into how we want the manuals - to read and to look. + are likely to be the most up-to-date of all of the documentation. + You should be able to glean some insights into how we want the manuals to read and to look. \end_layout -\end_deeper \begin_layout Enumerate -Contact the team at: -\end_layout +Contact the team at: +\begin_inset Newline newline +\end_inset -\begin_deeper -\begin_layout Standard -\family typewriter -lyx-docs@lists.lyx.org -\end_layout +\begin_inset CommandInset href +LatexCommand href +target "lyx-docs@lists.lyx.org" +type "mailto:" +literal "false" -\begin_layout Standard -to discuss your intended changes, and get some feedback on them. +\end_inset + + +\begin_inset Newline newline +\end_inset + +to discuss your intended changes and to get some feedback on them. \end_layout -\end_deeper \begin_layout Standard The changes you wish to make may range from improving clarity of the text, to doing major re-structuring of the documentation.