-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 404
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
\begin_document
\begin_header
\textclass scrbook
End
\end_local_layout
\language english
+\language_package default
\inputencoding latin1
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\tracking_changes false
\output_changes false
\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
-\author 1 "ab"
-\author 2 "bbb"
\end_header
\begin_body
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5
+ Suppose your left and top margins are always 0.5
\begin_inset space \thinspace{}
\end_inset
\end_inset
- solves some of these problems.
- In particular, its rendering of math tends to look better than
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
+
+\end_inset
+
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with
\begin_inset Flex Code
status collapsed
\end_inset
-'s, at least in simpler cases, since it renders math using a combination
- of HTML and CSS rather than converting the formulae to images.
- But more complex formula tend to be rendered less well than with
+; this reflects the limitations of HTML.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+That said,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-htlatex
+eLyXer
+\end_layout
+
+\end_inset
+
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
\end_layout
\end_inset
-, since there is no reasonable way of scaling parentheses in HTML, for example.
- More importantly (as of version 0.39, at least),
+ More importantly (as of version 1.1.1, at least),
\begin_inset Flex Code
status collapsed
\end_inset
- has no support for math macros, for user-defined paragraph or character
- styles, or for tables of contents and figures, and its treatment of cross-refer
-ences is minimal.
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
These limitations make
\begin_inset Flex Code
status collapsed
\end_inset
- unsuitable for many of the documents more advanced LyX users would produce.
- In principle, of course, all of these problems could be solved, but the
- LyX developers have decided to follow a different path and have made LyX
- itself capable of writing XHTML, just as it is capable of writing LaTeX,
- DocBook, and plaintext.
+ unsuitable for many of the documents LyX users produce.
+ In principle, of course, these problems could be solved, but the LyX developers
+ have decided to follow a different path and have made LyX itself capable
+ of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
+ plaintext.
\end_layout
\begin_layout Standard
\end_inset
, usually contains up-to-date information about the state of XHTML output.
+ See also the list of XHTML bugs on
+\begin_inset CommandInset href
+LatexCommand href
+name "the bug tracker"
+target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
+
+\end_inset
+
+.
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Another advantege is that, since these routines are internal to LyX, they
+Another advantage is that, since these routines are internal to LyX, they
are immune to changes in LyX's file format, or to changes in the semantics
of existing insets.
\end_layout
\end_layout
\begin_layout Standard
-Quite generally, the output routines know everything LyX knows about document
+Quite generally, the output routines know what LyX knows about document
layout, that is, about how the document is to be rendered on screen.
We use this information when we output the document as XHTML.
In particular, LyX
\end_layout
\begin_layout Standard
-The result is that XHTML output can be customized and extended in
-\emph on
-exactly
-\emph default
+The result is that XHTML output can be customized and extended in exactly
the same way LaTeX output can be customized and extended: through layout
files and modules.
See chapter five of the
\begin_inset Newline newline
\end_inset
-If Lyx is unable to render a formula as MathML---for example, if the formula
+If LyX is unable to render a formula as MathML---for example, if the formula
uses the
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-If Lyx is unable to render a formula as MathML---for example, if the formula
+If Lyx is unable to render a formula as HTML---for example, if the formula
uses the
\begin_inset Flex Code
status collapsed
LaTeX, so they are very accurate.
The disadvantage, as mentioned earlier, is that these are bitmapped images,
so they do not scale terribly well, and one cannot copy them, etc.
+ (As of this writing, there are also problems about equation numbering.
+ See
+\begin_inset CommandInset href
+LatexCommand href
+name "bug 6894"
+target "http://www.lyx.org/trac/ticket/6894"
+
+\end_inset
+
+.)
\begin_inset Newline newline
\end_inset
\begin_layout Standard
There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
\end_layout
\begin_layout Chapter
\end_inset
- on Windows.
+ on Windows (but any working path can be used).
You
\emph on
must
\end_layout
\begin_layout Subsection
-
-\change_inserted 2 1274788899
\begin_inset CommandInset label
LatexCommand label
name "sub:rev-search"
\end_inset
-Automatical enabling
+Automatic setup
\end_layout
\begin_layout Standard
-
-\change_inserted 2 1274789582
In most cases LyX will do the work for you by enabling
\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1274789026
Document\SpecialChar \menuseparator
Output\SpecialChar \menuseparator
-Output Sync
+Synchronize with Output
\end_layout
\end_inset
.
- In such a case LyX will automatically insert SyncTeX macro (for PDF) or
- srcltx package (for DVI) respectively.
+ In such a case LyX will automatically insert the necessary SyncTeX macro
+ (for PDF) or load the srcltx package (for DVI) respectively.
This option can be easily reached also on
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1274789582
-View/update
-\change_unchanged
-
+View/Update
\end_layout
\end_inset
\end_layout
\begin_layout Standard
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
+\end_layout
+
+\end_inset
+
+.
+\end_layout
-\change_inserted 2 1274789534
-Plase note that including
+\begin_layout Standard
+Please note that including the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1274789498
srcltx
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1274789484
src-specials
-\change_unchanged
+\end_layout
+
+\end_inset
+ sometimes has an undesired impact on the typesetting.
+ Thus, you should switch output synchronization off for the final typesetting
+ if you use the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+srcltx
\end_layout
\end_inset
- sometimes have an impact on the typeset and you should switch them off
- for the final typesets.
-\change_unchanged
+ package or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
+\end_layout
+
+\end_inset
+.
\end_layout
\begin_layout Standard
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
+\end_inset
-\change_inserted 2 1274789340
-You can also define custom macro in preferences and in case you need some
- special tweaks read the next section about manual enabling.
-
-\change_unchanged
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:configuring-viewers"
-\begin_layout Subsection
+\end_inset
-\change_inserted 2 1274788680
-Manual enabling
-\change_unchanged
+, where the necessary configuration steps in your viewer -- needed both
+ with the automatic and the manual setup -- are described.
+\end_layout
+\begin_layout Subsection
+Manual setup
\end_layout
\begin_layout Standard
a given method (the built-in methods are rather new) and whether your viewer
can cope with it.
The available methods are described in the following.
-\change_inserted 2 1274788557
-
\end_layout
\begin_layout Subsubsection*
\begin_layout Subsection
Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:configuring-viewers"
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection*
\begin_layout Standard
Reverse search is triggered by double-click.
-\change_inserted 1 1271453423
-
\end_layout
\begin_layout Section
-
-\change_inserted 1 1271453442
Forward search
\end_layout
\begin_layout Standard
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
+\end_inset
+
+opposite
+\begin_inset Quotes erd
+\end_inset
+
+ to reverse search.
+ It allows you to let the viewer jump to a given position from within LyX.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your LyX document, and hit
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Navigate\SpecialChar \menuseparator
+Forward search
+\end_layout
+
+\end_inset
+
+ (or select
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Forward search
+\end_layout
-\change_inserted 1 1271454338
-To make forward search possible you need to provide generated output PDF/DVI
- file with additional information about TeX sources.
+\end_inset
+
+ in the context menu via right mouse click), and then the viewer will jump
+ to that position as well.
+ This implies, of course, that your viewer supports this function.
+\end_layout
+
+\begin_layout Standard
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the TeX sources.
This can be done via the methods described in the section
\begin_inset CommandInset ref
LatexCommand ref
\end_layout
\begin_layout Standard
-
-\change_inserted 1 1271454479
-Secondly you need to configure LyX for using your viewers in
+Additionally, you need to configure LyX for using your viewers in
\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1 1271453866
+Tools\SpecialChar \menuseparator
Preferences\SpecialChar \menuseparator
Output\SpecialChar \menuseparator
General
\end_inset
.
- Only some of the viewers allows this operation --- yap, xdvi, okular, Sumatra
- PDF
-\begin_inset Foot
+ We provide a range of tested configurations for some viewers, which you
+ can select from the drop down list.
+ If none of these configurations suits you, you have to find out and enter
+ a suitable configuration yourself.
+ The definition syntax uses the following placeholders:
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
+\end_layout
+
+\end_inset
+
+: row number
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+$$o
+\end_layout
+
+\end_inset
+
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
+\end_layout
+
+\begin_layout Standard
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular and Sumatra PDF
+\begin_inset Foot
+status collapsed
-\change_inserted 1 1271454273
+\begin_layout Plain Layout
For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
ip
-\change_unchanged
-
\end_layout
\end_inset
.
- Some other viewers allow at least reloading and positioning to particular
- page of the file --- Evince or xpdf --- for these cases you can use external
- call of synctex.
- Please study the prepared examples in the Preferences dialog.
-\change_unchanged
+ While many of the widespread PDF viewers (most notably Adobe Reader) do
+ not support forward search at all, some other viewers -- e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ evince and xpdf -- allow at least to reload the document and jump to a
+ specific page of the file, so you can at least navigate
+\begin_inset Quotes eld
+\end_inset
+
+near
+\begin_inset Quotes erd
+\end_inset
+
+.
+ These latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
+\end_layout
+
+\begin_layout Standard
+Forward search works both with DVI and PDF output.
+ LyX simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
+
\end_layout
\begin_layout Chapter
\begin_layout Standard
A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
+ replace the original manual but is merely a short guide in how to realize
+ the correct form of your paper.
\end_layout
\begin_layout Standard
Please note that the publisher of the journal was changed from Springer
to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
+ That change involved also some slight changes to the style files, namely
the removal of the thesaurus command.
The LyX class aa supports the newest version of these style files, V 5.01.
If you have an older version installed, please upgrade.
\begin_layout Plain Layout
-http://authors.elsevier.com/
+http://www.elsevier.com/wps/find/authorsview.authors/latex
\end_layout
\end_inset
.
Instructions are supplied along with the class file, which details the
requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
+ LyX includes a package that allows for the use of this class, by a layout
and a template file.
Installation of the class file is the same as for any other LaTeX package;
instructions are provided in the Elsevier documentation.
command to implement table captions.
As a result, a table created by LyX is printed correctly, but its caption
is ignored.
- However, you can use some TeX code to overpass this problem, so that captions
+ However, you can use some TeX code to overcome this problem, so that captions
are printed as expected.
To do so, create a float table as usual, remove the caption, and replace
it with the TeX code
\end_layout
\begin_layout Itemize
-To be able to compile your document to a PDF, PS, or DVI, assure that the
+To be able to compile your document to a PDF, PS, or DVI, ensure that the
two options
\family sans
Use AMS math package
\emph default
, but there are many others (see a complete list at
\begin_inset Flex URL
-status collapsed
+status open
\begin_layout Plain Layout
Document
\family default
).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
Settings
\family default
.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
+Detailed descriptions of the LaTeX document classes of the Koma-Script family
+ can be found in the Koma-Script documentation
\emph on
scrguide
\emph default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-There is an English translation
+ (German) and
\emph on
-screnggu
+scrguien
\emph default
-, but it is not a complete one.
-\end_layout
-
-\end_inset
-
- The following sections describe only those aspects, which are relevant
- in LyX.
+ (English).
\end_layout
\begin_layout Subsection
.
It has — on the LaTeX side — a completely new interface and is not compatible
with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+ Therefore, LyX supports both, though it is recommended you use the new
+ class.
\end_layout
\begin_layout Standard
\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
+ to meet almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
\family typewriter
).
In this section, we can only list those features which are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
+ For detailed descriptions (and for the rest of features) we recommend you
+ have a look at the detailed manual of the Memoir class
\begin_inset Foot
status collapsed
\end_inset
style: The fancy page style is not supported, due to a command clash between
- Memoir and the fancyhdr package (they are both defining a command with
- the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses LaTeX).
+ Instead, Memoir comes with a number of its own page styles (see
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\end_layout
\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
(e.
\begin_inset space \thinspace{}
\end_inset
Slide
\family default
, for example.
- In that case, enter in your descriptive comment and hit
+ In that case, enter your descriptive comment and hit
\family sans
Return
\family default
\end_layout
\begin_layout Standard
-If, on the other hand, you don't want to enter in any descriptive text,
- you'll hit another LyX quirk.
+If, on the other hand, you don't want to enter any descriptive text, you'll
+ hit another LyX quirk.
LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
environment until you put something in the old one.
So, do this:
\begin_layout Standard
Before you begin to use the version control features in LyX, you should
be familiar with RCS/CVS/SVN usage before start using it under LyX.
- Also note that CVS support was obsoloted by introducing subversion support
- so we advice using SVN instead.
+ Also note that CVS support is not as good as subversion support so we advice
+ using SVN instead.
Good place to start with Subversion is SVN Book
\begin_inset Foot
status open
\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.
- Most of the log messages are not currently displayed after operations -
+ Most of the log messages are not currently displayed after operations —
you can check them in Messages pane if unsure.
\end_layout
\end_layout
\begin_layout Standard
-This show the complete history of the RCS document.
+This shows the complete history of the RCS document.
The output of
\family typewriter
rlog <file-name>
\end_layout
\begin_layout Standard
-CVS is now partially supported by LyX.
+A subset of CVS operations is supported by LyX.
You can find the commands in the
\family sans
File\SpecialChar \menuseparator
Control
\family default
submenu.
- Focus of the development moved to SVN support, so please use it instead
+ The version control system SVN is more powerful, so please use it instead
of CVS if possible.
\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.
-
+General CVS usage
\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.
+If you start from scratch with CVS you have to create your repository and
+ checkout the working copy with external tools.
+ If you're using a client-server setup you may need to login before doing
+ the first repository checkout.
\end_layout
\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
-\end_inset
-
-<entered message>"
+If your documents are under revision control and others are using the same
+ repository problems arise when different changes to the same document at
+ the same location happen.
+ Standard CVS repositories doesn't operate with a file locking mechanism.
+ This may be surprising, but conflicts only occur if people disagree on
+ the proper content of the same part of a document.
+ So, if co-workers are used to communicate regularly, these conflicts occur
+ rarely.
+ If they don't communicate they have a fundamental problem anyway.
+ Nevertheless some people like to work with so called
\begin_inset Quotes eld
\end_inset
-<file-name>
+reserved checkouts
\begin_inset Quotes erd
\end_inset
+.
+ If they do so the working copy of all files is readonly when checked out
+ first and the user starts editing after using a special command to make
+ the working copy writable.
+ When the changes are checked in the working copy returns to readonly state.
+ With LyX one has to edit the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+.cvsrc
\end_layout
-\begin_layout Standard
-Read
-\family typewriter
-man svn
-\family default
- to understand the switches.
-
-\end_layout
+\end_inset
-\begin_layout Subsubsection
+ file and add the line
+\begin_inset Flex Code
+status collapsed
-\family sans
-Check In Changes
+\begin_layout Plain Layout
+cvs -r
\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_inset
+
+ to work with reserved checkouts.
+ The benefit is the possibility to see who is using a writable copy of some
+ document.
+ It's not guaranteed only one user makes a copy writable.
+\end_layout
+
+\begin_layout Standard
+LyX tries to guess if you're using reserved or non-reserved checkouts.
+ If your working copy is readonly or it is writable and an additional copy
+ of your document exists in the CVS/Base sub-directory a reserved otherwise
+ a non-reserved checkout is assumed.
+ When a reserved checkout is detected you have to use
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
+\end_layout
+
+\end_inset
+
+ to make your working copy writable if it's readonly.
+ After doing so the
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check In
+\end_layout
+
+\end_inset
+
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
+\end_layout
+
+\begin_layout Standard
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.nongnu.org/cvs
+\end_layout
+
+\end_inset
+
+ and here
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://ximbiot.com/cvs
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man cvs
+\family default
+ to understand the sub-commands and the switches mentioned below.
+\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
+\emph on
+
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+only
+\end_layout
+
+\end_inset
+
+
+\emph default
+ 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 create or checkout the archive by yourself using
+ external tools.
+ (In case you forget that step LyX registers the document with RCS.)
+\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 checked in.
+\end_layout
+
+\begin_layout Standard
+CVS command that is run:
+\family typewriter
+cvs -q add -m"<entered message>" "<file-name>"
+\end_layout
+
+\begin_layout Standard
+The term
+\family typewriter
+"<file-name>"
+\family default
+ above and for all other CVS commands is an abbreviation for
+\begin_inset Quotes eld
+\end_inset
+
+change the current working directory to file location and use the file name
+ without path component as argument
+\begin_inset Quotes erd
+\end_inset
+
+.
+\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 and you had changed the document, you are asked for a
+ description of the changes.
+ After that changes are written to the repository.
+ In case you didn't change the document and a reserved checkout is detected
+ the reservation made on
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
+\end_layout
+
+\end_inset
+
+ is undone.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
+
+command:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs
+\family typewriter
+-q commit -m"<description>" "<file-name>"
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q unedit
+\family typewriter
+"<file-name>"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check Out Changes
+\end_layout
+
+\begin_layout Standard
+When you are sharing a repository with others, you may have to incorporate
+ their changes into your working copy.
\end_layout
\begin_layout Standard
CVS command:
\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+cvs -q update "<file-name>"
+\end_layout
+
+\begin_layout Standard
+If a readonly checkout is detected the working copy is made writable and
+ reserved.
+\end_layout
+
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q edit "<file-name>"
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
CVS command:
\family typewriter
-cvs update
-\begin_inset Quotes eld
+cvs -q update "<file-name>"
+\end_layout
+
+\begin_layout Standard
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
+\end_layout
+
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q unedit "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
+\end_layout
+
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
\end_inset
-<file-name>
-\begin_inset Quotes erd
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
\end_inset
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+<<<<<<<
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Show History
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
\end_layout
-\begin_layout Standard
-This show the complete history of the CVS document.
- The output of
+\end_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
+\end_layout
+
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
+\end_layout
+
+\end_inset
+
+ signs.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs diff
\family typewriter
-cvs log
-\begin_inset Quotes eld
+"."
+\end_layout
+
\end_inset
-<file-name>
-\begin_inset Quotes erd
+ (Ask if changes are detected.)
+\begin_inset Newline newline
\end_inset
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs -q update
+\family typewriter
+"."
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$path
+\end_layout
+
+\end_inset
+
+ stands for the path to the document.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log "<file-name>"
\family default
is shown in a browser.
\end_layout
\end_layout
\begin_layout Standard
-This show the complete history of the SVN document.
+This shows the complete history of the SVN document.
The output of
\family typewriter
svn log
The file exchange through various revision control systems brings the problem
of merge conflicts in case two different users try to edit the same (parts
of) document.
- When such conflict happens it needs manual resolving and one reasonable
+ When such a conflict happens it needs manual resolving and one reasonable
alternative is to provide some kind of locking mechanism, which guarantees
that only one user is allowed to edit file at the given time.
\end_layout
\begin_layout Standard
-SVN has two mechanisms to provide such kind of mutual exclusivity for file
- access - locks and automatical setting of write permissions (see sec.
+SVN has two such mechanisms to provide mutual exclusivity for file access
+ - locks and automatic setting of write permissions (see sec.
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
.
- In a case this property is detected for a given document LyX starts to
- use SVN locks for document editing automatically and the whole check-in/out
- mechanism switches to the same regimen as for RCS.
- This in particular means there are two different modes how file is used
- in LyX:
+ If this property is detected for a given document LyX starts to use SVN
+ locks for document editing automatically and the whole check-in/out mechanism
+ switches to the same regimen as for RCS.
+ This in particular means there are two different modes of file use in LyX:
\end_layout
\begin_layout Itemize
Unlocked state.
The loaded file is in the read-only mode.
- For editation on needs to check-out.
+ For editing on needs to check-out.
\emph on
Check-out
\emph default
- consists of update from repository and gaining write lock.
+ consists of updating from the repository and gaining write lock.
If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
\family default
-Automatical Locking Property
+Automatic Locking Property
\end_layout
\begin_layout Standard
-The above mentioned automatical setting of write permissions of the .lyx
- file can be set through
+The above mentioned automatic setting of write permissions of the .lyx file
+ can be set through
\family sans
\bar under
F
\family sans
svn propset svn:keywords 'Rev' file.lyx
\family default
-) and then paste keyword ERT
+) and then paste keyword TeX code
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Subsubsection
-SSH tunel used with SVN under Windows
+SSH tunnel used with SVN under Windows
\end_layout
\begin_layout Standard
-Compared to linux setting svn client to communicate over ssh under Windows
- is rather troublesome task.
- We will at least make some hints how to setup client side but former knowledge
- about ssh and Windows command line is needed, also be prepared for a great
- deal of frustration...
+Compared with Linux setting up svn client to communicate over ssh under
+ Windows is a rather troublesome task.
+ We will at least offer some hints how to setup the client side but prior
+ knowledge about ssh and the Windows command line is needed, also be prepared
+ for a great deal of frustration\SpecialChar \ldots{}
+
\end_layout
\begin_layout Enumerate
-Get svn client for windows, as described in previous sections.
- When it is fresh install run some svn command (e.g.
+Get a svn client for windows, as described in the previous sections.
+ When it is a fresh install run some svn command (e.g.
\begin_inset Flex Code
status collapsed
\end_inset
-) to have created config files, which you will need to change later on.
+) to create config files, which you will need to change later on.
\end_layout
\begin_layout Enumerate
-Choose ssh client for Windows.
- There are more possibilities, we will use the one from Putty tools
+Choose a ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
status open
\end_inset
.
- You will need to automatize connection, so client doesn't ask for any password
- from you.
+ You will need to set the connection up so that the client doesn't ask for
+ any password from you.
To keep things easy we will use only keys without any additional password
protection etc.
\end_layout
.
Save your private .ppk key file and put the public one on the server side.
- In case the SVN server runs on linux, note that the format of the public
- key is not compatible with linux openssh and you will need to direcly copy-past
-e the key from the “
+ If the SVN server runs on Linux, note that the format of the public key
+ is not compatible with Linux openssh and you will need to direcly copy-paste
+ the key from the “
\emph on
Public key for pasting into OpenSSH authorized_keys file
\emph default
\begin_layout Standard
When the collsraborators are mixing Linux and Windows environments, LyX
will use different line endings inside the .lyx files.
- This is not problem as far as LyX functionality is concerned, but the commit
- diffs will be huge and merge-conflicts prone.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
Fortunately SVN itself knows
\begin_inset Foot
status collapsed
\begin_layout Standard
The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+ literate programming, where it is assumed that you are familiar with this
+ programming technique, and know what
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+E.
Knuth during the development of his TeX typesetting software.
\end_layout
\begin_layout Plain Layout
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\begin_layout Standard
Most ideas in this section require less common files in your LaTeX installation.
- If you have a system like teTeX, most will already be available.
+ If you have a system like TeXLive, most will already be available.
A few, however, will need to be downloaded from one of the CTAN archives.
Often, there are several ways to do something, or several LaTeX style files
which do the same thing.
\end_layout
-\begin_layout Standard
-
-\end_layout
-
\begin_layout Section
Dropped Capitals
\end_layout
dropping
\family default
) package from CTAN allows a simple way to add such letters to your documents.
- Since this package is not a standard part of teTeX, I can't demonstrate
+ Since this package is not a standard part of TeXLive, I can't demonstrate
it within this document, but if you copy this paragraph to a new document,
delete the
\begin_inset Quotes eld
projects / lyx.git / blobdiff