X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FIntro.lyx;h=dcbb73719aca624d6c02f5513c223f24c959f10f;hb=2d0941919f3bd77ad2f7032e97e80ca95c878eb5;hp=d1013099ed08f70d2cb8f41687c704c85d90233a;hpb=95146d3cf911230ee6c810e22d0243f83ce977a3;p=lyx.git diff --git a/lib/doc/Intro.lyx b/lib/doc/Intro.lyx index d1013099ed..dcbb73719a 100644 --- a/lib/doc/Intro.lyx +++ b/lib/doc/Intro.lyx @@ -1,7 +1,9 @@ -#LyX 1.5.3 created this file. For more info see http://www.lyx.org/ -\lyxformat 276 +#LyX 2.4 created this file. For more info see https://www.lyx.org/ +\lyxformat 614 \begin_document \begin_header +\save_transient_properties true +\origin /systemlyxdir/doc/ \textclass article \begin_preamble % DO NOT ALTER THIS PREAMBLE!!! @@ -13,98 +15,137 @@ % 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}} - {\usepackage[scaled=0.92]{helvet} - \usepackage{mathptmx} - \usepackage{courier} } - - % link all cross references and URLs in pdf output - \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, - bookmarksopen, bookmarksopenlevel=2, - linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, - pdfpagelayout=OneColumn, pdfnewwindow=true, - pdfstartview=XYZ, plainpages=false, pdfpagelabels, - pdfauthor={LyX Team}, pdftex, - pdftitle={Introduction to LyX},pdfsubject={LyX-documentation Intro}, - pdfkeywords={LyX, documentation}]{hyperref} - -\else % if dvi or ps is produced - - % link all cross references and URLs in dvi output - \usepackage[ps2pdf]{hyperref} - -\fi % end if pdflatex is used - - % the pages of the TOC are numbered roman - % and a pdf-bookmark for the TOC is added - \pagenumbering{roman} - \let\myTOC\tableofcontents - \renewcommand\tableofcontents{% - \pdfbookmark[1]{Contents}{} - \myTOC - \cleardoublepage - \pagenumbering{arabic} } - -% redefine the \LyX macro for PDF bookmarks -\def\LyX{\texorpdfstring{% - L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@} - {LyX }} +% 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 auto -\font_roman default -\font_sans default -\font_typewriter 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 -\font_sc false -\font_osf false -\font_sf_scale 100 -\font_tt_scale 100 +\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 +\default_output_format pdf2 +\output_sync 0 +\bibtex_command default +\index_command default \paperfontsize 12 \spacing single -\papersize a4paper +\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 1 -\use_esint 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 +\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 1 \paperpagestyle default -\tracking_changes false +\tablestyle default +\tracking_changes true \output_changes false -\author "" -\author "" +\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 +\begin_layout Plain Layout \noindent -If you have comments or error corrections, please send them to the LyX Documenta -tion mailing list: -\family typewriter -lyx-docs@lists.lyx.org +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 \end_inset @@ -113,7 +154,8 @@ lyx-docs@lists.lyx.org \end_layout \begin_layout Standard -\begin_inset LatexCommand tableofcontents +\begin_inset CommandInset toc +LatexCommand tableofcontents \end_inset @@ -121,36 +163,54 @@ lyx-docs@lists.lyx.org \end_layout \begin_layout Section -The Philosophy of LyX -\end_layout +The Philosophy of \SpecialChar LyX -\begin_layout Subsection -What is 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, 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 +\begin_layout Subsection +What is \SpecialChar LyX +? +\end_layout + +\begin_layout Standard +\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 +\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 @@ -159,18 +219,24 @@ typewriter concept \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 @@ -178,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 @@ -203,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 @@ -215,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 @@ -242,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 @@ -344,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 @@ -365,57 +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. + 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 \begin_layout Subsection -Differences between LyX and Other Word Processors -\begin_inset OptArg -status collapsed - -\begin_layout Standard -\begin_inset ERT -status collapsed - -\begin_layout Standard - - -\backslash -texorpdfstring{ -\end_layout - -\end_inset - -LyX -\begin_inset ERT -status collapsed - -\begin_layout Standard - -}{LyX} -\end_layout - -\end_inset - +Differences between \SpecialChar LyX and Other Word Processors \end_layout -\end_inset - - -\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 @@ -427,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 @@ -440,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 @@ -462,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 @@ -475,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 @@ -537,12 +664,19 @@ 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 20 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 @@ -550,42 +684,41 @@ works \end_layout \begin_layout Subsection -What is LaTeX? +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 was built up from a typesetting language called TeX, created by Donald - Knuth in 1984. - TeX takes a sequence of typesetting commands, written in a script in an - ASCII file, and executes them. + 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 @@ -594,9 +727,11 @@ 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. - What comes directly out of TeX is the portable document format + 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 @@ -613,47 +748,71 @@ device independent dvi \emph default . - The dvi format is often used for previews and can later be converted to - other formats like PostScript. + The dvi format is often used for previews and can later be converted to other formats like PostScript. \end_layout \begin_layout Standard -TeX isn't only a typesetting engine, it also allows you to define macros. - Most people who use TeX are actually using a macro package which Knuth - created to hide a lot of the typesetting details. +\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- and less typesetter-oriented, with a set of commands that consistently typeset things like sections, - tables or math formulas in an uniform, consistent fashion. - This is how LaTeX was born. + 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 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, 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 macros describing a new type of document, like a book, + 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 + 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 @@ -663,13 +822,22 @@ 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, etc. + 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 @@ -677,34 +845,52 @@ Here is a summary: \end_layout \begin_layout Description -TeX: Typesetting language with macro capability. +\SpecialChar TeX +: + Typesetting language with macro capability. \end_layout \begin_layout Description -LaTeX: Macro package built upon TeX\SpecialChar \@. +\SpecialChar LaTeX +: + Macro package built upon \SpecialChar TeX +\SpecialChar endofsentence \end_layout \begin_layout Description -classes: Descriptions of a type of document, using LaTeX\SpecialChar \@. +classes: + Descriptions of types of document used with \SpecialChar LaTeX +\SpecialChar endofsentence \end_layout \begin_layout Description -styles: Alters the default behavior of LaTeX in some way. +styles: + Descriptions of the default behavior of particular elements of \SpecialChar LaTeX +. \end_layout \begin_layout Description -LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting. +\SpecialChar LyX +: + Visual, + WYSIWYM document processor that uses \SpecialChar LaTeX + to do its typesetting. \end_layout \begin_layout Standard -This section attempts to account for the difference between LyX and other - word processors. - Simply put, LaTeX is the difference. - By using LaTeX as its backend, LyX helps you think more about +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 - what + what \emph default (as in the \emph on @@ -723,19 +909,26 @@ 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 - -\begin_layout Standard -The developing of LyX will hopefully never stop, so that some of the documentati -on 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 +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 @@ -743,32 +936,95 @@ 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 ~ +, + 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 LatexCommand ref + +\begin_inset CommandInset ref +LatexCommand ref reference "sec:Contrib" +nolink "false" \end_inset - in addition to the rest of this document.) + 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 +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" + +\end_inset + . - 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 + +\change_inserted -584632292 1610248366 + +\end_layout + +\begin_layout Subsection + +\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" + +\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" + +\end_inset + + for further information. + LyX also has a +\begin_inset CommandInset href +LatexCommand href +target "http://wiki.lyx.org/" +literal "false" + +\end_inset + + that will answer many questions about how to get LyX to do various things. +\change_unchanged + \end_layout \begin_layout Subsection @@ -776,72 +1032,86 @@ The Format of the Manuals \end_layout \begin_layout Standard -Some may have printed out the manuals. - Others may be reading it within LyX. - There are some differences between the LyX-file and 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. +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: + To open a footnote, + which looks like this: + \begin_inset Graphics - filename clipart/footnoteQt4.png - scale 75 + filename clipart/footnote.png + scale 95 \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 - +, + 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 \@. + menu, + where the contents are displayed automatically\SpecialChar endofsentence \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 light-grey box like the - following: +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/referenceQt4.png - scale 75 + filename clipart/reference.png + scale 95 \end_inset . - 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 two, the first one is named -\begin_inset Quotes eld + 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 -sec:Contrib -\begin_inset Quotes erd +to +\begin_inset space ~ \end_inset -. - You can go to the referred section by right-clicking on the box or by clicking - the button -\family sans -Go\InsetSpace ~ -to\InsetSpace ~ Label \family default in the opened dialog. Going back to where you came from is just as easy. - Clicking on + Click on \family sans -Go back +Go +\begin_inset space ~ +\end_inset + +Back \family default 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 @@ -850,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 @@ -859,7 +1132,9 @@ Emphasized Style \family typewriter Typewriter \family default - is used for program and file names, LyX code and functions. + is used for program and file names, + \SpecialChar LyX + code and functions. \end_layout \begin_layout Itemize @@ -867,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 @@ -884,34 +1161,13 @@ Noun Style \series bold Bold \series default - is used for LaTeX code + is used for \SpecialChar LaTeX + code \end_layout \begin_layout Standard -For menu accelerator keys and 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_inset Quotes erd -\end_inset - - (the file -\family typewriter -Extended.lyx -\family default -). - When we do need to reference keys, we'll use the following prefixing convention -: +When we do need to reference keys, + we'll use the following prefixing convention: \end_layout \begin_layout Itemize @@ -920,7 +1176,7 @@ Extended.lyx \family sans -C- +Ctrl+ \family default \begin_inset Quotes erd @@ -928,7 +1184,7 @@ C- indicates the \family sans -Control- +Control \family default key. \end_layout @@ -939,7 +1195,7 @@ Control- \family sans -S- +Shift+ \family default \begin_inset Quotes erd @@ -947,7 +1203,7 @@ S- indicates the \family sans -Shift- +Shift \family default key. \end_layout @@ -958,7 +1214,7 @@ Shift- \family sans -M- +Alt+ \family default \begin_inset Quotes erd @@ -966,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 @@ -987,7 +1243,7 @@ F1 \begin_inset Quotes erd \end_inset - \SpecialChar \ldots{} + \SpecialChar ldots \begin_inset Quotes eld \end_inset @@ -1066,7 +1322,8 @@ Down \begin_inset Quotes erd \end_inset -: self-explanatory. +: + self-explanatory. \end_layout \begin_layout Itemize @@ -1141,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 @@ -1224,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 @@ -1236,72 +1500,15 @@ Enter \end_layout \begin_layout Standard -You'll also see something like -\begin_inset Quotes eld -\end_inset - -(See -\emph on - -\begin_inset Quotes els -\end_inset - -Extended -\emph default - -\begin_inset Quotes ers -\end_inset - -) -\begin_inset Quotes erd -\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_inset - - -\emph on -Extended Features Manual -\emph default -, -\begin_inset Quotes erd -\end_inset - - 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 - -CUA -\begin_inset Quotes erd -\end_inset - - style which is the default and familiar to those coming from the PC world, - and the -\begin_inset Quotes eld -\end_inset - -emacs -\begin_inset Quotes erd -\end_inset - - style, which is common with those who -\begin_inset Quotes eld -\end_inset - -grew up -\begin_inset Quotes erd -\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. +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 @@ -1309,29 +1516,38 @@ Units used in the Manuals \end_layout \begin_layout Standard -To understand the units described in this documentation, Table\InsetSpace ~ +To understand the units described in this documentation, + Table +\begin_inset space ~ +\end_inset + -\begin_inset LatexCommand ref -reference "cap:Units-for-image" +\begin_inset CommandInset ref +LatexCommand ref +reference "tab:Units" +nolink "false" \end_inset - explains all units available in LyX. + explains all units available in \SpecialChar LyX +. \end_layout \begin_layout Standard \begin_inset Float table -placement t +placement document +alignment document wide false sideways false status open -\begin_layout Standard -\begin_inset Caption +\begin_layout Plain Layout +\begin_inset Caption Standard -\begin_layout Standard -\begin_inset LatexCommand label -name "cap:Units-for-image" +\begin_layout Plain Layout +\begin_inset CommandInset label +LatexCommand label +name "tab:Units" \end_inset @@ -1343,45 +1559,45 @@ Units \end_layout -\begin_layout Standard +\begin_layout Plain Layout \begin_inset VSpace medskip \end_inset \end_layout -\begin_layout Standard +\begin_layout Plain Layout \align center \begin_inset Tabular - - - - - + + + + + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout unit \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout name/description \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout mm \end_layout @@ -1390,18 +1606,18 @@ mm \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout millimeter \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout cm \end_layout @@ -1410,18 +1626,18 @@ cm \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout centimeter \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout in \end_layout @@ -1430,18 +1646,26 @@ in \begin_inset Text -\begin_layout Standard -inch +\begin_layout Plain Layout +inch (1 +\begin_inset space \thinspace{} +\end_inset + +in = 2.54 +\begin_inset space \thinspace{} +\end_inset + +cm) \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout pt \end_layout @@ -1450,13 +1674,13 @@ pt \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout point (72.27 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset pt = 1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset in) @@ -1465,11 +1689,11 @@ in) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout pc \end_layout @@ -1478,13 +1702,13 @@ pc \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout pica (1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset pc = 12 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset pt) @@ -1493,11 +1717,11 @@ pt) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout sp \end_layout @@ -1506,13 +1730,13 @@ sp \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout scaled point (65536 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset sp = 1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset pt) @@ -1521,11 +1745,11 @@ pt) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout bp \end_layout @@ -1534,13 +1758,13 @@ bp \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout big point (72 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset bp = 1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset in) @@ -1549,11 +1773,11 @@ in) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout dd \end_layout @@ -1562,9 +1786,9 @@ dd \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout didot (72 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset dd @@ -1572,7 +1796,7 @@ dd \end_inset 37.6 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset mm) @@ -1581,11 +1805,11 @@ mm) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout cc \end_layout @@ -1594,13 +1818,13 @@ cc \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout cicero (1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset cc = 12 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset dd) @@ -1609,11 +1833,11 @@ dd) \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout Scale% \end_layout @@ -1622,18 +1846,18 @@ Scale% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of original image width \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout text% \end_layout @@ -1642,18 +1866,18 @@ text% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of text width \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout col% \end_layout @@ -1662,18 +1886,18 @@ col% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of column width \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout page% \end_layout @@ -1682,18 +1906,18 @@ page% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of paper width \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout line% \end_layout @@ -1702,18 +1926,18 @@ line% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of line width \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout theight% \end_layout @@ -1722,18 +1946,18 @@ theight% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of text height \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout pheight% \end_layout @@ -1742,18 +1966,18 @@ pheight% \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout % of paper height \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout ex \end_layout @@ -1762,7 +1986,7 @@ ex \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout height of letter \emph on x @@ -1773,11 +1997,11 @@ x \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout em \end_layout @@ -1786,7 +2010,7 @@ em \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout width of letter \emph on M @@ -1797,26 +2021,26 @@ M \end_inset - - + + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout mu \end_layout \end_inset - + \begin_inset Text -\begin_layout Standard +\begin_layout Plain Layout math unit (1 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset mu = 1/18 -\begin_inset Formula $\,$ +\begin_inset space \thinspace{} \end_inset em) @@ -1842,8 +2066,11 @@ The Manuals \end_layout \begin_layout Standard -The following list describes the contents of each of the files in the documentat -ion: +The following list describes the contents of the basic documentation files that you find in the +\family sans +Help +\family default + menu: \end_layout \begin_layout Description @@ -1851,32 +2078,45 @@ Introduction This file. \end_layout \begin_layout Description -Tutorial If you are new to LyX, and have never used LaTeX before, you should - start here. - If you have used LaTeX before, you should still read the +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 Tutorial \emph default -, starting with the section on +, + starting with the section on \begin_inset Quotes eld \end_inset -LyX for LaTeX users. +\SpecialChar LyX + for \SpecialChar LaTeX + users. \begin_inset Quotes erd \end_inset - (Skimming the rest of the document wouldn't hurt, either.) + (Skimming through the rest of the document wouldn't hurt, + either.) \end_layout \begin_layout Description -User's\InsetSpace ~ +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 @@ -1884,44 +2124,83 @@ Tutorial \end_layout \begin_layout Description -Embedded\InsetSpace ~ +Embedded +\begin_inset space ~ +\end_inset + Objects Extension of the \emph on User's Guide \emph default . - Documents in detail how to use tables, graphics, floats, notes, and boxes. - It also includes many tricks of the LaTeX masters. + 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_layout Description +Math Extension of the +\emph on +User's Guide +\emph default +. + Documents in detail how to typeset any kind of formula. \end_layout \begin_layout Description -Extended\InsetSpace ~ +Additional +\begin_inset space ~ +\end_inset + Features 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. + Documents how to use raw \SpecialChar LaTeX + commands, + additional layouts and special-purpose editing features. \end_layout \begin_layout Description -Customization A description of advanced LyX features, including how to customize - the overall behavior of LyX\SpecialChar \@. - This includes such things as keybindings, internati -onalization, and configuration files. +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 \begin_layout Description -LaTeX\InsetSpace ~ -configuration LyX investigates your system upon installation. - This file contains info on what LyX learned about your installation. +Shortcuts Tables of the currently defined \SpecialChar LyX + shortcuts. +\end_layout + +\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 \begin_layout Standard These files will reference one another as necessary. - For example, the + For example, + the \emph on User's Guide \emph default @@ -1929,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 @@ -1950,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 @@ -1967,28 +2248,34 @@ 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 Section -\begin_inset LatexCommand label +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 Subsection -Contributing to LyX +Contributing to \SpecialChar LyX + \end_layout \begin_layout Standard -LyX is mostly written in C++ (the 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. +\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 Subsubsection @@ -1996,62 +2283,83 @@ Reporting a bug \end_layout \begin_layout Standard -While using LyX, you may find behavior 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 +\SpecialChar LyX + has a bug tracking system, + which you can find at +\begin_inset Newline newline +\end_inset -\begin_inset LatexCommand url -target "http://bugzilla.lyx.org/" -\end_inset +\begin_inset CommandInset href +LatexCommand href +target "https://www.lyx.org/trac/wiki/BugTrackerHome" +\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 url -target "http://www.lyx.org/" + 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, + +\begin_inset CommandInset href +LatexCommand href +target "lyx-devel@lists.lyx.org" +type "mailto:" +literal "false" \end_inset +. + Archives of this list are linked from the main \SpecialChar LyX + website, + +\begin_inset CommandInset href +LatexCommand href +target "http://www.lyx.org" + +\end_inset -\family default . \end_layout \begin_layout Standard -A 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 +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 config.log \family default -, and mention which compiler you are using. - +, + and mention which compiler you are using. \end_layout \begin_layout Subsubsection @@ -2059,10 +2367,12 @@ 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 Subsection @@ -2070,11 +2380,14 @@ 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 Subsubsection @@ -2082,11 +2395,16 @@ 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 @@ -2096,32 +2414,34 @@ 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: +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 from -\newline +Get the latest \SpecialChar LyX + source code from +\begin_inset Newline newline +\end_inset -\begin_inset LatexCommand url -target "http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc" + +\begin_inset CommandInset href +LatexCommand href +target "https://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master " \end_inset - -\newline -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 @@ -2130,7 +2450,9 @@ User's Guide Tutorial \emph default -\newline +\begin_inset Newline newline +\end_inset + The point of this exercise is to give you ideas. The \emph on @@ -2140,21 +2462,29 @@ 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 \begin_layout Enumerate Contact the team at: -\newline - -\family typewriter -lyx-docs@lists.lyx.org -\family default +\begin_inset Newline newline +\end_inset + + +\begin_inset CommandInset href +LatexCommand href +target "lyx-docs@lists.lyx.org" +type "mailto:" +literal "false" + +\end_inset + + +\begin_inset Newline newline +\end_inset -\newline -to discuss your intended changes, and get some feedback on them. +to discuss your intended changes and to get some feedback on them. \end_layout \begin_layout Standard