texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

texinfo ChangeLog doc/texinfo.txi doc/texi2olda...


From: Karl Berry
Subject: texinfo ChangeLog doc/texinfo.txi doc/texi2olda...
Date: Mon, 10 Jan 2011 17:45:53 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       11/01/10 17:45:53

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi texi2oldapi.texi 

Log message:
        (texi2html History): move to archive file

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1197&r2=1.1198
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.364&r2=1.365
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texi2oldapi.texi?cvsroot=texinfo&r1=1.1&r2=1.2

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1197
retrieving revision 1.1198
diff -u -b -r1.1197 -r1.1198
--- ChangeLog   9 Jan 2011 19:38:03 -0000       1.1197
+++ ChangeLog   10 Jan 2011 17:45:52 -0000      1.1198
@@ -1,3 +1,8 @@
+2011-01-10  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (texi2html History): move to texi2oldapi.texi
+       archive file.
+
 2011-01-09  Karl Berry  <address@hidden>
 
        * doc/texinfo.txi (Other Configuration Variables): finish edit.

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.364
retrieving revision 1.365
diff -u -b -r1.364 -r1.365
--- doc/texinfo.txi     9 Jan 2011 19:38:03 -0000       1.364
+++ doc/texinfo.txi     10 Jan 2011 17:45:52 -0000      1.365
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.364 2011/01/09 19:38:03 karl Exp $
address@hidden $Id: texinfo.txi,v 1.365 2011/01/10 17:45:52 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.
 
@@ -172,7 +172,6 @@
 * Sample Texinfo Files::          Complete examples, including full texts.
 * Headings::                      How to write page headings and footings.
 * Catching Mistakes::             How to find mistakes in formatting.
-* Texi2HTML::                     Texi2HTML history, relation with makeinfo.
 * Info Format Specification::     Technical details of the Info file format.
 * GNU Free Documentation License::Copying this manual.
 * Command and Variable Index::    A menu containing commands and variables.
@@ -690,12 +689,6 @@
 * Tagifying::                   How to tagify a file.
 * Splitting::                   How to split a file manually.
 
-Texi2HTML
-
-* Texi2HTML history::               Texi2HTML history and makeinfo.
-* Texi2HTML texi2any differences::
-* Texi2HTML changes::               History of incompatibilities.
-
 Info Format Specification
 
 * General: Info Format General Layout.
