texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[no subject]


From: Patrice Dumas
Date: Mon, 18 Jul 2022 18:21:18 -0400 (EDT)

branch: master
commit 8fe022819e0796fa235abd9df7be3585e37bb1cf
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Tue Jul 19 00:21:02 2022 +0200

    * doc/texinfo.texi: add additional information on DocBook output.
    (Generating HTML): remove the sentence saying that DocBook and
    XML output are not described in detail, they are correctly described.
---
 ChangeLog        |  6 ++++++
 doc/texinfo.texi | 43 ++++++++++++++++++++-----------------------
 2 files changed, 26 insertions(+), 23 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 93208ddf01..47ad261a3b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2022-18-07  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texinfo.texi: add additional information on DocBook output.
+       (Generating HTML): remove the sentence saying that DocBook and
+       XML output are not described in detail, they are correctly described.
+
 2022-18-07  Patrice Dumas  <pertusus@free.fr>
 
        * doc/texinfo.texi (@command{latex2html} Customization Variables):
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index de654dbef3..11d0ea1425 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -3313,12 +3313,12 @@ Texinfo File''.  This shows a @code{@@node} line 
followed by a
 @dfn{Menus} contain pointers to subordinate nodes.  In Info output,
 you use menus to go to such nodes.  Menus can be used in HTML output
 but are not used in the default case.  Menus have no effect in printed
-manuals and do not appear in them.
+manuals and do not appear in them.  Menus are ignored in DocBook output.
 
 Menus are automatically generated by @command{texi2any} when outputting
 Info for nodes followed by a sectioning command, without menu, and with
 automatic pointers.  In a hierarchically organized manual with sectioning
-commands associated with nodes and with node pointers lefet out, you should
+commands associated with nodes and with node pointers left out, you should
 only write menus if you want to have descriptions especially formatted
 in Info.
 
@@ -4254,7 +4254,9 @@ unless it is to another manual altogether, in which case 
the
 cross-reference names that manual.  In Info, a cross-reference results
 in an entry that you can follow using the Info @samp{f} command.
 (@xref{Help-Xref,, Following cross-references, info, Info}.)  In HTML, a
-cross-reference results in an hyperlink.
+cross-reference results in an hyperlink.  In DocBook, the @code{<link>}
+element is used for cross-references unless it is to another manual,
+in which case the cross-reference names that manual.
 
 The various cross-reference commands use nodes, anchors
 (@pxref{@code{@@anchor}}) or float labels (@pxref{@code{@@float}}) to define
@@ -5743,8 +5745,7 @@ index entries.
 Use the @code{@@samp} command to indicate text that is a literal example
 or `sample' of a sequence of characters in a file, string, pattern, etc.
 Enclose the text in braces.  The argument appears within single
-quotation marks in both the Info file and the printed manual; in
-addition, it is printed in a fixed-width font.
+quotation marks; in addition, it is printed in a fixed-width font.
 
 @example
 To match @@samp@{foo@} at the end of the line,
@@ -5857,8 +5858,8 @@ Do not use @code{@@var} for environment variables either; 
@code{@@env}
 is correct for them (see the next section).
 
 The effect of @code{@@var} in the Info file is to change the case of
-the argument to all uppercase.  In the printed manual and HTML
-output, the argument is output in slanted type.
+the argument to all uppercase.  In the printed manual, the argument
+is output in slanted type.
 
 @need 700
 For example,
@@ -6225,8 +6226,9 @@ text to display (the default is the address itself).
 @cindex Mailto link
 In Info, the address is shown in angle brackets, preceded by the text
 to display if any.  In printed output, the angle brackets are omitted.  In
-HTML output, @code{@@email} produces a @samp{mailto} link that usually
-brings up a mail composition window.  For example:
+HTML and DocBook output, @code{@@email} produces a @samp{mailto} link.
+In HTML, a @samp{mailto} link usually brings up a mail composition window.
+For example:
 
 @example
 Send bug reports to @@email@{bug-texinfo@@@@gnu.org@},
@@ -6374,8 +6376,8 @@ Texinfo does not at present have commands to switch the 
font family
 to use, or more general size-changing commands.
 
 Texinfo also provides a number of font commands that specify font
-changes in the printed manual and (where possible) in the HTML output.
-They have no effect in Info.  All the commands apply to a following
+changes in the printed manual and (where possible) in the HTML and DocBook
+output.  They have no effect in Info.  All the commands apply to a following
 argument surrounded by braces.
 
 @table @code
@@ -6444,11 +6446,10 @@ produces
 @end lisp
 
 The @code{@@t} command can occasionally be useful for producing output in
-a typewriter font where that is supported (e.g., HTML and PDF), but no
-distinction with quotation marks is needed in Info or plain text.
-(Compare @code{@@t@{foo@}} producing @t{foo} with @code{@@code@{foo@}}
-producing @code{foo}.)  Here are some possible reasons for using
-@code{@@t} instead of @code{@@code}:
+a typewriter font where that is supported, but no distinction with
+quotation marks is needed in Info or plain text.  (Compare @code{@@t@{foo@}}
+producing @t{foo} with @code{@@code@{foo@}} producing @code{foo}.)  Here
+are some possible reasons for using @code{@@t} instead of @code{@@code}:
 
 @itemize @minus
 @item The argument is a single character
@@ -7172,7 +7173,7 @@ since @code{@@indent} is a command used outside of 
paragraphs
 
 In a printed manual, the @code{@@cartouche} command draws a box with
 rounded corners around its contents.  In HTML, a normal rectangle is
-drawn.  @code{@@cartouche} has no effect in Info output.
+drawn.  @code{@@cartouche} has no effect in Info and DocBook output.
 
 You can use this command to further highlight an example or quotation.
 For instance, you could write a manual in which one type of example is
@@ -7225,10 +7226,10 @@ Texinfo has ``small'' example-style commands.  These are
 @code{@@smalldisplay}, @code{@@smallexample}, @code{@@smallformat},
 and @code{@@smalllisp}.
 
-In Info and HTML output, the @code{@@small@dots{}} commands are 
+In Info, HTML and DocBook output, the @code{@@small@dots{}} commands are
 equivalent to their non-small companion commands.
 
-In printes output, however, the @code{@@small@dots{}} commands typeset text in
+In printed output, however, the @code{@@small@dots{}} commands typeset text in
 a smaller font than the non-small example commands.  Thus, for
 instance, code examples can contain longer lines and still fit on a
 page without needing to be rewritten.
@@ -18055,10 +18056,6 @@ other programs.  This chapter gives some details on 
such HTML output.
 with which you can influence the HTML output.  @xref{Customization
 Variables}.
 
-@command{makeinfo} can also produce output in XML and DocBook formats,
-but we do not as yet describe these in detail.  @xref{Output Formats},
-for a brief overview of all the output formats.
-
 @menu
 * HTML Translation::       Details of the HTML output.
 * HTML Splitting::         How HTML output is split.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]