]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/EmbeddedObjects.lyx
enhance documentation of forward/reverse search
[lyx.git] / lib / doc / EmbeddedObjects.lyx
index 8d4a8b903aec0aad73ae85f9fa45cb19a54b993a..a2eb4d30bb72788153cf35bb2bc89e1e7b0ca3cb 100644 (file)
@@ -1,5 +1,5 @@
-#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
 \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_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 false
 \end_header
 
@@ -2009,7 +2011,26 @@ You can alter a table by clicking on it with the right mouse button, which
 contents
 \emph default
  of the cell, and the cell itself.
- You can alter tables with the following tabs of the table dialog:
+\begin_inset Newline newline
+\end_inset
+
+With the dialog option 
+\family sans
+Immediate
+\begin_inset space ~
+\end_inset
+
+Apply
+\family default
+ every change you make in the dialog is directly applied.
+ If you move the cursor to another table cell the dialog will then also
+ be updated with the parameters of the new cell.
+ If you change length values in the dialog you must press return to get
+ the change applied.
+\begin_inset Newline newline
+\end_inset
+
+You can alter tables with the following tabs of the table dialog:
 \end_layout
 
 \begin_layout Description
@@ -2021,8 +2042,17 @@ Table
 
 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
@@ -2062,7 +2092,7 @@ reference "sub:Multiple-Lines-in"
 \end_inset
 
 .
- If you set no width, the column is as wide as the content of the widest
+ If you set no width, the column is as wide as the content of its widest
  cell.
 \begin_inset Newline newline
 \end_inset
@@ -2115,6 +2145,218 @@ Note:
 \end_inset
 
 
+\begin_inset Newline newline
+\end_inset
+
+The table-wide vertical alignment is used for tables within text lines:
+\begin_inset Newline newline
+\end_inset
+
+A line with tables with different alignments: 
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="2">
+<features tabularvalignment="top">
+<column alignment="center" valignment="top" width="0pt">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+1
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+A
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+1
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+A
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="2" columns="2">
+<features tabularvalignment="bottom">
+<column alignment="center" valignment="top" width="0pt">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+1
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+A
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
 \begin_inset Newline newline
 \end_inset
 
@@ -2221,12 +2463,6 @@ reference "sec:Special-Longtable-Issues"
  describe the longtable features in detail.
 \end_layout
 
-\begin_layout Standard
-When the table dialog is open, you can move the cursor with the arrow keys
- from cell to cell and the property of the current cell will immediately
- be displayed in the dialog.
-\end_layout
-
 \begin_layout Section
 Table Toolbar
 \begin_inset Index idx
 \end_inset
 
 :
-\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}
+\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}
 
 \end_inset
 
@@ -12034,8 +12272,10 @@ reference "eq:Wgn"
 \end_inset
 
  becomes
-\begin_inset Formula \begin{equation}
-W_{g\,2}=1.25\,\mathrm{cm}-6.2\,\mathrm{pt}\end{equation}
+\begin_inset Formula 
+\begin{equation}
+W_{g\,2}=1.25\,\mathrm{cm}-6.2\,\mathrm{pt}
+\end{equation}
 
 \end_inset
 
@@ -12235,11 +12475,11 @@ Here is an example table with a multirow in the first column:
 <column alignment="center" valignment="top" width="0">
 <column alignment="center" valignment="top" width="0">
 <row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
-a
+a long cell entry
 \end_layout
 
 \end_inset
 </cell>
 </row>
 <row>
-<cell multirow="3" alignment="center" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
-multirow entry
+multirow
 \end_layout
 
 \end_inset
 </cell>
 </row>
 <row>
-<cell multirow="4" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
+<cell multirow="4" alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
 \end_layout
 
 \begin_layout Standard
