[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: Edits to manual
From: |
Gavin D. Smith |
Subject: |
branch master updated: Edits to manual |
Date: |
Mon, 01 Apr 2024 17:23:02 -0400 |
This is an automated email from the git hooks/post-receive script.
gavin pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new 4876420cf6 Edits to manual
4876420cf6 is described below
commit 4876420cf63d74d7dda610b5752290a6fbe4c183
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Mon Apr 1 22:20:31 2024 +0100
Edits to manual
* doc/texinfo.texi (HTML Output Advanced Customization)
(HTML Output Structure Customization)
(File Names and Links Customization for HTML)
(Customization of Navigation and Headers)
(General Customization of HTML Code)
(Specific Customization of HTML Formatting):
Refer to the user of the program as "you" in many places in order
to be clearer as to semantic agency.
---
ChangeLog | 14 +++++++++++++
doc/texinfo.texi | 63 ++++++++++++++++++++++++++++----------------------------
2 files changed, 46 insertions(+), 31 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 98e957363e..25db4bfec9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2024-04-01 Gavin Smith <gavinsmith0123@gmail.com>
+
+ Edits to manual
+
+ * doc/texinfo.texi (HTML Output Advanced Customization)
+ (HTML Output Structure Customization)
+ (File Names and Links Customization for HTML)
+ (Customization of Navigation and Headers)
+ (General Customization of HTML Code)
+ (Specific Customization of HTML Formatting):
+
+ Refer to the user of the program as "you" in many places in order
+ to be clearer as to semantic agency.
+
2024-04-01 Patrice Dumas <pertusus@free.fr>
* doc/texinfo.texi: update internal references to use more the new
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 9223f879a0..39a3ef5e06 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -18441,7 +18441,7 @@ usual. You can get the latest version from
@node HTML Output Advanced Customization
@section HTML Output Advanced Customization
-Many user-definable customization variables can influence
+You can use many user-definable customization variables to influence
the HTML output. @xref{HTML Customization Variables List} for the full list.
The possibility offered by the customization variables, ranging from
overall document structure or HTML language variant to specific
@@ -18449,7 +18449,7 @@ constructs formatting should cover most needs not
already satisfied
by CSS customization (@pxref{HTML CSS}).
If more control is ever needed, it needs to be achieved through the use of
-initialization files, which is described in a separate manual (@pxref{,,,
+initialization files, which are described in a separate manual (@pxref{,,,
texi2any_api, GNU Texinfo @command{texi2any} Output Customization}).
@@ -18467,8 +18467,8 @@ setting @code{NO_TOP_NODE_OUTPUT} also sets
@code{SHOW_TITLE} to
output a title at the beginning of the document. In the default case
the full @code{@@titlepage} is used for the title, unset
@code{USE_TITLEPAGE_FOR_TITLE} to get a simple title string.
-If @code{SHOW_TITLE} is set, it is possible to output the table of contents
-at the end of the title by setting @code{CONTENTS_OUTPUT_LOCATION} to
+If @code{SHOW_TITLE} is set, you can have the table of contents
+output after the title by setting @code{CONTENTS_OUTPUT_LOCATION} to
@samp{after_title}.
@vindex CONTENTS_OUTPUT_LOCATION
@@ -18486,16 +18486,16 @@ needed at the end of the @code{@@top} section as
there should already be a master menu (@pxref{Master Menu Parts}).
To output the table of contents at the end of the document or to a separate
file, if output is split, set @code{CONTENTS_OUTPUT_LOCATION}
-to @samp{separate_element}. It is also possible to set
+to @samp{separate_element}. You can also set
@code{CONTENTS_OUTPUT_LOCATION} to @samp{inline}, in that case the
the tables of content are output where
the corresponding @@-command, for example @code{@@contents}, is set.
-If menus and subordinate sections list for navigation are not desired,
-set @code{FORMAT_MENU} to @samp{nomenu}.
+If you do not desire menus and subordinate sections list for navigation
+to be output, set @code{FORMAT_MENU} to @samp{nomenu}.
@vindex DO_ABOUT
-A special @dfn{About} element explaining how to navigate can be added by
+You can add a special @dfn{About} element explaining how to navigate by
setting @code{DO_ABOUT}, set to 0 in the default case (no About element).
@vindex MONOLITHIC
@@ -18508,7 +18508,7 @@ already described, the table of contents location may
also be tuned with
@vindex INFO_JS_DIR
@cindex JavaScript browsing interface for HTML
-An experimental JavaScript browsing interface to the manual can be added, by
+You can add an experimental JavaScript browsing interface to the manual by
setting @code{INFO_JS_DIR} value to the directory to place the code for this
interface as e.g.@: @samp{texi2any --html -c INFO_JS_DIR=js @var{manual}.texi}
to place files in a @samp{js} directory under the output. This provides some
@@ -18553,13 +18553,13 @@ have the node name used as heading in that case, set
@vindex SUBDIR
@vindex EXTENSION
@vindex CASE_INSENSITIVE_FILENAMES
-It is possible to specify the output file names with more control than
+You can specify the output file names with more control than
merely the command line option @option{--output} (@pxref{Invoking
@command{texi2any}}). The @code{PREFIX} customization
variable overrides the base name of the file given by @code{@@setfilename} or
the file name and should not contain any directory components. To alter
intermediate directories, use the @code{SUBDIR} customization variable.
-Finally, the extension may also be overriden by the customization variable
+Finally, you may also override the extension with the customization variable
@code{EXTENSION}. This variable should be @code{undef} if no extension is to
be added. If @code{CASE_INSENSITIVE_FILENAMES} is set, file names are
constructed as if the filesystem were case insensitive. In that case,
@@ -18680,10 +18680,11 @@ be relevant, for example, if you know that no manual
is installed locally.
@vindex HTMLXREF_FILE
@vindex EXTERNAL_CROSSREF_SPLIT
@cindex HTML cross-references @subentry configuration customization
-Customization variables can specify more precisely the HTML Xref Configuration.
+You can use customization variables to specify the HTML Xref
+Configuration more precisely.
In the default case, the file name used for HTML Xref configuration
is searched for in directories, and all the files found are used.
-The @code{HTMLXREF_MODE} customization variable can be set to modify how
+You can set the @code{HTMLXREF_MODE} customization variable to modify how
cross-references to other manuals information is determined.
If @code{HTMLXREF_MODE} is set to @samp{file}, the file name is directly used
as the source of information. If @code{HTMLXREF_MODE} is set to @samp{none}
@@ -18696,7 +18697,7 @@ being output. It is possible to set it explicitely,
instead, with
@code{EXTERNAL_CROSSREF_SPLIT}.
@cindex Cross-references customization, in HTML
-It also is possible to set customization variables to modify how
+You can also set customization variables to modify how
cross-references are output in various other ways. In general, this will make
cross-manual references ``invalid'', in the sense that the generated URL will
not link to the external manual, unless this manual was itself produced using
@@ -18722,8 +18723,8 @@ base file name is changed by setting
@code{BASEFILENAME_LENGTH}.
@subsection Customization of Navigation and Headers
@vindex HEADERS
-Headers with a navigation panel are output in the default case. if
-@option{--no-headers} is used or the customization variable @code{HEADERS}
+Headers with a navigation panel are output in the default case. If you
+use @option{--no-headers}, or if the customization variable @code{HEADERS}
is unset, the navigation bar is only inserted at the beginning of
split files.
@@ -18780,26 +18781,26 @@ If set, a vertical navigation panel is used.
@cindex Initialization file, HTML icon direction buttons
@vindex ACTIVE_ICONS
@vindex PASSIVE_ICONS
-Setting @code{ICONS} is necessary but not sufficient to get icons for direction
-buttons since no button image is specified in the default case.
-The @code{ACTIVE_ICONS} and @code{PASSIVE_ICONS} customization
-variables need to be set in addition. This requires using an
-initialization file (@pxref{Invoking @command{texi2any}}).
+Setting @code{ICONS} is necessary but not sufficient to get icons
+for direction buttons, since no button image is specified in the
+default case. In addition, you need to set the @code{ACTIVE_ICONS}
+and @code{PASSIVE_ICONS} customization variables. You can only do this
+using an initialization file (@pxref{Invoking @command{texi2any}}).
@xref{,,, texi2any_api, GNU Texinfo @command{texi2any} Output Customization}.
@node General Customization of HTML Code
@subsection General Customization of HTML Code
-The generated HTML code may be modified in two way. Firstly by specifying
-broad features of the generated HTML and secondly by inserting
-some HTML code in a few specific places.
+You can modify the generated HTML code in two ways. Firstly by specifying
+broad features of the generated HTML, and secondly by specifying HTML code
+to be inserted in specific places in the output.
@vindex USE_XML_SYNTAX
@cindex DOCTYPE customization
@vindex DOCTYPE
-In the default case, HTML is generated, but it is also possible to
-generate XML compatible code, by setting @code{USE_XML_SYNTAX}. The main
+In the default case, HTML is generated, but you can set
+@code{USE_XML_SYNTAX} in order to generate XML compatible code. The main
difference is that @samp{/>} instead of @samp{>} closes elements with an
opening element, but no closing element, such as @code{<img>} or @code{<link>}
(also called @dfn{void elements}).
@@ -18821,9 +18822,9 @@ the output encoding instead of entities.
@vindex NO_CUSTOM_HTML_ATTRIBUTE
In the default case, a custom attribute, as allowed by the standard, is
used to provide the target manual name in cross-references.
-If it is not desirable, for example to generate strict XHTML, it is
-possible to set @code{NO_CUSTOM_HTML_ATTRIBUTE} to prevent custom attributes to
-be output.
+If it is not desirable, for example to generate strict XHTML, you can
+set @code{NO_CUSTOM_HTML_ATTRIBUTE} to prevent custom attributes being
+output.
@vindex DEFAULT_RULE
@vindex BIG_RULE
@@ -18855,7 +18856,7 @@ You can define the variable @code{EXTRA_HEAD} to add
text within the
@code{AFTER_BODY_OPEN} is added just after @code{<body>} is output.
These variables are empty by default.
@cindex @code{<body>} tag, attributes of
-The @code{<body>} element attributes may be set by defining the
+You can set the @code{<body>} element attributes by defining the
customization variable @code{BODYTEXT}.
@vindex PRE_BODY_CLOSE
@@ -18937,7 +18938,7 @@ default @samp{4}.
@c Menu Options for the output of @@menu, as well as indices.
@c Output of other constructs
-The appearance of various constructs may be modified by setting:
+You may modify the appearance of various constructs by setting:
@vtable @code
@item DEF_TABLE
If set, a @code{<table>} construction for @code{@@deffn}
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: Edits to manual,
Gavin D. Smith <=