]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/Extended.lyx
doc/Makefile.am: add missing image file
[lyx.git] / lib / doc / Extended.lyx
index b9208f00fc8ccb19c6b762f35526b6f8898e8f24..7a15dec79e0d617a72ec5c6b42b591c999801400 100644 (file)
@@ -1,27 +1,50 @@
-#LyX 1.6.0beta3 created this file. For more info see http://www.lyx.org/
-\lyxformat 335
+#LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 340
 \begin_document
 \begin_header
-\textclass book
+\textclass scrbook
 \begin_preamble
-\usepackage{multicol}
-\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
+% DO NOT ALTER THIS PREAMBLE!!!
+%
+% This preamble is designed to ensure that the User's Guide prints
+% out as advertised. If you mess with this preamble,
+% parts of the User's Guide may not print out as expected.  If you
+% have problems LaTeXing this file, please contact 
+% the documentation team
+% email: lyx-docs@lists.lyx.org
 
 % if pdflatex is used
 \usepackage{ifpdf}
 \ifpdf
 
-% set fonts for nicer pdf view
-\IfFileExists{lmodern.sty}
- {\usepackage{lmodern}}{}
+ % set fonts for nicer pdf view
+ \IfFileExists{lmodern.sty}
 {\usepackage{lmodern}}{}
 
 \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]{\contentsname}{}