-The width and alignment of multirow cells is set by setting the width and
- alignment for the whole column.
+The width of multirow cells is set by setting the width and alignment for
+ the whole column.
+ The 
+\family sans
+Vertical Offset
+\family default
+ shifts the content of the multirow up/down if the offset is positive/negative.
+\end_layout
+
+\begin_layout Standard
+If the column of a multirow cell has no explicit width, the multirow cell
+ inherits the alignment of the column.
+ Otherwise it is by default left-aligned.
+ To override the default, renew the command 
+\series bold
+
+\backslash
+multirowsetup
+\series default
+ with the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+multirowsetup}{
+\backslash
+centering}
+\end_layout
+
+\begin_layout Standard
+in the document preamble.
+ Then all entries of multirow cells in the document are centered.
+ If centering is only needed for several tables, you can renew the command
+ in a TeX-Code box just before the table instead of the preamble.
+ If the text should be right-aligned, replace 
+\series bold
+
+\backslash
+centering
+\series default
+ by 
+\series bold
+
+\backslash
+raggedleft
+\series default
+.
+ To return to left-alignment 
+\series bold
+
+\backslash
+raggedright
+\series default
+ is used.
+\end_layout
+
+\begin_layout Standard
+This is an example table with a right-aligned multirow cell that has a vertical
+ offset of -4
+\begin_inset space \thinspace{}
+\end_inset
+
+mm and is in a 3
+\begin_inset space \thinspace{}
+\end_inset
+
+cm wide column:
+\end_layout
+
+\begin_layout Standard
+\noindent
+\align center
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+multirowsetup}{
+\backslash
+raggedleft}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Tabular
+<lyxtabular version="3" rows="4" columns="3">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="3cm">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+a long cell entry
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+b
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+c
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+t
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+n
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+m
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="3" mroffset="-4mm" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+multirow
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+e
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+f
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="4" alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+h
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+i
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand{
+\backslash
+multirowsetup}{
+\backslash
+raggedright}
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Section
@@ -16678,11 +17154,8 @@ reference "tab:Table-cells-align"
 \end_inset
 
 .
- This alignment is achieved by highlighting the last 3
-\begin_inset space ~
-\end_inset
-
-cells of the column and then either pressing the toolbar button 
+ This alignment is achieved by setting the cursor into the column and then
+ either pressing the toolbar button 
 \begin_inset Graphics
        filename ../images/tabular-feature_align-decimal.png
        scale 85
@@ -32112,13 +32585,21 @@ Files ! Include
 \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
- 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
 
@@ -32163,7 +32644,7 @@ Documents
 \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
@@ -32211,7 +32692,7 @@ reference "sub:External-Subsection-1"
 
 \end_inset
 
-
+.
 \end_layout
 
 \begin_layout Standard
@@ -32223,30 +32704,6 @@ The preamble of the child document is ignored; only the preamble of the
  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
@@ -32256,32 +32713,8 @@ status open
 \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 Plain Layout
-
-\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
 
@@ -32326,13 +32759,13 @@ Graphics
 \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
@@ -32352,7 +32785,7 @@ filename "DummyDocument2.lyx"
 \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 
@@ -32406,7 +32839,7 @@ filename "DummyTextDocument.txt"
 \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
@@ -32482,6 +32915,84 @@ Note:
 
 \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
@@ -33218,7 +33729,7 @@ Global listings settings can be set in the
 \family sans
 Document\SpecialChar \menuseparator
 Settings\SpecialChar \menuseparator
-Text Layout
+Listings
 \family default
  dialog.
  To get there a list of available options, type in a question mark 
@@ -33229,15 +33740,7 @@ Text Layout
 \begin_inset Quotes erd
 \end_inset
 
- in the 
-\family sans
-Listings
-\begin_inset space ~
-\end_inset
-
-settings
-\family default
- field.
+.
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard
-\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}
+\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}
 
 \end_inset
 
@@ -34442,8 +34947,10 @@ reference "eq:Wtot_n"
 \end_layout
 
 \begin_layout Standard
-\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}
+\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}
 
 \end_inset
 
 \end_layout
 
 \begin_layout Standard
-\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}
+\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}
 
 \end_inset