diff options
| author | Eli Zaretskii | 2020-10-17 14:43:25 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2020-10-17 14:43:25 +0300 |
| commit | 18c0e20bea07cf4591b45800205cf25a927045f6 (patch) | |
| tree | 5684fcdd15819f68dce1510b8b64fa5bb5570658 | |
| parent | 47b8a1c7672608f220c3e0d7f6cedc63e6f63386 (diff) | |
| download | emacs-18c0e20bea07cf4591b45800205cf25a927045f6.tar.gz emacs-18c0e20bea07cf4591b45800205cf25a927045f6.zip | |
Improve documentation of 'Info-hide-note-references' in info.texi
* doc/misc/info.texi (Help-Xref): Improve the wording.
(Emacs Info Variables): Update the documentation of
'Info-hide-note-references'. (Bug#44043)
| -rw-r--r-- | doc/misc/info.texi | 42 |
1 files changed, 25 insertions, 17 deletions
diff --git a/doc/misc/info.texi b/doc/misc/info.texi index f3ab305e350..85e04a99608 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi | |||
| @@ -798,17 +798,17 @@ in cross references and node names if it differs from the current | |||
| 798 | file, so you can always know that you are going to be switching to | 798 | file, so you can always know that you are going to be switching to |
| 799 | another manual and which one. | 799 | another manual and which one. |
| 800 | 800 | ||
| 801 | However, Emacs normally hides some other text in cross-references. | 801 | Emacs normally hides some text in cross references. If you put your |
| 802 | If you put your mouse over the cross reference, then the information | 802 | mouse over the cross reference, then the information appearing in a |
| 803 | appearing in a separate box (tool tip) or in the echo area will show | 803 | separate box (tool tip) or in the echo area will show the full |
| 804 | the full cross-reference including the file name and the node name of | 804 | cross reference, including the file name and the node name of the |
| 805 | the cross reference. If you have a mouse, just leave it over the | 805 | cross reference if it leads to another file. If you have a mouse, |
| 806 | cross reference @xref{Top,, Overview of Texinfo, texinfo, Texinfo: | 806 | just leave it over the next cross reference: @xref{Top,, Overview of |
| 807 | The GNU Documentation Format}, and watch what happens. If you | 807 | Texinfo, texinfo, Texinfo: The GNU Documentation Format}, and watch |
| 808 | always like to have that information visible without having to move | 808 | what happens. If you always like to have that information visible |
| 809 | your mouse over the cross reference, use @kbd{M-x visible-mode}, or | 809 | without having to move your mouse over the cross reference, use |
| 810 | set @code{Info-hide-note-references} to a value other than @code{t} | 810 | @kbd{M-x visible-mode}, or set @code{Info-hide-note-references} to a |
| 811 | (@pxref{Emacs Info Variables}). | 811 | value other than @code{t} (@pxref{Emacs Info Variables}). |
| 812 | 812 | ||
| 813 | @format | 813 | @format |
| 814 | >> Now type @kbd{n} to learn more commands. | 814 | >> Now type @kbd{n} to learn more commands. |
| @@ -1227,12 +1227,20 @@ not scroll with the rest of the buffer, making these links always | |||
| 1227 | visible. | 1227 | visible. |
| 1228 | 1228 | ||
| 1229 | @item Info-hide-note-references | 1229 | @item Info-hide-note-references |
| 1230 | As explained in earlier nodes, the Emacs version of Info normally | 1230 | As explained in earlier sections, the Emacs version of Info normally |
| 1231 | hides some text in menus and cross-references. You can completely | 1231 | hides some text in menus and cross references. It also replaces the |
| 1232 | disable this feature, by setting this option to @code{nil}. Setting | 1232 | @samp{*note} prefix of each cross reference with a more grammatically |
| 1233 | it to a value that is neither @code{nil} nor @code{t} produces an | 1233 | correct @samp{see}. This is the effect of the default value of this |
| 1234 | intermediate behavior, hiding a limited amount of text, but showing | 1234 | option, @code{t}. Setting this option to @code{nil} disables both |
| 1235 | all text that could potentially be useful. | 1235 | hiding and replacing of the original cross reference text, and Emacs |
| 1236 | will then display them as they are in the Info file. If you set it to | ||
| 1237 | the value @code{hide}, Emacs will do the same as with @code{t}, but | ||
| 1238 | will also remove @samp{*note} without replacing it with anything. | ||
| 1239 | Setting it to any other non-@code{nil} value produces an intermediate | ||
| 1240 | behavior, hiding a limited amount of text, but showing all text that | ||
| 1241 | could potentially be useful, including the name of the node that is | ||
| 1242 | the target of the cross reference and its file if it is different from | ||
| 1243 | the current file. | ||
| 1236 | 1244 | ||
| 1237 | @item Info-scroll-prefer-subnodes | 1245 | @item Info-scroll-prefer-subnodes |
| 1238 | If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or | 1246 | If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or |