[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo/texi2html ChangeLog NEWS TODO texi2html...
From: |
Patrice Dumas |
Subject: |
texinfo/texi2html ChangeLog NEWS TODO texi2html... |
Date: |
Wed, 14 Jul 2010 23:05:24 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Patrice Dumas <pertusus> 10/07/14 23:05:24
Modified files:
texi2html : ChangeLog NEWS TODO texi2html.init texi2html.pl
texi2html/doc : stamp-vti texi2html.texi version.texi
Log message:
* texi2html.pl: remove $Texi2HTML::THISDOC{'out_dir'}.
* texi2html.pl: set more @-command related information in
configuration variables.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/ChangeLog?cvsroot=texinfo&r1=1.515&r2=1.516
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/NEWS?cvsroot=texinfo&r1=1.126&r2=1.127
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/TODO?cvsroot=texinfo&r1=1.185&r2=1.186
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/texi2html.init?cvsroot=texinfo&r1=1.275&r2=1.276
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/texi2html.pl?cvsroot=texinfo&r1=1.397&r2=1.398
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/doc/stamp-vti?cvsroot=texinfo&r1=1.78&r2=1.79
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/doc/texi2html.texi?cvsroot=texinfo&r1=1.109&r2=1.110
http://cvs.savannah.gnu.org/viewcvs/texinfo/texi2html/doc/version.texi?cvsroot=texinfo&r1=1.78&r2=1.79
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/ChangeLog,v
retrieving revision 1.515
retrieving revision 1.516
diff -u -b -r1.515 -r1.516
--- ChangeLog 14 Jul 2010 20:22:11 -0000 1.515
+++ ChangeLog 14 Jul 2010 23:05:23 -0000 1.516
@@ -7,6 +7,9 @@
$Texi2HTML::THISDOC{'program'} hold the program name only.
Remove $Texi2HTML::THISDOC{'program_authors'}.
Simplify the comment at the beginning of html output files.
+ * texi2html.pl: remove $Texi2HTML::THISDOC{'out_dir'}.
+ * texi2html.pl: set more @-command related information in
+ configuration variables.
2010-07-13 Patrice Dumas <address@hidden>
Index: NEWS
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/NEWS,v
retrieving revision 1.126
retrieving revision 1.127
diff -u -b -r1.126 -r1.127
--- NEWS 14 Jul 2010 20:22:12 -0000 1.126
+++ NEWS 14 Jul 2010 23:05:23 -0000 1.127
@@ -58,6 +58,8 @@
holds the program and version, while $Texi2HTML::THISDOC{'program'} is only
the program name.
+* remove $Texi2HTML::THISDOC{'out_dir'}.
+
5.0 (2010-06-27)
* NEW FEATURES
Index: TODO
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/TODO,v
retrieving revision 1.185
retrieving revision 1.186
diff -u -b -r1.185 -r1.186
--- TODO 14 Jul 2010 20:22:12 -0000 1.185
+++ TODO 14 Jul 2010 23:05:23 -0000 1.186
@@ -6,12 +6,14 @@
remove l2h_tmp_dir.init from .cvsignore and Makefile.am
ship texi2any, makeinfo
change licenses to be FSF + GPLv3+
-remove set_default that sets to undef in load after inspection
-verify all the THISDOC. Some should certinaly be set_from_document
Later
-----
+* automatic menus.
+
+* automatic nodes, if feasible (issue of unicity, mostly).
+
* not a priority since it involves a lot of work. It would be nice to
have the texinfo parsing in a separate perl module (as Derek suggested).
It would do a tree out of texinfo code, and also a tree of the
@@ -82,6 +84,7 @@
$DATE_IN_HEADER
$INDEX_ENTRY_COLON
$MENU_ENTRY_COLON
+ CSS_LINES
$Texi2HTML::THISDOC{'htmlxref'}
$Texi2HTML::THISDOC{macro name}
$Texi2HTML::THISDOC{'hyphenation'}
@@ -92,7 +95,6 @@
$Texi2HTML::THISDOC{'simpletitle'}
$Texi2HTML::THISDOC{'filename'}->{'toc_frame'}
$Texi2HTML::THISDOC{'filename'}->{'frame'}
- $Texi2HTML::THISDOC{'CSS_LINES'}
'childnext'
$empty_preformatted
Index: texi2html.init
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/texi2html.init,v
retrieving revision 1.275
retrieving revision 1.276
diff -u -b -r1.275 -r1.276
--- texi2html.init 14 Jul 2010 20:22:12 -0000 1.275
+++ texi2html.init 14 Jul 2010 23:05:23 -0000 1.276
@@ -13,7 +13,7 @@
# Afterwards, load the file with command-line
# option --init-file <your_init_file>
#
-# $Id: texi2html.init,v 1.275 2010/07/14 20:22:12 pertusus Exp $
+# $Id: texi2html.init,v 1.276 2010/07/14 23:05:23 pertusus Exp $
######################################################################
# The following variables can also be set by command-line options
@@ -272,7 +272,7 @@
set_default('IGNORE_PREAMBLE_TEXT', 0);
# --html-xref-prefix
-# base directory for external manuals.
+# base directory for external manuals. Obsolete.
set_default('EXTERNAL_DIR', undef);
# --l2h
@@ -582,10 +582,6 @@
# if set, then use node names in menu entries, instead of section names
set_default('NODE_NAME_IN_MENU', 1);
-# if set use the node names in index entry, instead of section names
-# if not set, it is set to the same value than NODE_NAME_IN_MENU
- set_default('NODE_NAME_IN_INDEX', undef);
-
# if set always separate description and menu link, even in
# preformatted environment
set_default('SEPARATE_DESCRIPTION', 0);
@@ -610,9 +606,6 @@
# after they have more than that many entries
set_default('SPLIT_INDEX', 0);
-# file name used for Top node when NODE_FILES is true
- set_default('TOP_NODE_FILE', undef);
-
# extensions used for images
@IMAGE_EXTENSIONS = ('png','jpg', 'txt');
@@ -779,7 +772,9 @@
set_default('HEADERS', 0);
set_default('SIMPLE_MENU', 1);
set_default('INLINE_INSERTCOPYING', 0);
- set_default('NODE_FILENAMES', undef);
+ # reset here, in case it was set to something else by another
+ # format.
+ set_default('TOP_NODE_FILE', undef);
%simple_map = %default_simple_map;
%simple_map_pre = %simple_map;
@@ -1237,78 +1232,16 @@
# is used in main program for dumping texi too.
sub t2h_default_set_out_encoding()
{
- # $Texi2HTML::THISDOC{'*_ENCODING'} to keep code shorter
- #my ($out_encoding, $encoding_name);
-
- #if (defined($OUT_ENCODING))
- #{
- # $out_encoding = $OUT_ENCODING;
- #}
-
- #if (defined($ENCODING_NAME))
- #{
- # $encoding_name = $ENCODING_NAME;
- #}
-
+ # set in reverse order of precedence, such that later setting
+ # override the first settings.
my $out_encoding_from_documentencoding = main::encoding_alias
(get_conf('documentencoding'), undef, 'determining encoding from
documentencoding');
set_from_document('OUT_ENCODING', $out_encoding_from_documentencoding) if
(defined($out_encoding_from_documentencoding));
set_from_document('OUT_ENCODING', get_conf('IN_ENCODING')) if
(defined(get_conf('IN_ENCODING')));
my $out_encoding_from_encoding_name = main::encoding_alias
(get_conf('ENCODING_NAME'), undef, 'determining encoding from default
encoding');
set_from_document('OUT_ENCODING', $out_encoding_from_encoding_name) if
(defined($out_encoding_from_encoding_name));
- main::document_warn (__("Document encoding is utf8, but there is no
unicode support")) if (defined(get_conf('OUT_ENCODING')) and
get_conf('OUT_ENCODING') eq 'utf-8' and !get_conf('USE_UNICODE'));
-
- #if (!defined(get_conf('OUT_ENCODING')) and
(defined(get_conf('ENCODING_NAME'))))
- #{
- # my $possible_out_encoding = main::encoding_alias
(get_conf('ENCODING_NAME'), undef, 'determining encoding from default
encoding');
- #
- # $out_encoding = $possible_out_encoding if
(defined($possible_out_encoding));
- #}
- #if (!defined($out_encoding) and (defined(get_conf('IN_ENCODING'))))
- #{
- # $out_encoding = get_conf('IN_ENCODING');
- #}
- #if (!defined($out_encoding) and (defined(get_conf('documentencoding'))))
- #{
- # my $possible_out_encoding = main::encoding_alias
(get_conf('documentencoding'), undef, 'determining encoding from
documentencoding');
- # $out_encoding = $possible_out_encoding if
(defined($possible_out_encoding));
- #}
+ main::document_warn (__("Document encoding is utf8, but there is no
unicode support")) if (defined(get_conf('OUT_ENCODING')) and
get_conf('OUT_ENCODING') eq 'utf-8' and !get_conf('USE_UNICODE'));
-# if (!defined($encoding_name))
-# {
-# if (defined($out_encoding) and
defined($perl_charset_to_html{$out_encoding}))
-# {
-# $encoding_name = $perl_charset_to_html{$out_encoding};
-# }
-# elsif (defined(get_conf('IN_ENCODING')) and
defined($perl_charset_to_html{get_conf('IN_ENCODING')}))
-# {
-# $encoding_name = $perl_charset_to_html{get_conf('IN_ENCODING')};
-# }
-# elsif (defined(get_conf('documentencoding')) and
defined($perl_charset_to_html{get_conf('documentencoding')}))
-# {
-# $encoding_name =
$perl_charset_to_html{get_conf('documentencoding')};
-# }
-# elsif (defined($out_encoding))
-# {
-# $encoding_name = $out_encoding;
-# }
-# elsif (defined(get_conf('IN_ENCODING')))
-# {
-# $encoding_name = get_conf('IN_ENCODING');
-# }
-# elsif (defined(get_conf('documentencoding')))
-# {
-# $encoding_name = get_conf('documentencoding');
-# }
-# elsif (defined(get_conf('DEFAULT_ENCODING')) and
defined($perl_charset_to_html{get_conf('DEFAULT_ENCODING')}))
-# {
-# $encoding_name =
$perl_charset_to_html{get_conf('DEFAULT_ENCODING')};
-# }
-# else
-# {
-# $encoding_name = 'us-ascii';
-# }
-# }
set_from_document('ENCODING_NAME', 'us-ascii');
set_from_document('ENCODING_NAME',
$perl_charset_to_html{get_conf('DEFAULT_ENCODING')}) if
(defined(get_conf('DEFAULT_ENCODING')) and
defined($perl_charset_to_html{get_conf('DEFAULT_ENCODING')}));
set_from_document('ENCODING_NAME', get_conf('documentencoding')) if
(defined(get_conf('documentencoding')));
@@ -1318,9 +1251,9 @@
set_from_document('ENCODING_NAME',
$perl_charset_to_html{get_conf('IN_ENCODING')}) if
(defined(get_conf('IN_ENCODING')) and
defined($perl_charset_to_html{get_conf('IN_ENCODING')}));
set_from_document('ENCODING_NAME',
$perl_charset_to_html{get_conf('OUT_ENCODING')}) if
(defined(get_conf('OUT_ENCODING')) and
defined($perl_charset_to_html{get_conf('OUT_ENCODING')}));
- #$Texi2HTML::THISDOC{'OUT_ENCODING'} = $out_encoding;
- #$Texi2HTML::THISDOC{'ENCODING_NAME'} = $encoding_name;
+ if (get_conf('VERBOSE'))
+ {
# verbose output
my $out_encoding = get_conf('OUT_ENCODING');
$out_encoding = 'UNDEF' if (!defined($out_encoding));
@@ -1329,7 +1262,8 @@
my $document_encoding = get_conf('documentencoding');
$document_encoding = 'UNDEF' if (!defined($document_encoding));
my $encoding_name = get_conf('ENCODING_NAME');
- print STDERR "# Encodings: doc $document_encoding, in $in_encoding out
$out_encoding, name $encoding_name\n" if (get_conf('VERBOSE'));
+ print STDERR "# Encodings: doc $document_encoding, in $in_encoding out
$out_encoding, name $encoding_name\n";
+ }
}
sub t2h_default_init_out()
@@ -6995,8 +6929,6 @@
my $manual_name = shift;
$IDXFILE =
main::open_out("$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}"
. "_$name.idx");
- #open(IDXFILE,
">$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}"
. "_$name.idx")
- # || die "Can't open
>$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}"
. "_$name.idx for writing: $!\n";
}
sub t2h_default_index_summary_file_end($$$)
@@ -7350,13 +7282,11 @@
my $outname;
return unless (get_conf('USE_SETFILENAME_EXTENSION') and
get_conf('PREFIX') eq '');
my $outfile = get_conf('OUTFILE');
- #$outname = $outfile if (defined($outfile) and $outfile ne '' and $outfile
!~ /\/$/ and $Texi2HTML::THISDOC{'input_file_number'} == 0);
$outname = $outfile if (defined($outfile) and $outfile ne '' and
$Texi2HTML::THISDOC{'input_file_number'} == 0);
if ($type eq 'doc' or !get_conf('SPLIT'))
{
if (defined(get_conf('setfilename')) and !defined($outname))
{
- #$Texi2HTML::THISDOC{'extension'} = '';
main::document_override('EXTENSION', '');
return get_conf('setfilename');
}
Index: texi2html.pl
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/texi2html.pl,v
retrieving revision 1.397
retrieving revision 1.398
diff -u -b -r1.397 -r1.398
--- texi2html.pl 14 Jul 2010 20:22:12 -0000 1.397
+++ texi2html.pl 14 Jul 2010 23:05:23 -0000 1.398
@@ -91,7 +91,7 @@
}
# CVS version:
-# $Id: texi2html.pl,v 1.397 2010/07/14 20:22:12 pertusus Exp $
+# $Id: texi2html.pl,v 1.398 2010/07/14 23:05:23 pertusus Exp $
# Homepage:
my $T2H_HOMEPAGE = "http://www.gnu.org/software/texinfo/";
@@ -185,7 +185,13 @@
my @document_global_at_commands = ('contents', 'shortcontents',
'setcontentsaftertitlepage', 'setshortcontentsaftertitlepage',
'footnotestyle', 'novalidate', 'kbdinputstyle', 'documentencoding',
- 'setfilename', 'today', 'documentdescription');
+ 'setfilename', 'today', 'documentdescription',
+# the following are not set to anything in the default
+# case, and currently not used anywhere
+ 'everyheadingmarks','everyfootingmarks',
+
'evenheadingmarks','oddheadingmarks','evenfootingmarks','oddfootingmarks',
+ 'fonttextsize', 'pagesizes', 'setchapternewpage'
+ );
my @command_line_settables = ('DEBUG', 'FILLCOLUMN', 'SPLIT', 'SPLIT_SIZE',
'FRAMES', 'FRAMESET_DOCTYPE', 'HEADERS', 'DOCTYPE', 'TEST', 'DUMP_TEXI',
@@ -1097,8 +1103,6 @@
else
{
$file = "${docu_name}_$t2h_default_file_number";
- #$file .= '.' . $Texi2HTML::THISDOC{'extension'} if
- # (defined($Texi2HTML::THISDOC{'extension'}));
$file .= '.' . get_conf('EXTENSION') if
(defined(get_conf('EXTENSION')));
$t2h_default_seen_files{$default_element_file} = $file;
@@ -1242,8 +1246,6 @@
#file and id
my $relative_file = $Texi2HTML::THISDOC{'file_base_name'} . '_' .
$t2h_default_file_number;
$t2h_default_file_number++;
- #$relative_file .= '.' . $Texi2HTML::THISDOC{'extension'} if
- # (defined($Texi2HTML::THISDOC{'extension'}));
$relative_file .= '.' . get_conf('EXTENSION') if
(defined(get_conf('EXTENSION')));
my $id = "index_split-$t2h_default_index_id_nr";
@@ -4514,8 +4516,6 @@
@Texi2HTML::Config::INCLUDE_DIRS = @include_dirs_orig;
my @prependended_include_directories = ('.');
push @prependended_include_directories,
$Texi2HTML::THISDOC{'input_directory'} if
($Texi2HTML::THISDOC{'input_directory'} ne '.');
- # as Karl said, adding the destination directory is confusing.
- #push @prependended_include_directories, $docu_dir if ($docu_dir ne '.' and
$docu_dir ne $Texi2HTML::THISDOC{'input_directory'});
unshift(@Texi2HTML::Config::INCLUDE_DIRS,
@prependended_include_directories);
unshift(@Texi2HTML::Config::INCLUDE_DIRS, @Texi2HTML::Config::PREPEND_DIRS);
# AAAA
@@ -4535,12 +4535,9 @@
{ # this overrides the setting for this file.
if (get_conf ('SPLIT'))
{
- #$Texi2HTML::THISDOC{'SPLIT'} = '';
document_override('SPLIT', '');
document_warn(sprintf(__('Cannot split output %s'),
get_conf('OUTFILE')));
}
- #$Texi2HTML::THISDOC{'FRAMES'} = 0;
- #$Texi2HTML::THISDOC{'SPLIT_SIZE'} = undef;
document_override('FRAMES', 0);
document_override('SPLIT_SIZE', undef);
$no_file_output = 1;
@@ -4671,10 +4668,7 @@
}
}
- #my $docu_ext = $Texi2HTML::THISDOC{'extension'};
my $docu_ext = get_conf('EXTENSION');
- # out_dir is undocummented, should never be used, use destination_directory
- $Texi2HTML::THISDOC{'out_dir'} = $docu_rdir;
$Texi2HTML::THISDOC{'destination_directory'} = $docu_rdir;
$Texi2HTML::THISDOC{'file_base_name'} = $docu_name;
@@ -5948,7 +5942,6 @@
push @{$Texi2HTML::THISDOC{"${command}s_texi"}}, $arg;
push @{$Texi2HTML::THISDOC{"${command}s_line_nr"}}, $line_nr;
}
- #chomp($arg);
# FIXME backward compatibility. Obsoleted in nov 2009.
$value{"_$command"} .= $arg . "\n";
@@ -6022,7 +6015,7 @@
{
if (($line =~ /^\s+(top)[^\w\-]/) or ($line =~ /^\s+(bottom)[^\w\-]/))
{
- $Texi2HTML::THISDOC{$command} = $1;
+ set_from_document($command, $1);
}
else
{
@@ -6033,7 +6026,7 @@
{
if (($line =~ /^\s+(10)[^\w\-]/) or ($line =~ /^\s+(11)[^\w\-]/))
{
- $Texi2HTML::THISDOC{$command} = $1;
+ set_from_document($command, $1);
}
else
{
@@ -6044,7 +6037,7 @@
{
if ($line =~ /^\s+(.*)\s*$/)
{
- $Texi2HTML::THISDOC{$command} = $1;
+ set_from_document($command, $1);
}
}
elsif ($command eq 'footnotestyle')
@@ -6063,7 +6056,7 @@
if (($line =~ /^\s+(on)[^\w\-]/) or ($line =~ /^\s+(off)[^\w\-]/)
or ($line =~ /^\s+(odd)[^\w\-]/))
{
- $Texi2HTML::THISDOC{$command} = $1;
+ set_from_document($command, $1);
}
else
{
@@ -7816,7 +7809,6 @@
$element->{'doc_nr'} = $doc_nr;
$element->{'file'} = "${docu_name}_$doc_nr"
- #. (defined($Texi2HTML::THISDOC{'extension'}) ?
".$Texi2HTML::THISDOC{'extension'}" : '');
. (defined(get_conf('EXTENSION')) ? '.'.get_conf('EXTENSION')
: '');
my $use_node_file = 0;
if ($element eq $element_top)
@@ -7838,7 +7830,6 @@
{ # use the canonicalized/transliterated section file name.
$element->{'file'} = $element->{'cross'}
. (defined(get_conf('EXTENSION')) ?
'.'.get_conf('EXTENSION') : '');
- #. (defined($Texi2HTML::THISDOC{'extension'}) ?
".$Texi2HTML::THISDOC{'extension'}" : '');
}
# The remaining case is for sectioning elements with empty
# headings and no node associated. They will have a name
@@ -8615,6 +8606,7 @@
$Texi2HTML::THISDOC{'program'} = $THISPROG;
$Texi2HTML::THISDOC{'program_and_version'} = $THISPROG_THISVERSION;
$Texi2HTML::THISDOC{'program_homepage'} = $T2H_HOMEPAGE;
+ # titles is for backard compatibility
foreach my $command (('authors', 'subtitles', 'titles'))
{
$Texi2HTML::THISDOC{$command} = [];
@@ -9257,7 +9249,6 @@
my $file = shift;
my $append = shift;
local *FILE;
-#print STDERR "open_out $file $Texi2HTML::THISDOC{'OUT_ENCODING'}\n";
if ($file eq '-')
{
binmode(STDOUT, ":encoding(".get_conf('OUT_ENCODING').")") if
(get_conf('OUT_ENCODING') and get_conf('USE_UNICODE'));
@@ -9280,7 +9271,6 @@
else
{
binmode(FILE, ':bytes');
- #binmode(FILE, ":encoding($Texi2HTML::THISDOC{'OUT_ENCODING'})");
}
# FIXME is it useful when in utf8?
binmode(FILE, ":encoding(".get_conf('OUT_ENCODING').")");
Index: doc/stamp-vti
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/doc/stamp-vti,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -b -r1.78 -r1.79
--- doc/stamp-vti 14 Jul 2010 15:42:35 -0000 1.78
+++ doc/stamp-vti 14 Jul 2010 23:05:23 -0000 1.79
@@ -1,4 +1,4 @@
address@hidden UPDATED 14 July 2010
address@hidden UPDATED 15 July 2010
@set UPDATED-MONTH July 2010
@set EDITION 5.0
@set VERSION 5.0
Index: doc/texi2html.texi
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/doc/texi2html.texi,v
retrieving revision 1.109
retrieving revision 1.110
diff -u -b -r1.109 -r1.110
--- doc/texi2html.texi 14 Jul 2010 20:22:13 -0000 1.109
+++ doc/texi2html.texi 14 Jul 2010 23:05:23 -0000 1.110
@@ -995,6 +995,9 @@
@menu
* Setting and getting configuration variable value::
+* Global informations:: Accessing global informations, like date,
+ address@hidden
+* Getting flag values::
* Encodings:: Setting the encodings.
* Redefining functions:: Function redefinition is achieved with
redefinition of references on functions.
@@ -1055,12 +1058,196 @@
@code{--set-init-variable 'NO_CSS 1'} on the command-line.
@end defun
-To get the value of a variable, the function is
+To get the value of a variable, the function is @code{get_conf},
+in the @code{Texi2HTML::Config} namespace:
@defun get_conf ($variable_name)
@var{$variable_name} is the name of the variable you want to know the
value.
@end defun
+For example:
+
address@hidden
+if (get_conf('footnotestyle') eq 'separate') @{ .... @}
address@hidden example
+
+Currently the following information corresponding with @@-commands
+is available through @code{get_conf}:
+everyheading, everyfooting, evenheading,
+ evenfooting, oddheading, oddfooting, headings,
+ allowcodebreaks, frenchspacing, exampleindent,
+ firstparagraphindent, paragraphindent, clickstyle,
+ documentlanguage,
+contents, shortcontents,
+ setcontentsaftertitlepage, setshortcontentsaftertitlepage,
+ footnotestyle, novalidate, kbdinputstyle, documentencoding,
+ setfilename, today, documentdescription,
+ everyheadingmarks, everyfootingmarks,
+ evenheadingmarks,oddheadingmarks,evenfootingmarks,oddfootingmarks,
+ fonttextsize, pagesizes, setchapternewpage.
+
+Information that can be set on the command line and in init files, or
+that could be modified on a per-output file basis are also available
+through @code{get_conf} (many other undocumented values are available):
+
address@hidden Setting and getting configuration variable value
address@hidden or in an appendix since more information is required before?
address@hidden @code
address@hidden SPLIT
+How the manual is split.
address@hidden SPLIT_SIZE
+The split size, only relevant for info output.
address@hidden DOCTYPE
+The current doctype.
address@hidden HEADERS
+True if headers are to be output.
address@hidden table
+
address@hidden --------------------------------------------------------
address@hidden Global informations
address@hidden Accessing global informations
+
address@hidden FIXME this is not very well placed, it is quite general and is
buried
address@hidden in the pages fine tuning
+The @variable{%Texi2HTML::THISDOC} hash holds some global informations:
+
address@hidden
+FIXME
+'split_level' 'variable_levels' 'variables' 'toc_file' stoc_file
+%index_letters_array
+%index_entries_array
+%index_entries_region_array
+%index_entries
+%indices_numbers
+%indices
+input_file_name
+input_file_number
+input_directory
+css_import_lines
+css_rule_lines
+do_about
+titlefont_texi
+'file_base_name' 'FH' 'state' 'format_from_command_line' 'input_directory'
'destination_directory' 'file_base_name' %filename 'dircategory_texi'
'dircategory' 'settitle_texi' 'shorttitlepage_texi' 'title_texi'
settitle_line_nr shorttitlepage_line_nr title_line_nr @authors_texi
@authors_line_nr @subtitles_texi @subtitles_line_nr %merged_index @defindex
@defcodeindex
+command_stack top_texi fulltitle_texi simpletitle_texi
+program
+program_and_version
+program_homepage
+copying_comment
+inline_contents
+line_nr
+input_file_name
+%htmlxref
+%hyphenation
+
+author subtitle -> _texi
+
+'shorttitlepage', 'settitle', 'author',
+ 'titlefont', 'subtitle', 'title', 'fulltitle', 'simpletitle'
+-> $thing, $thing _no_texi, $thing _simple_format
address@hidden ignore
+
address@hidden @code
address@hidden fulltitle
+title set by @code{@@settitle}. If there is no @code{@@settitle} other
+possibilities are tried (@code{@@title}, @code{@@address@hidden).
address@hidden fulltitle_no_texi
+fulltitle without texi formatting
address@hidden fulltitle_texi
+fulltitle with texi commands
address@hidden title
address@hidden title set by @code{@@settitle}, or @code{fulltitle}.
+title set by @code{@@title}.
address@hidden title_no_texi
+title without texi formatting
address@hidden title_texi
+title with texi commands
address@hidden author
+Authors list set by @code{@@author}.
address@hidden authors
+A reference on an array containing each author set by @code{@@author}.
address@hidden copying_comment
+Text appearing in @code{@@copying} with all the texinfo commands removed,
+put in comments.
address@hidden program
+The name of the command generating the output.
address@hidden program_and_version
+The name and version of the command generating the output.
address@hidden program_homepage
+Homepage of the command generating the output..
address@hidden file_base_name
+base name of the texinfo manual file.
address@hidden filename
+This is a reference on a hash that holds the filenames for special elements.
+These files may not be used in certain cases, for example the @code{toc}
+element file name may not be relevant if table of contents is not output
+separately.
+The keys are
address@hidden @code
address@hidden doc
+the document file if not split, if split should be the top element file.
address@hidden top
+Top element file name.
address@hidden toc
+Table of contents element file name.
address@hidden stoc
+Overview (also called short table of contents) element file name.
address@hidden about
+About element file name.
address@hidden foot
+Footnotes element file name.
address@hidden frame
+Main frame file.
address@hidden toc_frame
+Table of contents frame file name.
address@hidden table
address@hidden input_file_name
+Name of the texinfo manual file given on the command line.
address@hidden destination_directory
+Destination directory for the resulting files.
address@hidden extension
+Extension for the output files.
address@hidden toc_file
+The file name of the table of contents, should always be valid, even
+when table of contents are output directly in the document.
address@hidden inline_contents
+A reference on a hash containing two key, one for each type of table
+of contents:
address@hidden @code
address@hidden contents
+The associated value is a
+reference on an array containg the line resulting from formatting
+the table of contents, including a heading and a reference.
address@hidden shortcontents
+The associated value is a
+reference on an array containg the line resulting from formatting
+the short table of contents, including a heading and a reference.
address@hidden table
address@hidden today
+The date. May be overriden in @variable{today}.
address@hidden css_import_lines
+reference on an array containing the @code{@@import} lines of
address@hidden files.
address@hidden css_lines
+reference on an array containing the normal lines of
address@hidden files.
address@hidden table
+
address@hidden --------------------------------------------------------
address@hidden Getting flag values
address@hidden Getting the values of flags set by @code{@@set}
+
+Flags defined by @code{@@set} may be accessed through the
address@hidden::value} hash. The key is the flag name, the value is the
+flag value at the end of the document.
+
address@hidden They should now be available through get_conf
address@hidden Special flags are set by the main program. They correspond with
a texinfo
address@hidden command, like @code{@@setfilename}, or @code{@@settitle},
address@hidden @code{@@address@hidden The corresponding flag is the command
name with
address@hidden @samp{_} appended, for example, @code{_titlefont} corresponds
with
address@hidden @code{@@titlefont}. Like other flags they are available in
address@hidden @variable{%main::value}.
+
@c --------------------------------------------------------
@node Encodings
@section Setting the encodings
@@ -1182,8 +1369,10 @@
* The different pages:: The different categories of pages.
* The page layout:: The elements of a page.
* Navigation panel:: How to change the navigation panel.
-* Program variables:: The available main program variables and some
- usefull functions from the main program.
+* Variables and functions for elements::
+ Main program variables and some functions
+ from the main program usefull for elements
+ formatting.
* Output initialization:: Setting variables before the document
production but after the texinfo parsing.
* Output finalization:: Cleaning after document generation.
@@ -1281,7 +1470,7 @@
directions are specified on node line or in menu organization).
These items are called @dfn{element labels}. They may be associated with
a button (@pxref{Button specifications}), and used in the formatting functions
-(@pxref{Program variables}).
+(@pxref{Elements hashes}).
Here is the list:
@@ -1480,19 +1669,19 @@
@end deftypefn
@c --------------------------------------------------------
address@hidden Program variables
address@hidden Main program variables and usefull functions
address@hidden Variables and functions for elements
address@hidden Variables and functions usefull for elements formatting
In the functions
-controlling the page layout some global variables set by the main
+controlling the page layout some variables set by the main
program are available, with value corresponding with the current
layout element.
@menu
* Elements hashes:: Accessing information related with the
different elements
-* Global informations:: Accessing global informations, like date,
- address@hidden
+* Section lines:: Accessing the line of the current
+ section and special sections
* Global functions:: main program usefull functions
@end menu
@@ -1520,158 +1709,8 @@
that section.
@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
address@hidden Global informations
address@hidden Accessing global informations
-
-Three kinds of global informations are available, miscalleneous global
-strings, flags set by @code{@@set} and special flags and section lines.
-
address@hidden Strings that can be set by some @@-commands
address@hidden get_conf
-
-Some information may be set up by @@-commands, by
-a variable in the init file, and sometime on the command-line.
-This is the case, for example, for
address@hidden@@footnotestyle}, @samp{--footnote-style}Â and
@code{$FOOTNOTESTYLE}.
-The value associated with these should be read by calling the @code{get_conf}
-function, in the @code{Texi2HTML::Config} namespace, for example:
-
address@hidden
-if (get_conf('footnotestyle') eq 'separate') @{ .... @}
address@hidden example
-
-When it exists, the associated
-variable that sets the default value have the same name, in upper case.
-Currently the following information corresponding with @@-commands
-is available through
address@hidden:
- kbdinputstyle, paragraphindent, setchapternewpage, headings,
- footnotestyle,
- exampleindent, firstparagraphindent, everyheading, everyfooting,
- evenheading, evenfooting, oddheading, oddfooting, setcontentsaftertitlepage,
- setshortcontentsaftertitlepage, frenchspacing, fillcolumn, documentlanguage,
- novalidate.
-
-Information nthat can be set on the command line and in init files, or
-that could be modified on a per-output file basis are also available
-through @code{get_conf}:
-
address@hidden @code
address@hidden SPLIT
-How the manual is split.
address@hidden SPLIT_SIZE
-The split size, only relevant for info output.
address@hidden DOCTYPE
-The current doctype.
address@hidden HEADERS
-True if headers are to be output.
address@hidden table
-
address@hidden Global strings
-
-The @variable{%Texi2HTML::THISDOC} hash holds some global informations:
-
address@hidden @code
address@hidden fulltitle
-title set by @code{@@settitle}. If there is no @code{@@settitle} other
-possibilities are tried (@code{@@title}, @code{@@address@hidden).
address@hidden fulltitle_no_texi
-fulltitle without texi formatting
address@hidden fulltitle_texi
-fulltitle with texi commands
address@hidden title
address@hidden title set by @code{@@settitle}, or @code{fulltitle}.
-title set by @code{@@title}.
address@hidden title_no_texi
-title without texi formatting
address@hidden title_texi
-title with texi commands
address@hidden author
-Authors list set by @code{@@author}.
address@hidden authors
-A reference on an array containing each author set by @code{@@author}.
address@hidden copying_comment
-Text appearing in @code{@@copying} with all the texinfo commands removed,
-put in comments.
address@hidden program
-The name and version of @command{texi2html}.
address@hidden program_homepage
-Homepage for @command{texi2html}.
address@hidden program_authors
-Authors of @command{texi2html}.
address@hidden file_base_name
-base name of the texinfo manual file.
address@hidden filename
-This is a reference on a hash that holds the filenames for special elements.
-These files may not be used in certain cases, for example the @code{toc}
-element file name may not be relevant if table of contents is not output
-separately.
-The keys are
address@hidden @code
address@hidden doc
-the document file if not split, if split should be the top element file.
address@hidden top
-Top element file name.
address@hidden toc
-Table of contents element file name.
address@hidden stoc
-Overview (also called short table of contents) element file name.
address@hidden about
-About element file name.
address@hidden foot
-Footnotes element file name.
address@hidden frame
-Main frame file.
address@hidden toc_frame
-Table of contents frame file name.
address@hidden table
address@hidden input_file_name
-Name of the texinfo manual file given on the command line.
address@hidden destination_directory
-Destination directory for the resulting files.
address@hidden extension
-Extension for the output files.
address@hidden toc_file
-The file name of the table of contents, should always be valid, even
-when table of contents are output directly in the document.
address@hidden inline_contents
-A reference on a hash containing two key, one for each type of table
-of contents:
address@hidden @code
address@hidden contents
-The associated value is a
-reference on an array containg the line resulting from formatting
-the table of contents, including a heading and a reference.
address@hidden shortcontents
-The associated value is a
-reference on an array containg the line resulting from formatting
-the short table of contents, including a heading and a reference.
address@hidden table
address@hidden today
-The date. May be overriden in @variable{today}.
address@hidden css_import_lines
-reference on an array containing the @code{@@import} lines of
address@hidden files.
address@hidden css_lines
-reference on an array containing the normal lines of
address@hidden files.
address@hidden table
-
address@hidden Flags
-Flags defined by @code{@@set} may be accessed through the
address@hidden::value} hash. The key is the flag name, the value is the
-flag value at the end of the document.
-
address@hidden They should now be available through get_conf
address@hidden Special flags are set by the main program. They correspond with
a texinfo
address@hidden command, like @code{@@setfilename}, or @code{@@settitle},
address@hidden @code{@@address@hidden The corresponding flag is the command
name with
address@hidden @samp{_} appended, for example, @code{_titlefont} corresponds
with
address@hidden @code{@@titlefont}. Like other flags they are available in
address@hidden @variable{%main::value}.
-
-
address@hidden Section lines
address@hidden Section lines
address@hidden Section lines
The following array references or arrays holds formatted lines:
Index: doc/version.texi
===================================================================
RCS file: /sources/texinfo/texinfo/texi2html/doc/version.texi,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -b -r1.78 -r1.79
--- doc/version.texi 14 Jul 2010 15:42:35 -0000 1.78
+++ doc/version.texi 14 Jul 2010 23:05:24 -0000 1.79
@@ -1,4 +1,4 @@
address@hidden UPDATED 14 July 2010
address@hidden UPDATED 15 July 2010
@set UPDATED-MONTH July 2010
@set EDITION 5.0
@set VERSION 5.0