]> git.lyx.org Git - features.git/commitdiff
Add some remarks about defining formatted references.
authorRichard Heck <rgheck@lyx.org>
Thu, 19 Jan 2017 20:23:35 +0000 (15:23 -0500)
committerRichard Heck <rgheck@lyx.org>
Thu, 19 Jan 2017 20:26:31 +0000 (15:26 -0500)
lib/doc/UserGuide.lyx
status.22x

index 15995f31b1506598b8d2a6c4918031fcde1cde2b..9b189b31091461f656539b656dfb46e64511908d 100644 (file)
@@ -26479,8 +26479,12 @@ newref
 \series default
  (refstyle) in the \SpecialChar LaTeX
  preamble of the document.
- For example redefining all references to figures (which have the label
- shortcut 
+ For example, if you are using 
+\series bold
+refstyle
+\series default
+, then redefining all references to figures (which have the label shortcut
 \begin_inset Quotes eld
 \end_inset
 
@@ -26508,8 +26512,41 @@ pageref{#1}}}
 \begin_inset Newline newline
 \end_inset
 
-For more information about the format, have a look at the package documentations
-, 
+Please note that neither 
+\series bold
+prettyref
+\series default
+ nor 
+\series bold
+refstyle
+\series default
+ (nor LyX itself) defines reference formats for all available types.
+ This is especially true for the wide variety of mathematical `theorem'
+ environments.
+ So if you want to make formatted references to, say, Propositions, then
+ you will need to define the relevant format yourself.
+ For 
+\series bold
+prettyref
+\series default
+, you might do so as follows: 
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+newrefformat{prop}{Proposition 
+\backslash
+ref{#1}}
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+For more information about the defining formatted references, have a look
+ at the package documentations, 
 \begin_inset CommandInset citation
 LatexCommand cite
 key "prettyref,refstyle"
index a9f1fb22cd78743e1e764f53262ef5af501519d0..6897b34eef9a7d9fd5f1a4c6e6bc38432a75725a 100644 (file)
@@ -192,6 +192,9 @@ What's new
 
 - Fix compilation of the Fexynman diagram example file.
 
+- Added some comments to User Guide section 6.1 about defining formatted
+  references (bug 10545).
+
 
 * LYXHTML