[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[no subject]
From: |
Patrice Dumas |
Date: |
Tue, 26 Dec 2023 12:53:13 -0500 (EST) |
branch: master
commit ebcebbf00d452adbff302f8189796966ba8920c0
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Tue Dec 26 11:56:29 2023 +0100
* * doc/texi2any_api.texi: do not use Perl tree as it could also be a
tree in C. Other misc changes.
---
ChangeLog | 5 +++++
doc/texi2any_api.texi | 17 +++++++++--------
2 files changed, 14 insertions(+), 8 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 032e07ead7..e801a4a200 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -8,6 +8,11 @@
* tp/Texinfo/Convert/Plaintext.pm (_align_lines):
Remove unused variable.
+2023-12-26 Patrice Dumas <pertusus@free.fr>
+
+ * * doc/texi2any_api.texi: do not use Perl tree as it could also be a
+ tree in C. Other misc changes.
+
2023-12-26 Patrice Dumas <pertusus@free.fr>
* doc/texi2any_api.texi (Conversion Customization Variables):
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index e138ca1a60..9b7c243007 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -67,14 +67,14 @@ available for HTML.
The conversion of Texinfo to HTML is done in two steps. After reading
command-line options and init files, input Texinfo code is parsed
-into a Texinfo Perl tree and information is gathered on the document
+into a Texinfo tree and information is gathered on the document
structure. This first step can only be customized to a certain extent, by
using the command-line options and setting customization variables. The
-Texinfo Perl tree describes a Texinfo document in a structured way which makes
+Texinfo tree describes a Texinfo document in a structured way which makes
it easy to go through the tree and format @@-commands and other containers.
The second step is the @dfn{conversion} step done in a converter. The HTML
-converter takes a Texinfo Perl tree as input and transforms it to HTML@. The
+converter takes a Texinfo tree as input and transforms it to HTML@. The
code that is used to go through the tree cannot be customized, but the
conversion of tree elements can be fully customized.
@@ -506,7 +506,7 @@ for @code{@@-} in normal, preformatted (and math) and
string context, call
texinfo_register_no_arg_command_formatting('-', undef, '­');
@end example
-If you want @code{<small>...</small>} to be output for @code{@@enddots}
+If you want ``@code{<small>...</small>}'' to be output for @code{@@enddots}
in normal context and @code{...} to be output in other contexts, call
@example
texinfo_register_no_arg_command_formatting('enddots',
@@ -515,7 +515,7 @@ texinfo_register_no_arg_command_formatting('enddots',
'preformatted', '...');
@end example
-If you want @code{error-->} to be used for @code{@@error} in every context,
+If you want ``@code{error-->}'' to be used for @code{@@error} in every
context,
with a translation when the document language changes, call
@example
@@ -523,7 +523,7 @@ texinfo_register_no_arg_command_formatting('error', undef,
undef, undef,
'error-->');
@end example
-If you want @code{is the @strong{same} as} to be used for @code{@@equiv},
+If you want ``@code{is the @strong{same} as}'' to be used for @code{@@equiv},
translated when the document language changes, and converted from Texinfo to
HTML in the context of the translation, call
@example
@@ -1322,11 +1322,12 @@ to a hash and @code{\&function} for a reference on a
function.
To illustrate these conventions, here is the prototype for the
function associated with @samp{format_thing}:
-@deftypefn {Function Reference} @var{$text} format_thing (@var{$arg1},
@var{\@@arg2})
+@defblock
+@defline {Function Reference} @var{$text} format_thing (@var{$arg1},
@var{\@@arg2})
A function reference associated with @samp{format_thing} has a first argument
@var{$arg1}, a second argument a reference to an array @var{\@@arg2}, and
returns the formatted text @var{$text}.
-@end deftypefn
+@end defblock
@node Converter Object and Conversion Functions