+ \myTOC
+ \cleardoublepage
+ \pagenumbering{arabic}}
+
 % redefine the \LyX macro for PDF bookmarks
 \def\LyX{\texorpdfstring{%
   L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
   {LyX }}
+
+% used for multi-column text
+\usepackage{multicol}
+
+% extra space for tables
+\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
 \end_preamble
+\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
 \begin_modules
 logicalmkup
 theorems-ams
@@ -37,8 +60,9 @@ theorems-ams-extended
 \font_osf false
 \font_sf_scale 100
 \font_tt_scale 100
+
 \graphics default
-\paperfontsize default
+\paperfontsize 12
 \spacing single
 \use_hyperref true
 \pdf_title "LyX's Extended manual"
@@ -47,7 +71,7 @@ theorems-ams-extended
 \pdf_keywords "LyX, Documentation, Extended"
 \pdf_bookmarks true
 \pdf_bookmarksnumbered true
-\pdf_bookmarksopen true
+\pdf_bookmarksopen false
 \pdf_bookmarksopenlevel 1
 \pdf_breaklinks false
 \pdf_pdfborder false
@@ -2934,6 +2958,59 @@ buffer
  to use.
 \end_layout
 
+\begin_layout Subsection
+Bibliography Lists in all Subdocuments
+\end_layout
+
+\begin_layout Standard
+Copy the bibliography list with all entries to all subdocuments and transform
+ them to a comment.
+ This way LyX will find the 
+\family typewriter
+.bib
+\family default
+-files and you can easily insert references without making the bibliography
+ list visible.
+\end_layout
+
+\begin_layout Standard
+As the bibliography list is in a comment, LaTeX won't use use it and the
+ references will look like this [?] instead of [1].
+ A solution is to use the LaTeX-package 
+\family typewriter
+comment
+\family default
+ that will only include comments by processing the files separately.
+ To do this, add in the LaTeX preamble of every subdocument the following:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+usepackage{comment}
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+includecomment{comment}
+\end_layout
+
+\begin_layout Standard
+See also 
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://wiki.lyx.org/FAQ/Unsorted#toc31
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Section
 Fancy Headers and Footers
 \end_layout
@@ -11977,7 +12054,7 @@ always
 \end_layout
 
 \begin_deeper
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMM
 
 \family sans
@@ -11990,7 +12067,7 @@ empty
  
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMM
 
 \family sans
@@ -12002,7 +12079,7 @@ plain
  No other headings or footers (other than footnotes).
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMM
 
 \series bold
@@ -12013,7 +12090,7 @@ foilheadings
  This is also the default.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMM
 
 \series bold
@@ -12055,7 +12132,7 @@ ettings
  dialog.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12066,7 +12143,7 @@ ettings
  this medium.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12076,7 +12153,7 @@ headrule
  title page.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12086,7 +12163,7 @@ footrule
  title page.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12105,7 +12182,7 @@ TeX to use the dvips driver to rotate those pages that are set as landscape
  foils.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12126,7 +12203,7 @@ Rotatefoilhead
  environments (don't worry these are described in the next section).
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12135,7 +12212,7 @@ leqno
  Equation numbers on the left.
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMx
 
 \series bold
@@ -12607,29 +12684,15 @@ Building a Set of Foils
 \begin_layout Standard
 This section will give a simple introduction to using the different environments
  to build a set of foils.
- If you want to see an example set of foils take a look at the 
+ If you want to see an example set of foils, take a look at the 
 \family typewriter
 Foils.lyx
 \family default
- file accessible from the 
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-O
-\bar default
-pen\SpecialChar \ldots{}
-
-\family default
- dialog under the 
-\family sans
-Examples
+ file you find in LyX's 
+\family typewriter
+examples
 \family default
- button.
+ folder.
 \end_layout
 
 \begin_layout Subsubsection
@@ -13024,7 +13087,7 @@ foilheadskip}{-0.5in}
 The spacings around floats can be adjusted by setting these lengths:
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13035,7 +13098,7 @@ abovefloatskip
  Separation between the text and the top of the float
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13046,7 +13109,7 @@ abovecaptionskip
  Separation between the float and the caption
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13057,7 +13120,7 @@ belowcaptionskip
  Separation between the caption and the following text
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13081,7 +13144,7 @@ There are also several title page related lengths that you may find useful
  if you have a long title or several authors:
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13094,7 +13157,7 @@ abovetitleskip
 Title
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13113,7 +13176,7 @@ Author
  environments
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13128,7 +13191,7 @@ Author
  lines
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -13145,7 +13208,7 @@ Author
 Date
 \end_layout
 
-\begin_layout List
+\begin_layout Labeling
 \labelwidthstring MMMMMMMMMMM
 
 \family typewriter
@@ -14976,38 +15039,31 @@ Introduction
 \end_layout
 
 \begin_layout Standard
-Under the 
+When you to have the 
+\family typewriter
+chktex
+\family default
+ program installed, you'll find in the 
 \family sans
-\bar under
-T
-\bar default
-ools
+Tools
 \family default
- menu, you'll find a 
+ menu the entry 
 \family sans
-\bar under
-C
-\bar default
-heck
+Check
 \begin_inset space ~
 \end_inset
 
 TeX
 \family default
  command.
- This feature requires you to have the 
+ You can get 
 \family typewriter
 chktex
 \family default
- program installed, and is grayed out if you don't have it.
- You can get it from your nearest CTAN mirror, or over the Web from 
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://www.ifi.uio.no/~jensthi/chktex/
-\end_layout
+ it from CTAN, 
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
 
 \end_inset
 
@@ -16100,7 +16156,11 @@ Version Control in LyX
 \begin_layout Standard
 by
 \noun on
- Lars Gullik Bjønnes
+ Lars Gullik Bjønnes, 
+\noun default
+updated by 
+\noun on
+Pavel Sanda
 \end_layout
 
 \begin_layout Subsection
@@ -16144,8 +16204,15 @@ man rcsintro
 \end_layout
 
 \begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS package---no
- guarantees are made for older versions.
+Later basic CVS/SVN support was added.
+ You should be familiar with CVS/SVN usage before start using it under LyX.
+ Most of the log messages are not currently displayed after operations -
+ you can check them in terminal window if unsure.
+\end_layout
+
+\begin_layout Standard
+The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package---no guarantees are made for older versions.
 \end_layout
 
 \begin_layout Subsection
 \bar default
 egister
 \family default
- item is grayed out.
+ item is not visible.
  
 \end_layout
 
 \begin_layout Standard
-This command registers your document with RCS\SpecialChar \@.
- You are asked interactively
- to supply an initial description of the document.
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
  The document is now set in Read-Only mode and you have to 
 \family sans
 Check
@@ -16285,7 +16353,7 @@ co -q -l <file-name>
 \begin_layout Subsubsection
 
 \family sans
-Revert To Last Version
+Revert To Repository Version
 \end_layout
 
 \begin_layout Standard
@@ -16339,6 +16407,344 @@ man rlog
  for more info.
 \end_layout
 
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
+
+\begin_layout Standard
+CVS is now partially supported by LyX.
+ You can find the commands in the 
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ submenu.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the 
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+\end_layout
+
+\begin_layout Standard
+This command registers in CVS your document ONLY in case you have already
+ the documents directory under CVS control (in particular 
+\family typewriter
+CVS/Entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+\end_layout
+
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+
+\begin_layout Standard
+CVS command that is run: 
+\family typewriter
+cvs -q add -m
+\begin_inset Quotes erd
+\end_inset
+
+<entered message>" 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read 
+\family typewriter
+man svn
+\family default
+ to understand the switches.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+
+\begin_layout Standard
+CVS command: 
+\family typewriter
+cvs -q commit -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
+\end_layout
+
+\begin_layout Standard
+CVS command: 
+\family typewriter
+cvs update 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This show the complete history of the CVS document.
+ The output of 
+\family typewriter
+cvs log 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ is shown in a browser.
+\end_layout
+
+\begin_layout Subsection
+SVN commands in LyX
+\end_layout
+
+\begin_layout Standard
+SVN is now partially supported by LyX.
+ You can find the commands in the 
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the 
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+\end_layout
+
+\begin_layout Standard
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular 
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+\end_layout
+
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+
+\begin_layout Standard
+SVN command that is run: 
+\family typewriter
+snv add -q 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read 
+\family typewriter
+man svn
+\family default
+ to understand the switches.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+
+\begin_layout Standard
+SVN command: 
+\family typewriter
+svn commit -q -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check Out For Edit
+\end_layout
+
+\begin_layout Standard
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be done manually by you!
+\end_layout
+
+\begin_layout Standard
+SVN command: 
+\family typewriter
+svn update 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+SVN command: 
+\family typewriter
+svn revert -q 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This show the complete history of the SVN document.
+ The output of 
+\family typewriter
+svn log 
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ is shown in a browser.
+\end_layout
+
 \begin_layout Section
 Literate Programming
 \end_layout