UserGuide.lyx: describe how to use hyperlinks for nomenclature

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

diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index 3f7d1fdabf68d110bff9cd93fb495c706cff904b..e1765c39e3dfe52caa106689cac2e72cb3815cde 100644 (file)
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -8336,12 +8336,14 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim
+
 This is Verbatim.
 \end_layout
 
 \begin_layout Verbatim
 \noindent
 \align block
+
 The following 2 lines are empty:
 \end_layout
 
@@ -8354,6 +8356,7 @@ The following 2 lines are empty:
 \end_layout
 
 \begin_layout Verbatim
+
 Almost everything is allowed in Verbatim:"%&$§#~'`
 \backslash
 }][{|
@@ -8377,6 +8380,7 @@ Verbatim
 \end_layout
 
 \begin_layout Verbatim*
+
 This is Verbatim*.
 \end_layout
 
@@ -31269,36 +31273,18 @@ 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 ' \"\" '"
+description "The quote sign in TeX code is output by writing ' \"\" '."
 literal "true"
 
 \end_inset
 
 
-\begin_inset Note Note
-status open
-
-\begin_layout Plain Layout
-Update description when bug 
-\begin_inset CommandInset href
-LatexCommand href
-name "10825"
-target "http://www.lyx.org/trac/ticket/10825"
-literal "false"
-
-\end_inset
-
- is fixed.
-\end_layout
-
-\end_inset
-
-
 \end_layout
 
 \begin_layout Subsection
@@ -31453,6 +31439,13 @@ Nomenclature ! Options
 \end_inset
 
 
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Nomenclature-Options"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -31612,8 +31605,8 @@ page
 \end_inset
 
  are automatically translated for most document languages.
- If not, add these lines to your \SpecialChar LaTeX
- preamble:
+ If not, add these lines in front of the nomenclature list as \SpecialChar TeX
+ code:
 \end_layout
 
 \begin_layout Standard
@@ -31622,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
@@ -31632,33 +31648,118 @@ nobreakspace(#1)}
 
 
 \backslash
-renewcommand{
+renewcommand*{
+\backslash
+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
-pagedeclaration}[1]{, page
+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
@@ -38050,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
@@ -50284,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