enhance documentation of forward/reverse search

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

diff --git a/lib/doc/EmbeddedObjects.lyx b/lib/doc/EmbeddedObjects.lyx
index df934fa1b16602b9ea09b3dd1c541be0d2a324ec..a2eb4d30bb72788153cf35bb2bc89e1e7b0ca3cb 100644 (file)
--- a/lib/doc/EmbeddedObjects.lyx
+++ b/lib/doc/EmbeddedObjects.lyx
@@ -1,5 +1,5 @@
-#LyX 2.0.0beta2 created this file. For more info see http://www.lyx.org/
-\lyxformat 410
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413

 \begin_document
 \begin_header
 \textclass scrbook
 \begin_document
 \begin_header
 \textclass scrbook


@@ -153,6 +153,7 @@
 \use_default_options false
 \maintain_unincluded_children false
 \language english
 \use_default_options false
 \maintain_unincluded_children false
 \language english

+\language_package default

 \inputencoding auto
 \fontencoding global
 \font_roman default
 \inputencoding auto
 \fontencoding global
 \font_roman default


@@ -218,6 +219,7 @@
 \tracking_changes false
 \output_changes false
 \html_math_output 0
 \tracking_changes false
 \output_changes false
 \html_math_output 0

+\html_css_as_file 0

 \html_be_strict false
 \end_header
 
 \html_be_strict false
 \end_header
 


@@ -2040,8 +2042,17 @@ Table
 
 Settings
 \family default
 
 Settings
 \family default

- Here you can set the horizontal alignment and the width of the current
- column.
+ Here you can set the table width
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+Table ! Width
+\end_layout
+
+\end_inset
+
+, and the horizontal alignment and the width of the current column.

  The alignment 
 \family sans
 At
  The alignment 
 \family sans
 At


@@ -12234,7 +12245,8 @@ n
 \end_inset
 
 :
 \end_inset
 
 :

-\begin_inset Formula \begin{equation}
+\begin_inset Formula 
+\begin{equation}

 W_{g\, n}=(W_{g\,\mathrm{multicolumn}}+(1-n)\cdot(12.4\,\mathrm{pt}))/n\label{eq:Wgn}
 \end{equation}
 
 W_{g\, n}=(W_{g\,\mathrm{multicolumn}}+(1-n)\cdot(12.4\,\mathrm{pt}))/n\label{eq:Wgn}
 \end{equation}
 


@@ -12260,7 +12272,8 @@ reference "eq:Wgn"
 \end_inset
 
  becomes
 \end_inset
 
  becomes

-\begin_inset Formula \begin{equation}
+\begin_inset Formula 
+\begin{equation}

 W_{g\,2}=1.25\,\mathrm{cm}-6.2\,\mathrm{pt}
 \end{equation}
 
 W_{g\,2}=1.25\,\mathrm{cm}-6.2\,\mathrm{pt}
 \end{equation}
 


@@ -32572,13 +32585,21 @@ Files ! Include
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-Child documents are used when you have a long document consisting of several
+Child documents are used if you have a long document consisting of several

  larger parts or sections.
  For maintenance it is often useful and sometimes even required to split
  larger parts or sections.
  For maintenance it is often useful and sometimes even required to split

- the document in several files that can be revised separately.
- The different documents are then the so called child documents and a master
- document connects them to print the full document or parts of it.
- A child documents inherits elements of its master, for example the LaTeX
+ the document into several files that can be revised separately.
+ The different documents are then the so called 
+\begin_inset Quotes eld
+\end_inset
+
+child documents
+\begin_inset Quotes erd
+\end_inset
+
+, and a master document connects them to print the full document or parts
+ of it.
+ A child document inherits elements of its master, for example the LaTeX

  preamble, the bibliography, and labels for cross-references.
 \end_layout
 
  preamble, the bibliography, and labels for cross-references.
 \end_layout
 


@@ -32623,7 +32644,7 @@ Documents
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Include You can include LyX and LaTeX-documents.
+Include You can include LyX- and LaTeX-documents.

  When you press the 
 \family sans
 Load
  When you press the 
 \family sans
 Load


@@ -32671,7 +32692,7 @@ reference "sub:External-Subsection-1"
 
 \end_inset
 
 
 \end_inset
 

-
+.

 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard


@@ -32683,54 +32704,6 @@ The preamble of the child document is ignored; only the preamble of the
  a page break.
 \end_layout
 
  a page break.
 \end_layout
 

-\begin_layout Standard
-If you are only working on a certain chapter of a large document and want
- to save compiling time, you can put each included file into a branch.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Branches are described in section 
-\emph on
-Branches
-\emph default
- of the LyX 
-\emph on
-Userguide
-\emph default
-.
-\end_layout
-
-\end_inset
-
- By enabling/disabling branches you can decide what included files will
- appear in the output.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Plain Layout
-
-\series bold
-Note:
-\series default
- Due to a bug in LyX the LaTeX command 
-\series bold
-
-\backslash
-includeonly
-\series default
- can currently not be used as an alternative to decide what files should
- be included.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-

 \begin_layout Standard
 \begin_inset Note Greyedout
 status open
 \begin_layout Standard
 \begin_inset Note Greyedout
 status open


@@ -32740,8 +32713,8 @@ status open
 \series bold
 Note:
 \series default
 \series bold
 Note:
 \series default

