[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi doc/refcard/t...
|
From: |
karl |
|
Subject: |
texinfo ChangeLog doc/texinfo.txi doc/refcard/t... |
|
Date: |
Sun, 27 Jan 2013 19:10:06 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: karl <karl> 13/01/27 19:10:06
Modified files:
. : ChangeLog
doc : texinfo.txi
doc/refcard : txivarcheck
Log message:
new TEXINFO_OUTPUT_FORMAT custvar; split HTML vars
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1531&r2=1.1532
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.534&r2=1.535
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/refcard/txivarcheck?cvsroot=texinfo&r1=1.3&r2=1.4
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1531
retrieving revision 1.1532
diff -u -b -r1.1531 -r1.1532
--- ChangeLog 27 Jan 2013 17:34:30 -0000 1.1531
+++ ChangeLog 27 Jan 2013 19:10:04 -0000 1.1532
@@ -1,5 +1,12 @@
2013-01-27 Karl Berry <address@hidden>
+ * doc/texinfo.txi (HTML Customization Variables): split node
+ out from Other Cust Var.
+ (Other Customization Variables): new TEXINFO_OUTPUT_FORMAT
+ replaces the individual special-output-format variables.
+ * doc/refcard/txivarcheck: only check uppercase
+ variable names, and do output manual-only names.
+
* man/pod2texi.1: new file, made with pod2man.
* man/Makefile.am (man_MANS): add it.
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.534
retrieving revision 1.535
diff -u -b -r1.534 -r1.535
--- doc/texinfo.txi 26 Jan 2013 15:14:38 -0000 1.534
+++ doc/texinfo.txi 27 Jan 2013 19:10:04 -0000 1.535
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.534 2013/01/26 15:14:38 karl Exp $
address@hidden $Id: texinfo.txi,v 1.535 2013/01/27 19:10:04 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -604,7 +604,6 @@
Customization Variables
-* Behavior: Customization Variables for Program Behavior.
* Commands: Customization Variables for @@-Commands.
* Options: Customization Variables and Options.
* Other: Other Customization Variables.
@@ -17313,6 +17312,10 @@
If not set or otherwise specified, Info output is the default.
+The customization variable of the same name is also read; if set, that
+overrides an environment variable setting, but not a command-line
+option. @xref{Customization Variables for @@-Commands}.
+
@node @t{texi2any} Printed Output
@section @command{texi2any} Printed Output
@@ -17423,19 +17426,14 @@
@itemize @bullet
@item
-Those changing fundamental program behavior; for example, set
address@hidden to output the text content only, stripped of
-commands. As these variables set the expanded format, they will only
-have an effect when set on the command line.
-
address@hidden
Those associated with @@-commands; for example,
@code{@@documentlanguage}.
@item
Those associated with command-line options; for example, the
customization variable @code{SPLIT} is associated with the
address@hidden command-line option.
address@hidden command-line option, and @code{TEXINFO_OUTPUT_FORMAT}
+allows specifying the output format.
@item
Other ad hoc variables.
@@ -17451,63 +17449,13 @@
The sections below give the details for each of these.
@menu
-* Behavior: Customization Variables for Program Behavior.
* Commands: Customization Variables for @@-Commands.
* Options: Customization Variables and Options.
+* HTML: HTML Customization Variables.
* Other: Other Customization Variables.
@end menu
address@hidden Customization Variables for Program Behavior
address@hidden Customization Variables for Program Behavior
address@hidden Customization variables for program behavior
address@hidden Program behavior, customization variables for
-
address@hidden @code
address@hidden DEBUGCOUNT
-Instead of generating a regular output format, output the count of
-bytes and lines obtained when converting to Info, and other information.
-
address@hidden DEBUGTREE
address@hidden tree representation, for debugging
address@hidden debugging document, with tree representation
-Instead of generating a regular output format, output a text representation
-of the tree obtained by parsing the input texinfo document.
-
address@hidden PLAINTEXINFO
-Output the Texinfo source with all the macros, @code{@@include} and
address@hidden@@address@hidden@}} expanded. This is similar to setting
address@hidden, but instead of being output in addition to
-the normal conversion, output of Texinfo is the main output.
-
address@hidden RAWTEXT
address@hidden raw text output
-Output raw text, with minimal formatting. For example, footnotes are
-ignored and there is no paragraph filling. This is used by the parser
-for file names and copyright text in HTML comments, for example.
-
address@hidden TEXINFOSXML
address@hidden SXML output
address@hidden S-expressions, output format
-Output the document in TexinfoSXML representation, a syntax for
-writing XML data using Lisp S-expressions.
-
address@hidden TEXTCONTENT
address@hidden spell checking
address@hidden word counting
address@hidden detexinfo
address@hidden stripping Texinfo commands
-Output the text content only, stripped of commands; this is useful for
-spell checking or word counting, for example. The trivial
address@hidden script setting this is in the @file{util} directory
-of the Texinfo source as an example. It's one line:
-
address@hidden
-exec texi2any --set-customization-variable TEXTCONTENT=1 "$@@"
address@hidden example
address@hidden vtable
-
-
@node Customization Variables for @@-Commands
@subsection Customization Variables for @@-Commands
@@ -17520,13 +17468,17 @@
@smallexample
@@allowcodebreaks @@clickstyle @@codequotebacktick
@@codequoteundirected @@contents @@deftypefnnewline
-@@documentdescription
-@@documentencoding @@documentlanguage
-@@evenfootingmarks @@evenheadingmarks @@everyfootingmarks
-@@everyheadingmarks @@exampleindent @@firstparagraphindent
+@@documentdescription @@documentencoding @@documentlanguage
+@@evenfooting @@evenfootingmarks
+@@evenheading @@evenheadingmarks
+@@everyfooting @@everyfootingmarks
+@@everyheading @@everyheadingmarks
+@@exampleindent @@firstparagraphindent
@@fonttextsize @@footnotestyle @@frenchspacing @@headings
-@@kbdinputstyle @@novalidate @@oddfootingmarks
-@@oddheadingmarks @@pagesizes @@paragraphindent
+@@kbdinputstyle @@novalidate
+@@oddfooting @@oddfootingmarks
+@@oddheading @@oddheadingmarks
+@@pagesizes @@paragraphindent
@@setchapternewpage @@setcontentsaftertitlepage
@@setfilename
@@setshortcontentsaftertitlepage @@shortcontents
@@ -17605,9 +17557,76 @@
essentially the same as specifying the @address@hidden if the
option takes an argument, or @address@hidden if not.
address@hidden TEXINFO_OUTPUT_FORMAT
+In addition, the customization variable @code{TEXINFO_OUTPUT_FORMAT}
+allows specifying what @code{makeinfo} outputs, either one of the usual
+output formats that can be specified with options, or various other
+forms:
+
address@hidden @samp
address@hidden docbook
address@hidden dvi
address@hidden dvipdf
address@hidden html
address@hidden info
address@hidden pdf
address@hidden plaintext
address@hidden ps
address@hidden xml
+These correspond to the command-line options (and
address@hidden environment variable values) of the same
+name. @xref{Invoking @t{texi2any}}.
+
address@hidden debugcount
+Instead of generating a regular output format, output the count of
+bytes and lines obtained when converting to Info, and other information.
+
address@hidden debugtree
address@hidden tree representation, for debugging
address@hidden debugging document, with tree representation
+Instead of generating a regular output format, output a text representation
+of the tree obtained by parsing the input texinfo document.
+
address@hidden plaintexinfo
+Output the Texinfo source with all the macros, @code{@@include} and
address@hidden@@address@hidden@}} expanded. This is similar to setting
address@hidden, but instead of being output in addition to
+the normal conversion, output of Texinfo is the main output.
+
address@hidden rawtext
address@hidden raw text output
+Output raw text, with minimal formatting. For example, footnotes are
+ignored and there is no paragraph filling. This is used by the parser
+for file names and copyright text in HTML comments, for example.
+
address@hidden texinfosxml
address@hidden SXML output
address@hidden S-expressions, output format
+Output the document in TexinfoSXML representation, a syntax for
+writing XML data using Lisp S-expressions.
+
address@hidden textcontent
address@hidden spell checking
address@hidden word counting
address@hidden detexinfo
address@hidden stripping Texinfo commands
+Output the text content only, stripped of commands; this is useful for
+spell checking or word counting, for example. The trivial
address@hidden script setting this is in the @file{util} directory
+of the Texinfo source as an example. It's one line:
+
address@hidden
+exec texi2any -c TEXINPUT_OUTPUT_FORMAT=textcontent "$@@"
address@hidden example
address@hidden ftable
address@hidden Other Customization Variables
address@hidden Other Customization Variables
+
address@hidden HTML Customization Variables
address@hidden HTML Customization Variables
+
+This table gives the customization variables which apply to HTML
+output only. A few other customization variable apply to both HTML
+and other output formats; those are given in the next section.
@vtable @code
@item AVOID_MENU_REDUNDANCY
@@ -17675,34 +17694,16 @@
cross references (@pxref{Four and Five Arguments}) are present in
@file{htmlxref.cnf} (@pxref{HTML Xref Configuration}); default false.
address@hidden CLOSE_QUOTE_SYMBOL
-When a closing quote is needed, use this character; default @code{’}
-in HTML, @code{’} in Docbook.
-
address@hidden @item COMPLETE_IMAGE_PATHS
address@hidden If set, the image files are computed to be relative from the
document
address@hidden directory to the source manual directory, and then to the image.
-
@item COMPLEX_FORMAT_IN_TABLE
For address@hidden If set, use tables for indentation of complex formats;
default
false.
address@hidden CPP_LINE_DIRECTIVES
-Recognize @code{#line} directives in a ``preprocessing'' pass
-(@pxref{External Macro Processors}); on by default.
-
@item CSS_LINES
For address@hidden CSS output, automatically determined by default
(@pxref{HTML CSS}).
@item DATE_IN_HEADER
For address@hidden Put the document generation date in the header; off by
default.
address@hidden DEBUG
-If set, debugging output is generated; default is off (zero).
address@hidden The integer value specifies what kinds of debugging output are
address@hidden generated. It is a bitmask. Setting it to 255 ensures having
all
address@hidden available debugging output.
-
@item DEF_TABLE
For address@hidden If set, a @code{<table>} construction for @code{@@deffn}
and similar @@-commands is used (looking more like the @TeX{} output),
@@ -17714,57 +17715,18 @@
default @code{<hr>}.
@item DO_ABOUT
-If set to 0 never do an About special element;
+For address@hidden If set to 0 never do an About special element;
if set to 1 always do an About special element;
default 0.
@c @xref{Output Elements Defined}.
address@hidden DOCTYPE
address@hidden SystemLiteral
-For Docbook, HTML, address@hidden Specifies the @code{SystemLiteral}, the
-entity's system identifier. This is a URI which may be used to
-retrieve the entity, and identifies the canonical DTD for the
-document. The default value is different for each of HTML, Docbook
-and address@hidden
-
address@hidden DUMP_TEXI
-For debugging. If set, no conversion is done, only parsing and macro
-expansion. If the option @option{--macro-expand} is set, the Texinfo
-source is also expanded to the corresponding file. Default false.
-
address@hidden DUMP_TREE
-For debugging. If set, the tree constructed upon parsing a Texinfo
-document is output to standard error; default false.
-
address@hidden ENABLE_ENCODING_USE_ENTITY
-For HTML, address@hidden If @option{--enable-encoding} is set, and there is an
-entity corresponding with the letter or the symbol being output,
-prefer the entity. Set by default for HTML, but not XML.
-
address@hidden EXTERNAL_CROSSREF_SPLIT
-For cross references to other manuals, this determines if the other
-manual is considered to be split or monolithic. By default, it is set
-based on the value of @code{SPLIT}. @xref{HTML Xref}, and @pxref{HTML
-Xref Configuration}.
-
address@hidden EXTENSION
-The extension added to the output file name. The default is different
-for each output format.
-
@item EXTERNAL_DIR
For address@hidden Base directory for external manuals; default none. It is
better to use the general external cross reference mechanism
(@pxref{HTML Xref Configuration}) than this variable.
@item EXTRA_HEAD
-For HTML, additional text appearing within @code{<head>}; default unset.
-
address@hidden FIX_TEXINFO
-For ``plain Texinfo'' (see the @code{PLAINTEXINFO} item). If set to
-false, the resulting Texinfo does not have all errors corrected, such
-as missing @samp{@@end}; default true. This variable is only
-relevant when expanding Texinfo; other converters always try to
-output something sane even if the input is erroneous.
+For address@hidden Additional text appearing within @code{<head>}; default
unset.
@item FOOTNOTE_END_HEADER_LEVEL
For address@hidden Header formatting level used for the footnotes header with
@@ -17790,58 +17752,14 @@
@item ICONS
For address@hidden Use icons for the navigation panel; default false.
address@hidden @item IDX_SUMMARY
address@hidden If set, for each @code{@@printindex} a file named
address@hidden @address@hidden@var{idxname}.idx} is created, containing lines of
address@hidden the form:
address@hidden
address@hidden @example
address@hidden @var{key} @var{reference}
address@hidden @end example
address@hidden
address@hidden @noindent sorted alphabetically (case matters).
-
address@hidden IGNORE_BEFORE_SETFILENAME
-If set, begin outputting at @code{@@setfilename}, if
address@hidden@@setfilename} is present; default true.
-
address@hidden IGNORE_SPACE_AFTER_BRACED_COMMAND_NAME
-If set, spaces are ignored after an @@-command that takes braces.
-Default on, matching the @TeX{} behavior.
-
@item IMAGE_LINK_PREFIX
For address@hidden If set, the associated value is prepended to the image file
links; default unset.
address@hidden INDEX_ENTRY_COLON
-Symbol used between the index entry and the associated node or section;
-default @samp{:}.
-
address@hidden INLINE_CONTENTS
-For address@hidden If set, output the contents where the @code{@@contents} and
-similar @@-commands are located; default true. This is Ignored if
address@hidden@@set*contentsaftertitlepage} is set (@pxref{Contents}).
-
@item INLINE_CSS_STYLE
For address@hidden Put CSS directly in HTML elements rather than at the
beginning of the output; default false.
address@hidden INLINE_INSERTCOPYING
-If set, @code{@@insertcopying} is replaced by the @code{@@copying}
-content (@address@hidden@@copying}}) as if @code{@@insertcopying} were a
-user-defined macro; default false.
-
address@hidden INPUT_ENCODING_NAME
-Normalized encoding name suitable for output. Should be a usable
-charset name in HTML, typically one of the preferred IANA encoding
-names. You should not need to use this variable, since it is set by
address@hidden@@documentencoding} (@address@hidden@@documentencoding}}).
-
address@hidden INPUT_PERL_ENCODING
-Perl encoding used to process the Texinfo source. You should not need
-to use that variable, since it is set by @code{@@documentencoding}
-(@address@hidden@@documentencoding}}).
-
@item KEEP_TOP_EXTERNAL_REF
For address@hidden If set, do not ignore @samp{Top} as the first
argument for an external ref to a manual, as is done by default.
@@ -17883,24 +17801,11 @@
fail (because of @command{dvips}). The default is the empty string,
which means the current directory.
address@hidden MACRO_BODY_IGNORES_LEADING_SPACE
-Ignore white space at the beginning of user defined macro body line,
-mimicking a @TeX{} limitation (@pxref{Macro Details}). Default off.
-
address@hidden MAX_MACRO_CALL_NESTING
-The maximal number of recursive calls of @@-commands defined through
address@hidden@@rmacro}; default 100000. The purpose of this variable is to
-avoid infinite recursions.
-
@item MAX_HEADER_LEVEL
For address@hidden Maximum header formatting level used (higher header
formatting level numbers correspond to lower sectioning levels);
default @samp{4}.
address@hidden MENU_ENTRY_COLON
-Symbol used between the menu entry and the description; default
address@hidden:}.
-
@item MENU_SYMBOL
For address@hidden Symbol used in front of menu entries when node names are
used
for menu entries formatting; default @samp{•}.
@@ -17912,57 +17817,10 @@
@item NO_CSS
For address@hidden Do not use CSS; default false. @xref{HTML CSS}.
address@hidden NO_USE_SETFILENAME
-If set, do not use @code{@@setfilename} to set the document name;
-instead, base the output document name only on the input file name.
-The default is false.
-
@item NODE_FILE_EXTENSION
For address@hidden Extension for node files if @code{NODE_FILENAMES} is set;
default @samp{html}.
address@hidden NODE_FILENAMES
-If set, node names are used to construct file names. By default, it
-is set if the output is split by node, or if @code{NODE_FILES} is set
-and the output is split in any way.
-
address@hidden NODE_NAME_IN_INDEX
-If set, use node names in index entries, otherwise prefer section names;
-default true.
-
address@hidden NODE_NAME_IN_MENU
-If set, use node names in menu entries, otherwise prefer section names;
-default true.
-
address@hidden OPEN_QUOTE_SYMBOL
-When an opening quote is needed, use the corresponding character; default
address@hidden‘} for HTML, @code{‘} for Docbook.
-
address@hidden OUTPUT_ENCODING_NAME
-Normalized encoding name used for output files. Should be a usable
-charset name in HTML, typically one of the preferred IANA encoding
-names. By default, if an input encoding is set (typically through
address@hidden@@documentencoding} or @code{INPUT_ENCODING_NAME}), this
-information is used to set the output encoding name. If no input
-encoding is specified, the default output encoding name may be set by
-the output format. In particular, the XML-based formats use
address@hidden for @code{OUTPUT_ENCODING_NAME} if the encoding is not
-otherwise specified. @address@hidden@@documentencoding}}.
-
address@hidden OVERVIEW_LINK_TO_TOC
-If set, the cross references in the Overview link to the corresponding
-Table of Contents entries; default true.
-
address@hidden PACKAGE
address@hidden PACKAGE_VERSION
address@hidden PACKAGE_AND_VERSION
address@hidden PACKAGE_URL
address@hidden PACKAGE_NAME
-The implementation's short package name, package version, package name
-and version concatenated, package url, and full package name,
-respectively. By default, these variables are all set through
-Autoconf, Automake, and @code{configure}.
-
@item PRE_ABOUT
For HTML, when an About element is output. If set to a text string,
this text will appear at the beginning of the About element. If set
@@ -17974,22 +17832,279 @@
For address@hidden If set, the given text will appear at the footer of each
HTML file; default unset.
address@hidden PREFIX
-The output file prefix, which is prepended to some output file names.
-By default it is set by @code{@@setfilename} or from the input file
-(@address@hidden@@setfilename}}). How this value is used depends on the
-value of other customization variables or command line options, such
-as whether the output is split and @code{NODE_FILENAMES}. The default
-is unset.
-
address@hidden PROGRAM
-Name of the program used. By default, it is set to the name of the
-program launched, with a trailing @samp{.pl} removed.
-
@item PROGRAM_NAME_IN_FOOTER
For address@hidden If set, output the program name and miscellaneous related
information in the page footers; default false.
address@hidden SHORTEXTN
+For address@hidden If set, use @samp{.htm} as extension; default false.
+
address@hidden SHOW_TITLE
+For address@hidden If set, output the title at the beginning of the document;
+default true.
+
address@hidden SIMPLE_MENU
+For address@hidden If set, use a simple preformatted style for the menu,
+instead of breaking down the different parts of the menu; default false.
address@hidden Parts}.
+
address@hidden TOC_FILE
address@hidden INLINE_CONTENTS
+The value is used as the file name for the table of contents, if
+output is split and @code{INLINE_CONTENTS} is not set. The extension
+is set appropriately, if necessary. The default is
address@hidden@var{docname}_toc.html}.
+
address@hidden TOC_LINKS
+For address@hidden If set, links from headings to toc entries are created;
+default false.
+
address@hidden TOP_FILE
+This file name may be used for the top-level file. The extension is
+set appropriately, if necessary. This is used to override the default,
+and is, in general, only taken into account when output is split, and
+for address@hidden
+
address@hidden TOP_NODE_FILE
+For address@hidden File name used for the Top node, if @code{NODE_FILENAMES}
+is set; default is @code{index}.
+
address@hidden TOP_NODE_FILE_TARGET
+For address@hidden File name used for the Top node in cross references;
+default is @code{index}.
+
address@hidden TOP_NODE_UP_URL
+For address@hidden The url used for the Up pointer of the Top node; default
address@hidden, meaning no link is generated.
+
address@hidden USE_ACCESSKEY
address@hidden @code{accesskey}, customization variable for
+For address@hidden Use @code{accesskey} in cross references; default true.
+
address@hidden USE_ISO
+For address@hidden Use entities for doubled single-quote characters
+(@pxref{Inserting Quotation Marks}), and @samp{---} and @samp{--}
+(@pxref{Conventions}); default true.
+
address@hidden USE_LINKS
address@hidden @code{<link>} HTML tag, in @code{<head>}
address@hidden @code{<head>} HTML tag, and @code{<link>}
+For address@hidden Generate @code{<link>} elements in the HTML @code{<head>}
+output; default true.
+
address@hidden USE_REL_REV
+For address@hidden Use @code{rel} in cross references; default true.
+
address@hidden VERTICAL_HEAD_NAVIGATION
+For address@hidden If set, a vertical navigation panel is used; default false.
+
address@hidden WORDS_IN_PAGE
address@hidden Navigation panel, bottom of page
+For HTML, with output split at nodes. Specifies the approximate
+minimum page length at which a navigation panel is placed at the
+bottom of a page. To avoid ever having the navigation buttons at the
+bottom of a page, set this to a sufficiently large number. The
+default is 300.
+
address@hidden XREF_USE_FLOAT_LABEL
+For address@hidden If set, for the float name in cross references, use the
+float label instead of the type followed by the float number
+(@address@hidden@@float}}). The default is off.
+
address@hidden XREF_USE_NODE_NAME_ARG
+For address@hidden Only relevant for cross reference commands with no cross
+reference name (second argument). If set address@hidden, use the node name
+(first) argument in cross reference @@-commands for the text displayed
+as the hyperlink. If set address@hidden, use the node name if
address@hidden is set, otherwise the section name. If set to
address@hidden, use the first argument in preformatted environments,
+otherwise use the node name or section name depending on
address@hidden The default is @samp{undef}.
+
address@hidden vtable
+
+
address@hidden Other Customization Variables
address@hidden Other Customization Variables
+
+This table gives the remaining customization variables, which apply to
+multiple formats, or affect global behavior, or otherwise don't fit
+into the categories of the previous sections.
+
address@hidden @code
address@hidden CLOSE_QUOTE_SYMBOL
+When a closing quote is needed, use this character; default @code{’}
+in HTML, @code{’} in Docbook.
+
address@hidden @item COMPLETE_IMAGE_PATHS
address@hidden If set, the image files are computed to be relative from the
document
address@hidden directory to the source manual directory, and then to the image.
+
address@hidden CPP_LINE_DIRECTIVES
+Recognize @code{#line} directives in a ``preprocessing'' pass
+(@pxref{External Macro Processors}); on by default.
+
address@hidden DEBUG
+If set, debugging output is generated; default is off (zero).
address@hidden The integer value specifies what kinds of debugging output are
address@hidden generated. It is a bitmask. Setting it to 255 ensures having
all
address@hidden available debugging output.
+
address@hidden DOCTYPE
address@hidden SystemLiteral
+For Docbook, HTML, address@hidden Specifies the @code{SystemLiteral}, the
+entity's system identifier. This is a URI which may be used to
+retrieve the entity, and identifies the canonical DTD for the
+document. The default value is different for each of HTML, Docbook
+and address@hidden
+
address@hidden DUMP_TEXI
+For debugging. If set, no conversion is done, only parsing and macro
+expansion. If the option @option{--macro-expand} is set, the Texinfo
+source is also expanded to the corresponding file. Default false.
+
address@hidden DUMP_TREE
+For debugging. If set, the tree constructed upon parsing a Texinfo
+document is output to standard error; default false.
+
address@hidden ENABLE_ENCODING_USE_ENTITY
+For HTML, address@hidden If @option{--enable-encoding} is set, and there is an
+entity corresponding with the letter or the symbol being output,
+prefer the entity. Set by default for HTML, but not XML.
+
address@hidden EXTERNAL_CROSSREF_SPLIT
+For cross references to other manuals, this determines if the other
+manual is considered to be split or monolithic. By default, it is set
+based on the value of @code{SPLIT}. @xref{HTML Xref}, and @pxref{HTML
+Xref Configuration}.
+
address@hidden EXTENSION
+The extension added to the output file name. The default is different
+for each output format.
+
address@hidden FIX_TEXINFO
+For ``plain Texinfo'' (see the @code{PLAINTEXINFO} item). If set to
+false, the resulting Texinfo does not have all errors corrected, such
+as missing @samp{@@end}; default true. This variable is only
+relevant when expanding Texinfo; other converters always try to
+output something sane even if the input is erroneous.
+
address@hidden @item IDX_SUMMARY
address@hidden If set, for each @code{@@printindex} a file named
address@hidden @address@hidden@var{idxname}.idx} is created, containing lines of
address@hidden the form:
address@hidden
address@hidden @example
address@hidden @var{key} @var{reference}
address@hidden @end example
address@hidden
address@hidden @noindent sorted alphabetically (case matters).
+
address@hidden IGNORE_BEFORE_SETFILENAME
+If set, begin outputting at @code{@@setfilename}, if
address@hidden@@setfilename} is present; default true.
+
address@hidden IGNORE_SPACE_AFTER_BRACED_COMMAND_NAME
+If set, spaces are ignored after an @@-command that takes braces.
+Default on, matching the @TeX{} behavior.
+
address@hidden INDEX_ENTRY_COLON
+Symbol used between the index entry and the associated node or section;
+default @samp{:}.
+
address@hidden INLINE_CONTENTS
+For address@hidden If set, output the contents where the @code{@@contents} and
+similar @@-commands are located; default true. This is Ignored if
address@hidden@@set*contentsaftertitlepage} is set (@pxref{Contents}).
+
address@hidden INLINE_INSERTCOPYING
+If set, @code{@@insertcopying} is replaced by the @code{@@copying}
+content (@address@hidden@@copying}}) as if @code{@@insertcopying} were a
+user-defined macro; default false.
+
address@hidden INPUT_ENCODING_NAME
+Normalized encoding name suitable for output. Should be a usable
+charset name in HTML, typically one of the preferred IANA encoding
+names. You should not need to use this variable, since it is set by
address@hidden@@documentencoding} (@address@hidden@@documentencoding}}).
+
address@hidden INPUT_PERL_ENCODING
+Perl encoding used to process the Texinfo source. You should not need
+to use that variable, since it is set by @code{@@documentencoding}
+(@address@hidden@@documentencoding}}).
+
address@hidden MACRO_BODY_IGNORES_LEADING_SPACE
+Ignore white space at the beginning of user defined macro body line,
+mimicking a @TeX{} limitation (@pxref{Macro Details}). Default off.
+
address@hidden MAX_MACRO_CALL_NESTING
+The maximal number of recursive calls of @@-commands defined through
address@hidden@@rmacro}; default 100000. The purpose of this variable is to
+avoid infinite recursions.
+
address@hidden MENU_ENTRY_COLON
+Symbol used between the menu entry and the description; default
address@hidden:}.
+
address@hidden NO_USE_SETFILENAME
+If set, do not use @code{@@setfilename} to set the document name;
+instead, base the output document name only on the input file name.
+The default is false.
+
address@hidden NODE_FILENAMES
+If set, node names are used to construct file names. By default, it
+is set if the output is split by node, or if @code{NODE_FILES} is set
+and the output is split in any way.
+
address@hidden NODE_NAME_IN_INDEX
+If set, use node names in index entries, otherwise prefer section names;
+default true.
+
address@hidden NODE_NAME_IN_MENU
+If set, use node names in menu entries, otherwise prefer section names;
+default true.
+
address@hidden OPEN_QUOTE_SYMBOL
+When an opening quote is needed, use the corresponding character; default
address@hidden‘} for HTML, @code{‘} for Docbook.
+
address@hidden OUTPUT_ENCODING_NAME
+Normalized encoding name used for output files. Should be a usable
+charset name in HTML, typically one of the preferred IANA encoding
+names. By default, if an input encoding is set (typically through
address@hidden@@documentencoding} or @code{INPUT_ENCODING_NAME}), this
+information is used to set the output encoding name. If no input
+encoding is specified, the default output encoding name may be set by
+the output format. In particular, the XML-based formats use
address@hidden for @code{OUTPUT_ENCODING_NAME} if the encoding is not
+otherwise specified. @address@hidden@@documentencoding}}.
+
address@hidden OVERVIEW_LINK_TO_TOC
+If set, the cross references in the Overview link to the corresponding
+Table of Contents entries; default true.
+
address@hidden PACKAGE
address@hidden PACKAGE_VERSION
address@hidden PACKAGE_AND_VERSION
address@hidden PACKAGE_URL
address@hidden PACKAGE_NAME
+The implementation's short package name, package version, package name
+and version concatenated, package url, and full package name,
+respectively. By default, these variables are all set through
+Autoconf, Automake, and @code{configure}.
+
address@hidden PREFIX
+The output file prefix, which is prepended to some output file names.
+By default it is set by @code{@@setfilename} or from the input file
+(@address@hidden@@setfilename}}). How this value is used depends on the
+value of other customization variables or command line options, such
+as whether the output is split and @code{NODE_FILENAMES}. The default
+is unset.
+
address@hidden PROGRAM
+Name of the program used. By default, it is set to the name of the
+program launched, with a trailing @samp{.pl} removed.
+
@item RENAMED_NODES_FILE
If set, use the value for the renamed nodes description file. If not
set, the file is @address@hidden
@@ -17999,23 +18114,11 @@
If set, create redirection files for renamed nodes. Set by default
when generating address@hidden
address@hidden SHORTEXTN
-For address@hidden If set, use @samp{.htm} as extension; default false.
-
@item SHOW_MENU
@opindex --no-headers
If set, Texinfo menus are output. By default, it is set unless
generating Docbook or if @option{--no-headers} is specified.
address@hidden SHOW_TITLE
-For address@hidden If set, output the title at the beginning of the document;
-default true.
-
address@hidden SIMPLE_MENU
-For address@hidden If set, use a simple preformatted style for the menu,
-instead of breaking down the different parts of the menu; default false.
address@hidden Parts}.
-
@item SORT_ELEMENT_COUNT
@pindex texi-elements-by-size
@cindex Longest nodes, finding
@@ -18062,41 +18165,13 @@
default is set based on a variable in @file{configure.ac}.
@item TEXTCONTENT_COMMENT
-For stripped text content output (i.e., when @code{TEXTCONTENT} is
-set). If set, also output comments. Default false.
-
address@hidden TOC_FILE
address@hidden INLINE_CONTENTS
-The value is used as the file name for the table of contents, if
-output is split and @code{INLINE_CONTENTS} is not set. The extension
-is set appropriately, if necessary. The default is
address@hidden@var{docname}_toc.html}.
-
address@hidden TOC_LINKS
-For address@hidden If set, links from headings to toc entries are created;
-default false.
-
address@hidden TOP_FILE
-This file name may be used for the top-level file. The extension is
-set appropriately, if necessary. This is used to override the default,
-and is, in general, only taken into account when output is split, and
-for address@hidden
-
address@hidden TOP_NODE_FILE
-For address@hidden File name used for the Top node, if @code{NODE_FILENAMES}
-is set; default is @code{index}.
-
address@hidden TOP_NODE_FILE_TARGET
-For address@hidden File name used for the Top node in cross references;
-default is @code{index}.
+For stripped text content output (i.e., when
address@hidden is set to @code{textcontent}). If set,
+also output comments. Default false.
@item TOP_NODE_UP
Up node for the Top node; default @samp{(dir)}.
address@hidden TOP_NODE_UP_URL
-The url used for the Up pointer of the Top node for HTML; default
address@hidden, meaning no link is generated.
-
@item TREE_TRANSFORMATIONS
The associated value is a comma separated list of transformations that
can be applied to the Texinfo tree prior to outputting the result. If
@@ -18158,21 +18233,6 @@
@end ftable
address@hidden USE_ACCESSKEY
address@hidden @code{accesskey}, customization variable for
-For address@hidden Use @code{accesskey} in cross references; default true.
-
address@hidden USE_ISO
-For address@hidden Use entities for doubled single-quote characters
-(@pxref{Inserting Quotation Marks}), and @samp{---} and @samp{--}
-(@pxref{Conventions}); default true.
-
address@hidden USE_LINKS
address@hidden @code{<link>} HTML tag, in @code{<head>}
address@hidden @code{<head>} HTML tag, and @code{<link>}
-For address@hidden Generate @code{<link>} elements in the HTML @code{<head>}
-output; default true.
-
@item USE_NODES
Preferentially use nodes to decide where elements are separated. If
set to false, preferentially use sectioning to decide where elements
@@ -18187,11 +18247,8 @@
characters when there is no named entity. By default, set to true for
HTML.
address@hidden USE_REL_REV
-For address@hidden Use @code{rel} in cross references; default true.
-
@item USE_UP_NODE_FOR_ELEMENT_UP
-Complete up sectioning direction with node direction when there is no
+Fill in up sectioning direction with node direction when there is no
sectioning up direction. In practice this can only happen when there
is no @@top section. Not set by default.
@@ -18209,32 +18266,6 @@
If set to false, do not use the @code{Text::Unidecode} Perl module to
transliterate more characters; default true.
address@hidden VERTICAL_HEAD_NAVIGATION
-For address@hidden If set, a vertical navigation panel is used; default false.
-
address@hidden WORDS_IN_PAGE
address@hidden Navigation panel, bottom of page
-For HTML, with output split at nodes. Specifies the approximate
-minimum page length at which a navigation panel is placed at the
-bottom of a page. To avoid ever having the navigation buttons at the
-bottom of a page, set this to a sufficiently large number. The
-default is 300.
-
address@hidden XREF_USE_FLOAT_LABEL
-For address@hidden If set, for the float name in cross references, use the
-float label instead of the type followed by the float number
-(@address@hidden@@float}}). The default is off.
-
address@hidden XREF_USE_NODE_NAME_ARG
-For address@hidden Only relevant for cross reference commands with no cross
-reference name (second argument). If set address@hidden, use the node name
-(first) argument in cross reference @@-commands for the text displayed
-as the hyperlink. If set address@hidden, use the node name if
address@hidden is set, otherwise the section name. If set to
address@hidden, use the first argument in preformatted environments,
-otherwise use the node name or section name depending on
address@hidden The default is @samp{undef}.
-
@end vtable
@@ -22052,7 +22083,7 @@
as:
@example
-$Id: texinfo.txi,v 1.534 2013/01/26 15:14:38 karl Exp $
+$Id: texinfo.txi,v 1.535 2013/01/27 19:10:04 karl Exp $
@end example
(This is potentially useful in all sources that use version control,
Index: doc/refcard/txivarcheck
===================================================================
RCS file: /sources/texinfo/texinfo/doc/refcard/txivarcheck,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- doc/refcard/txivarcheck 21 Sep 2012 17:40:45 -0000 1.3
+++ doc/refcard/txivarcheck 27 Jan 2013 19:10:05 -0000 1.4
@@ -1,6 +1,6 @@
#!/usr/bin/env perl
-# $Id: txivarcheck,v 1.3 2012/09/21 17:40:45 karl Exp $
-# Copyright 2012 Free Software Foundation, Inc.
+# $Id: txivarcheck,v 1.4 2013/01/27 19:10:05 karl Exp $
+# Copyright 2012, 2013 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -30,7 +30,7 @@
my @man_vars = &read_refman ("../texinfo.txi");
my @tp_vars = &read_tp ("../../util/txicustomvars");
- my (%man_vars, %tp_vars);
+ my (%man_vars, %tp_vars); # list to hash
@address@hidden = ();
@address@hidden = ();
@@ -46,8 +46,11 @@
printf ("common %3d: @{[sort @found]}\n", @found + 0)
unless $no_common;
- # we can't report variable names only in the manual, since our list
- # necessarily includes many non-variables.
+ # we can't reasonly reduce the list of variable names only in the
+ # manual to null, since the manual necessarily includes many non-variables.
+ #
+ my @man_only = keys %man_vars;
+ printf "man only %2s: @{[sort @man_only]}\n", @man_only + 0;
my @tp_only = keys %tp_vars;
printf "tp only %2s: @{[sort @tp_only]}\n", @tp_only + 0;
@@ -58,9 +61,8 @@
# Return customization variable names from the section in the reference
-# manual. Unfortunately a number of non-variable-names are also
-# returned, since we have no way to distinguish and it wouldn't be worth
-# all the meta-markup in the manual source.
+# manual. We assume their names are all uppercase, to avoid returning
+# numerous non-variables.
#
sub read_refman {
my ($fname) = @_;
@@ -91,9 +93,17 @@
# done with special node.
my @atcmds = split (" ", $atcmds);
push (@ret, @atcmds);
+ next;
}
- next unless s/^\@(itemx?|vindex) *//; # look for item[x]s
+ # Stop looking for cust.var names after those nodes are done.
+ last if /address@hidden Internationalization of Document Strings/;
+
+ # Otherwise, we're looking at a line in one of the cust.var
+ # documentation nodes.
+ next unless s/^\@(itemx?|vindex) *//; # look for item[x]s and vindex
+ next unless /^[A-Z0-9_]+$/; # uppercase only
+
chomp;
push (@ret, $_);
}
@@ -118,7 +128,11 @@
my ($var,$where) = split (/\t/);
next if ($where eq 'variable_other_settables'
|| $where eq 'parser_options');
- next if $var eq "OUTPUT_PERL_ENCODING";
+ next if $var eq "OUTPUT_PERL_ENCODING"; # not for users
+
+ # these are documented, but their lowercase names don't match
+ # everything
+ #next if $var =~ /^(even|every|odd)(heading|footing)$/;
push (@ret, $var);
}
close (FILE) || warn "close($FILE) failed: $!";
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- texinfo ChangeLog doc/texinfo.txi doc/refcard/t...,
karl <=