]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/EmbeddedObjects.lyx
Don't allow newline characters in document settings.
[lyx.git] / lib / doc / EmbeddedObjects.lyx
index 282a1047f763931a78500bec7f29a9d64cf26a3b..7bb26f6e8c2c94f06ad05bfafab0b95e5ff6ede5 100644 (file)
 
 % provides commands to set caption
 % beside tables/images
-\usepackage{sidecap}
-
-\newcommand{\TabBesBeg}{%
+\newcommand{\TabBesBeg}[1][1.0]{%
  \let\MyTable\table
  \let\MyEndtable\endtable
- \renewenvironment{table}{\begin{SCtable}}{\end{SCtable}}}
+ \renewenvironment{table}[1]{\begin{SCtable}[#1]##1}{\end{SCtable}}}
 
 \newcommand{\TabBesEnd}{%
  \let\table\MyTable
  \let\endtable\MyEndtable}
 
-\newcommand{\FigBesBeg}{%
+\newcommand{\FigBesBeg}[1][1.0]{%
  \let\MyFigure\figure
  \let\MyEndfigure\endfigure
- \renewenvironment{figure}{\begin{SCfigure}}{\end{SCfigure}}}
+ \renewenvironment{figure}[1]{\begin{SCfigure}[#1]##1}{\end{SCfigure}}}
 
 \newcommand{\FigBesEnd}{%
  \let\figure\MyFigure
  {\usepackage{picinpar}
   \setboolean{picinpar}{true}}
  {\setboolean{picinpar}{false}}
+
+% check for lettrine
+\newboolean{lettrine}
+\IfFileExists{lettrine.sty}
+ {\usepackage{lettrine}
+  \setboolean{lettrine}{true}}
+ {\setboolean{lettrine}{false}}
 \end_preamble
 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
 \use_default_options false
@@ -659,19 +664,15 @@ x.eps.bb
 \begin_inset Newline newline
 \end_inset
 
-The field 
+In the section 
 \family sans
-Initialize
+Graphics
 \begin_inset space ~
 \end_inset
 
 Group
-\begin_inset space ~
-\end_inset
-
-Name
 \family default
allows you define or join an image settings group.
you can define or join an image settings group.
 \begin_inset Index idx
 status collapsed
 
@@ -12815,6 +12816,104 @@ raggedright}
 
 \end_layout
 
+\begin_layout Standard
+To start a new line in a multirow you can use a forced line break (shortcut
+\begin_inset Info
+type  "shortcut"
+arg   "newline-insert newline"
+\end_inset
+
+) but this will not respect the cell lines as demonstrated in this table:
+\end_layout
+
+\begin_layout Standard
+\noindent
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="3" columns="2">
+<features tabularvalignment="middle">
+<column alignment="left" valignment="middle" width="2cm">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+aaa
+\begin_inset Newline newline
+\end_inset
+
+aaa
+\begin_inset Newline newline
+\end_inset
+
+wrong cell
+\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
+ccc
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell multirow="4" alignment="left" valignment="middle" 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" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+ddd
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+bbb
+\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
+eee
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Therefore be careful with forced line breaks.
+\end_layout
+
 \begin_layout Section
 Formal Tables
 \begin_inset CommandInset label
@@ -21244,7 +21343,7 @@ of
 \begin_inset space ~
 \end_inset
 
-floats try to place the float on its own page 
+floats try to place the float on its own page
 \end_layout
 
 \begin_layout Standard
@@ -23369,6 +23468,13 @@ To place in LyX the caption of a float on the side, it is necessary to add
  these commands to the document preamble:
 \end_layout
 
+\begin_layout Standard
+\begin_inset Newpage pagebreak
+\end_inset
+
+
+\end_layout
+
 \begin_layout Standard
 \noindent
 \begin_inset CommandInset line
@@ -23389,7 +23495,7 @@ height "1pt"
 \backslash
 newcommand{
 \backslash
-TabBesBeg}{%
+TabBesBeg}[1][1.0]{%
 \begin_inset Newline newline
 \end_inset
 
@@ -23398,8 +23504,6 @@ TabBesBeg}{%
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23424,7 +23528,7 @@ status open
 
 \begin_layout Plain Layout
 
-\series bold
+\series medium
 \begin_inset space ~
 \end_inset
 
@@ -23449,7 +23553,7 @@ status open
 
 \begin_layout Plain Layout
 
-\series bold
+\series medium
 \begin_inset space ~
 \end_inset
 
@@ -23460,9 +23564,9 @@ status open
 
 
 \backslash
-renewenvironment{table}{
+renewenvironment{table}[1]{
 \backslash
-begin{SCtable}}{
+begin{SCtable}[#1]##1}{
 \backslash
 end{SCtable}}}
 \end_layout
@@ -23483,8 +23587,6 @@ TabBesEnd}{%
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23508,8 +23610,6 @@ MyTable
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23534,7 +23634,7 @@ MyEndtable
 \backslash
 newcommand{
 \backslash
-FigBesBeg}{%
+FigBesBeg}[1][1.0]{%
 \begin_inset Newline newline
 \end_inset
 
@@ -23543,8 +23643,6 @@ FigBesBeg}{%
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23568,8 +23666,6 @@ figure
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23593,8 +23689,6 @@ endfigure
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23605,9 +23699,9 @@ status open
 
 
 \backslash
-renewenvironment{figure}{
+renewenvironment{figure}[1]{
 \backslash
-begin{SCfigure}}{
+begin{SCfigure}[#1]##1}{
 \backslash
 end{SCfigure}}}
 \end_layout
@@ -23628,8 +23722,6 @@ FigBesEnd}{%
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23653,8 +23745,6 @@ MyFigure
 status open
 
 \begin_layout Plain Layout
-
-\series bold
 \begin_inset space ~
 \end_inset
 
@@ -23701,7 +23791,7 @@ FigBesBeg
 
 \begin_layout Standard
 in TeX-Code before the float.
- After the float insert the command
+ And insert the command
 \end_layout
 
 \begin_layout Standard
@@ -23713,7 +23803,8 @@ FigBesEnd
 \end_layout
 
 \begin_layout Standard
-in TeX-Code to get back to the original float definition.
+in TeX-Code at the point where you want to get back to the original float
+ definition.
 \end_layout
 
 \begin_layout Standard
@@ -23852,6 +23943,115 @@ reference "fig:cap-beside-fig-2"
 \begin_inset VSpace medskip
 \end_inset
 
+
+\end_layout
+
+\begin_layout Standard
+The default caption width is the width of the image/table.
+ For thin image/tables, like in Table
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "tab:cap-beside-tab"
+
+\end_inset
+
+, this leads to captions that are too thin.
+ You can increase the width by specifying a factor that will be multiplied
+ with the image/table width to get the caption width.
+ The caption width will automatically be recalculated in case it would protrude
+ over the page or column margin due to the specified width.
+ The 
+\emph on
+factor
+\emph default
+ can either be given as optional argument for 
+\series bold
+
+\backslash
+FigBesBeg
+\series default
+:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+FigBesBeg[factor]
+\end_layout
+
+\begin_layout Standard
+or in the definition of 
+\series bold
+
+\backslash
+FigBesBeg
+\series default
+ by replacing the 
+\series bold
+1.0
+\series default
+ with another value.
+ If you do the latter, your factor will be the default if 
+\series bold
+
+\backslash
+FigBesBeg
+\series default
+ is used without an argument.
+ For Table
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "tab:cap-beside-tab-wider"
+
+\end_inset
+
+ the factor 5 was used.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ For floats with captions set beside, you cannot use the float placement
+ option 
+\family sans
+Here
+\begin_inset space ~
+\end_inset
+
+definitely
+\family default
+ because it is not supported by 
+\series bold
+sidecap
+\series default
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
 For more information about the package 
 \series bold
 sidecap
@@ -23916,7 +24116,7 @@ status collapsed
 
 
 \backslash
-FigBesBeg 
+FigBesBeg
 \end_layout
 
 \end_inset
@@ -23972,7 +24172,23 @@ status collapsed
 
 
 \backslash
-TabBesBeg 
+FigBesEnd
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+TabBesBeg
 \end_layout
 
 \end_inset
@@ -24305,6 +24521,282 @@ status collapsed
 \begin_layout Plain Layout
 
 
+\backslash
+TabBesBeg[5]
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Float table
+wide false
+sideways false
+status open
+
+\begin_layout Plain Layout
+\begin_inset Caption
+
+\begin_layout Plain Layout
+\begin_inset CommandInset label
+LatexCommand label
+name "tab:cap-beside-tab-wider"
+
+\end_inset
+
+This is a caption is wider than the one in Table
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "tab:cap-beside-tab"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset Tabular
+<lyxtabular version="3" rows="4" columns="5">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<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
+\end_layout
+
+\end_inset
+</cell>
+<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" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+b
+\end_layout
+
+\end_inset
+</cell>
+<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
+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
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+d
+\end_layout
+
+\end_inset
+</cell>
+<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" 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
+
+\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
+f
+\end_layout
+
+\end_inset
+</cell>
+<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" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+g
+\end_layout
+
+\end_inset
+</cell>
+<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
+h
+\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
+
+\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
+i
+\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
+
+\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
+j
+\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
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+TabBesEnd
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
 \backslash
 else
 \end_layout
@@ -33097,8 +33589,8 @@ Short
 Title
 \family default
  and contains the letter that is the initial.
- To use the also the optional argument, insert another argument in front
of the mandatory argument.
+ To use also the optional argument, insert another argument in front of
+ the mandatory argument.
  This one contains parameters to modify the initial.
  For more information about the possible parameters see the documentation
  of 
@@ -33136,6 +33628,36 @@ small caps
 Here are some examples:
 \end_layout
 
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+iflettrine
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+The following section will only be displayed when the LaTeX-package 
+\series bold
+lettrine
+\series default
+ is installed.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Enumerate
 No optional argument, the initial is the letter 'I' in the math font 
 \begin_inset Formula $\mathfrak{Fraktur}$
@@ -33466,6 +33988,60 @@ status collapsed
 \end_layout
 
 \end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+else
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+The following will be displayed when the LaTeX-package 
+\series bold
+lettrine
+\series default
+ is not installed:
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+You need to install the LaTeX-package 
+\series bold
+lettrine
+\series default
+ to see the following part of this section in the output.
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+fi
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Chapter
 External Document Parts
 \begin_inset Index idx
@@ -36626,52 +37202,6 @@ LaTeX-packages ! endfloat
 \end_inset
 
 
-\end_layout
-
-\begin_layout Bibliography
-\labelwidthstring Bibliography
-\begin_inset CommandInset bibitem
-LatexCommand bibitem
-key "wrapfig"
-
-\end_inset
-
-Documentation of the LaTeX-package 
-\series bold
-
-\begin_inset CommandInset href
-LatexCommand href
-name "wrapfig"
-target "ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/wrapfig/wrapfig.sty"
-
-\end_inset
-
-
-\series default
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-LaTeX-packages ! wrapfig
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-vspace{4mm}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-
 \end_layout
 
 \begin_layout Bibliography
@@ -37026,7 +37556,7 @@ Documentation of the LaTeX-package
 \begin_inset CommandInset href
 LatexCommand href
 name "refstyle"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/refstyle/doc/latex/refstyle/refstyle.pdf"
+target "http://mirrors.ctan.org/macros/latex/contrib/refstyle/refstyle.pdf"
 
 \end_inset