@@ -23056,7 +23049,7 @@
 (@url{http://www.gnu.org/software/rcs}) version control systems, which
 expand it into a string such as:
 @example
-$Id: texinfo.txi,v 1.364 2011/01/09 19:38:03 karl Exp $
+$Id: texinfo.txi,v 1.365 2011/01/10 17:45:52 karl 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}
@@ -23135,7 +23128,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.364 2011/01/09 19:38:03 karl Exp $
address@hidden $Id: texinfo.txi,v 1.365 2011/01/10 17:45:52 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi
@@ -24299,7 +24292,7 @@
 @end ignore
 
 Visit the Info file you wish to tagify and split and type the two
-commands:@refill
+commands:
 
 @example
 M-x Info-tagify
@@ -24307,353 +24300,16 @@
 @end example
 
 @noindent
-(Note that the @samp{I} in @samp{Info} is upper case.)@refill
+(Note that the @samp{I} in @samp{Info} is upper case.)
 
 When you use the @code{Info-split} command, the buffer is modified into a
 (small) Info file which lists the indirect subfiles.  This file should be
 saved in place of the original visited file.  The indirect subfiles are
 written in the same directory the original file is in, with names generated
-by appending @samp{-} and a number to the original file address@hidden
+by appending @samp{-} and a number to the original file name.
 
 The primary file still functions as an Info file, but it contains just
-the tag table and a directory of address@hidden
-
address@hidden Texi2HTML
address@hidden Texi2HTML history and relations with @command{makeinfo}
-
-In 2010 Texi2HTML was merged in GNU Texinfo.  Some informations
-are retained here, mainly for historical purposes.
-
address@hidden
-* Texi2HTML history::               Texi2HTML history and makeinfo.
-* Texi2HTML texi2any differences::
-* Texi2HTML changes::               History of incompatibilities.
address@hidden menu
-
address@hidden Texi2HTML history
address@hidden Texi2HTML history and merge in Texinfo
-
-In early 1998 @command{makeinfo} wasn't able to produce
-HTML output format, but people still wanted documentation in
-HTML.  This was the birthing hour for @command{texi2html},
-with original author Lionel Cons.  The basic purpose of 
address@hidden was to convert Texinfo documents into HTML.
-
-Since then, HTML support in @command{makeinfo} improved, but
address@hidden was still stronger in some areas, including the degree to
-which it allows customization.  After being briefly maintained by Karl
-Berry in 1999, Olaf Bachmann was the maintainer until 2000, adding many 
-features.  Adrian Aichner and Derek Price took over maintainance in 2001 
-and Derek was the maintainer from 2003 to 2010, with some help from 
-Patrice Dumas.
-
-In 2010, @command{texi2html}, then hosted
-at @uref{http://www.nongnu.org/texi2html/} was made
-compatible with @command{makeinfo}, losing the focus on HTML to become a
-more generic translator, and merged in 
address@hidden://www.gnu.org/software/texinfo/, GNU Texinfo} to
-replace @command{makeinfo} in C.
address@hidden is now installed as part of the texinfo package install,
-as an alias of @command{texi2any}.  The @command{texi2html} documentation 
-is also merged here in the Texinfo manual, as 
-the @command{texi2any}/@command{makeinfo} documentation.
-
address@hidden Texi2HTML texi2any differences
address@hidden Differences between @command{texi2html} and @command{texi2any} 
invokation
-
-There are some differences between an invokation of @command{texi2any} or
address@hidden and @command{texi2html}.  With @command{texi2html}:
address@hidden @bullet
address@hidden HTML is the default output, as with @option{--html}.
address@hidden Command line is not parsed exactly like GNU getopt does. To be 
on the safe
-side:
address@hidden @bullet
address@hidden always use two dashes for long options.
address@hidden do not bundle short options, that is, use @code{-v -o -P} and 
not @code{-voP}.
address@hidden itemize
address@hidden Some options, although obsoleted are still available.
address@hidden The defaults for the HTML formatting may be slightly different. 
-Have a look at the function @code{t2h_default_set_variables_texi2html} 
-in @file{texi2html.init}.
address@hidden itemize
-
address@hidden Texi2HTML changes
address@hidden Texi2HTML incompatibilities with previous versions
-
address@hidden has accumulated a lot of incompatibilities in previous
-versions, and more were added after the merge in Texinfo.  Many 
-incompatibilities were introduced in version 1.68.  API changed also a 
-lot between 1.78 and 1.80. Between 1.82 and 5.0 API changed also quite 
-a bit, and more importantly, the whole internationalization handling was 
-changed.
-
address@hidden @bullet
address@hidden API changes between 5.0 and later versions
address@hidden @bullet
-
address@hidden no default initialization file for latex2html.  ALso don't 
search in 
-directories for the latex2html initialization file, simply use the file 
-given in argument.
-
address@hidden  don't show menu with @option{--no-headers} as said in the 
makeinfo documentation.
-
address@hidden obsolete the @option{--iso} command line option.
-
address@hidden obsolete texi2html specific variables. Here is the list with the 
associated
-  configuration variables that may be set instead, with 
@option{--set-init-variable}:
address@hidden address@hidden address@hidden
address@hidden  @option{--toc-links}               @tab @code{TOC_LINKS}
address@hidden  @option{--short-ext}               @tab @code{SHORTEXTN}
address@hidden  @option{--prefix}                  @tab @code{PREFIX}
address@hidden  @option{--short-ref}               @tab @code{SHORT_REF}
address@hidden  @option{--idx-sum}                 @tab @code{IDX_SUMMARY}
address@hidden  @option{--def-table}               @tab @code{DEF_TABLE}
address@hidden  @option{--ignore-preamble-text}    @tab 
@code{IGNORE_PREAMBLE_TEXT}
address@hidden  @option{--html-xref-prefix}        @tab @code{EXTERNAL_DIR}
address@hidden  @option{--l2h}                     @tab @code{L2H}
address@hidden  @option{--l2h-l2h}                 @tab @code{L2H_L2H}
address@hidden  @option{--l2h-skip}                @tab @code{L2H_SKIP}
address@hidden  @option{--l2h-tmp}                 @tab @code{L2H_TMP}
address@hidden  @option{--l2h-file}                @tab @code{L2H_FILE}
address@hidden  @option{--l2h-clean}               @tab @code{L2H_CLEAN}
address@hidden  @option{--use-nodes}               @tab @code{USE_NODES}
address@hidden  @option{--monolithic}              @tab @code{MONOLITHIC}
address@hidden  @option{--top-file}                @tab @code{TOP_FILE}
address@hidden  @option{--toc-file}                @tab @code{TOC_FILE}
address@hidden  @option{--frames}                  @tab @code{FRAMES}
address@hidden  @option{--menu}                    @tab @code{SHOW_MENU}
address@hidden  @option{--debug}                   @tab @code{DEBUG}
address@hidden  @option{--doctype}                 @tab @code{DOCTYPE}
address@hidden  @option{--frameset-doctype}        @tab @code{FRAMESET_DOCTYPE}
address@hidden  @option{--test}                    @tab @code{TEST}
address@hidden multitable
-
address@hidden remove completly $INVISIBLE_MARK, $USE_GLOSSARY, $CHECK, 
$EXPAND, 
-  $ENCODING, $CENTER_IMAGE, $HREF_DIR_INSTEAD_FILE, $USE_MENU_DIRECTIONS
-  they have been obsolete, sometimes for many years.
address@hidden DATE is now set as today, DOCUMENT_ENCODING as documentencoding,
-  extension as EXTENSION and DOCUMENT_DESCRIPTION as documentdescription.
address@hidden Don't use perl variables for configuration variables anymore. 
Instead, 
-  they should be set by 
-  @code{set_from_init_file('VARIABLE', value);}.
-  For example 
address@hidden
-$SPLIT = 'node';
address@hidden example
-  should be replaced by
address@hidden
-set_from_init_file('SPLIT', 'node');
address@hidden example
address@hidden configuration variables are not in @code{Texi2HTML::THISDOC} 
directly 
-  anymore, but in 
@code{Texi2HTML::address@hidden'variables'@}->@address@hidden they 
-  should be accessed
-  through @code{get_conf($var)}.
address@hidden remove $Texi2HTML::address@hidden'program_authors'@}. 
$Texi2HTML::address@hidden'program_and_version'@}
-  holds the program and version, while $Texi2HTML::address@hidden'program'@} 
is only
-  the program name.
address@hidden itemize
address@hidden API changes between 1.82 and 5.0:
address@hidden @bullet
address@hidden complex format handling API changed. $complex_format_map is 
replaced by 
-  a real hash %complex_format_map and the begin and end are no more 
-  evaluated.
address@hidden In the default case a gettext-like framework is now used for in 
document
-  string translations. The old framework is still available by setting 
-  $I18N_PERL_HASH.
address@hidden Information that can be set by @@-commands should now be accessed
-  through get_conf.
address@hidden $format_list_item_texi should now modify directly the @@item 
argument
-  and apply the @@-command given as @@table argument. Correspondingly, 
-  some arguments of $table_item have been removed.
address@hidden Formatting of titlepage changed, and @@title, @@subtitle and 
@@author
-  are now handled by $line_command
address@hidden $SEPARATED_FOOTNOTES has been replaced by $FOOTNOTESTYLE, that 
takes the 
-  same argument than @@footnotestyle.
address@hidden replace $LANG by $DOCUMENTLANGUAGE.
address@hidden replace $DO_CONTENTS by $CONTENTS and $DO_SCONTENTS by 
$SHORTCONTENTS.
address@hidden replace $TRANSLITERATE_NODE by $TRANSLITERATE_FILE_NAMES.
address@hidden replace $SECTION_NAVIGATION by $HEADERS.
address@hidden @@verbatiminclude is now a $raw command argument distinct from 
@@verbatim.
address@hidden @@direntry is formatted like a menu and passed down to 
$menu_command.
address@hidden add $NODE_FILENAMES to use node names for files associated with 
nodes, 
-  such that $NODE_FILES is only means creating redirection files.
address@hidden Remove the user from footer, and the corresponding USER variable 
and
-  $Texi2HTML::address@hidden@}.
address@hidden Don't treat _setfilename as a value set. It should be available 
through
-  get_conf. Same for all the other @@-commands previously avaiable as
-  values.
address@hidden change in class attribute for html elements:
-for ul to class "no-bullet" ($NO_BULLET_LIST_ATTRIBUTE). @@top 
-and @@centerchap have now their command name as class.
-@@node heading class is now "node-heading", instead of "node".
-The whole header is in an element with class "header" 
-(was "node" when !$HEADER_IN_TABLE).
address@hidden print_element_header is obsoleted, 
-things should be directly done in element_heading.
address@hidden Add 'inline_attribute' for an XML attribute that should be 
closed at
-  paragraph end and reopened at paragraph begin. Consequently the closing
-  and opening of 'attribute' isn't done anymore in paragraph and 
-  preformatted.
address@hidden USE_ISO now only determines if @code{''}, @code{``} @code{---} 
and @code{--} are transformed
-  into entities. t2h_default_set_iso_symbols sets or unsets USE_ISO,
-  %things_map/%pre_map/%simple_format_simple_map_texi, 
-  $OPEN_QUOTE_SYMBOL and $CLOSE_QUOTE_SYMBOL.
-  %iso_symbols is unused now.
address@hidden change in the normal_text function reference API, now there is 
an 
-  input variable true if in @@math.
address@hidden change the external_ref API, fourth argument is now the file 
name and
-  add the node as an extra argument.
address@hidden rename $Texi2HTML::address@hidden@} as 
$Texi2HTML::address@hidden@}
address@hidden itemize
address@hidden API changes between 1.78 and 1.80: 
address@hidden @bullet
address@hidden what was done in the beginning of the $print_section 
-function reference is now done in $print_element_header.
address@hidden there is a new argument for $normal_text.
address@hidden there is a new argument for $menu_link and $simple_menu_link, 
and the 
-name argument is always set, even if there is no explicit name. The new 
-argument is true if there really was an explicit name.
address@hidden $internal_ref and $external_ref don't change inforef to xref 
anymore.
address@hidden in $table_item the text is not formatted with the format command,
-  the text_formatted argument is.
address@hidden definition index entries are now formatted with 
$definition_index_entry,
-  not with $definition_category anymore.
address@hidden $printindex is called if an index appears, even if the index is 
not 
-defined or there are no index entries.
address@hidden  new argument (@@-command name) for $quotation and 
$quotation_prepend_text.
address@hidden change in the heading API. THIS_HEADER is not used anymore.
-  New function reference, element_heading  to format a node or a section 
-  heading, including navigation and label. Accordingly, print_Top and 
-  one_section don't print the element header anymore. Also it is
-  reported if the element is a new element, is the main element and
-  more arguments, and top element heading is always done in heading.
address@hidden  print_element_header and print_navigation now return their 
result.      
address@hidden the @code{copying} key of %Texi2HTML::THISDOC is now called
address@hidden
address@hidden TOC_LIST_ATTRIBUTE is now called NO_BULLET_LIST_ATTRIBUTE.
address@hidden TOC_LIST_STYLE is now called NO_BULLET_LIST_STYLE.
address@hidden the $unknown function reference has a new argument, the pass 
number.
address@hidden @option{--sec-nav} is replaced by @option{--headers}.
address@hidden @option{--Verbose} is replaced by @option{--verbose}.
address@hidden @option{--lang} is replaced by @option{--document-language}.
address@hidden @option{--separated-footnotes} is replaced by 
@option{--footnote-style}.
address@hidden @option{--lang} is replaced by @option{--document-language}.
address@hidden @code{&$menu_comment} is removed, @code{menu_comment} is now 
handled
-  like an @@-command.
address@hidden @code{@@detailmenu} is now formatted more like @code{@@menu}, and
-the @code{&$menu} function reference is replaced by @code{&$menu_command}.
address@hidden&$menu} is kept for backward compatibility. If @code{&$menu} is 
defined, 
address@hidden@@detailmenu} is ignored.
address@hidden the API for the formatting of menus completly changed. 
$simple_menu_link
-  is removed, everything should be done in $menu_link.
address@hidden image API changed, and is unstable, so not documented.
address@hidden image file paths are not completed anymore in the default case. 
-  The previous
-  behaviour can be restored with @code{$COMPLETE_IMAGE_PATHS} set to true.
address@hidden in %misc_command @samp{texi} is not used anymore. The value and 
macros
-are expanded as they should be unconditionnally.
address@hidden there is a new 'style' key in $complex_format_map, to be able to 
-  differentiate complex formats inheriting fonts and code_style (like 
-  @@format, @@display).
address@hidden $EXTENSION should be undef if one doesn't want an extension to 
be added.
address@hidden address@hidden'title'@} and similar are now for @@title since 
only one @@title
-  should appear in the document. @@settitle is tried first to set fulltitle.
address@hidden Configuration variables are modified anymore, instead the 
variable
-  value is put in $Texi2HTML::address@hidden'VAR'@}. This is the case for
-  DO_CONTENTS, DO_SCONTENTS, CSS_LINES, BODYTEXT, DOCUMENT_DESCRIPTION,
-  DOCUMENT_ENCODING, IN_ENCODING, ENCODING_NAME, OUT_ENCODING.
-
-  For example, if $CSS_LINES is defined, the value is put in 
-  $Texi2HTML::address@hidden'CSS_LINES'@} which is used for formatting, and if
-  $CSS_LINES is not defined, $Texi2HTML::address@hidden'CSS_LINES'@} is 
-  autodetected.
address@hidden  When there is no section and $USE_NODES is not set don't split 
by node.
-This behaviour and the previous aren't documented, so it could change
-in the future.
address@hidden itemize
address@hidden API changes between 1.76 and 1.78: 
address@hidden @bullet
address@hidden paragraph has new arguments
-with indentation information, added as the third argument, and
-other context information. The formatting linked with commands
-opened before the paragraph and closed after the paragraph are done
-in the formatting function. Similar
-things are done for preformatted.
address@hidden normal_text 
-changed completely. There
-are much more arguments to give informations about the context, and
-normal_text now does more text manipulation. 
address@hidden New arguments for image the alt text, the height and width, 
-the path to working dir and the path to image file relative 
-to working dir. More image formatting is
-done in the formatting function.
address@hidden New argument for empty_line.
address@hidden End of line removal is done in formatting function of definition 
line
-formatting.
address@hidden node_file_name now should only returns the node file, since the 
-redirection file isn't used anymore. element_file_name only is used for 
-file names, whatever NODES_FILES is.
address@hidden itemize
address@hidden changes between 1.66 and 1.68:
address@hidden @bullet
address@hidden When the manual is split the default is to put resulting files 
in 
-a directory with name the manual file basename (previously they were left in
- the current directory). To avoid that, call texi2html with 
address@hidden .}. This has been changed to be compatible with 
address@hidden and also because it fits better with the cross
-manuals reference scheme.
address@hidden The option @option{--output} signification changed. It now
-has the same meaning than for @command{makeinfo}. It seems
-that in 1.66 it was the same than @option{-out-file}. 
address@hidden new meaning allows to replace @option{-out-file} and 
address@hidden with a unique option. 
-
-More precisely @option{-out-file} forces the output to be unsplit 
-while @option{--output} behaves differently when split (it specifies
-the directory
-where the manual files should be outputted) and unsplit (it specifies
-the output file). @option{-subdir} is retained for backward compatibility.
-
-If you want a backward compatibility you can use @option{-subdir} 
-for the output directory if the document is split, and @option{-out-file}
-if the document isn't split. This hasn't been tested extensively though.
address@hidden Many options has been obsoleted but they are retained for
-backward compatibility.
address@hidden The init files are searched in new directories, however they 
-are still searched for in the old directories for backward
-compatibility.
address@hidden the option @option{--glossary} doesn't do anything. Likely
-nothing specific is done regarding bibliographies. This has been
-decided because this added some semantics to the texinfo formatting 
-language that weren't part of texinfo. 
-
-It should be possible to do
-something similar with macros. See for example @file{glossary.texi} 
-for glossary and @file{my-bib-macros.texi} for bibliography
-in the directory @file{examples}. In the web2c package there is
-an example of use of BibTeX, see 
@url{http://tug.org/texlive/devsrc/Build/source/TeX/texk/web2c/doc/} (the 
examples for bibliography are taken from the
-texinfo home page @url{http://www.gnu.org/software/texinfo/texinfo.html}).
address@hidden don't use @code{T2H_CENTER_IMAGE}. @code{@@center} should be used
-insead, it will give the right output for all the formats.
address@hidden If a directory creation fails the program aborts. This is much 
safer.
address@hidden The interface for internationalisation changed, although
-the previous wasn't documented a lot.
address@hidden the API described in this manual changed a lot. A important
-change was to use the @code{Texi2HTML::Config} names space instead of
-variables prefixed with @samp{T2H_} or  @samp{t2h_}. To cope with
-the change the prefix should be removed from variables in init files.
-Some variables are now in @code{%Texi2HTML::THISDOC}.
address@hidden @code{@@ifinfo} regions are not expanded by default. This may 
lead
-to warnings or errors especially if the Top node is enclosed in 
address@hidden@@ifinfo}, as some node won't appear in menus. The quick fix
-is to call @command{texi2html} with the option @option{--ifinfo} and
-the right way should be to make more use of @code{@@ifnottex}.
address@hidden The code appearing before the first node is now outputted, it was
-ignored before. @option{--ignore-preamble-text} revert to the previous
-behaviour. Enclosing in @code{@@ifnothtml} would be much cleaner.
-
address@hidden itemize
address@hidden itemize
+the tag table and a directory of subfiles.
 
 
 @node Info Format Specification

Index: doc/texi2oldapi.texi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texi2oldapi.texi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/texi2oldapi.texi        5 Nov 2010 23:26:21 -0000       1.1
+++ doc/texi2oldapi.texi        10 Jan 2011 17:45:53 -0000      1.2
@@ -1,11 +1,350 @@
address@hidden sections from the texi2html manual (only partly edited), removed
address@hidden because the new tree-based translators is likely to obviate them.
address@hidden history and some customization sections from the texi2html manual
address@hidden (only partly edited), excised
address@hidden because the new tree-based translator is likely to obviate them.
 @c Doesn't format on its own, is just here (for now) for archival purposes.
 @c
 @c   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
address@hidden   2001, 2002, 2003, 2004, 2009, 2010 Free Software Foundation, 
Inc.
address@hidden   2001, 2002, 2003, 2004, 2009, 2010, 2011 Free Software 
Foundation, Inc.
 @c See texinfo.txi for copying conditions.
 
address@hidden Texi2HTML
address@hidden Texi2HTML history and relations with @command{makeinfo}
+
+In 2010 Texi2HTML was merged in GNU Texinfo.  Some informations are
+retained here, mainly for historical purposes.
+
address@hidden
+* Texi2HTML history::               Texi2HTML history and makeinfo.
+* Texi2HTML texi2any differences::
+* Texi2HTML changes::               History of incompatibilities.
address@hidden menu
+
address@hidden Texi2HTML history
address@hidden Texi2HTML history and merge in Texinfo
+
+In early 1998 @command{makeinfo} wasn't able to produce
+HTML output format, but people still wanted documentation in
+HTML.  This was the birthing hour for @command{texi2html},
+with original author Lionel Cons.  The basic purpose of 
address@hidden was to convert Texinfo documents into HTML.
+
+Since then, HTML support in @command{makeinfo} improved, but
address@hidden was still stronger in some areas, including the degree to
+which it allows customization.  After being briefly maintained by Karl
+Berry in 1999, Olaf Bachmann was the maintainer until 2000, adding many 
+features.  Adrian Aichner and Derek Price took over maintainance in 2001 
+and Derek was the maintainer from 2003 to 2010, with some help from 
+Patrice Dumas.
+
+In 2010, @command{texi2html}, then hosted
+at @uref{http://www.nongnu.org/texi2html/} was made
+compatible with @command{makeinfo}, losing the focus on HTML to become a
+more generic translator, and merged in 
address@hidden://www.gnu.org/software/texinfo/, GNU Texinfo} to
+replace @command{makeinfo} in C.
address@hidden is now installed as part of the texinfo package install,
+as an alias of @command{texi2any}.  The @command{texi2html} documentation 
+is also merged here in the Texinfo manual, as 
+the @command{texi2any}/@command{makeinfo} documentation.
+
address@hidden Texi2HTML texi2any differences
address@hidden Differences between @command{texi2html} and @command{texi2any} 
invokation
+
+There are some differences between an invokation of @command{texi2any} or
address@hidden and @command{texi2html}.  With @command{texi2html}:
address@hidden @bullet
address@hidden HTML is the default output, as with @option{--html}.
address@hidden Command line is not parsed exactly like GNU getopt does. To be 
on the safe
+side:
address@hidden @bullet
address@hidden always use two dashes for long options.
address@hidden do not bundle short options, that is, use @code{-v -o -P} and 
not @code{-voP}.
address@hidden itemize
address@hidden Some options, although obsoleted are still available.
address@hidden The defaults for the HTML formatting may be slightly different. 
+Have a look at the function @code{t2h_default_set_variables_texi2html} 
+in @file{texi2html.init}.
address@hidden itemize
+
address@hidden Texi2HTML changes
address@hidden Texi2HTML incompatibilities with previous versions
+
address@hidden has accumulated a lot of incompatibilities in previous
+versions, and more were added after the merge in Texinfo.  Many 
+incompatibilities were introduced in version 1.68.  API changed also a 
+lot between 1.78 and 1.80. Between 1.82 and 5.0 API changed also quite 
+a bit, and more importantly, the whole internationalization handling was 
+changed.
+
address@hidden @bullet
address@hidden API changes between 5.0 and later versions
address@hidden @bullet
+
address@hidden no default initialization file for latex2html.  ALso don't 
search in 
+directories for the latex2html initialization file, simply use the file 
+given in argument.
+
address@hidden  don't show menu with @option{--no-headers} as said in the 
makeinfo documentation.
+
address@hidden obsolete the @option{--iso} command line option.
+
address@hidden obsolete texi2html specific variables. Here is the list with the 
associated
+  configuration variables that may be set instead, with 
@option{--set-init-variable}:
address@hidden address@hidden address@hidden
address@hidden  @option{--toc-links}               @tab @code{TOC_LINKS}
address@hidden  @option{--short-ext}               @tab @code{SHORTEXTN}
address@hidden  @option{--prefix}                  @tab @code{PREFIX}
address@hidden  @option{--short-ref}               @tab @code{SHORT_REF}
address@hidden  @option{--idx-sum}                 @tab @code{IDX_SUMMARY}
address@hidden  @option{--def-table}               @tab @code{DEF_TABLE}
address@hidden  @option{--ignore-preamble-text}    @tab 
@code{IGNORE_PREAMBLE_TEXT}
address@hidden  @option{--html-xref-prefix}        @tab @code{EXTERNAL_DIR}
address@hidden  @option{--l2h}                     @tab @code{L2H}
address@hidden  @option{--l2h-l2h}                 @tab @code{L2H_L2H}
address@hidden  @option{--l2h-skip}                @tab @code{L2H_SKIP}
address@hidden  @option{--l2h-tmp}                 @tab @code{L2H_TMP}
address@hidden  @option{--l2h-file}                @tab @code{L2H_FILE}
address@hidden  @option{--l2h-clean}               @tab @code{L2H_CLEAN}
address@hidden  @option{--use-nodes}               @tab @code{USE_NODES}
address@hidden  @option{--monolithic}              @tab @code{MONOLITHIC}
address@hidden  @option{--top-file}                @tab @code{TOP_FILE}
address@hidden  @option{--toc-file}                @tab @code{TOC_FILE}
address@hidden  @option{--frames}                  @tab @code{FRAMES}
address@hidden  @option{--menu}                    @tab @code{SHOW_MENU}
address@hidden  @option{--debug}                   @tab @code{DEBUG}
address@hidden  @option{--doctype}                 @tab @code{DOCTYPE}
address@hidden  @option{--frameset-doctype}        @tab @code{FRAMESET_DOCTYPE}
address@hidden  @option{--test}                    @tab @code{TEST}
address@hidden multitable
+
address@hidden remove completly $INVISIBLE_MARK, $USE_GLOSSARY, $CHECK, 
$EXPAND, 
+  $ENCODING, $CENTER_IMAGE, $HREF_DIR_INSTEAD_FILE, $USE_MENU_DIRECTIONS
+  they have been obsolete, sometimes for many years.
address@hidden DATE is now set as today, DOCUMENT_ENCODING as documentencoding,
+  extension as EXTENSION and DOCUMENT_DESCRIPTION as documentdescription.
address@hidden Don't use perl variables for configuration variables anymore. 
Instead, 
+  they should be set by 
+  @code{set_from_init_file('VARIABLE', value);}.
+  For example 
address@hidden
+$SPLIT = 'node';
address@hidden example
+  should be replaced by
address@hidden
+set_from_init_file('SPLIT', 'node');
address@hidden example
address@hidden configuration variables are not in @code{Texi2HTML::THISDOC} 
directly 
+  anymore, but in 
@code{Texi2HTML::address@hidden'variables'@}->@address@hidden they 
+  should be accessed
+  through @code{get_conf($var)}.
address@hidden remove $Texi2HTML::address@hidden'program_authors'@}. 
$Texi2HTML::address@hidden'program_and_version'@}
+  holds the program and version, while $Texi2HTML::address@hidden'program'@} 
is only
+  the program name.
address@hidden itemize
address@hidden API changes between 1.82 and 5.0:
address@hidden @bullet
address@hidden complex format handling API changed. $complex_format_map is 
replaced by 
+  a real hash %complex_format_map and the begin and end are no more 
+  evaluated.
address@hidden In the default case a gettext-like framework is now used for in 
document
+  string translations. The old framework is still available by setting 
+  $I18N_PERL_HASH.
address@hidden Information that can be set by @@-commands should now be accessed
+  through get_conf.
address@hidden $format_list_item_texi should now modify directly the @@item 
argument
+  and apply the @@-command given as @@table argument. Correspondingly, 
+  some arguments of $table_item have been removed.
address@hidden Formatting of titlepage changed, and @@title, @@subtitle and 
@@author
+  are now handled by $line_command
address@hidden $SEPARATED_FOOTNOTES has been replaced by $FOOTNOTESTYLE, that 
takes the 
+  same argument than @@footnotestyle.
address@hidden replace $LANG by $DOCUMENTLANGUAGE.
address@hidden replace $DO_CONTENTS by $CONTENTS and $DO_SCONTENTS by 
$SHORTCONTENTS.
address@hidden replace $TRANSLITERATE_NODE by $TRANSLITERATE_FILE_NAMES.
address@hidden replace $SECTION_NAVIGATION by $HEADERS.
address@hidden @@verbatiminclude is now a $raw command argument distinct from 
@@verbatim.
address@hidden @@direntry is formatted like a menu and passed down to 
$menu_command.
address@hidden add $NODE_FILENAMES to use node names for files associated with 
nodes, 
+  such that $NODE_FILES is only means creating redirection files.
address@hidden Remove the user from footer, and the corresponding USER variable 
and
+  $Texi2HTML::address@hidden@}.
address@hidden Don't treat _setfilename as a value set. It should be available 
through
+  get_conf. Same for all the other @@-commands previously avaiable as
+  values.
address@hidden change in class attribute for html elements:
+for ul to class "no-bullet" ($NO_BULLET_LIST_ATTRIBUTE). @@top 
+and @@centerchap have now their command name as class.
+@@node heading class is now "node-heading", instead of "node".
+The whole header is in an element with class "header" 
+(was "node" when !$HEADER_IN_TABLE).
address@hidden print_element_header is obsoleted, 
+things should be directly done in element_heading.
address@hidden Add 'inline_attribute' for an XML attribute that should be 
closed at
+  paragraph end and reopened at paragraph begin. Consequently the closing
+  and opening of 'attribute' isn't done anymore in paragraph and 
+  preformatted.
address@hidden USE_ISO now only determines if @code{''}, @code{``} @code{---} 
and @code{--} are transformed
+  into entities. t2h_default_set_iso_symbols sets or unsets USE_ISO,
+  %things_map/%pre_map/%simple_format_simple_map_texi, 
+  $OPEN_QUOTE_SYMBOL and $CLOSE_QUOTE_SYMBOL.
+  %iso_symbols is unused now.
address@hidden change in the normal_text function reference API, now there is 
an 
+  input variable true if in @@math.
address@hidden change the external_ref API, fourth argument is now the file 
name and
+  add the node as an extra argument.
address@hidden rename $Texi2HTML::address@hidden@} as 
$Texi2HTML::address@hidden@}
address@hidden itemize
address@hidden API changes between 1.78 and 1.80: 
address@hidden @bullet
address@hidden what was done in the beginning of the $print_section 
+function reference is now done in $print_element_header.
address@hidden there is a new argument for $normal_text.
address@hidden there is a new argument for $menu_link and $simple_menu_link, 
and the 
+name argument is always set, even if there is no explicit name. The new 
+argument is true if there really was an explicit name.
address@hidden $internal_ref and $external_ref don't change inforef to xref 
anymore.
address@hidden in $table_item the text is not formatted with the format command,
+  the text_formatted argument is.
address@hidden definition index entries are now formatted with 
$definition_index_entry,
+  not with $definition_category anymore.
address@hidden $printindex is called if an index appears, even if the index is 
not 
+defined or there are no index entries.
address@hidden  new argument (@@-command name) for $quotation and 
$quotation_prepend_text.
address@hidden change in the heading API. THIS_HEADER is not used anymore.
+  New function reference, element_heading  to format a node or a section 
+  heading, including navigation and label. Accordingly, print_Top and 
+  one_section don't print the element header anymore. Also it is
+  reported if the element is a new element, is the main element and
+  more arguments, and top element heading is always done in heading.
address@hidden  print_element_header and print_navigation now return their 
result.      
address@hidden the @code{copying} key of %Texi2HTML::THISDOC is now called
address@hidden
address@hidden TOC_LIST_ATTRIBUTE is now called NO_BULLET_LIST_ATTRIBUTE.
address@hidden TOC_LIST_STYLE is now called NO_BULLET_LIST_STYLE.
address@hidden the $unknown function reference has a new argument, the pass 
number.
address@hidden @option{--sec-nav} is replaced by @option{--headers}.
address@hidden @option{--Verbose} is replaced by @option{--verbose}.
address@hidden @option{--lang} is replaced by @option{--document-language}.
address@hidden @option{--separated-footnotes} is replaced by 
@option{--footnote-style}.
address@hidden @option{--lang} is replaced by @option{--document-language}.
address@hidden @code{&$menu_comment} is removed, @code{menu_comment} is now 
handled
+  like an @@-command.
address@hidden @code{@@detailmenu} is now formatted more like @code{@@menu}, and
+the @code{&$menu} function reference is replaced by @code{&$menu_command}.
address@hidden&$menu} is kept for backward compatibility. If @code{&$menu} is 
defined, 
address@hidden@@detailmenu} is ignored.
address@hidden the API for the formatting of menus completly changed. 
$simple_menu_link
+  is removed, everything should be done in $menu_link.
address@hidden image API changed, and is unstable, so not documented.
address@hidden image file paths are not completed anymore in the default case. 
+  The previous
+  behaviour can be restored with @code{$COMPLETE_IMAGE_PATHS} set to true.
address@hidden in %misc_command @samp{texi} is not used anymore. The value and 
macros
+are expanded as they should be unconditionnally.
address@hidden there is a new 'style' key in $complex_format_map, to be able to 
+  differentiate complex formats inheriting fonts and code_style (like 
+  @@format, @@display).
address@hidden $EXTENSION should be undef if one doesn't want an extension to 
be added.
address@hidden address@hidden'title'@} and similar are now for @@title since 
only one @@title
+  should appear in the document. @@settitle is tried first to set fulltitle.
address@hidden Configuration variables are modified anymore, instead the 
variable
+  value is put in $Texi2HTML::address@hidden'VAR'@}. This is the case for
+  DO_CONTENTS, DO_SCONTENTS, CSS_LINES, BODYTEXT, DOCUMENT_DESCRIPTION,
+  DOCUMENT_ENCODING, IN_ENCODING, ENCODING_NAME, OUT_ENCODING.
+
+  For example, if $CSS_LINES is defined, the value is put in 
+  $Texi2HTML::address@hidden'CSS_LINES'@} which is used for formatting, and if
+  $CSS_LINES is not defined, $Texi2HTML::address@hidden'CSS_LINES'@} is 
+  autodetected.
address@hidden  When there is no section and $USE_NODES is not set don't split 
by node.
+This behaviour and the previous aren't documented, so it could change
+in the future.
address@hidden itemize
address@hidden API changes between 1.76 and 1.78: 
address@hidden @bullet
address@hidden paragraph has new arguments
+with indentation information, added as the third argument, and
+other context information. The formatting linked with commands
+opened before the paragraph and closed after the paragraph are done
+in the formatting function. Similar
+things are done for preformatted.
address@hidden normal_text 
+changed completely. There
+are much more arguments to give informations about the context, and
+normal_text now does more text manipulation. 
address@hidden New arguments for image the alt text, the height and width, 
+the path to working dir and the path to image file relative 
+to working dir. More image formatting is
+done in the formatting function.
address@hidden New argument for empty_line.
address@hidden End of line removal is done in formatting function of definition 
line
+formatting.
address@hidden node_file_name now should only returns the node file, since the 
+redirection file isn't used anymore. element_file_name only is used for 
+file names, whatever NODES_FILES is.
address@hidden itemize
address@hidden changes between 1.66 and 1.68:
address@hidden @bullet
address@hidden When the manual is split the default is to put resulting files 
in 
+a directory with name the manual file basename (previously they were left in
+ the current directory). To avoid that, call texi2html with 
address@hidden .}. This has been changed to be compatible with 
address@hidden and also because it fits better with the cross
+manuals reference scheme.
address@hidden The option @option{--output} signification changed. It now
+has the same meaning than for @command{makeinfo}. It seems
+that in 1.66 it was the same than @option{-out-file}. 
address@hidden new meaning allows to replace @option{-out-file} and 
address@hidden with a unique option. 
+
+More precisely @option{-out-file} forces the output to be unsplit 
+while @option{--output} behaves differently when split (it specifies
+the directory
+where the manual files should be outputted) and unsplit (it specifies
+the output file). @option{-subdir} is retained for backward compatibility.
+
+If you want a backward compatibility you can use @option{-subdir} 
+for the output directory if the document is split, and @option{-out-file}
+if the document isn't split. This hasn't been tested extensively though.
address@hidden Many options has been obsoleted but they are retained for
+backward compatibility.
address@hidden The init files are searched in new directories, however they 
+are still searched for in the old directories for backward
+compatibility.
address@hidden the option @option{--glossary} doesn't do anything. Likely
+nothing specific is done regarding bibliographies. This has been
+decided because this added some semantics to the texinfo formatting 
+language that weren't part of texinfo. 
+
+It should be possible to do
+something similar with macros. See for example @file{glossary.texi} 
+for glossary and @file{my-bib-macros.texi} for bibliography
+in the directory @file{examples}. In the web2c package there is
+an example of use of BibTeX, see 
@url{http://tug.org/texlive/devsrc/Build/source/TeX/texk/web2c/doc/} (the 
examples for bibliography are taken from the
+texinfo home page @url{http://www.gnu.org/software/texinfo/texinfo.html}).
address@hidden don't use @code{T2H_CENTER_IMAGE}. @code{@@center} should be used
+insead, it will give the right output for all the formats.
address@hidden If a directory creation fails the program aborts. This is much 
safer.
address@hidden The interface for internationalisation changed, although
+the previous wasn't documented a lot.
address@hidden the API described in this manual changed a lot. A important
+change was to use the @code{Texi2HTML::Config} names space instead of
+variables prefixed with @samp{T2H_} or  @samp{t2h_}. To cope with
+the change the prefix should be removed from variables in init files.
+Some variables are now in @code{%Texi2HTML::THISDOC}.
address@hidden @code{@@ifinfo} regions are not expanded by default. This may 
lead
+to warnings or errors especially if the Top node is enclosed in 
address@hidden@@ifinfo}, as some node won't appear in menus. The quick fix
+is to call @command{texi2html} with the option @option{--ifinfo} and
+the right way should be to make more use of @code{@@ifnottex}.
address@hidden The code appearing before the first node is now outputted, it was
+ignored before. @option{--ignore-preamble-text} revert to the previous
+behaviour. Enclosing in @code{@@ifnothtml} would be much cleaner.
+
address@hidden itemize
address@hidden itemize
+
+
 
 * Customizing HTML Basic Commands:: Commands with no arguments, images, etc.
 * Customizing HTML References::     @code{@@xref}, external node pointers, etc.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]