Doc updates

[lyx.git] / lib / doc / UserGuide.lyx

diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index 2c7e2396a1951a1161b19ece3bdc4a746b3fda5b..de4786a1babe83456ed231a237bef7df229ede79 100644 (file)
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -1660,8 +1660,12 @@ T
 \bar default 
 ools\SpecialChar \menuseparator
 
 \bar default 
 ools\SpecialChar \menuseparator
 

+\family default 
+\SpecialChar \-
+
+\family sans 

 \bar under 
 \bar under 

--P
+P

 \bar default 
 references
 \family default 
 \bar default 
 references
 \family default 


@@ -1673,7 +1677,7 @@ Customization
  files.
 \layout Section
 
  files.
 \layout Section
 

-Setting Up the X Keyboard
+Setting Up the X Keyboard [obsolescent]

 \begin_inset LatexCommand \label{sec:x-win-keys}
 
 \end_inset 
 \begin_inset LatexCommand \label{sec:x-win-keys}
 
 \end_inset 


@@ -1681,18 +1685,18 @@ Setting Up the X Keyboard
 
 \layout Standard
 
 
 \layout Standard
 

-To use LyX properly, you 
+To use LyX properly, X 

 \emph on 
 must
 \emph default 
 \emph on 
 must
 \emph default 

- set X up correctly.
+ be set up correctly.

  This is especially vital if you're using the international support features
  of LyX and want to use non-English keyboard mappings.
  This is especially vital if you're using the international support features
  of LyX and want to use non-English keyboard mappings.

- Unfortunately, almost nobody bothers to do this, especially those who've
- installed Linux on a PC\SpecialChar \@.
- Administrators of large systems can be guilty of
- this, too, so don't assume that you're safe if you're using a large system.
- Any user can instruct X how to use his or her keyboard.
+ On modern distributions, this likely has been taken care of, but if not,
+ you must do this yourself.
+ Administrators of large systems often neglect this, so don't assume that
+ you're safe if you're using a large system.
+ Also ordinary users can instruct X how to use his or her keyboard.

 \layout Subsection
 
 xmodmap and xkeycaps
 \layout Subsection
 
 xmodmap and xkeycaps


@@ -1749,9 +1753,9 @@ xmodmap\SpecialChar ~
 xkeycaps
 \layout Standard
 
 xkeycaps
 \layout Standard
 

-This program is a dream come true! It brings up a graphical version of your
- keyboard, allows you to make modifications, and then spits those modifications
- out to the standard output in a form readable by 
+This program brings up a graphical version of your keyboard, allows you
+ to make modifications, and then spits those modifications out to the standard
+ output in a form readable by 

 \family typewriter 
 xmodmap
 \family default 
 \family typewriter 
 xmodmap
 \family default 


@@ -9692,7 +9696,7 @@ Using a sledgehammer to swat a fly,
 
  comes to mind.
  And, as the old saying implies, documents that overuse different fonts
 
  comes to mind.
  And, as the old saying implies, documents that overuse different fonts

- and sizes tend to look like someone's knocked huge holes in it.
+ and sizes tend to look like someone's knocked huge holes in them.

 \layout Standard
 
 Enough complaining.
 \layout Standard
 
 Enough complaining.


@@ -11234,18 +11238,53 @@ Those of you reading this from within LyX will see no difference, though
  there is one in the printed version.
 \layout Standard
 
  there is one in the printed version.
 \layout Standard
 

-One last note about hyphenation --- LyX automatically breaks up words and
+One more note about hyphenation --- LyX automatically breaks up words and

  inserts hyphens in English text.
  inserts hyphens in English text.

- (Actually, it's LaTeX that does this, and it will also hyphenate words
- in 
+ The words won't be hyphenated until you generate the final output.
+\layout Standard
+
+Actually, it's LaTeX that does this, and it will also hyphenate words in
+ 

 \emph on 
 some
 \emph default 
 \emph on 
 some
 \emph default 

- other languages.) The words won't be hyphenated until you generate the final
- output.
+ other languages.
+ To know whether (PDF)LaTeX hyphenates for 
+\emph on 
+your
+\emph default 
+ language, look at any log file produced by a LaTeX run: it will say
+\layout Quote
+
+
+\family typewriter 
+Babel <v3.7h> and hyphenation patterns for american, french, german, ngerman,
+ nohyphenation, loaded.

 \layout Standard
 
 \layout Standard
 

-If, for some reason, LaTeX can't break a word correctly, you can set hyphenation
+This tells you that, e.g., if you write in Finnish, you're out of luck.
+ Study (for the teTeX distribution of LaTeX) the utilities 
+\family typewriter 
+texconfig
+\family default 
+ and 
+\family typewriter 
+fmtutil
+\family default 
+ in order to switch hyphenation on for your language by ''uncommenting''
+ the relevant line in a file typically named 
+\family typewriter 
+language.dat
+\family default 
+.
+ Sorry for the inconvenience.
+\layout Standard
+
+If, for whatever reason, LaTeX 
+\emph on 
+still
+\emph default 
+ can't break a word correctly (e.g., a compound word), you can set hyphenation

  points manually.
  This is done with the menu item 
 \family sans 
  points manually.
  This is done with the menu item 
 \family sans 


@@ -19862,6 +19901,78 @@ optional
 The title of this section is a good example of using this feature.
 \layout Section
 
 The title of this section is a good example of using this feature.
 \layout Section
 

+Branches
+\layout Standard
+
+Sometimes you wish to be able to output to paper multiple versions of the
+ same document.
+ The most extreme version of this is, when you want to prepare a single
+ document in two or more different languages, but as a single document file,
+ with corresponding pieces of text adjacent in the file and on-screen.
+ This can be achieved with 
+\emph on 
+branches
+\emph default 
+.
+\layout Standard
+
+First, you have to 
+\emph on 
+define 
+\emph default 
+the branches available within a particular document.
+ This is done in the 
+\family sans 
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Branches
+\family default 
+ tab.
+ You can also associate a background colour with each branch, e.g., red for
+ the English language, blue for the German language branch.
+ Then, you create a branch inset from the 
+\family sans 
+Insert\SpecialChar \menuseparator
+Branch
+\family default 
+ menu item.
+ The inset will contain the text that you want to be output when this branch
+ is activated.
+\layout Standard
+
+
+\emph on 
+Activation 
+\emph default 
+or 
+\emph on 
+deactivation
+\emph default 
+ of a branch is done from the document settings menu.
+ All insets belonging to deactivated branches will be automatically closed,
+ those belonging to activated branches automatically opened.
+\layout Standard
+
+Other possible applications of the Branches paradigm include a 
+\begin_inset Quotes eld
+\end_inset 
+
+teacher's version
+\begin_inset Quotes erd
+\end_inset 
+
+ of a textbook containing the answers to questions, etc.
+\begin_inset Note
+collapsed true
+
+\layout Standard
+
+Once this doc is updated to 1.4, include branch examples here!
+\end_inset 
+
+
+\layout Section
+

 Previewing snippets of your document
 \layout Standard
 
 Previewing snippets of your document
 \layout Standard