[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
|
From: |
Patrice Dumas |
|
Subject: |
texinfo ChangeLog doc/texinfo.txi |
|
Date: |
Fri, 30 Nov 2012 20:48:39 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Patrice Dumas <pertusus> 12/11/30 20:48:39
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
* doc/texinfo.txi (Other Customization Variables): explain
default
values for customization variables.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1465&r2=1.1466
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.497&r2=1.498
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1465
retrieving revision 1.1466
diff -u -b -r1.1465 -r1.1466
--- ChangeLog 30 Nov 2012 18:32:30 -0000 1.1465
+++ ChangeLog 30 Nov 2012 20:48:38 -0000 1.1466
@@ -2,6 +2,8 @@
* doc/texinfo.txi (Invoking texi2any), tp/texi2any.pl: add -c as an
alias for --set-customization-variable (Karl idea).
+ * doc/texinfo.txi (Other Customization Variables): explain default
+ values for customization variables.
2012-11-30 Karl Berry <address@hidden>
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.497
retrieving revision 1.498
diff -u -b -r1.497 -r1.498
--- doc/texinfo.txi 30 Nov 2012 18:32:30 -0000 1.497
+++ doc/texinfo.txi 30 Nov 2012 20:48:38 -0000 1.498
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.497 2012/11/30 18:32:30 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.498 2012/11/30 20:48:38 pertusus 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.
@@ -17381,22 +17381,26 @@
@vtable @code
@item AVOID_MENU_REDUNDANCY
For address@hidden If set, and the menu entry and menu description are the
-same, then do not print the menu description.
+same, then do not print the menu description; default false.
@item AFTER_BODY_OPEN
For address@hidden If set, the corresponding text will appear at the
-beginning of each HTML file.
+beginning of each HTML file; default unset.
@item AFTER_ABOUT
For HTML, when an About'element is output. If set, the corresponding
-text will appear at the end of the About element.
+text will appear at the end of the About element; default unset.
@item AFTER_OVERVIEW
@itemx AFTER_TOC_LINES
For address@hidden If set, the corresponding text is output after the short
table of contents for @code{AFTER_OVERVIEW} and after the table of
contents for @code{AFTER_TOC_LINES}, otherwise a default string is
-used.
+used (at the time of writing a @code{</div>} element is closed).
+
+In general you should set @code{BEFORE_OVERVIEW} if
address@hidden is set, and you should set @code{BEFORE_TOC_LINES}
+if @code{AFTER_TOC_LINES} is set.
@item BASEFILENAME_LENGTH
For address@hidden The maximum length of the base filenames; default 245.
@@ -17408,11 +17412,18 @@
For address@hidden If set, the corresponding text is output before the
short table of contents for @code{BEFORE_OVERVIEW} and before
the table of contents for @code{BEFORE_TOC_LINES}, otherwise a
-default string is used.
+default string is used (at the time of writing a
address@hidden<div ...>} element is opened).
+
+In general you should set @code{AFTER_OVERVIEW} if @code{BEFORE_OVERVIEW}
+is set, and you should set @code{AFTER_TOC_LINES} if @code{BEFORE_TOC_LINES}
+is set.
+
@item BIG_RULE
For address@hidden Rule used after and before the top element and before
-special elements, but not for footers and headers.
+special elements, but not for footers and headers; default
address@hidden<hr>}.
@item BODYTEXT
@cindex @code{<body>} text, customizing
@@ -17433,14 +17444,16 @@
@file{htmlxref.cnf} (@pxref{HTML Xref Configuration}); default false.
@item CLOSE_QUOTE_SYMBOL
-When a closing quote is needed, use this character.
+When a closing quote is needed, use this character; default @code{’}
+in HTML, @code{’} in DocBook.
@c @item COMPLETE_IMAGE_PATHS
@c If set, the image files are computed to be relative from the document
@c 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.
+For address@hidden If set, use tables for indentation of complex formats;
default
+false.
@item CPP_LINE_DIRECTIVES
Recognize @code{#line} directives in a ``preprocessing'' pass
@@ -17461,15 +17474,17 @@
@item DEF_TABLE
For address@hidden If this is set a @code{<table>} construction for
@code{@@deffn} and similar @@-commands is used (looking more like the
address@hidden output), instead of definition lists.
address@hidden output), instead of definition lists; default false.
@item DEFAULT_RULE
For address@hidden Rule used between element, except after and before the
-top element, or before special elements, and for footers and headers.
+top element, or before special elements, and for footers and headers;
+default is @code{<hr>}.
@item DO_ABOUT
If set to 0 never do an About special element.
-If set to 1 always do an About special element.
+If set to 1 always do an About special element;
+default 0.
@c @xref{Output Elements Defined}.
@item DOCTYPE
@@ -17477,21 +17492,22 @@
For Docbook, HTML, address@hidden Specifies the @code{SystemLiteral}, the
entity's system identifier. It is a URI, which may be used to
retrieve the entity, and identifies the canonical DTD for the
-document.
+document. The default is different for HTML, DocBook and Texinfo
+XML.
@item DUMP_TEXI
For debugging. If set, there is no conversion done, only parsing and
macros expansion. If @option{--macro-expand} is set, the Texinfo
-source is also expanded to the corresponding file.
+source is also expanded to the corresponding file; default false.
@item DUMP_TREE
For debugging. If set, the tree constructed upon parsing a Texinfo
-document is output on standard error.
+document is output on standard error; default false.
@item 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.
+prefer the entity. Set in the default case for HTML.
@item EXTERNAL_CROSSREF_SPLIT
For cross references to other manuals, this determines if the other
@@ -17500,46 +17516,47 @@
Xref Configuration}.
@item EXTENSION
-The extension added to the output file name.
+The extension added to the output file name. In the default case,
+an extension specific of each output format is used.
@item EXTERNAL_DIR
For address@hidden Base directory for external manuals. It is better to use
the general external cross reference mechanism (@pxref{HTML Xref
-Configuration}) and avoid this variable.
+Configuration}) and avoid this variable; default false.
@item EXTRA_HEAD
-For HTML, additional text appearing within @code{<head>}.
+For HTML, additional text appearing within @code{<head>}; default unset.
@item FIX_TEXINFO
For plain Texinfo (with @code{PLAINTEXINFO}). If set to false,
the resulting Texinfo is not corrected of all errors, like missing
address@hidden@@end}.
address@hidden@@end}; default true.
This only has effect when expanding Texinfo, as other converter will
always try to output something sane even if the Texinfo is broken.
@item FOOTNOTE_END_HEADER_LEVEL
For address@hidden Header formatting level used for footnotes header
-with footnotestyle end. @xref{Footnote Styles}.
+with footnotestyle end; default @samp{4}. @xref{Footnote Styles}.
@item FOOTNOTE_SEPARATE_HEADER_LEVEL
For address@hidden Header formatting level used for footnotes header
-with footnotestyle separate. @xref{Footnote Styles}.
+with footnotestyle separate; default @samp{4}. @xref{Footnote Styles}.
@item FRAMES
For address@hidden If set, a file describing the frame layout is generated,
-together with a file with the short table of contents.
+together with a file with the short table of contents; default false.
@item FRAMESET_DOCTYPE
For address@hidden Same as DOCTYPE, but for the file containing the frame
description.
@item HEADER_IN_TABLE
-For address@hidden Use simple header formatting, rather than tables with node
-names.
+For address@hidden Use tables for header formatting rather than a simple
address@hidden<div>} element; default false.
@item ICONS
-For address@hidden Use icons for the navigation panel.
+For address@hidden Use icons for the navigation panel; default false.
@c @item IDX_SUMMARY
@c If set, for each @code{@@printindex} a file named
@@ -17554,7 +17571,7 @@
@item IGNORE_BEFORE_SETFILENAME
If set, begin outputting at @code{@@setfilename}, if
address@hidden@@setfilename} is present.
address@hidden@@setfilename} is present; default true.
@item IGNORE_SPACE_AFTER_BRACED_COMMAND_NAME
If set, spaces are ignored after an @@-command that takes braces.
@@ -17562,24 +17579,25 @@
@item IMAGE_LINK_PREFIX
For address@hidden If set, the associated value is prepended to the image
file
-links.
+links; default unset.
@item INDEX_ENTRY_COLON
-Symbol used between the index entry and the associated node or section.
+Symbol used between the index entry and the associated node or section;
+default is @samp{:}.
@item INLINE_CONTENTS
-If set, output the contents where the @code{@@contents} and similar
-@@-commands are located. Ignored if
+For address@hidden If set, output the contents where the @code{@@contents}
and
+similar @@-commands are located; default true. Ignored if
@code{@@set*contentsaftertitlepage} is set.
@item INLINE_CSS_STYLE
For address@hidden Put CSS directly in HTML elements rather than at the
-beginning of the output.
+beginning of the output; default false.
@item INLINE_INSERTCOPYING
If set, @code{@@insertcopying} is replaced by the @code{@@copying}
content (@pxref{copying,, @code{@@copying}}) as if
address@hidden@@insertcopying} were a user-defined macro.
address@hidden@@insertcopying} were a user-defined macro; default false.
@item INPUT_ENCODING_NAME
Normalized encoding name suitable for output. Should be a usable
@@ -17599,35 +17617,38 @@
@item L2H
For address@hidden If set, @command{latex2html} is used to convert
@code{@@math}
-and @code{@@tex} sections. Best used with @option{--iftex}.
+and @code{@@tex} sections. Best used with @option{--iftex}; default false.
@item L2H_CLEAN
(Relevant only if @code{L2H} is set.) If this is set the intermediate
-files generated in relation with @command{latex2html} are removed.
+files generated in relation with @command{latex2html} are removed; default
+true.
@item L2H_FILE
(Relevant only if @code{L2H} is set.) If set, the given file is used
-as @command{latex2html}'s init file.
+as @command{latex2html}'s init file; default unset.
@item L2H_HTML_VERSION
(Relevant only if @code{L2H} is set.) The HTML version used in the
address@hidden call.
address@hidden call; default unset.
@item L2H_L2H
-The program invoked as @command{latex2html} if @code{L2H} is set.
+The program invoked as @command{latex2html} if @code{L2H} is set;
+default is @code{latex2html}.
@item L2H_SKIP
(Relevant only if @code{L2H} is set.) If this is set the actual call
to @command{latex2html} is skipped; previously generated content is
reused, instead. If set to 0, the cache is not used at all. If set
to undef, the cache is used for as many @TeX{} fragments as possible
-and for the remaining the command is run.
+and for the remaining the command is run; default is @samp{undef}.
@item L2H_TMP
(Relevant only if @code{L2H} is set.) Set the directory used for
temporary files. None of the file name components in this directory
name may start with @samp{.}; otherwise, @command{latex2html} will
-fail (because of @command{dvips}).
+fail (because of @command{dvips}); default is an empty string,
+corresponding to the current directory.
@item MACRO_BODY_IGNORES_LEADING_SPACE
Ignore white space at the beginning of user defined macro body line,
@@ -17636,28 +17657,31 @@
@item MAX_MACRO_CALL_NESTING
The maximal number of recursive calls of @@-commands defined
through @code{@@rmacro}. The purpose of this variable is to avoid
-infinite recursions.
+infinite recursions; default 100000.
@item MAX_HEADER_LEVEL
For address@hidden Maximum header formatting level used (higher header
-formatting level correspond to lower level in sectioning).
+formatting level correspond to lower level in sectioning); default
address@hidden
@item MENU_ENTRY_COLON
-Symbol used between the menu entry and the description.
+Symbol used between the menu entry and the description; default is
address@hidden:}.
@item MENU_SYMBOL
-Symbol used in front of menu entries when node names are used for menu
-entries formatting.
+For address@hidden Symbol used in front of menu entries when node names are
used
+for menu entries formatting; default @samp{•}.
@item MONOLITHIC
For address@hidden Output only one file including the table of contents. Set
by default, but it is only considered when the output is not split.
@item NO_CSS
-For address@hidden Do not use CSS (@pxref{HTML CSS}).
+For address@hidden Do not use CSS (@pxref{HTML CSS}); default false.
@item NODE_FILE_EXTENSION
-Extension for node files if @code{NODE_FILENAMES} is set.
+For address@hidden Extension for node files if @code{NODE_FILENAMES} is set;
+default is @samp{html}.
@item NODE_FILENAMES
If set, node names are used to construct file names. By default, it
@@ -17665,13 +17689,16 @@
and the output is split in any way.
@item NODE_NAME_IN_INDEX
-If set, use node names in index entries, otherwise prefer section names.
+If set, use node names in index entries, otherwise prefer section names;
+default true.
@item NODE_NAME_IN_MENU
-If set, use node names in menu entries, otherwise prefer section names.
+If set, use node names in menu entries, otherwise prefer section names;
+default true.
@item OPEN_QUOTE_SYMBOL
-When an opening quote is needed, use the corresponding character.
+When an opening quote is needed, use the corresponding character; default
address@hidden‘} in HTML, @code{‘} in DocBook.
@item OUTPUT_ENCODING_NAME
Normalized encoding name used for output files. Should be a usable
@@ -17686,7 +17713,7 @@
@item OVERVIEW_LINK_TO_TOC
If set, the cross references in the Overview link to the corresponding
-Table of Contents entry.
+Table of Contents entry; default true.
@item PACKAGE
@itemx PACKAGE_VERSION
@@ -17706,14 +17733,14 @@
@item PRE_BODY_CLOSE
For address@hidden If set, the corresponding text will appear at the footer of
-each HTML file.
+each HTML file; default unset.
@item PREFIX
The output file prefix, which is prepended to some output files. By
default it is set by @code{@@setfilename} or from the input file
(@pxref{setfilename}). How this value is used depends on the value of
other customization variables or command line options, such as split output
-and @code{NODE_FILENAMES}.
+and @code{NODE_FILENAMES}; default unset.
@item PROGRAM
Name of the program used. It is set automatically in the default case
@@ -17721,7 +17748,7 @@
@item PROGRAM_NAME_IN_FOOTER
For address@hidden If set, output the program name and miscellaneous related
-information in the page footers.
+information in the page footers; default false.
@item RENAMED_NODES_FILE
If set, use the value for the renamed nodes description file. If not
@@ -17733,7 +17760,7 @@
generating address@hidden
@item SHORTEXTN
-For address@hidden If this is set, use @samp{.htm} as extension.
+For address@hidden If this is set, use @samp{.htm} as extension; default
false.
@item SHOW_MENU
@opindex --no-headers
@@ -17741,21 +17768,22 @@
generating Docbook or if @option{--no-headers} is specified.
@item SHOW_TITLE
-For address@hidden If set, output the title at the beginning of the document.
+For address@hidden If set, output the title at the beginning of the document;
+default true.
@item 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.
+instead of breaking down the different parts of the menu; default false.
@xref{Menu Parts}.
@item SORT_ELEMENT_COUNT
If set, the name of a file to which a list of elements (nodes or
sections, depending on the output format) is dumped, sorted by the
-number of lines they contain after removal of @@-commands.
+number of lines they contain after removal of @@-commands; default unset.
@item SORT_ELEMENT_COUNT_WORDS
When dumping the elements-by-size file (see preceding item), use word
-counts instead of line counts.
+counts instead of line counts; default false.
@c @item SPLIT_INDEX
@c For address@hidden If set, the output is split, and the output from
@@ -17767,7 +17795,7 @@
If set to true, some variables which are normally dynamically
generated anew for each run (the date, the program name, the version)
are set to fixed and given values. This is useful to compare the
-output to a reference file, as is done for the tests.
+output to a reference file, as is done for the tests; default false.
@item TEXI2DVI
Name of the command used to produce PostScript, PDF, and DVI; default
@@ -17776,7 +17804,7 @@
@item TEXI2HTML
@cindex compatibility, with @command{texi2html}
Generate HTML and try to be as compatible as possible with
address@hidden
address@hidden; default false.
@item TEXTCONTENT_COMMENT
For stripped text content output (i.e., when @code{TEXTCONTENT} is
@@ -17790,7 +17818,8 @@
@address@hidden
@item TOC_LINKS
-For address@hidden If set, links from headings to toc entries are created.
+For address@hidden If set, links from headings to toc entries are created;
+default false.
@item TOP_FILE
This file name may be used for the top-level file. The extension is
@@ -17806,10 +17835,12 @@
@code{undef}, so no link is generated.
@item TOP_NODE_FILE
-File used for the Top node, if @code{NODE_FILENAMES} is set.
+For address@hidden File used for the Top node, if @code{NODE_FILENAMES} is
+set; default is @code{index}.
@item TOP_NODE_FILE_TARGET
-File used for the Top node in cross references.
+For address@hidden File used for the Top node in cross references; default
+is @code{index}.
@item TREE_TRANSFORMATIONS
The associated value is a comma separated list of transformations applied
@@ -17847,33 +17878,35 @@
@item USE_ACCESSKEY
@cindex @code{accesskey}, customization variable for
-For address@hidden Use @code{accesskey} in cross references.
+For address@hidden Use @code{accesskey} in cross references; default true.
@item USE_ISO
For address@hidden Use entities for doubled single-quote characters
(@pxref{Inserting Quotation Marks}), and @samp{---} and @samp{--}
-(@pxref{Conventions, General Syntactic Conventions}).
+(@pxref{Conventions, General Syntactic Conventions}); default true.
@item USE_LINKS
@cindex @code{<link>} HTML tag, in @code{<head>}
@cindex @code{<head>} HTML tag, and @code{<link>}
-For address@hidden Generate @code{<link>} elements in the HTML @code{<head>}
output.
+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
-are separated.
+are separated; default true.
@item USE_NODE_TARGET
If set, use the node associated with a section for the section target
-in cross references.
+in cross references; default true.
@item USE_NUMERIC_ENTITY
For HTML, address@hidden If set, use numeric entities instead of ASCII
-characters when there is no named entity.
+characters when there is no named entity. Set to true for HTML in the
+default case.
@item USE_REL_REV
-For address@hidden Use @code{rel} in cross references.
+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
@@ -17883,7 +17916,7 @@
@item NO_USE_SETFILENAME
If set, do not use @code{@@setfilename} to set the document name,
base the document name only on the input file name
-(@pxref{setfilename}).
+(@pxref{setfilename}); default false.
@item USE_SETFILENAME_EXTENSION
Default is on for Info, off for other output. If set, use what
@@ -17891,7 +17924,8 @@
extension. You should not need to explicitly set this variable.
@item USE_TITLEPAGE_FOR_TITLE
-Use the full @code{@@titlepage} as the title, not a simple title string.
+Use the full @code{@@titlepage} as the title, not a simple title string;
+default false.
@item USE_UNIDECODE
@pindex Text::Unidecode
@@ -21673,7 +21707,7 @@
or other version control systems, which expand it into a string such
as:
@example
-$Id: texinfo.txi,v 1.497 2012/11/30 18:32:30 pertusus Exp $
+$Id: texinfo.txi,v 1.498 2012/11/30 20:48:38 pertusus Exp $
@end example
(This is useful in all sources that use version control, not just manuals.)
You may wish to include the @samp{$Id:} comment in the @code{@@copying}