[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Describe formatting of chapter structuring comman
From: |
Patrice Dumas |
Subject: |
branch master updated: Describe formatting of chapter structuring commands only once |
Date: |
Sat, 20 Aug 2022 15:57:13 -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 8ece56925d Describe formatting of chapter structuring commands only
once
8ece56925d is described below
commit 8ece56925d09c09ac2899e09c9d724e9d53657db
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Aug 20 21:56:06 2022 +0200
Describe formatting of chapter structuring commands only once
* doc/texinfo.texi (Structuring Command Types, @code{@@chapter})
(@code{@@section}, @code{@@subsection}, @code{@@subsubsection}):
describe the formatting of all the chapter structuring commands
in 'Structuring Command Types' and try to be somewhat less precise.
(@code{@@subsubsection}): fix section title.
---
ChangeLog | 11 ++++++
doc/texinfo.texi | 102 ++++++++++++++++---------------------------------------
2 files changed, 41 insertions(+), 72 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 2054b752b1..29773c4ade 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -6,6 +6,17 @@
Do not override any active definitions for ASCII characters.
Broken output for hyphen reported by Werner.
+2022-08-20 Patrice Dumas <pertusus@free.fr>
+
+ Describe formatting of chapter structuring commands only once
+
+ * doc/texinfo.texi (Structuring Command Types, @code{@@chapter})
+ (@code{@@section}, @code{@@subsection}, @code{@@subsubsection}):
+ describe the formatting of all the chapter structuring commands
+ in 'Structuring Command Types' and try to be somewhat less precise.
+
+ (@code{@@subsubsection}): fix section title.
+
2022-08-20 Patrice Dumas <pertusus@free.fr>
Document that input and output file names should only be ASCII
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index b8c0e70770..b96cf22d37 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -3822,11 +3822,37 @@ with nodes, and cannot be cross-referenced. These
heading commands
never start a new page.
@end itemize
-When a @code{@@setchapternewpage} command says to do so, the
+In printed output, the chapter structuring commands produce a heading
+in the document. When a @code{@@setchapternewpage} command says to do so, the
@code{@@chapter}, @code{@@unnumbered}, and @code{@@appendix} commands
start new pages in the printed manual; the @code{@@heading} commands
do not. @xref{@code{@@setchapternewpage}}.
+In Info and plain text output, the command cause the
+title to appear on a line by itself, with a line of an ASCII character
+(@samp{*}, @samp{=}, @dots{}) inserted
+underneath. The underlining character is the same for all the commands
+at the same level. For instance, they are the same for the chapter-level
commands
+@code{@@chapter}, @code{@@apppendix}, @code{@@unnumbered} and
+@code{@@chapheading}. For example, the ``Chapter Structuring'' heading could
be:
+
+@example
+@group
+5 Chapter Structuring
+*********************
+@end group
+@end example
+
+In HTML, the chapter-level commands produce an @code{<h2>}-level
+header by default (controlled by the @code{CHAPTER_HEADER_LEVEL}
+customization variable, @pxref{Other Customization Variables}).
+The heading element level is adjusted for the other commands.
+
+In the XML and DocBook output, the appropriate element is produced
+that includes all the following sections, up to the next command
+at the same level. For example, a @code{<chapter>} element is produced
+for @code{@@chapter}.
+
Here is a summary:
@tex
@@ -3868,26 +3894,6 @@ looks like this:
@@chapter Chapter Structuring
@end example
-In printed output, the @code{@@chapter} command produces a chapter heading in
-the document.
-
-In Info and plain text output, the @code{@@chapter} command causes the
-title to appear on a line by itself, with a line of asterisks inserted
-underneath. So, the above example produces the following output:
-
-@example
-@group
-5 Chapter Structuring
-*********************
-@end group
-@end example
-
-In HTML, the @code{@@chapter} command produces an @code{<h2>}-level
-header by default (controlled by the @code{CHAPTER_HEADER_LEVEL}
-customization variable, @pxref{Other Customization Variables}).
-
-In the XML and DocBook output, a @code{<chapter>} element is produced
-that includes all the following sections, up to the next chapter.
@node @code{@@unnumbered @@appendix}
@@ -3973,31 +3979,17 @@ command. Thus, within a @code{@@chapter} chapter
numbered `1', the
sections are numbered `1.1', `1.2', etc.; within an @code{@@appendix}
``chapter'' labeled `A', the sections are numbered `A.1', `A.2', etc.;
within an @code{@@unnumbered} chapter, the section gets no number.
-The output is underlined with @samp{=} in Info and plain text.
To make a section, write the @code{@@section} command at the
beginning of a line and follow it on the same line by the section
-title. For example,
+title. For example:
@example
@@section This is a section
@end example
-@noindent
-might produce the following in Info:
-
-@example
-@group
-5.7 This is a section
-=====================
-@end group
-@end example
-
Section titles are listed in the table of contents.
-The printed output, HTML, DocBook, and XML output is all analogous to the
-chapter-level output, just ``one level down''; @pxref{@code{@@chapter}}.
-
@node @code{@@unnumberedsec @@appendixsec @@heading}
@section @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}
@@ -4050,29 +4042,14 @@ etc., are not allowed.
@findex subsection
Subsections are to sections as sections are to chapters;
-@pxref{@code{@@section}}. In Info and plain text, subsection titles
-are underlined with @samp{-}. For example,
+@pxref{@code{@@section}}. For example:
@example
@@subsection This is a subsection
@end example
-@noindent
-might produce
-
-@example
-@group
-1.2.3 This is a subsection
---------------------------
-@end group
-@end example
-
Subsection titles are listed in the table of contents.
-The printed output, HTML, DocBook, and XML output is all analogous to the
-chapter-level output, just ``two levels down'';
-@pxref{@code{@@chapter}}.
-
@node @code{@@unnumberedsubsec @@appendixsubsec @@subheading}
@section The @code{@@subsection}-like Commands
@@ -4105,7 +4082,7 @@ underlined with hyphens.
@node @code{@@subsubsection}
-@section @code{@@subsection} and Other Subsub Commands
+@section @code{@@subsubsection} and Other Subsub Commands
@anchor{subsubsection}@c old name
@findex subsubsection
@@ -4144,25 +4121,6 @@ circumstances, because @code{@@subsubsection} may also
be used within
subsections of @code{@@unnumbered} and @code{@@appendix} chapters
(@pxref{@code{@@section}}).
-In Info, `subsub' titles are underlined with periods. For example,
-
-@example
-@@subsubsection This is a subsubsection
-@end example
-
-@noindent
-might produce
-
-@example
-@group
-1.2.3.4 This is a subsubsection
-...............................
-@end group
-@end example
-
-The printed output, HTML, DocBook, and XML output is all analogous to the
-chapter-level output, just ``three levels down''; @pxref{@code{@@chapter}}.
-
@node @code{@@part}
@section @code{@@part}: Groups of Chapters
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: Describe formatting of chapter structuring commands only once,
Patrice Dumas <=