[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Describe @-commands roles in Command List, not fo
|
From: |
Patrice Dumas |
|
Subject: |
branch master updated: Describe @-commands roles in Command List, not formatting |
|
Date: |
Wed, 20 Jul 2022 15:44:17 -0400 |
This is an automated email from the git hooks/post-receive script.
pertusus pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new 5f42bb119b Describe @-commands roles in Command List, not formatting
5f42bb119b is described below
commit 5f42bb119baeec485acb38a233b8d258118672c5
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed Jul 20 21:44:05 2022 +0200
Describe @-commands roles in Command List, not formatting
* doc/texinfo.texi (Command List): explain the role of the
@-commands, not the formatting. Avoid details on output
format specificities when it is not crucial for the understanding
of the @-command role. Move or duplicate some information to the main
nodes describing some @-commands. Update some @-commands descriptions.
(Command Contexts): explain @shortcaption context along with
@caption.
---
ChangeLog | 12 +++
doc/texinfo.texi | 253 ++++++++++++++++++++++++++-----------------------------
2 files changed, 130 insertions(+), 135 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 05ddf8a79e..12f9cb2912 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2022-20-07 Patrice Dumas <pertusus@free.fr>
+
+ Describe @-commands roles in Command List, not formatting
+
+ * doc/texinfo.texi (Command List): explain the role of the
+ @-commands, not the formatting. Avoid details on output
+ format specificities when it is not crucial for the understanding
+ of the @-command role. Move or duplicate some information to the main
+ nodes describing some @-commands. Update some @-commands descriptions.
+ (Command Contexts): explain @shortcaption context along with
+ @caption.
+
2022-20-07 Patrice Dumas <pertusus@free.fr>
No HTML features list, explain how HTML evolves
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 065449aa61..00415d1e78 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -1679,7 +1679,8 @@ from the file extension automatically.
@cindex output file name
The @code{@@setfilename} line specifies the name of the output file to
-be generated.
+be generated by @command{makeinfo}. This command is ignored
+for @TeX{} formatting.
When present, it should be the first Texinfo command (that is, after
@samp{\input texinfo}).
Write the @code{@@setfilename} command at the beginning of a line and
@@ -3111,7 +3112,7 @@ should only use after a @samp{@@node Top} line at the
beginning of a
Texinfo file.
It produces the same sort of output as @code{@@unnumbered}
-(@pxref{@code{@@unnumbered @@appendix}}).
+(@pxref{@code{@@unnumbered @@appendix}}). In @LaTeX{} @code{\part*} is used.
@code{@@top} is ignored when raising or lowering sections. That is,
it is never lowered and nothing can be raised to it
@@ -9698,7 +9699,7 @@ You can use the @code{@@dmn} command to format a
dimension with a
little extra space in the printed output. That is, on seeing
@code{@@dmn}, @TeX{} inserts just enough space for proper typesetting;
in other output formats, the formatting commands insert no space at
-all.
+all. No effect in other formats.
To use the @code{@@dmn} command, write the number and then follow it
immediately, with no intervening space, by @code{@@dmn}, and then by
@@ -19062,47 +19063,44 @@ Define @var{name} as the current location for use as
a cross-reference
target. @xref{@code{@@anchor}}.
@item @@appendix @var{title}
-Begin an appendix. The title appears in the table of contents. In
-Info, the title is underlined with asterisks.
+Begin an appendix. The title appears in the table of contents.
@xref{@code{@@unnumbered @@appendix}}.
@item @@appendixsec @var{title}
@itemx @@appendixsection @var{title}
Begin an appendix section within an appendix. The section title
-appears in the table of contents. In Info, the title is underlined
-with equal signs. @code{@@appendixsection} is a longer spelling of
-the @code{@@appendixsec} command. @xref{@code{@@unnumberedsec
-@@appendixsec @@heading}}.
+appears in the table of contents. @code{@@appendixsection} is
+a longer spelling of the @code{@@appendixsec} command.
+@xref{@code{@@unnumberedsec @@appendixsec @@heading}}.
@item @@appendixsubsec @var{title}
Begin an appendix subsection. The title appears in the table of
-contents. In Info, the title is underlined with hyphens.
-@xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
+contents. @xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
@item @@appendixsubsubsec @var{title}
Begin an appendix subsubsection. The title appears in the table of
-contents. In Info, the title is underlined with periods.
-@xref{@code{@@subsubsection}}.
+contents. @xref{@code{@@subsubsection}}.
@item @@arrow@{@}
Generate a right arrow glyph: @samp{@arrow{}}. Used by default
for @code{@@click}. @xref{Click Sequences}.
@item @@asis
+Keep the argument as is.
Used following @code{@@table}, @code{@@ftable}, and @code{@@vtable} to
print the table's first column without highlighting (``as is'').
@xref{@code{@@asis}}.
@item @@author @var{author}
-Typeset @var{author} flushleft and underline it. @xref{@code{@@title
-@@subtitle @@author}}.
+Set a manual author in the title page. @xref{@code{@@title @@subtitle
@@author}}.
+Set a quotation author in @code{@@quotation}. @xref{@code{@@quotation}}.
@item @@b@{@var{text}@}
-Set @var{text} in a @b{bold} font. No effect in Info. @xref{Fonts}.
+Set @var{text} in a @b{bold} font, if possible. @xref{Fonts}.
@item @@bullet@{@}
-Generate a large round dot, @bullet{} (@samp{*} in Info). Often used
-with @code{@@table}. @xref{@code{@@bullet}}.
+Generate a large round dot, @bullet{}, or the closest possible thing to one.
+Often used with @code{@@table}. @xref{@code{@@bullet}}.
@item @@bsixpaper
Change page dimensions for the B6 paper size. @xref{A4 Paper}.
@@ -19122,8 +19120,8 @@ Define the full caption for a @code{@@float}.
@xref{@code{@@caption
@item @@cartouche
Highlight an example or quotation by drawing a box with rounded
-corners around it. Pair with @code{@@end cartouche}. No effect in
-Info. @xref{@code{@@cartouche}}.
+corners around it, if possible. Pair with @code{@@end cartouche}.
+@xref{@code{@@cartouche}}.
@item @@center @var{line-of-text}
Center the line of text following the command.
@@ -19134,13 +19132,11 @@ Like @code{@@chapter}, but centers the chapter title.
@xref{@code{@@chapter}}.
@item @@chapheading @var{title}
Print an unnumbered chapter-like heading, but omit from the table of
-contents. In Info, the title is underlined with asterisks.
-@xref{@code{@@majorheading @@chapheading}}.
+contents. @xref{@code{@@majorheading @@chapheading}}.
@item @@chapter @var{title}
Begin a numbered chapter. The chapter title appears in the table of
-contents. In Info, the title is underlined with asterisks.
-@xref{@code{@@chapter}}.
+contents. @xref{@code{@@chapter}}.
@item @@cindex @var{entry}
Add @var{entry} to the index of concepts. @xref{Index Entries, ,
@@ -19171,7 +19167,7 @@ omitted. @xref{Click Sequences}.
@item @@code@{@var{sample-code}@}
Indicate an expression, a syntactically complete token of a program,
-or a program name. Unquoted in Info output. @xref{@code{@@code}}.
+or a program name. @xref{@code{@@code}}.
@item @@codequotebacktick @var{on-off}
@itemx @@codequoteundirected @var{on-off}
@@ -19191,8 +19187,9 @@ any output. A synonym for @code{@@c}.
@xref{Comments}.
@item @@contents
-Print a complete table of contents. Has no effect in Info, which uses
-menus instead. @xref{Contents, , Generating a Table of Contents}.
+Print a complete table of contents or specify that a table of content
+should be output, for formats that may output a table of contents.
+@xref{Contents, , Generating a Table of Contents}.
@item @@copying
Specify copyright holders and copying conditions for the document. Pair
@@ -19225,9 +19222,9 @@ Define a new index and its indexing command. Print
entries in a roman
font. @xref{New Indices, , Defining New Indices}.
@item @@definfoenclose @var{newcmd}, @var{before}, @var{after}
-Must be used within @code{@@ifinfo}; create a new command
-@code{@@@var{newcmd}} for Info that marks text by enclosing it in
-strings that precede and follow the text.
+Create a new command @code{@@@var{newcmd}} for online formats
+that marks text by enclosing it in strings that precede and
+follow the text.
@xref{@code{@@definfoenclose}}.
@item @@defivar @var{class} @var{instance-variable-name}
@@ -19352,8 +19349,7 @@ Generate the uppercase and lowercase Icelandic letter
eth, respectively:
@DH{}, @dh{}. @xref{Inserting Accents}.
@item @@dircategory @var{dirpart}
-Specify a part of the Info directory menu where this file's entry should
-go. @xref{Installing Dir Entries}.
+Specify a category for the manual. @xref{Directory Category}.
@item @@direntry
Begin the Info directory menu entry for this file. Pair with
@@ -19368,9 +19364,7 @@ fill), but do not select a new font. Pair with
@code{@@end display}.
Format a block of math in ``display'' format. @xref{Inserting Math}.
@item @@dmn@{@var{dimension}@}
-Format a unit of measure, as in 12@dmn{pt}. Causes @TeX{} to insert a
-thin space before @var{dimension}. No effect in Info.
-@xref{@code{@@dmn}}.
+Format a unit of measure, as in 12@dmn{pt}. @xref{@code{@@dmn}}.
@item @@docbook
Enter DocBook completely. Pair with @code{@@end docbook}. @xref{Raw
@@ -19404,8 +19398,7 @@ Generate an ellipsis, @samp{@dots{}}.
Indicate an electronic mail address. @xref{@code{@@email}}.
@item @@emph@{@var{text}@}
-Emphasize @var{text}, by using @emph{italics} where possible, and
-enclosing in asterisks in Info. @xref{Emphasis, , Emphasizing Text}.
+Emphasize @var{text}. @xref{Emphasis, , Emphasizing Text}.
@item @@end @var{environment}
Ends @var{environment}, as in @samp{@@end example}. @xref{Formatting
@@ -19453,7 +19446,9 @@ Info. @xref{Custom Headings, , How to Make Your Own
Headings}.
@item @@example
Begin an example. Indent text, do not fill, and select fixed-width
-font. Pair with @code{@@end example}. @xref{@code{@@example}}.
+font. Pair with @code{@@end example}. @code{@@example} accepts optional
+arguments, separated by commas. It is recommended to set the first argument to
+the language of the example code. @xref{@code{@@example}}.
@item @@exampleindent @var{indent}
Indent example-like environments by @var{indent} number of spaces
@@ -19502,14 +19497,17 @@ Change the size of the main body font in the printed
output.
@xref{Fonts}.
@item @@footnote@{@var{text-of-footnote}@}
-Enter a footnote. Footnote text is printed at the bottom of the page
-in printed output; Info may format in either `End' node or `Separate' node
style.
-@xref{Footnotes}.
+Enter a footnote, for a reference that documents or elucidates the
+primary text. Footnote text is printed at the bottom of the page
+in printed output. In other formats, footnote text can be output
+in the same node, in a separate node, or simply be marked as
+being footnote text. @xref{Footnotes}.
@item @@footnotestyle @var{style}
-Specify an Info file's footnote style, either @samp{end} for the end
-node style or @samp{separate} for the separate node style.
-@xref{Footnotes}.
+Specify a footnote style, either @samp{end} for the end
+node style or @samp{separate} for the separate style. In the
+separate style, footnotes are put in a separate node or file.
+@xref{Footnote Styles}.
@item @@format
Begin a kind of example. Like @code{@@display}, but do not indent.
@@ -19553,8 +19551,7 @@ introduce @code{#line} directive. @xref{Inserting a
Hashsign}, and
@item @@heading @var{title}
Print an unnumbered section-like heading, but omit from the table of
-contents. In Info, the title is underlined with equal signs.
-@xref{@code{@@unnumberedsec @@appendixsec @@heading}}.
+contents. @xref{@code{@@unnumberedsec @@appendixsec @@heading}}.
@item @@headings @var{on-off-single-double}
Turn page headings on or off, and/or specify single-sided or double-sided
@@ -19575,7 +19572,7 @@ Formatter Commands}.
Explicitly define hyphenation points. @xref{@code{@@- @@hyphenation}}.
@item @@i@{@var{text}@}
-Set @var{text} in an @i{italic} font. No effect in Info. @xref{Fonts}.
+Set @var{text} in an @i{italic} font, when possible. @xref{Fonts}.
@item @@ifclear @var{txivar}
If the Texinfo variable @var{txivar} is not set, format the following
@@ -19591,14 +19588,18 @@ follow text. Pair with the corresponding @code{@@end
ifcommand...}.
@item @@ifdocbook
@itemx @@ifhtml
@itemx @@ifinfo
+@itemx @@iflatex
+@itemx @@ifplaintext
+@itemx @@ifxml
Begin text that will appear only in the given output format.
@code{@@ifinfo} output appears in both Info and (for historical
compatibility) plain text output. Pair with @code{@@end ifdocbook}
-resp.@: @code{@@end ifhtml} resp.@: @code{@@end ifinfo}.
+resp.@: @code{@@end ifhtml}@enddots{}
@xref{Conditionals}.
@item @@ifnotdocbook
@itemx @@ifnothtml
+@itemx @@ifnotlatex
@itemx @@ifnotplaintext
@itemx @@ifnottex
@itemx @@ifnotxml
@@ -19612,10 +19613,6 @@ Begin text to appear in output other than Info and
(for historical
compatibility) plain text. Pair with @code{@@end ifnotinfo}.
@xref{Conditionals}.
-@item @@ifplaintext
-Begin text that will appear only in the plain text output.
-Pair with @code{@@end ifplaintext}. @xref{Conditionals}.
-
@item @@ifset @var{txivar}
If the Texinfo variable @var{txivar} is set, format the following
text. Pair with @code{@@end ifset}. @xref{@code{@@set @@clear
@@ -19623,11 +19620,7 @@ text. Pair with @code{@@end ifset}.
@xref{@code{@@set @@clear
@item @@iftex
Begin text to appear only in the @TeX{} output. Pair with @code{@@end
-iftex}. @xref{Conditionals, , Conditionally Visible Text}.
-
-@item @@ifxml
-Begin text that will appear only in the XML output. Pair with
-@code{@@end ifxml}. @xref{Conditionals}.
+iftex}. @xref{Conditionals}.
@item @@ignore
Begin text that will not appear in any output. Pair with @code{@@end
@@ -19695,7 +19688,8 @@ Begin an unordered list: indented paragraphs with a
mark, such as
Pair with @code{@@end itemize}. @xref{@code{@@itemize}}.
@item @@itemx
-Like @code{@@item} but do not generate extra vertical space above the
+Like @code{@@item} in @code{@@table}, @code{@@ftable}, and @code{@@vtable},
+but do not generate extra vertical space above the
item text. Thus, when several items have the same description, use
@code{@@item} for the first and @code{@@itemx} for the others.
@xref{@code{@@itemx}}.
@@ -19769,8 +19763,9 @@ Start a new page in a printed manual if fewer than
@var{n} mils
(thousandths of an inch) remain on the current page.
@xref{@code{@@need}}.
-@item @@node @var{name}, @var{next}, @var{previous}, @var{up}
-Begin a new node. @xref{Writing a Node}.
+@item @@node @var{name}, [@var{next}], [@var{previous}], [@var{up}]
+Begin a new node. Only the first argument is mandatory.
+@xref{Writing a Node}.
@item @@noindent
Prevent text from being indented as if it were a new paragraph.
@@ -19811,8 +19806,7 @@ Generate the feminine and masculine Spanish ordinals,
respectively:
@ordf{}, @ordm{}. @xref{Inserting Accents}.
@item @@page
-Start a new page in a printed manual. No effect in Info.
-@xref{@code{@@page}}.
+Start a new page in a printed manual. @xref{@code{@@page}}.
@item @@pagesizes [@var{width}][, @var{height}]
Change page dimensions. @xref{pagesizes}.
@@ -19824,7 +19818,7 @@ source file indentation if @var{indent} is @code{asis}.
@item @@part @var{title}
Begin a group of chapters or appendixes; included in the tables of
-contents and produces a page of its own in printed output.
+contents.
@xref{@code{@@part}}.
@item @@pindex @var{entry}
@@ -19836,7 +19830,7 @@ Indicate the position of point in a buffer to the
reader with a glyph:
@samp{@point{}}. @xref{@code{@@point}}.
@item @@pounds@{@}
-Generate the pounds sterling currency sign.
+Generate the pounds sterling currency sign, @samp{@pounds{}}.
@xref{@code{@@pounds}}.
@item @@print@{@}
@@ -19844,21 +19838,22 @@ Indicate printed output to the reader with a glyph:
@samp{@print{}}.
@xref{@code{@@print}}.
@item @@printindex @var{index-name}
-Generate the alphabetized index for @var{index-name} (using two
-columns in a printed manual). @xref{Printing Indices & Menus}.
+Generate the index for @var{index-name}. @xref{Printing Indices & Menus}.
-@item @@pxref@{@var{node}, [@var{entry}], [@var{node-title}],
[@var{info-file}], [@var{manual}]@}
-Make a reference that starts with a lowercase `see' in a printed
-manual. Use within parentheses only. Only the first argument is
-mandatory. @xref{@code{@@pxref}}.
+@item @@pxref@{@var{node}, [@var{entry}], [@var{node-title}],
[@var{info-file}], [@var{printed-manual}]@}
+Make a reference to be used within parentheses. Starts with a lowercase
+`see' in a printed manual. The first argument is mandatory, except for
+references to whole manuals. To refer to another manual as a whole,
+the @var{printed-manual} and/or the @var{info-file} are the only
+required arguments. @xref{@code{@@pxref}}.
@item @@questiondown@{@}
Generate an upside-down question mark. @xref{Inserting Accents}.
@item @@quotation
Narrow the margins to indicate text that is quoted from another work.
-Takes optional argument specifying prefix text, e.g., an author name.
-Pair with @code{@@end quotation}. @xref{@code{@@quotation}}.
+Takes optional argument specifying prefix text. Pair with @code{@@end
+quotation}. @xref{@code{@@quotation}}.
@item @@quotedblleft@{@}
@itemx @@quotedblright@{@}
@@ -19871,22 +19866,24 @@ Produce various quotation marks: @quotedblleft{}
@quotedblright{}
@xref{Inserting Quotation Marks}.
@item @@r@{@var{text}@}
-Set @var{text} in the regular @r{roman} font. No effect in Info.
+Set @var{text} in the regular @r{roman} font, if possible.
@xref{Fonts}.
@item @@raggedright
Fill text; left justify every line while leaving the right end ragged.
-Leave font as is. Pair with @code{@@end raggedright}. No effect in
-Info. @xref{@code{@@raggedright}}.
+Leave font as is. Pair with @code{@@end raggedright}.
+@xref{@code{@@raggedright}}.
@item @@raisesections
Change subsequent sections to chapters, subsections to sections, and so
on. @xref{Raise/lower sections}.
-@item @@ref@{@var{node}, [@var{entry}], [@var{node-title}], [@var{info-file}],
[@var{manual}]@}
+@item @@ref@{@var{node}, [@var{entry}], [@var{node-title}], [@var{info-file}],
[@var{printed-manual}]@}
Make a plain reference that does not start with any special text.
-Follow command with a punctuation mark. Only the first argument is
-mandatory. @xref{@code{@@ref}}.
+Follow command with a punctuation mark. The first argument is mandatory,
except for
+references to whole manuals. To refer to another manual as a whole,
+the @var{printed-manual} and/or the @var{info-file} are the only
+required arguments. @xref{@code{@@ref}}.
@item @@registeredsymbol@{@}
Generate the legal symbol @registeredsymbol{}.
@@ -19902,21 +19899,20 @@ Generate a ring accent over the next character, as in
@ringaccent{o}.
@item @@samp@{@var{text}@}
Indicate a literal example of a sequence of characters, in general.
-Quoted in Info output. @xref{@code{@@samp}}.
+@xref{@code{@@samp}}.
@item @@sansserif@{@var{text}@}
-Set @var{text} in a @sansserif{sans serif} font if possible. No
-effect in Info. @xref{Fonts}.
+Set @var{text} in a @sansserif{sans serif} font if possible.
+@xref{Fonts}.
@item @@sc@{@var{text}@}
-Set @var{text} in a small caps font in printed output, and uppercase
+Set @var{text} in a small caps font if possible, and uppercase
in Info. @xref{Smallcaps}.
@item @@section @var{title}
Begin a section within a chapter. The section title appears in the
-table of contents. In Info, the title is underlined with equal signs.
-Within @code{@@chapter} and @code{@@appendix}, the section title is
-numbered; within @code{@@unnumbered}, the section is unnumbered.
+table of contents. Within @code{@@chapter} and @code{@@appendix}, the section
+title is numbered; within @code{@@unnumbered}, the section is unnumbered.
@xref{@code{@@section}}.
@item @@set @var{txivar} [@var{string}]
@@ -19933,7 +19929,7 @@ for @TeX{} formatting. @xref{@code{@@setfilename}}.
@item @@settitle @var{title}
Specify the title for page headers in a printed manual, and the
-default document title for HTML @samp{<head>}.
+default document title for HTML.
@xref{@code{@@settitle}}.
@item @@shortcaption
@@ -19941,16 +19937,16 @@ Define the short caption for a @code{@@float}.
@xref{@code{@@caption
@@shortcaption}}.
@item @@shortcontents
-Print a short table of contents, with chapter-level entries only. Not
-relevant to Info, which uses menus rather than tables of contents.
+Print a short table of contents, with chapter-level entries only,
+or specify that a short table of contents should be output.
+For formats that may output a short table of contents.
@xref{Contents, , Generating a Table of Contents}.
@item @@shorttitlepage @var{title}
Generate a minimal title page. @xref{@code{@@titlepage}}.
@item @@slanted@{@var{text}@}
-Set @var{text} in a @slanted{slanted} font if possible. No effect
-in Info. @xref{Fonts}.
+Set @var{text} in a @slanted{slanted} font if possible. @xref{Fonts}.
@item @@smallbook
Cause to produce a printed manual in a 7 by 9.25 inch format
@@ -19996,8 +19992,7 @@ Skip @var{n} blank lines. @xref{@code{@@sp}}.
Generate the German sharp-S es-zet letter, @ss{}. @xref{Inserting Accents}.
@item @@strong @{@var{text}@}
-Emphasize @var{text} more strongly than @code{@@emph}, by using
-@strong{boldface} where possible; enclosed in asterisks in Info.
+Emphasize @var{text} more strongly than @code{@@emph}.
@xref{emph & strong, , Emphasizing Text}.
@item @@sub @{@var{text}@}
@@ -20005,33 +20000,29 @@ Set @var{text} as a subscript. @xref{Inserting
Subscripts and Superscripts}.
@item @@subheading @var{title}
Print an unnumbered subsection-like heading, but omit from the table
-of contents of a printed manual. In Info, the title is underlined
-with hyphens. @xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
+of contents of a printed manual.
+@xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
@item @@subsection @var{title}
Begin a subsection within a section. The subsection title appears in
-the table of contents. In Info, the title is underlined with hyphens.
+the table of contents.
Same context-dependent numbering as @code{@@section}.
@xref{@code{@@subsection}}.
@item @@subsubheading @var{title}
Print an unnumbered subsubsection-like heading, but omit from the
-table of contents of a printed manual. In Info, the title is
-underlined with periods. @xref{@code{@@subsubsection}}.
+table of contents of a printed manual. @xref{@code{@@subsubsection}}.
@item @@subsubsection @var{title}
Begin a subsubsection within a subsection. The subsubsection title
-appears in the table of contents. In Info, the title is underlined
-with periods. Same context-dependent numbering as @code{@@section}.
-@xref{@code{@@subsubsection}}.
+appears in the table of contents. Same context-dependent numbering as
+@code{@@section}. @xref{@code{@@subsubsection}}.
@item @@subtitle @var{title}
-In a printed manual, set a subtitle in a normal sized font flush to
-the right-hand side of the page. Not relevant to Info, which does not
-have title pages. @xref{@code{@@title @@subtitle @@author}}.
+Set a subtitle for the title page. @xref{@code{@@title @@subtitle @@author}}.
@item @@summarycontents
-Print a short table of contents. Synonym for @code{@@shortcontents}.
+Print or specify a short table of contents. Synonym for
@code{@@shortcontents}.
@xref{Contents, , Generating a Table of Contents}.
@item @@sup @{@var{text}@}
@@ -20048,8 +20039,8 @@ the second argument. Do not change the font of
@var{from-index}
entries. @xref{Combining Indices}.
@item @@t@{@var{text}@}
-Set @var{text} in a @t{fixed-width}, typewriter-like font. No effect
-in Info. @xref{Fonts}.
+Set @var{text} in a @t{fixed-width}, typewriter-like font, if possible.
+@xref{Fonts}.
@item @@tab
Separate columns in a row of a multitable. @xref{Multitable Rows}.
@@ -20082,7 +20073,7 @@ Only allowed in a heading or footing. Stands for,
respectively, the
number and name of the current chapter (in the format `Chapter 1:
Title'), the current chapter name only, the current chapter number
only, the file name, the current page number, and the title of the
-document, respectively. @xref{Custom Headings, , How to Make Your Own
+document. @xref{Custom Headings, , How to Make Your Own
Headings}.
@item @@TH@{@}
@@ -20103,19 +20094,16 @@ Add @var{entry} to the index of data types.
@xref{Index Entries, ,
Defining the Entries of an Index}.
@item @@title @var{title}
-In a printed manual, set a title flush to the left-hand side of the
-page in a larger than normal font and underline it with a black rule.
-Not relevant to Info, which does not have title pages.
-@xref{@code{@@title @@subtitle @@author}}.
+Set the title for the title page. @xref{@code{@@title @@subtitle @@author}}.
@item @@titlefont@{@var{text}@}
-In a printed manual, print @var{text} in a larger than normal font.
+Print @var{text} in a larger than normal font, if possible.
@xref{@code{@@titlefont @@center @@sp}}.
@item @@titlepage
Begin the title page. Write the command on a line of its own, paired
-with @code{@@end titlepage}. Nothing between @code{@@titlepage} and
-@code{@@end titlepage} appears in Info. @xref{@code{@@titlepage}}.
+with @code{@@end titlepage}. The title page is not output, in the
+default case, in online formats. @xref{@code{@@titlepage}}.
@item @@today@{@}
Insert the current date, in `1 Jan 1900' style. @xref{Custom
@@ -20125,8 +20113,7 @@ Headings, , How to Make Your Own Headings}.
Mark the topmost @code{@@node} in the file, which must be defined on
the line immediately preceding the @code{@@top} command. The title is
formatted as a chapter-level heading. In @TeX{} the @code{@@top}
-command is merely a synonym for @code{@@unnumbered}. In @LaTeX{}
-@code{\part*} is used.
+command is merely a synonym for @code{@@unnumbered}.
@item @@U@{@var{hex}@}
Output a representation of Unicode character U+@var{hex}.
@@ -20145,24 +20132,20 @@ Undefine the macro @code{@@@var{macroname}} if it has
been defined.
@item @@unnumbered @var{title}
Begin a chapter that appears without chapter numbers of any kind. The
-title appears in the table of contents. In Info, the title is
-underlined with asterisks. @xref{@code{@@unnumbered @@appendix}}.
+title appears in the table of contents. @xref{@code{@@unnumbered @@appendix}}.
@item @@unnumberedsec @var{title}
Begin a section that appears without section numbers of any kind. The
-title appears in the table of contents of a printed manual. In Info,
-the title is underlined with equal signs. @xref{@code{@@unnumberedsec
+title appears in the table of contents. @xref{@code{@@unnumberedsec
@@appendixsec @@heading}}.
@item @@unnumberedsubsec @var{title}
Begin an unnumbered subsection. The title appears in the table of
-contents. In Info, the title is underlined with hyphens.
-@xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
+contents. @xref{@code{@@unnumberedsubsec @@appendixsubsec @@subheading}}.
@item @@unnumberedsubsubsec @var{title}
Begin an unnumbered subsubsection. The title appears in the table of
-contents. In Info, the title is underlined with periods.
-@xref{@code{@@subsubsection}}.
+contents. @xref{@code{@@subsubsection}}.
@item @@uref@{@var{url}[, @var{displayed-text}][, @var{replacement}@}
@itemx @@url@{@var{url}[, @var{displayed-text}][, @var{replacement}@}
@@ -20208,8 +20191,7 @@ Defining the Entries of an Index}.
In a printed manual, insert whitespace so as to push text on the
remainder of the page towards the bottom of the page. Used in
formatting the copyright page with the argument @samp{0pt plus
-1filll}. (Note spelling of @samp{filll}.) @code{@@vskip} may be used
-only in contexts ignored for Info. @xref{Copyright}.
+1filll}. (Note spelling of @samp{filll}.) @xref{Copyright}.
@item @@vtable @var{formatting-command}
Begin a two-column table, using @code{@@item} for each entry.
@@ -20224,10 +20206,12 @@ Disallow line breaks within @var{text}.
@xref{@code{@@w}}.
Enter XML completely. Pair with @code{@@end xml}. @xref{Raw
Formatter Commands}.
-@item @@xref@{@var{node}, [@var{entry}], [@var{node-title}],
[@var{info-file}], [@var{manual}]@}
+@item @@xref@{@var{node}, [@var{entry}], [@var{node-title}],
[@var{info-file}], [@var{printed-manual}]@}
Make a reference that starts with `See' in a printed manual. Follow
-command with a punctuation mark. Only the first argument is
-mandatory. @xref{@code{@@xref}}.
+command with a punctuation mark. The first argument is mandatory, except for
+references to whole manuals. To refer to another manual as a whole,
+the @var{printed-manual} and/or the @var{info-file} are the only
+required arguments. @xref{@code{@@xref}}.
@item @@xrefautomaticsectiontitle @var{on-off}
By default, use the section title instead of the node name in cross
@@ -20252,10 +20236,10 @@ other such outer-level document commands, such as
@code{@@section},
@code{@@node}, and @code{@@setfilename}.
@code{@@c}, @code{@@comment} and @code{@@if ... @@end if} conditional
-commands may appear anywhere (except the conditionals must still be on
-lines by themselves). @code{@@caption} may only appear in
-@code{@@float} but may contain general text. @code{@@footnote}
-content likewise.
+commands may appear anywhere (except the conditionals must still be on lines by
+themselves). @code{@@caption} and @code{@@shortcaption} may only appear in
+@code{@@float} but may contain general text. @code{@@footnote} content
+likewise.
@@-commands with braces marking text (such as @code{@@strong},
@code{@@sc}, @code{@@asis}) may contain raw formatter commands such as
@@ -20275,8 +20259,7 @@ In addition to the above, remaining commands
(@code{@@node},
@code{@@anchor}, @code{@@printindex}, @code{@@ref}, @code{@@math},
@code{@@cindex}, @code{@@url}, @code{@@image}, and so on) cannot
contain cross-reference commands (@code{@@ref}, @code{@@xref},
-@code{@@pxref} and @code{@@inforef}). In one last addition,
-@code{@@shortcaption} may only appear inside @code{@@float}.
+@code{@@pxref} and @code{@@inforef}).
For precise and complete information, we suggest looking into the
test suite in the sources, which exhaustively tries combinations.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: Describe @-commands roles in Command List, not formatting,
Patrice Dumas <=