]> git.lyx.org Git - features.git/blobdiff - lib/doc/UserGuide.lyx
UserGuide.lyx: describe how to use hyperlinks for nomenclature
[features.git] / lib / doc / UserGuide.lyx
index c712944db4e498062c3846e75187a881761f01b3..e1765c39e3dfe52caa106689cac2e72cb3815cde 100644 (file)
@@ -31273,13 +31273,14 @@ If the characters |
 \begin_inset space \space{}
 \end_inset
 
-should appear in nomenclature entries they need to be escaped by adding
- a quote character in front of them.
+should appear in nomenclature entries containing \SpecialChar TeX
+ code they need to be escaped
+ by adding a quote character in front of them.
 \begin_inset CommandInset nomenclature
 LatexCommand nomenclature
 symbol "\"@, \"|, \"!, \"\""
-description "The quote sign is output by writing ‘ \"\"\"\" '"
-literal "false"
+description "The quote sign in TeX code is output by writing ' \"\" '."
+literal "true"
 
 \end_inset
 
@@ -31329,7 +31330,7 @@ LatexCommand nomenclature
 prefix "sigma"
 symbol "$\\sigma$"
 description "dummy entry for the character \\textsf{sigma}"
-literal "false"
+literal "true"
 
 \end_inset
 
@@ -31438,6 +31439,13 @@ Nomenclature ! Options
 \end_inset
 
 
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Nomenclature-Options"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -31596,9 +31604,9 @@ page
 \begin_inset Quotes erd
 \end_inset
 
- are automatically translated for some document languages.
- If not, add these lines to your \SpecialChar LaTeX
preamble:
+ are automatically translated for most document languages.
+ If not, add these lines in front of the nomenclature list as \SpecialChar TeX
code:
 \end_layout
 
 \begin_layout Standard
@@ -31607,9 +31615,32 @@ page
 \series bold
 
 \backslash
