]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Intro.lyx
Fix # 8414: Use the noweb module instead of literate-* article layouts
[lyx.git] / lib / doc / Intro.lyx
index 8d361a4e3527c2451cc7daaabeebfe39e03d4f73..86a897c359f327c08d12d6737caf6858ea22498d 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 1.6.0rc5 created this file. For more info see http://www.lyx.org/
-\lyxformat 344
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
 \begin_document
 \begin_header
 \textclass article
   \myTOC
   \cleardoublepage
   \pagenumbering{arabic} }
-
-% redefine the \LyX macro for PDF bookmarks
-\def\LyX{\texorpdfstring{%
-  L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
-  {LyX }}
 \end_preamble
 \use_default_options false
+\maintain_unincluded_children false
 \language english
+\language_package default
 \inputencoding auto
+\fontencoding global
 \font_roman default
 \font_sans default
 \font_typewriter default
 \font_default_family default
+\use_non_tex_fonts false
 \font_sc false
 \font_osf false
 \font_sf_scale 100
 \font_tt_scale 100
 
 \graphics default
+\default_output_format default
+\output_sync 0
+\bibtex_command default
+\index_command default
 \paperfontsize 12
 \spacing single
 \use_hyperref true
 \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, pdfpagelabels"
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
 \papersize a4paper
 \use_geometry false
 \use_amsmath 1
 \use_esint 0
+\use_mhchem 1
+\use_mathdots 1
 \cite_engine basic
 \use_bibtopic false
+\use_indices false
 \paperorientation portrait
+\suppress_date false
+\use_refstyle 0
+\index Index
+\shortcut idx
+\color #008000
+\end_index
 \secnumdepth 3
 \tocdepth 2
 \paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
 \quotes_language english
 \papercolumns 1
 \papersides 1
 \paperpagestyle default
 \tracking_changes false
 \output_changes false
-\author "" 
-\author "" 
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict false
 \end_header
 
 \begin_body
@@ -138,16 +151,16 @@ What is LyX?
 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 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 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
+ 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{}
 
@@ -166,9 +179,9 @@ typewriter concept
 
 .
  It is designed for authors who want professional output quickly with a
- minimum of effort without becoming specialists in typesetting.
+ minimum of effort and 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.
+ with LyX, the author can concentrate on the contents of his writing.
 \end_layout
 
 \begin_layout Standard
@@ -229,9 +242,9 @@ what you're doing
 \emph default
  and LyX takes care of the rest, following a set of rules called a 
 \emph on
-style.
+style
 \emph default
-
+.
 \begin_inset Foot
 status collapsed
 
@@ -281,7 +294,6 @@ Introduction
  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
@@ -294,17 +306,16 @@ Section
 \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 ---
+ 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
@@ -318,12 +329,19 @@ Now let's look at the problem of consistency.
 \end_inset
 
 4.
- However, you forget that you were using 18pt bold instead of 16pt, so you
- type in the heading for Section
+ 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 that what you used for Section
+4 in a different font from the one you used for Section
 \begin_inset space ~
 \end_inset
 
@@ -385,21 +403,21 @@ 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 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.
+ 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
+\begin_inset Argument
 status collapsed
 
 \begin_layout Plain Layout
@@ -447,7 +465,7 @@ Tab stops
 \end_layout
 
 \begin_layout Itemize
-Extra whitespace (i.
+Extra whitespace (e.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -489,7 +507,7 @@ Page breaks
 \end_layout
 
 \begin_layout Itemize
-Line spacing (i.
+Line spacing (e.
 \begin_inset space \thinspace{}
 \end_inset
 
@@ -542,7 +560,7 @@ Additional Features
 
 \end_inset
 
+
 \end_layout
 
 \begin_layout Standard
@@ -576,7 +594,7 @@ Granted, many modern word processors can handle mathematical symbols, tables,
  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 
+ LaTeX has been around since 1985, and 
 \emph on
 works
 \emph default
@@ -653,13 +671,13 @@ dvi
 \end_layout
 
 \begin_layout Standard
-TeX isn't only a typesetting engine, it also allows you to define macros.
+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.
  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.
+ tables or math formulas in a uniform, consistent fashion.
  This is how LaTeX was born.
 \end_layout
 
@@ -687,7 +705,8 @@ class
  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 
+ even have a class for their thesis format.
+ A 
 \emph on
 style
 \emph default
@@ -736,9 +755,9 @@ LyX: Visual, WYSIWYM word-processor that uses LaTeX to do its typesetting.
 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 
+ By using LaTeX as its backend, LyX helps you think more about
 \emph on
- what 
+ what
 \emph default
  (as in the 
 \emph on
@@ -760,8 +779,8 @@ Navigating the Documentation
 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
+ 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
 
@@ -793,7 +812,7 @@ reference "sec:Contrib"
 \end_layout
 
 \begin_layout Standard
-Also, please do us a favor -- if anything in these manuals confuses you,
+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 
 \begin_inset CommandInset href
@@ -804,7 +823,7 @@ type "mailto:"
 \end_inset
 
 .
- If you have questions which are not obviously answered in the documentation,
+ 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
@@ -823,9 +842,9 @@ The Format of the Manuals
 
 \begin_layout Standard
 Some may have printed out the manuals.
- Others may be reading it within LyX.
+ Others may be reading them 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
In 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: 
@@ -859,15 +878,6 @@ In the printed manuals, all cross-references appear as the actual numbers
 .
  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
-\end_inset
-
-sec:Contrib
-\begin_inset Quotes erd
-\end_inset
-
-.
  You can go to the referred section by right-clicking on the box or by clicking
  the button 
 \family sans
@@ -885,7 +895,11 @@ Label
  Going back to where you came from is just as easy.
  Clicking on 
 \family sans
-Go back
+Go
+\begin_inset space ~
+\end_inset
+
+Back
 \family default
  to go back to your earlier location.
 \end_layout
@@ -940,30 +954,7 @@ Bold
 \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
-Addtional 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
@@ -972,7 +963,7 @@ Extended.lyx
 
 
 \family sans
-C-
+Ctrl-
 \family default
 
 \begin_inset Quotes erd
@@ -980,7 +971,7 @@ C-
 
  indicates the 
 \family sans
-Control-
+Control
 \family default
  key.
 \end_layout
@@ -991,7 +982,7 @@ Control-
 
 
 \family sans
-S-
+Shift-
 \family default
 
 \begin_inset Quotes erd
@@ -999,7 +990,7 @@ S-
 
  indicates the 
 \family sans
-Shift-
+Shift
 \family default
  key.
 \end_layout
@@ -1010,7 +1001,7 @@ Shift-
 
 
 \family sans
-M-
+Alt-
 \family default
 
 \begin_inset Quotes erd
@@ -1018,13 +1009,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
@@ -1288,72 +1279,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
-Additional 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
@@ -1411,7 +1345,7 @@ Units
 \align center
 \begin_inset Tabular
 <lyxtabular version="3" rows="20" columns="2">
-<features>
+<features tabularvalignment="middle">
 <column alignment="center" valignment="top" width="0">
 <column alignment="center" valignment="top" width="0">
 <row>
@@ -1899,8 +1833,12 @@ 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
@@ -1953,12 +1891,22 @@ Objects Extension of the
 User's Guide
 \emph default
 .
- Documents in detail how to use tables, graphics, floats, notes, and boxes.
+ Documents in detail how to use tables, graphics, floats, notes, program
+ listings, and boxes.
  It also includes many tricks of the LaTeX masters.
 \end_layout
 
 \begin_layout Description
-Extended
+Math Extension of the 
+\emph on
+User's Guide
+\emph default
+.
+ Documents in detail how to typeset any kind of formulas.
+\end_layout
+
+\begin_layout Description
+Additional
 \begin_inset space ~
 \end_inset
 
@@ -1976,6 +1924,12 @@ 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.
+ It also includes information about layout files, which are needed to get
+ LyX to support LaTeX classes or packages.
+\end_layout
+
+\begin_layout Description
+Shortcuts Tables with the currently defined LyX shortcuts.
 \end_layout
 
 \begin_layout Description
@@ -1983,7 +1937,7 @@ LaTeX
 \begin_inset space ~
 \end_inset
 
-configuration LyX investigates your system upon installation.
+Configuration LyX investigates your system upon installation.
  This file contains info on what LyX learned about your installation.
  Check it to see if you're missing something you might like to have.
 \end_layout
@@ -2037,8 +1991,6 @@ Tutorial
 
 \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.
 \end_layout
 
 \begin_layout Section
@@ -2083,7 +2035,7 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://bugzilla.lyx.org/
+http://www.lyx.org/trac/wiki/BugTrackerHome
 \end_layout
 
 \end_inset
@@ -2136,7 +2088,6 @@ A useful bug report will at a minimum include the version of LyX you are
 config.log
 \family default
 , and mention which compiler you are using.
 \end_layout
 
 \begin_layout Subsubsection
@@ -2201,21 +2152,12 @@ status collapsed
 
 \begin_layout Plain Layout
 
-http://www.lyx.org/trac/browser/lyx-devel/trunk/lib/doc
+http://www.lyx.org/trac/browser/lyxgit/lib/doc?rev=master
 \end_layout
 
 \end_inset
 
  
-\begin_inset Newline newline
-\end_inset
-
-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
@@ -2240,7 +2182,7 @@ Tutorial
 \emph on
 User's Guide
 \emph default
is likely to be the most up-to-date of all of the documentation.
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
@@ -2262,7 +2204,7 @@ type "mailto:"
 \begin_inset Newline newline
 \end_inset
 
-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