UserGuide: take care of the new reference format features

- also: as we recommend refstyle in the text the document should also use it
This commit is contained in:
Uwe Stöhr 2017-07-26 23:43:35 +02:00
parent 49b83acf12
commit 00ae46489e
6 changed files with 536 additions and 246 deletions

View File

@ -1,4 +1,12 @@
For LyX 2.2.3:
For LyX 2.3.0:
Modified:
first step:
- sec. 6.1: new reference format and new options
For LyX 2.2.3:
- sec. 2.5.1: (not French) new sentence
- sec. 6.11.4: Japanese only: untranslated note

View File

@ -112,7 +112,7 @@ enumitem
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\branch Question
@ -27314,7 +27314,7 @@ reference "subsec:Protected-Space"
\end_layout
\begin_layout Standard
There are six formats of cross-references:
There are eight formats of cross-references:
\end_layout
\begin_layout Description
@ -27546,19 +27546,11 @@ fig
\begin_inset Quotes erd
\end_inset
) can be done
\change_inserted 424524441 1483414614
, for
) can be done for
\series bold
refstyle
\series default
,
\change_unchanged
with this command
\change_inserted 424524441 1483414616
:
\change_unchanged
with this command:
\begin_inset Newline newline
\end_inset
@ -27569,23 +27561,20 @@ refstyle
newref{fig}{refcmd={Image on page
\backslash
pageref{#1}}}
\change_inserted 424524441 1484857490
\series default
\begin_inset Newline newline
\end_inset
Please note that neither
Note that neither
\series bold
prettyref
\series default
nor
\series bold
refstyle
refstyle
\series default
(nor \SpecialChar LyX
itself) predefines reference formats for all available types.
predefines 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
@ -27605,24 +27594,13 @@ prettyref
newrefformat{prop}{Proposition
\backslash
ref{#1}}
\change_unchanged
\series default
\begin_inset Newline newline
\end_inset
For more information about
\change_inserted 424524441 1484843645
defining formatted references
\change_deleted 424524441 1484843647
the format
\change_unchanged
, have a look at the package documentation
\change_deleted 424524441 1484843659
s,
\change_unchanged
For more information about defining formatted references, have a look at
the package documentation
\begin_inset CommandInset citation
LatexCommand cite
key "prettyref,refstyle"
@ -27631,18 +27609,22 @@ literal "true"
\end_inset
.
\change_inserted 424524441 1484843594
\begin_inset Newline newline
\end_inset
The `Plural' and `Capitalized' options will be available with formatted
references only if you are using the
The options
\family sans
Plural
\family default
and
\family sans
Capitalized
\family default
will be available with formatted references only if you are using the
\series bold
refstyle
\series default
package.
See its documentation, again, for more information.
\end_layout
\begin_layout Description
@ -27658,33 +27640,41 @@ reference "fig:Two-distorted-images"
\end_inset
\change_inserted 424524441 1483414460
\end_layout
\begin_layout Description
\change_inserted 424524441 1483817846
Label
\begin_inset space ~
\end_inset
only: prints only the \SpecialChar LaTeX
label for the reference.
This allows for customization, using ERT, if you want to issue a command
that LyX does not support.
label for the reference:
\begin_inset CommandInset ref
LatexCommand labelonly
reference "fig:Two-distorted-images"
\end_inset
\begin_inset Newline newline
\end_inset
This allows for customization, using \SpecialChar TeX
Code, if you want to issue a command
that \SpecialChar LyX
does not support.
If you are using
\series bold
refstyle
\series default
, then you may want to use the
\begin_inset Quotes eld
\end_inset
No prefix
\begin_inset Quotes erd
\family sans
No
\begin_inset space ~
\end_inset
Prefix
\family default
option, which will output only the part of the reference following the
\begin_inset Quotes eld
@ -27695,18 +27685,20 @@ No prefix
\end_inset
separator.
This is the form needed for, e.g.,
This is the form needed for e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
\series bold
refstyle
\series default
's range commands.
\change_deleted 424524441 1483414539
\end_layout
\begin_layout Standard
The number and current page of the referenced document part in the output
is automatically calculated by \SpecialChar LaTeX
's range commands.The number and current page of the referenced document
part in the output is automatically calculated by \SpecialChar LaTeX
.
The varieties are adjusted in the field
\family sans
@ -27810,87 +27802,6 @@ Embedded
Objects
\emph default
manual.
\change_inserted 424524441 1483414754
\end_layout
\begin_layout Standard
\change_inserted 424524441 1483414754
\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
\change_inserted 424524441 1483414754
\series bold
Note:
\series default
It is recommended to use the \SpecialChar LaTeX
-package
\series bold
refstyle
\series default
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
\change_inserted 424524441 1483414754
\SpecialChar LaTeX
-packages ! refstyle
\end_layout
\end_inset
because
\series bold
prettyref
\series default
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
\change_inserted 424524441 1483414754
\SpecialChar LaTeX
-packages ! prettyref
\end_layout
\end_inset
does not know all of \SpecialChar LyX
's possible label shortcuts
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\change_inserted 424524441 1483414754
\begin_inset Quotes eld
\end_inset
fig:
\begin_inset Quotes erd
\end_inset
is for example \SpecialChar LyX
's shortcut for labels in figure captions.
\end_layout
\end_inset
and is not internationalized.
\end_layout
\end_inset
\change_unchanged
\end_layout
\begin_layout Section

View File

@ -121,7 +121,7 @@ enumitem
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\branch Frage
@ -26781,7 +26781,11 @@ B.
\family sans
„fig
\family default
“ haben) umzuformatieren, verwendet man im Fall von refstyle den Befehl
“ haben) umzuformatieren, verwendet man im Fall von
\series bold
refstyle
\series default
den Befehl
\begin_inset Newline newline
\end_inset
@ -26793,13 +26797,10 @@ newref{fig}{refcmd={Bild auf Seite
\backslash
pageref{#1}}}
\series default
\lang english
\begin_inset Newline newline
\end_inset
\lang ngerman
Bitte beachten Sie, dass weder
\series bold
prettyref
@ -26808,10 +26809,8 @@ prettyref
\series bold
refstyle
\series default
(noch \SpecialChar LyX
selbst) Formate für alle verfügbarren Typen von Verweisen vordefiniert.
Dies trifft insbesondere auf eine große Bandbreite verfügbarer mathematischer
Formate für alle verfügbarren Typen von Verweisen vordefiniert.
Dies trifft insbesondere auf viele der verfügbaren mathematischer
\begin_inset Quotes gls
\end_inset
@ -26827,7 +26826,10 @@ Theorem
prettyref
\series default
würde das bspw.
so aussehen:
\begin_inset space \space{}
\end_inset
so aussehen:
\begin_inset Newline newline
\end_inset
@ -26869,12 +26871,6 @@ Großschreibung
refstyle
\series default
aktiviert.
Für weitere Informationen konsultieren Sie bitte auch hier die Dokumentation
des Pakets
\emph on
refstyle
\emph default
.
\end_layout
\begin_layout Description
@ -26893,9 +26889,22 @@ Nur
\begin_inset space ~
\end_inset
Marke: gibt nur den \SpecialChar LaTeX
-Schlüssel für den Querverweis aus.
Das ist sinnvoll, wenn Sie über den \SpecialChar TeX
Marke: gibt nur die \SpecialChar LaTeX
-Marke für den Querverweis aus:
\begin_inset CommandInset ref
LatexCommand labelonly
reference "tab:Ein-Tabellen-Gleitobjekt"
plural "false"
caps "false"
noprefix "false"
\end_inset
\begin_inset Newline newline
\end_inset
Das ist sinnvoll, wenn Sie über den \SpecialChar TeX
-Modus einen Befehl für Querverweise
eingeben wollen, der von \SpecialChar LyX
nicht unterstützt wird.
@ -26903,9 +26912,13 @@ Marke: gibt nur den \SpecialChar LaTeX
\series bold
refstyle
\series default
verwenden, können Sie in diesem Fall zusätzlich
verwenden, können Sie in diesem Fall zusätzlich die Option
\family sans
Ohne Präfix
Ohne
\begin_inset space ~
\end_inset
Präfix
\family default
aktivieren, womit nur der Teil des Schlüssels, der nach dem Separator
\begin_inset Quotes gld
@ -26918,9 +26931,9 @@ Ohne Präfix
kommt, ausgegeben wird.
Diese Form wird beispielsweise für
\series bold
refstyles
refstyle
\series default
s
\emph on
Range-
\emph default
@ -27032,73 +27045,6 @@ Objekte
Handbuch beschrieben.
\end_layout
\begin_layout Standard
\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
\series bold
Bemerkung:
\series default
Die Verwendung des \SpecialChar LaTeX
-Pakets
\series bold
refstyle
\series default
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
\SpecialChar LaTeX
-Paket ! refstyle
\end_layout
\end_inset
wird empfohlen, da
\series bold
prettyref
\series default
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
\SpecialChar LaTeX
-Paket ! prettyref
\end_layout
\end_inset
nicht alle von \SpecialChar LyX
generierten Markenkürzel kennt
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\begin_inset Quotes gld
\end_inset
fig:
\begin_inset Quotes grd
\end_inset
zum Beispiel ist \SpecialChar LyX
' Kürzel für Marken in Abbildungslegenden.
\end_layout
\end_inset
und keine Übersetzungen anbietet.
\end_layout
\end_inset
\end_layout
\begin_layout Section
Inhaltsverzeichnis
\begin_inset Index idx

View File

@ -1,5 +1,5 @@
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 543
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
@ -112,7 +112,8 @@ enumitem
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\branch Pregunta
\selected 1
@ -8558,12 +8559,14 @@ Literal
\end_layout
\begin_layout Verbatim
Esto es entorno Literal.
\end_layout
\begin_layout Verbatim
\noindent
\align block
Las dos líneas siguientes están vacías:
\end_layout
@ -8576,6 +8579,7 @@ Las dos líneas siguientes están vacías:
\end_layout
\begin_layout Verbatim
Casi todo está permitido en entorno Literal:"%&$§#~'`
\backslash
}][{|
@ -8600,6 +8604,7 @@ con la diferencia de que los espacios aparecen en la salida como el carácter
\end_layout
\begin_layout Verbatim*
Esto es entorno Literal*.
\end_layout
@ -26890,7 +26895,7 @@ reference "subsec:Espacio-protegido"
\end_layout
\begin_layout Standard
Hay seis estilos de referencias cruzadas:
Hay ocho estilos de referencias cruzadas:
\end_layout
\begin_layout Description
@ -27179,7 +27184,11 @@ fig
\begin_inset Quotes crd
\end_inset
), se usa el comando
), con
\series bold
refstyle
\series default
se usa el comando
\begin_inset Newline newline
\end_inset
@ -27195,8 +27204,51 @@ pageref{#1}}}
\begin_inset Newline newline
\end_inset
Para más información sobre el formato echa un vistazo a las documentaciones
de los paquetes,
\lang english
Note that neither
\series bold
prettyref
\series default
nor
\series bold
refstyle
\series default
predefines 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
\lang spanish
\backslash
newrefformat{prop}{
\lang english
Proposition
\lang spanish
\backslash
ref{#1}}
\series default
\begin_inset Newline newline
\end_inset
Para más información sobre
\lang english
defining formatted references
\lang spanish
echa un vistazo a las documentaciones de los paquetes,
\begin_inset CommandInset citation
LatexCommand cite
key "prettyref,refstyle"
@ -27205,6 +27257,24 @@ literal "true"
\end_inset
.
\begin_inset Newline newline
\end_inset
\lang english
The options
\family sans
Plural
\family default
and
\family sans
Capitalized
\family default
will be available with formatted references only if you are using the
\series bold
refstyle
\series default
package.
\end_layout
\begin_layout Description
@ -27222,6 +27292,73 @@ reference "fig:Dos-imágenes"
\end_layout
\begin_layout Description
\lang english
Label
\begin_inset space ~
\end_inset
only: prints only the \SpecialChar LaTeX
label for the reference:
\lang spanish
\begin_inset CommandInset ref
LatexCommand labelonly
reference "fig:Dos-imágenes"
plural "false"
caps "false"
noprefix "false"
\end_inset
\begin_inset Newline newline
\end_inset
\lang english
This allows for customization, using \SpecialChar TeX
Code, if you want to issue a command
that \SpecialChar LyX
does not support.
If you are using
\series bold
refstyle
\series default
, then you may want to use the
\family sans
No
\begin_inset space ~
\end_inset
Prefix
\family default
option, which will output only the part of the reference following the
\begin_inset Quotes eld
\end_inset
:
\begin_inset Quotes erd
\end_inset
separator.
This is the form needed for e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
\series bold
refstyle
\series default
's range commands.
\end_layout
\begin_layout Standard
El número y la página de la parte referida del documento es calculado automática
mente por \SpecialChar LaTeX

View File

@ -1,5 +1,5 @@
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 543
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
@ -126,6 +126,7 @@ logicalmkup
\suppress_date false
\justification true
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\branch Question
\selected 1
@ -9029,12 +9030,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
@ -9047,6 +9050,7 @@ The following 2 lines are empty:
\end_layout
\begin_layout Verbatim
Almost everything is allowed in Verbatim:"%&$§#~'`
\backslash
}][{|
@ -9079,6 +9083,7 @@ Verbatim
\end_layout
\begin_layout Verbatim*
This is Verbatim*.
\end_layout
@ -27801,7 +27806,7 @@ reference "subsec:Espace-Insécable"
\end_layout
\begin_layout Standard
Il y six variétés de références croisées:
Il y huit variétés de références croisées:
\end_layout
\begin_layout Description
@ -28077,8 +28082,18 @@ newrefformat
newref
\series default
(refstyle) au préambule du document.
Par exemple, la directive suivante redéfinit toutes les commandes aux figures
(qui sont marquées dans les étiquettes par
Par exemple, avec
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
refstyle
\end_layout
\end_inset
la directive suivante redéfinit toutes les commandes aux figures (qui sont
marquées dans les étiquettes par
\family sans
\begin_inset Quotes cld
@ -28106,8 +28121,51 @@ pageref{#1}}}
\begin_inset Newline newline
\end_inset
Pour les détails sur la gestion des mises en forme, voyez la documentation
des paquetages,
\lang english
Note that neither
\series bold
prettyref
\series default
nor
\series bold
refstyle
\series default
predefines 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
\lang french
\backslash
newrefformat{prop}{
\lang english
Proposition
\lang french
\backslash
ref{#1}}
\series default
\begin_inset Newline newline
\end_inset
Pour les détails sur
\lang english
defining formatted references
\lang french
, voyez la documentation des paquetages,
\begin_inset CommandInset citation
LatexCommand cite
key "prettyref,refstyle"
@ -28119,8 +28177,28 @@ literal "true"
\begin_inset Newline newline
\end_inset
\lang english
The options
\family sans
Plural
\family default
and
\family sans
Capitalized
\family default
will be available with formatted references only if you are using the
\series bold
refstyle
\series default
package.
\lang french
\begin_inset Newline newline
\end_inset
Voici un exemple de référence mise ne forme utilisant
\begin_inset Flex Code
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
@ -28133,7 +28211,17 @@ refstyle
\emph on
Guide de l'utilisateur
\emph default
, prettyref provoquant des erreurs en français): dans la
,
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
prettyref
\end_layout
\end_inset
provoquant des erreurs en français): dans la
\begin_inset CommandInset ref
LatexCommand formatted
reference "sec:Citation"
@ -28160,6 +28248,73 @@ reference "fig:Deux-images-déformées."
\end_layout
\begin_layout Description
\lang english
Label
\begin_inset space ~
\end_inset
only: prints only the \SpecialChar LaTeX
label for the reference:
\lang french
\begin_inset CommandInset ref
LatexCommand labelonly
reference "fig:Deux-images-déformées."
plural "false"
caps "false"
noprefix "false"
\end_inset
\lang english
\begin_inset Newline newline
\end_inset
This allows for customization, using \SpecialChar TeX
Code, if you want to issue a command
that \SpecialChar LyX
does not support.
If you are using
\series bold
refstyle
\series default
, then you may want to use the
\family sans
No
\begin_inset space ~
\end_inset
Prefix
\family default
option, which will output only the part of the reference following the
\begin_inset Quotes eld
\end_inset
:
\begin_inset Quotes erd
\end_inset
separator.
This is the form needed for e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
\series bold
refstyle
\series default
's range commands.
\end_layout
\begin_layout Standard
Le numéro affecté à une étiquette et le numéro de la page sur laquelle elle
se trouve sont calculés automatiquement par \SpecialChar LaTeX

View File

@ -1,5 +1,5 @@
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 543
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
@ -99,7 +99,7 @@ End
\use_microtype false
\use_dash_ligatures false
\graphics default
\default_output_format pdf3
\default_output_format default
\output_sync 0
\bibtex_command bibtex
\index_command default
@ -140,7 +140,8 @@ End
\paperorientation portrait
\suppress_date false
\justification false
\use_refstyle 0
\use_refstyle 1
\use_minted 0
\notefontcolor #0000ff
\branch 質問
\selected 1
@ -7175,12 +7176,14 @@ Space
\end_layout
\begin_layout Verbatim
これは原文儘(verbatim)環境です.
\end_layout
\begin_layout Verbatim
\noindent
\align block
この下の2行は空白行です
\end_layout
@ -7193,6 +7196,7 @@ Space
\end_layout
\begin_layout Verbatim
右記の各文字を始め,ほぼすべての文字が使えます.例:"%&$§#~'`
\backslash
}][{|
@ -7215,6 +7219,7 @@ Space
\end_layout
\begin_layout Verbatim*
This is Verbatim*.
\end_layout
@ -22606,6 +22611,49 @@ pageref{#1}ページにある図}}}
\begin_inset Newline newline
\end_inset
\lang english
Note that neither
\series bold
prettyref
\series default
nor
\series bold
refstyle
\series default
predefines 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
\lang japanese
\backslash
newrefformat{prop}{
\lang english
Proposition
\lang japanese
\backslash
ref{#1}
\lang english
}
\series default
\lang japanese
\begin_inset Newline newline
\end_inset
のようなコマンドを使うことができます.書式についての詳細は,パッケージ取扱説明書
\begin_inset CommandInset citation
LatexCommand cite
@ -22615,6 +22663,24 @@ literal "true"
\end_inset
をご覧ください.
\begin_inset Newline newline
\end_inset
\lang english
The options
\family sans
Plural
\family default
and
\family sans
Capitalized
\family default
will be available with formatted references only if you are using the
\series bold
refstyle
\series default
package.
\end_layout
\begin_layout Description
@ -22628,6 +22694,73 @@ reference "fig:歪められた二つの像"
のように参照のキャプションを印字します.
\end_layout
\begin_layout Description
\lang english
Label
\begin_inset space ~
\end_inset
only: prints only the \SpecialChar LaTeX
label for the reference:
\lang japanese
\begin_inset CommandInset ref
LatexCommand labelonly
reference "fig:歪められた二つの像"
plural "false"
caps "false"
noprefix "false"
\end_inset
\lang english
\begin_inset Newline newline
\end_inset
This allows for customization, using \SpecialChar TeX
Code, if you want to issue a command
that \SpecialChar LyX
does not support.
If you are using
\series bold
refstyle
\series default
, then you may want to use the
\family sans
No
\begin_inset space ~
\end_inset
Prefix
\family default
option, which will output only the part of the reference following the
\begin_inset Quotes eld
\end_inset
:
\begin_inset Quotes erd
\end_inset
separator.
This is the form needed for e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
\series bold
refstyle
\series default
's range commands.
\end_layout
\begin_layout Standard
文書中参照されている部分の出力における参照番号と参照ページ番号は,\SpecialChar LaTeX
が自動的に計算します.参照の種類は,相互参照枠をクリックすると出てくる相互参照ウィンドウの