-renewcommand{
+renewcommand*{
 \backslash
-eqdeclaration}[1]{, see equation
+eqdeclaration}[1]{
+\begin_inset Newline newline
+\end_inset
+
+
+\size small
+
+\begin_inset Phantom HPhantom
+status open
+
+\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\size default
+
+\backslash
+unskip, see equation
 \backslash
 nobreakspace(#1)}
 \begin_inset Newline newline
@@ -31617,33 +31648,118 @@ nobreakspace(#1)}
 
 
 \backslash
-renewcommand{
+renewcommand*{
 \backslash
-pagedeclaration}[1]{, page
+pagedeclaration}[1]{
+\begin_inset Newline newline
+\end_inset
+
+
+\size small
+
+\begin_inset Phantom HPhantom
+status open
+
+\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\size default
+
+\backslash
+unskip, page
 \backslash
 nobreakspace{}#1}
-\series default
+\end_layout
+
+\begin_layout Standard
+If the numbers should be hyperlinks, assure that you use 
+\family sans
+Hyperref
+\begin_inset space ~
+\end_inset
+
+Support
+\family default
+ in the document settings under 
+\family sans
+PDF
+\begin_inset space ~
+\end_inset
 
+Properties
+\family default
+ and use instead:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+renewcommand*{
+\backslash
+eqdeclaration}[1]{
 \begin_inset Newline newline
 \end_inset
 
-and replace 
-\begin_inset Quotes eld
+
+\begin_inset Phantom HPhantom
+status open
+
+\begin_layout Plain Layout
+\begin_inset space ~
 \end_inset
 
-see equation
-\begin_inset Quotes erd
+
+\end_layout
+
 \end_inset
 
- and 
-\begin_inset Quotes eld
+
+\backslash
+unskip, see 
+\backslash
+hyperlink{equation.#1}{equation
+\backslash
+nobreakspace{}(#1)}}
+\begin_inset Newline newline
 \end_inset
 
-page
-\begin_inset Quotes erd
+
+\backslash
+renewcommand*{
+\backslash
+pagedeclaration}[1]{
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Phantom HPhantom
+status open
+
+\begin_layout Plain Layout
+\begin_inset space ~
 \end_inset
 
- by their translation.
+
+\end_layout
+
+\end_inset
+
+
+\backslash
+unskip, 
+\backslash
+hyperlink{page.#1}{page
+\backslash
+nobreakspace{}#1}}
 \end_layout
 
 \begin_layout Subsection
@@ -38035,7 +38151,8 @@ Toolbar
 \end_layout
 
 \begin_layout Standard
-In this menu entry you can set the appearance of the different toolbars.
+In this menu entry you can set the icon size and the appearance of the different
+ toolbars.
  All toolbars and the 
 \family sans
 Command
@@ -48226,10 +48343,10 @@ Units
 \begin_layout Plain Layout
 \align center
 \begin_inset Tabular
-<lyxtabular version="3" rows="20" columns="3">
+<lyxtabular version="3" rows="21" columns="3">
 <features tabularvalignment="middle">
 <column alignment="center" valignment="top">
-<column alignment="center" valignment="top">
+<column alignment="center" valignment="middle" width="50col%">
 <column alignment="center" valignment="top">
 <row>
 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
@@ -48266,7 +48383,7 @@ name/description
 \begin_inset Text
 
 \begin_layout Plain Layout
-mm
+bp
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-millimeter
+big point (72
+\begin_inset space \thinspace{}
+\end_inset
+
+bp = 1
+\begin_inset space \thinspace{}
+\end_inset
+
+in)
 \end_layout
 
 \end_inset
@@ -48295,7 +48420,7 @@ millimeter
 \begin_inset Text
 
 \begin_layout Plain Layout
-cm
+cc
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-centimeter
+cicero (1
+\begin_inset space \thinspace{}
+\end_inset
+
+cc = 12
+\begin_inset space \thinspace{}
+\end_inset
+
+dd)
 \end_layout
 
 \end_inset
@@ -48324,7 +48457,7 @@ centimeter
 \begin_inset Text
 
 \begin_layout Plain Layout
-in
+cm
 \end_layout
 
 \end_inset
@@ -48333,7 +48466,7 @@ in
 \begin_inset Text
 
 \begin_layout Plain Layout
-inch
+centimeter
 \end_layout
 
 \end_inset
@@ -48353,7 +48486,7 @@ inch
 \begin_inset Text
 
 \begin_layout Plain Layout
-pt
+dd
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-point (72.27
+didot (1
 \begin_inset space \thinspace{}
 \end_inset
 
-pt = 1
+dd 
+\begin_inset Formula $\approx$
+\end_inset
+
+ 0.376
 \begin_inset space \thinspace{}
 \end_inset
 
-in)
+mm)
 \end_layout
 
 \end_inset
@@ -48390,7 +48527,7 @@ in)
 \begin_inset Text
 
 \begin_layout Plain Layout
-pc
+em
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-pica (1
-\begin_inset space \thinspace{}
-\end_inset
-
-pc = 12
-\begin_inset space \thinspace{}
-\end_inset
-
-pt)
+width of letter 
+\emph on
+M
+\emph default
+ in current font
 \end_layout
 
 \end_inset
@@ -48427,7 +48560,7 @@ pt)
 \begin_inset Text
 
 \begin_layout Plain Layout
-sp
+ex
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-scaled point (65536
-\begin_inset space \thinspace{}
-\end_inset
-
-sp = 1
-\begin_inset space \thinspace{}
-\end_inset
-
-pt)
+height of letter 
+\emph on
+x
+\emph default
+ in current font
 \end_layout
 
 \end_inset
@@ -48464,7 +48593,7 @@ pt)
 \begin_inset Text
 
 \begin_layout Plain Layout
-bp
+in
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-big point (72
-\begin_inset space \thinspace{}
+inch
+\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
 
-bp = 1
-\begin_inset space \thinspace{}
 \end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
 
-in)
+\begin_layout Plain Layout
+mm
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+millimeter
 \end_layout
 
 \end_inset
@@ -48501,7 +48651,7 @@ in)
 \begin_inset Text
 
 \begin_layout Plain Layout
-dd
+mu
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-didot (1
+math unit (1
 \begin_inset space \thinspace{}
 \end_inset
 
-dd 
-\begin_inset Formula $\approx$
-\end_inset
-
- 0.376
+mu = 1/18
 \begin_inset space \thinspace{}
 \end_inset
 
-mm)
+em)
 \end_layout
 
 \end_inset
@@ -48542,7 +48688,7 @@ mm)
 \begin_inset Text
 
 \begin_layout Plain Layout
-cc
+pt
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-cicero (1
+point (72.27
 \begin_inset space \thinspace{}
 \end_inset
 
-cc = 12
+pt = 1
 \begin_inset space \thinspace{}
 \end_inset
 
-dd)
+in)
 \end_layout
 
 \end_inset
@@ -48579,7 +48725,7 @@ dd)
 \begin_inset Text
 
 \begin_layout Plain Layout
-Scale Graphics %
+pc
 \end_layout
 
 \end_inset
@@ -48588,7 +48734,15 @@ Scale Graphics %
 \begin_inset Text
 
 \begin_layout Plain Layout
-% of original image width
+pica (1
+\begin_inset space \thinspace{}
+\end_inset
+
+pc = 12
+\begin_inset space \thinspace{}
+\end_inset
+
+pt)
 \end_layout
 
 \end_inset
@@ -48597,7 +48751,7 @@ Scale Graphics %
 \begin_inset Text
 
 \begin_layout Plain Layout
-
+-
 \end_layout
 
 \end_inset
@@ -48608,7 +48762,7 @@ Scale Graphics %
 \begin_inset Text
 
 \begin_layout Plain Layout
-Text Width %
+sp
 \end_layout
 
 \end_inset
@@ -48617,7 +48771,15 @@ Text Width %
 \begin_inset Text
 
 \begin_layout Plain Layout
-% of text width
+scaled point (65536
+\begin_inset space \thinspace{}
+\end_inset
+
+sp = 1
+\begin_inset space \thinspace{}
+\end_inset
+
+pt)
 \end_layout
 
 \end_inset
@@ -48626,9 +48788,7 @@ Text Width %
 \begin_inset Text
 
 \begin_layout Plain Layout
-
-\backslash
-textwidth
+-
 \end_layout
 
 \end_inset
@@ -48670,7 +48830,7 @@ columnwidth
 \begin_inset Text
 
 \begin_layout Plain Layout
-Page Width %
+Line Distance %
 \end_layout
 
 \end_inset
@@ -48679,7 +48839,7 @@ Page Width %
 \begin_inset Text
 
 \begin_layout Plain Layout
-% of paper width
+% of height between baselines of two subsequent text lines
 \end_layout
 
 \end_inset
@@ -48690,7 +48850,7 @@ Page Width %
 \begin_layout Plain Layout
 
 \backslash
-paperwidth
+baselineskip
 \end_layout
 
 \end_inset
@@ -48732,7 +48892,7 @@ linewidth
 \begin_inset Text
 
 \begin_layout Plain Layout
-Text Height %
+Page Height %
 \end_layout
 
 \end_inset
@@ -48741,7 +48901,7 @@ Text Height %
 \begin_inset Text
 
 \begin_layout Plain Layout
-% of text height
+% of paper height
 \end_layout
 
 \end_inset
@@ -48752,7 +48912,7 @@ Text Height %
 \begin_layout Plain Layout
 
 \backslash
-textheight
+paperheight
 \end_layout
 
 \end_inset
@@ -48763,7 +48923,7 @@ textheight
 \begin_inset Text
 
 \begin_layout Plain Layout
-Page Height %
+Page Width %
 \end_layout
 
 \end_inset
@@ -48772,7 +48932,7 @@ Page Height %
 \begin_inset Text
 
 \begin_layout Plain Layout
-% of paper height
+% of paper width
 \end_layout
 
 \end_inset
@@ -48783,7 +48943,7 @@ Page Height %
 \begin_layout Plain Layout
 
 \backslash
-paperheight
+paperwidth
 \end_layout
 
 \end_inset
@@ -48794,7 +48954,7 @@ paperheight
 \begin_inset Text
 
 \begin_layout Plain Layout
-ex
+Scale Graphics %
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-height of letter 
-\emph on
-x
-\emph default
- in current font
+% of original image width
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
--
+
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-em
+Text Height %
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-width of letter 
-\emph on
-M
-\emph default
- in current font
+% of text height
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
--
+
+\backslash
+textheight
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-mu
+Text Width %
 \end_layout
 
 \end_inset
 \begin_inset Text
 
 \begin_layout Plain Layout
-math unit (1
-\begin_inset space \thinspace{}
-\end_inset
-
-mu = 1/18
-\begin_inset space \thinspace{}
-\end_inset
-
-em)
+% of text width
 \end_layout
 
 \end_inset
@@ -48886,7 +49032,9 @@ em)
 \begin_inset Text
 
 \begin_layout Plain Layout
--
+
+\backslash
+textwidth
 \end_layout
 
 \end_inset
@@ -50238,6 +50386,56 @@ The above bibliography is created from a Bib\SpecialChar TeX
  database.
 \end_layout
 
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+renewcommand*{
+\backslash
+pagedeclaration}[1]{
+\end_layout
+
+\begin_layout Plain Layout
+
+\backslash
+unskip, 
+\backslash
+hyperlink{page.#1}{page
+\backslash
+nobreakspace{}#1}}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+This command makes the page number a clickable hyperlink, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Nomenclature-Options"
+
+\end_inset
+
+ for more info.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Standard
 \begin_inset CommandInset nomencl_print
 LatexCommand printnomenclature