- When you have included a LyX- or LaTeX-file, you are warned when you export/vie
-w the document in case the child document uses another document class than
+ If you have included a LyX- or LaTeX-file, you are warned when you export/view
+ the document in case the child document uses another document class than

  the master document as this will lead to unexpected outputs.
 \end_layout
 
  the master document as this will lead to unexpected outputs.
 \end_layout
 


@@ -32786,13 +32759,13 @@ Graphics
 \end_layout
 
 \begin_layout Itemize
 \end_layout
 
 \begin_layout Itemize

-The LaTeX-command 
-\series bold
-
-\backslash
-includeonly
-\series default
- cannot be used.
+You cannot exclude Input files via the menu 
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Child Documents
+\family default
+.

 \end_layout
 
 \end_deeper
 \end_layout
 
 \end_deeper


@@ -32812,7 +32785,7 @@ filename "DummyDocument2.lyx"
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Verbatim With this method every text file can be included.
+Verbatim With this method any text file can be included.

  The file is shown in the output with its source code; no command used in
  the text is invoked.
  You can use the option 
  The file is shown in the output with its source code; no command used in
  the text is invoked.
  You can use the option 


@@ -32866,7 +32839,7 @@ filename "DummyTextDocument.txt"
 \begin_inset VSpace bigskip
 \end_inset
 
 \begin_inset VSpace bigskip
 \end_inset
 

-Here is a child document inserted as Verbatim using the 
+ Here is a child document inserted as Verbatim using the 

 \family sans
 Mark spaces in output
 \family default
 \family sans
 Mark spaces in output
 \family default


@@ -32942,6 +32915,84 @@ Note:
 
 \end_layout
 
 
 \end_layout
 

+\begin_layout Standard
+If you want to view/export only selected children of your master document,
+ either because you want to save compiling time or because you want to distribut
+e single chapters of the book you are just writing, you can exclude children
+ from the output.
+ This is done via the menu 
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Child Documents
+\family default
+.
+ You can exclude\SpecialChar \slash{}
+include children by double-clicking on the 
+\family sans
+include to output
+\family default
+ column of the respective child document in the list (note that this only
+ works for documents embedded via 
+\begin_inset Quotes eld
+\end_inset
+
+Include
+\begin_inset Quotes erd
+\end_inset
+
+, not with 
+\begin_inset Quotes eld
+\end_inset
+
+Input
+\begin_inset Quotes erd
+\end_inset
+
+).
+ If the option 
+\family sans
+Maintain counters and references
+\family default
+ is enabled, LyX will assure that all page numbers, references etc.
+\begin_inset space ~
+\end_inset
+
+are correct as if the whole document was processed.
+ This is useful if you want the selected sub-documents to look exactly as
+ in the context of the whole document.
+ However, LyX needs to process the whole document in the background for
+ this feature.
+ So if you want to save compile time and if counters and references do not
+ need to be correct, disable this checkbox.
+\end_layout
+
+\begin_layout Standard
+Alternatively, you can put each included file into a branch.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Branches are described in section 
+\emph on
+Branches
+\emph default
+ of the LyX 
+\emph on
+Userguide
+\emph default
+.
+\end_layout
+
+\end_inset
+
+ By enabling\SpecialChar \slash{}
+disabling branches you can decide which included files will
+ appear in the output.
+ This has the advantage that it also works with Input'ed sub-documents.
+ However, counters and references will not be maintained with this approach.
+\end_layout
+

 \begin_layout Chapter
 Program Code Listings
 \begin_inset CommandInset label
 \begin_layout Chapter
 Program Code Listings
 \begin_inset CommandInset label


@@ -34840,7 +34891,8 @@ n
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-\begin_inset Formula \begin{equation}
+\begin_inset Formula 
+\begin{equation}

 W_{\mathrm{tot}\, n}=n\cdot(W_{g\, n}+2\cdot\backslash\mbox{tabcolsep})+(n+1)\cdot\backslash\mbox{arrayrulewidth}\label{eq:Wtot_n}
 \end{equation}
 
 W_{\mathrm{tot}\, n}=n\cdot(W_{g\, n}+2\cdot\backslash\mbox{tabcolsep})+(n+1)\cdot\backslash\mbox{arrayrulewidth}\label{eq:Wtot_n}
 \end{equation}
 


@@ -34895,7 +34947,8 @@ reference "eq:Wtot_n"
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-\begin_inset Formula \begin{equation}
+\begin_inset Formula 
+\begin{equation}

 W_{\mathrm{tot\, mult}}=W_{g\,\mathrm{mult}}+2\cdot\backslash\mbox{tabcolsep}+2\cdot\backslash\mbox{arrayrulewidth}\label{eq:Wtot_mult}
 \end{equation}
 
 W_{\mathrm{tot\, mult}}=W_{g\,\mathrm{mult}}+2\cdot\backslash\mbox{tabcolsep}+2\cdot\backslash\mbox{arrayrulewidth}\label{eq:Wtot_mult}
 \end{equation}
 


@@ -34939,7 +34992,8 @@ n
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-\begin_inset Formula \begin{equation}
+\begin_inset Formula 
+\begin{equation}

 W_{g\, n}=(W_{g\,\mathrm{mult}}+(1-n)\cdot(2\cdot\backslash\mbox{tabcolsep}+\backslash\mbox{arrayrulewidth}))/n
 \end{equation}
 
 W_{g\, n}=(W_{g\,\mathrm{mult}}+(1-n)\cdot(2\cdot\backslash\mbox{tabcolsep}+\backslash\mbox{arrayrulewidth}))/n
 \end{equation}