diff options
Diffstat (limited to 'Build/source/utils/texi2html/doc')
-rw-r--r-- | Build/source/utils/texi2html/doc/Makefile.am | 41 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/Makefile.in | 512 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/TODO | 5 | ||||
-rwxr-xr-x | Build/source/utils/texi2html/doc/mdate-sh | 92 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/stamp-vti | 4 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.html | 6072 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.info | 176 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.info-1 | 1299 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.info-2 | 1262 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.info-3 | 1085 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texi2html.texi | 3426 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/texinfo.tex | 6882 | ||||
-rw-r--r-- | Build/source/utils/texi2html/doc/version.texi | 4 |
13 files changed, 20860 insertions, 0 deletions
diff --git a/Build/source/utils/texi2html/doc/Makefile.am b/Build/source/utils/texi2html/doc/Makefile.am new file mode 100644 index 00000000000..817fef7bc7a --- /dev/null +++ b/Build/source/utils/texi2html/doc/Makefile.am @@ -0,0 +1,41 @@ +# +info_TEXINFOS = texi2html.texi + +#CLEANFILES = texi2html.ps texi2html.pdf texi2html.html \ +# texi2html.ascii +# +texinfodata = $(datadir)/texinfo +texinfohtmldir = $(texinfodata)/html +texinfohtml_DATA = texi2html.html + +# use the script out of the distribution NOT +# an old one which is installed on the client. +TEXI2HTML = $(top_builddir)/texi2html + +EXTRA_DIST = texi2html.html + +texi2html.html: texi2html.texi $(srcdir)/version.texi \ + $(top_builddir)/texi2html.pl $(top_builddir)/texi2html.init \ + $(top_builddir)/MySimple.pm $(top_builddir)/T2h_i18n.pm \ + $(top_builddir)/translations.pl + TEXINPUTS=$(srcdir)::$$TEXINPUTS \ + $(SHELL) $(top_srcdir)/missing-texi2html --run $(TEXI2HTML) -V $< + +txt: texi2html.txt + +SUFFIXES = .txt + +check-local: $(TEXI2HTML) + TEXINPUTS=$(srcdir)::$$TEXINPUTS \ + $(PERL) $(TEXI2HTML) -V $(srcdir)/texi2html.texi + +# texinfo based targets automake neglects to include +.texinfo.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< +.txi.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< +.texi.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< diff --git a/Build/source/utils/texi2html/doc/Makefile.in b/Build/source/utils/texi2html/doc/Makefile.in new file mode 100644 index 00000000000..295c7ee22f2 --- /dev/null +++ b/Build/source/utils/texi2html/doc/Makefile.in @@ -0,0 +1,512 @@ +# Makefile.in generated by automake 1.9.3 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = .. +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = doc +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/stamp-vti $(srcdir)/version.texi TODO mdate-sh \ + texinfo.tex +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +INFO_DEPS = $(srcdir)/texi2html.info +am__TEXINFO_TEX_DIR = $(srcdir) +DVIS = texi2html.dvi +PDFS = texi2html.pdf +PSS = texi2html.ps +HTMLS = texi2html.html +TEXINFOS = texi2html.texi +TEXI2DVI = texi2dvi +TEXI2PDF = $(TEXI2DVI) --pdf --batch +MAKEINFOHTML = $(MAKEINFO) --html +AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) +DVIPS = dvips +am__installdirs = "$(DESTDIR)$(infodir)" "$(DESTDIR)$(texinfohtmldir)" +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; +texinfohtmlDATA_INSTALL = $(INSTALL_DATA) +DATA = $(texinfohtml_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@ +MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@ +MAKEINFO = @MAKEINFO@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_DATE = @PACKAGE_DATE@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_UNICODE = @USE_UNICODE@ +VERSION = @VERSION@ +ac_ct_STRIP = @ac_ct_STRIP@ +am__leading_dot = @am__leading_dot@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +datadir = @datadir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ + +# +info_TEXINFOS = texi2html.texi + +#CLEANFILES = texi2html.ps texi2html.pdf texi2html.html \ +# texi2html.ascii +# +texinfodata = $(datadir)/texinfo +texinfohtmldir = $(texinfodata)/html +texinfohtml_DATA = texi2html.html + +# use the script out of the distribution NOT +# an old one which is installed on the client. +TEXI2HTML = $(top_builddir)/texi2html +EXTRA_DIST = texi2html.html +SUFFIXES = .txt +all: all-am + +.SUFFIXES: +.SUFFIXES: .txt .dvi .html .info .pdf .ps .texi .texinfo .txi +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +.texi.info: + restore=: && backupdir="$(am__leading_dot)am$$$$" && \ + am__cwd=`pwd` && cd $(srcdir) && \ + rm -rf $$backupdir && mkdir $$backupdir && \ + for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \ + if test -f $$f; then mv $$f $$backupdir; restore=mv; else :; fi; \ + done; \ + cd "$$am__cwd"; \ + if $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + -o $@ $<; \ + then \ + rc=0; \ + cd $(srcdir); \ + else \ + rc=$$?; \ + cd $(srcdir) && \ + $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \ + fi; \ + rm -rf $$backupdir; exit $$rc + +.texi.dvi: + TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ + $(TEXI2DVI) $< + +.texi.pdf: + TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ + MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir)' \ + $(TEXI2PDF) $< + +.texi.html: + rm -rf $(@:.html=.htp) + if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + -o $(@:.html=.htp) $<; \ + then \ + rm -rf $@; \ + if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \ + mv $(@:.html=) $@; else mv $(@:.html=.htp) $@; fi; \ + else \ + if test ! -d $(@:.html=.htp) && test -d $(@:.html=); then \ + rm -rf $(@:.html=); else rm -Rf $(@:.html=.htp) $@; fi; \ + exit 1; \ + fi +$(srcdir)/texi2html.info: texi2html.texi $(srcdir)/version.texi +texi2html.dvi: texi2html.texi $(srcdir)/version.texi +texi2html.pdf: texi2html.texi $(srcdir)/version.texi +$(srcdir)/version.texi: @MAINTAINER_MODE_TRUE@ $(srcdir)/stamp-vti +$(srcdir)/stamp-vti: texi2html.texi $(top_srcdir)/configure + @(dir=.; test -f ./texi2html.texi || dir=$(srcdir); \ + set `$(SHELL) $(srcdir)/mdate-sh $$dir/texi2html.texi`; \ + echo "@set UPDATED $$1 $$2 $$3"; \ + echo "@set UPDATED-MONTH $$2 $$3"; \ + echo "@set EDITION $(VERSION)"; \ + echo "@set VERSION $(VERSION)") > vti.tmp + @cmp -s vti.tmp $(srcdir)/version.texi \ + || (echo "Updating $(srcdir)/version.texi"; \ + cp vti.tmp $(srcdir)/version.texi) + -@rm -f vti.tmp + @cp $(srcdir)/version.texi $@ + +mostlyclean-vti: + -rm -f vti.tmp + +maintainer-clean-vti: +@MAINTAINER_MODE_TRUE@ -rm -f $(srcdir)/stamp-vti $(srcdir)/version.texi +.dvi.ps: + $(DVIPS) -o $@ $< + +uninstall-info-am: + $(PRE_UNINSTALL) + @if (install-info --version && \ + install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \ + list='$(INFO_DEPS)'; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + echo " install-info --info-dir='$(DESTDIR)$(infodir)' --remove '$(DESTDIR)$(infodir)/$$relfile'"; \ + install-info --info-dir="$(DESTDIR)$(infodir)" --remove "$(DESTDIR)$(infodir)/$$relfile"; \ + done; \ + else :; fi + @$(NORMAL_UNINSTALL) + @list='$(INFO_DEPS)'; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + relfile_i=`echo "$$relfile" | sed 's|\.info$$||;s|$$|.i|'`; \ + (if cd "$(DESTDIR)$(infodir)"; then \ + echo " rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9])"; \ + rm -f $$relfile $$relfile-[0-9] $$relfile-[0-9][0-9] $$relfile_i[0-9] $$relfile_i[0-9][0-9]; \ + else :; fi); \ + done + +dist-info: $(INFO_DEPS) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + list='$(INFO_DEPS)'; \ + for base in $$list; do \ + case $$base in \ + $(srcdir)/*) base=`echo "$$base" | sed "s|^$$srcdirstrip/||"`;; \ + esac; \ + if test -f $$base; then d=.; else d=$(srcdir); fi; \ + for file in $$d/$$base*; do \ + relfile=`expr "$$file" : "$$d/\(.*\)"`; \ + test -f $(distdir)/$$relfile || \ + cp -p $$file $(distdir)/$$relfile; \ + done; \ + done + +mostlyclean-aminfo: + -rm -rf texi2html.aux texi2html.cp texi2html.cps texi2html.fn texi2html.fns \ + texi2html.ky texi2html.kys texi2html.log texi2html.op \ + texi2html.ops texi2html.pg texi2html.pgs texi2html.tmp \ + texi2html.toc texi2html.tp texi2html.tps texi2html.vr \ + texi2html.vrs texi2html.dvi texi2html.pdf texi2html.ps + +maintainer-clean-aminfo: + @list='$(INFO_DEPS)'; for i in $$list; do \ + i_i=`echo "$$i" | sed 's|\.info$$||;s|$$|.i|'`; \ + echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \ + rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \ + done +install-texinfohtmlDATA: $(texinfohtml_DATA) + @$(NORMAL_INSTALL) + test -z "$(texinfohtmldir)" || $(mkdir_p) "$(DESTDIR)$(texinfohtmldir)" + @list='$(texinfohtml_DATA)'; for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + f=$(am__strip_dir) \ + echo " $(texinfohtmlDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(texinfohtmldir)/$$f'"; \ + $(texinfohtmlDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(texinfohtmldir)/$$f"; \ + done + +uninstall-texinfohtmlDATA: + @$(NORMAL_UNINSTALL) + @list='$(texinfohtml_DATA)'; for p in $$list; do \ + f=$(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(texinfohtmldir)/$$f'"; \ + rm -f "$(DESTDIR)$(texinfohtmldir)/$$f"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkdir_p) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-info +check-am: all-am + $(MAKE) $(AM_MAKEFLAGS) check-local +check: check-am +all-am: Makefile $(INFO_DEPS) $(DATA) +installdirs: + for dir in "$(DESTDIR)$(infodir)" "$(DESTDIR)$(texinfohtmldir)"; do \ + test -z "$$dir" || $(mkdir_p) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: $(DVIS) + +html: html-am + +html-am: $(HTMLS) + +info: info-am + +info-am: $(INFO_DEPS) + +install-data-am: install-info-am install-texinfohtmlDATA + +install-exec-am: + +install-info: install-info-am + +install-info-am: $(INFO_DEPS) + @$(NORMAL_INSTALL) + test -z "$(infodir)" || $(mkdir_p) "$(DESTDIR)$(infodir)" + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + list='$(INFO_DEPS)'; \ + for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + esac; \ + if test -f $$file; then d=.; else d=$(srcdir); fi; \ + file_i=`echo "$$file" | sed 's|\.info$$||;s|$$|.i|'`; \ + for ifile in $$d/$$file $$d/$$file-[0-9] $$d/$$file-[0-9][0-9] \ + $$d/$$file_i[0-9] $$d/$$file_i[0-9][0-9] ; do \ + if test -f $$ifile; then \ + relfile=`echo "$$ifile" | sed 's|^.*/||'`; \ + echo " $(INSTALL_DATA) '$$ifile' '$(DESTDIR)$(infodir)/$$relfile'"; \ + $(INSTALL_DATA) "$$ifile" "$(DESTDIR)$(infodir)/$$relfile"; \ + else : ; fi; \ + done; \ + done + @$(POST_INSTALL) + @if (install-info --version && \ + install-info --version 2>&1 | sed 1q | grep -i -v debian) >/dev/null 2>&1; then \ + list='$(INFO_DEPS)'; \ + for file in $$list; do \ + relfile=`echo "$$file" | sed 's|^.*/||'`; \ + echo " install-info --info-dir='$(DESTDIR)$(infodir)' '$(DESTDIR)$(infodir)/$$relfile'";\ + install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\ + done; \ + else : ; fi +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-aminfo \ + maintainer-clean-generic maintainer-clean-vti + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-aminfo mostlyclean-generic mostlyclean-vti + +pdf: pdf-am + +pdf-am: $(PDFS) + +ps: ps-am + +ps-am: $(PSS) + +uninstall-am: uninstall-info-am uninstall-texinfohtmlDATA + +.PHONY: all all-am check check-am check-local clean clean-generic \ + dist-info distclean distclean-generic distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-exec install-exec-am install-info \ + install-info-am install-man install-strip \ + install-texinfohtmlDATA installcheck installcheck-am \ + installdirs maintainer-clean maintainer-clean-aminfo \ + maintainer-clean-generic maintainer-clean-vti mostlyclean \ + mostlyclean-aminfo mostlyclean-generic mostlyclean-vti pdf \ + pdf-am ps ps-am uninstall uninstall-am uninstall-info-am \ + uninstall-texinfohtmlDATA + + +texi2html.html: texi2html.texi $(srcdir)/version.texi \ + $(top_builddir)/texi2html.pl $(top_builddir)/texi2html.init \ + $(top_builddir)/MySimple.pm $(top_builddir)/T2h_i18n.pm \ + $(top_builddir)/translations.pl + TEXINPUTS=$(srcdir)::$$TEXINPUTS \ + $(SHELL) $(top_srcdir)/missing-texi2html --run $(TEXI2HTML) -V $< + +txt: texi2html.txt + +check-local: $(TEXI2HTML) + TEXINPUTS=$(srcdir)::$$TEXINPUTS \ + $(PERL) $(TEXI2HTML) -V $(srcdir)/texi2html.texi + +# texinfo based targets automake neglects to include +.texinfo.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< +.txi.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< +.texi.txt: + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) \ + --no-headers -o $@ `test -f '$<' || echo '$(srcdir)/'`$< +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/Build/source/utils/texi2html/doc/TODO b/Build/source/utils/texi2html/doc/TODO new file mode 100644 index 00000000000..9cad5c458b1 --- /dev/null +++ b/Build/source/utils/texi2html/doc/TODO @@ -0,0 +1,5 @@ +- use hightlighter perl script (change code2html.pl + let it produce Texinfo code instead of HTML) +- More reference parts. +- Examples on how to make customizations to HTML + output. diff --git a/Build/source/utils/texi2html/doc/mdate-sh b/Build/source/utils/texi2html/doc/mdate-sh new file mode 100755 index 00000000000..37171f21fbd --- /dev/null +++ b/Build/source/utils/texi2html/doc/mdate-sh @@ -0,0 +1,92 @@ +#!/bin/sh +# Get modification time of a file or directory and pretty-print it. +# Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc. +# written by Ulrich Drepper <drepper@gnu.ai.mit.edu>, June 1995 +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + +# Prevent date giving response in another language. +LANG=C +export LANG +LC_ALL=C +export LC_ALL +LC_TIME=C +export LC_TIME + +# Get the extended ls output of the file or directory. +# On HPUX /bin/sh, "set" interprets "-rw-r--r--" as options, so the "x" below. +if ls -L /dev/null 1>/dev/null 2>&1; then + set - x`ls -L -l -d $1` +else + set - x`ls -l -d $1` +fi +# The month is at least the fourth argument +# (3 shifts here, the next inside the loop). +shift +shift +shift + +# Find the month. Next argument is day, followed by the year or time. +month= +until test $month +do + shift + case $1 in + Jan) month=January; nummonth=1;; + Feb) month=February; nummonth=2;; + Mar) month=March; nummonth=3;; + Apr) month=April; nummonth=4;; + May) month=May; nummonth=5;; + Jun) month=June; nummonth=6;; + Jul) month=July; nummonth=7;; + Aug) month=August; nummonth=8;; + Sep) month=September; nummonth=9;; + Oct) month=October; nummonth=10;; + Nov) month=November; nummonth=11;; + Dec) month=December; nummonth=12;; + esac +done + +day=$2 + +# Here we have to deal with the problem that the ls output gives either +# the time of day or the year. +case $3 in + *:*) set `date`; eval year=\$$# + case $2 in + Jan) nummonthtod=1;; + Feb) nummonthtod=2;; + Mar) nummonthtod=3;; + Apr) nummonthtod=4;; + May) nummonthtod=5;; + Jun) nummonthtod=6;; + Jul) nummonthtod=7;; + Aug) nummonthtod=8;; + Sep) nummonthtod=9;; + Oct) nummonthtod=10;; + Nov) nummonthtod=11;; + Dec) nummonthtod=12;; + esac + # For the first six month of the year the time notation can also + # be used for files modified in the last year. + if (expr $nummonth \> $nummonthtod) > /dev/null; + then + year=`expr $year - 1` + fi;; + *) year=$3;; +esac + +# The result. +echo $day $month $year diff --git a/Build/source/utils/texi2html/doc/stamp-vti b/Build/source/utils/texi2html/doc/stamp-vti new file mode 100644 index 00000000000..103d48daaa0 --- /dev/null +++ b/Build/source/utils/texi2html/doc/stamp-vti @@ -0,0 +1,4 @@ +@set UPDATED 1 February 2005 +@set UPDATED-MONTH February 2005 +@set EDITION 1.76 +@set VERSION 1.76 diff --git a/Build/source/utils/texi2html/doc/texi2html.html b/Build/source/utils/texi2html/doc/texi2html.html new file mode 100644 index 00000000000..d55c003b90f --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.html @@ -0,0 +1,6072 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> +<html> +<!--Copyright C 1999, 2000, 2001, 2002, 2003 + Free Software Foundation, Inc. + + Portions of texi2html + Copyright C 1999, 2000 Lionel Cons + Copyright C 1999, 2000 Karl Berry + Copyright C 1999, 2000 Olaf Bachmann + Copyright C 2002, 2003 Patrice Dumas + Copyright C 2001, 2002, 2003 Derek Price + Copyright C many others. + + + Portions of this manual + Copyright C 1999, 2000 Karl Heinz Marbaise (manual) + Copyright C 2003 Patrice Dumas (manual) + Copyright C 2003 Derek Price (manual) + + +Permission is granted to make and distribute verbatim +copies of this manual provided the copyright notice and +this permission notice are preserved on all copies. + +Permission is granted to copy and distribute modified +versions of this manual under the conditions for verbatim +copying, provided that the entire resulting derived work is +distributed under the terms of a permission notice +identical to this one. + +Permission is granted to copy and distribute translations +of this manual into another language, under the above +conditions for modified versions, except that this +permission notice may be stated in a translation approved +by the Free Software Foundation. +--> +<!-- Created on February, 3 2005 by texi2html 1.76 --> +<!-- +Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author) + Karl Berry <karl@freefriends.org> + Olaf Bachmann <obachman@mathematik.uni-kl.de> + and many others. +Maintained by: Many creative people <dev@texi2html.cvshome.org> +Send bugs and suggestions to <users@texi2html.cvshome.org> + +--> +<head> +<title>Texi2HTML - Texinfo to HTML v1.76: Texi2HTML</title> + +<meta name="description" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML"> +<meta name="keywords" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="texi2html 1.76"> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +pre.display {font-family: serif} +pre.format {font-family: serif} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: serif; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: serif; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.sansserif {font-family:sans-serif; font-weight:normal;} +ul.toc {list-style: none} +--> +</style> + + +</head> + +<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> + +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="settitle">Texi2HTML</h1> +<p>Copyright © 1999, 2000, 2001, 2002, 2003 + Free Software Foundation, Inc. +</p> +<table> +<tr><td><p> Portions of <code>texi2html</code> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 1999, 2000 Lionel Cons<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Berry<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 1999, 2000 Olaf Bachmann<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 2002, 2003 Patrice Dumas<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 2001, 2002, 2003 Derek Price<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © many others.<br> +</p></td></tr> +<tr><td> </td><td> +</td></tr> +<tr><td> </td><td> +</td></tr> +<tr><td><p> Portions of this manual +</p></td></tr> +<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Heinz Marbaise (manual)<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 2003 Patrice Dumas (manual)<br> +</p></td></tr> +<tr><td> </td><td><p> Copyright © 2003 Derek Price (manual)<br> +</p></td></tr> +</table> + +<p>Permission is granted to make and distribute verbatim +copies of this manual provided the copyright notice and +this permission notice are preserved on all copies. +</p> +<p>Permission is granted to copy and distribute modified +versions of this manual under the conditions for verbatim +copying, provided that the entire resulting derived work is +distributed under the terms of a permission notice +identical to this one. +</p> +<p>Permission is granted to copy and distribute translations +of this manual into another language, under the above +conditions for modified versions, except that this +permission notice may be stated in a translation approved +by the Free Software Foundation. +</p> + + + +<a name="Top"></a> +<a name="SEC_Top"></a> + + +<p>This manual, last updated 1 February 2005, describes version 1.76 +of the <code>texi2html</code> Perl script which converts +<a href="http://www.texinfo.org">Texinfo</a> into <a href="http://w3c.org">HTML</a>. +</p> +<p>Please send bug reports concerning this manual to the Texi2HTML user +discussion list <a href="mailto:user@texi2html.cvshome.org">user@texi2html.cvshome.org</a>. Please state the exact +version of the manual which contains the bug, as given above. +</p> + +<table><tr><td> </td><td><pre class="example"><strong>This manual is currently under construction and of course incomplete. ;-)</strong> +</pre></td></tr></table> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC1">1. Overview</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> + Obtaining a copy of the <code>texi2html</code> + source code distribution +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> Installing <code>texi2html</code> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> Description of the command line options +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC14">5. Overview of initialization files content and loading</a></td><td> </td><td align="left" valign="top"> What kind of variables and subroutines appear + in init files and how they are called +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC17">6. Fine tuning of the page layout</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><td align="left" valign="top"><a href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a></td><td> </td><td align="left" valign="top"> Fine tuning of the <acronym>HTML</acronym> elements + associated with the texinfo constructs +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC84">A. Internationalization</a></td><td> </td><td align="left" valign="top"> Help translating ! +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC87">B. Command Line Option Index</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><td align="left" valign="top"><a href="#SEC88">C. Variable Index</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><td align="left" valign="top"><a href="#SEC89">D. Concept Index</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr></table> +<hr size="1"> +<a name="Overview"></a> +<a name="SEC1"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC2" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[ << ]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 1. Overview </h1> + + +<p><a href="http://www.texinfo.org">Texinfo</a> is the official +documentation format of the <a href="http://www.gnu.org">GNU</a> +project. It uses a single source file to produce both +online information and printed output. +</p> +<p>It is often desirable to have a way to produce +<acronym>HTML</acronym> from Texinfo sources, as GNU-Info files are +produced. It is much simpler to run a converter than it is to +rewrite all the documentation in <acronym>HTML</acronym>, especially +considering that there is so much Texinfo documentation in +the world. +</p> +<p>Some time ago <code>makeinfo</code> wasn't able to produce +<acronym>HTML</acronym> output format, but people still wanted documentation in +<acronym>HTML</acronym>. This was the birthing hour for +<code>texi2html</code>. The basic purpose of <code>texi2html</code> +is to convert Texinfo documents into <acronym>HTML</acronym>. +</p> +<p>Since then, <acronym>HTML</acronym> support in <code>makeinfo</code> has improved, but +<code>texi2html</code> is still stronger in many areas, including the degree to +which it allows customization. With <code>texi2html</code>, some important +aspects of the resulting <acronym>HTML</acronym> files may be specified via command +line options, and configuration files provide an even finer degree of control +over the final output, allowing most every aspect of the final output not +specified in the Texinfo input file to be specified. Configuration files are +written in <code>perl</code>, like the main program, and anything which may be +specified on the command line may also be specified within a configuration +file. +</p> +<p>For an example of the kind of pages <code>texi2html</code> is capable of +producing, have a look at the following sites: +<a href="http://www.singular.uni-kl.de/Manual/html/">the Singular Manual</a>, +<a href="http://ccvs.cvshome.org/docs/manual">the Cederqvist (CVS Manual)</a>. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></td><td> </td><td align="left" valign="top"></td></tr> +</table> + +<hr size="6"> +<a name="whytexi2html"></a> +<a name="SEC2"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC1" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC3" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC3" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 1.1 Why <code>texi2html</code> and not <code>makeinfo</code>? </h2> + + +<p>You would like to produce <acronym>HTML</acronym> files from your existing Texinfo +files? There are two programs you can use to do this. The first is +<code>makeinfo</code> (see <a href="texinfo.html#Generating-HTML">(texinfo)Generating HTML</a>). +The second is <code>texi2html</code>. +</p> +<p>The design goal of <code>makeinfo</code>'s <acronym>HTML</acronym> output was to produce +readable <acronym>HTML</acronym> output. It is now possible to use <acronym>CSS</acronym> +for <acronym>HTML</acronym> customization. Another possibility is to use intermediate +formats, like docbook or <code>mekeinfo</code> <acronym>XML</acronym> +and <acronym>XSL</acronym> stylesheets to customize the resulting document. Still the +output produced by <code>makeinfo</code> isn't customizable. +</p> +<p>The current development of <code>texi2html</code> tries to +provide for producing the more interesting and sophisticated <acronym>HTML</acronym> +pages that today's Internet users have come to expect. +The goal behind <code>texi2html</code> is to generate attractive <acronym>HTML</acronym> by +default but also to allow users considerable freedom to affect the final +style and design of the output <acronym>HTML</acronym> pages. This is achieved via +command line options and flexible configuration files. +</p> + +<p>In contrast to the <acronym>HTML</acronym> produced by <code>makeinfo --html</code> (the +<code>makeinfo</code> program is part of the Texinfo distribution), the +<code>texi2html</code> program, among other differences, allows for the +customization of the entire page layout, including headers, footers, style +sheets, etc., allows for customization of the low level <acronym>HTML</acronym> +formatting, provides for splitting documents at various levels, and provides +for using the <code>latex2html</code> program to convert <code>@tex</code> sections of +the Texinfo source. +</p> +<p>The focus on <acronym>HTML</acronym> is still present but with the help of the +customization files it is now possible to use <code>texi2html</code> to +produce other formats as well. <code>texi2html</code> may for example be +turned into a texinfo to roff translator with the help of a customization file +provided with the distribution. +</p> +<p><code>texi2html</code> should reasonably convert all Texinfo +4.8 constructs. If you find it does not, please send a bug report to the +<a href="mailto:users@texi2html.cvshome.org">users@texi2html.cvshome.org</a> email list. +</p> +<hr size="6"> +<a name="Obtaining-texi2html"></a> +<a name="SEC3"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC2" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC4" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC4" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 2. Obtaining <code>texi2html</code> </h1> + +<p>The latest version of the source code for <code>texi2html</code> should be +available from <a href="http://texi2html.cvshome.org">texi2html.cvshome.org</a>. +</p> +<hr size="6"> +<a name="Installation"></a> +<a name="SEC4"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC3" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 3. Installation of <code>texi2html</code> </h1> + +<p>To install <code>texi2html</code>, you must first obtain a copy of the +source distribution. See section <a href="#SEC3">Obtaining <code>texi2html</code></a>. +</p> +<p><code>texi2html</code> also requires <code>perl</code> version +5.004 or above. The current version has not been tested +extensively on versions of <code>perl</code> below 5.6, however. +</p> +<p><code>texi2html</code> is a standard Automake-based distribution. +If you have a source version, you should run <code>./configure</code> +to regenerate the executable <tt>`texi2html'</tt> file. <code>./configure</code> +accepts options to select the installation directory for the <tt>`texi2html'</tt> +file, the default directories <code>texi2html</code> will use to look for +configuration files, and other details. Run <code>./configure --help</code> for +more information. +</p> +<p>Running <code>./configure</code> combines four files into the final +<tt>`texi2html'</tt> program file: +</p><ul class="toc"> +<li> <tt>`texi2html.pl'</tt> contains the base program, +</li><li> <tt>`MySimple.pm'</tt> handles the command line options, +</li><li> <tt>`texi2html.init'</tt> is the default configuration file, and +</li><li> <tt>`T2h_i18n.pm'</tt> is used for internationalization. +</li><li> <tt>`translations.pl'</tt> contains the translations of the strings used in +documents. +</li></ul> + +<p>Running <code>./configure</code> also builds the <code>make</code> configuration +files (<tt>`Makefile'</tt>s). To make the documentation run <code>make</code>. +</p> +<p><code>make install</code> performs the installation to the locations specified to +the <code>./configure</code> script. This usually involves placing the actual +<tt>`texi2html'</tt> file someplace in your path, such as <tt>`/usr/local/bin'</tt> or +<tt>`/usr/bin'</tt>. +</p> +<p>Installing <code>texi2html</code> in your path should be sufficient +to run it. To use default initialization files, or a configuration file for +LaTeX2HTML when using <code>latex2html</code> to convert <code>@tex</code> sections +(see section <a href="#SEC12">Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a>), install them in the package data directory +specified to configure. This is <tt>`/usr/local/share/texi2html/'</tt> by default, +but depends on the value of the <a name="IDX1"></a> +<samp>`--pkgdatadir=<var>dir</var>'</samp> option passed to +the <code>./configure</code> script. Files used for strings customization and +internationalization are also searched for in the <tt>`i18n'</tt> directory +of this directory. See section <a href="#SEC13">Use initialization files for fine tuning</a> for more. +</p> +<hr size="6"> +<a name="Invoking-texi2html"></a> +<a name="SEC5"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC4" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC6" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC4" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 4. Invoking <code>texi2html</code> </h1> + +<p>To produce an <acronym>HTML</acronym> manual, run <code>texi2html</code> with a Texinfo +file as an argument. For example, this manual is created with: +</p> +<table><tr><td> </td><td><pre class="example">$ texi2html texi2html.texi +</pre></td></tr></table> +<p>The behaviour of <code>texi2html</code> may be changed with command line +options. These command line options are always associated with corresponding +<code>perl</code> variables which may appear in init files, and these +variables are presented in this chapter each time a switch is described. +</p> +<p>Boolean command line switches always have a corresponding negated switch, +obtained by prepending <samp>`no'</samp> or <samp>`no-'</samp> to the switch name. For example +<a name="IDX2"></a> +<samp>`--nomenu'</samp> does the reverse of <a name="IDX3"></a> +<samp>`--menu'</samp>. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td><td> </td><td align="left" valign="top"> The <acronym>HTML</acronym> output may be split at + different levels +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td><td> </td><td align="left" valign="top"> Customizing page layout +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><td align="left" valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td><td> </td><td align="left" valign="top"> Specifying initialization files for fine tuning +</td></tr> +</table> + +<hr size="6"> +<a name="Splitting-output"></a> +<a name="SEC6"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC5" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC7" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.1 Specifying where to split the generated document </h2> + +<p>The <acronym>HTML</acronym> manual resulting from the processing of the Texinfo source +may be split into files at different levels. This is specified with the +option <a name="IDX4"></a> +<samp>`--split'</samp> which takes an argument, namely the level of splitting +(variable: <a name="IDX5"></a> +<code>$SPLIT</code>). This level may be: +</p> +<dl compact="compact"> +<dt> <samp>`chapter'</samp></dt> +<dd><p>The document is split at <code>@chapter</code>, <code>@appendix</code>, or <code>@unnumbered</code>. +</p></dd> +<dt> <samp>`section'</samp></dt> +<dd><p>The document is split at the same places as it is using the <samp>`chapter'</samp> +argument, and also at <code>@section</code>, <code>@appendixsec</code> or +<code>@unnumberedsec</code>. +</p></dd> +<dt> <samp>`node'</samp></dt> +<dd><p>The document is split at every sectioning command. It is not necessarily +split at each node, if the <code>@node</code> structure doesn't correspond with +the sectioning command structure (see below). +</p></dd> +<dt> <samp>`none'</samp></dt> +<dd><p>The document isn't split. This is the default. +</p></dd> +</dl> + +<p>There are two kinds of commands which may be used to define sectioning +elements in Texinfo: <code>@node</code> and the structuring commands (<code>@top</code>, +<code>@section</code>, <code>@appendixsubsec</code>, and so on). A node just preceding +a structuring command is considered to be part of the same sectioning element +as that command. If the <code>@node Top</code> isn't associated with a structuring +command it also defines a sectioning element. +</p> +<p>By default, nodes which aren't associated with a structuring command are not +considered to be sectioning commands. They are always considered to be part +of a sectioning element defined by a structuring command. It is possible to +change this behaviour via the <a name="IDX6"></a> +<samp>`--use-nodes'</samp> option (variable +<a name="IDX7"></a> +<code>$USE_NODES</code>). In this case, nodes not associated with structuring +commands are also considered to be sectioning commands defining a sectioning +element. +</p> +<p>This default behaviour mimics <code>texi2dvi</code> behaviour, which ignores +<code>@node</code> commands for the purprose of sectioning, while the second +looks like <code>makeinfo</code> behaviour (see <a href="texinfo.html#Two-Paths">(texinfo)Two Paths</a>). +</p> +<p>As an illustration, the following table shows how a sample Texinfo document is +divided into sectioning elements when <a name="IDX8"></a> +<samp>`--use-nodes'</samp> is used and not: +</p> +<table> +<tr><td><p> Texinfo code +</p></td><td> +</td><td> +<p>default case +</p></td><td> +</td><td> +<p>with <a name="IDX9"></a> +<samp>`--use-nodes'</samp> +</p></td></tr> +<tr><td> +<br> +<br> +<table><tr><td> </td><td><pre class="example">@node node1 +@chapter node 1 +node1 text + +@node node2 +node2 text + +@node node3 +node3 text +@chapter node 3 +chapter text +</pre></td></tr></table></td><td> +</td><td> +<p>first element: +</p> +<table><tr><td> </td><td><pre class="example">@node node1 +@chapter node 1 +node1 text + +@node node2 +node2 text +</pre></td></tr></table> +<p>second element: +</p> +<table><tr><td> </td><td><pre class="example">@node node3 +node3 text +@chapter node 3 +chapter text +</pre></td></tr></table> +</td><td> +</td><td> +<p>first element: +</p> +<table><tr><td> </td><td><pre class="example">@node node1 +@chapter node 1 +node1 text +</pre></td></tr></table> +<p>second element: +</p> +<table><tr><td> </td><td><pre class="example">@node node2 +node2 text +</pre></td></tr></table> +<p>third element: +</p> +<table><tr><td> </td><td><pre class="example">@node node3 +node3 text +@chapter node 3 +chapter text +</pre></td></tr></table> +</td></tr> +</table> + +<hr size="6"> +<a name="Output-files"></a> +<a name="SEC7"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC6" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC8" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.2 Setting output file and directory names </h2> + +<p>The manual name is constructed by stripping the <samp>`.texi'</samp>, +<samp>`.txi'</samp>, <samp>`.texinfo'</samp>, or <samp>`.txinfo'</samp> extension from the Texinfo file +name. +</p> +<p>By default, <code>texi2html</code> generates the manual file in the current +directory if the manual isn't split. A <samp>`.html'</samp> file extension is appended +to the manual name. +</p> +<p>If the manual is split the files are put in a directory named after the +manual name. The file name is constructed using the manual name as basename. +An underscore followed by a number is appended +to the basename for each files corresponding with sectioning elements, with the +exception of the top element. For the top element there nothing appended. +The files containing special elements pages +have an underscore and a 3 letter code corresponding to their content +(<samp>`toc'</samp> for table of contents, <samp>`abt'</samp> for about, <samp>`ovr'</samp> for +overview) appended. Lastly, an <samp>`.html'</samp> file extension is appended. +</p> +<p>Thus, if the texinfo file <tt>`afile.texi'</tt> is processed and split at chapters +into 3 files, the generated files (in directory <tt>`afile'</tt>) will be: +</p> +<table><tr><td> </td><td><pre class="example">afile.html --> <code>@node Top</code> or <code>@top</code> section +afile_1.html --> Chapter 1 +afile_2.html --> Chapter 2 +afile_toc.html --> Table of Contents +afile_abt.html --> About Page +</pre></td></tr></table> +<p>This default behavior may be modified by several command line options. If the +output isn't split, the prefix file name may be overrided by the +<a name="IDX10"></a> +<samp>`--output'</samp> command line option (variable <a name="IDX11"></a> +<code>$OUT</code>). If the output +is split, and <a name="IDX12"></a> +<samp>`--output'</samp> is set, the files are placed in the directory +specified by the argument to the option. +</p> +<p>The basename may be overridden with <a name="IDX13"></a> +<samp>`--prefix'</samp> (variable +<a name="IDX14"></a> +<code>$PREFIX</code>). If <a name="IDX15"></a> +<samp>`--short-ext'</samp> is given, <samp>`.htm'</samp> is appended +instead of <samp>`.html'</samp> in the final step (variable <a name="IDX16"></a> +<code>$SHORTEXTN</code>). +The <a name="IDX17"></a> +<samp>`--top-file'</samp> option +overrides the top element file name (variable <a name="IDX18"></a> +<code>$TOP_FILE</code>). This can +be used to name the top element file <samp>`index.html'</samp>. Similarly, +<a name="IDX19"></a> +<samp>`--toc-file'</samp> changes the name of the table of contents file (variable +<a name="IDX20"></a> +<code>$TOC_FILE</code>). +</p> +<p>Reusing the example above, but this time calling <code>texi2html</code> like so: +</p> +<table><tr><td> </td><td><pre class="example">$ texi2html -split chapter -prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi +</pre></td></tr></table> +<p>we get, in <tt>`manual'</tt>: +</p> +<table><tr><td> </td><td><pre class="example">index.htm --> <code>@node Top</code> or <code>@top</code> section +manual_1.htm --> Chapter 1 +manual_2.htm --> Chapter 2 +contents.htm --> Table of Contents +manual_abt.htm --> About Page +</pre></td></tr></table> +<p>The file names generated by <code>texi2html</code> differ from those generated +by <code>makeinfo</code>. <code>makeinfo</code> uses the node name to construct +the file names while splitting at nodes. It is possible to get the same +behaviour out of <code>texi2html</code> by specifying the +<a name="IDX21"></a> +<samp>`--node-files'</samp> option (variable <a name="IDX22"></a> +<code>$NODE_FILES</code>). If the output +isn't split at nodes, <code>texi2html</code> will still output files named after +the nodes, without real content but redirecting to the right file. +The default is false for this option. +This trick enables the generated <acronym>HTML</acronym> manual to be a +target for the cross-references of other manuals generated by +<code>makeinfo</code> or <code>texi2html</code>. +</p> +<hr size="6"> +<a name="Expansion"></a> +<a name="SEC8"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC7" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC9" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.3 Specifying which regions get expanded </h2> + +<p>The default for <code>texi2html</code> is to expand the <code>@ifhtml</code>, +<code>@html</code>, and <code>@menu</code> regions, all the <code>@ifnot</code> regions +except <code>@ifnothtml</code>, and no other <code>@if</code> regions. +</p> +<p>It is possible to expand other regions by setting <a name="IDX23"></a> +<samp>`--if<region>'</samp>, +where <samp>`<region>'</samp> is replaced by the literal name of the region (for +example, <samp>`--iftex'</samp>). Symetrically, if <a name="IDX24"></a> +<samp>`--no-if<region>'</samp> is +specified, the <samp>`<region>'</samp> region is ignored. The configuration file +array, <a name="IDX25"></a> +<code>@EXPAND</code>, holds the names of regions which should be +expanded. The only region name present in <code>@EXPAND</code> in the default case +is <samp>`html'</samp>. +</p> +<p>If <a name="IDX26"></a> +<samp>`--nomenu'</samp> is set, the <code>@menu</code> sections are not expanded +(variable <a name="IDX27"></a> +<code>$SHOW_MENU</code>). The default is to expand <code>@menu</code> +sections. +</p> +<hr size="6"> +<a name="Texinfo-related-options"></a> +<a name="SEC9"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC8" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.4 Command line options related to Texinfo language features </h2> + +<p>Miscalleneous Texinfo related things may be specified via command line options. +</p> +<dl compact="compact"> +<dt> <a name="IDX28"></a> +<p><samp>`--lang=<var>lang</var>'</samp> +</p></dt> +<dd><p>Sets the document language similar to the Texinfo directive, +<code>@documentlanguage <var>lang</var></code> (variable <a name="IDX29"></a> +<code>$LANG</code>). +The default is <samp>`en'</samp>, that is, use the english language strings. +</p></dd> +<dt> <a name="IDX30"></a> +<p><samp>`-D<var>var</var>'</samp> +</p></dt> +<dd><p>Sets <var>var</var>. Equivalent to, <code>@set <var>var</var> 1</code>, in Texinfo. +</p></dd> +<dt> <a name="IDX31"></a> +<p><samp>`-U<var>var</var>'</samp> +</p></dt> +<dd><p>Clears <var>var</var>. Equivalent to, <code>@clear <var>var</var></code>, in Texinfo. +</p></dd> +<dt> <a name="IDX32"></a> +<p><samp>`-P<var>dir</var>'</samp> +</p></dt> +<dd><p>Prepend <var>dir</var> to the list of directories to search for +<code>@include</code> files (the associated array is <a name="IDX33"></a> +<code>@PREPEND_DIRS</code>, +empty in the default case). +</p></dd> +<dt> <a name="IDX34"></a> +<p><samp>`-I<var>dir</var>'</samp> +</p></dt> +<dd><p>Append <var>dir</var> to the list of directories to search for +<code>@include</code> files (the associated array is <a name="IDX35"></a> +<code>@INCLUDE_DIRS</code>, +empty in the default case). +</p></dd> +</dl> + +<p>The include files are always searched for in the current directory. +</p> +<hr size="6"> +<a name="Page-layout-options"></a> +<a name="SEC10"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC9" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC11" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.5 Page layout related command line options </h2> + +<p>If the <a name="IDX36"></a> +<samp>`--frames'</samp> option is specified, <acronym>HTML</acronym> frames +are used. A file describing the frame layout is generated, and the +document page is associated with a frame where the short table of +content appears (variable <a name="IDX37"></a> +<code>$FRAMES</code>). The default is not +to use frames. +</p> +<p>It is also possible to suppress the section navigation panel with +<a name="IDX38"></a> +<samp>`--nosec-nav'</samp> (variable <a name="IDX39"></a> +<code>$SECTION_NAVIGATION</code>, the default +is to output all the navigation panels), and to specify +whether footnotes should appear at the foot of the same page which contains +the reference to the note or on a separate page with +<a name="IDX40"></a> +<samp>`--separated-footnotes'</samp> (variable <a name="IDX41"></a> +<code>$SEPARATED_FOOTNOTES</code>). +The default is to have separated footnotes. +</p> +<hr size="6"> +<a name="Style-options"></a> +<a name="SEC11"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC10" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC12" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.6 Customizing the <acronym>HTML</acronym> and text style </h2> + +<p>Miscalleneous style changes may be achieved with command line options. +</p> +<dl compact="compact"> +<dt> <a name="IDX42"></a> +<p><samp>`--doctype=<var>DTD</var>'</samp> +</p></dt> +<dt> <a name="IDX43"></a> +<p><samp>`--frameset-doctype=<var>DTD</var>'</samp> +</p></dt> +<dd><p>You can specify the document DTD by setting these options. +<a name="IDX44"></a> +<samp>`--frameset-doctype'</samp> applies to the file describing the frames when +frames are used (corresponding variables are <a name="IDX45"></a> +<code>$DOCTYPE</code> and +<a name="IDX46"></a> +<code>$FRAMESET_DOCTYPE</code>). +</p> +<p>The default for the document doctype is: +</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> +</pre></td></tr></table><p>And for the frameset doctype: +</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd"> +</pre></td></tr></table> +</dd> +<dt> <a name="IDX47"></a> +<p><samp>`--iso'</samp> +</p></dt> +<dd><p>If this option is set, ISO8859 entities are used for some special symbols, +like Copyright © (variable <a name="IDX48"></a> +<code>$USE_ISO</code>). It is the default. +</p> +</dd> +<dt> <a name="IDX49"></a> +<p><samp>`--css-include=<var>file</var>'</samp> +</p></dt> +<dd><p>This command line switch provides for the inclusion of an external +Cascading Style Sheet (<acronym>CSS</acronym>) file. More than one file may be +specified, and <samp>`-'</samp> stands for the standard input (array +<a name="IDX50"></a> +<code>@CSS_FILES</code>). +</p> +<p>The option use is the same than for <code>makeinfo</code> and is described +extensively in <a href="texinfo.html#HTML-CSS">(texinfo)HTML CSS</a>. +Briefly, the <acronym>CSS</acronym> <code>@import</code> lines from the external file +<acronym>CSS</acronym> file are pasted before the +<code>texi2html</code> <acronym>CSS</acronym> rules, and the external file <acronym>CSS</acronym> +rules are pasted after the <code>texi2html</code> <acronym>CSS</acronym> rules. +</p> +</dd> +<dt> <a name="IDX51"></a> +<p><samp>`--html-xref-prefix=<var>path</var>'</samp> +</p></dt> +<dd><p>This option sets the base directory for external <acronym>HTML</acronym> texinfo manuals +(variable <a name="IDX52"></a> +<code>$EXTERNAL_DIR</code>). Defaults to <samp>`../'</samp>. +</p> +</dd> +<dt> <a name="IDX53"></a> +<p><samp>`--def-table'</samp> +</p></dt> +<dd><p>If this option is set, <acronym>HTML</acronym> tables are used to format definition +commands, rather than <acronym>HTML</acronym> definition tables (variable +<a name="IDX54"></a> +<code>$DEF_TABLE</code>). Default is false. +</p> +</dd> +<dt> <a name="IDX55"></a> +<p><samp>`--short-ref'</samp> +</p></dt> +<dd><p>If this option is set, cross-references are given without section numbers +(variable <a name="IDX56"></a> +<code>$SHORT_REF</code>). Default is false. +</p> +</dd> +<dt> <a name="IDX57"></a> +<p><samp>`--number'</samp> +</p></dt> +<dd><p>If this option is set, sections are numbered (variable +<a name="IDX58"></a> +<code>$NUMBER_SECTIONS</code>). This is the default. +</p> +</dd> +<dt> <a name="IDX59"></a> +<p><samp>`--toc-links'</samp> +</p></dt> +<dd><p>If this option is set, links from headings to <acronym>TOC</acronym> entries are +created (variable <a name="IDX60"></a> +<code>$TOC_LINKS</code>). Default is false. +</p></dd> +</dl> + +<hr size="6"> +<a name="Expanding-TeX-regions"></a> +<a name="SEC12"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC11" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC13" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML </h2> + +<p>It is possible to use <a href="http://www.latex2html.org/">LaTeX2HTML</a> +to process <code>@tex</code> regions and <code>@math{}</code> commands. This is an +attractive way to display mathematical constructs in the <acronym>HTML</acronym> +manual. The <a name="IDX61"></a> +<samp>`--l2h'</samp> option activates this feature (variable +<var>$L2H</var>). It is usually desirable to expand <code>@tex</code> sections when this +option is specified (see section <a href="#SEC8">Specifying which regions get expanded</a>). The default is not to use this +feature. +</p> +<p>The <a name="IDX62"></a> +<samp>`--l2h-l2h=<var>program</var>'</samp> option enables changing the name/location +of the LaTeX2HTML program processing TeX regions (variable +<a name="IDX63"></a> +<code>$L2H_L2H</code>). The default is <code>latex2html</code>. +</p> +<a name="IDX64"></a> +<p><samp>`--l2h-tmp'</samp> sets the directory used for temporary +files, this name shouldn't contain a dot <samp>`.'</samp> +(variable is <a name="IDX65"></a> +<code>$L2H_TMP</code>). Defaults to the current dir. +</p> +<p>The file specified by <a name="IDX66"></a> +<samp>`--l2h-file'</samp> is +used as LaTeX2HTML init file. It is searched at the same places than +init files (see section <a href="#SEC13">Use initialization files for fine tuning</a>), and the default is <tt>`l2h.init'</tt>. +</p> +<hr size="6"> +<a name="Using-init-files"></a> +<a name="SEC13"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC12" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 4.8 Use initialization files for fine tuning </h2> + + +<p>Initialization variables are read first from +<tt>`/usr/local/share/texi2html/Config'</tt> (the exact location being +changeable with the <a name="IDX67"></a> +<samp>`--pkgdatadir=dir'</samp> option of the +<code>configure</code> script, see <a href="#SEC4">Installation of <code>texi2html</code></a>), +<tt>`/usr/local/etc/texi2html/Config'</tt> (the exact location being +changeable with the <a name="IDX68"></a> +<samp>`--sysconfdir=dir'</samp> option of the +<code>configure</code> script, see <a href="#SEC4">Installation of <code>texi2html</code></a>), from <tt>`./Config'</tt> +then from <tt>`$HOME/.texi2html/Config'</tt>. Any command-line option +can override the corresponding option set in init file, and the +option <a name="IDX69"></a> +<samp>`--init-file'</samp> specifies an init file to be loaded, with +later settings overriding earlier ones. +</p> +<p>The init files specified with <a name="IDX70"></a> +<samp>`--init-file'</samp> are searched +first in the current directory, then in the <tt>`$HOME/.texi2html/'</tt> +directory, in the <tt>`/usr/local/etc/texi2html/'</tt> directory and lastly +in the <tt>`/usr/local/share/texi2html/'</tt> directory. +</p> +<p>A file is also included based on the language selected, +by <a name="IDX71"></a> +<code>$LANG</code>, <a name="IDX72"></a> +<samp>`--lang'</samp> or <code>@documentlanguage</code>. +If no language was selected <samp>`en'</samp> is considered to be +the language. All the files with name the language name in +<tt>`/usr/local/share/texi2html/i18n/'</tt>, +<tt>`/usr/local/etc/texi2html/i18n/'</tt>, +<tt>`$HOME/.texi2html/i18n/'</tt> and then <tt>`./i18n/'</tt> are included. +</p> +<p>The default initialization options are defined in the +<tt>`texi2html.init'</tt> file contained in the <code>texi2html</code> +distribution (which gets included near the beginning of the +<code>texi2html</code> script that gets installed). +</p> +<p>To customize <code>texi2html</code> it is best if you copy the +appropriate sections from the <tt>`texi2html.init'</tt> +contents into an appropriate local initialization file, +make the necessary changes there, and then have +<code>texi2html</code> read this initialization file by one of +the means described above. +</p> +<hr size="6"> +<a name="Initialization-files"></a> +<a name="SEC14"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC13" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC15" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 5. Overview of initialization files content and loading </h1> + +<p>The initialization files are <code>perl</code> files, read as explained +in <a href="#SEC13">Use initialization files for fine tuning</a>. You don't need to know much of <code>perl</code> +to do some simple changes in variable values, however, to be able to +really take advantage of all the features of the initialization file, +a good knowledge of <code>perl</code> is required. +</p> +<p>In initialization file two kind of variables appear. These are normal +variables (including arrays and hashes) and references on functions. +The later permits the dynamic redefinition of functions used to produce +the <acronym>HTML</acronym> manual. You should be able to change the value of some +normal variables without a deep knowledge of <code>perl</code>, by looking +at the existing examples. The possible mistakes in that case could be +omitted <samp>`;'</samp>, and bad quoting. +</p> +<p>Initialization file are loaded from the main program by +the mean of a <code>require</code>, while in the <code>Texi2HTML::Config</code> +namespace. This means that the namespace of the main program and +the namespace of inititalization files are distinct, which ensures +that no name clash should happen. The variables are declared with the +<code>our</code> specifier, such that it should be possible to use the +<code>use strict</code> pragma in the initialization file code. +</p> +<p>To avoid messing with the variables in the <code>main</code> namespace +all the global variables which could be of use in the init files +are in the <code>Texi2HTML</code> namespace. Notice that the functions +of the main program are still in the <code>main</code> namespace. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC15">5.1 Redefining functions in initialization files</a></td><td> </td><td align="left" valign="top"> Function redefinition is achieved with + redefinition of references on functions. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC16">5.2 Conventions used for function prototypes</a></td><td> </td><td align="left" valign="top"> Conventions used in that manual for function + reference prototypes display. +</td></tr> +</table> + +<hr size="6"> +<a name="Redefining-functions"></a> +<a name="SEC15"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC14" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC16" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 5.1 Redefining functions in initialization files </h2> + +<p>To redefine a function you must replace the corresponding funtion +reference with a reference on your function. +Thus you should write your function, give it a name you +are certain it is unique in the <code>Texi2HTML::Config</code> namespace, +and override the value of the function reference with your own +function reference. When another function from the main program +(or from another functions of an initialization file) calls the reference, +your function will be used. +</p> +<p>For example the function +reference corresponding with the function called when doing an +anchor is called <a name="IDX73"></a> +<code>$anchor</code>. Thus if you want to override the +corresponding function +you could write: +</p> +<table><tr><td> </td><td><pre class="example"># override the function reference +$anchor = \&my_own_function; + +# the function reference now refers to +sub my_own_function { +# process arguments and return an html anchor +} +</pre></td></tr></table> +<hr size="6"> +<a name="Function-prototypes"></a> +<a name="SEC16"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC15" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 5.2 Conventions used for function prototypes </h2> + +<p>As the functions are defined by a reference name, we will always +use the reference name in function prototypes. For the function arguments +we will use <code>\@array</code> for a reference on an array and similarly +<code>\%hash</code> for a reference on a hash. +</p> +<p>Thus, the prototype for the function associated with the function +reference <samp>`$formatting_function'</samp> will be: +</p> +<dl> +<dt><u>Function Reference:</u> $text <b>formatting_function</b><i> $arg1 \@arg2</i> +<a name="IDX74"></a> +</dt> +<dd><p><code>formatting_function</code> takes as first argument <var>$arg2</var>, +as second argument a reference on an array <var>\@arg2</var> +and returns the formatted text <var>$text</var>. +</p></dd></dl> + +<p>To redefined the corresponding function, you should write: +</p> +<table><tr><td> </td><td><pre class="example">$formatting_function = \&my_formatting_function + +sub my_formatting_function($ $) +{ + my $arg1 = shift; + my $arg2 = shift; + # prepare $formatted_text + ..... + return $formatted_text +} +</pre></td></tr></table> +<hr size="6"> +<a name="Changing-the-page-layout"></a> +<a name="SEC17"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC16" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC18" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 6. Fine tuning of the page layout </h1> + +<p>Some features of the page layout might be specified with command line +options, the corresponding variables are described in +<a href="#SEC10">Page layout related command line options</a>. +Fine tuning of the page layout may be achieved +with redefinition of other variables and function references in the +initialization files. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC18">6.1 The different categories of pages and sectioning elements</a></td><td> </td><td align="left" valign="top"> The different categories of pages. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td><td> </td><td align="left" valign="top"> The elements of a page. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC21">6.3 Customization of the navigation panels buttons</a></td><td> </td><td align="left" valign="top"> How to change the navigation panel. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC25">6.4 Main program variables and usefull functions</a></td><td> </td><td align="left" valign="top"> The available main program variables and some + usefull functions from the main program. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC32">6.5 Preparing the output</a></td><td> </td><td align="left" valign="top"> Setting variables before the document + production but after the texinfo parsing. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC33">6.6 Finalizing the output</a></td><td> </td><td align="left" valign="top"> Cleaning after document generation. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td><td> </td><td align="left" valign="top"> Customizing css lines. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC36">6.9 Customizing the sections</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC38">6.11 Special pages formatting</a></td><td> </td><td align="left" valign="top"> Customizing table of contents, top, about page. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td><td> </td><td align="left" valign="top"></td></tr> +<tr><td align="left" valign="top"><a href="#SEC46">6.13 Generation of external files for index entries</a></td><td> </td><td align="left" valign="top"> Putting index entries in external files. +</td></tr> +</table> + +<hr size="6"> +<a name="The-different-pages"></a> +<a name="SEC18"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC17" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC19" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.1 The different categories of pages and sectioning elements </h2> + +<p>The following sectioning elements can be associated with pages: +</p> +<dl compact="compact"> +<dt> <em>Normal elements</em></dt> +<dd><p>These are normal sections or nodes. Their association with pages is +determined by the splitting of the document. See section <a href="#SEC6">Specifying where to split the generated document</a>. +</p></dd> +<dt> <em>Top element</em></dt> +<dd><p>The top element is the higher element in the document structure. +If there is a <code>@top</code> section it is the element associated with +that section. Otherwise it is the element associated with the +<code>@node Top</code>. If there is no <code>@node Top</code> the first element is the +top element. +</p> +<p>The top element is formatted differently than a normal element if there +is a <code>@top</code> section or the <code>@node Top</code> isn't associated +with a sectioning command. +</p></dd> +<dt> <em>Misc elements</em></dt> +<dd><p>These elements are associated with pages if the document is split. +There are four misc elements: +</p><ol> +<li> Table of contents +</li><li> Short table of contents, also called Overview +</li><li> Footnotes page +</li><li> About page +</li></ol> + +<p>The <em>About page</em> shouldn't be present for documents consisting +in only one sectioning element. The <em>Footnote page</em> should only +be present if the footnotes appear on a separated page +(see section <a href="#SEC10">Page layout related command line options</a>), however a footnote element is present if +the document isn't split. The <em>Table of contents</em> should only +be formatted if <code>@contents</code> is present in the document. +Similarly the <em>Overview</em> should only appear if <code>@shortcontents</code> +or <code>@summarycontents</code> is present. +</p></dd> +</dl> + +<hr size="6"> +<a name="The-page-layout"></a> +<a name="SEC19"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC18" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC21" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.2 Page layout and navigation panel overview </h2> + +<p>A page is broken up in three parts. A page header, the sections +and a page footer. A common element in the page layout is a navigation +panel with icons or text linking to other sections or pages. Another +common element is a rule, separating sections or footer. The navigation +panel and the rules may be part of the sections or part of headers or +footers. You may use the variables <a name="IDX75"></a> +<code>$SMALL_RULE</code>, +<a name="IDX76"></a> +<code>$DEFAULT_RULE</code>, <a name="IDX77"></a> +<code>$MIDDLE_RULE</code> and <a name="IDX78"></a> +<code>$BIG_RULE</code> +for rules of different sizes. +The defaults are +</p><table><tr><td> </td><td><pre class="example">$SMALL_RULE = '<hr size="1">'; +$DEFAULT_RULE = '<hr>'; +$MIDDLE_RULE = '<hr size="2">'; +$BIG_RULE = '<hr size="6">'; +</pre></td></tr></table> + +<p>In the header some important meta data may be defined, like the +title or style information, and textual informations may be present +in comments. All this doesn't appear directly in the displayed +<acronym>HTML</acronym>, though. +</p> +<p>The page layout is mainly controlled by functions, the precise functions +called depending on the document splitting. The navigation panel, however, +can be customized with variables. +</p> +<a name="SEC20"></a> +<h3 class="subheading"> Element labels </h3> +<p><a name="Element-labels"></a> +</p> +<p>There are 19 items associated with elements. Each of these +is associated with a name and a reference to the +element they represent, when such an element exists. +The element is either a global element or an element relative to the current +element. The relative elements are found with respect with the document +structure defined by the section structuring commands (<code>@chapter</code>, +<code>@unnumbered</code>…) or by the nodes (in that case the node +directions are specified on node line or in menu organization). +These items are called <em>element labels</em>. They may be associated with +a button (see section <a href="#SEC23">Specifying the buttons formatting</a>), and used in the formatting functions +(see section <a href="#SEC25">Main program variables and usefull functions</a>). +</p> +<p>Here is the list: +</p> +<dl compact="compact"> +<dt> <em><samp>` '</samp></em></dt> +<dd><p>An empty button +</p></dd> +<dt> <em>Top</em></dt> +<dd><p>Top element. The associated name is <a name="IDX79"></a> +<code>$TOP_HEADING</code> if that variable is +defined. This variable is not set by default. +</p></dd> +<dt> <em>Contents</em></dt> +<dd><p>Table of contents +</p></dd> +<dt> <em>About</em></dt> +<dd><p>About (help) page +</p></dd> +<dt> <em>Overview</em></dt> +<dd><p>Overview, short table of contents +</p></dd> +<dt> <em>First</em></dt> +<dd><p>First element in reading order +</p></dd> +<dt> <em>Last</em></dt> +<dd><p>Last element in reading order +</p></dd> +<dt> <em>Index</em></dt> +<dd><p>The first chapter with <code>@printindex</code>. The associated name +is <a name="IDX80"></a> +<code>$INDEX_CHAPTER</code>, if the variable is set. This variable is not set +by default. +</p></dd> +<dt> <em>This</em></dt> +<dd><p>The current element +</p></dd> +<dt> <em>Back</em></dt> +<dd><p>Preceding element in reading order +</p></dd> +<dt> <em>FastBack</em></dt> +<dd><p>Beginning of this chapter or previous chapter if the element is a chapter +</p></dd> +<dt> <em>Prev</em></dt> +<dd><p>Previous section on the same level +</p></dd> +<dt> <em>NodePrev</em></dt> +<dd><p>Previous node +</p></dd> +<dt> <em>Forward</em> </dt> +<dd><p>Next element in reading order +</p></dd> +<dt> <em>FastForward</em></dt> +<dd><p>Next chapter +</p></dd> +<dt> <em>Next</em></dt> +<dd><p>Next section on the same level +</p></dd> +<dt> <em>NodeNext</em></dt> +<dd><p>Next node +</p></dd> +<dt> <em>Following</em></dt> +<dd><p>Next node in node reading order +</p></dd> +<dt> <em>Up</em></dt> +<dd><p>Up section +</p></dd> +<dt> <em>NodeUp</em></dt> +<dd><p>Up node +</p></dd> +</dl> + +<hr size="6"> +<a name="Navigation-panel"></a> +<a name="SEC21"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC19" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC22" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.3 Customization of the navigation panels buttons </h2> + +<p>A lot of customization of the navigation panel may be achieved without +redefining functions, with variables redefinition. +In case it isn't enough, it is also possible to redefine the function +doing the navigation panel formatting. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td><td> </td><td align="left" valign="top"> Variables controlling the navigation panel + at a global level +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC24">6.3.3 Changing the navigation panel formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="General-purpose-variables"></a> +<a name="SEC22"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC21" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC23" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.3.1 Controlling the navigation panel panel at a high level </h3> + +<p>The global formatting of the navigation panels may be +changed with the following variables: +</p> +<dl compact="compact"> +<dt> <code>$VERTICAL_HEAD_NAVIGATION</code> +<a name="IDX81"></a> +</dt> +<dd><p>A vertical navigation panel will be used for the header navigation +panel if this variable is true. +</p></dd> +<dt> <code>$ICONS</code> +<a name="IDX82"></a> +</dt> +<dd><p>Icons are used instead of +textual buttons if this variable is true. +</p></dd> +<dt> <code>$SECTION_NAVIGATION</code> +<a name="IDX83"></a> +</dt> +<dd><p>If this variable is false there is no section navigation, no navigation +panels for the elements within the pages, only at +the beginning and the end of the page (see section <a href="#SEC10">Page layout related command line options</a>). +</p></dd> +</dl> + +<hr size="6"> +<a name="Button-specifications"></a> +<a name="SEC23"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC22" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC24" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.3.2 Specifying the buttons formatting </h3> + +<p>Several arrays and hashes enable a precise control on the buttons and +their display. +The following arrays determine the buttons present in navigation panels: +</p> +<dl compact="compact"> +<dt> <code>@SECTION_BUTTONS</code> +<a name="IDX84"></a> +</dt> +<dd><p>This array is used for the navigation panel buttons present at the begining +of sectioning elements. If split at node or section they are also used +at the page footer, and in the case of section navigation at the page header. +</p></dd> +<dt> <code>@SECTION_FOOTER_BUTTONS</code> +<a name="IDX85"></a> +</dt> +<dt> <code>@NODE_FOOTER_BUTTONS</code> +<a name="IDX86"></a> +</dt> +<dd><p>This array is used for the navigation panel buttons present at the footer +of pages when split at node or at section. +</p> +<p>If <a name="IDX87"></a> +<code>$WORDS_IN_PAGE</code> is set and the output is split at nodes, these +buttons are only present if there are more than <a name="IDX88"></a> +<code>$WORDS_IN_PAGE</code> +words in the sectioning element text. This counting is very rough and include +punctuation marks, html elements, numbers. The default is to include the +buttons after 300 words. +</p></dd> +<dt> <code>@CHAPTER_BUTTONS</code> +<a name="IDX89"></a> +</dt> +<dd><p>This array is used for the buttons appearing at the page footer if split at +chapter, and at the page header if split at chapter and there is no section +navigation. +</p></dd> +<dt> <code>@MISC_BUTTONS</code> +<a name="IDX90"></a> +</dt> +<dd><p>These buttons appear at the beginning of special and sections +and at the end of these section pages if the output is split. +</p></dd> +</dl> + +<p>The array specify the buttons displayed in navigation panels, +and how the button is displayed. +Each element is associated with +a button of the navigation panel from left to right. +The signification of the array element value is the following: +</p> +<dl compact="compact"> +<dt> <em>reference on a function</em></dt> +<dd><p>The function is called with first argument a filehandle reference on the +current file and second argument a boolean true if the navigation +panel should be vertical. +</p></dd> +<dt> <em>reference on a scalar</em></dt> +<dd><p>The scalar value is printed. For some possibly +usefull scalars, <a href="#SEC26">Accessing elements informations</a>. +</p></dd> +<dt> <em>reference on an array</em></dt> +<dd><p>In this case the first array element should be a reference on text and the +second element an element label. In that case a link to the +element associated with the element label with the scalar value +text is generated. +</p> +<p>For example if the buttons array element is +</p><table><tr><td> </td><td><pre class="example">[ 'Next', \$Texi2HTML::NODE{Next} ] +</pre></td></tr></table> +<p>The button will be a link to the next section with text +<a name="IDX91"></a> +<code>$Texi2HTML::NODE{Next}</code>. +</p></dd> +<dt> <em>element label</em></dt> +<dd><p>If icons are not used, the button is a link to the corresponding +element which text is defined by the value associated with the +element label in the <a name="IDX92"></a> +<code>%NAVIGATION_TEXT</code> hash, surrounded +by <samp>`['</samp> and <samp>`]'</samp>. If the element label is <samp>` '</samp>, there is +no <samp>`['</samp> and <samp>`]'</samp>. +The element of the <code>%NAVIGATION_TEXT</code> hash are defined +dynamically, in the <code>init_out</code> function reference +(see section <a href="#SEC32">Preparing the output</a>). +</p> +<p>If icons are used, the button is an image with file determined by +the value associated with the element label in the <a name="IDX93"></a> +<code>%ACTIVE_ICONS</code> +hash if the the link really leads to an element, or in the <a name="IDX94"></a> +<code>%PASSIVE_ICONS</code> +hash if there is no element to link to. Of course if there is a link to the +element the icon links to that element. +</p></dd> +</dl> + +<hr size="6"> +<a name="Panel-formatting-function"></a> +<a name="SEC24"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC23" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC25" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.3.3 Changing the navigation panel formatting </h3> + +<p>If you are not satisfied with this scheme, it is possible to +control exactly the formatting of navigation panels by redefining a function +reference. The function controlling the display of navigation panel is +associated with the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_navigation</b><i> $filehandle \@buttons $vertical</i> +<a name="IDX95"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>\@buttons</var> is an array reference which should hold the specification of +the buttons for that navigation panel. <var>$vertical</var> is true if the +navigation panel should be vertical. +</p></dd></dl> + +<hr size="6"> +<a name="Program-variables"></a> +<a name="SEC25"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC24" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC26" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.4 Main program variables and usefull functions </h2> + +<p>In the functions +controlling the page layout some global variables set by the main +program are available, with value corresponding with the current +layout element. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td><td> </td><td align="left" valign="top"> Accessing information related with the + different elements +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC27">6.4.2 Accessing global informations</a></td><td> </td><td align="left" valign="top"> Accessing global informations, like date, + title… +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td><td> </td><td align="left" valign="top"> main program usefull functions +</td></tr> +</table> + + +<hr size="6"> +<a name="Elements-hashes"></a> +<a name="SEC26"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC25" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC27" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.4.1 Accessing elements informations </h3> + +<p>Four hashes are available, with key the elements labels (as described +in <a href="#Element-labels">Element labels</a>) and values: +</p> +<dl compact="compact"> +<dt> <code>%Texi2HTML::NAME</code> +<a name="IDX96"></a> +</dt> +<dd><p>The formatted element name +</p></dd> +<dt> <code>%Texi2HTML::HREF</code> +<a name="IDX97"></a> +</dt> +<dd><p>The element hypertext reference +</p></dd> +<dt> <code>%Texi2HTML::NODE</code> +<a name="IDX98"></a> +</dt> +<dd><p>The element node name +</p></dd> +<dt> <code>%Texi2HTML::NO_TEXI</code> +<a name="IDX99"></a> +</dt> +<dd><p>The element name after removal of texi commands +</p></dd> +</dl> + +<hr size="6"> +<a name="Global-informations"></a> +<a name="SEC27"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC26" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC31" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.4.2 Accessing global informations </h3> + +<p>Three kinds of global informations are available, miscalleneous global +strings, flags set by <code>@set</code> and special flags and section lines. +</p> +<a name="SEC28"></a> +<h4 class="subsubheading"> Global strings </h4> +<p>The <a name="IDX100"></a> +<code>%Texi2HTML::THISDOC</code> hash holds some global informations: +</p> +<dl compact="compact"> +<dt> <code>fulltitle</code></dt> +<dd><p>title set by <code>@title</code>. If there is no <code>@title</code> other +possibilities are tried (<code>@settitle</code>, <code>@shorttitlepage</code>…). +</p></dd> +<dt> <code>title</code></dt> +<dd><p>title set by <code>@settitle</code>, or <code>fulltitle</code>. +</p></dd> +<dt> <code>title_no_texi</code></dt> +<dd><p>title without texi formatting +</p></dd> +<dt> <code>title_texi</code></dt> +<dd><p>title with texi commands +</p></dd> +<dt> <code>author</code></dt> +<dd><p>Authors list set by <code>@author</code>. +</p></dd> +<dt> <code>authors</code></dt> +<dd><p>A reference on an array containing each author set by <code>@author</code>. +</p></dd> +<dt> <code>copying</code></dt> +<dd><p>Text appearing in <code>@copying</code> with all the texinfo commands removed, +put in comments. +</p></dd> +<dt> <code>program</code></dt> +<dd><p>The name and version of <code>texi2html</code>. +</p></dd> +<dt> <code>program_homepage</code></dt> +<dd><p>Homepage for <code>texi2html</code>. +</p></dd> +<dt> <code>program_authors</code></dt> +<dd><p>Authors of <code>texi2html</code>. +</p></dd> +<dt> <code>file_base_name</code></dt> +<dd><p>base name of the texinfo manual file. +</p></dd> +<dt> <code>destination_directory</code></dt> +<dd><p>Destination directory for the resulting files. +</p></dd> +<dt> <code>toc_file</code></dt> +<dd><p>The file name of the table of contents. +</p></dd> +<dt> <code>today</code></dt> +<dd><p>The date. +</p></dd> +</dl> + +<p>It also holds the arg of the following commands, associated with the command +name: kbdinputstyle, paragraphindent, setchapternewpage, headings, +footnotestyle, + exampleindent, firstparagraphindent, everyheading, everyfooting, + evenheading, evenfooting, oddheading, oddfooting. +</p> + +<a name="SEC29"></a> +<h4 class="subsubheading"> Flags </h4> +<p>Flags defined by <code>@set</code> may be accessed through the +<a name="IDX101"></a> +<code>%main::value</code> hash. The key is the flag name, the value is the +flag value at the end of the document. +</p> +<p>Special flags are set by the main program. They correspond with a texinfo +command, like <code>@setfilename</code>, or <code>@settitle</code>, +<code>@author</code>… The corresponding flag is the command name with +<samp>`_'</samp> appended, for example, <code>_titlefont</code> corresponds with +<code>@titlefont</code>. Like other flags they are available in +<a name="IDX102"></a> +<code>%main::value</code>. +</p> + +<a name="SEC30"></a> +<h4 class="subsubheading"> Section lines </h4> + +<p>The following array references or arrays holds formatted lines: +</p> +<dl compact="compact"> +<dt> <code>$Texi2HTML::THIS_SECTION</code> +<a name="IDX103"></a> +</dt> +<dd><p>Lines of the current element. +</p></dd> +<dt> <code>$Texi2HTML::THIS_HEADER</code> +<a name="IDX104"></a> +</dt> +<dd><p>Lines of the current element appearing before the element label (anchors). +</p></dd> +<dt> <code>$Texi2HTML::OVERVIEW</code> +<a name="IDX105"></a> +</dt> +<dd><p>Lines of short table of contents. See section <a href="#SEC38">Special pages formatting</a>. +</p></dd> +<dt> <code>$Texi2HTML::TOC_LINES</code> +<a name="IDX106"></a> +</dt> +<dd><p>Lines of table of contents. See section <a href="#SEC38">Special pages formatting</a>. +</p></dd> +</dl> + +<hr size="6"> +<a name="Global-functions"></a> +<a name="SEC31"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC27" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC32" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.4.3 Function usefull in page formatting </h3> + +<p>The usefull function is a function used to print an array of lines, which +also counts the number of words in the array, if needed. +</p> +<dl> +<dt><u>Function:</u> $words_number <b>main::print_lines</b><i> $filehandle \@lines_array</i> +<a name="IDX107"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>\@lines_array</var> is the array line the function should write to the file. +If this argument is omitted, the function uses <a name="IDX108"></a> +<code>$Texi2HTML::THIS_SECTION</code>. +<var>$words_number</var> is the number of words in the array, only defined if +split at nodes and <a name="IDX109"></a> +<code>$WORDS_IN_PAGE</code> is defined. +</p></dd></dl> + +<hr size="6"> +<a name="Output-initialization"></a> +<a name="SEC32"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC31" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC33" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.5 Preparing the output </h2> + +<p>After the texinfo file has been parsed, some information is available +which can be used to modify some variables and prepare the outputting. +For example the document language, the document encoding, +values set with <code>@set</code> or <code>@setfilename</code> and other similar +@-commands are not known before the texinfo parsing. +</p> +<p>The following function reference may be redefined to be called after +texinfo processing and before document generation: +</p> +<dl> +<dt><u>Function Reference:</u> $encoding <b>init_out</b> +<a name="IDX110"></a> +</dt> +<dd><p>This function perform the initialization of variables and any other +task before document outputting. It returns the encoding used for the +output files. +</p></dd></dl> + +<p>In the default case the <a name="IDX111"></a> +<code>$BODYTEXT</code> (see section <a href="#SEC35">Customizing the page header</a>) +and the hashes <a name="IDX112"></a> +<code>%NAVIGATION_TEXT</code> (see section <a href="#SEC23">Specifying the buttons formatting</a>) and +<a name="IDX113"></a> +<code>%BUTTONS_GOTO</code> (see section <a href="#SEC43">Formatting of about text</a>) are initialized. +</p> +<p>To perform the default initializations and also add more code, you could +do as in the following example (save the default function reference and call +it in your own function) : +</p> +<table><tr><td> </td><td><pre class="example">my $default_init_out = $init_out; +$init_out = \&makeinfo_like_init_out; +sub makeinfo_like_init_out() +{ + my $encoding = &$default_init_out(); + $NAVIGATION_TEXT{'Following'} = ' &gt; '; + return $encoding; +} +</pre></td></tr></table> +<hr size="6"> +<a name="Output-finalization"></a> +<a name="SEC33"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC32" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC34" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.6 Finalizing the output </h2> + +<p>If you want to do some cleaning after the document was generated (close +files, write at the end of files and so on), the following function +reference may be redefined: +</p> +<dl> +<dt><u>Function Reference:</u> <b>finish_out</b> +<a name="IDX114"></a> +</dt> +<dd><p>This function is called after the document generation. +</p></dd></dl> + +<p>The default is to do nothing. +</p> +<hr size="6"> +<a name="css"></a> +<a name="SEC34"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC33" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC35" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.7 Customizing the <code>texi2html</code> css lines </h2> + +<p>It is possible to modify the <code>texi2html</code> css lines by modifying +the entries or adding to the <a name="IDX115"></a> +<code>%css_map</code> hash. Each key is a css +selector, the corresponding value is a style string. +</p> +<p>The whole css text is in the variable <a name="IDX116"></a> +<code>$CSS_LINES</code>. If this +variable is defined the variable value is used instead of being +constructed using the <a name="IDX117"></a> +<code>%css_map</code> entries. For example if you don't +want any css entries, set +</p> +<table><tr><td> </td><td><pre class="example">$CSS_LINES = ''; +</pre></td></tr></table> +<p>It is also possible to change completely the way <a name="IDX118"></a> +<code>$CSS_LINES</code> are +generated by redefining the following function reference: +</p> + +<dl> +<dt><u>Function Reference:</u> <b>css_lines</b><i> \@import_lines \@rule_lines</i> +<a name="IDX119"></a> +</dt> +<dd><p>This function should be used to construct the <a name="IDX120"></a> +<code>$CSS_LINES</code>. +<var>\@import_lines</var> are the <code>@import</code> lines of the +files specified with <a name="IDX121"></a> +<samp>`--include-css'</samp>, +and <var>\@rule_lines</var> are the css commands lines of these files. +See section <a href="#SEC11">Customizing the <acronym>HTML</acronym> and text style</a>. +</p></dd></dl> + +<hr size="6"> +<a name="Customizing-header"></a> +<a name="SEC35"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC34" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC36" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.8 Customizing the page header </h2> + +<p>It is possible to add lines to the text within the <code><head></code> +<acronym>HTML</acronym> elements, by defining the variable <a name="IDX122"></a> +<code>$EXTRA_HEAD</code>. +Similarly it is possible to add text just after the <code><body></code> +element with the variable <a name="IDX123"></a> +<code>$AFTER_BODY_OPEN</code>. +These variables are empty by default. +</p> +<p>The encoding of the texinfo file is defined by <a name="IDX124"></a> +<code>$DOCUMENT_ENCODING</code> +if no <code>@documentencoding</code> appears in the document. +The default is a <samp>`en-ascii'</samp> encoding. +The encoding of the resulting document is defined by +<a name="IDX125"></a> +<code>$ENCODING</code>. The default is the <code>$DOCUMENT_ENCODING</code>. +</p> +<p>The description of the document may be specified in +<a name="IDX126"></a> +<code>$DOCUMENT_DESCRIPTION</code>. If this variable is undef, the text +associated with <code>@documentdescription</code> is used, and if there isn't +such test a default description is constructed using the document title and +the name of the first section of the file. +</p> +<p>The <code><body></code> element attributes may be set by defining the +variable <a name="IDX127"></a> +<code>$BODYTEXT</code>. If you want to define that variable +dynamically, you should use the <code>init_out</code> function reference +(see section <a href="#SEC32">Preparing the output</a>). +</p> +<p>The default functions call the function associated with +<a name="IDX128"></a> +<code>$print_head_navigation</code> to format the navigation panel for the +page header. Thus you can control parts of the formatting by +redefining the function reference. +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_head_navigation</b><i> $filehandle \@buttons</i> +<a name="IDX129"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>\@buttons</var> is an array reference which should hold the specification of +the buttons for the navigation panel. +</p></dd></dl> + +<p>If you want even more control, you can have full control over the page header +formatting by redefining three function references. The function associated +with <a name="IDX130"></a> +<code>$print_page_head</code> is called for all the pages, and after that, +the function associated with <a name="IDX131"></a> +<code>$print_chapter_header</code> is called +if the document is split at chapters, or the function associated with +<a name="IDX132"></a> +<code>$print_section_header</code> is called if the document is split at sections. +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_page_head</b><i> $filehandle</i> +<a name="IDX133"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function should print the page head, including the <code><body></code> +element. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_chapter_header</b><i> $filehandle</i> +<a name="IDX134"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function is called if the document is split at chapters, after +<code>print_page_head</code>. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_section_header</b><i> $filehandle</i> +<a name="IDX135"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function is called if the document is split at sections, after +<code>print_page_head</code>. +</p></dd></dl> + +<hr size="6"> +<a name="Customizing-section"></a> +<a name="SEC36"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC35" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC37" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.9 Customizing the sections </h2> + +<p>The functions associated with the following function references are used for +the formatting of sections: +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_section</b><i> $filehandle $first_in_page $previous_is_top</i> +<a name="IDX136"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>$first_in_page</var> is true if this section is the first section in the page. +<var>$previous_is_top</var> is true if this section is the section following the +Top section. +This function should print the current section. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>end_section</b><i> $filehandle $last_element_or_before_top</i> +<a name="IDX137"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>$last_element_or_before_top</var> is true if this section precedes the top +element or is the last one in page, or before the special elements. +</p></dd></dl> + +<hr size="6"> +<a name="Customizing-footer"></a> +<a name="SEC37"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC36" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC38" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.10 Customizing the page footer </h2> + +<p>It is possible to add text just before the <code></body></code> +element with the variable <a name="IDX138"></a> +<code>$PRE_BODY_CLOSE</code>. Nothing is added +by default. +</p> + +<p>The default functions call the function associated with +<a name="IDX139"></a> +<code>$print_foot_navigation</code> to format the navigation panel for the +page footer. Thus you can control parts of the formatting by +redefining the function reference. +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_foot_navigation</b><i> $filehandle \@buttons</i> +<a name="IDX140"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>\@buttons</var> is an array reference which should hold the specification of +the buttons for the navigation panel. +</p></dd></dl> + +<p>If you want even more control, you can have full control the page footer +formatting by redefining three function references. +The function associated with <a name="IDX141"></a> +<code>$print_chapter_footer</code> is called +if the document is split at chapters, or the function associated with +<a name="IDX142"></a> +<code>$print_section_footer</code> is called if the document is split at sections. + After that the function associated +with <a name="IDX143"></a> +<code>$print_page_foot</code> is called. +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_page_foot</b><i> $filehandle</i> +<a name="IDX144"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function should print the page foot, including the <code></body></code> +element. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_chapter_footer</b><i> $filehandle</i> +<a name="IDX145"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function is called if the document is split at chapters, before +<code>print_page_foot</code>. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_section_footer</b><i> $filehandle</i> +<a name="IDX146"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +This function is called if the document is split at sections, before +<code>print_page_foot</code>. +</p></dd></dl> + + +<hr size="6"> +<a name="Special-pages"></a> +<a name="SEC38"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC37" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC39" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.11 Special pages formatting </h2> + +<p>For the special elements, two things must be formatted: the content +and the page layout +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC39">6.11.1 Customizing the content of the special pages</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Special-pages-content"></a> +<a name="SEC39"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC38" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC40" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.11.1 Customizing the content of the special pages </h3> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC40">6.11.1.1 Top element text formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC42">6.11.1.3 Formatting of footnotes text</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC43">6.11.1.4 Formatting of about text</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Top-element-text"></a> +<a name="SEC40"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC39" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC41" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h4 class="subsubsection"> 6.11.1.1 Top element text formatting </h4> +<p>The top element formatting is controlled by three function which also +controls the layout of the top element page or section. The associated +function references are: +</p> +<dl> +<dt><u>Function Reference:</u> <b>print_Top_header</b><i> $filehandle $begin_page</i> +<a name="IDX147"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>$begin_page</var> is true if the element is the first in a page. +This function should begin the Top element. At the time this function is called +the top element text hasn't been parsed. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_Top</b><i> $filehandle $has_top_heading</i> +<a name="IDX148"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>$has_top_heading</var> is true if there is a <code>@heading</code> command or +<code>@titlefont</code> command appearing in the Top element text. +This function should be used to format the Top element text and navigation +panel. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>print_Top_footer</b><i> $filehandle $end_page</i> +<a name="IDX149"></a> +</dt> +<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. +<var>$end_page</var> is true if the element is the last in a page. +This function should end the Top element. +</p></dd></dl> + +<hr size="6"> +<a name="Contents-and-Overview-text"></a> +<a name="SEC41"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC40" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC42" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h4 class="subsubsection"> 6.11.1.2 Table of contents and Short table of contents </h4> +<p>Several variables may be used to control the formatting of table of contents +and short table of contents: +</p> +<dl compact="compact"> +<dt> <code>$DO_CONTENTS</code> +<a name="IDX150"></a> +</dt> +<dd><p>If the variable is true a table of contents is done even if there is no +<code>@contents</code> command. +</p></dd> +<dt> <code>$DO_SCONTENTS</code> +<a name="IDX151"></a> +</dt> +<dd><p>If the variable is true a short table of contents is done even if there is no +<code>@summarycontents</code> command. +</p></dd> +<dt> <code>$BEFORE_OVERVIEW</code> +<a name="IDX152"></a> +</dt> +<dd><p>The variable value is inserted before the short table of contents text. +</p></dd> +<dt> <code>$AFTER_OVERVIEW</code> +<a name="IDX153"></a> +</dt> +<dd><p>The variable value is inserted after the short table of contents text. +</p></dd> +<dt> <code>$BEFORE_TOC_LINES</code> +<a name="IDX154"></a> +</dt> +<dd><p>The variable value is inserted before the table of contents text. +</p></dd> +<dt> <code>$AFTER_TOC_LINES</code> +<a name="IDX155"></a> +</dt> +<dd><p>The variable value is inserted after the table of contents text. +</p></dd> +<dt> <code>$TOC_LIST_STYLE</code> +<a name="IDX156"></a> +</dt> +<dd><p>This should contain a css style used for the list style if the tables of +content are formatted with a list. +</p></dd> +<dt> <code>$TOC_LIST_ATTRIBUTE</code> +<a name="IDX157"></a> +</dt> +<dd><p>This should contain an attribute text used for the list element if the tables of +content are formatted with a list. +</p></dd> +</dl> + +<p>More control on the table of contents and short table of contents formatting +may be achieved by redefining a function with the following associated +function reference: +</p> +<dl> +<dt><u>Function Reference:</u> <b>toc_body</b><i> \@elements </i> +<a name="IDX158"></a> +</dt> +<dd><p><var>\@elements</var> is an array reference contining informations about +all the elements of the document. Each of the entry of this array is an hash +reference which entries correspond with different informations +about the element. Interesting keys have the following meaning: +</p> +<dl compact="compact"> +<dt> <code>top</code></dt> +<dd><p>true if the element is the top element, +</p></dd> +<dt> <code>index_page</code></dt> +<dd><p>true if the element is an index page added because of index splitting, +</p></dd> +<dt> <code>toc_level</code></dt> +<dd><p>level of the element in the table of content. Highest level +is 1 for the top element and for chapters, appendix and so on, +2 for section, unnumberedsec and so on... +</p></dd> +<dt> <code>tocid</code></dt> +<dd><p>label used for reference linking to the element in table of +contents, +</p></dd> +<dt> <code>file</code> </dt> +<dd><p>the file containing the element, usefull to do href to that file +in case the document is split, +</p></dd> +<dt> <code>text</code></dt> +<dd><p>text of the element, with section number, +</p></dd> +<dt> <code>name</code></dt> +<dd><p>text of the element, without section number. +</p></dd> +</dl> + +<p>This function doesn't return anything but should fill the array corresponding +with the +<a name="IDX159"></a> +<code>$Texi2HTML::TOC_LINES</code> and +<a name="IDX160"></a> +<code>$Texi2HTML::OVERVIEW</code> references with the table of contents and short +table of contents. +</p> +</dd></dl> + +<hr size="6"> +<a name="Footnotes-text"></a> +<a name="SEC42"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC41" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC43" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h4 class="subsubsection"> 6.11.1.3 Formatting of footnotes text </h4> + +<p>The footnotes text is allready formatting when <code>@footnote</code> commands +are expanded. See section <a href="#SEC82">Customizing the footnotes formatting</a>. +</p> +<hr size="6"> +<a name="About-text"></a> +<a name="SEC43"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC42" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC44" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h4 class="subsubsection"> 6.11.1.4 Formatting of about text </h4> + +<p>The default about element contains an explaination of the buttons used +in the document (<code>@SECTION_BUTTONS</code>, <a href="#SEC23">Specifying the buttons formatting</a>) and +an example locating the buttons targets in an example. +The formatting of this text may be influenced by the following +hashes and variables: +</p> +<dl compact="compact"> +<dt> <code>$PRE_ABOUT</code> </dt> +<dt> <code>$AFTER_ABOUT</code></dt> +<dd><p>This variable may be a scalar or a function reference. +If it is a scalar, the value is used. +If this is a function reference it is expanded and the returned text is +used. The text is added before or after the main about text. +</p></dd> +<dt> <code>%BUTTONS_GOTO</code></dt> +<dd> +<p>The keys of this hash are element labels (see <a href="#Element-labels">Element labels</a>). The value +is the text associated with the element label in the about text. +The element of the hash are defined +dynamically, you should in the <code>init_out</code> function reference +(see section <a href="#SEC32">Preparing the output</a>). +</p> + +</dd> +<dt> <code>%BUTTONS_EXAMPLE</code></dt> +<dd> +<p>The keys of this hash are element labels (see <a href="#Element-labels">Element labels</a>). The value +is the text associated with the element label in the about example, +typically a section number. +</p> +</dd> +</dl> + +<p>If this is not enough and you want to control exactly the formatting of +the about text, you can redefine the function associated with the following +function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $about_text <b>print_about</b> +<a name="IDX161"></a> +</dt> +<dd><p>This function should return the about text. +</p></dd></dl> + +<hr size="6"> +<a name="Special-pages-layout"></a> +<a name="SEC44"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC43" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC45" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 6.11.2 Customizing the layout of the special pages </h3> + +<p>The formatting of each of the special pages, or section in case +the document is not split, is controlled by a function. +The associated function reference is called accordingly: +</p> +<dl compact="compact"> +<dt> <code>print_Top</code> +<a name="IDX162"></a> +</dt> +<dt> <code>print_Top_header</code> +<a name="IDX163"></a> +</dt> +<dt> <code>print_Top_footer</code> +<a name="IDX164"></a> +</dt> +<dd><p>Formatting of top element page or section. It is also used for the formatting +of the top element text (see section <a href="#SEC40">Top element text formatting</a>). +</p></dd> +<dt> <code>print_Toc</code> +<a name="IDX165"></a> +</dt> +<dd><p>Formatting of table of contents page or section +</p></dd> +<dt> <code>print_Overview</code> +<a name="IDX166"></a> +</dt> +<dd><p>Formatting of short table of contents page or section +</p></dd> +<dt> <code>print_About</code> +<a name="IDX167"></a> +</dt> +<dd><p>Formatting of about (help) page or section +</p></dd> +<dt> <code>print_Footnotes</code> +<a name="IDX168"></a> +</dt> +<dd><p>Formatting of footnotes section or page in case footnotes are on a +separated page or the document isn't split. +</p></dd> +</dl> + +<p>In the default case, <a name="IDX169"></a> +<code>$print_Top</code> calls <a name="IDX170"></a> +<code>$print_Top_header</code> for +the header and <a name="IDX171"></a> +<code>$print_Top_footer</code> for the footer of top element. +All the other function call <a name="IDX172"></a> +<code>$print_misc</code> which in turn calls +<a name="IDX173"></a> +<code>$print_misc_header</code> for the headers and <a name="IDX174"></a> +<code>$print_misc_footer</code> +for the footers. +</p> +<hr size="6"> +<a name="File-names"></a> +<a name="SEC45"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC44" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC46" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.12 Customizing the file names </h2> + +<p>It is possible to specify the file names with more control than with the +command line options (see section <a href="#SEC7">Setting output file and directory names</a>). +First the extension may be overrided by the variable <a name="IDX175"></a> +<code>$EXTENSION</code> +value. +Two function references enable +further customization. One is usefull in case <a name="IDX176"></a> +<code>$NODE_FILES</code> is true +and it is used to customize the node file name itself and is also used +to produce a file name with a redirection leading to the node file. +</p> +<dl> +<dt><u>Function Reference:</u> ($node_file $redirection_node_file) <b>node_file_name</b><i> $node</i> +<a name="IDX177"></a> +</dt> +<dd><p><var>$node</var> is a hash reference with the following interesting keys (there +are much more keys): +</p><dl compact="compact"> +<dt> <code>texi</code></dt> +<dd><p>The texinfo node name. +</p></dd> +<dt> <code>with_section</code></dt> +<dd><p>True if associated with a section. +</p></dd> +</dl> +<p>The result is the node file name <var>$node_file</var>, and the file containing +a redirection to the node <var>$redirection_node_file</var>. +</p></dd></dl> + +<p>The other is usefull if <code>$NODE_FILES</code> isn't true. It is used to +customize the file associated with each element. +</p><dl> +<dt><u>Function Reference:</u> $file <b>element_file_name</b><i> $element $is_top $docu_name</i> +<a name="IDX178"></a> +</dt> +<dd><p><var>$element</var> is a hash reference with the following interesting keys (there +are much more keys): +</p><dl compact="compact"> +<dt> <code>texi</code></dt> +<dd><p>The texinfo element name. +</p></dd> +<dt> <code>number</code></dt> +<dd><p>The number associated with a section. +</p></dd> +<dt> <code>doc_nr</code></dt> +<dd><p>A number incremented whenever a new file should begin, based on how the +document is split (see section <a href="#SEC6">Specifying where to split the generated document</a>). +</p></dd> +<dt> <code>text</code></dt> +<dd><p>The element text. +</p></dd> +<dt> <code>name</code></dt> +<dd><p>The element text without section number. +</p></dd> +</dl> +<p><var>$is_top</var> is true if the element is considered as the top element. +<var>$docu_name</var> is the basename of the texinfo manual. +The result is the element file name. +</p></dd></dl> + +<hr size="6"> +<a name="External-index-files"></a> +<a name="SEC46"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC45" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 6.13 Generation of external files for index entries </h2> + +<p>Within the document, <code>@printindex</code> commands are expanded as explained +in <a href="#SEC78">Customizing the formatting of index lists</a>. In case you want to do something special with index +entries, outside of the document, you should first set the variable +<a name="IDX179"></a> +<code>$IDX_SUMMARY</code> true. After that some function reference will be called +for each non empty index. For each index there are 3 function +references, one called for initialization, one called for each index entry +and the last one called for finalazation. +</p> +<dl> +<dt><u>Function Reference:</u> <b>index_summary_file_begin</b><i> $index_name $is_printed</i> +<a name="IDX180"></a> +</dt> +<dd><p><var>$index_name</var> is the two letters name for the index. +This function +is called for each index +appearing in the document, before +<code>index_summary_file_entry</code>. +<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>index_summary_file_entry</b><i> $index_name $entry_text $entry_reference $formatted_entry $texi_entry $entry_element_reference $entry_element_header $is_printed</i> +<a name="IDX181"></a> +</dt> +<dd><p>This function is called for each entry of an index. <var>index_name</var> is the +name of the index. <var>$entry_text</var> is the entry in plain text, +<var>$formatted_entry</var> is the index entry formatted, <var>$texi_entry</var> is the +entry with texinfo commands. <var>$entry_reference</var> is the reference placed +at the index entry place, in the form <samp>`file#id'</samp>. +<var>$entry_element_header</var> is the formatted header of the element containing +the index entry. <var>entry_element_header</var> is the reference to the +beginning of the element containing the index entry, in the form +<samp>`file#id'</samp>. +<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> <b>index_summary_file_end</b><i> $index_name $is_printed</i> +<a name="IDX182"></a> +</dt> +<dd><p><var>$index_name</var> is the two letters name for the index. This function +is called for each index appearing in the document, after +<code>index_summary_file_entry</code>. +<var>$is_printed</var> is true if there is a <code>@printindex</code> for that index. +</p></dd></dl> + +<hr size="6"> +<a name="Customizing-HTML"></a> +<a name="SEC47"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC46" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC48" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="chapter"> 7. Customizing <acronym>HTML</acronym> and text style in init files </h1> + +<p>Some simple customization may be achieved with the redefinition of the +variables +associated with the command line options. For the description and an +explanation of the meaning of these variables, <a href="#SEC11">Customizing the <acronym>HTML</acronym> and text style</a>. +</p> +<p>Other variables and hash entries can be modified in initialization file +to achieve more customization. +Lastly, functions references corresponding with functions called from +the main program and initialization files may +be redefined. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC48">7.1 Three contexts for expansions: preformatted, normal and string</a></td><td> </td><td align="left" valign="top"> there are three different contexts for command + expansion: normal text, preformatted text and + strings. +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC54">7.4 Formatting of special simple commands</a></td><td> </td><td align="left" valign="top"> Formatting of <code>@anchor</code>, <code>@image</code>, <code>@sp</code>, <code>@acronym</code>, <code>@abbr</code> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC55">7.5 Processing special characters in text</a></td><td> </td><td align="left" valign="top"> Some characters are processed specially +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td><td> </td><td align="left" valign="top"> <code>texi2html</code> write some strings in the output + different for each languages +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC57">7.7 References</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td><td> </td><td align="left" valign="top"> <code>@center</code>, <code>@flushleft</code>… +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td><td> </td><td align="left" valign="top"> <code>@example</code>, <code>@display</code>… +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC65">7.11 Customizing the formatting of lists and tables</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC68">7.12 Definition commands formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC71">7.13 Customizing headings formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC72">7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</a></td><td> </td><td align="left" valign="top"> <code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC73">7.15 Menu formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC76">7.16 Indices formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC79">7.17 Floats and lists of floats</a></td><td> </td><td align="left" valign="top"> <code>@float</code> and <code>@listoffloats</code> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC82">7.18 Customizing the footnotes formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td><td> </td><td align="left" valign="top"> You can handle specifically other commands +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> +</pre></th></tr></table> + +<hr size="6"> +<a name="Three-contexts"></a> +<a name="SEC48"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC47" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC49" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.1 Three contexts for expansions: preformatted, normal and string </h2> + +<p>There are three contexts of interest, one is the normal context, the other +is a special context, called the <em>preformatted</em> context and the last is +the string context. The preformatted +context occurs when the spacing between words is kept. This is the +case, for example, in <code>@display</code> or <code>@example</code> regions, and in +menu comments (see section <a href="#SEC73">Menu formatting</a>). The preformatted regions are usually +rendered in <code><pre></code> elements in <acronym>HTML</acronym>. +The string context occurs when rendering strings without formatting elements, +in comments or titles for example. +</p> +<hr size="6"> +<a name="Commands-without-argument"></a> +<a name="SEC49"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC48" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC50" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.2 Customizing the formatting of commands without argument </h2> + +<p>This includes the commands whose name is a nonletter character like <code>@@</code>, +the commands with lettered characters and braces +but whose braces should be empty, like <code>@TeX{}</code>, or some commands +associated with accentted letters like <code>@AA{}</code>. If there happens to +be something within the braces, it is put after the command, thus +</p><table><tr><td> </td><td><pre class="example">@TeX{something} +</pre></td></tr></table><p>leads to the same than +</p><table><tr><td> </td><td><pre class="example">@TeX{} something +</pre></td></tr></table> +<p>Each of these categories of commands have three associated hashes, one +for normal +context, the other for preformatted context and the last in strings. The +keys of the hashes are the +command names, the associated value is the text replacing the command. +</p> +<p>The hashes are: +</p><table> +<tr><td><p> command type </p></td><td><p> normal text </p></td><td><p> preformatted text </p></td><td><p> string +</p></td></tr> +<tr><td><p> one nonlettered character </p></td><td> <a name="IDX183"></a> +<p><code>%simple_map</code> </p></td><td> <a name="IDX184"></a> +<p><code>%simple_map_pre</code> </p></td><td> <a name="IDX185"></a> +<p><code>%simple_map_texi</code> +</p></td></tr> +<tr><td><p> nothing in braces </p></td><td> <a name="IDX186"></a> +<p><code>%things_map</code> </p></td><td> <a name="IDX187"></a> +<p><code>%pre_map</code> </p></td><td> <a name="IDX188"></a> +<p><code>%texi_map</code> +</p></td></tr> +</table> + +<p>To change the <acronym>HTML</acronym> resulting from these constructs, just change the +value. For example, if you want <code>&shy;</code> to be outputted for <code>@-</code> +in normal and preformatted context, write in your init file: +</p> +<table><tr><td> </td><td><pre class="example">$simple_map{'-'} = '&shy;'; +$simple_map_pre{'-'} = '&shy;'; +</pre></td></tr></table> +<hr size="6"> +<a name="Style-and-accent-commands"></a> +<a name="SEC50"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC49" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC51" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.3 Customizing accent, style and other simple commands </h2> + +<p>The formatting of the <acronym>HTML</acronym> produced by style and indicatric +commands (<code>@tt</code>, <code>@code</code>, +<code>@email</code>, <code>@titlefont</code>), the accentuation related +commands taking argument (<code>@'</code>, <code>@udotaccent</code>, <code>@dotless</code>) +and miscalleneous commands (<code>@email</code>, <code>@verb</code>, <code>@w</code>, +<code>@uref</code>, <code>@math</code>, <code>@asis</code>) is controlled by two hash in the +default case, +<a name="IDX189"></a> +<code>%style_map</code> for normal context, <a name="IDX190"></a> +<code>%style_map_pre</code> for +preformatted context and <a name="IDX191"></a> +<code>%style_map_texi</code> in string context. +</p> +<p>The key of the hashes are the command names. There are two possibilities for +the values corresponding with two interfaces. The values may be strings or +hash references, and you can chose the interface depending on the one you +prefer. The interface with hash reference is a bit more flexible but might also +be regarded as more complex. If you don't like either of these interfaces you +can define your own. +</p> +<p>Some remarks are in order: +</p> +<ul class="toc"> +<li> +The nonlettered accent commands which following character is considered +to be the argument (like in <code>@`a</code>) should be keys of the +hash <a name="IDX192"></a> +<code>%accent_map</code> hash, even if no value is associated. +</li><li> +<code>@math</code> is handled differently if LaTeX2HTML is used. +</li></ul> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC53">7.3.3 Defining the style and indicatric commands interface</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Hash-reference-interface"></a> +<a name="SEC51"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC50" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC52" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.3.1 An interface for commands formatting with a hash reference </h3> + +<p>The key of the hashes are the command names. The value determine how the command argument +is formatted. This value is a reference on a hash. In this hash each key +corresponds with a type of information for the formatting, and the value is +the corresponding information. For example, in +</p> +<table><tr><td> </td><td><pre class="example">$style_map{'command'} = { 'args' => ['code'], 'attribute' => 'code'}; +</pre></td></tr></table> +<p>the arguments for <code>@command</code> are interpreted as specified by +the values associated with the <samp>`args'</samp> key while the attribute associated +with that command is <samp>`code'</samp>. +</p> +<p>The following keys in the hashes associated with each command have the +following meaning: +</p> +<dl compact="compact"> +<dt> <samp>`args'</samp></dt> +<dd><p><a name="Reference-hash-args"></a> +The value associated is a reference on an array. Each element of the array +defines how the arguments (separated by <samp>`,'</samp> in the texinfo code) for +the @-command should be +formatted. The possibilities are +</p><dl compact="compact"> +<dt> <code>normal</code></dt> +<dd><p>for normal text, +</p></dd> +<dt> <code>code</code></dt> +<dd><p>for text with <samp>`---'</samp>, <samp>`--'</samp>, <samp>`'''</samp> and <samp>```'</samp> kept as is, +</p></dd> +<dt> <code>keep</code></dt> +<dd><p>if the texinfo should be kept as is, without interpretation of the @-commands. +</p></dd> +</dl> + +<p>For example, we have +</p><table><tr><td> </td><td><pre class="example">$style_map{'email'}->{'args'} = ['code', 'normal']; +</pre></td></tr></table> +<p>because <samp>`---'</samp>, <samp>`--'</samp>, <samp>`'''</samp> and <samp>```'</samp> should be kept as is in +the first argument of <code>@email</code>. +</p> +<p>The default is <samp>`['normal']'</samp>. +</p> +</dd> +<dt> <samp>`attribute'</samp></dt> +<dd> +<p>If the associated value is a word, it is considered to be an <acronym>HTML</acronym> +element name, and the argument is enclosed between the element opening +and the element closing. For example, if the value is <code>elem</code>, the +resulting <acronym>HTML</acronym> is <code><elem><var>arg</var></elem></code>. +</p> +<p>If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +Thus <code>elem class="elem"</code> leads to +<code><elem class="elem"><var>arg</var></elem></code>. +</p> +<p>This works only if there is only one argument. +</p> +</dd> +<dt> <samp>`begin'</samp></dt> +<dd> +<p>The associated value is added in front of the text. +</p> +</dd> +<dt> <samp>`begin'</samp></dt> +<dd> +<p>The associated value is added after the text. +</p> +</dd> +<dt> <samp>`quotes'</samp></dt> +<dd> +<p>If the corresponding value is true, the result is +enclosed in quotes <a name="IDX193"></a> +<code>$OPEN_QUOTE_SYMBOL</code> and +<a name="IDX194"></a> +<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults +<samp>``'</samp> and <samp>`''</samp>. +</p> +</dd> +<dt> <samp>`function'</samp> </dt> +<dd> +<p>The corresponding value should be a function reference. The corresponding +function is called with the following arguments: +</p> +<dl compact="compact"> +<dt> <code>$command</code></dt> +<dd><p>The @-command name +</p></dd> +<dt> <code>$args</code></dt> +<dd><p>A reference on an array containing the arguments of the @-command. +</p></dd> +<dt> <code>$style_stack</code></dt> +<dd><p>A reference on an array containing the name of the @-commands containing +the @-command being formatted. +</p></dd> +<dt> <code>$state</code></dt> +<dd><p>A reference on a hash containing a lot of informations about the context +of the @-command. +</p></dd> +<dt> <code>$line_nr</code></dt> +<dd><p>An opaque structure containing the information about the line number of the +@-command. It can be used to call <code>main::echo_error</code> or +<code>main::echo_warning</code> with first argument a message, and second argument +<code>$line_nr</code>. +</p></dd> +</dl> +</dd> +</dl> + +<hr size="6"> +<a name="String-interface"></a> +<a name="SEC52"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC51" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC53" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.3.2 An interface for commands formatting with a string </h3> + +<p>The keys of the hashes are the command names. The value determine +how the command argument +is formatted. If the value begins with <samp>`"'</samp>, the result is +enclosed in quotes <a name="IDX195"></a> +<code>$OPEN_QUOTE_SYMBOL</code> and +<a name="IDX196"></a> +<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults +<samp>``'</samp> and <samp>`''</samp>. +</p> +<p>The command argument is allready formatted as <acronym>HTML</acronym>. +The remaining of the value text +(or the value text if there were no <samp>`"'</samp>) is interpreted as follow: +</p> +<ul> +<li> +If the text is empty the argument of the command is left as is. +</li><li> +If the text is a <samp>`&'</samp> followed by a name, +like <samp>`&function'</samp>, the name is considered to be a function name, +and this function is called to format the argument of the command. The +first argument of the function is the command name, the second is +the command argument. For example, if the value associated with the +(fictituous) command <code>@foo</code> is <code>&my_func</code> +and we have: + +<table><tr><td> </td><td><pre class="example">sub my_func +{ + my @args = split /,\s*/ $_[1]; + return "$_[0]: $args[0]" if ($args[1] = 1); + return "$args[0]"; +} +</pre></td></tr></table> +<p>The result of +</p><table><tr><td> </td><td><pre class="example">@foo{truc, 1} +@foo{truc, bidule} +</pre></td></tr></table> +<p>will be +</p><table><tr><td> </td><td><pre class="example">foo: truc +truc +</pre></td></tr></table></li><li> +If the text is a word, it is considered to be an <acronym>HTML</acronym> element +name, and the argument is enclosed between the element opening +and the element closing. For example, if the value is <code>elem</code>, the +resulting <acronym>HTML</acronym> is <code><elem><var>arg</var></elem></code>. +Similarly <code>"quoted</code> leads to +<code>`<quoted><var>arg</var></quoted>'</code>. +</li><li> +If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +Thus <code>elem class="elem"</code> leads to +<code><elem class="elem"><var>arg</var></elem></code>. +</li></ul> + +<hr size="6"> +<a name="Define-your-own-interface"></a> +<a name="SEC53"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC52" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC54" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.3.3 Defining the style and indicatric commands interface </h3> + +<p>If you don't like this scheme, it is possible to change how those commands +are processed by redefining the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $resulting_text <b>style</b><i> $style $command $text $args $no_close $no_open $line_nr $state $style_stack</i> +<a name="IDX197"></a> +</dt> +<dd><p><var>$command</var> is the @-command, <var>$style</var> is the value associated with +the <var>$command</var> in the <code>%style_map</code>, <code>%style_map_pre</code> +or <code>%style_map_texi</code> hashes. +The <var>$text</var> is the text appearing within the @-command braces. +<var>args</var> is a reference on an array contening the command arguments +formatted according to the same conventions than with the reference hash style +(provided the value associated with the @-command is a hash reference with a +<var>$arg</var> key as described in <a href="#Reference-hash-args">Reference hash args</a>). +If <var>$text</var> is split in paragraphs each paragraph is passed through +the function, and <var>$no_close</var> is true if it is not the last paragraph, +while <var>$no_open</var> is true if it is not the first paragraph. +<var>$line_nr</var> +is an opaque structure containing the information about the line number of the +@-command. It can be used to call <code>main::echo_error</code> or +<code>main::echo_warning</code> with first argument a message, and second argument +<code>$line_nr</code>. +<var>$state</var> +is a reference on a hash containing a lot of informations about the context +of the @-command. +<var>$style_stack</var> +is a reference on an array containing the name of the @-commands containing +the @-command being formatted. +</p> +</dd></dl> + +<hr size="6"> +<a name="Anchors-images-and-spaces"></a> +<a name="SEC54"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC53" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC55" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.4 Formatting of special simple commands </h2> + +<p>The formatting of special simple commands is controlled by functions. To +customize the output, the corresponding function references should be +redefined. All these functions return a formatted text. +</p> +<p>The formatting of anchors is controlled by <a name="IDX198"></a> +<code>$anchor</code>, but the function +associated with the function reference does more, it is usefull +to produce a reference target or link. +</p><dl> +<dt><u>Function Reference:</u> $anchor <b>anchor</b><i> $identifier $href $text $attributes</i> +<a name="IDX199"></a> +</dt> +<dd><p>If <var>$identifier</var> is not empty, this value should be used to create +a target for links (typically associated with a name or id +attribute in <acronym>HTML</acronym>). +The <var>$href</var> argument specifies a hpertextual reference which should be +used to link to a target. +In case both <var>$identifier</var> and <var>$href</var> are given the text produced +should be both a target for <var>$identifier</var> and a link to <var>$href</var>. +<var>$text</var> is the text to be displayed. +<var>$attributes</var> are additional attributes. +It should be reasonable to assume that the attributes are for a <code><a></code> +<acronym>HTML</acronym> element. +</p></dd></dl> + +<p>The formatting of <code>@image</code> is controlled by: +</p><dl> +<dt><u>Function Reference:</u> $image <b>image</b><i> $file_path $basename $preformatted $file_name</i> +<a name="IDX200"></a> +</dt> +<dd><p><var>$file_path</var> is the image file name with the path, <var>$basename</var> is the +alternate text or the file name without extension if no alternate text is +given. <var>$preformatted</var> is true if the image +appears in preformatted text. <var>$file_name</var> is the file name without path +but with extension. +</p></dd></dl> + +<p>The formatting of <code>@sp</code> is controlled by: +</p><dl> +<dt><u>Function Reference:</u> $sp <b>sp</b><i> $number $preformatted</i> +<a name="IDX201"></a> +</dt> +<dd><p><var>$number</var> is the numeric argument of <code>@sp</code>. +<var>$preformatted</var> is true if the <code>@sp</code> appears in preformatted text. +</p></dd></dl> + +<p>The formatting of <code>@acronym</code> and <code>@abbr</code> is controlled by: +</p><dl> +<dt><u>Function Reference:</u> $acronym <b>acronym_like</b><i> $acronym_texi $acronym_text $with_explanation \@explanation_lines $explanation_text $explanation_simply_formatted</i> +<a name="IDX202"></a> +</dt> +<dd><p><var>$acronym_texi</var> is the acronym argument with texinfo @-commands, +<var>$acronym_text</var> is formatted. +</p> +<p>The other arguments are related with +the explanation, the second arg of the acronym. <var>$with_explanation</var> is +true if the second argument of the acronym command is present. If an +explanation exists, coming from previous <code>@acronym</code> or as an arg of this +command, the other args are defined: <var>\@explanation_lines</var> is a +reference on an array containing the unformatted explanation lines, +<var>$explanation_text</var> is the explanation text formatted, +<var>$explanation_simply_formatted</var> is the explanation with a light formatting, +unabling in <acronym>HTML</acronym> (or <acronym>XML</acronym>) the explanation to be in an +attribute. +</p></dd></dl> + +<hr size="6"> +<a name="Text"></a> +<a name="SEC55"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC54" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC56" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.5 Processing special characters in text </h2> + +<p>Some characters are processed especially in text: <samp>`---'</samp>, <samp>`--'</samp>, +<samp>```'</samp> and <samp>`'''</samp>. This is done only if in normal text and not in +some commands (<code>@code</code>, <code>@env</code>…). A function reference +is called to process those characters in text +</p> +<dl> +<dt><u>Function Reference:</u> $processed_text <b>normal_text</b><i> $text</i> +<a name="IDX203"></a> +</dt> +<dd><p>The function processes <samp>`---'</samp>, <samp>`--'</samp>, <samp>```'</samp> and <samp>`'''</samp> +in <var>$text</var> and returns <var>$processed_text</var>. The default is to +change <samp>`---'</samp> to <samp>`--'</samp>, <samp>`--'</samp> to <samp>`-'</samp>, and <samp>```'</samp> and +<samp>`'''</samp> to <samp>`"'</samp>. +</p></dd></dl> + +<p>Some characters are special in <acronym>HTML</acronym> (<samp>`&'</samp>, <samp>`"'</samp>, +<samp>`<'</samp> and <samp>`>'</samp>) and should be protected. +This is done by the function associated with the function reference +</p> +<dl> +<dt><u>Function Reference:</u> $protected_text <b>protect_text</b><i> $text</i> +<a name="IDX204"></a> +</dt> +<dd><p>The function processes the unprotected text <var>$text</var> and returns +the resulting protected text <var>$protected_text</var>. +</p></dd></dl> + +<p>Empty lines are processed by the following function reference, which could +be usefull if empty lines are to be removed for example +</p> +<dl> +<dt><u>Function Reference:</u> $resulting_text <b>empty_line</b><i> $empty_line</i> +<a name="IDX205"></a> +</dt> +<dd><p>This function processes an <var>$empty_line</var> and returns the resulting +text <var>$resulting_text</var>. Empty lines are left as is by default. +</p></dd></dl> + +<hr size="6"> +<a name="Strings"></a> +<a name="SEC56"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC55" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC57" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.6 Customizing strings written by <code>texi2html</code> </h2> + + +<p><code>texi2html</code> writes some strings in the generated document at +various places, at the page footers, on the help page, for special +section headings, buttons alt text and so on. These strings are +customizable. The string chosen depends on the language of the +document (set by <a name="IDX206"></a> +<samp>`--lang'</samp>, <a name="IDX207"></a> +<code>$LANG</code> or +<code>@documentlanguage</code>). This is the basis for internationalization +as it allows for strings translations. +</p> +<p>The strings are found in a hash reference, <a name="IDX208"></a> +<code>$LANGUAGES</code>. +Each key is a language code. The associated value is also a hash +reference. The key is an english string and the associated value +is the string replacing the english string, if present. For example, +we have +</p> +<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = { + ' Up ' => 'Plus haut', +}; +</pre></td></tr></table> +<p>It means that whenever the string <samp>` Up '</samp> is to be written +and the language is <samp>`fr'</samp>, <samp>`Plus haut'</samp> is written. It is possible +to customize the english strings by redefining the <samp>`en'</samp> language hash. +</p> +<p>When a string contains a <samp>`%'</samp> followed by <samp>`{'</samp> <var>name</var> <samp>`}'</samp> +it means that the string will be expanded by <code>texi2html</code>. For +example, if we have +</p> +<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = { + 'See %{node_file_href}' => 'Voir %{node_file_href}', +}; +</pre></td></tr></table> +<p><samp>`%{node_file_href}'</samp> will be expanded to an href for a node in a +file by <code>texi2html</code> in the string. A <samp>`%%'</samp> will be expanded +as <samp>`%'</samp>. +</p> +<p>For more on internationalization, see <a href="#SEC84">Internationalization</a>. +</p> +<hr size="6"> +<a name="References"></a> +<a name="SEC57"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC56" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC58" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.7 References </h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC59">7.7.2 Reference to an internal node</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Reference-to-external-manual"></a> +<a name="SEC58"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC57" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC59" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.7.1 Reference to external manual </h3> + +<p>The references are produced with two function references, one for the +hypertextual reference construction, the other for the full reference to +external manual. +</p> +<dl> +<dt><u>Function Reference:</u> $href <b>external_href</b><i> $node $node_identifier $xml_node_identifier $manual_file_name</i> +<a name="IDX209"></a> +</dt> +<dd><p><var>$node</var> is the node name, with @-commands. <var>$node_identifer</var> is the +node name mapped to an identifier acceptable as a file name. +<var>$xml_node_identifier</var> is the +node name mapped to an identifier acceptable as an <acronym>XML</acronym> identifier. +Those identifiers are built as explained in <a href="texinfo.html#HTML-Xref">(texinfo)HTML Xref</a>, +thus allowing for cross references to external manuals. <var>$file</var> is the +manual or file name of the external reference. This function should return an +href leading to the external manual. +</p> +<p>The default for this function is to make a reference compatible with +<code>makeinfo</code> (see <a href="texinfo.html#HTML-Xref">(texinfo)HTML Xref</a>). +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $text <b>external_ref</b><i> $command $section $book $node_and_file $href $cross_ref_name</i> +<a name="IDX210"></a> +</dt> +<dd><p>This function formats a reference to an external texinfo manual. +The <var>$command</var> is the ref command (<code>ref</code>, <code>xref</code> or +<code>pxref</code>, in text, at sentence beginning or in parenthesis). +The optionnal <var>$section</var> argument is the section in the book and + <var>book</var> is the book title. +<var>$node_and_file</var> is the node and file name formatted according to the +convention used in info: <samp>`(file)node'</samp>. <var>$href</var> it an hypertextual +reference to the distant manual constructed using the above function. +<var>$cross_ref_name</var> is an optionnal cross +reference name appearing in the reference command. This function returns +the text corresponding with the external html manual reference. +This function returns the full formatted text of the external reference. +</p></dd></dl> + +<hr size="6"> +<a name="Internal-reference"></a> +<a name="SEC59"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC58" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC60" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.7.2 Reference to an internal node </h3> + +<p>A function reference is available for internal references. +</p> +<dl> +<dt><u>Function Reference:</u> $text <b>internal_ref</b><i> $command $href $short_name $name $is_section</i> +<a name="IDX211"></a> +</dt> +<dd><p>This function formats a reference to a node in the current manual. +The <var>$command</var> is the ref command (<code>ref</code>, <code>xref</code> or +<code>pxref</code>, in text, at sentence beginning or in parenthesis). +<var>$href</var> it an hypertextual reference linking to the corresponding +node or section. <var>$short_name</var> and <var>$name</var> hold the text for the +reference but <var>$short_name</var> can be the node name which is assumed to +be shorter than the section name. +<var>$is_section</var> is a boolean true if the reference is a reference to a +section. This function returns the full formatted text of the internal +reference. +</p></dd></dl> + + +<hr size="6"> +<a name="Alignement-commands"></a> +<a name="SEC60"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC59" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC61" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.8 Commands used for centering and flushing of text </h2> + + +<p>When a command controlling the alignement of text is used (<code>@center</code>, +<code>@flushleft</code> and <code>@flushright</code>), the main program takes +care of opening and closing paragraphs. The alignement commands are the +key of the <a name="IDX212"></a> +<code>%paragraph_style</code> hash. +The value is used in the function doing the formatting of the paragraphs. +See section <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>. +</p> +<p>A function references allows for a customization of the formatting of the text +appearing in the command block. +</p> +<dl> +<dt><u>Function Reference:</u> $result <b>paragraph_style_command</b><i> $command $text</i> +<a name="IDX213"></a> +</dt> +<dd><p><var>$command</var> is the command name, <var>$text</var> is the text appearing within +the command. This function returns a formatted text. +The default is to return the text unmodified. +</p></dd></dl> + +<hr size="6"> +<a name="Paragraph-and-preformatted-region"></a> +<a name="SEC61"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC60" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC62" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.9 Formatting or not a paragraph or a preformatted region </h2> + + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Paragraph-and-preformatted-formatting"></a> +<a name="SEC62"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC61" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC63" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.9.1 Paragraph and preformatted region formatting </h3> + + +<p>The formatting of a paragraph region or a preformatted region, is controlled +by function references: +</p> +<dl> +<dt><u>Function Reference:</u> $paragraph_text <b>paragraph</b><i> $text $alignement $formatting_command $formatting_command_formatted \$paragraph_number $format $item_number $enumerate_style $number</i> +<a name="IDX214"></a> +</dt> +<dd><p>This function formats a paragraph. <var>$text</var> is the text of the paragraph, +<var>$alignement</var> is the empty string when no alignement command has +been seen, otherwise it is the current alignement command name. +See section <a href="#SEC60">Commands used for centering and flushing of text</a>. +</p> +<p>The remaining arguments are usefull when the paragraph appears within a +list or table. It is usefull whenever the paragraph has to be formatted +differently when appearing in such environments. +Moreover in that case the format command (<code>@itemize</code>…) +may have +an associated formatting command. +<var>$formatting_command</var> is this formatting command +(like <code>@minus</code>). +<var>$formatting_command_formatted</var> is the command formatted in html +in case the formatting command is a leading command (like <code>@minus</code>) +which should be leading the first paragraph. +<var>\$paragraph_number</var> is a reference on the number of +paragraphs in that format command. The corresponding variable should be +increased when a paragraph is added. <var>$format</var> is the format command. +See section <a href="#SEC66">Formatting individual table and list items</a>. +</p> +<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of +the item in the list, <var>$enumerate_style</var> is the argument of the enumerate, +<var>$number</var> is the number or letter corresponding with this item. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $preformatted_text <b>preformatted</b><i> $text $style $region_name $formatting_command $formatting_command_formatted \$preformatted_number $format $item_number $enumerate_style $number</i> +<a name="IDX215"></a> +</dt> +<dd><p>This function formats a preformatted region. <var>$text</var> is the text of the +preformatted region, <var>$style</var> is the css style associated with that +preformatted region (See section <a href="#SEC34">Customizing the <code>texi2html</code> css lines</a>). <var>$region_name</var> is the +name of the command opening +the preformatted region (<code>example</code>…, see <a href="#SEC64">Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a>) +or a identifier for the preformatted context (for example +<code>menu-comment</code>, see <a href="#SEC73">Menu formatting</a>). +The alignment commands are not taken into account, as the spaces are +preserved in preformatted regions, you should flush and center by hand. +</p> +<p>The remaining arguments are usefull when the preformatted region appears +within a list or table. It is usefull whenever the preformatted region +has to be formatted +differently when appearing in such environments. +Moreover in that case the format command (<code>@itemize</code>…) +may have +an associated formatting command. +<var>$formatting_command</var> is this formatting command +(like <code>@minus</code>). +<var>$formatting_command_formatted</var> is the command formatted in html +in case the formatting command is a leading command (like <code>@minus</code>) +which should be leading the first preformatted region. +<var>\$preformatted_number</var> is a reference on the number of +preformatted regions in that format command. The corresponding variable +should be increased when a preformatted region is added. <var>$format</var> is the +format command. +See section <a href="#SEC66">Formatting individual table and list items</a>. +</p> +<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of +the item in the list, <var>$enumerate_style</var> is the argument of the enumerate, +<var>$number</var> is the number or letter corresponding with this item. +</p></dd></dl> + +<hr size="6"> +<a name="Avoiding-paragraphs"></a> +<a name="SEC63"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC62" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC64" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.9.2 Avoiding paragraphs in formats </h3> + + +<p>It is possible to avoid that a format closes the previous paragraph or +preformatted region and reopens one, by putting the format command in a +hash, <a name="IDX216"></a> +<code>%format_in_paragraph</code> with a true value. +</p> +<hr size="6"> +<a name="Complex-formats"></a> +<a name="SEC64"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC63" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC65" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…) </h2> + + +<p>Here we see how a whole complex format is formatted. For the formatting +of the text, see <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>. +</p> +<p>The formatting of the complex formats is ultimately controlled by a +function, however the default for this function uses a hash reference and +changing the hash reference values should be enough in most cases. This +hash reference is called <a name="IDX217"></a> +<code>$complex_format_map</code>. It has a key for each +of the complex format commands (<code>example</code>, <code>smallexample</code>, +<code>lisp</code>, <code>smalllisp</code>, <code>display</code>, <code>smalldisplay</code>, +<code>format</code>, <code>smallformat</code>). +</p> +<p>The associated value is also a reference on a hash. The keys are <code>begin</code> +and <code>end</code>. An eval of <code>begin</code> should lead to the beginning of the +formatted <acronym>HTML</acronym>, an eval of <code>end</code> should lead to the end of the +formatted <acronym>HTML</acronym>. The enclosed text will be formatted as described in +<a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>, and the name of the complex +format will be available to the function formatting the text. +</p> +<p>If you aren't satisfied with this scheme, you can redefine the following +function reference for a better control over the complex format formatting: +</p> +<dl> +<dt><u>Function Reference:</u> $complex_format_text <b>complex_format</b><i> $format_name $preformatted_text</i> +<a name="IDX218"></a> +</dt> +<dd><p><var>$format_name</var> is the complex format name, <var>$preformatted_text</var> is the +text allready formatted as described in <a href="#SEC61">Formatting or not a paragraph or a preformatted region</a>. +This function returns the whole complex format. +</p></dd></dl> + +<hr size="6"> +<a name="Lists-tables"></a> +<a name="SEC65"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC64" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC66" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.11 Customizing the formatting of lists and tables </h2> + +<p>The formatting of lists and tables is done at two levels: +</p><ul class="toc"> +<li> +At the level of the whole region (table or list), +</li><li> +At the level of the individual items, rows or cells of the list or table. +</li></ul> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Table-and-list-items"></a> +<a name="SEC66"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC65" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC67" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.11.1 Formatting individual table and list items </h3> + +<p>In texinfo it is possible to give <code>@itemize</code> or table command (hereafter +called a <em>format command</em>) a <em>formatting command</em>. +For example <code>@minus</code> is the formatting command here: +</p><table><tr><td> </td><td><pre class="example">@table @minus +</pre></td></tr></table> +<p>The default is to apply the command to the text item, however it is possible +to avoid it. +The hash <a name="IDX219"></a> +<code>%special_list_commands</code> has an entry for each of the +format command. Each of these entries is a hash reference. If a formatting +command is a key of the hash reference, then the formatting command is not +applied to the text item for that format command. For example, if we have: +</p> +<table><tr><td> </td><td><pre class="example">$special_list_commands{'itemize'} = { 'bullet' => '' }; +</pre></td></tr></table> +<p>and we have the following <code>@itemize</code>: +</p><table><tr><td> </td><td><pre class="example">@itemize @bullet +@item an item +@end itemize +</pre></td></tr></table> +<p>then <code>@bullet</code> will not be applied to <code>an item</code>. +</p> +<dl compact="compact"> +<dt> <em>lists</em></dt> +<dd><p>The items of lists are formatted using the following function reference: +</p><dl> +<dt><u>Function Reference:</u> $list_item <b>list_item</b><i> $text $format $command $formatted_command $item_number $enumerate_style $number</i> +<a name="IDX220"></a> +</dt> +<dd><p>This function formats the text between <code>@item</code> commands. <var>$text</var> +is the text corresponding with the item. <var>$format</var> is the type of format, +<samp>`itemize'</samp> or <samp>`enumerate'</samp>. <var>$command</var> is the formatting command +given in argument to <code>@itemize</code>, <var>$formatted_command</var> is this command +formatted if it is a leading command, like <code>@minus</code>. +</p> +<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the number of +the item in the list, <var>$enumerate_style</var> is the argument of the enumerate, +<var>$number</var> is the number or letter corresponding with this item. +</p></dd></dl> + +</dd> +<dt> <em>two column tables</em></dt> +<dd><p>The two columns tables (<code>@table</code>, <code>@ftable</code> and <code>@vtable</code>), +items are formatted using two function references, +one for the first line located on the <code>@item</code> line corresponding +with the first column, the other for the text appearing on the +following lines, corresponding with the second column text. +</p> +<dl> +<dt><u>Function Reference:</u> $table_item <b>table_item</b><i> $item_text $index_label_text $format $command $formatted_command</i> +<a name="IDX221"></a> +</dt> +<dd><p>This function is used to format the text on the <code>@item</code> line. +<var>$text_item</var> is the text line. In case there is an index entry +associated with the <code>@item</code> (as with <code>@ftable</code> and +<code>@vtable</code>), <var>$index_label_text</var> is the text inserted at +the place where an index entry appears. See section <a href="#SEC77">Formatting of index entries</a>. +<var>$format</var> is the type of format, +<samp>`table'</samp>, <samp>`ftable'</samp> or <samp>`vtable'</samp>. <var>$command</var> is the formatting command +given in argument to the table format command, <var>$formatted_command</var> is +this command formatted if it is a leading command, like <code>@minus</code>. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $table_line <b>table_line</b><i> $text</i> +<a name="IDX222"></a> +</dt> +<dd><p>This function is used to format the text on the lines following +the <code>@item</code> line. <var>$text</var> is the corresponding text. +</p></dd></dl> + +</dd> +<dt> <em>multitable</em></dt> +<dd><p>The multitable elements formatting is controlled by the functions associated +with two function references. One for a cell, and the other for a row. +</p> +<dl> +<dt><u>Function Reference:</u> $multitable_cell <b>cell</b><i> $text</i> +<a name="IDX223"></a> +</dt> +<dd><p>This function is used to format the text of a multitable cell, the text +following a <code>@item</code> or a <code>@tab</code>. +<var>$text</var> is the corresponding text. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $multitable_row <b>row</b><i> $text $item_command</i> +<a name="IDX224"></a> +</dt> +<dd><p>This function is used to format a multitable row. <var>$text</var> is +the row text, with cells allready formatted with the <a name="IDX225"></a> +<code>$cell</code> +function reference. <var>$item_command</var> is the command used to introduce +the row, such that it is possible to distinguish between <code>@item</code> and +<code>@headitem</code>. +</p></dd></dl> +</dd> +</dl> + +<hr size="6"> +<a name="Whole-table-list"></a> +<a name="SEC67"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC66" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC68" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.11.2 Formatting of a whole table or list </h3> + +<p>If the Texinfo command is a key of the <a name="IDX226"></a> +<code>%format_map</code>, the associated +value is used to specify the formatting of the construct, otherwise a function +is called. +The value in <code>%format_map</code> associated with a command is interpreted +similarly with values associated with more simpler commands: +</p> +<ul class="toc"> +<li> +If the text is a word, it is considered to be an <acronym>HTML</acronym> element +name, and the whole table or list is enclosed between the element opening +and the element closing. +</li><li> +If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +</li><li> +If the text is empty nothing is added to the text. +</li></ul> + +<p>In case the <code>%format_map</code> isn't used, a function reference called +<code>$table_list</code> +should be redefined, the associated function will be called each time +a command isn't found in <code>%format_map</code>. +</p> +<dl> +<dt><u>Function Reference:</u> $whole_table_list <b>table_list</b><i> $command $text</i> +<a name="IDX227"></a> +</dt> +<dd><p><var>$command</var> is the Texinfo command name, <var>$text</var> is the formatted +items. +</p></dd></dl> + +<p>If you still want to use <a name="IDX228"></a> +<code>%format_map</code> but differently from +the default, it is possible to redefine the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $whole_table_list <b>format</b><i> $command $format $text</i> +<a name="IDX229"></a> +</dt> +<dd><p><var>$command</var> is the @-command, <var>$format</var> is the entry associated with +<var>$command</var> in <code>%format_map</code>. <var>$text</var> is the formatted items. +</p></dd></dl> + +<hr size="6"> +<a name="Definitions"></a> +<a name="SEC68"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC67" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC69" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.12 Definition commands formatting </h2> + +<p>The formatting of definition commands is controlled by a hash and four +functions. The hash describes how the text on the definition line is +interpreted, the functions control the formatting of the definition line +and the definition function text. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC70">7.12.2 Customization of the definition formatting</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Definition-line"></a> +<a name="SEC69"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC68" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC70" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.12.1 Customizing the interpretation of a definition line </h3> + +<p>The keys of the hash <a name="IDX230"></a> +<code>%def_map</code> are definition command names. +There are two types of entries: +</p> +<ul class="toc"> +<li> If the command is a shortcut for +another definition command the value is a text and the definition +command is replaced by the text. + +<p>For example if we have: +</p><table><tr><td> </td><td><pre class="example">$def_map{'deftruc'} = '@defvr {A truc}'; +</pre></td></tr></table> +<p>and a line like +</p><table><tr><td> </td><td><pre class="example">@deftruc var +</pre></td></tr></table> +<p>the line will be transformed in +</p><table><tr><td> </td><td><pre class="example">@defvr {A truc} var +</pre></td></tr></table> +</li><li> +If the command isn't a shortcut, it is associated with an array +reference. The first element is <samp>`f'</samp>, <samp>`v'</samp> or <samp>`t'</samp> corresponding +with the index type (<samp>`f'</samp> for function, <samp>`v'</samp> for variable, +<samp>`t'</samp> for type). + +<p>The remaining of the array describes how to interpret the text following +the definition command on the definition command line. +The entry item specify what corresponds +with the next bracketed item or word. Currently the possibilities are +<samp>`category'</samp>, <samp>`name'</samp>, <samp>`type'</samp>, <samp>`class'</samp> and <samp>`arg'</samp>. +</p> +<p>For example if we have +</p><table><tr><td> </td><td><pre class="example">def_map{'defvr'} = [ 'v', 'category', 'name' ]; +</pre></td></tr></table> +<p>The first bracketed item following <code>@defvr</code> is considered +to be the category and the next one is the name. The index associated +with the definition line is the variables index. +</p></li></ul> + +<hr size="6"> +<a name="Definition-formatting"></a> +<a name="SEC70"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC69" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC71" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.12.2 Customization of the definition formatting </h3> + +<p>Four functions are used when formatting a definition command: +</p> +<dl compact="compact"> +<dt> category name</dt> +<dd><dl> +<dt><u>Function Reference:</u> $category <b>definition_category</b><i> $category_or_name $class $style</i> +<a name="IDX231"></a> +</dt> +<dd><p>This function precise a category or an index entry name associating a class +<var>$class</var> (if given) with <var>$category_or_name</var>. The <var>$style</var> of the +definition may be <samp>`f'</samp>, for function, <samp>`v'</samp>, for variable or <samp>`t'</samp>, +for type. +</p></dd></dl> +</dd> +<dt> formatting of the definition line</dt> +<dd><dl> +<dt><u>Function Reference:</u> $line <b>def_line</b><i> $category $name $type $arguments $index_label</i> +<a name="IDX232"></a> +</dt> +<dd><p>This function formats the definition line. <var>$category</var> is the category +formatted with <a name="IDX233"></a> +<code>$definition_category</code>, <var>$name</var>, <var>$type</var> and +<var>arguments</var> are the element of the definition line. <var>$index_label</var> is +the text inserted at the place where an index entry appears. +See section <a href="#SEC77">Formatting of index entries</a>. +</p></dd></dl> + +</dd> +<dt> definition text</dt> +<dd><dl> +<dt><u>Function Reference:</u> $definition_text <b>def_item</b><i> $text</i> +<a name="IDX234"></a> +</dt> +<dd><p>This function formats the definition text, <var>$text</var>. +</p></dd></dl> + +</dd> +<dt> the whole definition</dt> +<dd><dl> +<dt><u>Function Reference:</u> $definition <b>def</b><i> $text</i> +<a name="IDX235"></a> +</dt> +<dd><p>This function formats the whole definition. The definition line and text +formatted by the above functions are in <var>$text</var>. +</p></dd></dl> + +</dd> +</dl> + +<hr size="6"> +<a name="Headings"></a> +<a name="SEC71"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC70" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC72" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.13 Customizing headings formatting </h2> + +<p>A function controls the formatting of sectioning element headings, +with the corresponding function reference: +</p><dl> +<dt><u>Function Reference:</u> $heading_text <b>heading</b><i> \%element_reference</i> +<a name="IDX236"></a> +</dt> +<dd><p>The <var>\%element_reference</var> is a reference on a hash corresponding +with the sectioning element. The following keys are of interest: +</p><dl compact="compact"> +<dt> <code>text</code></dt> +<dd><p>The heading text +</p></dd> +<dt> <code>name</code></dt> +<dd><p>The heading text without section number +</p></dd> +<dt> <code>node</code></dt> +<dd><p>true if the sectioning element is a node without associated structuring command +</p></dd> +<dt> <code>level</code></dt> +<dd><p>The level of the element in the document tree. <samp>`0'</samp> is for <code>@top</code>, +<samp>`1'</samp> for <code>@chapter</code> and so on +</p></dd> +<dt> <code>tag_level</code></dt> +<dd><p>the sectioning element name, with <code>@raisesections</code> and +<code>@lowersections</code> taken into account +</p></dd> +</dl> +</dd></dl> + +<hr size="6"> +<a name="Special-regions"></a> +<a name="SEC72"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC71" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC73" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>) </h2> + +<p>Regions corresponding with raw text, like <code>@verbatim</code>, <code>@html</code> +or <code>@tex</code> are formatted according to the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $raw_region <b>raw</b><i> $command $text</i> +<a name="IDX237"></a> +</dt> +<dd><p><var>$command</var> is the command name, <var>$text</var> is the raw text. +</p></dd></dl> + +<p>If LaTeX2HTML is used, <code>@tex</code> regions are handled differently, +from within the main program. +</p> +<p>The <code>@cartouche</code> command formatting is controlled by the +function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $cartouche <b>cartouche</b><i> $text</i> +<a name="IDX238"></a> +</dt> +<dd><p><var>$text</var> is the text appearing within the cartouche. +</p></dd></dl> + +<p>The formatting of <code>@quotation</code> is controlled by two function references. +The first one is usefull in case the <code>@quotation</code> has an argument, as +it allows to prepend a string to the quotation text: +</p> +<dl> +<dt><u>Function Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $style $text</i> +<a name="IDX239"></a> +</dt> +<dd><p><var>$style</var> is the first argument of the <code>@quotation</code> if there are +two arguments. <var>$text</var> is the second argument or the first if there is +one argument. There are still @-commands in these strings. This function +can return a string which will be prepended to the quotation text. +</p></dd></dl> + +<p>The whole quotation is formatted by: +</p> +<dl> +<dt><u>Function Reference:</u> $quotation <b>quotation</b><i> $quotation_text $argument_text $argument_style_texi $argument_style_id</i> +<a name="IDX240"></a> +</dt> +<dd><p><var>$quotation_text</var> is the quotation text, formatted, with the text +prepended by the function above. <var>$argument_text</var> is the second argument +of the <code>@quotation</code> or the first if there is one argument, formatted. +The other arguments are defiend if there are two arguments for the +<code>@quotation</code>, <var>$argument_style_texi</var> is this argument, with +@-commands, and <var>$argument_style_id</var> is this argument transformed in +an identifier which can be used as an <acronym>XML</acronym> identifier. +</p></dd></dl> + + +<hr size="6"> +<a name="Menus"></a> +<a name="SEC73"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC72" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC74" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.15 Menu formatting </h2> + +<p>To understand how the formatting of menus is controlled, the different +parts of a menu are first described, then how to control the formatting +of each of these parts. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC74">7.15.1 The structure of a menu</a></td><td> </td><td align="left" valign="top"> A menu consists in menu entry and menu + comments +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Menu-parts"></a> +<a name="SEC74"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC73" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC75" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.15.1 The structure of a menu </h3> + +<p>In <code>texi2html</code>, a menu is considered to be composed of 2 parts, the +<em>menu entries</em> and the <em>menu comments</em>. Menu entries are further +divided in an <em>entry link</em> and optionnaly an <em>entry description</em>. +The entry link consists in a node name and an optionnal menu entry +name. +</p> +<p>A menu entry begins with <samp>`*'</samp> at the beginning of the line. It begins +with the entry link, followed by the description. The description spans until +the next menu entry, or some text begining at the first character of a line +or an empty line, not contained within a command block which begun in the +description. An empty line or a line with text at the first character +starts a menu comment, which spans until the next menu entry. +</p> +<p>Here is an illustration of these rules: +</p> +<table><tr><td> </td><td><pre class="example">@menu +* node name: entry name. description begins + description continues +* another menu entry:: + description begins + description continues + + A menu comment, after an empty line + +* node:: description begins +A menu comment. The line starts at the first character + +* last entry:: description begins <em>text +of the description, even if the line begins at the first character, +because we are in @emph</em>. +@end menu +</pre></td></tr></table> +<hr size="6"> +<a name="Menu-formatting"></a> +<a name="SEC75"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC74" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC76" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.15.2 The formatting of the different menu components </h3> + +<p>In the default case, the name of the section corresponding with the +node is used instead of the node name. If <a name="IDX241"></a> +<code>$NODE_NAME_IN_MENU</code> is +true, however, node names are used. If <a name="IDX242"></a> +<code>$AVOID_MENU_REDUNDANCY</code> +is true and menu entry equal menu description the description isn't printed. +This is the default. Likewise, if node or section name equal entry name, +do not print entry name. +</p> +<p>A symbol, <a name="IDX243"></a> +<code>$MENU_SYMBOL</code> is put at the beginning of menu entries +when the node name is used. The default is <samp>`&bull;'</samp>. +If <a name="IDX244"></a> +<code>$UNNUMBERED_SYMBOL_IN_MENU</code> is true it is +also put at the beginning of unnumbered section names. This is not +done by default. +</p> +<p>The menu comments are considered to be preformatted text. The style +associated with this preformatted text is determined by +<a name="IDX245"></a> +<code>$MENU_PRE_STYLE</code>. Default is <samp>`font-family: serif'</samp>. +The css class associated with menu comments is <code>menu-comments</code>. +</p> +<p>Three function references are associated with the formatting of the +different parts of a menu: +</p><dl> +<dt><u>Function Reference:</u> $link <b>menu_link</b><i> $section \%state $href $node $name $ending</i> +<a name="IDX246"></a> +</dt> +<dd><p><var>$section</var> is the section name corresponding with the link, <var>$href</var> +is the link hypertextual reference. <var>$href</var> may be absent. <var>\%state</var> +holds informations about the current context. The only key which could be +of interest is <code>preformatted</code>, true if the context is a preformatted +context. See section <a href="#SEC48">Three contexts for expansions: preformatted, normal and string</a>. +<var>$node</var> is the node name, <var>$name</var> is the +name of the node, and <var>$ending</var> is the text ending the link entry. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $description <b>menu_description</b><i> $description_text \%state</i> +<a name="IDX247"></a> +</dt> +<dd><p><var>$description_text</var> is the text of the menu description. <var>\%state</var> +should be used similarly than for the menu link. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $menu_comment <b>menu_comment</b><i> $text</i> +<a name="IDX248"></a> +</dt> +<dd><p><var>$text</var> is the text of the menu comment. It is in a preformatted +environment. +</p></dd></dl> + +<p>The following function reference controls the formatting of a wole menu: +</p> +<dl> +<dt><u>Function Reference:</u> $menu <b>menu</b><i> $menu_components_text</i> +<a name="IDX249"></a> +</dt> +<dd><p><var>$menu_components_text</var> is the formatted menu components text, obtained +as explained above. +</p></dd></dl> + +<p>The last function reference corresponds with a special case. It +is used when a menu entry appears within another block command, to +avoid the possibilities of invalid <acronym>HTML</acronym> production. +In that case the menu description and menu comments are not formatted +specially, but treated like normal text. +</p><dl> +<dt><u>Function Reference:</u> $link <b>simple_menu_link</b><i> $link_text $href $node $name $ending</i> +<a name="IDX250"></a> +</dt> +<dd><p><var>$link_text</var> is the text corresponding with the link name, <var>$href</var> +is the link hypertextual reference. +<var>$node</var> is the node name, <var>$name</var> is the +name of the node, and <var>$ending</var> is the text ending the link entry. +</p></dd></dl> + +<hr size="6"> +<a name="Indices"></a> +<a name="SEC76"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC75" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC77" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.16 Indices formatting </h2> + +<p>Two different things needs to be handled for indices formatting, the place +where the index term appears, the index entry, and the index list itself. +The indexing commands like <code>@cindex</code> determines where index entries +appear, and the index list is printed with a <code>@printindex</code> command. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC77">7.16.1 Formatting of index entries</a></td><td> </td><td align="left" valign="top"> Index entries in the main document are + targets for hypertext references +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC78">7.16.2 Customizing the formatting of index lists</a></td><td> </td><td align="left" valign="top"> Customizing the formatting of the index list +</td></tr> +</table> + +<hr size="6"> +<a name="Index-entry-place"></a> +<a name="SEC77"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC76" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC78" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.16.1 Formatting of index entries </h3> + +<p>Index entry places in the main text may be the target for hypertext +references. Their formatting +is controlled by the function associated with the following function +reference: +</p> +<dl> +<dt><u>Function Reference:</u> $target <b>index_entry_label</b><i> $identifier $preformatted</i> +<a name="IDX251"></a> +</dt> +<dd><p><var>$identifier</var> should be used to create +a target for links (typically associated with a name or id +attribute in <acronym>HTML</acronym>). +<var>$preformatted</var> is true if the index entry appeared in preformatted text. +</p></dd></dl> + +<hr size="6"> +<a name="Index-list"></a> +<a name="SEC78"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC77" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC79" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.16.2 Customizing the formatting of index lists </h3> + +<p>The index entries are sorted alphabetically. A whole index list is +considered to be composed of letter entries. A letter entry is composed +by all the index entries beginning with that letter. A letter may +be a non alphabetical character, but we call it letter here. +</p> +<p>An index summary appears at the beginning and at the end of an index list, +and should be used to jump directly to a letter entry. Indices lists +may be split across pages, thus the different letters may appear on different +files. The number of index entries appearing on each page is determined +by a variable <a name="IDX252"></a> +<code>$SPLIT_INDEX</code> if set. The default is to split +indices after 100 entries. +</p> +<p>The formatting of all these elements is controlled by the following +function references: +</p> +<dl compact="compact"> +<dt> <em>formatting of a letter in a summary</em></dt> +<dd><dl> +<dt><u>Function Reference:</u> $letter <b>summary_letter</b><i> $letter $file $identifier</i> +<a name="IDX253"></a> +</dt> +<dd><p>This function is used to format a letter appearing in a summary, refering +to a letter entry in the index list. +<var>$letter</var> is the letter. <var>$file</var> is the file name where the letter +entry appears. More precisely, it is empty when the letter entry is on the +same page than the summary, it contains the file name when the index page +is split accross page. <var>$identifier</var> is an identifier for the target +letter entry. +</p></dd></dl> + +</dd> +<dt> <em>formatting of a summary</em></dt> +<dd><dl> +<dt><u>Function Reference:</u> $summary <b>index_summary</b><i> \@alphabetical_letters \@nonalphabetical_letters</i> +<a name="IDX254"></a> +</dt> +<dd><p><var>\@alphabetical_letters</var> and <var>\@nonalphabetical_letters</var> contain the +formatted summary letters, formatted with the above function. +</p></dd></dl> + +</dd> +<dt> <em>formatting of an index entry</em></dt> +<dd><dl> +<dt><u>Function Reference:</u> $entry <b>index_entry</b><i> $entry_href $entry_text $section_href $section_heading</i> +<a name="IDX255"></a> +</dt> +<dd><p><var>$entry_href</var> is a reference to the place where the index entry +appeared, <var>$entry_text</var> is the corresponding text. <var>$section_href</var> +is a reference to the beginning of the sectioning element containing +the index entry, <var>$section_heading</var> is the heading of the element. +</p></dd></dl> + +</dd> +<dt> <em>formatting of letter entry</em></dt> +<dd><dl> +<dt><u>Function Reference:</u> $letter_entry <b>index_letter</b><i> $letter $identifier $index_entries_text</i> +<a name="IDX256"></a> +</dt> +<dd><p>This function formats a letter entry, consisting in all the index entries +beginning with this letter. <var>$letter</var> is the letter, <var>$identifier</var> +should be used to create a target for links (typically links from summaries), +and <var>$index_entries_text</var> is the text of the index entries formatted as +described above. +</p></dd></dl> + +</dd> +<dt> <em>formatting of whole index</em></dt> +<dd><dl> +<dt><u>Function Reference:</u> $index <b>print_index</b><i> $index_text $index_name</i> +<a name="IDX257"></a> +</dt> +<dd><p><var>$index_text</var> is the text of all the index entries grouped by letter +appearing in that page formatted as above. <var>index_name</var> is the name of +the index, the argument of <code>@printindex</code>. +</p></dd></dl> +</dd> +</dl> + +<hr size="6"> +<a name="Floats-and-lists-of-floats"></a> +<a name="SEC79"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC78" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC80" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.17 Floats and lists of floats </h2> + +<p>Floats appear in the <code>@float</code> environment, optionaly with a style +and a label, and with optionnal <code>@caption</code> and <code>@shortcaption</code>. +Their list appear after a <code>@listoffloats</code>. +</p> +<p>A hash reference is associated with each float, it is available in some +formatting functions. The keys are: +</p><dl compact="compact"> +<dt> <code>caption_texi</code></dt> +<dt> <code>shortcaption_texi</code></dt> +<dd><p>A reference on an array containing the caption or shortcaption lines, +unformatted. +</p></dd> +<dt> <code>style_texi</code></dt> +<dd><p>The style with texi @-commands. +</p></dd> +<dt> <code>style_id</code></dt> +<dd><p>The unique identifier associated with the style. +</p></dd> +<dt> <code>nr</code></dt> +<dd><p>The number with the same conventions than makeinfo (use the chapter number a +dot and then the number of the float of that style in the chapter, or an +absolute number if in unnumbered). +</p></dd> +<dt> <code>chapter_nr</code></dt> +<dd><p>The number of the chapter containing the float. +</p></dd> +<dt> <code>nr_in_chapter</code></dt> +<dd><p>The number of the float in the chapter. +</p></dd> +<dt> <code>absolut_nr</code></dt> +<dd><p>The number of the float in the document. +</p></dd> +<dt> <code>texi</code></dt> +<dd><p>The label with @-commands. +</p></dd> +<dt> <code>id</code></dt> +<dd><p>The unique identifier associated with the label. Usefull to make an anchor +or a reference. +</p></dd> +<dt> <code>element</code></dt> +<dd><p>A reference on a structure representing the element the float appear in. +</p></dd> +</dl> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC80">7.17.1 Formatting a float</a></td><td> </td><td align="left" valign="top"> Formatting of floats +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC81">7.17.2 Formatting lists of floats</a></td><td> </td><td align="left" valign="top"> Formatting the lists of floats +</td></tr> +</table> + +<hr size="6"> +<a name="Floats"></a> +<a name="SEC80"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC79" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC81" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.17.1 Formatting a float </h3> + +<p>First there is an occasion to construct a texinfo text for the caption, using +the caption texinfo lines and the informations in the float structure. +The returned lines will be formatted in the main program. A function reference +is used here: +</p> +<dl> +<dt><u>Function Reference:</u> (\@caption_lines_returned, \@shortcaption_lines_returned) <b>caption_shortcaption</b><i> \%float \@caption_lines \@shortcaption_lines</i> +<a name="IDX258"></a> +</dt> +<dd><p><var>\%float</var> is the structure defined above. <var>\@caption_lines</var> and +<var>\@shortcaption_lines</var> are references on arrays containing the +texinfo lines for caption and short caption. <var>\@caption_lines_returned</var> +and <var>\@shortcaption_lines_returned</var> are references on an array +containing the texinfo lines for the caption and shortcaption. +</p></dd></dl> + +<p>Then the float is formatted with the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $text <b>float</b><i> $float_text \%float $caption_text $shortcaption_text</i> +<a name="IDX259"></a> +</dt> +<dd><p><var>$float_text</var> is the text appearing within the <code>@float</code>, formatted. +<var>\%float</var> is still the structure defined above. <var>$caption_text</var> and +<var>$shortcaption_text</var> are the caption and short caption build with the +above function and formatted. +</p></dd></dl> + +<hr size="6"> +<a name="Lists-of-floats"></a> +<a name="SEC81"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC80" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC82" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h3 class="subsection"> 7.17.2 Formatting lists of floats </h3> + +<p>A list of floats is introduced by <code>@listoffloats</code>. The argument of +<code>@listoffloats</code> is the <em>style</em>. First the style texinfo can be +modified with the following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> $style_texi_returned <b>listoffloats_style</b><i> $style_texi</i> +<a name="IDX260"></a> +</dt> +<dd><p><var>$style_texi</var> is the <code>@listoffloats</code> argument with texinfo +@-commands kept. It is possible to make changes to the <var>$style_texi</var> and +return a modified string, still with @-commands. The modified string +is formatted in the main program. +</p></dd></dl> + +<p>After that, for each of the floats with that style, first there is a +possibility to modify the float style and the float caption before they +are formatted in the main program, with the following function references: +</p> +<dl> +<dt><u>Function Reference:</u> $float_style_texi_returned <b>listoffloats_float_style</b><i> $style_texi \%float</i> +<a name="IDX261"></a> +</dt> +<dd><p><var>$style_texi</var> is the style, and <var>\%float</var> is the structure described +above. This function reference returns a style to be formatted in the +main program. +</p></dd></dl> + +<dl> +<dt><u>Function Reference:</u> $caption_texi_returned <b>listoffloats_caption</b><i> \%float</i> +<a name="IDX262"></a> +</dt> +<dd><p><var>\%float</var> is the structure described +above. This function reference returns a caption to be formatted in the +main program. +</p></dd></dl> + +<p>Each entry is formatted by: +</p> +<dl> +<dt><u>Function Reference:</u> $listoffloats_entry <b>listoffloats_entry</b><i> $style_texi \%float $float_style $caption $href</i> +<a name="IDX263"></a> +</dt> +<dd><p><var>$style_texi</var> is the style with @-commands, <var>$float_style</var> is the +style returned by the above function and formatted. <var>$caption</var> is the +caption returned by the above function formatted. <var>\%float</var> is the +structure corresponding with the float, and <var>$href</var> is an href pointing to +the float location. +</p></dd></dl> + +<p>Lastly, the whole <code>@listoffloats</code> is formatted by: +</p> +<dl> +<dt><u>Function Reference:</u> $listoffloats <b>listoffloats</b><i> $style_texi $style \@listoffloats_entries</i> +<a name="IDX264"></a> +</dt> +<dd><p><var>$style_texi</var> is the style with @-commands, <var>$style</var> is the +style returned by the above function and formatted. The array reference +<var>\@listoffloats_entries</var> holds the entries formatted by the above +function. +</p></dd></dl> + +<hr size="6"> +<a name="Footnotes"></a> +<a name="SEC82"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC81" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC83" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.18 Customizing the footnotes formatting </h2> + +<p>Each footnote is associated with a footnote entry. Several footnote entries +are grouped in a footnote section. When a footnote appears, two things must +be formatted: in the main text the place where the footnote appear +and the footnote text. +</p> +<p>Two functions, with corresponding function references control the formatting +of the footnotes: +</p> +<dl> +<dt><u>Function Reference:</u> (\@lines $text_for_document) <b>foot_line_and_ref</b><i> $number_in_doc $number_in_page $footnote_id $place_id $document_file $footnote_file \@lines \%state</i> +<a name="IDX265"></a> +</dt> +<dd><p><var>$number_in_doc</var> is the footnote number in the whole document, +<var>$number_in_page</var> is the footnote number in the current page. +<var>$footnote_id</var> is an identifier for the footnote in the footnote text +which should be used to make target for references to that footnote, +while <var>$place_id</var> is an identifier for the location of the footnote +in the main document. Similarly, <var>$document_file</var> is the file name +of the file containing the text where the footnote appears in the main +document, while <var>$footnote_file</var> is the file name of the file where +the footnote text appears. +</p> +<p><var>\@lines</var> is a reference on an array containing the footnote text +lines, allready formatted. +And <var>\%state</var> holds informations about the context at the footnote +place in the main document. As usual the most usefull entry is +<code>preformatted</code> which is true if the footnote appears in a preformatted +context. +</p> +<p>This function returns a reference on an array, <var>\@lines</var> containing +the updated footnote text for the footnote entry, and <var>$text_for_document</var>, +the text appearing at the footnote place in the main document, linking +to the footnote entry. +</p></dd></dl> + +<p>The following function is only used when footnotes are at the bottom +of a page and the document is split. +For customization of the footnotes page in case they are on a separated +page or section, <a href="#SEC44">Customizing the layout of the special pages</a>. For +the determination of the footnote locations, <a href="#SEC10">Page layout related command line options</a>. +</p> +<dl> +<dt><u>Function Reference:</u> <b>foot_section</b><i> \@footnotes_lines</i> +<a name="IDX266"></a> +</dt> +<dd><p>This function formats a group of footnotes. <var>\@footnotes_lines</var> is a +reference on an array holding the lines of all the footnote entries +formatted as explained above. This function modifies the reference. +</p></dd></dl> + + +<hr size="6"> +<a name="Other-and-unknown-commands"></a> +<a name="SEC83"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC82" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="section"> 7.19 Customizing other commands, and unknown commands </h2> + + + +<p>Many commands without braces are available in texinfo, sometimes with +a specific syntax. For example we have <code>@sp</code>, <code>@noindent</code>, +<code>@documentlanguage</code>, <code>@oddheading</code>, <code>@headings</code>, +<code>@shortcontents</code>, <code>@shorttitlepage</code> or <code>@comment</code>. +<code>texi2html</code> interprets +some of these commands and some functions or variables are used for +their formatting or to access their information. +In the default case, however, most of these constructs are ignored. +</p> +<p>It is possible to change how the things following these commands +on the line are handled, what is considered to be an arg for those +commands and it is also possible to keep them instead of discarding +them such that it is possible to handle them specially, with the +same function than the one used for unknown commands. +</p> +<p>Those special commands without braces are the key of a hash: +<a name="IDX267"></a> +<code>%misc_command</code>. The associated value is a reference on a +hash enabling to set the properties of these commands. The +keys of this hash reference is the name of a property, the value +is the value of the property. For example here we have <code>line</code> +for the <code>arg</code> property for the <code>command</code> @-command. +</p> +<table><tr><td> </td><td><pre class="example">$misc_command{'command'} = {'arg' => 'line', 'skip' => 'space'}; +</pre></td></tr></table> +<p>The properties and possible values are: +</p> +<dl compact="compact"> +<dt> <code>skip</code></dt> +<dd><p>This property enables to set what is skipped after the command arguments. +Here are the possible values: +</p><dl compact="compact"> +<dt> <code>line</code></dt> +<dd><p>The remaining of the line is skipped. +</p></dd> +<dt> <code>space</code> </dt> +<dd><p>Spaces are skipped but not newline. +</p></dd> +<dt> <code>whitespace</code> </dt> +<dd><p>Spaces are skipped +</p></dd> +<dt> <code>linewhitespace</code></dt> +<dd><p>Spaces are skipped if there are only spaces remaining on the line. +</p></dd> +<dt> <code>linespace</code></dt> +<dd><p>Spaces are skipped, but not newline if +there are only spaces remaining on the line +</p></dd> +</dl> + +</dd> +<dt> <code>arg</code></dt> +<dd><p>If the associated value is <code>line</code> the line is considered to be the +argument. If it is a number it is the number of args (separated by spaces). +</p></dd> +<dt> <code>texi</code></dt> +<dd><p>If true the arguments are considered to real texinfo, therefore + <code>@value</code> and <code>@macro</code> are expanded. +</p></dd> +<dt> <code>keep</code></dt> +<dd><p>If true the args and the macro are kept, otherwise they are discarded. +The defaut is to have <code>keep</code> undef for all the commands. +If <code>keep</code> is true for <code>@verbatiminclude</code> the default +action for this macro isn't done. +</p></dd> +</dl> + + +<p>Commands which don't appear in the hashes +<a name="IDX268"></a> +<code>%simple_map</code>, <a name="IDX269"></a> +<code>%simple_map_pre</code>, +<a name="IDX270"></a> +<code>%simple_map_texi</code> and <code>%misc_command</code>, or that appear in +<code>%misc_command</code> but with <code>keep</code> true are processed by the +following function reference: +</p> +<dl> +<dt><u>Function Reference:</u> ($result_line, $result, $result_text, $message) <b>unknown</b><i> $command $line</i> +<a name="IDX271"></a> +</dt> +<dd><p><var>$command</var> is the @-command, <var>$line</var> is the line following the +<var>$command</var>. <var>$result</var> is a boolean. If it is true then the other return +values are taken into account otherwise the default actions are +used. In case <var>$result</var> is true, <var>$result_line</var> is the new line +to be processed further, <var>$result_text</var> is the resulting formatted text +and <var>$message</var>, if defined is a message outputted to the output +with line number added by <code>texi2html</code>. +</p></dd></dl> + +<p>Commands with braces not specified above +nor in <a name="IDX272"></a> +<code>%style_map</code>, <a name="IDX273"></a> +<code>%style_map_pre</code> and +<a name="IDX274"></a> +<code>%style_map_texi</code> are processed +by the following function reference +</p> +<dl> +<dt><u>Function Reference:</u> ($result, $result_text, $message) <b>unknown_style</b><i> $command $text</i> +<a name="IDX275"></a> +</dt> +<dd><p><var>$command</var> is the @-command, <var>$text</var> is the text appearing within +the braces (allready formatted). <var>$result</var> is a boolean. If it is true then +the other return +values are taken into account otherwise the default actions are +used. In case <var>$result</var> is true, <var>$result_text</var> is the resulting +formatted text +and <var>$message</var>, if defined is a message outputted to the output +with line number added by <code>texi2html</code>. +</p></dd></dl> + + + +<hr size="6"> +<a name="Internationalization"></a> +<a name="SEC84"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC83" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC85" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="appendix"> A. Internationalization </h1> + +<p>The strings written in the document are selected based on the +document language. This can be used to customize the strings, +as described in <a href="#SEC56">Customizing strings written by <code>texi2html</code></a>. This also enables translation of the +strings. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="#SEC85">A.1 Translating strings</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + +<hr size="6"> +<a name="Translating-strings"></a> +<a name="SEC85"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC84" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC86" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="appendixsec"> A.1 Translating strings </h2> + + +<p>If the language is allready supported, then there will be a file +in the <tt>`i18n'</tt> directory with name the two-letter +ISO-639 language code. In that case you can enhance the translations by +editing this file. There is a <code>$LANGUAGES->{'<var>language</var>'}</code> +hash in that file. The keys are the english strings, in <code>''</code>, the +values (in <code>''</code> after <code>=></code>) are the translations. +When a string contains a <samp>`%'</samp> followed by <samp>`{'</samp> <var>name</var> <samp>`}'</samp> +it means that the string will be expanded by <code>texi2html</code>. For +an example, see <a href="#SEC56">Customizing strings written by <code>texi2html</code></a>. +</p> +<p>After that you should run the command <code>./manage_i18n.pl all</code> in +the top directory, it should merge your file with the existing files in +<tt>`translations.pl'</tt>, which is incorporated to the <tt>`texi2html'</tt> script +by <code>./configure</code>. +</p> +<p>If the language isn't currently supported, copy the <tt>`en'</tt> file in +<tt>`i18n'</tt> to a file with name the two-letter ISO-639 +language code of your language + and then add your translations to the strings. You could also add your +two-letter language code in the <tt>`manage_i18n.pl'</tt> file in the +<code>@known_languages</code> array. +</p> +<p>After that you should similarly run the command +<code>./manage_i18n.pl all</code> in +the top directory. +</p> +<p>Obsoleted strings are not removed from the files, they are still present +in the <code>$T2H_OBSOLETE_STRINGS->{'<var>language</var>'}</code> hash in case +the string is reused later. +</p> +<p>If you made change to strings specified in installed files +(see section <a href="#SEC4">Installation of <code>texi2html</code></a>) +you will have to reinstall them otherwise the installated files will +take precedence (see section <a href="#SEC13">Use initialization files for fine tuning</a>). +</p> +<hr size="6"> +<a name="Adding-new-strings"></a> +<a name="SEC86"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC85" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h2 class="appendixsec"> A.2 Adding new strings written to document </h2> + + +<p>If you need to write strings, for example the new string <var>a string</var> +to the resulting document, call <code>&$I('a string')</code>. Use simple quotes. +If you want to substitute a value in the string put +<code>%{<var>string_value</var>}</code>, in the string, and give a second argument +to <code>&$I</code>, a hash reference with key <var>string_value</var> and value +the what you want to substitute. +Here is an example: +</p> +<table><tr><td> </td><td><pre class="example">return &$I('%{name} of %{class}', { 'name' => $name, 'class' => $class }); +</pre></td></tr></table> +<p>In that case <code>%{name}</code> is substituted by <code>$name</code> in the translated +string. +</p> +<p>After that you should run the command <code>./manage_i18n.pl all</code> in the top +directory, it should add your new strings to all the files in the <tt>`i18n'</tt> +directory. +</p> +<hr size="6"> +<a name="Indexop"></a> +<a name="SEC87"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC86" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC88" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC88" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="appendix"> B. Command Line Option Index </h1> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a> + +<a href="#SEC87_1" class="summary-letter"><b>D</b></a> + +<a href="#SEC87_2" class="summary-letter"><b>F</b></a> + +<a href="#SEC87_3" class="summary-letter"><b>H</b></a> + +<a href="#SEC87_4" class="summary-letter"><b>I</b></a> + +<a href="#SEC87_5" class="summary-letter"><b>L</b></a> + +<a href="#SEC87_6" class="summary-letter"><b>M</b></a> + +<a href="#SEC87_7" class="summary-letter"><b>N</b></a> + +<a href="#SEC87_8" class="summary-letter"><b>O</b></a> + +<a href="#SEC87_9" class="summary-letter"><b>P</b></a> + +<a href="#SEC87_10" class="summary-letter"><b>S</b></a> + +<a href="#SEC87_11" class="summary-letter"><b>T</b></a> + +<a href="#SEC87_12" class="summary-letter"><b>U</b></a> + +</td></tr></table> +<table border="0" class="index-op"> +<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_0">C</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX49">css-include=<var>file</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_1">D</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX53">def-table</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX42">doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX30">D<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_2">F</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX36">frames</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX44">frameset-doctype</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX43">frameset-doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_3">H</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX51">html-xref-prefix=<var>path</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_4">I</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX34">I<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX23">if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX121">include-css</a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX69">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX70">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX47">iso</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_5">L</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX61">l2h</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX66">l2h-file</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX62">l2h-l2h=<var>program</var></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX64">l2h-tmp</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX72">lang</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX206">lang</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX28">lang=<var>lang</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_6">M</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX3">menu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_7">N</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX24">no-if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX21">node-files</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX2">nomenu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX26">nomenu</a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX38">nosec-nav</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX57">number</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_8">O</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX10">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX12">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_9">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX32">P<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX1">pkgdatadir=<var>dir</var></a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX67">pkgdatadir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX13">prefix</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_10">S</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX40">separated-footnotes</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX15">short-ext</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX55">short-ref</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX4">split</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX68">sysconfdir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_11">T</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX19">toc-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX59">toc-links</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX17">top-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC87_12">U</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX6">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX8">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX9">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX31">U<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a> + +<a href="#SEC87_1" class="summary-letter"><b>D</b></a> + +<a href="#SEC87_2" class="summary-letter"><b>F</b></a> + +<a href="#SEC87_3" class="summary-letter"><b>H</b></a> + +<a href="#SEC87_4" class="summary-letter"><b>I</b></a> + +<a href="#SEC87_5" class="summary-letter"><b>L</b></a> + +<a href="#SEC87_6" class="summary-letter"><b>M</b></a> + +<a href="#SEC87_7" class="summary-letter"><b>N</b></a> + +<a href="#SEC87_8" class="summary-letter"><b>O</b></a> + +<a href="#SEC87_9" class="summary-letter"><b>P</b></a> + +<a href="#SEC87_10" class="summary-letter"><b>S</b></a> + +<a href="#SEC87_11" class="summary-letter"><b>T</b></a> + +<a href="#SEC87_12" class="summary-letter"><b>U</b></a> + +</td></tr></table> +<hr size="6"> +<a name="Indexvr"></a> +<a name="SEC88"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC87" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC89" title="Next section in reading order"> > </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC87" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC89" title="Next chapter"> >> </a>]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="appendix"> C. Variable Index </h1> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC88_0" class="summary-letter"><b>$</b></a> + +<a href="#SEC88_1" class="summary-letter"><b>%</b></a> + +<a href="#SEC88_2" class="summary-letter"><b>@</b></a> +</td></tr></table> +<table border="0" class="index-vr"> +<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC88_0">$</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX123"><code>$AFTER_BODY_OPEN</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX153"><code>$AFTER_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX155"><code>$AFTER_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX73"><code>$anchor</code></a></td><td valign="top"><a href="#SEC15">5.1 Redefining functions in initialization files</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX198"><code>$anchor</code></a></td><td valign="top"><a href="#SEC54">7.4 Formatting of special simple commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX242"><code>$AVOID_MENU_REDUNDANCY</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX152"><code>$BEFORE_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX154"><code>$BEFORE_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX78"><code>$BIG_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX111"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX127"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX225"><code>$cell</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX194"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX196"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX217"><code>$complex_format_map</code></a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX116"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX118"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX120"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX54"><code>$DEF_TABLE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX76"><code>$DEFAULT_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX233"><code>$definition_category</code></a></td><td valign="top"><a href="#SEC70">7.12.2 Customization of the definition formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX150"><code>$DO_CONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX151"><code>$DO_SCONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX45"><code>$DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX126"><code>$DOCUMENT_DESCRIPTION</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX124"><code>$DOCUMENT_ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX125"><code>$ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX175"><code>$EXTENSION</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX52"><code>$EXTERNAL_DIR</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX122"><code>$EXTRA_HEAD</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX37"><code>$FRAMES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX46"><code>$FRAMESET_DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX82"><code>$ICONS</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX179"><code>$IDX_SUMMARY</code></a></td><td valign="top"><a href="#SEC46">6.13 Generation of external files for index entries</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX80"><code>$INDEX_CHAPTER</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX63"><code>$L2H_L2H</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX65"><code>$L2H_TMP</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX29"><code>$LANG</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX71"><code>$LANG</code></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX207"><code>$LANG</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX208"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC85"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX245"><code>$MENU_PRE_STYLE</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX243"><code>$MENU_SYMBOL</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX77"><code>$MIDDLE_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX22"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX176"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX241"><code>$NODE_NAME_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX58"><code>$NUMBER_SECTIONS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX193"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX195"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX11"><code>$OUT</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX138"><code>$PRE_BODY_CLOSE</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX14"><code>$PREFIX</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX141"><code>$print_chapter_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX131"><code>$print_chapter_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX139"><code>$print_foot_navigation</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX128"><code>$print_head_navigation</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX172"><code>$print_misc</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX174"><code>$print_misc_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX173"><code>$print_misc_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX143"><code>$print_page_foot</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX130"><code>$print_page_head</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX142"><code>$print_section_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX132"><code>$print_section_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX169"><code>$print_Top</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX171"><code>$print_Top_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX170"><code>$print_Top_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX39"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX83"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX41"><code>$SEPARATED_FOOTNOTES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX56"><code>$SHORT_REF</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX16"><code>$SHORTEXTN</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX27"><code>$SHOW_MENU</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX75"><code>$SMALL_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX5"><code>$SPLIT</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX252"><code>$SPLIT_INDEX</code></a></td><td valign="top"><a href="#SEC78">7.16.2 Customizing the formatting of index lists</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC85"><code>$T2H_OBSOLETE_STRINGS</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX91"><code>$Texi2HTML::NODE{Next}</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX105"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX160"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX104"><code>$Texi2HTML::THIS_HEADER</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX103"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX108"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX106"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX159"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX20"><code>$TOC_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX60"><code>$TOC_LINKS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX157"><code>$TOC_LIST_ATTRIBUTE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX156"><code>$TOC_LIST_STYLE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX18"><code>$TOP_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX79"><code>$TOP_HEADING</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX244"><code>$UNNUMBERED_SYMBOL_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX48"><code>$USE_ISO</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX7"><code>$USE_NODES</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX81"><code>$VERTICAL_HEAD_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX87"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX88"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX109"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC88_1">%</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX192"><code>%accent_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX93"><code>%ACTIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX113"><code>%BUTTONS_GOTO</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX115"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX117"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX230"><code>%def_map</code></a></td><td valign="top"><a href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX216"><code>%format_in_paragraph</code></a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX226"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX228"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX101"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX102"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX267"><code>%misc_command</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX92"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX112"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX212"><code>%paragraph_style</code></a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX94"><code>%PASSIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX187"><code>%pre_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX183"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX268"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX184"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX269"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX185"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX270"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX219"><code>%special_list_commands</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX189"><code>%style_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX272"><code>%style_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX190"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX273"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX191"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX274"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX97"><code>%Texi2HTML::HREF</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX96"><code>%Texi2HTML::NAME</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX99"><code>%Texi2HTML::NO_TEXI</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX98"><code>%Texi2HTML::NODE</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX100"><code>%Texi2HTML::THISDOC</code></a></td><td valign="top"><a href="#SEC28">Global strings</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX188"><code>%texi_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX186"><code>%things_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC88_2">@</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#IDX89"><code>@CHAPTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX50"><code>@CSS_FILES</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX25"><code>@EXPAND</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX35"><code>@INCLUDE_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX90"><code>@MISC_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX86"><code>@NODE_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX33"><code>@PREPEND_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX84"><code>@SECTION_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#IDX85"><code>@SECTION_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC88_0" class="summary-letter"><b>$</b></a> + +<a href="#SEC88_1" class="summary-letter"><b>%</b></a> + +<a href="#SEC88_2" class="summary-letter"><b>@</b></a> +</td></tr></table> +<hr size="6"> +<a name="Indexcp"></a> +<a name="SEC89"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC88" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[ > ]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC88" title="Beginning of this chapter or previous chapter"> << </a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[ >> ]</td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left"> </td> +<td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1 class="appendix"> D. Concept Index </h1> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC89_0" class="summary-letter"><b>A</b></a> + +<a href="#SEC89_1" class="summary-letter"><b>B</b></a> + +<a href="#SEC89_2" class="summary-letter"><b>C</b></a> + +<a href="#SEC89_3" class="summary-letter"><b>D</b></a> + +<a href="#SEC89_4" class="summary-letter"><b>E</b></a> + +<a href="#SEC89_5" class="summary-letter"><b>F</b></a> + +<a href="#SEC89_6" class="summary-letter"><b>I</b></a> + +<a href="#SEC89_7" class="summary-letter"><b>M</b></a> + +<a href="#SEC89_8" class="summary-letter"><b>P</b></a> + +<a href="#SEC89_9" class="summary-letter"><b>R</b></a> + +<a href="#SEC89_10" class="summary-letter"><b>S</b></a> + +<a href="#SEC89_11" class="summary-letter"><b>T</b></a> + +<a href="#SEC89_12" class="summary-letter"><b>U</b></a> + +</td></tr></table> +<table border="0" class="index-cp"> +<tr><td></td><th align="left">Index Entry</th><th align="left"> Section</th></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_0">A</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC63">Avoid paragraph opening</a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_1">B</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC_Top">bug report</a></td><td valign="top"><a href="#SEC_Top">Texi2HTML</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_2">C</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC60">centering</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC64">complex format</a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC13"><tt>`Config'</tt></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC4">configure</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_3">D</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC3">downloading <code>texi2html</code> source</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_4">E</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC1">examples of manuals</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC58">external manual</a></td><td valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_5">F</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC60">flushing text</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_6">I</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC56">i18n</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC85">i18n</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC4">Installation</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC13">internationalization</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC86">internationalized strings</a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_7">M</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC2">makeinfo</a></td><td valign="top"><a href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC86"><code>manage_i18n.pl</code></a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_8">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC62">paragraph</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC62">preformatted region</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_9">R</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC57">reference</a></td><td valign="top"><a href="#SEC57">7.7 References</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_10">S</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC83">skipped command</a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC3">source code for <code>texi2html</code>, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_11">T</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC3"><code>texi2html</code> source, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC1">Texinfo</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC60">text alignement</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> +<tr><td></td><td valign="top"><a href="#SEC85">Translation</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +<tr><th><a name="SEC89_12">U</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#SEC83">unknown command</a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> +<tr><td colspan="3"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a href="#SEC89_0" class="summary-letter"><b>A</b></a> + +<a href="#SEC89_1" class="summary-letter"><b>B</b></a> + +<a href="#SEC89_2" class="summary-letter"><b>C</b></a> + +<a href="#SEC89_3" class="summary-letter"><b>D</b></a> + +<a href="#SEC89_4" class="summary-letter"><b>E</b></a> + +<a href="#SEC89_5" class="summary-letter"><b>F</b></a> + +<a href="#SEC89_6" class="summary-letter"><b>I</b></a> + +<a href="#SEC89_7" class="summary-letter"><b>M</b></a> + +<a href="#SEC89_8" class="summary-letter"><b>P</b></a> + +<a href="#SEC89_9" class="summary-letter"><b>R</b></a> + +<a href="#SEC89_10" class="summary-letter"><b>S</b></a> + +<a href="#SEC89_11" class="summary-letter"><b>T</b></a> + +<a href="#SEC89_12" class="summary-letter"><b>U</b></a> + +</td></tr></table> +<hr size="6"> +<a name="SEC_Contents"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1>Table of Contents</h1> +<div class="contents"> + +<ul class="toc"> + <li><a name="TOC1" href="#SEC1">1. Overview</a> + <ul class="toc"> + <li><a name="TOC2" href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></li> + </ul></li> + <li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li> + <li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li> + <li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a> + <ul class="toc"> + <li><a name="TOC6" href="#SEC6">4.1 Specifying where to split the generated document</a></li> + <li><a name="TOC7" href="#SEC7">4.2 Setting output file and directory names</a></li> + <li><a name="TOC8" href="#SEC8">4.3 Specifying which regions get expanded</a></li> + <li><a name="TOC9" href="#SEC9">4.4 Command line options related to Texinfo language features</a></li> + <li><a name="TOC10" href="#SEC10">4.5 Page layout related command line options</a></li> + <li><a name="TOC11" href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></li> + <li><a name="TOC12" href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></li> + <li><a name="TOC13" href="#SEC13">4.8 Use initialization files for fine tuning</a></li> + </ul></li> + <li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a> + <ul class="toc"> + <li><a name="TOC15" href="#SEC15">5.1 Redefining functions in initialization files</a></li> + <li><a name="TOC16" href="#SEC16">5.2 Conventions used for function prototypes</a></li> + </ul></li> + <li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a> + <ul class="toc"> + <li><a name="TOC18" href="#SEC18">6.1 The different categories of pages and sectioning elements</a></li> + <li><a name="TOC19" href="#SEC19">6.2 Page layout and navigation panel overview</a></li> + <li><a name="TOC20" href="#SEC21">6.3 Customization of the navigation panels buttons</a> + <ul class="toc"> + <li><a name="TOC21" href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></li> + <li><a name="TOC22" href="#SEC23">6.3.2 Specifying the buttons formatting</a></li> + <li><a name="TOC23" href="#SEC24">6.3.3 Changing the navigation panel formatting</a></li> + </ul></li> + <li><a name="TOC24" href="#SEC25">6.4 Main program variables and usefull functions</a> + <ul class="toc"> + <li><a name="TOC25" href="#SEC26">6.4.1 Accessing elements informations</a></li> + <li><a name="TOC26" href="#SEC27">6.4.2 Accessing global informations</a></li> + <li><a name="TOC27" href="#SEC31">6.4.3 Function usefull in page formatting</a></li> + </ul></li> + <li><a name="TOC28" href="#SEC32">6.5 Preparing the output</a></li> + <li><a name="TOC29" href="#SEC33">6.6 Finalizing the output</a></li> + <li><a name="TOC30" href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></li> + <li><a name="TOC31" href="#SEC35">6.8 Customizing the page header</a></li> + <li><a name="TOC32" href="#SEC36">6.9 Customizing the sections</a></li> + <li><a name="TOC33" href="#SEC37">6.10 Customizing the page footer</a></li> + <li><a name="TOC34" href="#SEC38">6.11 Special pages formatting</a> + <ul class="toc"> + <li><a name="TOC35" href="#SEC39">6.11.1 Customizing the content of the special pages</a> + <ul class="toc"> + <li><a name="TOC36" href="#SEC40">6.11.1.1 Top element text formatting</a></li> + <li><a name="TOC37" href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></li> + <li><a name="TOC38" href="#SEC42">6.11.1.3 Formatting of footnotes text</a></li> + <li><a name="TOC39" href="#SEC43">6.11.1.4 Formatting of about text</a></li> + </ul></li> + <li><a name="TOC40" href="#SEC44">6.11.2 Customizing the layout of the special pages</a></li> + </ul></li> + <li><a name="TOC41" href="#SEC45">6.12 Customizing the file names</a></li> + <li><a name="TOC42" href="#SEC46">6.13 Generation of external files for index entries</a></li> + </ul></li> + <li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a> + <ul class="toc"> + <li><a name="TOC44" href="#SEC48">7.1 Three contexts for expansions: preformatted, normal and string</a></li> + <li><a name="TOC45" href="#SEC49">7.2 Customizing the formatting of commands without argument</a></li> + <li><a name="TOC46" href="#SEC50">7.3 Customizing accent, style and other simple commands</a> + <ul class="toc"> + <li><a name="TOC47" href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></li> + <li><a name="TOC48" href="#SEC52">7.3.2 An interface for commands formatting with a string</a></li> + <li><a name="TOC49" href="#SEC53">7.3.3 Defining the style and indicatric commands interface</a></li> + </ul></li> + <li><a name="TOC50" href="#SEC54">7.4 Formatting of special simple commands</a></li> + <li><a name="TOC51" href="#SEC55">7.5 Processing special characters in text</a></li> + <li><a name="TOC52" href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></li> + <li><a name="TOC53" href="#SEC57">7.7 References</a> + <ul class="toc"> + <li><a name="TOC54" href="#SEC58">7.7.1 Reference to external manual</a></li> + <li><a name="TOC55" href="#SEC59">7.7.2 Reference to an internal node</a></li> + </ul></li> + <li><a name="TOC56" href="#SEC60">7.8 Commands used for centering and flushing of text</a></li> + <li><a name="TOC57" href="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a> + <ul class="toc"> + <li><a name="TOC58" href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></li> + <li><a name="TOC59" href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></li> + </ul></li> + <li><a name="TOC60" href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></li> + <li><a name="TOC61" href="#SEC65">7.11 Customizing the formatting of lists and tables</a> + <ul class="toc"> + <li><a name="TOC62" href="#SEC66">7.11.1 Formatting individual table and list items</a></li> + <li><a name="TOC63" href="#SEC67">7.11.2 Formatting of a whole table or list</a></li> + </ul></li> + <li><a name="TOC64" href="#SEC68">7.12 Definition commands formatting</a> + <ul class="toc"> + <li><a name="TOC65" href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></li> + <li><a name="TOC66" href="#SEC70">7.12.2 Customization of the definition formatting</a></li> + </ul></li> + <li><a name="TOC67" href="#SEC71">7.13 Customizing headings formatting</a></li> + <li><a name="TOC68" href="#SEC72">7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</a></li> + <li><a name="TOC69" href="#SEC73">7.15 Menu formatting</a> + <ul class="toc"> + <li><a name="TOC70" href="#SEC74">7.15.1 The structure of a menu</a></li> + <li><a name="TOC71" href="#SEC75">7.15.2 The formatting of the different menu components</a></li> + </ul></li> + <li><a name="TOC72" href="#SEC76">7.16 Indices formatting</a> + <ul class="toc"> + <li><a name="TOC73" href="#SEC77">7.16.1 Formatting of index entries</a></li> + <li><a name="TOC74" href="#SEC78">7.16.2 Customizing the formatting of index lists</a></li> + </ul></li> + <li><a name="TOC75" href="#SEC79">7.17 Floats and lists of floats</a> + <ul class="toc"> + <li><a name="TOC76" href="#SEC80">7.17.1 Formatting a float</a></li> + <li><a name="TOC77" href="#SEC81">7.17.2 Formatting lists of floats</a></li> + </ul></li> + <li><a name="TOC78" href="#SEC82">7.18 Customizing the footnotes formatting</a></li> + <li><a name="TOC79" href="#SEC83">7.19 Customizing other commands, and unknown commands</a></li> + </ul></li> + <li><a name="TOC80" href="#SEC84">A. Internationalization</a> + <ul class="toc"> + <li><a name="TOC81" href="#SEC85">A.1 Translating strings</a></li> + <li><a name="TOC82" href="#SEC86">A.2 Adding new strings written to document</a></li> + </ul></li> + <li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li> + <li><a name="TOC84" href="#SEC88">C. Variable Index</a></li> + <li><a name="TOC85" href="#SEC89">D. Concept Index</a></li> +</ul> +</div> +<hr size="1"> +<a name="SEC_Overview"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1>Short Table of Contents</h1> +<div class="shortcontents"> +<ul class="toc"> +<li><a name="TOC1" href="#SEC1">1. Overview</a></li> +<li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li> +<li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li> +<li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a></li> +<li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a></li> +<li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a></li> +<li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a></li> +<li><a name="TOC80" href="#SEC84">A. Internationalization</a></li> +<li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li> +<li><a name="TOC84" href="#SEC88">C. Variable Index</a></li> +<li><a name="TOC85" href="#SEC89">D. Concept Index</a></li> +</ul> +</div> +<hr size="1"> +<a name="SEC_About"></a> +<table cellpadding="1" cellspacing="1" border="0"> +<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="#SEC87" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> +</tr></table> +<h1>About This Document</h1> +<p> + This document was generated by <em>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>. +</p> +<p> + The buttons in the navigation panels have the following meaning: +</p> +<table border="1"> + <tr> + <th> Button </th> + <th> Name </th> + <th> Go to </th> + <th> From 1.2.3 go to</th> + </tr> + <tr> + <td align="center"> [ < ] </td> + <td align="center">Back</td> + <td>previous section in reading order</td> + <td>1.2.2</td> + </tr> + <tr> + <td align="center"> [ > ] </td> + <td align="center">Forward</td> + <td>next section in reading order</td> + <td>1.2.4</td> + </tr> + <tr> + <td align="center"> [ << ] </td> + <td align="center">FastBack</td> + <td>beginning of this chapter or previous chapter</td> + <td>1</td> + </tr> + <tr> + <td align="center"> [ Up ] </td> + <td align="center">Up</td> + <td>up section</td> + <td>1.2</td> + </tr> + <tr> + <td align="center"> [ >> ] </td> + <td align="center">FastForward</td> + <td>next chapter</td> + <td>2</td> + </tr> + <tr> + <td align="center"> [Top] </td> + <td align="center">Top</td> + <td>cover (top) of document</td> + <td> </td> + </tr> + <tr> + <td align="center"> [Contents] </td> + <td align="center">Contents</td> + <td>table of contents</td> + <td> </td> + </tr> + <tr> + <td align="center"> [Index] </td> + <td align="center">Index</td> + <td>index</td> + <td> </td> + </tr> + <tr> + <td align="center"> [ ? ] </td> + <td align="center">About</td> + <td>about (help)</td> + <td> </td> + </tr> +</table> + +<p> + where the <strong> Example </strong> assumes that the current position is at <strong> Subsubsection One-Two-Three </strong> of a document of the following structure: +</p> + +<ul> + <li> 1. Section One + <ul> + <li>1.1 Subsection One-One + <ul> + <li>...</li> + </ul> + </li> + <li>1.2 Subsection One-Two + <ul> + <li>1.2.1 Subsubsection One-Two-One</li> + <li>1.2.2 Subsubsection One-Two-Two</li> + <li>1.2.3 Subsubsection One-Two-Three + <strong><== Current Position </strong></li> + <li>1.2.4 Subsubsection One-Two-Four</li> + </ul> + </li> + <li>1.3 Subsection One-Three + <ul> + <li>...</li> + </ul> + </li> + <li>1.4 Subsection One-Four</li> + </ul> + </li> +</ul> + +<hr size="1"> +<p> + <font size="-1"> + This document was generated by <em>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>. + </font> + <br> + +</p> +</body> +</html> diff --git a/Build/source/utils/texi2html/doc/texi2html.info b/Build/source/utils/texi2html/doc/texi2html.info new file mode 100644 index 00000000000..d791b234206 --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.info @@ -0,0 +1,176 @@ +This is texi2html.info, produced by makeinfo version 4.5 from +texi2html.texi. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. +INFO-DIR-SECTION Texinfo documentation system +START-INFO-DIR-ENTRY +* Texi2HTML: (texi2html). Texinfo to HTML Converter. +END-INFO-DIR-ENTRY + + This file, last updated 1 February 2005, documents the `texi2html' +script which converts Texinfo (http://www.texinfo.org) into HTML +(http://w3c.org). This edition is for `texi2html' version 1.76. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. + +Indirect: +texi2html.info-1: 2995 +texi2html.info-2: 51146 +texi2html.info-3: 101110 + +Tag Table: +(Indirect) +Node: Top2995 +Node: Overview5644 +Node: whytexi2html7433 +Node: Obtaining texi2html9512 +Node: Installation9794 +Node: Invoking texi2html11983 +Node: Splitting output13162 +Node: Output files16491 +Node: Expansion19748 +Node: Texinfo related options20652 +Node: Page layout options21714 +Node: Style options22607 +Node: Expanding TeX regions24932 +Node: Using init files26073 +Node: Initialization files27957 +Node: Redefining functions29903 +Node: Function prototypes30969 +Node: Changing the page layout32044 +Node: The different pages33401 +Node: The page layout35114 +Ref: Element labels36393 +Node: Navigation panel38129 +Node: General purpose variables38787 +Node: Button specifications39555 +Node: Panel formatting function42887 +Node: Program variables43676 +Node: Elements hashes44381 +Node: Global informations44891 +Node: Global functions47411 +Node: Output initialization48152 +Node: Output finalization49609 +Node: css50080 +Node: Customizing header51146 +Node: Customizing section53951 +Node: Customizing footer54948 +Node: Special pages56815 +Node: Special pages content57142 +Node: Top element text57432 +Node: Contents and Overview text58703 +Node: Footnotes text61441 +Node: About text61734 +Node: Special pages layout63238 +Node: File names64428 +Node: External index files66300 +Node: Customizing HTML68420 +Node: Three contexts70141 +Node: Commands without argument70910 +Node: Style and accent commands72327 +Node: Hash reference interface73815 +Ref: Reference hash args74682 +Node: String interface77052 +Node: Define your own interface79028 +Node: Anchors images and spaces80738 +Node: Text83603 +Node: Strings84931 +Node: References86516 +Node: Reference to external manual86715 +Node: Internal reference88708 +Node: Alignement commands89634 +Node: Paragraph and preformatted region90592 +Node: Paragraph and preformatted formatting90920 +Node: Avoiding paragraphs94646 +Node: Complex formats95042 +Node: Lists tables96731 +Node: Table and list items97196 +Node: Whole table list101110 +Node: Definitions102651 +Node: Definition line103126 +Node: Definition formatting104568 +Node: Headings106005 +Node: Special regions106964 +Node: Menus108991 +Node: Menu parts109436 +Node: Menu formatting110869 +Node: Indices113760 +Node: Index entry place114430 +Node: Index list115041 +Node: Floats and lists of floats118130 +Node: Floats119608 +Node: Lists of floats120911 +Node: Footnotes123124 +Node: Other and unknown commands125630 +Node: Internationalization129570 +Node: Translating strings129981 +Node: Adding new strings131634 +Node: Indexop132506 +Node: Indexvr135109 +Node: Indexcp143811 + +End Tag Table diff --git a/Build/source/utils/texi2html/doc/texi2html.info-1 b/Build/source/utils/texi2html/doc/texi2html.info-1 new file mode 100644 index 00000000000..1b2eaccb006 --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.info-1 @@ -0,0 +1,1299 @@ +This is texi2html.info, produced by makeinfo version 4.5 from +texi2html.texi. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. +INFO-DIR-SECTION Texinfo documentation system +START-INFO-DIR-ENTRY +* Texi2HTML: (texi2html). Texinfo to HTML Converter. +END-INFO-DIR-ENTRY + + This file, last updated 1 February 2005, documents the `texi2html' +script which converts Texinfo (http://www.texinfo.org) into HTML +(http://w3c.org). This edition is for `texi2html' version 1.76. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. + +File: texi2html.info, Node: Top, Next: Overview, Up: (dir) + +Texi2HTML +********* + + This manual, last updated 1 February 2005, describes version 1.76 of +the `texi2html' Perl script which converts Texinfo (*note Texinfo: +(Texinfo)Top.) into HTML. + + Please send bug reports concerning this manual to the Texi2HTML user +discussion list <user@texi2html.cvshome.org>. Please state the exact +version of the manual which contains the bug, as given above. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. + *This manual is currently under construction and of course incomplete. ;-)* + +* Menu: + +* Overview:: +* Obtaining texi2html:: + Obtaining a copy of the `texi2html' + source code distribution +* Installation:: Installing `texi2html' +* Invoking texi2html:: Description of the command line options +* Initialization files:: What kind of variables and subroutines appear + in init files and how they are called +* Changing the page layout:: Fine tuning of the page layout +* Customizing HTML:: Fine tuning of the HTML elements + associated with the texinfo constructs +* Internationalization:: Help translating ! +* Indexop:: Command Line Option Index +* Indexvr:: Variable Index +* Indexcp:: Concept Index + + +File: texi2html.info, Node: Overview, Next: Obtaining texi2html, Prev: Top, Up: Top + +Overview +******** + + Texinfo (http://www.texinfo.org) is the official documentation +format of the GNU (http://www.gnu.org) project. It uses a single +source file to produce both online information and printed output. + + It is often desirable to have a way to produce HTML from Texinfo +sources, as GNU-Info files are produced. It is much simpler to run a +converter than it is to rewrite all the documentation in HTML, +especially considering that there is so much Texinfo documentation in +the world. + + Some time ago `makeinfo' wasn't able to produce HTML output format, +but people still wanted documentation in HTML. This was the birthing +hour for `texi2html'. The basic purpose of `texi2html' is to convert +Texinfo documents into HTML. + + Since then, HTML support in `makeinfo' has improved, but `texi2html' +is still stronger in many areas, including the degree to which it +allows customization. With `texi2html', some important aspects of the +resulting HTML files may be specified via command line options, and +configuration files provide an even finer degree of control over the +final output, allowing most every aspect of the final output not +specified in the Texinfo input file to be specified. Configuration +files are written in `perl', like the main program, and anything which +may be specified on the command line may also be specified within a +configuration file. + + For an example of the kind of pages `texi2html' is capable of +producing, have a look at the following sites: the Singular Manual +(http://www.singular.uni-kl.de/Manual/html/), the Cederqvist (CVS +Manual) (http://ccvs.cvshome.org/docs/manual). + +* Menu: + +* whytexi2html:: Why `texi2html' and not `makeinfo'?. + + +File: texi2html.info, Node: whytexi2html, Up: Overview + +Why `texi2html' and not `makeinfo'? +=================================== + + You would like to produce HTML files from your existing Texinfo +files? There are two programs you can use to do this. The first is +`makeinfo' (*note Generating HTML: (texinfo)Generating HTML.). The +second is `texi2html'. + + The design goal of `makeinfo''s HTML output was to produce readable +HTML output. It is now possible to use CSS for HTML customization. +Another possibility is to use intermediate formats, like docbook or +`mekeinfo' XML and XSL stylesheets to customize the resulting document. +Still the output produced by `makeinfo' isn't customizable. + + The current development of `texi2html' tries to provide for +producing the more interesting and sophisticated HTML pages that +today's Internet users have come to expect. The goal behind +`texi2html' is to generate attractive HTML by default but also to allow +users considerable freedom to affect the final style and design of the +output HTML pages. This is achieved via command line options and +flexible configuration files. + + In contrast to the HTML produced by `makeinfo --html' (the +`makeinfo' program is part of the Texinfo distribution), the +`texi2html' program, among other differences, allows for the +customization of the entire page layout, including headers, footers, +style sheets, etc., allows for customization of the low level HTML +formatting, provides for splitting documents at various levels, and +provides for using the `latex2html' program to convert `@tex' sections +of the Texinfo source. + + The focus on HTML is still present but with the help of the +customization files it is now possible to use `texi2html' to produce +other formats as well. `texi2html' may for example be turned into a +texinfo to roff translator with the help of a customization file +provided with the distribution. + + `texi2html' should reasonably convert all Texinfo 4.8 constructs. +If you find it does not, please send a bug report to the +<users@texi2html.cvshome.org> email list. + + +File: texi2html.info, Node: Obtaining texi2html, Next: Installation, Prev: Overview, Up: Top + +Obtaining `texi2html' +********************* + + The latest version of the source code for `texi2html' should be +available from texi2html.cvshome.org (http://texi2html.cvshome.org). + + +File: texi2html.info, Node: Installation, Next: Invoking texi2html, Prev: Obtaining texi2html, Up: Top + +Installation of `texi2html' +*************************** + + To install `texi2html', you must first obtain a copy of the source +distribution. *Note Obtaining texi2html::. + + `texi2html' also requires `perl' version 5.004 or above. The +current version has not been tested extensively on versions of `perl' +below 5.6, however. + + `texi2html' is a standard Automake-based distribution. If you have +a source version, you should run `./configure' to regenerate the +executable `texi2html' file. `./configure' accepts options to select +the installation directory for the `texi2html' file, the default +directories `texi2html' will use to look for configuration files, and +other details. Run `./configure --help' for more information. + + Running `./configure' combines four files into the final `texi2html' +program file: + * `texi2html.pl' contains the base program, + + * `MySimple.pm' handles the command line options, + + * `texi2html.init' is the default configuration file, and + + * `T2h_i18n.pm' is used for internationalization. + + * `translations.pl' contains the translations of the strings used in + documents. + + Running `./configure' also builds the `make' configuration files +(`Makefile's). To make the documentation run `make'. + + `make install' performs the installation to the locations specified +to the `./configure' script. This usually involves placing the actual +`texi2html' file someplace in your path, such as `/usr/local/bin' or +`/usr/bin'. + + Installing `texi2html' in your path should be sufficient to run it. +To use default initialization files, or a configuration file for +LaTeX2HTML when using `latex2html' to convert `@tex' sections (*note +Expanding TeX regions::), install them in the package data directory +specified to configure. This is `/usr/local/share/texi2html/' by +default, but depends on the value of the `--pkgdatadir=DIR' option +passed to the `./configure' script. Files used for strings +customization and internationalization are also searched for in the +`i18n' directory of this directory. *Note Using init files:: for more. + + +File: texi2html.info, Node: Invoking texi2html, Next: Initialization files, Prev: Installation, Up: Top + +Invoking `texi2html' +******************** + + To produce an HTML manual, run `texi2html' with a Texinfo file as an +argument. For example, this manual is created with: + + $ texi2html texi2html.texi + + The behaviour of `texi2html' may be changed with command line +options. These command line options are always associated with +corresponding `perl' variables which may appear in init files, and these +variables are presented in this chapter each time a switch is described. + + Boolean command line switches always have a corresponding negated +switch, obtained by prepending `no' or `no-' to the switch name. For +example `--nomenu' does the reverse of `--menu'. + +* Menu: + +* Splitting output:: The HTML output may be split at + different levels +* Output files:: +* Expansion:: +* Texinfo related options:: +* Page layout options:: Customizing page layout +* Style options:: Customizing the HTML and text style +* Expanding TeX regions:: +* Using init files:: Specifying initialization files for fine tuning + + +File: texi2html.info, Node: Splitting output, Next: Output files, Up: Invoking texi2html + +Specifying where to split the generated document +================================================ + + The HTML manual resulting from the processing of the Texinfo source +may be split into files at different levels. This is specified with the +option `--split' which takes an argument, namely the level of splitting +(variable: `$SPLIT'). This level may be: + +`chapter' + The document is split at `@chapter', `@appendix', or `@unnumbered'. + +`section' + The document is split at the same places as it is using the + `chapter' argument, and also at `@section', `@appendixsec' or + `@unnumberedsec'. + +`node' + The document is split at every sectioning command. It is not + necessarily split at each node, if the `@node' structure doesn't + correspond with the sectioning command structure (see below). + +`none' + The document isn't split. This is the default. + + There are two kinds of commands which may be used to define +sectioning elements in Texinfo: `@node' and the structuring commands +(`@top', `@section', `@appendixsubsec', and so on). A node just +preceding a structuring command is considered to be part of the same +sectioning element as that command. If the `@node Top' isn't +associated with a structuring command it also defines a sectioning +element. + + By default, nodes which aren't associated with a structuring command +are not considered to be sectioning commands. They are always +considered to be part of a sectioning element defined by a structuring +command. It is possible to change this behaviour via the `--use-nodes' +option (variable `$USE_NODES'). In this case, nodes not associated +with structuring commands are also considered to be sectioning commands +defining a sectioning element. + + This default behaviour mimics `texi2dvi' behaviour, which ignores +`@node' commands for the purprose of sectioning, while the second looks +like `makeinfo' behaviour (*note Two Paths: (texinfo)Two Paths.). + + As an illustration, the following table shows how a sample Texinfo +document is divided into sectioning elements when `--use-nodes' is used +and not: + +Texinfo code default case with + `--use-nodes' + @node node1 first element: first element: + @chapter node 1 + node1 text @node node1 @node node1 + @chapter node 1 @chapter node 1 + @node node2 node1 text node1 text + node2 text second + @node node2 element: + @node node3 node2 text + node3 text second @node node2 + @chapter node 3 element: node2 text + chapter text third + @node node3 element: + node3 text + @chapter node 3 @node node3 + chapter text node3 text + @chapter node 3 + chapter text + + +File: texi2html.info, Node: Output files, Next: Expansion, Prev: Splitting output, Up: Invoking texi2html + +Setting output file and directory names +======================================= + + The manual name is constructed by stripping the `.texi', `.txi', +`.texinfo', or `.txinfo' extension from the Texinfo file name. + + By default, `texi2html' generates the manual file in the current +directory if the manual isn't split. A `.html' file extension is +appended to the manual name. + + If the manual is split the files are put in a directory named after +the manual name. The file name is constructed using the manual name as +basename. An underscore followed by a number is appended to the +basename for each files corresponding with sectioning elements, with the +exception of the top element. For the top element there nothing +appended. The files containing special elements pages have an +underscore and a 3 letter code corresponding to their content (`toc' +for table of contents, `abt' for about, `ovr' for overview) appended. +Lastly, an `.html' file extension is appended. + + Thus, if the texinfo file `afile.texi' is processed and split at +chapters into 3 files, the generated files (in directory `afile') will +be: + + afile.html --> `@node Top' or `@top' section + afile_1.html --> Chapter 1 + afile_2.html --> Chapter 2 + afile_toc.html --> Table of Contents + afile_abt.html --> About Page + + This default behavior may be modified by several command line +options. If the output isn't split, the prefix file name may be +overrided by the `--output' command line option (variable `$OUT'). If +the output is split, and `--output' is set, the files are placed in the +directory specified by the argument to the option. + + The basename may be overridden with `--prefix' (variable `$PREFIX'). +If `--short-ext' is given, `.htm' is appended instead of `.html' in +the final step (variable `$SHORTEXTN'). The `--top-file' option +overrides the top element file name (variable `$TOP_FILE'). This can +be used to name the top element file `index.html'. Similarly, +`--toc-file' changes the name of the table of contents file (variable +`$TOC_FILE'). + + Reusing the example above, but this time calling `texi2html' like so: + + $ texi2html -split chapter -prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi + + we get, in `manual': + + index.htm --> `@node Top' or `@top' section + manual_1.htm --> Chapter 1 + manual_2.htm --> Chapter 2 + contents.htm --> Table of Contents + manual_abt.htm --> About Page + + The file names generated by `texi2html' differ from those generated +by `makeinfo'. `makeinfo' uses the node name to construct the file +names while splitting at nodes. It is possible to get the same +behaviour out of `texi2html' by specifying the `--node-files' option +(variable `$NODE_FILES'). If the output isn't split at nodes, +`texi2html' will still output files named after the nodes, without real +content but redirecting to the right file. The default is false for +this option. This trick enables the generated HTML manual to be a +target for the cross-references of other manuals generated by +`makeinfo' or `texi2html'. + + +File: texi2html.info, Node: Expansion, Next: Texinfo related options, Prev: Output files, Up: Invoking texi2html + +Specifying which regions get expanded +===================================== + + The default for `texi2html' is to expand the `@ifhtml', `@html', and +`@menu' regions, all the `@ifnot' regions except `@ifnothtml', and no +other `@if' regions. + + It is possible to expand other regions by setting `--if<region>', +where `<region>' is replaced by the literal name of the region (for +example, `--iftex'). Symetrically, if `--no-if<region>' is specified, +the `<region>' region is ignored. The configuration file array, +`@EXPAND', holds the names of regions which should be expanded. The +only region name present in `@EXPAND' in the default case is `html'. + + If `--nomenu' is set, the `@menu' sections are not expanded +(variable `$SHOW_MENU'). The default is to expand `@menu' sections. + + +File: texi2html.info, Node: Texinfo related options, Next: Page layout options, Prev: Expansion, Up: Invoking texi2html + +Command line options related to Texinfo language features +========================================================= + + Miscalleneous Texinfo related things may be specified via command +line options. + +`--lang=LANG' + Sets the document language similar to the Texinfo directive, + `@documentlanguage LANG' (variable `$LANG'). The default is `en', + that is, use the english language strings. + +`-DVAR' + Sets VAR. Equivalent to, `@set VAR 1', in Texinfo. + +`-UVAR' + Clears VAR. Equivalent to, `@clear VAR', in Texinfo. + +`-PDIR' + Prepend DIR to the list of directories to search for `@include' + files (the associated array is `@PREPEND_DIRS', empty in the + default case). + +`-IDIR' + Append DIR to the list of directories to search for `@include' + files (the associated array is `@INCLUDE_DIRS', empty in the + default case). + + The include files are always searched for in the current directory. + + +File: texi2html.info, Node: Page layout options, Next: Style options, Prev: Texinfo related options, Up: Invoking texi2html + +Page layout related command line options +======================================== + + If the `--frames' option is specified, HTML frames are used. A file +describing the frame layout is generated, and the document page is +associated with a frame where the short table of content appears +(variable `$FRAMES'). The default is not to use frames. + + It is also possible to suppress the section navigation panel with +`--nosec-nav' (variable `$SECTION_NAVIGATION', the default is to output +all the navigation panels), and to specify whether footnotes should +appear at the foot of the same page which contains the reference to the +note or on a separate page with `--separated-footnotes' (variable +`$SEPARATED_FOOTNOTES'). The default is to have separated footnotes. + + +File: texi2html.info, Node: Style options, Next: Expanding TeX regions, Prev: Page layout options, Up: Invoking texi2html + +Customizing the HTML and text style +=================================== + + Miscalleneous style changes may be achieved with command line +options. + +`--doctype=DTD' +`--frameset-doctype=DTD' + You can specify the document DTD by setting these options. + `--frameset-doctype' applies to the file describing the frames when + frames are used (corresponding variables are `$DOCTYPE' and + `$FRAMESET_DOCTYPE'). + + The default for the document doctype is: + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> + And for the frameset doctype: + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd"> + +`--iso' + If this option is set, ISO8859 entities are used for some special + symbols, like Copyright (C) (variable `$USE_ISO'). It is the + default. + +`--css-include=FILE' + This command line switch provides for the inclusion of an external + Cascading Style Sheet (CSS) file. More than one file may be + specified, and `-' stands for the standard input (array + `@CSS_FILES'). + + The option use is the same than for `makeinfo' and is described + extensively in *Note HTML CSS: (texinfo)HTML CSS. Briefly, the + CSS `@import' lines from the external file CSS file are pasted + before the `texi2html' CSS rules, and the external file CSS rules + are pasted after the `texi2html' CSS rules. + +`--html-xref-prefix=PATH' + This option sets the base directory for external HTML texinfo + manuals (variable `$EXTERNAL_DIR'). Defaults to `../'. + +`--def-table' + If this option is set, HTML tables are used to format definition + commands, rather than HTML definition tables (variable + `$DEF_TABLE'). Default is false. + +`--short-ref' + If this option is set, cross-references are given without section + numbers (variable `$SHORT_REF'). Default is false. + +`--number' + If this option is set, sections are numbered (variable + `$NUMBER_SECTIONS'). This is the default. + +`--toc-links' + If this option is set, links from headings to TOC entries are + created (variable `$TOC_LINKS'). Default is false. + + +File: texi2html.info, Node: Expanding TeX regions, Next: Using init files, Prev: Style options, Up: Invoking texi2html + +Expanding `@tex' and `@math' regions using LaTeX2HTML +===================================================== + + It is possible to use LaTeX2HTML (http://www.latex2html.org/) to +process `@tex' regions and `@math{}' commands. This is an attractive +way to display mathematical constructs in the HTML manual. The `--l2h' +option activates this feature (variable $L2H). It is usually desirable +to expand `@tex' sections when this option is specified (*note +Expansion::). The default is not to use this feature. + + The `--l2h-l2h=PROGRAM' option enables changing the name/location of +the LaTeX2HTML program processing TeX regions (variable `$L2H_L2H'). +The default is `latex2html'. + + `--l2h-tmp' sets the directory used for temporary files, this name +shouldn't contain a dot `.' (variable is `$L2H_TMP'). Defaults to the +current dir. + + The file specified by `--l2h-file' is used as LaTeX2HTML init file. +It is searched at the same places than init files (*note Using init +files::), and the default is `l2h.init'. + + +File: texi2html.info, Node: Using init files, Prev: Expanding TeX regions, Up: Invoking texi2html + +Use initialization files for fine tuning +======================================== + + Initialization variables are read first from +`/usr/local/share/texi2html/Config' (the exact location being +changeable with the `--pkgdatadir=dir' option of the `configure' +script, see *Note Installation::), `/usr/local/etc/texi2html/Config' +(the exact location being changeable with the `--sysconfdir=dir' option +of the `configure' script, see *Note Installation::), from `./Config' +then from `$HOME/.texi2html/Config'. Any command-line option can +override the corresponding option set in init file, and the option +`--init-file' specifies an init file to be loaded, with later settings +overriding earlier ones. + + The init files specified with `--init-file' are searched first in +the current directory, then in the `$HOME/.texi2html/' directory, in +the `/usr/local/etc/texi2html/' directory and lastly in the +`/usr/local/share/texi2html/' directory. + + A file is also included based on the language selected, by `$LANG', +`--lang' or `@documentlanguage'. If no language was selected `en' is +considered to be the language. All the files with name the language +name in `/usr/local/share/texi2html/i18n/', +`/usr/local/etc/texi2html/i18n/', `$HOME/.texi2html/i18n/' and then +`./i18n/' are included. + + The default initialization options are defined in the +`texi2html.init' file contained in the `texi2html' distribution (which +gets included near the beginning of the `texi2html' script that gets +installed). + + To customize `texi2html' it is best if you copy the appropriate +sections from the `texi2html.init' contents into an appropriate local +initialization file, make the necessary changes there, and then have +`texi2html' read this initialization file by one of the means described +above. + + +File: texi2html.info, Node: Initialization files, Next: Changing the page layout, Prev: Invoking texi2html, Up: Top + +Overview of initialization files content and loading +**************************************************** + + The initialization files are `perl' files, read as explained in +*Note Using init files::. You don't need to know much of `perl' to do +some simple changes in variable values, however, to be able to really +take advantage of all the features of the initialization file, a good +knowledge of `perl' is required. + + In initialization file two kind of variables appear. These are normal +variables (including arrays and hashes) and references on functions. +The later permits the dynamic redefinition of functions used to produce +the HTML manual. You should be able to change the value of some normal +variables without a deep knowledge of `perl', by looking at the +existing examples. The possible mistakes in that case could be omitted +`;', and bad quoting. + + Initialization file are loaded from the main program by the mean of +a `require', while in the `Texi2HTML::Config' namespace. This means +that the namespace of the main program and the namespace of +inititalization files are distinct, which ensures that no name clash +should happen. The variables are declared with the `our' specifier, +such that it should be possible to use the `use strict' pragma in the +initialization file code. + + To avoid messing with the variables in the `main' namespace all the +global variables which could be of use in the init files are in the +`Texi2HTML' namespace. Notice that the functions of the main program +are still in the `main' namespace. + +* Menu: + +* Redefining functions:: Function redefinition is achieved with + redefinition of references on functions. +* Function prototypes:: Conventions used in that manual for function + reference prototypes display. + + +File: texi2html.info, Node: Redefining functions, Next: Function prototypes, Up: Initialization files + +Redefining functions in initialization files +============================================ + + To redefine a function you must replace the corresponding funtion +reference with a reference on your function. Thus you should write +your function, give it a name you are certain it is unique in the +`Texi2HTML::Config' namespace, and override the value of the function +reference with your own function reference. When another function from +the main program (or from another functions of an initialization file) +calls the reference, your function will be used. + + For example the function reference corresponding with the function +called when doing an anchor is called `$anchor'. Thus if you want to +override the corresponding function you could write: + + # override the function reference + $anchor = \&my_own_function; + + # the function reference now refers to + sub my_own_function { + # process arguments and return an html anchor + } + + +File: texi2html.info, Node: Function prototypes, Prev: Redefining functions, Up: Initialization files + +Conventions used for function prototypes +======================================== + + As the functions are defined by a reference name, we will always use +the reference name in function prototypes. For the function arguments +we will use `\@array' for a reference on an array and similarly +`\%hash' for a reference on a hash. + + Thus, the prototype for the function associated with the function +reference `$formatting_function' will be: + + - Function Reference: $text formatting_function $arg1 \@arg2 + `formatting_function' takes as first argument $ARG2, as second + argument a reference on an array \@ARG2 and returns the formatted + text $TEXT. + + To redefined the corresponding function, you should write: + + $formatting_function = \&my_formatting_function + + sub my_formatting_function($ $) + { + my $arg1 = shift; + my $arg2 = shift; + # prepare $formatted_text + ..... + return $formatted_text + } + + +File: texi2html.info, Node: Changing the page layout, Next: Customizing HTML, Prev: Initialization files, Up: Top + +Fine tuning of the page layout +****************************** + + Some features of the page layout might be specified with command line +options, the corresponding variables are described in *Note Page layout +options::. Fine tuning of the page layout may be achieved with +redefinition of other variables and function references in the +initialization files. + +* Menu: + +* 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. +* Output initialization:: Setting variables before the document + production but after the texinfo parsing. +* Output finalization:: Cleaning after document generation. +* css:: Customizing css lines. +* Customizing header:: +* Customizing section:: +* Customizing footer:: +* Special pages:: Customizing table of contents, top, about page. +* File names:: Customizing the file names. +* External index files:: Putting index entries in external files. + + +File: texi2html.info, Node: The different pages, Next: The page layout, Up: Changing the page layout + +The different categories of pages and sectioning elements +========================================================= + + The following sectioning elements can be associated with pages: + +_Normal elements_ + These are normal sections or nodes. Their association with pages is + determined by the splitting of the document. *Note Splitting + output::. + +_Top element_ + The top element is the higher element in the document structure. + If there is a `@top' section it is the element associated with + that section. Otherwise it is the element associated with the + `@node Top'. If there is no `@node Top' the first element is the + top element. + + The top element is formatted differently than a normal element if + there is a `@top' section or the `@node Top' isn't associated with + a sectioning command. + +_Misc elements_ + These elements are associated with pages if the document is split. + There are four misc elements: + 1. Table of contents + + 2. Short table of contents, also called Overview + + 3. Footnotes page + + 4. About page + + The _About page_ shouldn't be present for documents consisting in + only one sectioning element. The _Footnote page_ should only be + present if the footnotes appear on a separated page (*note Page + layout options::), however a footnote element is present if the + document isn't split. The _Table of contents_ should only be + formatted if `@contents' is present in the document. Similarly + the _Overview_ should only appear if `@shortcontents' or + `@summarycontents' is present. + + +File: texi2html.info, Node: The page layout, Next: Navigation panel, Prev: The different pages, Up: Changing the page layout + +Page layout and navigation panel overview +========================================= + + A page is broken up in three parts. A page header, the sections and +a page footer. A common element in the page layout is a navigation +panel with icons or text linking to other sections or pages. Another +common element is a rule, separating sections or footer. The navigation +panel and the rules may be part of the sections or part of headers or +footers. You may use the variables `$SMALL_RULE', `$DEFAULT_RULE', +`$MIDDLE_RULE' and `$BIG_RULE' for rules of different sizes. The +defaults are + $SMALL_RULE = '<hr size="1">'; + $DEFAULT_RULE = '<hr>'; + $MIDDLE_RULE = '<hr size="2">'; + $BIG_RULE = '<hr size="6">'; + + In the header some important meta data may be defined, like the +title or style information, and textual informations may be present in +comments. All this doesn't appear directly in the displayed HTML, +though. + + The page layout is mainly controlled by functions, the precise +functions called depending on the document splitting. The navigation +panel, however, can be customized with variables. + +Element labels +-------------- + + There are 19 items associated with elements. Each of these is +associated with a name and a reference to the element they represent, +when such an element exists. The element is either a global element or +an element relative to the current element. The relative elements are +found with respect with the document structure defined by the section +structuring commands (`@chapter', `@unnumbered'...) or by the nodes (in +that case the node directions are specified on node line or in menu +organization). These items are called "element labels". They may be +associated with a button (*note Button specifications::), and used in +the formatting functions (*note Program variables::). + + Here is the list: + +_` '_ + An empty button + +_Top_ + Top element. The associated name is `$TOP_HEADING' if that + variable is defined. This variable is not set by default. + +_Contents_ + Table of contents + +_About_ + About (help) page + +_Overview_ + Overview, short table of contents + +_First_ + First element in reading order + +_Last_ + Last element in reading order + +_Index_ + The first chapter with `@printindex'. The associated name is + `$INDEX_CHAPTER', if the variable is set. This variable is not set + by default. + +_This_ + The current element + +_Back_ + Preceding element in reading order + +_FastBack_ + Beginning of this chapter or previous chapter if the element is a + chapter + +_Prev_ + Previous section on the same level + +_NodePrev_ + Previous node + +_Forward_ + Next element in reading order + +_FastForward_ + Next chapter + +_Next_ + Next section on the same level + +_NodeNext_ + Next node + +_Following_ + Next node in node reading order + +_Up_ + Up section + +_NodeUp_ + Up node + + +File: texi2html.info, Node: Navigation panel, Next: Program variables, Prev: The page layout, Up: Changing the page layout + +Customization of the navigation panels buttons +============================================== + + A lot of customization of the navigation panel may be achieved +without redefining functions, with variables redefinition. In case it +isn't enough, it is also possible to redefine the function doing the +navigation panel formatting. + +* Menu: + +* General purpose variables:: Variables controlling the navigation panel + at a global level +* Button specifications:: +* Panel formatting function:: + + +File: texi2html.info, Node: General purpose variables, Next: Button specifications, Up: Navigation panel + +Controlling the navigation panel panel at a high level +------------------------------------------------------ + + The global formatting of the navigation panels may be changed with +the following variables: + +`$VERTICAL_HEAD_NAVIGATION' + A vertical navigation panel will be used for the header navigation + panel if this variable is true. + +`$ICONS' + Icons are used instead of textual buttons if this variable is true. + +`$SECTION_NAVIGATION' + If this variable is false there is no section navigation, no + navigation panels for the elements within the pages, only at the + beginning and the end of the page (*note Page layout options::). + + +File: texi2html.info, Node: Button specifications, Next: Panel formatting function, Prev: General purpose variables, Up: Navigation panel + +Specifying the buttons formatting +--------------------------------- + + Several arrays and hashes enable a precise control on the buttons and +their display. The following arrays determine the buttons present in +navigation panels: + +`@SECTION_BUTTONS' + This array is used for the navigation panel buttons present at the + begining of sectioning elements. If split at node or section they + are also used at the page footer, and in the case of section + navigation at the page header. + +`@SECTION_FOOTER_BUTTONS' +`@NODE_FOOTER_BUTTONS' + This array is used for the navigation panel buttons present at the + footer of pages when split at node or at section. + + If `$WORDS_IN_PAGE' is set and the output is split at nodes, these + buttons are only present if there are more than `$WORDS_IN_PAGE' + words in the sectioning element text. This counting is very rough + and include punctuation marks, html elements, numbers. The + default is to include the buttons after 300 words. + +`@CHAPTER_BUTTONS' + This array is used for the buttons appearing at the page footer if + split at chapter, and at the page header if split at chapter and + there is no section navigation. + +`@MISC_BUTTONS' + These buttons appear at the beginning of special and sections and + at the end of these section pages if the output is split. + + The array specify the buttons displayed in navigation panels, and +how the button is displayed. Each element is associated with a button +of the navigation panel from left to right. The signification of the +array element value is the following: + +_reference on a function_ + The function is called with first argument a filehandle reference + on the current file and second argument a boolean true if the + navigation panel should be vertical. + +_reference on a scalar_ + The scalar value is printed. For some possibly usefull scalars, + *Note Elements hashes::. + +_reference on an array_ + In this case the first array element should be a reference on text + and the second element an element label. In that case a link to the + element associated with the element label with the scalar value + text is generated. + + For example if the buttons array element is + [ 'Next', \$Texi2HTML::NODE{Next} ] + + The button will be a link to the next section with text + `$Texi2HTML::NODE{Next}'. + +_element label_ + If icons are not used, the button is a link to the corresponding + element which text is defined by the value associated with the + element label in the `%NAVIGATION_TEXT' hash, surrounded by `[' + and `]'. If the element label is ` ', there is no `[' and `]'. + The element of the `%NAVIGATION_TEXT' hash are defined + dynamically, in the `init_out' function reference (*note Output + initialization::). + + If icons are used, the button is an image with file determined by + the value associated with the element label in the `%ACTIVE_ICONS' + hash if the the link really leads to an element, or in the + `%PASSIVE_ICONS' hash if there is no element to link to. Of course + if there is a link to the element the icon links to that element. + + +File: texi2html.info, Node: Panel formatting function, Prev: Button specifications, Up: Navigation panel + +Changing the navigation panel formatting +---------------------------------------- + + If you are not satisfied with this scheme, it is possible to control +exactly the formatting of navigation panels by redefining a function +reference. The function controlling the display of navigation panel is +associated with the following function reference: + + - Function Reference: print_navigation $filehandle \@buttons $vertical + $FILEHANDLE is the opened filehandle the function should write to. + \@BUTTONS is an array reference which should hold the + specification of the buttons for that navigation panel. $VERTICAL + is true if the navigation panel should be vertical. + + +File: texi2html.info, Node: Program variables, Next: Output initialization, Prev: Navigation panel, Up: Changing the page layout + +Main program variables and usefull functions +============================================ + + In the functions controlling the page layout some global 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, + title... +* Global functions:: main program usefull functions + + +File: texi2html.info, Node: Elements hashes, Next: Global informations, Up: Program variables + +Accessing elements informations +------------------------------- + + Four hashes are available, with key the elements labels (as described +in *Note Element labels::) and values: + +`%Texi2HTML::NAME' + The formatted element name + +`%Texi2HTML::HREF' + The element hypertext reference + +`%Texi2HTML::NODE' + The element node name + +`%Texi2HTML::NO_TEXI' + The element name after removal of texi commands + + +File: texi2html.info, Node: Global informations, Next: Global functions, Prev: Elements hashes, Up: Program variables + +Accessing global informations +----------------------------- + + Three kinds of global informations are available, miscalleneous +global strings, flags set by `@set' and special flags and section lines. + +Global strings +.............. + + The `%Texi2HTML::THISDOC' hash holds some global informations: + +`fulltitle' + title set by `@title'. If there is no `@title' other possibilities + are tried (`@settitle', `@shorttitlepage'...). + +`title' + title set by `@settitle', or `fulltitle'. + +`title_no_texi' + title without texi formatting + +`title_texi' + title with texi commands + +`author' + Authors list set by `@author'. + +`authors' + A reference on an array containing each author set by `@author'. + +`copying' + Text appearing in `@copying' with all the texinfo commands removed, + put in comments. + +`program' + The name and version of `texi2html'. + +`program_homepage' + Homepage for `texi2html'. + +`program_authors' + Authors of `texi2html'. + +`file_base_name' + base name of the texinfo manual file. + +`destination_directory' + Destination directory for the resulting files. + +`toc_file' + The file name of the table of contents. + +`today' + The date. + + It also holds the arg of the following commands, associated with the +command name: kbdinputstyle, paragraphindent, setchapternewpage, +headings, footnotestyle, exampleindent, firstparagraphindent, +everyheading, everyfooting, evenheading, evenfooting, oddheading, +oddfooting. + +Flags +..... + + Flags defined by `@set' may be accessed through the `%main::value' +hash. The key is the flag name, the value is the flag value at the end +of the document. + + Special flags are set by the main program. They correspond with a +texinfo command, like `@setfilename', or `@settitle', `@author'... The +corresponding flag is the command name with `_' appended, for example, +`_titlefont' corresponds with `@titlefont'. Like other flags they are +available in `%main::value'. + +Section lines +............. + + The following array references or arrays holds formatted lines: + +`$Texi2HTML::THIS_SECTION' + Lines of the current element. + +`$Texi2HTML::THIS_HEADER' + Lines of the current element appearing before the element label + (anchors). + +`$Texi2HTML::OVERVIEW' + Lines of short table of contents. *Note Special pages::. + +`$Texi2HTML::TOC_LINES' + Lines of table of contents. *Note Special pages::. + + +File: texi2html.info, Node: Global functions, Prev: Global informations, Up: Program variables + +Function usefull in page formatting +----------------------------------- + + The usefull function is a function used to print an array of lines, +which also counts the number of words in the array, if needed. + + - Function: $words_number main::print_lines $filehandle \@lines_array + $FILEHANDLE is the opened filehandle the function should write to. + \@LINES_ARRAY is the array line the function should write to the + file. If this argument is omitted, the function uses + `$Texi2HTML::THIS_SECTION'. $WORDS_NUMBER is the number of words + in the array, only defined if split at nodes and `$WORDS_IN_PAGE' + is defined. + + +File: texi2html.info, Node: Output initialization, Next: Output finalization, Prev: Program variables, Up: Changing the page layout + +Preparing the output +==================== + + After the texinfo file has been parsed, some information is available +which can be used to modify some variables and prepare the outputting. +For example the document language, the document encoding, values set +with `@set' or `@setfilename' and other similar @-commands are not +known before the texinfo parsing. + + The following function reference may be redefined to be called after +texinfo processing and before document generation: + + - Function Reference: $encoding init_out + This function perform the initialization of variables and any other + task before document outputting. It returns the encoding used for + the output files. + + In the default case the `$BODYTEXT' (*note Customizing header::) and +the hashes `%NAVIGATION_TEXT' (*note Button specifications::) and +`%BUTTONS_GOTO' (*note About text::) are initialized. + + To perform the default initializations and also add more code, you +could do as in the following example (save the default function +reference and call it in your own function) : + + my $default_init_out = $init_out; + $init_out = \&makeinfo_like_init_out; + sub makeinfo_like_init_out() + { + my $encoding = &$default_init_out(); + $NAVIGATION_TEXT{'Following'} = ' > '; + return $encoding; + } + + +File: texi2html.info, Node: Output finalization, Next: css, Prev: Output initialization, Up: Changing the page layout + +Finalizing the output +===================== + + If you want to do some cleaning after the document was generated +(close files, write at the end of files and so on), the following +function reference may be redefined: + + - Function Reference: finish_out + This function is called after the document generation. + + The default is to do nothing. + + +File: texi2html.info, Node: css, Next: Customizing header, Prev: Output finalization, Up: Changing the page layout + +Customizing the `texi2html' css lines +===================================== + + It is possible to modify the `texi2html' css lines by modifying the +entries or adding to the `%css_map' hash. Each key is a css selector, +the corresponding value is a style string. + + The whole css text is in the variable `$CSS_LINES'. If this variable +is defined the variable value is used instead of being constructed +using the `%css_map' entries. For example if you don't want any css +entries, set + + $CSS_LINES = ''; + + It is also possible to change completely the way `$CSS_LINES' are +generated by redefining the following function reference: + + - Function Reference: css_lines \@import_lines \@rule_lines + This function should be used to construct the `$CSS_LINES'. + \@IMPORT_LINES are the `@import' lines of the files specified with + `--include-css', and \@RULE_LINES are the css commands lines of + these files. *Note Style options::. + diff --git a/Build/source/utils/texi2html/doc/texi2html.info-2 b/Build/source/utils/texi2html/doc/texi2html.info-2 new file mode 100644 index 00000000000..7ca7887deb8 --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.info-2 @@ -0,0 +1,1262 @@ +This is texi2html.info, produced by makeinfo version 4.5 from +texi2html.texi. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. +INFO-DIR-SECTION Texinfo documentation system +START-INFO-DIR-ENTRY +* Texi2HTML: (texi2html). Texinfo to HTML Converter. +END-INFO-DIR-ENTRY + + This file, last updated 1 February 2005, documents the `texi2html' +script which converts Texinfo (http://www.texinfo.org) into HTML +(http://w3c.org). This edition is for `texi2html' version 1.76. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. + +File: texi2html.info, Node: Customizing header, Next: Customizing section, Prev: css, Up: Changing the page layout + +Customizing the page header +=========================== + + It is possible to add lines to the text within the `<head>' HTML +elements, by defining the variable `$EXTRA_HEAD'. Similarly it is +possible to add text just after the `<body>' element with the variable +`$AFTER_BODY_OPEN'. These variables are empty by default. + + The encoding of the texinfo file is defined by `$DOCUMENT_ENCODING' +if no `@documentencoding' appears in the document. The default is a +`en-ascii' encoding. The encoding of the resulting document is defined +by `$ENCODING'. The default is the `$DOCUMENT_ENCODING'. + + The description of the document may be specified in +`$DOCUMENT_DESCRIPTION'. If this variable is undef, the text associated +with `@documentdescription' is used, and if there isn't such test a +default description is constructed using the document title and the +name of the first section of the file. + + The `<body>' element attributes may be set by defining the variable +`$BODYTEXT'. If you want to define that variable dynamically, you +should use the `init_out' function reference (*note Output +initialization::). + + The default functions call the function associated with +`$print_head_navigation' to format the navigation panel for the page +header. Thus you can control parts of the formatting by redefining the +function reference. + + - Function Reference: print_head_navigation $filehandle \@buttons + $FILEHANDLE is the opened filehandle the function should write to. + \@BUTTONS is an array reference which should hold the + specification of the buttons for the navigation panel. + + If you want even more control, you can have full control over the +page header formatting by redefining three function references. The +function associated with `$print_page_head' is called for all the +pages, and after that, the function associated with +`$print_chapter_header' is called if the document is split at chapters, +or the function associated with `$print_section_header' is called if +the document is split at sections. + + - Function Reference: print_page_head $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function should print the page head, including the `<body>' + element. + + - Function Reference: print_chapter_header $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function is called if the document is split at chapters, after + `print_page_head'. + + - Function Reference: print_section_header $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function is called if the document is split at sections, after + `print_page_head'. + + +File: texi2html.info, Node: Customizing section, Next: Customizing footer, Prev: Customizing header, Up: Changing the page layout + +Customizing the sections +======================== + + The functions associated with the following function references are +used for the formatting of sections: + + - Function Reference: print_section $filehandle $first_in_page + $previous_is_top + $FILEHANDLE is the opened filehandle the function should write to. + $FIRST_IN_PAGE is true if this section is the first section in the + page. $PREVIOUS_IS_TOP is true if this section is the section + following the Top section. This function should print the current + section. + + - Function Reference: end_section $filehandle + $last_element_or_before_top + $FILEHANDLE is the opened filehandle the function should write to. + $LAST_ELEMENT_OR_BEFORE_TOP is true if this section precedes the + top element or is the last one in page, or before the special + elements. + + +File: texi2html.info, Node: Customizing footer, Next: Special pages, Prev: Customizing section, Up: Changing the page layout + +Customizing the page footer +=========================== + + It is possible to add text just before the `</body>' element with +the variable `$PRE_BODY_CLOSE'. Nothing is added by default. + + The default functions call the function associated with +`$print_foot_navigation' to format the navigation panel for the page +footer. Thus you can control parts of the formatting by redefining the +function reference. + + - Function Reference: print_foot_navigation $filehandle \@buttons + $FILEHANDLE is the opened filehandle the function should write to. + \@BUTTONS is an array reference which should hold the + specification of the buttons for the navigation panel. + + If you want even more control, you can have full control the page +footer formatting by redefining three function references. The +function associated with `$print_chapter_footer' is called if the +document is split at chapters, or the function associated with +`$print_section_footer' is called if the document is split at sections. +After that the function associated with `$print_page_foot' is called. + + - Function Reference: print_page_foot $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function should print the page foot, including the `</body>' + element. + + - Function Reference: print_chapter_footer $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function is called if the document is split at chapters, + before `print_page_foot'. + + - Function Reference: print_section_footer $filehandle + $FILEHANDLE is the opened filehandle the function should write to. + This function is called if the document is split at sections, + before `print_page_foot'. + + +File: texi2html.info, Node: Special pages, Next: File names, Prev: Customizing footer, Up: Changing the page layout + +Special pages formatting +======================== + + For the special elements, two things must be formatted: the content +and the page layout + +* Menu: + +* Special pages content:: +* Special pages layout:: + + +File: texi2html.info, Node: Special pages content, Next: Special pages layout, Up: Special pages + +Customizing the content of the special pages +-------------------------------------------- + +* Menu: + +* Top element text:: +* Contents and Overview text:: +* Footnotes text:: +* About text:: + + +File: texi2html.info, Node: Top element text, Next: Contents and Overview text, Up: Special pages content + +Top element text formatting +........................... + + The top element formatting is controlled by three function which also +controls the layout of the top element page or section. The associated +function references are: + + - Function Reference: print_Top_header $filehandle $begin_page + $FILEHANDLE is the opened filehandle the function should write to. + $BEGIN_PAGE is true if the element is the first in a page. This + function should begin the Top element. At the time this function + is called the top element text hasn't been parsed. + + - Function Reference: print_Top $filehandle $has_top_heading + $FILEHANDLE is the opened filehandle the function should write to. + $HAS_TOP_HEADING is true if there is a `@heading' command or + `@titlefont' command appearing in the Top element text. This + function should be used to format the Top element text and + navigation panel. + + - Function Reference: print_Top_footer $filehandle $end_page + $FILEHANDLE is the opened filehandle the function should write to. + $END_PAGE is true if the element is the last in a page. This + function should end the Top element. + + +File: texi2html.info, Node: Contents and Overview text, Next: Footnotes text, Prev: Top element text, Up: Special pages content + +Table of contents and Short table of contents +............................................. + + Several variables may be used to control the formatting of table of +contents and short table of contents: + +`$DO_CONTENTS' + If the variable is true a table of contents is done even if there + is no `@contents' command. + +`$DO_SCONTENTS' + If the variable is true a short table of contents is done even if + there is no `@summarycontents' command. + +`$BEFORE_OVERVIEW' + The variable value is inserted before the short table of contents + text. + +`$AFTER_OVERVIEW' + The variable value is inserted after the short table of contents + text. + +`$BEFORE_TOC_LINES' + The variable value is inserted before the table of contents text. + +`$AFTER_TOC_LINES' + The variable value is inserted after the table of contents text. + +`$TOC_LIST_STYLE' + This should contain a css style used for the list style if the + tables of content are formatted with a list. + +`$TOC_LIST_ATTRIBUTE' + This should contain an attribute text used for the list element if + the tables of content are formatted with a list. + + More control on the table of contents and short table of contents +formatting may be achieved by redefining a function with the following +associated function reference: + + - Function Reference: toc_body \@elements + \@ELEMENTS is an array reference contining informations about all + the elements of the document. Each of the entry of this array is + an hash reference which entries correspond with different + informations about the element. Interesting keys have the + following meaning: + + `top' + true if the element is the top element, + + `index_page' + true if the element is an index page added because of index + splitting, + + `toc_level' + level of the element in the table of content. Highest level + is 1 for the top element and for chapters, appendix and so on, + 2 for section, unnumberedsec and so on... + + `tocid' + label used for reference linking to the element in table of + contents, + + `file' + the file containing the element, usefull to do href to that + file in case the document is split, + + `text' + text of the element, with section number, + + `name' + text of the element, without section number. + + This function doesn't return anything but should fill the array + corresponding with the `$Texi2HTML::TOC_LINES' and + `$Texi2HTML::OVERVIEW' references with the table of contents and + short table of contents. + + + +File: texi2html.info, Node: Footnotes text, Next: About text, Prev: Contents and Overview text, Up: Special pages content + +Formatting of footnotes text +............................ + + The footnotes text is allready formatting when `@footnote' commands +are expanded. *Note Footnotes::. + + +File: texi2html.info, Node: About text, Prev: Footnotes text, Up: Special pages content + +Formatting of about text +........................ + + The default about element contains an explaination of the buttons +used in the document (`@SECTION_BUTTONS', *Note Button +specifications::) and an example locating the buttons targets in an +example. The formatting of this text may be influenced by the following +hashes and variables: + +`$PRE_ABOUT' +`$AFTER_ABOUT' + This variable may be a scalar or a function reference. If it is a + scalar, the value is used. If this is a function reference it is + expanded and the returned text is used. The text is added before + or after the main about text. + +`%BUTTONS_GOTO' + The keys of this hash are element labels (*note Element labels::). + The value is the text associated with the element label in the + about text. The element of the hash are defined dynamically, you + should in the `init_out' function reference (*note Output + initialization::). + +`%BUTTONS_EXAMPLE' + The keys of this hash are element labels (*note Element + labels::). The value is the text associated with the element label + in the about example, typically a section number. + + + If this is not enough and you want to control exactly the formatting +of the about text, you can redefine the function associated with the +following function reference: + + - Function Reference: $about_text print_about + This function should return the about text. + + +File: texi2html.info, Node: Special pages layout, Prev: Special pages content, Up: Special pages + +Customizing the layout of the special pages +------------------------------------------- + + The formatting of each of the special pages, or section in case the +document is not split, is controlled by a function. The associated +function reference is called accordingly: + +`print_Top' + +`print_Top_header' + +`print_Top_footer' + Formatting of top element page or section. It is also used for the + formatting of the top element text (*note Top element text::). + +`print_Toc' + Formatting of table of contents page or section + +`print_Overview' + Formatting of short table of contents page or section + +`print_About' + Formatting of about (help) page or section + +`print_Footnotes' + Formatting of footnotes section or page in case footnotes are on a + separated page or the document isn't split. + + In the default case, `$print_Top' calls `$print_Top_header' for the +header and `$print_Top_footer' for the footer of top element. All the +other function call `$print_misc' which in turn calls +`$print_misc_header' for the headers and `$print_misc_footer' for the +footers. + + +File: texi2html.info, Node: File names, Next: External index files, Prev: Special pages, Up: Changing the page layout + +Customizing the file names +========================== + + It is possible to specify the file names with more control than with +the command line options (*note Output files::). First the extension +may be overrided by the variable `$EXTENSION' value. Two function +references enable further customization. One is usefull in case +`$NODE_FILES' is true and it is used to customize the node file name +itself and is also used to produce a file name with a redirection +leading to the node file. + + - Function Reference: ($node_file $redirection_node_file) +node_file_name $node + $NODE is a hash reference with the following interesting keys + (there are much more keys): + `texi' + The texinfo node name. + + `with_section' + True if associated with a section. + The result is the node file name $NODE_FILE, and the file + containing a redirection to the node $REDIRECTION_NODE_FILE. + + The other is usefull if `$NODE_FILES' isn't true. It is used to +customize the file associated with each element. + + - Function Reference: $file element_file_name $element $is_top + $docu_name + $ELEMENT is a hash reference with the following interesting keys + (there are much more keys): + `texi' + The texinfo element name. + + `number' + The number associated with a section. + + `doc_nr' + A number incremented whenever a new file should begin, based + on how the document is split (*note Splitting output::). + + `text' + The element text. + + `name' + The element text without section number. + $IS_TOP is true if the element is considered as the top element. + $DOCU_NAME is the basename of the texinfo manual. The result is + the element file name. + + +File: texi2html.info, Node: External index files, Prev: File names, Up: Changing the page layout + +Generation of external files for index entries +============================================== + + Within the document, `@printindex' commands are expanded as explained +in *Note Index list::. In case you want to do something special with +index entries, outside of the document, you should first set the +variable `$IDX_SUMMARY' true. After that some function reference will +be called for each non empty index. For each index there are 3 function +references, one called for initialization, one called for each index +entry and the last one called for finalazation. + + - Function Reference: index_summary_file_begin $index_name $is_printed + $INDEX_NAME is the two letters name for the index. This function + is called for each index appearing in the document, before + `index_summary_file_entry'. $IS_PRINTED is true if there is a + `@printindex' for that index. + + - Function Reference: index_summary_file_entry $index_name $entry_text + $entry_reference $formatted_entry $texi_entry + $entry_element_reference $entry_element_header $is_printed + This function is called for each entry of an index. INDEX_NAME is + the name of the index. $ENTRY_TEXT is the entry in plain text, + $FORMATTED_ENTRY is the index entry formatted, $TEXI_ENTRY is the + entry with texinfo commands. $ENTRY_REFERENCE is the reference + placed at the index entry place, in the form `file#id'. + $ENTRY_ELEMENT_HEADER is the formatted header of the element + containing the index entry. ENTRY_ELEMENT_HEADER is the reference + to the beginning of the element containing the index entry, in the + form `file#id'. $IS_PRINTED is true if there is a `@printindex' + for that index. + + - Function Reference: index_summary_file_end $index_name $is_printed + $INDEX_NAME is the two letters name for the index. This function + is called for each index appearing in the document, after + `index_summary_file_entry'. $IS_PRINTED is true if there is a + `@printindex' for that index. + + +File: texi2html.info, Node: Customizing HTML, Next: Internationalization, Prev: Changing the page layout, Up: Top + +Customizing HTML and text style in init files +********************************************* + + Some simple customization may be achieved with the redefinition of +the variables associated with the command line options. For the +description and an explanation of the meaning of these variables, *Note +Style options::. + + Other variables and hash entries can be modified in initialization +file to achieve more customization. Lastly, functions references +corresponding with functions called from the main program and +initialization files may be redefined. + +* Menu: + +* Three contexts:: there are three different contexts for command + expansion: normal text, preformatted text and + strings. +* Commands without argument:: +* Style and accent commands:: +* Anchors images and spaces:: Formatting of `@anchor', `@image', `@sp', `@acronym', `@abbr' +* Text:: Some characters are processed specially +* Strings:: `texi2html' write some strings in the output + different for each languages +* References:: +* Alignement commands:: `@center', `@flushleft'... +* Paragraph and preformatted region:: +* Complex formats:: `@example', `@display'... +* Lists tables:: +* Definitions:: +* Headings:: +* Special regions:: `@verbatim', `@cartouche', `@quotation' +* Menus:: +* Indices:: +* Floats and lists of floats:: `@float' and `@listoffloats' +* Footnotes:: +* Other and unknown commands:: You can handle specifically other commands + + +File: texi2html.info, Node: Three contexts, Next: Commands without argument, Up: Customizing HTML + +Three contexts for expansions: preformatted, normal and string +============================================================== + + There are three contexts of interest, one is the normal context, the +other is a special context, called the "preformatted" context and the +last is the string context. The preformatted context occurs when the +spacing between words is kept. This is the case, for example, in +`@display' or `@example' regions, and in menu comments (*note Menus::). +The preformatted regions are usually rendered in `<pre>' elements in +HTML. The string context occurs when rendering strings without +formatting elements, in comments or titles for example. + + +File: texi2html.info, Node: Commands without argument, Next: Style and accent commands, Prev: Three contexts, Up: Customizing HTML + +Customizing the formatting of commands without argument +======================================================= + + This includes the commands whose name is a nonletter character like +`@@', the commands with lettered characters and braces but whose braces +should be empty, like `@TeX{}', or some commands associated with +accentted letters like `@AA{}'. If there happens to be something within +the braces, it is put after the command, thus + @TeX{something} + leads to the same than + @TeX{} something + + Each of these categories of commands have three associated hashes, +one for normal context, the other for preformatted context and the last +in strings. The keys of the hashes are the command names, the +associated value is the text replacing the command. + + The hashes are: +command type normal text preformatted text string +one nonlettered character `%simple_map' `%simple_map_pre' `%simple_map_texi' +nothing in braces `%things_map' `%pre_map' `%texi_map' + + To change the HTML resulting from these constructs, just change the +value. For example, if you want `­' to be outputted for `@-' in +normal and preformatted context, write in your init file: + + $simple_map{'-'} = '­'; + $simple_map_pre{'-'} = '­'; + + +File: texi2html.info, Node: Style and accent commands, Next: Anchors images and spaces, Prev: Commands without argument, Up: Customizing HTML + +Customizing accent, style and other simple commands +=================================================== + + The formatting of the HTML produced by style and indicatric commands +(`@tt', `@code', `@email', `@titlefont'), the accentuation related +commands taking argument (`@'', `@udotaccent', `@dotless') and +miscalleneous commands (`@email', `@verb', `@w', `@uref', `@math', +`@asis') is controlled by two hash in the default case, `%style_map' +for normal context, `%style_map_pre' for preformatted context and +`%style_map_texi' in string context. + + The key of the hashes are the command names. There are two +possibilities for the values corresponding with two interfaces. The +values may be strings or hash references, and you can chose the +interface depending on the one you prefer. The interface with hash +reference is a bit more flexible but might also be regarded as more +complex. If you don't like either of these interfaces you can define +your own. + + Some remarks are in order: + + * The nonlettered accent commands which following character is + considered to be the argument (like in `@`a') should be keys of the + hash `%accent_map' hash, even if no value is associated. + + * `@math' is handled differently if LaTeX2HTML is used. + +* Menu: + +* Hash reference interface:: +* String interface:: +* Define your own interface:: + + +File: texi2html.info, Node: Hash reference interface, Next: String interface, Up: Style and accent commands + +An interface for commands formatting with a hash reference +---------------------------------------------------------- + + The key of the hashes are the command names. The value determine how +the command argument is formatted. This value is a reference on a hash. +In this hash each key corresponds with a type of information for the +formatting, and the value is the corresponding information. For +example, in + + $style_map{'command'} = { 'args' => ['code'], 'attribute' => 'code'}; + + the arguments for `@command' are interpreted as specified by the +values associated with the `args' key while the attribute associated +with that command is `code'. + + The following keys in the hashes associated with each command have +the following meaning: + +`args' + The value associated is a reference on an array. Each element of + the array defines how the arguments (separated by `,' in the + texinfo code) for the @-command should be formatted. The + possibilities are + `normal' + for normal text, + + `code' + for text with `---', `--', `''' and ```' kept as is, + + `keep' + if the texinfo should be kept as is, without interpretation + of the @-commands. + + For example, we have + $style_map{'email'}->{'args'} = ['code', 'normal']; + + because `---', `--', `''' and ```' should be kept as is in the + first argument of `@email'. + + The default is `['normal']'. + +`attribute' + If the associated value is a word, it is considered to be an HTML + element name, and the argument is enclosed between the element + opening and the element closing. For example, if the value is + `elem', the resulting HTML is `<elem>ARG</elem>'. + + If the text is a word followed by some text, the word and is + interpreted as above, and the text is considered to be the + attributes text of the element. Thus `elem class="elem"' leads to + `<elem class="elem">ARG</elem>'. + + This works only if there is only one argument. + +`begin' + The associated value is added in front of the text. + +`begin' + The associated value is added after the text. + +`quotes' + If the corresponding value is true, the result is enclosed in + quotes `$OPEN_QUOTE_SYMBOL' and `$CLOSE_QUOTE_SYMBOL', with + defaults ``' and `''. + +`function' + The corresponding value should be a function reference. The + corresponding function is called with the following arguments: + + `$command' + The @-command name + + `$args' + A reference on an array containing the arguments of the + @-command. + + `$style_stack' + A reference on an array containing the name of the @-commands + containing the @-command being formatted. + + `$state' + A reference on a hash containing a lot of informations about + the context of the @-command. + + `$line_nr' + An opaque structure containing the information about the line + number of the @-command. It can be used to call + `main::echo_error' or `main::echo_warning' with first + argument a message, and second argument `$line_nr'. + + +File: texi2html.info, Node: String interface, Next: Define your own interface, Prev: Hash reference interface, Up: Style and accent commands + +An interface for commands formatting with a string +-------------------------------------------------- + + The keys of the hashes are the command names. The value determine +how the command argument is formatted. If the value begins with `"', +the result is enclosed in quotes `$OPEN_QUOTE_SYMBOL' and +`$CLOSE_QUOTE_SYMBOL', with defaults ``' and `''. + + The command argument is allready formatted as HTML. The remaining +of the value text (or the value text if there were no `"') is +interpreted as follow: + + * If the text is empty the argument of the command is left as is. + + * If the text is a `&' followed by a name, like `&function', the + name is considered to be a function name, and this function is + called to format the argument of the command. The first argument + of the function is the command name, the second is the command + argument. For example, if the value associated with the + (fictituous) command `@foo' is `&my_func' and we have: + + sub my_func + { + my @args = split /,\s*/ $_[1]; + return "$_[0]: $args[0]" if ($args[1] = 1); + return "$args[0]"; + } + + The result of + @foo{truc, 1} + @foo{truc, bidule} + will be + foo: truc + truc + + * If the text is a word, it is considered to be an HTML element + name, and the argument is enclosed between the element opening and + the element closing. For example, if the value is `elem', the + resulting HTML is `<elem>ARG</elem>'. Similarly `"quoted' leads to + ``<quoted>ARG</quoted>''. + + * If the text is a word followed by some text, the word and is + interpreted as above, and the text is considered to be the + attributes text of the element. Thus `elem class="elem"' leads to + `<elem class="elem">ARG</elem>'. + + +File: texi2html.info, Node: Define your own interface, Prev: String interface, Up: Style and accent commands + +Defining the style and indicatric commands interface +---------------------------------------------------- + + If you don't like this scheme, it is possible to change how those +commands are processed by redefining the following function reference: + + - Function Reference: $resulting_text style $style $command $text + $args $no_close $no_open $line_nr $state $style_stack + $COMMAND is the @-command, $STYLE is the value associated with the + $COMMAND in the `%style_map', `%style_map_pre' or + `%style_map_texi' hashes. The $TEXT is the text appearing within + the @-command braces. ARGS is a reference on an array contening + the command arguments formatted according to the same conventions + than with the reference hash style (provided the value associated + with the @-command is a hash reference with a $ARG key as + described in *Note Reference hash args::). If $TEXT is split in + paragraphs each paragraph is passed through the function, and + $NO_CLOSE is true if it is not the last paragraph, while $NO_OPEN + is true if it is not the first paragraph. $LINE_NR is an opaque + structure containing the information about the line number of the + @-command. It can be used to call `main::echo_error' or + `main::echo_warning' with first argument a message, and second + argument `$line_nr'. $STATE is a reference on a hash containing a + lot of informations about the context of the @-command. + $STYLE_STACK is a reference on an array containing the name of the + @-commands containing the @-command being formatted. + + + +File: texi2html.info, Node: Anchors images and spaces, Next: Text, Prev: Style and accent commands, Up: Customizing HTML + +Formatting of special simple commands +===================================== + + The formatting of special simple commands is controlled by +functions. To customize the output, the corresponding function +references should be redefined. All these functions return a formatted +text. + + The formatting of anchors is controlled by `$anchor', but the +function associated with the function reference does more, it is usefull +to produce a reference target or link. + + - Function Reference: $anchor anchor $identifier $href $text + $attributes + If $IDENTIFIER is not empty, this value should be used to create a + target for links (typically associated with a name or id attribute + in HTML). The $HREF argument specifies a hpertextual reference + which should be used to link to a target. In case both + $IDENTIFIER and $HREF are given the text produced should be both + a target for $IDENTIFIER and a link to $HREF. $TEXT is the text + to be displayed. $ATTRIBUTES are additional attributes. It + should be reasonable to assume that the attributes are for a `<a>' + HTML element. + + The formatting of `@image' is controlled by: + + - Function Reference: $image image $file_path $basename $preformatted + $file_name + $FILE_PATH is the image file name with the path, $BASENAME is the + alternate text or the file name without extension if no alternate + text is given. $PREFORMATTED is true if the image appears in + preformatted text. $FILE_NAME is the file name without path but + with extension. + + The formatting of `@sp' is controlled by: + + - Function Reference: $sp sp $number $preformatted + $NUMBER is the numeric argument of `@sp'. $PREFORMATTED is true + if the `@sp' appears in preformatted text. + + The formatting of `@acronym' and `@abbr' is controlled by: + + - Function Reference: $acronym acronym_like $acronym_texi + $acronym_text $with_explanation \@explanation_lines + $explanation_text $explanation_simply_formatted + $ACRONYM_TEXI is the acronym argument with texinfo @-commands, + $ACRONYM_TEXT is formatted. + + The other arguments are related with the explanation, the second + arg of the acronym. $WITH_EXPLANATION is true if the second + argument of the acronym command is present. If an explanation + exists, coming from previous `@acronym' or as an arg of this + command, the other args are defined: \@EXPLANATION_LINES is a + reference on an array containing the unformatted explanation lines, + $EXPLANATION_TEXT is the explanation text formatted, + $EXPLANATION_SIMPLY_FORMATTED is the explanation with a light + formatting, unabling in HTML (or XML) the explanation to be in an + attribute. + + +File: texi2html.info, Node: Text, Next: Strings, Prev: Anchors images and spaces, Up: Customizing HTML + +Processing special characters in text +===================================== + + Some characters are processed especially in text: `---', `--', ```' +and `'''. This is done only if in normal text and not in some commands +(`@code', `@env'...). A function reference is called to process those +characters in text + + - Function Reference: $processed_text normal_text $text + The function processes `---', `--', ```' and `''' in $TEXT and + returns $PROCESSED_TEXT. The default is to change `---' to `--', + `--' to `-', and ```' and `''' to `"'. + + Some characters are special in HTML (`&', `"', `<' and `>') and +should be protected. This is done by the function associated with the +function reference + + - Function Reference: $protected_text protect_text $text + The function processes the unprotected text $TEXT and returns the + resulting protected text $PROTECTED_TEXT. + + Empty lines are processed by the following function reference, which +could be usefull if empty lines are to be removed for example + + - Function Reference: $resulting_text empty_line $empty_line + This function processes an $EMPTY_LINE and returns the resulting + text $RESULTING_TEXT. Empty lines are left as is by default. + + +File: texi2html.info, Node: Strings, Next: References, Prev: Text, Up: Customizing HTML + +Customizing strings written by `texi2html' +========================================== + + `texi2html' writes some strings in the generated document at various +places, at the page footers, on the help page, for special section +headings, buttons alt text and so on. These strings are customizable. +The string chosen depends on the language of the document (set by +`--lang', `$LANG' or `@documentlanguage'). This is the basis for +internationalization as it allows for strings translations. + + The strings are found in a hash reference, `$LANGUAGES'. Each key +is a language code. The associated value is also a hash reference. The +key is an english string and the associated value is the string +replacing the english string, if present. For example, we have + + $LANGUAGES->{'fr'} = { + ' Up ' => 'Plus haut', + }; + + It means that whenever the string ` Up ' is to be written and the +language is `fr', `Plus haut' is written. It is possible to customize +the english strings by redefining the `en' language hash. + + When a string contains a `%' followed by `{' NAME `}' it means that +the string will be expanded by `texi2html'. For example, if we have + + $LANGUAGES->{'fr'} = { + 'See %{node_file_href}' => 'Voir %{node_file_href}', + }; + + `%{node_file_href}' will be expanded to an href for a node in a file +by `texi2html' in the string. A `%%' will be expanded as `%'. + + For more on internationalization, see *Note Internationalization::. + + +File: texi2html.info, Node: References, Next: Alignement commands, Prev: Strings, Up: Customizing HTML + +References +========== + +* Menu: + +* Reference to external manual:: +* Internal reference:: + + +File: texi2html.info, Node: Reference to external manual, Next: Internal reference, Up: References + +Reference to external manual +---------------------------- + + The references are produced with two function references, one for the +hypertextual reference construction, the other for the full reference to +external manual. + + - Function Reference: $href external_href $node $node_identifier + $xml_node_identifier $manual_file_name + $NODE is the node name, with @-commands. $NODE_IDENTIFER is the + node name mapped to an identifier acceptable as a file name. + $XML_NODE_IDENTIFIER is the node name mapped to an identifier + acceptable as an XML identifier. Those identifiers are built as + explained in *Note HTML Xref: (texinfo)HTML Xref, thus allowing + for cross references to external manuals. $FILE is the manual or + file name of the external reference. This function should return an + href leading to the external manual. + + The default for this function is to make a reference compatible + with `makeinfo' (*note HTML Xref: (texinfo)HTML Xref.). + + - Function Reference: $text external_ref $command $section $book + $node_and_file $href $cross_ref_name + This function formats a reference to an external texinfo manual. + The $COMMAND is the ref command (`ref', `xref' or `pxref', in + text, at sentence beginning or in parenthesis). The optionnal + $SECTION argument is the section in the book and BOOK is the book + title. $NODE_AND_FILE is the node and file name formatted + according to the convention used in info: `(file)node'. $HREF it + an hypertextual reference to the distant manual constructed using + the above function. $CROSS_REF_NAME is an optionnal cross + reference name appearing in the reference command. This function + returns the text corresponding with the external html manual + reference. This function returns the full formatted text of the + external reference. + + +File: texi2html.info, Node: Internal reference, Prev: Reference to external manual, Up: References + +Reference to an internal node +----------------------------- + + A function reference is available for internal references. + + - Function Reference: $text internal_ref $command $href $short_name + $name $is_section + This function formats a reference to a node in the current manual. + The $COMMAND is the ref command (`ref', `xref' or `pxref', in + text, at sentence beginning or in parenthesis). $HREF it an + hypertextual reference linking to the corresponding node or + section. $SHORT_NAME and $NAME hold the text for the reference but + $SHORT_NAME can be the node name which is assumed to be shorter + than the section name. $IS_SECTION is a boolean true if the + reference is a reference to a section. This function returns the + full formatted text of the internal reference. + + +File: texi2html.info, Node: Alignement commands, Next: Paragraph and preformatted region, Prev: References, Up: Customizing HTML + +Commands used for centering and flushing of text +================================================ + + When a command controlling the alignement of text is used (`@center', +`@flushleft' and `@flushright'), the main program takes care of opening +and closing paragraphs. The alignement commands are the key of the +`%paragraph_style' hash. The value is used in the function doing the +formatting of the paragraphs. *Note Paragraph and preformatted +region::. + + A function references allows for a customization of the formatting +of the text appearing in the command block. + + - Function Reference: $result paragraph_style_command $command $text + $COMMAND is the command name, $TEXT is the text appearing within + the command. This function returns a formatted text. The default + is to return the text unmodified. + + +File: texi2html.info, Node: Paragraph and preformatted region, Next: Complex formats, Prev: Alignement commands, Up: Customizing HTML + +Formatting or not a paragraph or a preformatted region +====================================================== + +* Menu: + +* Paragraph and preformatted formatting:: +* Avoiding paragraphs:: + + +File: texi2html.info, Node: Paragraph and preformatted formatting, Next: Avoiding paragraphs, Up: Paragraph and preformatted region + +Paragraph and preformatted region formatting +-------------------------------------------- + + The formatting of a paragraph region or a preformatted region, is +controlled by function references: + + - Function Reference: $paragraph_text paragraph $text $alignement + $formatting_command $formatting_command_formatted + \$paragraph_number $format $item_number $enumerate_style + $number + This function formats a paragraph. $TEXT is the text of the + paragraph, $ALIGNEMENT is the empty string when no alignement + command has been seen, otherwise it is the current alignement + command name. *Note Alignement commands::. + + The remaining arguments are usefull when the paragraph appears + within a list or table. It is usefull whenever the paragraph has + to be formatted differently when appearing in such environments. + Moreover in that case the format command (`@itemize'...) may have + an associated formatting command. $FORMATTING_COMMAND is this + formatting command (like `@minus'). $FORMATTING_COMMAND_FORMATTED + is the command formatted in html in case the formatting command is + a leading command (like `@minus') which should be leading the + first paragraph. \$PARAGRAPH_NUMBER is a reference on the number + of paragraphs in that format command. The corresponding variable + should be increased when a paragraph is added. $FORMAT is the + format command. *Note Table and list items::. + + If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of the + item in the list, $ENUMERATE_STYLE is the argument of the + enumerate, $NUMBER is the number or letter corresponding with this + item. + + - Function Reference: $preformatted_text preformatted $text $style + $region_name $formatting_command + $formatting_command_formatted \$preformatted_number $format + $item_number $enumerate_style $number + This function formats a preformatted region. $TEXT is the text of + the preformatted region, $STYLE is the css style associated with + that preformatted region (*Note css::). $REGION_NAME is the name + of the command opening the preformatted region (`example'..., see + *Note Complex formats::) or a identifier for the preformatted + context (for example `menu-comment', see *Note Menus::). The + alignment commands are not taken into account, as the spaces are + preserved in preformatted regions, you should flush and center by + hand. + + The remaining arguments are usefull when the preformatted region + appears within a list or table. It is usefull whenever the + preformatted region has to be formatted differently when appearing + in such environments. Moreover in that case the format command + (`@itemize'...) may have an associated formatting command. + $FORMATTING_COMMAND is this formatting command (like `@minus'). + $FORMATTING_COMMAND_FORMATTED is the command formatted in html in + case the formatting command is a leading command (like `@minus') + which should be leading the first preformatted region. + \$PREFORMATTED_NUMBER is a reference on the number of preformatted + regions in that format command. The corresponding variable should + be increased when a preformatted region is added. $FORMAT is the + format command. *Note Table and list items::. + + If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of the + item in the list, $ENUMERATE_STYLE is the argument of the + enumerate, $NUMBER is the number or letter corresponding with this + item. + + +File: texi2html.info, Node: Avoiding paragraphs, Prev: Paragraph and preformatted formatting, Up: Paragraph and preformatted region + +Avoiding paragraphs in formats +------------------------------ + + It is possible to avoid that a format closes the previous paragraph +or preformatted region and reopens one, by putting the format command +in a hash, `%format_in_paragraph' with a true value. + + +File: texi2html.info, Node: Complex formats, Next: Lists tables, Prev: Paragraph and preformatted region, Up: Customizing HTML + +Formatting of complex formats (`@example', `@display'...) +========================================================= + + Here we see how a whole complex format is formatted. For the +formatting of the text, see *Note Paragraph and preformatted region::. + + The formatting of the complex formats is ultimately controlled by a +function, however the default for this function uses a hash reference +and changing the hash reference values should be enough in most cases. +This hash reference is called `$complex_format_map'. It has a key for +each of the complex format commands (`example', `smallexample', `lisp', +`smalllisp', `display', `smalldisplay', `format', `smallformat'). + + The associated value is also a reference on a hash. The keys are +`begin' and `end'. An eval of `begin' should lead to the beginning of +the formatted HTML, an eval of `end' should lead to the end of the +formatted HTML. The enclosed text will be formatted as described in +*Note Paragraph and preformatted region::, and the name of the complex +format will be available to the function formatting the text. + + If you aren't satisfied with this scheme, you can redefine the +following function reference for a better control over the complex +format formatting: + + - Function Reference: $complex_format_text complex_format $format_name + $preformatted_text + $FORMAT_NAME is the complex format name, $PREFORMATTED_TEXT is the + text allready formatted as described in *Note Paragraph and + preformatted region::. This function returns the whole complex + format. + + +File: texi2html.info, Node: Lists tables, Next: Definitions, Prev: Complex formats, Up: Customizing HTML + +Customizing the formatting of lists and tables +============================================== + + The formatting of lists and tables is done at two levels: + * At the level of the whole region (table or list), + + * At the level of the individual items, rows or cells of the list or + table. + +* Menu: + +* Table and list items:: +* Whole table list:: + + +File: texi2html.info, Node: Table and list items, Next: Whole table list, Up: Lists tables + +Formatting individual table and list items +------------------------------------------ + + In texinfo it is possible to give `@itemize' or table command +(hereafter called a "format command") a "formatting command". For +example `@minus' is the formatting command here: + @table @minus + + The default is to apply the command to the text item, however it is +possible to avoid it. The hash `%special_list_commands' has an entry +for each of the format command. Each of these entries is a hash +reference. If a formatting command is a key of the hash reference, then +the formatting command is not applied to the text item for that format +command. For example, if we have: + + $special_list_commands{'itemize'} = { 'bullet' => '' }; + + and we have the following `@itemize': + @itemize @bullet + @item an item + @end itemize + + then `@bullet' will not be applied to `an item'. + +_lists_ + The items of lists are formatted using the following function + reference: + + - Function Reference: $list_item list_item $text $format $command + $formatted_command $item_number $enumerate_style $number + This function formats the text between `@item' commands. $TEXT + is the text corresponding with the item. $FORMAT is the type + of format, `itemize' or `enumerate'. $COMMAND is the + formatting command given in argument to `@itemize', + $FORMATTED_COMMAND is this command formatted if it is a + leading command, like `@minus'. + + If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of + the item in the list, $ENUMERATE_STYLE is the argument of the + enumerate, $NUMBER is the number or letter corresponding with + this item. + +_two column tables_ + The two columns tables (`@table', `@ftable' and `@vtable'), items + are formatted using two function references, one for the first + line located on the `@item' line corresponding with the first + column, the other for the text appearing on the following lines, + corresponding with the second column text. + + - Function Reference: $table_item table_item $item_text + $index_label_text $format $command $formatted_command + This function is used to format the text on the `@item' line. + $TEXT_ITEM is the text line. In case there is an index entry + associated with the `@item' (as with `@ftable' and + `@vtable'), $INDEX_LABEL_TEXT is the text inserted at the + place where an index entry appears. *Note Index entry place::. + $FORMAT is the type of format, `table', `ftable' or `vtable'. + $COMMAND is the formatting command given in argument to the + table format command, $FORMATTED_COMMAND is this command + formatted if it is a leading command, like `@minus'. + + - Function Reference: $table_line table_line $text + This function is used to format the text on the lines + following the `@item' line. $TEXT is the corresponding text. + +_multitable_ + The multitable elements formatting is controlled by the functions + associated with two function references. One for a cell, and the + other for a row. + + - Function Reference: $multitable_cell cell $text + This function is used to format the text of a multitable + cell, the text following a `@item' or a `@tab'. $TEXT is the + corresponding text. + + - Function Reference: $multitable_row row $text $item_command + This function is used to format a multitable row. $TEXT is + the row text, with cells allready formatted with the `$cell' + function reference. $ITEM_COMMAND is the command used to + introduce the row, such that it is possible to distinguish + between `@item' and `@headitem'. + diff --git a/Build/source/utils/texi2html/doc/texi2html.info-3 b/Build/source/utils/texi2html/doc/texi2html.info-3 new file mode 100644 index 00000000000..29fade237c7 --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.info-3 @@ -0,0 +1,1085 @@ +This is texi2html.info, produced by makeinfo version 4.5 from +texi2html.texi. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. +INFO-DIR-SECTION Texinfo documentation system +START-INFO-DIR-ENTRY +* Texi2HTML: (texi2html). Texinfo to HTML Converter. +END-INFO-DIR-ENTRY + + This file, last updated 1 February 2005, documents the `texi2html' +script which converts Texinfo (http://www.texinfo.org) into HTML +(http://w3c.org). This edition is for `texi2html' version 1.76. + +Copyright (C) 1999, 2000, 2001, 2002, 2003 Free +Software Foundation, Inc. + +Portions +of +`texi2html' + Copyright (C) 1999, 2000 Lionel Cons + Copyright (C) 1999, 2000 Karl Berry + Copyright (C) 1999, 2000 Olaf Bachmann + Copyright (C) 2002, 2003 Patrice Dumas + Copyright (C) 2001, 2002, 2003 Derek Price + Copyright (C) many others. + + +Portions +of this +manual + Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) + Copyright (C) 2003 Patrice Dumas (manual) + Copyright (C) 2003 Derek Price (manual) + Permission is granted to make and distribute verbatim copies of this +manual provided the copyright notice and this permission notice are +preserved on all copies. + + Permission is granted to copy and distribute modified versions of +this manual under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. + + Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be stated in a +translation approved by the Free Software Foundation. + +File: texi2html.info, Node: Whole table list, Prev: Table and list items, Up: Lists tables + +Formatting of a whole table or list +----------------------------------- + + If the Texinfo command is a key of the `%format_map', the associated +value is used to specify the formatting of the construct, otherwise a +function is called. The value in `%format_map' associated with a +command is interpreted similarly with values associated with more +simpler commands: + + * If the text is a word, it is considered to be an HTML element + name, and the whole table or list is enclosed between the element + opening and the element closing. + + * If the text is a word followed by some text, the word and is + interpreted as above, and the text is considered to be the + attributes text of the element. + + * If the text is empty nothing is added to the text. + + In case the `%format_map' isn't used, a function reference called +`$table_list' should be redefined, the associated function will be +called each time a command isn't found in `%format_map'. + + - Function Reference: $whole_table_list table_list $command $text + $COMMAND is the Texinfo command name, $TEXT is the formatted items. + + If you still want to use `%format_map' but differently from the +default, it is possible to redefine the following function reference: + + - Function Reference: $whole_table_list format $command $format $text + $COMMAND is the @-command, $FORMAT is the entry associated with + $COMMAND in `%format_map'. $TEXT is the formatted items. + + +File: texi2html.info, Node: Definitions, Next: Headings, Prev: Lists tables, Up: Customizing HTML + +Definition commands formatting +============================== + + The formatting of definition commands is controlled by a hash and +four functions. The hash describes how the text on the definition line +is interpreted, the functions control the formatting of the definition +line and the definition function text. + +* Menu: + +* Definition line:: +* Definition formatting:: + + +File: texi2html.info, Node: Definition line, Next: Definition formatting, Up: Definitions + +Customizing the interpretation of a definition line +--------------------------------------------------- + + The keys of the hash `%def_map' are definition command names. There +are two types of entries: + + * If the command is a shortcut for another definition command the + value is a text and the definition command is replaced by the text. + + For example if we have: + $def_map{'deftruc'} = '@defvr {A truc}'; + + and a line like + @deftruc var + + the line will be transformed in + @defvr {A truc} var + + * If the command isn't a shortcut, it is associated with an array + reference. The first element is `f', `v' or `t' corresponding with + the index type (`f' for function, `v' for variable, `t' for type). + + The remaining of the array describes how to interpret the text + following the definition command on the definition command line. + The entry item specify what corresponds with the next bracketed + item or word. Currently the possibilities are `category', `name', + `type', `class' and `arg'. + + For example if we have + def_map{'defvr'} = [ 'v', 'category', 'name' ]; + + The first bracketed item following `@defvr' is considered to be + the category and the next one is the name. The index associated + with the definition line is the variables index. + + +File: texi2html.info, Node: Definition formatting, Prev: Definition line, Up: Definitions + +Customization of the definition formatting +------------------------------------------ + + Four functions are used when formatting a definition command: + +category name + - Function Reference: $category definition_category + $category_or_name $class $style + This function precise a category or an index entry name + associating a class $CLASS (if given) with $CATEGORY_OR_NAME. + The $STYLE of the definition may be `f', for function, `v', + for variable or `t', for type. + +formatting of the definition line + - Function Reference: $line def_line $category $name $type + $arguments $index_label + This function formats the definition line. $CATEGORY is the + category formatted with `$definition_category', $NAME, $TYPE + and ARGUMENTS are the element of the definition line. + $INDEX_LABEL is the text inserted at the place where an index + entry appears. *Note Index entry place::. + +definition text + - Function Reference: $definition_text def_item $text + This function formats the definition text, $TEXT. + +the whole definition + - Function Reference: $definition def $text + This function formats the whole definition. The definition + line and text formatted by the above functions are in $TEXT. + + + +File: texi2html.info, Node: Headings, Next: Special regions, Prev: Definitions, Up: Customizing HTML + +Customizing headings formatting +=============================== + + A function controls the formatting of sectioning element headings, +with the corresponding function reference: + + - Function Reference: $heading_text heading \%element_reference + The \%ELEMENT_REFERENCE is a reference on a hash corresponding + with the sectioning element. The following keys are of interest: + `text' + The heading text + + `name' + The heading text without section number + + `node' + true if the sectioning element is a node without associated + structuring command + + `level' + The level of the element in the document tree. `0' is for + `@top', `1' for `@chapter' and so on + + `tag_level' + the sectioning element name, with `@raisesections' and + `@lowersections' taken into account + + +File: texi2html.info, Node: Special regions, Next: Menus, Prev: Headings, Up: Customizing HTML + +Formatting of special regions (`@verbatim', `@cartouche', `@quotation') +======================================================================= + + Regions corresponding with raw text, like `@verbatim', `@html' or +`@tex' are formatted according to the following function reference: + + - Function Reference: $raw_region raw $command $text + $COMMAND is the command name, $TEXT is the raw text. + + If LaTeX2HTML is used, `@tex' regions are handled differently, from +within the main program. + + The `@cartouche' command formatting is controlled by the function +reference: + + - Function Reference: $cartouche cartouche $text + $TEXT is the text appearing within the cartouche. + + The formatting of `@quotation' is controlled by two function +references. The first one is usefull in case the `@quotation' has an +argument, as it allows to prepend a string to the quotation text: + + - Function Reference: $prepended_string quotation_prepend_text $style + $text + $STYLE is the first argument of the `@quotation' if there are two + arguments. $TEXT is the second argument or the first if there is + one argument. There are still @-commands in these strings. This + function can return a string which will be prepended to the + quotation text. + + The whole quotation is formatted by: + + - Function Reference: $quotation quotation $quotation_text + $argument_text $argument_style_texi $argument_style_id + $QUOTATION_TEXT is the quotation text, formatted, with the text + prepended by the function above. $ARGUMENT_TEXT is the second + argument of the `@quotation' or the first if there is one + argument, formatted. The other arguments are defiend if there are + two arguments for the `@quotation', $ARGUMENT_STYLE_TEXI is this + argument, with @-commands, and $ARGUMENT_STYLE_ID is this + argument transformed in an identifier which can be used as an XML + identifier. + + +File: texi2html.info, Node: Menus, Next: Indices, Prev: Special regions, Up: Customizing HTML + +Menu formatting +=============== + + To understand how the formatting of menus is controlled, the +different parts of a menu are first described, then how to control the +formatting of each of these parts. + +* Menu: + +* Menu parts:: A menu consists in menu entry and menu + comments +* Menu formatting:: + + +File: texi2html.info, Node: Menu parts, Next: Menu formatting, Up: Menus + +The structure of a menu +----------------------- + + In `texi2html', a menu is considered to be composed of 2 parts, the +"menu entries" and the "menu comments". Menu entries are further +divided in an "entry link" and optionnaly an "entry description". The +entry link consists in a node name and an optionnal menu entry name. + + A menu entry begins with `*' at the beginning of the line. It begins +with the entry link, followed by the description. The description spans +until the next menu entry, or some text begining at the first character +of a line or an empty line, not contained within a command block which +begun in the description. An empty line or a line with text at the +first character starts a menu comment, which spans until the next menu +entry. + + Here is an illustration of these rules: + + @menu + * node name: entry name. description begins + description continues + * another menu entry:: + description begins + description continues + + A menu comment, after an empty line + + * node:: description begins + A menu comment. The line starts at the first character + + * last entry:: description begins _text + of the description, even if the line begins at the first character, + because we are in @emph_. + @end menu + + +File: texi2html.info, Node: Menu formatting, Prev: Menu parts, Up: Menus + +The formatting of the different menu components +----------------------------------------------- + + In the default case, the name of the section corresponding with the +node is used instead of the node name. If `$NODE_NAME_IN_MENU' is true, +however, node names are used. If `$AVOID_MENU_REDUNDANCY' is true and +menu entry equal menu description the description isn't printed. This +is the default. Likewise, if node or section name equal entry name, do +not print entry name. + + A symbol, `$MENU_SYMBOL' is put at the beginning of menu entries +when the node name is used. The default is `•'. If +`$UNNUMBERED_SYMBOL_IN_MENU' is true it is also put at the beginning of +unnumbered section names. This is not done by default. + + The menu comments are considered to be preformatted text. The style +associated with this preformatted text is determined by +`$MENU_PRE_STYLE'. Default is `font-family: serif'. The css class +associated with menu comments is `menu-comments'. + + Three function references are associated with the formatting of the +different parts of a menu: + + - Function Reference: $link menu_link $section \%state $href $node + $name $ending + $SECTION is the section name corresponding with the link, $HREF is + the link hypertextual reference. $HREF may be absent. \%STATE + holds informations about the current context. The only key which + could be of interest is `preformatted', true if the context is a + preformatted context. *Note Three contexts::. $NODE is the node + name, $NAME is the name of the node, and $ENDING is the text + ending the link entry. + + - Function Reference: $description menu_description $description_text + \%state + $DESCRIPTION_TEXT is the text of the menu description. \%STATE + should be used similarly than for the menu link. + + - Function Reference: $menu_comment menu_comment $text + $TEXT is the text of the menu comment. It is in a preformatted + environment. + + The following function reference controls the formatting of a wole +menu: + + - Function Reference: $menu menu $menu_components_text + $MENU_COMPONENTS_TEXT is the formatted menu components text, + obtained as explained above. + + The last function reference corresponds with a special case. It is +used when a menu entry appears within another block command, to avoid +the possibilities of invalid HTML production. In that case the menu +description and menu comments are not formatted specially, but treated +like normal text. + + - Function Reference: $link simple_menu_link $link_text $href $node + $name $ending + $LINK_TEXT is the text corresponding with the link name, $HREF is + the link hypertextual reference. $NODE is the node name, $NAME is + the name of the node, and $ENDING is the text ending the link + entry. + + +File: texi2html.info, Node: Indices, Next: Floats and lists of floats, Prev: Menus, Up: Customizing HTML + +Indices formatting +================== + + Two different things needs to be handled for indices formatting, the +place where the index term appears, the index entry, and the index list +itself. The indexing commands like `@cindex' determines where index +entries appear, and the index list is printed with a `@printindex' +command. + +* Menu: + +* Index entry place:: Index entries in the main document are + targets for hypertext references +* Index list:: Customizing the formatting of the index list + + +File: texi2html.info, Node: Index entry place, Next: Index list, Up: Indices + +Formatting of index entries +--------------------------- + + Index entry places in the main text may be the target for hypertext +references. Their formatting is controlled by the function associated +with the following function reference: + + - Function Reference: $target index_entry_label $identifier + $preformatted + $IDENTIFIER should be used to create a target for links (typically + associated with a name or id attribute in HTML). $PREFORMATTED is + true if the index entry appeared in preformatted text. + + +File: texi2html.info, Node: Index list, Prev: Index entry place, Up: Indices + +Customizing the formatting of index lists +----------------------------------------- + + The index entries are sorted alphabetically. A whole index list is +considered to be composed of letter entries. A letter entry is composed +by all the index entries beginning with that letter. A letter may be a +non alphabetical character, but we call it letter here. + + An index summary appears at the beginning and at the end of an index +list, and should be used to jump directly to a letter entry. Indices +lists may be split across pages, thus the different letters may appear +on different files. The number of index entries appearing on each page +is determined by a variable `$SPLIT_INDEX' if set. The default is to +split indices after 100 entries. + + The formatting of all these elements is controlled by the following +function references: + +_formatting of a letter in a summary_ + - Function Reference: $letter summary_letter $letter $file + $identifier + This function is used to format a letter appearing in a + summary, refering to a letter entry in the index list. + $LETTER is the letter. $FILE is the file name where the letter + entry appears. More precisely, it is empty when the letter + entry is on the same page than the summary, it contains the + file name when the index page is split accross page. + $IDENTIFIER is an identifier for the target letter entry. + +_formatting of a summary_ + - Function Reference: $summary index_summary + \@alphabetical_letters \@nonalphabetical_letters + \@ALPHABETICAL_LETTERS and \@NONALPHABETICAL_LETTERS contain + the formatted summary letters, formatted with the above + function. + +_formatting of an index entry_ + - Function Reference: $entry index_entry $entry_href $entry_text + $section_href $section_heading + $ENTRY_HREF is a reference to the place where the index entry + appeared, $ENTRY_TEXT is the corresponding text. $SECTION_HREF + is a reference to the beginning of the sectioning element + containing the index entry, $SECTION_HEADING is the heading + of the element. + +_formatting of letter entry_ + - Function Reference: $letter_entry index_letter $letter + $identifier $index_entries_text + This function formats a letter entry, consisting in all the + index entries beginning with this letter. $LETTER is the + letter, $IDENTIFIER should be used to create a target for + links (typically links from summaries), and + $INDEX_ENTRIES_TEXT is the text of the index entries + formatted as described above. + +_formatting of whole index_ + - Function Reference: $index print_index $index_text $index_name + $INDEX_TEXT is the text of all the index entries grouped by + letter appearing in that page formatted as above. INDEX_NAME + is the name of the index, the argument of `@printindex'. + + +File: texi2html.info, Node: Floats and lists of floats, Next: Footnotes, Prev: Indices, Up: Customizing HTML + +Floats and lists of floats +========================== + + Floats appear in the `@float' environment, optionaly with a style +and a label, and with optionnal `@caption' and `@shortcaption'. Their +list appear after a `@listoffloats'. + + A hash reference is associated with each float, it is available in +some formatting functions. The keys are: +`caption_texi' +`shortcaption_texi' + A reference on an array containing the caption or shortcaption + lines, unformatted. + +`style_texi' + The style with texi @-commands. + +`style_id' + The unique identifier associated with the style. + +`nr' + The number with the same conventions than makeinfo (use the + chapter number a dot and then the number of the float of that + style in the chapter, or an absolute number if in unnumbered). + +`chapter_nr' + The number of the chapter containing the float. + +`nr_in_chapter' + The number of the float in the chapter. + +`absolut_nr' + The number of the float in the document. + +`texi' + The label with @-commands. + +`id' + The unique identifier associated with the label. Usefull to make + an anchor or a reference. + +`element' + A reference on a structure representing the element the float + appear in. + +* Menu: + +* Floats:: Formatting of floats +* Lists of floats:: Formatting the lists of floats + + +File: texi2html.info, Node: Floats, Next: Lists of floats, Up: Floats and lists of floats + +Formatting a float +------------------ + + First there is an occasion to construct a texinfo text for the +caption, using the caption texinfo lines and the informations in the +float structure. The returned lines will be formatted in the main +program. A function reference is used here: + + - Function Reference: (\@caption_lines_returned, +\@shortcaption_lines_returned) caption_shortcaption \%float + \@caption_lines \@shortcaption_lines + \%FLOAT is the structure defined above. \@CAPTION_LINES and + \@SHORTCAPTION_LINES are references on arrays containing the + texinfo lines for caption and short caption. + \@CAPTION_LINES_RETURNED and \@SHORTCAPTION_LINES_RETURNED are + references on an array containing the texinfo lines for the + caption and shortcaption. + + Then the float is formatted with the following function reference: + + - Function Reference: $text float $float_text \%float $caption_text + $shortcaption_text + $FLOAT_TEXT is the text appearing within the `@float', formatted. + \%FLOAT is still the structure defined above. $CAPTION_TEXT and + $SHORTCAPTION_TEXT are the caption and short caption build with the + above function and formatted. + + +File: texi2html.info, Node: Lists of floats, Prev: Floats, Up: Floats and lists of floats + +Formatting lists of floats +-------------------------- + + A list of floats is introduced by `@listoffloats'. The argument of +`@listoffloats' is the "style". First the style texinfo can be modified +with the following function reference: + + - Function Reference: $style_texi_returned listoffloats_style + $style_texi + $STYLE_TEXI is the `@listoffloats' argument with texinfo + @-commands kept. It is possible to make changes to the $STYLE_TEXI + and return a modified string, still with @-commands. The modified + string is formatted in the main program. + + After that, for each of the floats with that style, first there is a +possibility to modify the float style and the float caption before they +are formatted in the main program, with the following function +references: + + - Function Reference: $float_style_texi_returned +listoffloats_float_style $style_texi \%float + $STYLE_TEXI is the style, and \%FLOAT is the structure described + above. This function reference returns a style to be formatted in + the main program. + + - Function Reference: $caption_texi_returned listoffloats_caption + \%float + \%FLOAT is the structure described above. This function reference + returns a caption to be formatted in the main program. + + Each entry is formatted by: + + - Function Reference: $listoffloats_entry listoffloats_entry + $style_texi \%float $float_style $caption $href + $STYLE_TEXI is the style with @-commands, $FLOAT_STYLE is the + style returned by the above function and formatted. $CAPTION is the + caption returned by the above function formatted. \%FLOAT is the + structure corresponding with the float, and $HREF is an href + pointing to the float location. + + Lastly, the whole `@listoffloats' is formatted by: + + - Function Reference: $listoffloats listoffloats $style_texi $style + \@listoffloats_entries + $STYLE_TEXI is the style with @-commands, $STYLE is the style + returned by the above function and formatted. The array reference + \@LISTOFFLOATS_ENTRIES holds the entries formatted by the above + function. + + +File: texi2html.info, Node: Footnotes, Next: Other and unknown commands, Prev: Floats and lists of floats, Up: Customizing HTML + +Customizing the footnotes formatting +==================================== + + Each footnote is associated with a footnote entry. Several footnote +entries are grouped in a footnote section. When a footnote appears, two +things must be formatted: in the main text the place where the footnote +appear and the footnote text. + + Two functions, with corresponding function references control the +formatting of the footnotes: + + - Function Reference: (\@lines $text_for_document) foot_line_and_ref + $number_in_doc $number_in_page $footnote_id $place_id + $document_file $footnote_file \@lines \%state + $NUMBER_IN_DOC is the footnote number in the whole document, + $NUMBER_IN_PAGE is the footnote number in the current page. + $FOOTNOTE_ID is an identifier for the footnote in the footnote text + which should be used to make target for references to that + footnote, while $PLACE_ID is an identifier for the location of the + footnote in the main document. Similarly, $DOCUMENT_FILE is the + file name of the file containing the text where the footnote + appears in the main document, while $FOOTNOTE_FILE is the file + name of the file where the footnote text appears. + + \@LINES is a reference on an array containing the footnote text + lines, allready formatted. And \%STATE holds informations about + the context at the footnote place in the main document. As usual + the most usefull entry is `preformatted' which is true if the + footnote appears in a preformatted context. + + This function returns a reference on an array, \@LINES containing + the updated footnote text for the footnote entry, and + $TEXT_FOR_DOCUMENT, the text appearing at the footnote place in + the main document, linking to the footnote entry. + + The following function is only used when footnotes are at the bottom +of a page and the document is split. For customization of the +footnotes page in case they are on a separated page or section, *Note +Special pages layout::. For the determination of the footnote +locations, *Note Page layout options::. + + - Function Reference: foot_section \@footnotes_lines + This function formats a group of footnotes. \@FOOTNOTES_LINES is a + reference on an array holding the lines of all the footnote entries + formatted as explained above. This function modifies the reference. + + +File: texi2html.info, Node: Other and unknown commands, Prev: Footnotes, Up: Customizing HTML + +Customizing other commands, and unknown commands +================================================ + + Many commands without braces are available in texinfo, sometimes with +a specific syntax. For example we have `@sp', `@noindent', +`@documentlanguage', `@oddheading', `@headings', `@shortcontents', +`@shorttitlepage' or `@comment'. `texi2html' interprets some of these +commands and some functions or variables are used for their formatting +or to access their information. In the default case, however, most of +these constructs are ignored. + + It is possible to change how the things following these commands on +the line are handled, what is considered to be an arg for those +commands and it is also possible to keep them instead of discarding +them such that it is possible to handle them specially, with the same +function than the one used for unknown commands. + + Those special commands without braces are the key of a hash: +`%misc_command'. The associated value is a reference on a hash enabling +to set the properties of these commands. The keys of this hash +reference is the name of a property, the value is the value of the +property. For example here we have `line' for the `arg' property for +the `command' @-command. + + $misc_command{'command'} = {'arg' => 'line', 'skip' => 'space'}; + + The properties and possible values are: + +`skip' + This property enables to set what is skipped after the command + arguments. Here are the possible values: + `line' + The remaining of the line is skipped. + + `space' + Spaces are skipped but not newline. + + `whitespace' + Spaces are skipped + + `linewhitespace' + Spaces are skipped if there are only spaces remaining on the + line. + + `linespace' + Spaces are skipped, but not newline if there are only spaces + remaining on the line + +`arg' + If the associated value is `line' the line is considered to be the + argument. If it is a number it is the number of args (separated by + spaces). + +`texi' + If true the arguments are considered to real texinfo, therefore + `@value' and `@macro' are expanded. + +`keep' + If true the args and the macro are kept, otherwise they are + discarded. The defaut is to have `keep' undef for all the + commands. If `keep' is true for `@verbatiminclude' the default + action for this macro isn't done. + + Commands which don't appear in the hashes `%simple_map', +`%simple_map_pre', `%simple_map_texi' and `%misc_command', or that +appear in `%misc_command' but with `keep' true are processed by the +following function reference: + + - Function Reference: ($result_line, $result, $result_text, $message) +unknown $command $line + $COMMAND is the @-command, $LINE is the line following the + $COMMAND. $RESULT is a boolean. If it is true then the other return + values are taken into account otherwise the default actions are + used. In case $RESULT is true, $RESULT_LINE is the new line to be + processed further, $RESULT_TEXT is the resulting formatted text + and $MESSAGE, if defined is a message outputted to the output with + line number added by `texi2html'. + + Commands with braces not specified above nor in `%style_map', +`%style_map_pre' and `%style_map_texi' are processed by the following +function reference + + - Function Reference: ($result, $result_text, $message) unknown_style + $command $text + $COMMAND is the @-command, $TEXT is the text appearing within the + braces (allready formatted). $RESULT is a boolean. If it is true + then the other return values are taken into account otherwise the + default actions are used. In case $RESULT is true, $RESULT_TEXT is + the resulting formatted text and $MESSAGE, if defined is a message + outputted to the output with line number added by `texi2html'. + + +File: texi2html.info, Node: Internationalization, Next: Indexop, Prev: Customizing HTML, Up: Top + +Internationalization +******************** + + The strings written in the document are selected based on the +document language. This can be used to customize the strings, as +described in *Note Strings::. This also enables translation of the +strings. + +* Menu: + +* Translating strings:: +* Adding new strings:: + + +File: texi2html.info, Node: Translating strings, Next: Adding new strings, Up: Internationalization + +Translating strings +=================== + + If the language is allready supported, then there will be a file in +the `i18n' directory with name the two-letter ISO-639 language code. In +that case you can enhance the translations by editing this file. There +is a `$LANGUAGES->{'LANGUAGE'}' hash in that file. The keys are the +english strings, in `''', the values (in `''' after `=>') are the +translations. When a string contains a `%' followed by `{' NAME `}' it +means that the string will be expanded by `texi2html'. For an example, +see *Note Strings::. + + After that you should run the command `./manage_i18n.pl all' in the +top directory, it should merge your file with the existing files in +`translations.pl', which is incorporated to the `texi2html' script by +`./configure'. + + If the language isn't currently supported, copy the `en' file in +`i18n' to a file with name the two-letter ISO-639 language code of your +language and then add your translations to the strings. You could also +add your two-letter language code in the `manage_i18n.pl' file in the +`@known_languages' array. + + After that you should similarly run the command `./manage_i18n.pl +all' in the top directory. + + Obsoleted strings are not removed from the files, they are still +present in the `$T2H_OBSOLETE_STRINGS->{'LANGUAGE'}' hash in case the +string is reused later. + + If you made change to strings specified in installed files (*note +Installation::) you will have to reinstall them otherwise the +installated files will take precedence (*note Using init files::). + + +File: texi2html.info, Node: Adding new strings, Prev: Translating strings, Up: Internationalization + +Adding new strings written to document +====================================== + + If you need to write strings, for example the new string A STRING to +the resulting document, call `&$I('a string')'. Use simple quotes. If +you want to substitute a value in the string put `%{STRING_VALUE}', in +the string, and give a second argument to `&$I', a hash reference with +key STRING_VALUE and value the what you want to substitute. Here is an +example: + + return &$I('%{name} of %{class}', { 'name' => $name, 'class' => $class }); + + In that case `%{name}' is substituted by `$name' in the translated +string. + + After that you should run the command `./manage_i18n.pl all' in the +top directory, it should add your new strings to all the files in the +`i18n' directory. + + +File: texi2html.info, Node: Indexop, Next: Indexvr, Prev: Internationalization, Up: Top + +Command Line Option Index +************************* + +* Menu: + +* css-include=FILE: Style options. +* def-table: Style options. +* doctype=DTD: Style options. +* DVAR: Texinfo related options. +* frames: Page layout options. +* frameset-doctype: Style options. +* frameset-doctype=DTD: Style options. +* html-xref-prefix=PATH: Style options. +* IDIR: Texinfo related options. +* if<region>: Expansion. +* include-css: css. +* init-file: Using init files. +* iso: Style options. +* l2h: Expanding TeX regions. +* l2h-file: Expanding TeX regions. +* l2h-l2h=PROGRAM: Expanding TeX regions. +* l2h-tmp: Expanding TeX regions. +* lang <1>: Strings. +* lang: Using init files. +* lang=LANG: Texinfo related options. +* menu: Invoking texi2html. +* no-if<region>: Expansion. +* node-files: Output files. +* nomenu <1>: Expansion. +* nomenu: Invoking texi2html. +* nosec-nav: Page layout options. +* number: Style options. +* output: Output files. +* PDIR: Texinfo related options. +* pkgdatadir=dir: Using init files. +* pkgdatadir=DIR: Installation. +* prefix: Output files. +* separated-footnotes: Page layout options. +* short-ext: Output files. +* short-ref: Style options. +* split: Splitting output. +* sysconfdir=dir: Using init files. +* toc-file: Output files. +* toc-links: Style options. +* top-file: Output files. +* use-nodes: Splitting output. +* UVAR: Texinfo related options. + + +File: texi2html.info, Node: Indexvr, Next: Indexcp, Prev: Indexop, Up: Top + +Variable Index +************** + +* Menu: + +* $AFTER_BODY_OPEN: Customizing header. +* $AFTER_OVERVIEW: Contents and Overview text. +* $AFTER_TOC_LINES: Contents and Overview text. +* $anchor <1>: Anchors images and spaces. +* $anchor: Redefining functions. +* $AVOID_MENU_REDUNDANCY: Menu formatting. +* $BEFORE_OVERVIEW: Contents and Overview text. +* $BEFORE_TOC_LINES: Contents and Overview text. +* $BIG_RULE: The page layout. +* $BODYTEXT <1>: Customizing header. +* $BODYTEXT: Output initialization. +* $cell: Table and list items. +* $CLOSE_QUOTE_SYMBOL <1>: String interface. +* $CLOSE_QUOTE_SYMBOL: Hash reference interface. +* $complex_format_map: Complex formats. +* $CSS_LINES: css. +* $DEF_TABLE: Style options. +* $DEFAULT_RULE: The page layout. +* $definition_category: Definition formatting. +* $DO_CONTENTS: Contents and Overview text. +* $DO_SCONTENTS: Contents and Overview text. +* $DOCTYPE: Style options. +* $DOCUMENT_DESCRIPTION: Customizing header. +* $DOCUMENT_ENCODING: Customizing header. +* $ENCODING: Customizing header. +* $EXTENSION: File names. +* $EXTERNAL_DIR: Style options. +* $EXTRA_HEAD: Customizing header. +* $FRAMES: Page layout options. +* $FRAMESET_DOCTYPE: Style options. +* $ICONS: General purpose variables. +* $IDX_SUMMARY: External index files. +* $INDEX_CHAPTER: The page layout. +* $L2H_L2H: Expanding TeX regions. +* $L2H_TMP: Expanding TeX regions. +* $LANG <1>: Strings. +* $LANG <2>: Using init files. +* $LANG: Texinfo related options. +* $LANGUAGES <1>: Translating strings. +* $LANGUAGES: Strings. +* $MENU_PRE_STYLE: Menu formatting. +* $MENU_SYMBOL: Menu formatting. +* $MIDDLE_RULE: The page layout. +* $NODE_FILES <1>: File names. +* $NODE_FILES: Output files. +* $NODE_NAME_IN_MENU: Menu formatting. +* $NUMBER_SECTIONS: Style options. +* $OPEN_QUOTE_SYMBOL <1>: String interface. +* $OPEN_QUOTE_SYMBOL: Hash reference interface. +* $OUT: Output files. +* $PRE_BODY_CLOSE: Customizing footer. +* $PREFIX: Output files. +* $print_chapter_footer: Customizing footer. +* $print_chapter_header: Customizing header. +* $print_foot_navigation: Customizing footer. +* $print_head_navigation: Customizing header. +* $print_misc: Special pages layout. +* $print_misc_footer: Special pages layout. +* $print_misc_header: Special pages layout. +* $print_page_foot: Customizing footer. +* $print_page_head: Customizing header. +* $print_section_footer: Customizing footer. +* $print_section_header: Customizing header. +* $print_Top: Special pages layout. +* $print_Top_footer: Special pages layout. +* $print_Top_header: Special pages layout. +* $SECTION_NAVIGATION <1>: General purpose variables. +* $SECTION_NAVIGATION: Page layout options. +* $SEPARATED_FOOTNOTES: Page layout options. +* $SHORT_REF: Style options. +* $SHORTEXTN: Output files. +* $SHOW_MENU: Expansion. +* $SMALL_RULE: The page layout. +* $SPLIT: Splitting output. +* $SPLIT_INDEX: Index list. +* $T2H_OBSOLETE_STRINGS: Translating strings. +* $Texi2HTML::NODE{Next}: Button specifications. +* $Texi2HTML::OVERVIEW <1>: Contents and Overview text. +* $Texi2HTML::OVERVIEW: Global informations. +* $Texi2HTML::THIS_HEADER: Global informations. +* $Texi2HTML::THIS_SECTION <1>: Global functions. +* $Texi2HTML::THIS_SECTION: Global informations. +* $Texi2HTML::TOC_LINES <1>: Contents and Overview text. +* $Texi2HTML::TOC_LINES: Global informations. +* $TOC_FILE: Output files. +* $TOC_LINKS: Style options. +* $TOC_LIST_ATTRIBUTE: Contents and Overview text. +* $TOC_LIST_STYLE: Contents and Overview text. +* $TOP_FILE: Output files. +* $TOP_HEADING: The page layout. +* $UNNUMBERED_SYMBOL_IN_MENU: Menu formatting. +* $USE_ISO: Style options. +* $USE_NODES: Splitting output. +* $VERTICAL_HEAD_NAVIGATION: General purpose variables. +* $WORDS_IN_PAGE <1>: Global functions. +* $WORDS_IN_PAGE: Button specifications. +* %accent_map: Style and accent commands. +* %ACTIVE_ICONS: Button specifications. +* %BUTTONS_GOTO: Output initialization. +* %css_map: css. +* %def_map: Definition line. +* %format_in_paragraph: Avoiding paragraphs. +* %format_map: Whole table list. +* %main::value: Global informations. +* %misc_command: Other and unknown commands. +* %NAVIGATION_TEXT <1>: Output initialization. +* %NAVIGATION_TEXT: Button specifications. +* %paragraph_style: Alignement commands. +* %PASSIVE_ICONS: Button specifications. +* %pre_map: Commands without argument. +* %simple_map <1>: Other and unknown commands. +* %simple_map: Commands without argument. +* %simple_map_pre <1>: Other and unknown commands. +* %simple_map_pre: Commands without argument. +* %simple_map_texi <1>: Other and unknown commands. +* %simple_map_texi: Commands without argument. +* %special_list_commands: Table and list items. +* %style_map <1>: Other and unknown commands. +* %style_map: Style and accent commands. +* %style_map_pre <1>: Other and unknown commands. +* %style_map_pre: Style and accent commands. +* %style_map_texi <1>: Other and unknown commands. +* %style_map_texi: Style and accent commands. +* %Texi2HTML::HREF: Elements hashes. +* %Texi2HTML::NAME: Elements hashes. +* %Texi2HTML::NO_TEXI: Elements hashes. +* %Texi2HTML::NODE: Elements hashes. +* %Texi2HTML::THISDOC: Global informations. +* %texi_map: Commands without argument. +* %things_map: Commands without argument. +* @CHAPTER_BUTTONS: Button specifications. +* @CSS_FILES: Style options. +* @EXPAND: Expansion. +* @INCLUDE_DIRS: Texinfo related options. +* @MISC_BUTTONS: Button specifications. +* @NODE_FOOTER_BUTTONS: Button specifications. +* @PREPEND_DIRS: Texinfo related options. +* @SECTION_BUTTONS: Button specifications. +* @SECTION_FOOTER_BUTTONS: Button specifications. + + +File: texi2html.info, Node: Indexcp, Prev: Indexvr, Up: Top + +Concept Index +************* + +* Menu: + +* Avoid paragraph opening: Avoiding paragraphs. +* bug report: Top. +* centering: Alignement commands. +* complex format: Complex formats. +* Config: Using init files. +* configure: Installation. +* downloading texi2html source: Obtaining texi2html. +* examples of manuals: Overview. +* external manual: Reference to external manual. +* flushing text: Alignement commands. +* i18n <1>: Translating strings. +* i18n: Strings. +* Installation: Installation. +* internationalization: Using init files. +* internationalized strings: Adding new strings. +* makeinfo: whytexi2html. +* manage_i18n.pl: Adding new strings. +* paragraph: Paragraph and preformatted formatting. +* preformatted region: Paragraph and preformatted formatting. +* reference: References. +* skipped command: Other and unknown commands. +* source code for texi2html, downloading: Obtaining texi2html. +* texi2html source, downloading: Obtaining texi2html. +* Texinfo: Overview. +* text alignement: Alignement commands. +* Translation: Translating strings. +* unknown command: Other and unknown commands. + + diff --git a/Build/source/utils/texi2html/doc/texi2html.texi b/Build/source/utils/texi2html/doc/texi2html.texi new file mode 100644 index 00000000000..b4e2662badb --- /dev/null +++ b/Build/source/utils/texi2html/doc/texi2html.texi @@ -0,0 +1,3426 @@ +\input texinfo @c -*-texinfo-*- +@c This is the ``Texinfo to HTML Converter'' manual which +@c which is part of the ``texi2html'' distribution. +@setfilename texi2html.info + +@c @macro copyleftnotice +@copying +Copyright @copyright{} 1999, 2000, 2001, 2002, 2003 + Free Software Foundation, Inc. + +@multitable @columnfractions .12 .88 +@item Portions of @command{texi2html} +@item @tab Copyright @copyright{} 1999, 2000 Lionel Cons@* +@item @tab Copyright @copyright{} 1999, 2000 Karl Berry@* +@item @tab Copyright @copyright{} 1999, 2000 Olaf Bachmann@* +@item @tab Copyright @copyright{} 2002, 2003 Patrice Dumas@* +@item @tab Copyright @copyright{} 2001, 2002, 2003 Derek Price@* +@item @tab Copyright @copyright{} many others.@* +@item @tab +@item @tab +@item Portions of this manual +@item @tab Copyright @copyright{} 1999, 2000 Karl Heinz Marbaise (manual)@* +@item @tab Copyright @copyright{} 2003 Patrice Dumas (manual)@* +@item @tab Copyright @copyright{} 2003 Derek Price (manual)@* +@end multitable + +Permission is granted to make and distribute verbatim +copies of this manual provided the copyright notice and +this permission notice are preserved on all copies. + +@ignore +Permission is granted to process this file through TeX and +print the results, provided the printed document carries +copying permission notice identical to this one except for +the removal of this paragraph (this paragraph not being +relevant to the printed manual). + +@end ignore +Permission is granted to copy and distribute modified +versions of this manual under the conditions for verbatim +copying, provided that the entire resulting derived work is +distributed under the terms of a permission notice +identical to this one. + +Permission is granted to copy and distribute translations +of this manual into another language, under the above +conditions for modified versions, except that this +permission notice may be stated in a translation approved +by the Free Software Foundation. +@end copying +@c @end macro + +@c -------------------------------------------------------- +@c This file is part of the Texi2HTML distribution. +@c +@c Texi2HTML is free software; you can redistribute it +@c and/or modify it under the terms of the GNU General Public +@c License as published by the Free Software Foundation; +@c either version 2 of the License, or (at your option) any +@c later version. +@c +@c Texi2HTML is distributed in the hope that it will be +@c useful, but WITHOUT ANY WARRANTY; without even the implied +@c warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +@c PURPOSE. See the GNU General Public License for more +@c details. +@c +@c You should have received a copy of the GNU General +@c Public License along with this program; if not, write to +@c the Free Software Foundation, Inc., 59 Temple Place, Suite +@c 330, Boston, MA 02111-1307 USA +@c +@c Author: +@c Karl Heinz Marbaise <khmarbaise@gmx.de> +@c Patrice Dumas +@c Derek Price +@c -------------------------------------------------------- + +@c -------------------------------------------------------- +@c Get the version of the script and the last update time +@c of this manual. +@c +@c version.texi is automatically generated through +@c configure/autoconf. +@include version.texi +@c -------------------------------------------------------- + +@c -------------------------------------------------------- +@c Define an index for command line options +@defindex op + +@c Define some macros which affect markup and add to the +@c index simultaneously. +@macro longopt {arg} +@opindex \arg\ +@option{--\arg\} +@end macro + +@macro shortopt {arg} +@opindex \arg\ +@option{-\arg\} +@end macro + +@macro variable {arg} +@vindex \arg\ +@code{\arg\} +@end macro +@c -------------------------------------------------------- + +@settitle Texi2HTML -- Texinfo to HTML v@value{VERSION} +@setchapternewpage odd +@footnotestyle separate +@ifset shorttitlepage-enabled +@shorttitlepage Texi2HTML -- Texinfo to HTML v@value{VERSION} +@end ifset + +@c -------------------------------------------------------- +@c support old style Info Dir entries. +@ifset OLDSTYLE-INFO-DIR +@ifinfo +@format +START-INFO-DIR-ENTRY +* Texi2HTML: (texi2html). Texinfo 2 HTML Converter (texi2html). +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ifset +@c -------------------------------------------------------- +@c Informations for install-info. +@c I think the conversion script should be found +@c where the documentation system lives. +@c What do you think? +@dircategory Texinfo documentation system +@direntry +* Texi2HTML: (texi2html). Texinfo to HTML Converter. +@end direntry +@c -------------------------------------------------------- + +@ifnottex +@ifnothtml +This file, last updated @value{UPDATED}, documents the @command{texi2html} +script which converts @uref{http://www.texinfo.org,Texinfo} into +@uref{http://w3c.org,HTML}. This edition is for @command{texi2html} version +@value{VERSION}. +@end ifnothtml + +@c @copyleftnotice +@insertcopying +@end ifnottex +@c -------------------------------------------------------- +@titlepage +@title Texi2HTML -- Texinfo to HTML v@value{VERSION} +@subtitle Last Update: @value{UPDATED} +@subtitle for Version @value{VERSION} of the @command{texi2html} script. +@author Lionel Cons +@author Karl Berry +@author Olaf Bachmann +@author Patrice Dumas +@author Derek Price +@author and many others. +@author Karl Heinz Marbaise (manual) +@author Patrice Dumas (manual) +@author Derek Price (manual) +@page +@vskip 0pt plus 1filll +@c @copyleftnotice +@insertcopying +@end titlepage + +@comment ======================================================== +@comment The real text starts here. +@comment ======================================================== + +@summarycontents +@contents + +@ifnottex +@c ======================================================== +@node Top +@top Texi2HTML + +@cindex bug report + +This manual, last updated @value{UPDATED}, describes version @value{VERSION} +of the @command{texi2html} Perl script which converts +@c The following construct allows me to get +@c real URL link in HTML and working refs in +@c info. +@c +@c pertusus: support for html cross manual now +@c exists in texi2html, but it implies having Texinfo's +@c HTML manual at the right place, which isn't usually the case. +@c The resulting ref is also less pretty in info. +@ifnotinfo +@uref{http://www.texinfo.org,Texinfo} into @uref{http://w3c.org,HTML}. +@end ifnotinfo +@ifinfo +Texinfo (@pxref{Top,,Texinfo,Texinfo}) into @acronym{HTML}. +@end ifinfo + +Please send bug reports concerning this manual to the Texi2HTML user +discussion list @email{user@@texi2html.cvshome.org}. Please state the exact +version of the manual which contains the bug, as given above. + +@ifinfo +@c @copyleftnotice +@insertcopying +@end ifinfo + +@example +@strong{This manual is currently under construction and of course incomplete. ;-)} +@end example + +@menu +@c * MenuName:NodeName. Description +* Overview:: +* Obtaining texi2html:: + Obtaining a copy of the @command{texi2html} + source code distribution +* Installation:: Installing @command{texi2html} +* Invoking texi2html:: Description of the command line options +* Initialization files:: What kind of variables and subroutines appear + in init files and how they are called +* Changing the page layout:: Fine tuning of the page layout +* Customizing HTML:: Fine tuning of the @acronym{HTML} elements + associated with the texinfo constructs +* Internationalization:: Help translating ! +* Indexop:: Command Line Option Index +* Indexvr:: Variable Index +* Indexcp:: Concept Index + +@end menu +@end ifnottex +@c ======================================================== +@node Overview +@chapter Overview + +@cindex Texinfo +@cindex examples of manuals + +@uref{http://www.texinfo.org,Texinfo} is the official +documentation format of the @uref{http://www.gnu.org,GNU} +project. It uses a single source file to produce both +online information and printed output. + +It is often desirable to have a way to produce +@acronym{HTML} from Texinfo sources, as GNU-Info files are +produced. It is much simpler to run a converter than it is to +rewrite all the documentation in @acronym{HTML}, especially +considering that there is so much Texinfo documentation in +the world. + +Some time ago @command{makeinfo} wasn't able to produce +@acronym{HTML} output format, but people still wanted documentation in +@acronym{HTML}. This was the birthing hour for +@command{texi2html}. The basic purpose of @command{texi2html} +is to convert Texinfo documents into @acronym{HTML}. + +Since then, @acronym{HTML} support in @command{makeinfo} has improved, but +@command{texi2html} is still stronger in many areas, including the degree to +which it allows customization. With @command{texi2html}, some important +aspects of the resulting @acronym{HTML} files may be specified via command +line options, and configuration files provide an even finer degree of control +over the final output, allowing most every aspect of the final output not +specified in the Texinfo input file to be specified. Configuration files are +written in @command{perl}, like the main program, and anything which may be +specified on the command line may also be specified within a configuration +file. + +For an example of the kind of pages @command{texi2html} is capable of +producing, have a look at the following sites: +@uref{http://www.singular.uni-kl.de/Manual/html/,the Singular Manual}, +@uref{http://ccvs.cvshome.org/docs/manual,the Cederqvist (CVS Manual)}. + +@menu +* whytexi2html:: Why @command{texi2html} and not @command{makeinfo}?. +@end menu +@c -------------------------------------------------------- + +@node whytexi2html +@section Why @command{texi2html} and not @command{makeinfo}? + +@cindex makeinfo + +You would like to produce @acronym{HTML} files from your existing Texinfo +files? There are two programs you can use to do this. The first is +@command{makeinfo} (@pxref{Generating HTML,,,texinfo}). +The second is @command{texi2html}. + +The design goal of @command{makeinfo}'s @acronym{HTML} output was to produce +readable @acronym{HTML} output. It is now possible to use @acronym{CSS} +for @acronym{HTML} customization. Another possibility is to use intermediate +formats, like docbook or @command{mekeinfo} @acronym{XML} +and @acronym{XSL} stylesheets to customize the resulting document. Still the +output produced by @command{makeinfo} isn't customizable. + +The current development of @command{texi2html} tries to +provide for producing the more interesting and sophisticated @acronym{HTML} +pages that today's Internet users have come to expect. +The goal behind @command{texi2html} is to generate attractive @acronym{HTML} by +default but also to allow users considerable freedom to affect the final +style and design of the output @acronym{HTML} pages. This is achieved via +command line options and flexible configuration files. + +@c The main disadvantage of @command{makeinfo}'s +@c @acronym{HTML} output is that it is only available as one big file. +@c This is of course readable but not very usable. This would be hard to +@c remedy in @command{makeinfo}, as the Texinfo source has to be read in at +@c least twice to implement split nodes. This would require a major +@c rewrite of the @command{makeinfo} source. + +@c think more about this???? +In contrast to the @acronym{HTML} produced by @command{makeinfo --html} (the +@command{makeinfo} program is part of the Texinfo distribution), the +@command{texi2html} program, among other differences, allows for the +customization of the entire page layout, including headers, footers, style +sheets, etc., allows for customization of the low level @acronym{HTML} +formatting, provides for splitting documents at various levels, and provides +for using the @command{latex2html} program to convert @code{@@tex} sections of +the Texinfo source. + +The focus on @acronym{HTML} is still present but with the help of the +customization files it is now possible to use @command{texi2html} to +produce other formats as well. @command{texi2html} may for example be +turned into a texinfo to roff translator with the help of a customization file +provided with the distribution. + +@command{texi2html} should reasonably convert all Texinfo +4.8 constructs. If you find it does not, please send a bug report to the +@email{users@@texi2html.cvshome.org} email list. + +@c ======================================================== +@node Obtaining texi2html +@chapter Obtaining @command{texi2html} +@cindex downloading @command{texi2html} source +@cindex @command{texi2html} source, downloading +@cindex source code for @command{texi2html}, downloading + +The latest version of the source code for @command{texi2html} should be +available from @uref{http://texi2html.cvshome.org,texi2html.cvshome.org}. + +@c ======================================================== +@node Installation +@chapter Installation of @command{texi2html} +@cindex Installation +@cindex configure + +To install @command{texi2html}, you must first obtain a copy of the +source distribution. @xref{Obtaining texi2html}. + +@command{texi2html} also requires @command{perl} version +5.004 or above. The current version has not been tested +extensively on versions of @command{perl} below 5.6, however. + +@command{texi2html} is a standard Automake-based distribution. +If you have a source version, you should run @command{./configure} +to regenerate the executable @file{texi2html} file. @command{./configure} +accepts options to select the installation directory for the @file{texi2html} +file, the default directories @command{texi2html} will use to look for +configuration files, and other details. Run @command{./configure --help} for +more information. + +Running @command{./configure} combines four files into the final +@file{texi2html} program file: +@itemize +@item @file{texi2html.pl} contains the base program, +@item @file{MySimple.pm} handles the command line options, +@item @file{texi2html.init} is the default configuration file, and +@item @file{T2h_i18n.pm} is used for internationalization. +@item @file{translations.pl} contains the translations of the strings used in +documents. +@end itemize + +Running @command{./configure} also builds the @command{make} configuration +files (@file{Makefile}s). To make the documentation run @command{make}. + +@command{make install} performs the installation to the locations specified to +the @command{./configure} script. This usually involves placing the actual +@file{texi2html} file someplace in your path, such as @file{/usr/local/bin} or +@file{/usr/bin}. + +Installing @command{texi2html} in your path should be sufficient +to run it. To use default initialization files, or a configuration file for +La@TeX{}2HTML when using @command{latex2html} to convert @code{@@tex} sections +(@pxref{Expanding TeX regions}), install them in the package data directory +specified to configure. This is @file{/usr/local/share/texi2html/} by default, +but depends on the value of the @longopt{pkgdatadir=@var{dir}} option passed to +the @command{./configure} script. Files used for strings customization and +internationalization are also searched for in the @file{i18n} directory +of this directory. @xref{Using init files} for more. + +@c ======================================================== +@node Invoking texi2html +@chapter Invoking @command{texi2html} + +To produce an @acronym{HTML} manual, run @command{texi2html} with a Texinfo +file as an argument. For example, this manual is created with: + +@example +$ texi2html texi2html.texi +@end example + +The behaviour of @command{texi2html} may be changed with command line +options. These command line options are always associated with corresponding +@command{perl} variables which may appear in init files, and these +variables are presented in this chapter each time a switch is described. + +Boolean command line switches always have a corresponding negated switch, +obtained by prepending @samp{no} or @samp{no-} to the switch name. For example +@c PAT maybe it should be better to have @option{--nomenu} and @option{--menu} +@c as it is not needed and maybe harmfull to have an index entry for these +@c options here +@longopt{nomenu} does the reverse of @longopt{menu}. + +@menu +* Splitting output:: The @acronym{HTML} output may be split at + different levels +* Output files:: +* Expansion:: +* Texinfo related options:: +* Page layout options:: Customizing page layout +* Style options:: Customizing the @acronym{HTML} and text style +* Expanding TeX regions:: +* Using init files:: Specifying initialization files for fine tuning +@end menu + +@c -------------------------------------------------------- +@node Splitting output +@section Specifying where to split the generated document + +The @acronym{HTML} manual resulting from the processing of the Texinfo source +may be split into files at different levels. This is specified with the +option @longopt{split} which takes an argument, namely the level of splitting +(variable: @variable{$SPLIT}). This level may be: + +@table @asis +@item @samp{chapter} +The document is split at @code{@@chapter}, @code{@@appendix}, or @code{@@unnumbered}. +@item @samp{section} +The document is split at the same places as it is using the @samp{chapter} +argument, and also at @code{@@section}, @code{@@appendixsec} or +@code{@@unnumberedsec}. +@item @samp{node} +The document is split at every sectioning command. It is not necessarily +split at each node, if the @code{@@node} structure doesn't correspond with +the sectioning command structure (see below). +@item @samp{none} +The document isn't split. This is the default. +@end table + +There are two kinds of commands which may be used to define sectioning +elements in Texinfo: @code{@@node} and the structuring commands (@code{@@top}, +@code{@@section}, @code{@@appendixsubsec}, and so on). A node just preceding +a structuring command is considered to be part of the same sectioning element +as that command. If the @code{@@node Top} isn't associated with a structuring +command it also defines a sectioning element. + +By default, nodes which aren't associated with a structuring command are not +considered to be sectioning commands. They are always considered to be part +of a sectioning element defined by a structuring command. It is possible to +change this behaviour via the @longopt{use-nodes} option (variable +@variable{$USE_NODES}). In this case, nodes not associated with structuring +commands are also considered to be sectioning commands defining a sectioning +element. + +This default behaviour mimics @command{texi2dvi} behaviour, which ignores +@code{@@node} commands for the purprose of sectioning, while the second +looks like @command{makeinfo} behaviour (@pxref{Two Paths,,, texinfo}). + +As an illustration, the following table shows how a sample Texinfo document is +divided into sectioning elements when @longopt{use-nodes} is used and not: + +@multitable @columnfractions .2 .1 .2 .1 .2 +@item Texinfo code +@tab +@tab +default case +@tab +@tab +with @longopt{use-nodes} +@item +@* +@* +@example +@@node node1 +@@chapter node 1 +node1 text + +@@node node2 +node2 text + +@@node node3 +node3 text +@@chapter node 3 +chapter text +@end example +@tab +@tab +first element: + +@example +@@node node1 +@@chapter node 1 +node1 text + +@@node node2 +node2 text +@end example + +second element: + +@example +@@node node3 +node3 text +@@chapter node 3 +chapter text +@end example + +@tab +@tab +first element: + +@example +@@node node1 +@@chapter node 1 +node1 text +@end example + +second element: + +@example +@@node node2 +node2 text +@end example + +third element: + +@example +@@node node3 +node3 text +@@chapter node 3 +chapter text +@end example + +@end multitable + +@c -------------------------------------------------------- +@node Output files +@section Setting output file and directory names + +The manual name is constructed by stripping the @samp{.texi}, +@samp{.txi}, @samp{.texinfo}, or @samp{.txinfo} extension from the Texinfo file +name. + +By default, @command{texi2html} generates the manual file in the current +directory if the manual isn't split. A @samp{.html} file extension is appended +to the manual name. + +If the manual is split the files are put in a directory named after the +manual name. The file name is constructed using the manual name as basename. +An underscore followed by a number is appended +to the basename for each files corresponding with sectioning elements, with the +exception of the top element. For the top element there nothing appended. +The files containing special elements pages +have an underscore and a 3 letter code corresponding to their content +(@samp{toc} for table of contents, @samp{abt} for about, @samp{ovr} for +overview) appended. Lastly, an @samp{.html} file extension is appended. + +Thus, if the texinfo file @file{afile.texi} is processed and split at chapters +into 3 files, the generated files (in directory @file{afile}) will be: + +@example +afile.html --> @code{@@node Top} or @code{@@top} section +afile_1.html --> Chapter 1 +afile_2.html --> Chapter 2 +afile_toc.html --> Table of Contents +afile_abt.html --> About Page +@end example + +This default behavior may be modified by several command line options. If the +output isn't split, the prefix file name may be overrided by the +@longopt{output} command line option (variable @variable{$OUT}). If the output +is split, and @longopt{output} is set, the files are placed in the directory +specified by the argument to the option. + +The basename may be overridden with @longopt{prefix} (variable +@variable{$PREFIX}). If @longopt{short-ext} is given, @samp{.htm} is appended +instead of @samp{.html} in the final step (variable @variable{$SHORTEXTN}). +The @longopt{top-file} option +overrides the top element file name (variable @variable{$TOP_FILE}). This can +be used to name the top element file @samp{index.html}. Similarly, +@longopt{toc-file} changes the name of the table of contents file (variable +@variable{$TOC_FILE}). + +Reusing the example above, but this time calling @command{texi2html} like so: + +@example +$ texi2html -split chapter -prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi +@end example + +we get, in @file{manual}: + +@example +index.htm --> @code{@@node Top} or @code{@@top} section +manual_1.htm --> Chapter 1 +manual_2.htm --> Chapter 2 +contents.htm --> Table of Contents +manual_abt.htm --> About Page +@end example + +The file names generated by @command{texi2html} differ from those generated +by @command{makeinfo}. @command{makeinfo} uses the node name to construct +the file names while splitting at nodes. It is possible to get the same +behaviour out of @command{texi2html} by specifying the +@longopt{node-files} option (variable @variable{$NODE_FILES}). If the output +isn't split at nodes, @command{texi2html} will still output files named after +the nodes, without real content but redirecting to the right file. +The default is false for this option. +@c Is this true? It wasn't in the last version. -DRP +This trick enables the generated @acronym{HTML} manual to be a +target for the cross-references of other manuals generated by +@command{makeinfo} or @command{texi2html}. + +@c -------------------------------------------------------- +@node Expansion +@section Specifying which regions get expanded + +The default for @command{texi2html} is to expand the @code{@@ifhtml}, +@code{@@html}, and @code{@@menu} regions, all the @code{@@ifnot} regions +except @code{@@ifnothtml}, and no other @code{@@if} regions. + +It is possible to expand other regions by setting @longopt{if<region>}, +where @samp{<region>} is replaced by the literal name of the region (for +example, @samp{--iftex}). Symetrically, if @longopt{no-if<region>} is +specified, the @samp{<region>} region is ignored. The configuration file +array, @variable{@@EXPAND}, holds the names of regions which should be +expanded. The only region name present in @code{@@EXPAND} in the default case +is @samp{html}. + +If @longopt{nomenu} is set, the @code{@@menu} sections are not expanded +(variable @variable{$SHOW_MENU}). The default is to expand @code{@@menu} +sections. +@c How is --no-ifhtml specified? -DRP + +@c -------------------------------------------------------- +@node Texinfo related options +@section Command line options related to Texinfo language features + +Miscalleneous Texinfo related things may be specified via command line options. + +@table @asis +@item @longopt{lang=@var{lang}} +Sets the document language similar to the Texinfo directive, +@code{@@documentlanguage @var{lang}} (variable @variable{$LANG}). +The default is @samp{en}, that is, use the english language strings. +@item @shortopt{D@var{var}} +Sets @var{var}. Equivalent to, @code{@@set @var{var} 1}, in Texinfo. +@item @shortopt{U@var{var}} +Clears @var{var}. Equivalent to, @code{@@clear @var{var}}, in Texinfo. +@item @shortopt{P@var{dir}} +Prepend @var{dir} to the list of directories to search for +@code{@@include} files (the associated array is @variable{@@PREPEND_DIRS}, +empty in the default case). +@item @shortopt{I@var{dir}} +Append @var{dir} to the list of directories to search for +@code{@@include} files (the associated array is @variable{@@INCLUDE_DIRS}, +empty in the default case). +@end table + +The include files are always searched for in the current directory. + +@c -------------------------------------------------------- +@node Page layout options +@section Page layout related command line options + +If the @longopt{frames} option is specified, @acronym{HTML} frames +are used. A file describing the frame layout is generated, and the +document page is associated with a frame where the short table of +content appears (variable @variable{$FRAMES}). The default is not +to use frames. + +It is also possible to suppress the section navigation panel with +@longopt{nosec-nav} (variable @variable{$SECTION_NAVIGATION}, the default +is to output all the navigation panels), and to specify +whether footnotes should appear at the foot of the same page which contains +the reference to the note or on a separate page with +@longopt{separated-footnotes} (variable @variable{$SEPARATED_FOOTNOTES}). +The default is to have separated footnotes. + +@c -------------------------------------------------------- +@node Style options +@section Customizing the @acronym{HTML} and text style + +Miscalleneous style changes may be achieved with command line options. + +@table @asis +@item @longopt{doctype=@var{DTD}} +@itemx @longopt{frameset-doctype=@var{DTD}} +You can specify the document DTD by setting these options. +@longopt{frameset-doctype} applies to the file describing the frames when +frames are used (corresponding variables are @variable{$DOCTYPE} and +@variable{$FRAMESET_DOCTYPE}). + +The default for the document doctype is: +@example +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> +@end example +And for the frameset doctype: +@example +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd"> +@end example + +@item @longopt{iso} +If this option is set, ISO8859 entities are used for some special symbols, +like Copyright @copyright{} (variable @variable{$USE_ISO}). It is the default. + +@item @longopt{css-include=@var{file}} +This command line switch provides for the inclusion of an external +Cascading Style Sheet (@acronym{CSS}) file. More than one file may be +specified, and @samp{-} stands for the standard input (array +@variable{@@CSS_FILES}). + +The option use is the same than for @command{makeinfo} and is described +extensively in @ref{HTML CSS,,,texinfo}. +Briefly, the @acronym{CSS} @code{@@import} lines from the external file +@acronym{CSS} file are pasted before the +@c What does this mean? I don't think I clarified this one much. -DRP +@c Is it better ? -PAT +@command{texi2html} @acronym{CSS} rules, and the external file @acronym{CSS} +rules are pasted after the @command{texi2html} @acronym{CSS} rules. + +@item @longopt{html-xref-prefix=@var{path}} +This option sets the base directory for external @acronym{HTML} texinfo manuals +(variable @variable{$EXTERNAL_DIR}). Defaults to @samp{../}. + +@item @longopt{def-table} +If this option is set, @acronym{HTML} tables are used to format definition +commands, rather than @acronym{HTML} definition tables (variable +@variable{$DEF_TABLE}). Default is false. + +@item @longopt{short-ref} +If this option is set, cross-references are given without section numbers +(variable @variable{$SHORT_REF}). Default is false. + +@item @longopt{number} +If this option is set, sections are numbered (variable +@variable{$NUMBER_SECTIONS}). This is the default. + +@item @longopt{toc-links} +If this option is set, links from headings to @acronym{TOC} entries are +created (variable @variable{$TOC_LINKS}). Default is false. +@end table + +@c -------------------------------------------------------- +@node Expanding TeX regions +@section Expanding @code{@@tex} and @code{@@math} regions using La@TeX{}2HTML + +It is possible to use @uref{http://www.latex2html.org/,La@TeX{}2HTML} +to process @code{@@tex} regions and @code{@@math@{@}} commands. This is an +attractive way to display mathematical constructs in the @acronym{HTML} +manual. The @longopt{l2h} option activates this feature (variable +@var{$L2H}). It is usually desirable to expand @code{@@tex} sections when this +option is specified (@pxref{Expansion}). The default is not to use this +feature. + +The @longopt{l2h-l2h=@var{program}} option enables changing the name/location +of the La@TeX{}2HTML program processing @TeX{} regions (variable +@variable{$L2H_L2H}). The default is @command{latex2html}. + +@longopt{l2h-tmp} sets the directory used for temporary +files, this name shouldn't contain a dot @samp{.} +@c Why not? -DRP +(variable is @variable{$L2H_TMP}). Defaults to the current dir. + +The file specified by @longopt{l2h-file} is +used as La@TeX{}2HTML init file. It is searched at the same places than +init files (@pxref{Using init files}), and the default is @file{l2h.init}. + +@c -------------------------------------------------------- +@node Using init files +@section Use initialization files for fine tuning + +@cindex internationalization +@cindex @file{Config} + +Initialization variables are read first from +@file{/usr/local/share/texi2html/Config} (the exact location being +changeable with the @longopt{pkgdatadir=dir} option of the +@command{configure} script, see @ref{Installation}), +@file{/usr/local/etc/texi2html/Config} (the exact location being +changeable with the @longopt{sysconfdir=dir} option of the +@command{configure} script, see @ref{Installation}), from @file{./Config} +then from @file{$HOME/.texi2html/Config}. Any command-line option +can override the corresponding option set in init file, and the +option @longopt{init-file} specifies an init file to be loaded, with +later settings overriding earlier ones. + +The init files specified with @longopt{init-file} are searched +first in the current directory, then in the @file{$HOME/.texi2html/} +directory, in the @file{/usr/local/etc/texi2html/} directory and lastly +in the @file{/usr/local/share/texi2html/} directory. + +A file is also included based on the language selected, +by @variable{$LANG}, @longopt{lang} or @code{@@documentlanguage}. +If no language was selected @samp{en} is considered to be +the language. All the files with name the language name in +@file{/usr/local/share/texi2html/i18n/}, +@file{/usr/local/etc/texi2html/i18n/}, +@file{$HOME/.texi2html/i18n/} and then @file{./i18n/} are included. + +The default initialization options are defined in the +@file{texi2html.init} file contained in the @command{texi2html} +distribution (which gets included near the beginning of the +@command{texi2html} script that gets installed). + +To customize @command{texi2html} it is best if you copy the +appropriate sections from the @file{texi2html.init} +contents into an appropriate local initialization file, +make the necessary changes there, and then have +@command{texi2html} read this initialization file by one of +the means described above. + +@c ======================================================== +@node Initialization files +@chapter Overview of initialization files content and loading + +The initialization files are @command{perl} files, read as explained +in @ref{Using init files}. You don't need to know much of @command{perl} +to do some simple changes in variable values, however, to be able to +really take advantage of all the features of the initialization file, +a good knowledge of @command{perl} is required. + +In initialization file two kind of variables appear. These are normal +variables (including arrays and hashes) and references on functions. +The later permits the dynamic redefinition of functions used to produce +the @acronym{HTML} manual. You should be able to change the value of some +normal variables without a deep knowledge of @command{perl}, by looking +at the existing examples. The possible mistakes in that case could be +omitted @samp{;}, and bad quoting. + +Initialization file are loaded from the main program by +the mean of a @code{require}, while in the @code{Texi2HTML::Config} +namespace. This means that the namespace of the main program and +the namespace of inititalization files are distinct, which ensures +that no name clash should happen. The variables are declared with the +@code{our} specifier, such that it should be possible to use the +@code{use strict} pragma in the initialization file code. + +To avoid messing with the variables in the @code{main} namespace +all the global variables which could be of use in the init files +are in the @code{Texi2HTML} namespace. Notice that the functions +of the main program are still in the @code{main} namespace. + +@menu +* Redefining functions:: Function redefinition is achieved with + redefinition of references on functions. +* Function prototypes:: Conventions used in that manual for function + reference prototypes display. +@end menu + +@c -------------------------------------------------------- +@node Redefining functions +@section Redefining functions in initialization files + +To redefine a function you must replace the corresponding funtion +reference with a reference on your function. +Thus you should write your function, give it a name you +are certain it is unique in the @code{Texi2HTML::Config} namespace, +and override the value of the function reference with your own +function reference. When another function from the main program +(or from another functions of an initialization file) calls the reference, +your function will be used. + +For example the function +reference corresponding with the function called when doing an +anchor is called @variable{$anchor}. Thus if you want to override the +corresponding function +you could write: + +@example +# override the function reference +$anchor = \&my_own_function; + +# the function reference now refers to +sub my_own_function @{ +# process arguments and return an html anchor +@} +@end example + +@c -------------------------------------------------------- +@node Function prototypes +@section Conventions used for function prototypes + +As the functions are defined by a reference name, we will always +use the reference name in function prototypes. For the function arguments +we will use @code{\@@array} for a reference on an array and similarly +@code{\%hash} for a reference on a hash. + +Thus, the prototype for the function associated with the function +reference @samp{$formatting_function} will be: + +@deftypefn {Function Reference} $text formatting_function $arg1 \@@arg2 +@code{formatting_function} takes as first argument @var{$arg2}, +as second argument a reference on an array @var{\@@arg2} +and returns the formatted text @var{$text}. +@end deftypefn + +To redefined the corresponding function, you should write: + +@example +$formatting_function = \&my_formatting_function + +sub my_formatting_function($ $) +@{ + my $arg1 = shift; + my $arg2 = shift; + # prepare $formatted_text + ..... + return $formatted_text +@} +@end example + +@c -------------------------------------------------------- +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@c ======================================================== +@c @include custpage.texi +@node Changing the page layout +@chapter Fine tuning of the page layout + +Some features of the page layout might be specified with command line +options, the corresponding variables are described in +@ref{Page layout options}. +Fine tuning of the page layout may be achieved +with redefinition of other variables and function references in the +initialization files. + +@menu +* 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. +* Output initialization:: Setting variables before the document + production but after the texinfo parsing. +* Output finalization:: Cleaning after document generation. +* css:: Customizing css lines. +* Customizing header:: +* Customizing section:: +* Customizing footer:: +* Special pages:: Customizing table of contents, top, about page. +* File names:: Customizing the file names. +* External index files:: Putting index entries in external files. +@end menu + +@c -------------------------------------------------------- +@node The different pages +@section The different categories of pages and sectioning elements + +The following sectioning elements can be associated with pages: + +@table @emph +@item Normal elements +These are normal sections or nodes. Their association with pages is +determined by the splitting of the document. @xref{Splitting output}. +@item Top element +The top element is the higher element in the document structure. +If there is a @code{@@top} section it is the element associated with +that section. Otherwise it is the element associated with the +@code{@@node Top}. If there is no @code{@@node Top} the first element is the +top element. + +The top element is formatted differently than a normal element if there +is a @code{@@top} section or the @code{@@node Top} isn't associated +with a sectioning command. +@item Misc elements +These elements are associated with pages if the document is split. +There are four misc elements: +@enumerate +@item Table of contents +@item Short table of contents, also called Overview +@item Footnotes page +@item About page +@end enumerate + +The @emph{About page} shouldn't be present for documents consisting +in only one sectioning element. The @emph{Footnote page} should only +be present if the footnotes appear on a separated page +(@pxref{Page layout options}), however a footnote element is present if +the document isn't split. The @emph{Table of contents} should only +be formatted if @code{@@contents} is present in the document. +Similarly the @emph{Overview} should only appear if @code{@@shortcontents} +or @code{@@summarycontents} is present. +@end table + +@c -------------------------------------------------------- +@node The page layout +@section Page layout and navigation panel overview + +A page is broken up in three parts. A page header, the sections +and a page footer. A common element in the page layout is a navigation +panel with icons or text linking to other sections or pages. Another +common element is a rule, separating sections or footer. The navigation +panel and the rules may be part of the sections or part of headers or +footers. You may use the variables @variable{$SMALL_RULE}, +@variable{$DEFAULT_RULE}, @variable{$MIDDLE_RULE} and @variable{$BIG_RULE} +for rules of different sizes. +The defaults are +@example +$SMALL_RULE = '<hr size="1">'; +$DEFAULT_RULE = '<hr>'; +$MIDDLE_RULE = '<hr size="2">'; +$BIG_RULE = '<hr size="6">'; +@end example + +In the header some important meta data may be defined, like the +title or style information, and textual informations may be present +in comments. All this doesn't appear directly in the displayed +@acronym{HTML}, though. + +The page layout is mainly controlled by functions, the precise functions +called depending on the document splitting. The navigation panel, however, +can be customized with variables. + +@subheading Element labels +@anchor{Element labels} + +There are 19 items associated with elements. Each of these +is associated with a name and a reference to the +element they represent, when such an element exists. +The element is either a global element or an element relative to the current +element. The relative elements are found with respect with the document +structure defined by the section structuring commands (@code{@@chapter}, +@code{@@unnumbered}@dots{}) or by the nodes (in that case the node +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}). + +Here is the list: + +@table @emph +@item @samp{@ } +An empty button +@item Top +Top element. The associated name is @variable{$TOP_HEADING} if that variable is +defined. This variable is not set by default. +@item Contents +Table of contents +@item About +About (help) page +@item Overview +Overview, short table of contents +@item First +First element in reading order +@item Last +Last element in reading order +@item Index +The first chapter with @code{@@printindex}. The associated name +is @variable{$INDEX_CHAPTER}, if the variable is set. This variable is not set +by default. +@item This +The current element +@item Back +Preceding element in reading order +@item FastBack +Beginning of this chapter or previous chapter if the element is a chapter +@item Prev +Previous section on the same level +@item NodePrev +Previous node +@item Forward +Next element in reading order +@item FastForward +Next chapter +@item Next +Next section on the same level +@item NodeNext +Next node +@item Following +Next node in node reading order +@item Up +Up section +@item NodeUp +Up node +@end table + +@c -------------------------------------------------------- +@node Navigation panel +@section Customization of the navigation panels buttons + +A lot of customization of the navigation panel may be achieved without +redefining functions, with variables redefinition. +In case it isn't enough, it is also possible to redefine the function +doing the navigation panel formatting. + +@menu +* General purpose variables:: Variables controlling the navigation panel + at a global level +* Button specifications:: +* Panel formatting function:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node General purpose variables +@subsection Controlling the navigation panel panel at a high level + +The global formatting of the navigation panels may be +changed with the following variables: + +@vtable @code +@item $VERTICAL_HEAD_NAVIGATION +A vertical navigation panel will be used for the header navigation +panel if this variable is true. +@item $ICONS +Icons are used instead of +textual buttons if this variable is true. +@item $SECTION_NAVIGATION +If this variable is false there is no section navigation, no navigation +panels for the elements within the pages, only at +the beginning and the end of the page (@pxref{Page layout options}). +@end vtable + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Button specifications +@subsection Specifying the buttons formatting + +Several arrays and hashes enable a precise control on the buttons and +their display. +The following arrays determine the buttons present in navigation panels: + +@vtable @code +@item @@SECTION_BUTTONS +This array is used for the navigation panel buttons present at the begining +of sectioning elements. If split at node or section they are also used +at the page footer, and in the case of section navigation at the page header. +@item @@SECTION_FOOTER_BUTTONS +@itemx @@NODE_FOOTER_BUTTONS +This array is used for the navigation panel buttons present at the footer +of pages when split at node or at section. + +If @variable{$WORDS_IN_PAGE} is set and the output is split at nodes, these +buttons are only present if there are more than @variable{$WORDS_IN_PAGE} +words in the sectioning element text. This counting is very rough and include +punctuation marks, html elements, numbers. The default is to include the +buttons after 300 words. +@item @@CHAPTER_BUTTONS +This array is used for the buttons appearing at the page footer if split at +chapter, and at the page header if split at chapter and there is no section +navigation. +@item @@MISC_BUTTONS +These buttons appear at the beginning of special and sections +and at the end of these section pages if the output is split. +@end vtable + +The array specify the buttons displayed in navigation panels, +and how the button is displayed. +Each element is associated with +a button of the navigation panel from left to right. +The signification of the array element value is the following: + +@table @emph +@item reference on a function +The function is called with first argument a filehandle reference on the +current file and second argument a boolean true if the navigation +panel should be vertical. +@item reference on a scalar +The scalar value is printed. For some possibly +usefull scalars, @ref{Elements hashes}. +@item reference on an array +In this case the first array element should be a reference on text and the +second element an element label. In that case a link to the +element associated with the element label with the scalar value +text is generated. + +For example if the buttons array element is +@example +[ 'Next', \$Texi2HTML::NODE@{Next@} ] +@end example + +The button will be a link to the next section with text +@variable{$Texi2HTML::NODE@{Next@}}. +@item element label +If icons are not used, the button is a link to the corresponding +element which text is defined by the value associated with the +element label in the @variable{%NAVIGATION_TEXT} hash, surrounded +by @samp{[} and @samp{]}. If the element label is @samp{ }, there is +no @samp{[} and @samp{]}. +The element of the @code{%NAVIGATION_TEXT} hash are defined +dynamically, in the @code{init_out} function reference +(@pxref{Output initialization}). + +If icons are used, the button is an image with file determined by +the value associated with the element label in the @variable{%ACTIVE_ICONS} +hash if the the link really leads to an element, or in the @variable{%PASSIVE_ICONS} +hash if there is no element to link to. Of course if there is a link to the +element the icon links to that element. +@end table + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Panel formatting function +@subsection Changing the navigation panel formatting + +If you are not satisfied with this scheme, it is possible to +control exactly the formatting of navigation panels by redefining a function +reference. The function controlling the display of navigation panel is +associated with the following function reference: + +@deffn {Function Reference} print_navigation $filehandle \@@buttons $vertical +@var{$filehandle} is the opened filehandle the function should write to. +@var{\@@buttons} is an array reference which should hold the specification of +the buttons for that navigation panel. @var{$vertical} is true if the +navigation panel should be vertical. +@end deffn + +@c -------------------------------------------------------- +@node Program variables +@section Main program variables and usefull functions + +In the functions +controlling the page layout some global 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, + title@dots{} +* Global functions:: main program usefull functions +@end menu + + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Elements hashes +@subsection Accessing elements informations + +Four hashes are available, with key the elements labels (as described +in @ref{Element labels}) and values: + +@vtable @code +@item %Texi2HTML::NAME +The formatted element name +@item %Texi2HTML::HREF +The element hypertext reference +@item %Texi2HTML::NODE +The element node name +@item %Texi2HTML::NO_TEXI +The element name after removal of texi commands +@end vtable + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Global informations +@subsection Accessing global informations + +Three kinds of global informations are available, miscalleneous global +strings, flags set by @code{@@set} and special flags and section lines. + +@subsubheading Global strings +The @variable{%Texi2HTML::THISDOC} hash holds some global informations: + +@table @code +@item fulltitle +title set by @code{@@title}. If there is no @code{@@title} other +possibilities are tried (@code{@@settitle}, @code{@@shorttitlepage}@dots{}). +@item title +title set by @code{@@settitle}, or @code{fulltitle}. +@item title_no_texi +title without texi formatting +@item title_texi +title with texi commands +@item author +Authors list set by @code{@@author}. +@item authors +A reference on an array containing each author set by @code{@@author}. +@item copying +Text appearing in @code{@@copying} with all the texinfo commands removed, +put in comments. +@item program +The name and version of @command{texi2html}. +@item program_homepage +Homepage for @command{texi2html}. +@item program_authors +Authors of @command{texi2html}. +@item file_base_name +base name of the texinfo manual file. +@item destination_directory +Destination directory for the resulting files. +@item toc_file +The file name of the table of contents. +@item today +The date. +@end table + +It also holds the arg of the following commands, associated with the command +name: kbdinputstyle, paragraphindent, setchapternewpage, headings, +footnotestyle, + exampleindent, firstparagraphindent, everyheading, everyfooting, + evenheading, evenfooting, oddheading, oddfooting. + + +@subsubheading Flags +Flags defined by @code{@@set} may be accessed through the +@variable{%main::value} hash. The key is the flag name, the value is the +flag value at the end of the document. + +Special flags are set by the main program. They correspond with a texinfo +command, like @code{@@setfilename}, or @code{@@settitle}, +@code{@@author}@dots{} The corresponding flag is the command name with +@samp{_} appended, for example, @code{_titlefont} corresponds with +@code{@@titlefont}. Like other flags they are available in +@variable{%main::value}. + + +@subsubheading Section lines + +The following array references or arrays holds formatted lines: + +@vtable @code +@item $Texi2HTML::THIS_SECTION +Lines of the current element. +@item $Texi2HTML::THIS_HEADER +Lines of the current element appearing before the element label (anchors). +@item $Texi2HTML::OVERVIEW +Lines of short table of contents. @xref{Special pages}. +@item $Texi2HTML::TOC_LINES +Lines of table of contents. @xref{Special pages}. +@end vtable + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Global functions +@subsection Function usefull in page formatting + +The usefull function is a function used to print an array of lines, which +also counts the number of words in the array, if needed. + +@deftypefun $words_number main::print_lines $filehandle \@@lines_array +@var{$filehandle} is the opened filehandle the function should write to. +@var{\@@lines_array} is the array line the function should write to the file. +If this argument is omitted, the function uses @variable{$Texi2HTML::THIS_SECTION}. +@var{$words_number} is the number of words in the array, only defined if +split at nodes and @variable{$WORDS_IN_PAGE} is defined. +@end deftypefun + +@c -------------------------------------------------------- +@node Output initialization +@section Preparing the output + +After the texinfo file has been parsed, some information is available +which can be used to modify some variables and prepare the outputting. +For example the document language, the document encoding, +values set with @code{@@set} or @code{@@setfilename} and other similar +@@-commands are not known before the texinfo parsing. + +The following function reference may be redefined to be called after +texinfo processing and before document generation: + +@deftypefn {Function Reference} $encoding init_out +This function perform the initialization of variables and any other +task before document outputting. It returns the encoding used for the +output files. +@end deftypefn + +In the default case the @variable{$BODYTEXT} (@pxref{Customizing header}) +and the hashes @variable{%NAVIGATION_TEXT} (@pxref{Button specifications}) and +@variable{%BUTTONS_GOTO} (@pxref{About text}) are initialized. + +To perform the default initializations and also add more code, you could +do as in the following example (save the default function reference and call +it in your own function) : + +@example +my $default_init_out = $init_out; +$init_out = \&makeinfo_like_init_out; +sub makeinfo_like_init_out() +@{ + my $encoding = &$default_init_out(); + $NAVIGATION_TEXT@{'Following'@} = ' > '; + return $encoding; +@} +@end example + +@c -------------------------------------------------------- +@node Output finalization +@section Finalizing the output + +If you want to do some cleaning after the document was generated (close +files, write at the end of files and so on), the following function +reference may be redefined: + +@deffn {Function Reference} finish_out +This function is called after the document generation. +@end deffn + +The default is to do nothing. + +@c -------------------------------------------------------- +@node css +@section Customizing the @command{texi2html} css lines + +It is possible to modify the @command{texi2html} css lines by modifying +the entries or adding to the @variable{%css_map} hash. Each key is a css +selector, the corresponding value is a style string. + +The whole css text is in the variable @variable{$CSS_LINES}. If this +variable is defined the variable value is used instead of being +constructed using the @variable{%css_map} entries. For example if you don't +want any css entries, set + +@example +$CSS_LINES = ''; +@end example + +It is also possible to change completely the way @variable{$CSS_LINES} are +generated by redefining the following function reference: + + +@deffn {Function Reference} css_lines \@@import_lines \@@rule_lines +This function should be used to construct the @variable{$CSS_LINES}. +@var{\@@import_lines} are the @code{@@import} lines of the +files specified with @longopt{include-css}, +and @var{\@@rule_lines} are the css commands lines of these files. +@xref{Style options}. +@end deffn + +@c -------------------------------------------------------- +@node Customizing header +@section Customizing the page header + +It is possible to add lines to the text within the @code{<head>} +@acronym{HTML} elements, by defining the variable @variable{$EXTRA_HEAD}. +Similarly it is possible to add text just after the @code{<body>} +element with the variable @variable{$AFTER_BODY_OPEN}. +These variables are empty by default. + +The encoding of the texinfo file is defined by @variable{$DOCUMENT_ENCODING} +if no @code{@@documentencoding} appears in the document. +The default is a @samp{en-ascii} encoding. +The encoding of the resulting document is defined by +@variable{$ENCODING}. The default is the @code{$DOCUMENT_ENCODING}. + +The description of the document may be specified in +@variable{$DOCUMENT_DESCRIPTION}. If this variable is undef, the text +associated with @code{@@documentdescription} is used, and if there isn't +such test a default description is constructed using the document title and +the name of the first section of the file. + +The @code{<body>} element attributes may be set by defining the +variable @variable{$BODYTEXT}. If you want to define that variable +dynamically, you should use the @code{init_out} function reference +(@pxref{Output initialization}). + +The default functions call the function associated with +@variable{$print_head_navigation} to format the navigation panel for the +page header. Thus you can control parts of the formatting by +redefining the function reference. + +@deffn {Function Reference} print_head_navigation $filehandle \@@buttons +@var{$filehandle} is the opened filehandle the function should write to. +@var{\@@buttons} is an array reference which should hold the specification of +the buttons for the navigation panel. +@end deffn + +If you want even more control, you can have full control over the page header +formatting by redefining three function references. The function associated +with @variable{$print_page_head} is called for all the pages, and after that, +the function associated with @variable{$print_chapter_header} is called +if the document is split at chapters, or the function associated with +@variable{$print_section_header} is called if the document is split at sections. + +@deffn {Function Reference} print_page_head $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function should print the page head, including the @code{<body>} +element. +@end deffn + +@deffn {Function Reference} print_chapter_header $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function is called if the document is split at chapters, after +@code{print_page_head}. +@end deffn + +@deffn {Function Reference} print_section_header $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function is called if the document is split at sections, after +@code{print_page_head}. +@end deffn + +@c -------------------------------------------------------- +@node Customizing section +@section Customizing the sections + +The functions associated with the following function references are used for +the formatting of sections: + +@deffn {Function Reference} print_section $filehandle $first_in_page $previous_is_top +@var{$filehandle} is the opened filehandle the function should write to. +@var{$first_in_page} is true if this section is the first section in the page. +@var{$previous_is_top} is true if this section is the section following the +Top section. +This function should print the current section. +@end deffn + +@deffn {Function Reference} end_section $filehandle $last_element_or_before_top +@var{$filehandle} is the opened filehandle the function should write to. +@var{$last_element_or_before_top} is true if this section precedes the top +element or is the last one in page, or before the special elements. +@end deffn + +@c -------------------------------------------------------- +@node Customizing footer +@section Customizing the page footer + +It is possible to add text just before the @code{</body>} +element with the variable @variable{$PRE_BODY_CLOSE}. Nothing is added +by default. + +@ignore +The footer text may be influenced by @variable{$ADDRESS} which should hold +information about who created the document and how. +If you want to define that variable +dynamically, you could redefine the following function reference: + +@deftypefn {Function Reference} $address_text address $user $date +This function should return the address. @var{$user} is the user name +of the user running @command{texi2html}, @var{$date} is the date of the day. +@end deftypefn +@end ignore + +The default functions call the function associated with +@variable{$print_foot_navigation} to format the navigation panel for the +page footer. Thus you can control parts of the formatting by +redefining the function reference. + +@deffn {Function Reference} print_foot_navigation $filehandle \@@buttons +@var{$filehandle} is the opened filehandle the function should write to. +@var{\@@buttons} is an array reference which should hold the specification of +the buttons for the navigation panel. +@end deffn + +If you want even more control, you can have full control the page footer +formatting by redefining three function references. +The function associated with @variable{$print_chapter_footer} is called +if the document is split at chapters, or the function associated with +@variable{$print_section_footer} is called if the document is split at sections. + After that the function associated +with @variable{$print_page_foot} is called. + +@deffn {Function Reference} print_page_foot $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function should print the page foot, including the @code{</body>} +element. +@end deffn + +@deffn {Function Reference} print_chapter_footer $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function is called if the document is split at chapters, before +@code{print_page_foot}. +@end deffn + +@deffn {Function Reference} print_section_footer $filehandle +@var{$filehandle} is the opened filehandle the function should write to. +This function is called if the document is split at sections, before +@code{print_page_foot}. +@end deffn + + +@c -------------------------------------------------------- +@node Special pages +@section Special pages formatting + +For the special elements, two things must be formatted: the content +and the page layout + +@menu +* Special pages content:: +* Special pages layout:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Special pages content +@subsection Customizing the content of the special pages + +@menu +* Top element text:: +* Contents and Overview text:: +* Footnotes text:: +* About text:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Top element text +@subsubsection Top element text formatting +The top element formatting is controlled by three function which also +controls the layout of the top element page or section. The associated +function references are: + +@deffn {Function Reference} print_Top_header $filehandle $begin_page +@var{$filehandle} is the opened filehandle the function should write to. +@var{$begin_page} is true if the element is the first in a page. +This function should begin the Top element. At the time this function is called +the top element text hasn't been parsed. +@end deffn + +@deffn {Function Reference} print_Top $filehandle $has_top_heading +@var{$filehandle} is the opened filehandle the function should write to. +@var{$has_top_heading} is true if there is a @code{@@heading} command or +@code{@@titlefont} command appearing in the Top element text. +This function should be used to format the Top element text and navigation +panel. +@end deffn + +@deffn {Function Reference} print_Top_footer $filehandle $end_page +@var{$filehandle} is the opened filehandle the function should write to. +@var{$end_page} is true if the element is the last in a page. +This function should end the Top element. +@end deffn + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Contents and Overview text +@subsubsection Table of contents and Short table of contents +Several variables may be used to control the formatting of table of contents +and short table of contents: + +@vtable @code +@item $DO_CONTENTS +If the variable is true a table of contents is done even if there is no +@code{@@contents} command. +@item $DO_SCONTENTS +If the variable is true a short table of contents is done even if there is no +@code{@@summarycontents} command. +@item $BEFORE_OVERVIEW +The variable value is inserted before the short table of contents text. +@item $AFTER_OVERVIEW +The variable value is inserted after the short table of contents text. +@item $BEFORE_TOC_LINES +The variable value is inserted before the table of contents text. +@item $AFTER_TOC_LINES +The variable value is inserted after the table of contents text. +@item $TOC_LIST_STYLE +This should contain a css style used for the list style if the tables of +content are formatted with a list. +@item $TOC_LIST_ATTRIBUTE +This should contain an attribute text used for the list element if the tables of +content are formatted with a list. +@end vtable + +More control on the table of contents and short table of contents formatting +may be achieved by redefining a function with the following associated +function reference: + +@deffn {Function Reference} toc_body \@@elements +@var{\@@elements} is an array reference contining informations about +all the elements of the document. Each of the entry of this array is an hash +reference which entries correspond with different informations +about the element. Interesting keys have the following meaning: + +@table @code +@item top +true if the element is the top element, +@item index_page +true if the element is an index page added because of index splitting, +@item toc_level +level of the element in the table of content. Highest level +is 1 for the top element and for chapters, appendix and so on, +2 for section, unnumberedsec and so on... +@item tocid +label used for reference linking to the element in table of +contents, +@item file +the file containing the element, usefull to do href to that file +in case the document is split, +@item text +text of the element, with section number, +@item name +text of the element, without section number. +@end table + +This function doesn't return anything but should fill the array corresponding +with the +@variable{$Texi2HTML::TOC_LINES} and +@variable{$Texi2HTML::OVERVIEW} references with the table of contents and short +table of contents. + +@end deffn + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Footnotes text +@subsubsection Formatting of footnotes text + +The footnotes text is allready formatting when @code{@@footnote} commands +are expanded. @xref{Footnotes}. + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node About text +@subsubsection Formatting of about text + +The default about element contains an explaination of the buttons used +in the document (@code{@@SECTION_BUTTONS}, @ref{Button specifications}) and +an example locating the buttons targets in an example. +The formatting of this text may be influenced by the following +hashes and variables: + +@table @code +@item $PRE_ABOUT +@itemx $AFTER_ABOUT +This variable may be a scalar or a function reference. +If it is a scalar, the value is used. +If this is a function reference it is expanded and the returned text is +used. The text is added before or after the main about text. +@item %BUTTONS_GOTO + +The keys of this hash are element labels (@pxref{Element labels}). The value +is the text associated with the element label in the about text. +The element of the hash are defined +dynamically, you should in the @code{init_out} function reference +(@pxref{Output initialization}). + + +@item %BUTTONS_EXAMPLE + +The keys of this hash are element labels (@pxref{Element labels}). The value +is the text associated with the element label in the about example, +typically a section number. + +@end table + +If this is not enough and you want to control exactly the formatting of +the about text, you can redefine the function associated with the following +function reference: + +@deftypefn {Function Reference} $about_text print_about +This function should return the about text. +@end deftypefn + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Special pages layout +@subsection Customizing the layout of the special pages + +The formatting of each of the special pages, or section in case +the document is not split, is controlled by a function. +The associated function reference is called accordingly: + +@ftable @code +@item print_Top +@item print_Top_header +@item print_Top_footer +Formatting of top element page or section. It is also used for the formatting +of the top element text (@pxref{Top element text}). +@item print_Toc +Formatting of table of contents page or section +@item print_Overview +Formatting of short table of contents page or section +@item print_About +Formatting of about (help) page or section +@item print_Footnotes +Formatting of footnotes section or page in case footnotes are on a +separated page or the document isn't split. +@end ftable + +In the default case, @variable{$print_Top} calls @variable{$print_Top_header} for +the header and @variable{$print_Top_footer} for the footer of top element. +All the other function call @variable{$print_misc} which in turn calls +@variable{$print_misc_header} for the headers and @variable{$print_misc_footer} +for the footers. + +@c -------------------------------------------------------- +@node File names +@section Customizing the file names + +It is possible to specify the file names with more control than with the +command line options (@pxref{Output files}). +First the extension may be overrided by the variable @variable{$EXTENSION} +value. +Two function references enable +further customization. One is usefull in case @variable{$NODE_FILES} is true +and it is used to customize the node file name itself and is also used +to produce a file name with a redirection leading to the node file. + +@deftypefn {Function Reference} {($node_file $redirection_node_file)} node_file_name $node +@var{$node} is a hash reference with the following interesting keys (there +are much more keys): +@table @code +@item texi +The texinfo node name. +@item with_section +True if associated with a section. +@end table +The result is the node file name @var{$node_file}, and the file containing +a redirection to the node @var{$redirection_node_file}. +@end deftypefn + +The other is usefull if @code{$NODE_FILES} isn't true. It is used to +customize the file associated with each element. +@deftypefn {Function Reference} $file element_file_name $element $is_top $docu_name +@var{$element} is a hash reference with the following interesting keys (there +are much more keys): +@table @code +@item texi +The texinfo element name. +@item number +The number associated with a section. +@item doc_nr +A number incremented whenever a new file should begin, based on how the +document is split (@pxref{Splitting output}). +@item text +The element text. +@item name +The element text without section number. +@end table +@var{$is_top} is true if the element is considered as the top element. +@var{$docu_name} is the basename of the texinfo manual. +The result is the element file name. +@end deftypefn + +@c -------------------------------------------------------- +@node External index files +@section Generation of external files for index entries + +Within the document, @code{@@printindex} commands are expanded as explained +in @ref{Index list}. In case you want to do something special with index +entries, outside of the document, you should first set the variable +@variable{$IDX_SUMMARY} true. After that some function reference will be called +for each non empty index. For each index there are 3 function +references, one called for initialization, one called for each index entry +and the last one called for finalazation. + +@deffn {Function Reference} index_summary_file_begin $index_name $is_printed +@var{$index_name} is the two letters name for the index. +This function +is called for each index +appearing in the document, before +@code{index_summary_file_entry}. +@var{$is_printed} is true if there is a @code{@@printindex} for that index. +@end deffn + +@deffn {Function Reference} index_summary_file_entry $index_name $entry_text $entry_reference $formatted_entry $texi_entry $entry_element_reference $entry_element_header $is_printed +This function is called for each entry of an index. @var{index_name} is the +name of the index. @var{$entry_text} is the entry in plain text, +@var{$formatted_entry} is the index entry formatted, @var{$texi_entry} is the +entry with texinfo commands. @var{$entry_reference} is the reference placed +at the index entry place, in the form @samp{file#id}. +@var{$entry_element_header} is the formatted header of the element containing +the index entry. @var{entry_element_header} is the reference to the +beginning of the element containing the index entry, in the form +@samp{file#id}. +@var{$is_printed} is true if there is a @code{@@printindex} for that index. +@end deffn + +@deffn {Function Reference} index_summary_file_end $index_name $is_printed +@var{$index_name} is the two letters name for the index. This function +is called for each index appearing in the document, after +@code{index_summary_file_entry}. +@var{$is_printed} is true if there is a @code{@@printindex} for that index. +@end deffn + +@c ======================================================== +@node Customizing HTML +@chapter Customizing @acronym{HTML} and text style in init files + +Some simple customization may be achieved with the redefinition of the +variables +associated with the command line options. For the description and an +explanation of the meaning of these variables, @ref{Style options}. + +Other variables and hash entries can be modified in initialization file +to achieve more customization. +Lastly, functions references corresponding with functions called from +the main program and initialization files may +be redefined. + +@menu +* Three contexts:: there are three different contexts for command + expansion: normal text, preformatted text and + strings. +* Commands without argument:: +* Style and accent commands:: +* Anchors images and spaces:: Formatting of @code{@@anchor}, @code{@@image}, @code{@@sp}, @code{@@acronym}, @code{@@abbr} +* Text:: Some characters are processed specially +* Strings:: @command{texi2html} write some strings in the output + different for each languages +@c * Skipped commands:: +* References:: +* Alignement commands:: @code{@@center}, @code{@@flushleft}@dots{} +* Paragraph and preformatted region:: +* Complex formats:: @code{@@example}, @code{@@display}@dots{} +* Lists tables:: +* Definitions:: +* Headings:: +* Special regions:: @code{@@verbatim}, @code{@@cartouche}, @code{@@quotation} +* Menus:: +* Indices:: +* Floats and lists of floats:: @code{@@float} and @code{@@listoffloats} +* Footnotes:: +* Other and unknown commands:: You can handle specifically other commands + +@end menu + +@c -------------------------------------------------------- +@node Three contexts +@section Three contexts for expansions: preformatted, normal and string + +There are three contexts of interest, one is the normal context, the other +is a special context, called the @dfn{preformatted} context and the last is +the string context. The preformatted +context occurs when the spacing between words is kept. This is the +case, for example, in @code{@@display} or @code{@@example} regions, and in +menu comments (@pxref{Menus}). The preformatted regions are usually +rendered in @code{<pre>} elements in @acronym{HTML}. +The string context occurs when rendering strings without formatting elements, +in comments or titles for example. + +@c -------------------------------------------------------- +@node Commands without argument +@section Customizing the formatting of commands without argument + +This includes the commands whose name is a nonletter character like @code{@@@@}, +the commands with lettered characters and braces +but whose braces should be empty, like @code{@@TeX@{@}}, or some commands +associated with accentted letters like @code{@@AA@{@}}. If there happens to +be something within the braces, it is put after the command, thus +@example +@@TeX@{something@} +@end example +leads to the same than +@example +@@TeX@{@} something +@end example + +Each of these categories of commands have three associated hashes, one +for normal +context, the other for preformatted context and the last in strings. The +keys of the hashes are the +command names, the associated value is the text replacing the command. + +The hashes are: +@multitable {one nonlettered character} {normal text} {preformatted text} {string} +@item command type @tab normal text @tab preformatted text @tab string +@item one nonlettered character @tab @variable{%simple_map} @tab @variable{%simple_map_pre} @tab @variable{%simple_map_texi} +@item nothing in braces @tab @variable{%things_map} @tab @variable{%pre_map} @tab @variable{%texi_map} +@end multitable + +To change the @acronym{HTML} resulting from these constructs, just change the +value. For example, if you want @code{­} to be outputted for @code{@@-} +in normal and preformatted context, write in your init file: + +@example +$simple_map@{'-'@} = '­'; +$simple_map_pre@{'-'@} = '­'; +@end example + +@c -------------------------------------------------------- +@node Style and accent commands +@section Customizing accent, style and other simple commands + +The formatting of the @acronym{HTML} produced by style and indicatric +commands (@code{@@tt}, @code{@@code}, +@code{@@email}, @code{@@titlefont}), the accentuation related +commands taking argument (@code{@@'}, @code{@@udotaccent}, @code{@@dotless}) +and miscalleneous commands (@code{@@email}, @code{@@verb}, @code{@@w}, +@code{@@uref}, @code{@@math}, @code{@@asis}) is controlled by two hash in the +default case, +@variable{%style_map} for normal context, @variable{%style_map_pre} for +preformatted context and @variable{%style_map_texi} in string context. + +The key of the hashes are the command names. There are two possibilities for +the values corresponding with two interfaces. The values may be strings or +hash references, and you can chose the interface depending on the one you +prefer. The interface with hash reference is a bit more flexible but might also +be regarded as more complex. If you don't like either of these interfaces you +can define your own. + +Some remarks are in order: + +@itemize +@item +The nonlettered accent commands which following character is considered +to be the argument (like in @code{@@`a}) should be keys of the +hash @variable{%accent_map} hash, even if no value is associated. +@item +@code{@@math} is handled differently if La@TeX{}2HTML is used. +@end itemize + +@menu +* Hash reference interface:: +* String interface:: +* Define your own interface:: +@end menu + +@node Hash reference interface +@subsection An interface for commands formatting with a hash reference + +The key of the hashes are the command names. The value determine how the command argument +is formatted. This value is a reference on a hash. In this hash each key +corresponds with a type of information for the formatting, and the value is +the corresponding information. For example, in + +@example +$style_map@{'command'@} = @{ 'args' => ['code'], 'attribute' => 'code'@}; +@end example + +the arguments for @code{@@command} are interpreted as specified by +the values associated with the @samp{args} key while the attribute associated +with that command is @samp{code}. + +The following keys in the hashes associated with each command have the +following meaning: + +@table @samp +@item args +@anchor{Reference hash args} +The value associated is a reference on an array. Each element of the array +defines how the arguments (separated by @samp{,} in the texinfo code) for +the @@-command should be +formatted. The possibilities are +@table @code +@item normal +for normal text, +@item code +for text with @samp{---}, @samp{--}, @samp{''} and @samp{``} kept as is, +@item keep +if the texinfo should be kept as is, without interpretation of the @@-commands. +@end table + +For example, we have +@example +$style_map@{'email'@}->@{'args'@} = ['code', 'normal']; +@end example + +because @samp{---}, @samp{--}, @samp{''} and @samp{``} should be kept as is in +the first argument of @code{@@email}. + +The default is @samp{['normal']}. + +@item attribute + +If the associated value is a word, it is considered to be an @acronym{HTML} +element name, and the argument is enclosed between the element opening +and the element closing. For example, if the value is @code{elem}, the +resulting @acronym{HTML} is @code{<elem>@var{arg}</elem>}. + +If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +Thus @code{elem class="elem"} leads to +@code{<elem class="elem">@var{arg}</elem>}. + +This works only if there is only one argument. + +@item begin + +The associated value is added in front of the text. + +@item begin + +The associated value is added after the text. + +@item quotes + +If the corresponding value is true, the result is +enclosed in quotes @variable{$OPEN_QUOTE_SYMBOL} and +@variable{$CLOSE_QUOTE_SYMBOL}, with defaults +@samp{`} and @samp{'}. + +@item function + +The corresponding value should be a function reference. The corresponding +function is called with the following arguments: + +@table @code +@item $command +The @@-command name +@item $args +A reference on an array containing the arguments of the @@-command. +@item $style_stack +A reference on an array containing the name of the @@-commands containing +the @@-command being formatted. +@item $state +A reference on a hash containing a lot of informations about the context +of the @@-command. +@item $line_nr +An opaque structure containing the information about the line number of the +@@-command. It can be used to call @code{main::echo_error} or +@code{main::echo_warning} with first argument a message, and second argument +@code{$line_nr}. +@end table +@end table + +@node String interface +@subsection An interface for commands formatting with a string + +The keys of the hashes are the command names. The value determine +how the command argument +is formatted. If the value begins with @samp{"}, the result is +enclosed in quotes @variable{$OPEN_QUOTE_SYMBOL} and +@variable{$CLOSE_QUOTE_SYMBOL}, with defaults +@samp{`} and @samp{'}. + +The command argument is allready formatted as @acronym{HTML}. +The remaining of the value text +(or the value text if there were no @samp{"}) is interpreted as follow: + +@itemize @bullet +@item +If the text is empty the argument of the command is left as is. +@item +If the text is a @samp{&} followed by a name, +like @samp{&function}, the name is considered to be a function name, +and this function is called to format the argument of the command. The +first argument of the function is the command name, the second is +the command argument. For example, if the value associated with the +(fictituous) command @code{@@foo} is @code{&my_func} +and we have: + +@example +sub my_func +@{ + my @@args = split /,\s*/ $_[1]; + return "$_[0]: $args[0]" if ($args[1] = 1); + return "$args[0]"; +@} +@end example + +The result of +@example +@@foo@{truc, 1@} +@@foo@{truc, bidule@} +@end example +will be +@example +foo: truc +truc +@end example +@item +If the text is a word, it is considered to be an @acronym{HTML} element +name, and the argument is enclosed between the element opening +and the element closing. For example, if the value is @code{elem}, the +resulting @acronym{HTML} is @code{<elem>@var{arg}</elem>}. +Similarly @code{"quoted} leads to +@code{`<quoted>@var{arg}</quoted>'}. +@item +If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +Thus @code{elem class="elem"} leads to +@code{<elem class="elem">@var{arg}</elem>}. +@end itemize + +@node Define your own interface +@subsection Defining the style and indicatric commands interface + +If you don't like this scheme, it is possible to change how those commands +are processed by redefining the following function reference: + +@deftypefn {Function Reference} $resulting_text style $style $command $text $args $no_close $no_open $line_nr $state $style_stack +@var{$command} is the @@-command, @var{$style} is the value associated with +the @var{$command} in the @code{%style_map}, @code{%style_map_pre} +or @code{%style_map_texi} hashes. +The @var{$text} is the text appearing within the @@-command braces. +@var{args} is a reference on an array contening the command arguments +formatted according to the same conventions than with the reference hash style +(provided the value associated with the @@-command is a hash reference with a +@var{$arg} key as described in @ref{Reference hash args}). +If @var{$text} is split in paragraphs each paragraph is passed through +the function, and @var{$no_close} is true if it is not the last paragraph, +while @var{$no_open} is true if it is not the first paragraph. +@var{$line_nr} +is an opaque structure containing the information about the line number of the +@@-command. It can be used to call @code{main::echo_error} or +@code{main::echo_warning} with first argument a message, and second argument +@code{$line_nr}. +@var{$state} +is a reference on a hash containing a lot of informations about the context +of the @@-command. +@var{$style_stack} +is a reference on an array containing the name of the @@-commands containing +the @@-command being formatted. + +@end deftypefn + +@c -------------------------------------------------------- +@node Anchors images and spaces +@section Formatting of special simple commands + +The formatting of special simple commands is controlled by functions. To +customize the output, the corresponding function references should be +redefined. All these functions return a formatted text. + +The formatting of anchors is controlled by @variable{$anchor}, but the function +associated with the function reference does more, it is usefull +to produce a reference target or link. +@deftypefn {Function Reference} $anchor anchor $identifier $href $text $attributes +If @var{$identifier} is not empty, this value should be used to create +a target for links (typically associated with a name or id +attribute in @acronym{HTML}). +The @var{$href} argument specifies a hpertextual reference which should be +used to link to a target. +In case both @var{$identifier} and @var{$href} are given the text produced +should be both a target for @var{$identifier} and a link to @var{$href}. +@var{$text} is the text to be displayed. +@var{$attributes} are additional attributes. +It should be reasonable to assume that the attributes are for a @code{<a>} +@acronym{HTML} element. +@end deftypefn + +The formatting of @code{@@image} is controlled by: +@deftypefn {Function Reference} $image image $file_path $basename $preformatted $file_name +@var{$file_path} is the image file name with the path, @var{$basename} is the +alternate text or the file name without extension if no alternate text is +given. @var{$preformatted} is true if the image +appears in preformatted text. @var{$file_name} is the file name without path +but with extension. +@end deftypefn + +The formatting of @code{@@sp} is controlled by: +@deftypefn {Function Reference} $sp sp $number $preformatted +@var{$number} is the numeric argument of @code{@@sp}. +@var{$preformatted} is true if the @code{@@sp} appears in preformatted text. +@end deftypefn + +The formatting of @code{@@acronym} and @code{@@abbr} is controlled by: +@deftypefn {Function Reference} $acronym acronym_like $acronym_texi $acronym_text $with_explanation \@@explanation_lines $explanation_text $explanation_simply_formatted +@var{$acronym_texi} is the acronym argument with texinfo @@-commands, +@var{$acronym_text} is formatted. + +The other arguments are related with +the explanation, the second arg of the acronym. @var{$with_explanation} is +true if the second argument of the acronym command is present. If an +explanation exists, coming from previous @code{@@acronym} or as an arg of this +command, the other args are defined: @var{\@@explanation_lines} is a +reference on an array containing the unformatted explanation lines, +@var{$explanation_text} is the explanation text formatted, +@var{$explanation_simply_formatted} is the explanation with a light formatting, +unabling in @acronym{HTML} (or @acronym{XML}) the explanation to be in an +attribute. +@end deftypefn + +@c -------------------------------------------------------- +@node Text +@section Processing special characters in text + +Some characters are processed especially in text: @samp{---}, @samp{--}, +@samp{``} and @samp{''}. This is done only if in normal text and not in +some commands (@code{@@code}, @code{@@env}@dots{}). A function reference +is called to process those characters in text + +@deftypefn {Function Reference} $processed_text normal_text $text +The function processes @samp{---}, @samp{--}, @samp{``} and @samp{''} +in @var{$text} and returns @var{$processed_text}. The default is to +change @samp{---} to @samp{--}, @samp{--} to @samp{-}, and @samp{``} and +@samp{''} to @samp{"}. +@end deftypefn + +Some characters are special in @acronym{HTML} (@samp{&}, @samp{"}, +@samp{<} and @samp{>}) and should be protected. +This is done by the function associated with the function reference + +@deftypefn {Function Reference} $protected_text protect_text $text +The function processes the unprotected text @var{$text} and returns +the resulting protected text @var{$protected_text}. +@end deftypefn + +Empty lines are processed by the following function reference, which could +be usefull if empty lines are to be removed for example + +@deftypefn {Function Reference} $resulting_text empty_line $empty_line +This function processes an @var{$empty_line} and returns the resulting +text @var{$resulting_text}. Empty lines are left as is by default. +@end deftypefn + +@c -------------------------------------------------------- +@node Strings +@section Customizing strings written by @command{texi2html} + +@cindex i18n + +@command{texi2html} writes some strings in the generated document at +various places, at the page footers, on the help page, for special +section headings, buttons alt text and so on. These strings are +customizable. The string chosen depends on the language of the +document (set by @longopt{lang}, @variable{$LANG} or +@code{@@documentlanguage}). This is the basis for internationalization +as it allows for strings translations. + +The strings are found in a hash reference, @variable{$LANGUAGES}. +Each key is a language code. The associated value is also a hash +reference. The key is an english string and the associated value +is the string replacing the english string, if present. For example, +we have + +@example +$LANGUAGES->@{'fr'@} = @{ + ' Up ' => 'Plus haut', +@}; +@end example + +It means that whenever the string @samp{@ Up@ } is to be written +and the language is @samp{fr}, @samp{Plus haut} is written. It is possible +to customize the english strings by redefining the @samp{en} language hash. + +When a string contains a @samp{%} followed by @samp{@{} @var{name} @samp{@}} +it means that the string will be expanded by @command{texi2html}. For +example, if we have + +@example +$LANGUAGES->@{'fr'@} = @{ + 'See %@{node_file_href@}' => 'Voir %@{node_file_href@}', +@}; +@end example + +@samp{%@{node_file_href@}} will be expanded to an href for a node in a +file by @command{texi2html} in the string. A @samp{%%} will be expanded +as @samp{%}. + +For more on internationalization, see @ref{Internationalization}. + +@c -------------------------------------------------------- +@node References +@section References +@cindex reference + +@menu +* Reference to external manual:: +* Internal reference:: +@end menu + +@node Reference to external manual +@subsection Reference to external manual +@cindex external manual + +The references are produced with two function references, one for the +hypertextual reference construction, the other for the full reference to +external manual. + +@deftypefn {Function Reference} $href external_href $node $node_identifier $xml_node_identifier $manual_file_name +@var{$node} is the node name, with @@-commands. @var{$node_identifer} is the +node name mapped to an identifier acceptable as a file name. +@var{$xml_node_identifier} is the +node name mapped to an identifier acceptable as an @acronym{XML} identifier. +Those identifiers are built as explained in @ref{HTML Xref,,,texinfo}, +thus allowing for cross references to external manuals. @var{$file} is the +manual or file name of the external reference. This function should return an +href leading to the external manual. + +The default for this function is to make a reference compatible with +@command{makeinfo} (@pxref{HTML Xref,,,texinfo}). +@end deftypefn + +@deftypefn {Function Reference} $text external_ref $command $section $book $node_and_file $href $cross_ref_name +This function formats a reference to an external texinfo manual. +The @var{$command} is the ref command (@code{ref}, @code{xref} or +@code{pxref}, in text, at sentence beginning or in parenthesis). +The optionnal @var{$section} argument is the section in the book and + @var{book} is the book title. +@var{$node_and_file} is the node and file name formatted according to the +convention used in info: @samp{(file)node}. @var{$href} it an hypertextual +reference to the distant manual constructed using the above function. +@var{$cross_ref_name} is an optionnal cross +reference name appearing in the reference command. This function returns +the text corresponding with the external html manual reference. +This function returns the full formatted text of the external reference. +@end deftypefn + +@node Internal reference +@subsection Reference to an internal node + +A function reference is available for internal references. + +@deftypefn {Function Reference} $text internal_ref $command $href $short_name $name $is_section +This function formats a reference to a node in the current manual. +The @var{$command} is the ref command (@code{ref}, @code{xref} or +@code{pxref}, in text, at sentence beginning or in parenthesis). +@var{$href} it an hypertextual reference linking to the corresponding +node or section. @var{$short_name} and @var{$name} hold the text for the +reference but @var{$short_name} can be the node name which is assumed to +be shorter than the section name. +@var{$is_section} is a boolean true if the reference is a reference to a +section. This function returns the full formatted text of the internal +reference. +@end deftypefn + + +@c -------------------------------------------------------- +@node Alignement commands +@section Commands used for centering and flushing of text + +@cindex centering +@cindex flushing text +@cindex text alignement + +When a command controlling the alignement of text is used (@code{@@center}, +@code{@@flushleft} and @code{@@flushright}), the main program takes +care of opening and closing paragraphs. The alignement commands are the +key of the @variable{%paragraph_style} hash. +The value is used in the function doing the formatting of the paragraphs. +@xref{Paragraph and preformatted region}. + +A function references allows for a customization of the formatting of the text +appearing in the command block. + +@deftypefn {Function Reference} $result paragraph_style_command $command $text +@var{$command} is the command name, @var{$text} is the text appearing within +the command. This function returns a formatted text. +The default is to return the text unmodified. +@end deftypefn + +@c -------------------------------------------------------- +@node Paragraph and preformatted region +@section Formatting or not a paragraph or a preformatted region + + +@menu +* Paragraph and preformatted formatting:: +* Avoiding paragraphs:: +@end menu + +@node Paragraph and preformatted formatting +@subsection Paragraph and preformatted region formatting + +@cindex paragraph +@cindex preformatted region + +The formatting of a paragraph region or a preformatted region, is controlled +by function references: + +@deftypefn {Function Reference} $paragraph_text paragraph $text $alignement $formatting_command $formatting_command_formatted \$paragraph_number $format $item_number $enumerate_style $number +This function formats a paragraph. @var{$text} is the text of the paragraph, +@var{$alignement} is the empty string when no alignement command has +been seen, otherwise it is the current alignement command name. +@xref{Alignement commands}. + +The remaining arguments are usefull when the paragraph appears within a +list or table. It is usefull whenever the paragraph has to be formatted +differently when appearing in such environments. +Moreover in that case the format command (@code{@@itemize}@dots{}) +may have +an associated formatting command. +@var{$formatting_command} is this formatting command +(like @code{@@minus}). +@var{$formatting_command_formatted} is the command formatted in html +in case the formatting command is a leading command (like @code{@@minus}) +which should be leading the first paragraph. +@var{\$paragraph_number} is a reference on the number of +paragraphs in that format command. The corresponding variable should be +increased when a paragraph is added. @var{$format} is the format command. +@xref{Table and list items}. + +If the @var{$format} is an enumerate, @var{$item_number} is the number of +the item in the list, @var{$enumerate_style} is the argument of the enumerate, +@var{$number} is the number or letter corresponding with this item. +@end deftypefn + +@deftypefn {Function Reference} $preformatted_text preformatted $text $style $region_name $formatting_command $formatting_command_formatted \$preformatted_number $format $item_number $enumerate_style $number +This function formats a preformatted region. @var{$text} is the text of the +preformatted region, @var{$style} is the css style associated with that +preformatted region (@xref{css}). @var{$region_name} is the +name of the command opening +the preformatted region (@code{example}@dots{}, see @ref{Complex formats}) +or a identifier for the preformatted context (for example +@code{menu-comment}, see @ref{Menus}). +The alignment commands are not taken into account, as the spaces are +preserved in preformatted regions, you should flush and center by hand. + +The remaining arguments are usefull when the preformatted region appears +within a list or table. It is usefull whenever the preformatted region +has to be formatted +differently when appearing in such environments. +Moreover in that case the format command (@code{@@itemize}@dots{}) +may have +an associated formatting command. +@var{$formatting_command} is this formatting command +(like @code{@@minus}). +@var{$formatting_command_formatted} is the command formatted in html +in case the formatting command is a leading command (like @code{@@minus}) +which should be leading the first preformatted region. +@var{\$preformatted_number} is a reference on the number of +preformatted regions in that format command. The corresponding variable +should be increased when a preformatted region is added. @var{$format} is the +format command. +@xref{Table and list items}. + +If the @var{$format} is an enumerate, @var{$item_number} is the number of +the item in the list, @var{$enumerate_style} is the argument of the enumerate, +@var{$number} is the number or letter corresponding with this item. +@end deftypefn + +@node Avoiding paragraphs +@subsection Avoiding paragraphs in formats + +@cindex Avoid paragraph opening + +It is possible to avoid that a format closes the previous paragraph or +preformatted region and reopens one, by putting the format command in a +hash, @variable{%format_in_paragraph} with a true value. + +@c -------------------------------------------------------- +@node Complex formats +@section Formatting of complex formats (@code{@@example}, @code{@@display}@dots{}) + +@cindex complex format + +Here we see how a whole complex format is formatted. For the formatting +of the text, see @ref{Paragraph and preformatted region}. + +The formatting of the complex formats is ultimately controlled by a +function, however the default for this function uses a hash reference and +changing the hash reference values should be enough in most cases. This +hash reference is called @variable{$complex_format_map}. It has a key for each +of the complex format commands (@code{example}, @code{smallexample}, +@code{lisp}, @code{smalllisp}, @code{display}, @code{smalldisplay}, +@code{format}, @code{smallformat}). + +The associated value is also a reference on a hash. The keys are @code{begin} +and @code{end}. An eval of @code{begin} should lead to the beginning of the +formatted @acronym{HTML}, an eval of @code{end} should lead to the end of the +formatted @acronym{HTML}. The enclosed text will be formatted as described in +@ref{Paragraph and preformatted region}, and the name of the complex +format will be available to the function formatting the text. + +If you aren't satisfied with this scheme, you can redefine the following +function reference for a better control over the complex format formatting: + +@deftypefn {Function Reference} $complex_format_text complex_format $format_name $preformatted_text + +@var{$format_name} is the complex format name, @var{$preformatted_text} is the +text allready formatted as described in @ref{Paragraph and preformatted region}. +This function returns the whole complex format. +@end deftypefn + +@c -------------------------------------------------------- +@node Lists tables +@section Customizing the formatting of lists and tables + +The formatting of lists and tables is done at two levels: +@itemize +@item +At the level of the whole region (table or list), +@item +At the level of the individual items, rows or cells of the list or table. +@end itemize + +@menu +* Table and list items:: +* Whole table list:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Table and list items +@subsection Formatting individual table and list items + +In texinfo it is possible to give @code{@@itemize} or table command (hereafter +called a @dfn{format command}) a @dfn{formatting command}. +For example @code{@@minus} is the formatting command here: +@example +@@table @@minus +@end example + +The default is to apply the command to the text item, however it is possible +to avoid it. +The hash @variable{%special_list_commands} has an entry for each of the +format command. Each of these entries is a hash reference. If a formatting +command is a key of the hash reference, then the formatting command is not +applied to the text item for that format command. For example, if we have: + +@example +$special_list_commands@{'itemize'@} = @{ 'bullet' => '' @}; +@end example + +and we have the following @code{@@itemize}: +@example +@@itemize @@bullet +@@item an item +@@end itemize +@end example + +then @code{@@bullet} will not be applied to @code{an item}. + +@table @emph +@item lists +The items of lists are formatted using the following function reference: +@deftypefn {Function Reference} $list_item list_item $text $format $command $formatted_command $item_number $enumerate_style $number +This function formats the text between @code{@@item} commands. @var{$text} +is the text corresponding with the item. @var{$format} is the type of format, +@samp{itemize} or @samp{enumerate}. @var{$command} is the formatting command +given in argument to @code{@@itemize}, @var{$formatted_command} is this command +formatted if it is a leading command, like @code{@@minus}. + +If the @var{$format} is an enumerate, @var{$item_number} is the number of +the item in the list, @var{$enumerate_style} is the argument of the enumerate, +@var{$number} is the number or letter corresponding with this item. +@end deftypefn + +@item two column tables +The two columns tables (@code{@@table}, @code{@@ftable} and @code{@@vtable}), +items are formatted using two function references, +one for the first line located on the @code{@@item} line corresponding +with the first column, the other for the text appearing on the +following lines, corresponding with the second column text. + +@deftypefn {Function Reference} $table_item table_item $item_text $index_label_text $format $command $formatted_command +This function is used to format the text on the @code{@@item} line. +@var{$text_item} is the text line. In case there is an index entry +associated with the @code{@@item} (as with @code{@@ftable} and +@code{@@vtable}), @var{$index_label_text} is the text inserted at +the place where an index entry appears. @xref{Index entry place}. +@var{$format} is the type of format, +@samp{table}, @samp{ftable} or @samp{vtable}. @var{$command} is the formatting command +given in argument to the table format command, @var{$formatted_command} is +this command formatted if it is a leading command, like @code{@@minus}. +@end deftypefn + +@deftypefn {Function Reference} $table_line table_line $text +This function is used to format the text on the lines following +the @code{@@item} line. @var{$text} is the corresponding text. +@end deftypefn + +@item multitable +The multitable elements formatting is controlled by the functions associated +with two function references. One for a cell, and the other for a row. + +@deftypefn {Function Reference} $multitable_cell cell $text +This function is used to format the text of a multitable cell, the text +following a @code{@@item} or a @code{@@tab}. +@var{$text} is the corresponding text. +@end deftypefn + +@deftypefn {Function Reference} $multitable_row row $text $item_command +This function is used to format a multitable row. @var{$text} is +the row text, with cells allready formatted with the @variable{$cell} +function reference. @var{$item_command} is the command used to introduce +the row, such that it is possible to distinguish between @code{@@item} and +@code{@@headitem}. +@end deftypefn +@end table + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Whole table list +@subsection Formatting of a whole table or list + +If the Texinfo command is a key of the @variable{%format_map}, the associated +value is used to specify the formatting of the construct, otherwise a function +is called. +The value in @code{%format_map} associated with a command is interpreted +similarly with values associated with more simpler commands: + +@itemize +@item +If the text is a word, it is considered to be an @acronym{HTML} element +name, and the whole table or list is enclosed between the element opening +and the element closing. +@item +If the text is a word followed by some text, +the word and is interpreted as above, and the +text is considered to be the attributes text of the element. +@item +If the text is empty nothing is added to the text. +@end itemize + +In case the @code{%format_map} isn't used, a function reference called +@code{$table_list} +should be redefined, the associated function will be called each time +a command isn't found in @code{%format_map}. + +@deftypefn {Function Reference} $whole_table_list table_list $command $text +@var{$command} is the Texinfo command name, @var{$text} is the formatted +items. +@end deftypefn + +If you still want to use @variable{%format_map} but differently from +the default, it is possible to redefine the following function reference: + +@deftypefn {Function Reference} $whole_table_list format $command $format $text +@var{$command} is the @@-command, @var{$format} is the entry associated with +@var{$command} in @code{%format_map}. @var{$text} is the formatted items. +@end deftypefn + +@c -------------------------------------------------------- +@node Definitions +@section Definition commands formatting + +The formatting of definition commands is controlled by a hash and four +functions. The hash describes how the text on the definition line is +interpreted, the functions control the formatting of the definition line +and the definition function text. + +@menu +* Definition line:: +* Definition formatting:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Definition line +@subsection Customizing the interpretation of a definition line + +The keys of the hash @variable{%def_map} are definition command names. +There are two types of entries: + +@itemize + +@item If the command is a shortcut for +another definition command the value is a text and the definition +command is replaced by the text. + +For example if we have: +@example +$def_map@{'deftruc'@} = '@@defvr @{A truc@}'; +@end example + +and a line like +@example +@@deftruc var +@end example + +the line will be transformed in +@example +@@defvr @{A truc@} var +@end example + +@item +If the command isn't a shortcut, it is associated with an array +reference. The first element is @samp{f}, @samp{v} or @samp{t} corresponding +with the index type (@samp{f} for function, @samp{v} for variable, +@samp{t} for type). + +The remaining of the array describes how to interpret the text following +the definition command on the definition command line. +The entry item specify what corresponds +with the next bracketed item or word. Currently the possibilities are +@samp{category}, @samp{name}, @samp{type}, @samp{class} and @samp{arg}. + +For example if we have +@example +def_map@{'defvr'@} = [ 'v', 'category', 'name' ]; +@end example + +The first bracketed item following @code{@@defvr} is considered +to be the category and the next one is the name. The index associated +with the definition line is the variables index. +@end itemize + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Definition formatting +@subsection Customization of the definition formatting + +Four functions are used when formatting a definition command: + +@table @asis +@item category name +@deftypefn {Function Reference} $category definition_category $category_or_name $class $style +This function precise a category or an index entry name associating a class +@var{$class} (if given) with @var{$category_or_name}. The @var{$style} of the +definition may be @samp{f}, for function, @samp{v}, for variable or @samp{t}, +for type. +@end deftypefn +@item formatting of the definition line +@deftypefn {Function Reference} $line def_line $category $name $type $arguments $index_label +This function formats the definition line. @var{$category} is the category +formatted with @variable{$definition_category}, @var{$name}, @var{$type} and +@var{arguments} are the element of the definition line. @var{$index_label} is +the text inserted at the place where an index entry appears. +@xref{Index entry place}. +@end deftypefn + +@item definition text +@deftypefn {Function Reference} $definition_text def_item $text +This function formats the definition text, @var{$text}. +@end deftypefn + +@item the whole definition +@deftypefn {Function Reference} $definition def $text +This function formats the whole definition. The definition line and text +formatted by the above functions are in @var{$text}. +@end deftypefn + +@end table + +@c -------------------------------------------------------- +@node Headings +@section Customizing headings formatting + +A function controls the formatting of sectioning element headings, +with the corresponding function reference: +@deftypefn {Function Reference} $heading_text heading \%element_reference +The @var{\%element_reference} is a reference on a hash corresponding +with the sectioning element. The following keys are of interest: +@table @code +@item text +The heading text +@item name +The heading text without section number +@item node +true if the sectioning element is a node without associated structuring command +@item level +The level of the element in the document tree. @samp{0} is for @code{@@top}, +@samp{1} for @code{@@chapter} and so on +@item tag_level +the sectioning element name, with @code{@@raisesections} and +@code{@@lowersections} taken into account +@end table +@end deftypefn + +@c -------------------------------------------------------- +@node Special regions +@section Formatting of special regions (@code{@@verbatim}, @code{@@cartouche}, @code{@@quotation}) + +Regions corresponding with raw text, like @code{@@verbatim}, @code{@@html} +or @code{@@tex} are formatted according to the following function reference: + +@deftypefn {Function Reference} $raw_region raw $command $text +@var{$command} is the command name, @var{$text} is the raw text. +@end deftypefn + +If La@TeX{}2HTML is used, @code{@@tex} regions are handled differently, +from within the main program. + +The @code{@@cartouche} command formatting is controlled by the +function reference: + +@deftypefn {Function Reference} $cartouche cartouche $text +@var{$text} is the text appearing within the cartouche. +@end deftypefn + +The formatting of @code{@@quotation} is controlled by two function references. +The first one is usefull in case the @code{@@quotation} has an argument, as +it allows to prepend a string to the quotation text: + +@deftypefn {Function Reference} $prepended_string quotation_prepend_text $style $text +@var{$style} is the first argument of the @code{@@quotation} if there are +two arguments. @var{$text} is the second argument or the first if there is +one argument. There are still @@-commands in these strings. This function +can return a string which will be prepended to the quotation text. +@end deftypefn + +The whole quotation is formatted by: + +@deftypefn {Function Reference} $quotation quotation $quotation_text $argument_text $argument_style_texi $argument_style_id +@var{$quotation_text} is the quotation text, formatted, with the text +prepended by the function above. @var{$argument_text} is the second argument +of the @code{@@quotation} or the first if there is one argument, formatted. +The other arguments are defiend if there are two arguments for the +@code{@@quotation}, @var{$argument_style_texi} is this argument, with +@@-commands, and @var{$argument_style_id} is this argument transformed in +an identifier which can be used as an @acronym{XML} identifier. +@end deftypefn + + +@c -------------------------------------------------------- +@node Menus +@section Menu formatting + +To understand how the formatting of menus is controlled, the different +parts of a menu are first described, then how to control the formatting +of each of these parts. + +@menu +* Menu parts:: A menu consists in menu entry and menu + comments +* Menu formatting:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Menu parts +@subsection The structure of a menu + +In @command{texi2html}, a menu is considered to be composed of 2 parts, the +@dfn{menu entries} and the @dfn{menu comments}. Menu entries are further +divided in an @dfn{entry link} and optionnaly an @dfn{entry description}. +The entry link consists in a node name and an optionnal menu entry +name. + +A menu entry begins with @samp{*} at the beginning of the line. It begins +with the entry link, followed by the description. The description spans until +the next menu entry, or some text begining at the first character of a line +or an empty line, not contained within a command block which begun in the +description. An empty line or a line with text at the first character +starts a menu comment, which spans until the next menu entry. + +Here is an illustration of these rules: + +@example +@@menu +* node name: entry name. description begins + description continues +* another menu entry:: + description begins + description continues + + A menu comment, after an empty line + +* node:: description begins +A menu comment. The line starts at the first character + +* last entry:: description begins @emph{text +of the description, even if the line begins at the first character, +because we are in @@emph}. +@@end menu +@end example + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Menu formatting +@subsection The formatting of the different menu components + +In the default case, the name of the section corresponding with the +node is used instead of the node name. If @variable{$NODE_NAME_IN_MENU} is +true, however, node names are used. If @variable{$AVOID_MENU_REDUNDANCY} +is true and menu entry equal menu description the description isn't printed. +This is the default. Likewise, if node or section name equal entry name, +do not print entry name. + +A symbol, @variable{$MENU_SYMBOL} is put at the beginning of menu entries +when the node name is used. The default is @samp{•}. +If @variable{$UNNUMBERED_SYMBOL_IN_MENU} is true it is +also put at the beginning of unnumbered section names. This is not +done by default. + +The menu comments are considered to be preformatted text. The style +associated with this preformatted text is determined by +@variable{$MENU_PRE_STYLE}. Default is @samp{font-family: serif}. +The css class associated with menu comments is @code{menu-comments}. + +Three function references are associated with the formatting of the +different parts of a menu: +@deftypefn {Function Reference} $link menu_link $section \%state $href $node $name $ending +@var{$section} is the section name corresponding with the link, @var{$href} +is the link hypertextual reference. @var{$href} may be absent. @var{\%state} +holds informations about the current context. The only key which could be +of interest is @code{preformatted}, true if the context is a preformatted +context. @xref{Three contexts}. +@var{$node} is the node name, @var{$name} is the +name of the node, and @var{$ending} is the text ending the link entry. +@end deftypefn + +@deftypefn {Function Reference} $description menu_description $description_text \%state +@var{$description_text} is the text of the menu description. @var{\%state} +should be used similarly than for the menu link. +@end deftypefn + +@deftypefn {Function Reference} $menu_comment menu_comment $text +@var{$text} is the text of the menu comment. It is in a preformatted +environment. +@end deftypefn + +The following function reference controls the formatting of a wole menu: + +@deftypefn {Function Reference} $menu menu $menu_components_text +@var{$menu_components_text} is the formatted menu components text, obtained +as explained above. +@end deftypefn + +The last function reference corresponds with a special case. It +is used when a menu entry appears within another block command, to +avoid the possibilities of invalid @acronym{HTML} production. +In that case the menu description and menu comments are not formatted +specially, but treated like normal text. +@deftypefn {Function Reference} $link simple_menu_link $link_text $href $node $name $ending +@var{$link_text} is the text corresponding with the link name, @var{$href} +is the link hypertextual reference. +@var{$node} is the node name, @var{$name} is the +name of the node, and @var{$ending} is the text ending the link entry. +@end deftypefn + +@c -------------------------------------------------------- +@node Indices +@section Indices formatting + +Two different things needs to be handled for indices formatting, the place +where the index term appears, the index entry, and the index list itself. +The indexing commands like @code{@@cindex} determines where index entries +appear, and the index list is printed with a @code{@@printindex} command. + +@menu +* Index entry place:: Index entries in the main document are + targets for hypertext references +* Index list:: Customizing the formatting of the index list +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Index entry place +@subsection Formatting of index entries + +Index entry places in the main text may be the target for hypertext +references. Their formatting +is controlled by the function associated with the following function +reference: + +@deftypefn {Function Reference} $target index_entry_label $identifier $preformatted +@var{$identifier} should be used to create +a target for links (typically associated with a name or id +attribute in @acronym{HTML}). +@var{$preformatted} is true if the index entry appeared in preformatted text. +@end deftypefn + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Index list +@subsection Customizing the formatting of index lists + +The index entries are sorted alphabetically. A whole index list is +considered to be composed of letter entries. A letter entry is composed +by all the index entries beginning with that letter. A letter may +be a non alphabetical character, but we call it letter here. + +An index summary appears at the beginning and at the end of an index list, +and should be used to jump directly to a letter entry. Indices lists +may be split across pages, thus the different letters may appear on different +files. The number of index entries appearing on each page is determined +by a variable @variable{$SPLIT_INDEX} if set. The default is to split +indices after 100 entries. + +The formatting of all these elements is controlled by the following +function references: + +@table @emph +@item formatting of a letter in a summary +@deftypefn {Function Reference} $letter summary_letter $letter $file $identifier +This function is used to format a letter appearing in a summary, refering +to a letter entry in the index list. +@var{$letter} is the letter. @var{$file} is the file name where the letter +entry appears. More precisely, it is empty when the letter entry is on the +same page than the summary, it contains the file name when the index page +is split accross page. @var{$identifier} is an identifier for the target +letter entry. +@end deftypefn + +@item formatting of a summary +@deftypefn {Function Reference} $summary index_summary \@@alphabetical_letters \@@nonalphabetical_letters +@var{\@@alphabetical_letters} and @var{\@@nonalphabetical_letters} contain the +formatted summary letters, formatted with the above function. +@end deftypefn + +@item formatting of an index entry +@deftypefn {Function Reference} $entry index_entry $entry_href $entry_text $section_href $section_heading +@var{$entry_href} is a reference to the place where the index entry +appeared, @var{$entry_text} is the corresponding text. @var{$section_href} +is a reference to the beginning of the sectioning element containing +the index entry, @var{$section_heading} is the heading of the element. +@end deftypefn + +@item formatting of letter entry +@deftypefn {Function Reference} $letter_entry index_letter $letter $identifier $index_entries_text +This function formats a letter entry, consisting in all the index entries +beginning with this letter. @var{$letter} is the letter, @var{$identifier} +should be used to create a target for links (typically links from summaries), +and @var{$index_entries_text} is the text of the index entries formatted as +described above. +@end deftypefn + +@item formatting of whole index +@deftypefn {Function Reference} $index print_index $index_text $index_name +@var{$index_text} is the text of all the index entries grouped by letter +appearing in that page formatted as above. @var{index_name} is the name of +the index, the argument of @code{@@printindex}. +@end deftypefn +@end table + +@c -------------------------------------------------------- +@node Floats and lists of floats +@section Floats and lists of floats + +Floats appear in the @code{@@float} environment, optionaly with a style +and a label, and with optionnal @code{@@caption} and @code{@@shortcaption}. +Their list appear after a @code{@@listoffloats}. + +A hash reference is associated with each float, it is available in some +formatting functions. The keys are: +@table @code +@item caption_texi +@itemx shortcaption_texi +A reference on an array containing the caption or shortcaption lines, +unformatted. +@item style_texi +The style with texi @@-commands. +@item style_id +The unique identifier associated with the style. +@item nr +The number with the same conventions than makeinfo (use the chapter number a +dot and then the number of the float of that style in the chapter, or an +absolute number if in unnumbered). +@item chapter_nr +The number of the chapter containing the float. +@item nr_in_chapter +The number of the float in the chapter. +@item absolut_nr +The number of the float in the document. +@item texi +The label with @@-commands. +@item id +The unique identifier associated with the label. Usefull to make an anchor +or a reference. +@item element +A reference on a structure representing the element the float appear in. +@end table + +@menu +* Floats:: Formatting of floats +* Lists of floats:: Formatting the lists of floats +@end menu + +@node Floats +@subsection Formatting a float + +First there is an occasion to construct a texinfo text for the caption, using +the caption texinfo lines and the informations in the float structure. +The returned lines will be formatted in the main program. A function reference +is used here: + +@deftypefn {Function Reference} {(\@@caption_lines_returned, \@@shortcaption_lines_returned)} caption_shortcaption \%float \@@caption_lines \@@shortcaption_lines +@var{\%float} is the structure defined above. @var{\@@caption_lines} and +@var{\@@shortcaption_lines} are references on arrays containing the +texinfo lines for caption and short caption. @var{\@@caption_lines_returned} +and @var{\@@shortcaption_lines_returned} are references on an array +containing the texinfo lines for the caption and shortcaption. +@end deftypefn + +Then the float is formatted with the following function reference: + +@deftypefn {Function Reference} $text float $float_text \%float $caption_text $shortcaption_text +@var{$float_text} is the text appearing within the @code{@@float}, formatted. +@var{\%float} is still the structure defined above. @var{$caption_text} and +@var{$shortcaption_text} are the caption and short caption build with the +above function and formatted. +@end deftypefn + +@node Lists of floats +@subsection Formatting lists of floats + +A list of floats is introduced by @code{@@listoffloats}. The argument of +@code{@@listoffloats} is the @dfn{style}. First the style texinfo can be +modified with the following function reference: + +@deftypefn {Function Reference} $style_texi_returned listoffloats_style $style_texi +@var{$style_texi} is the @code{@@listoffloats} argument with texinfo +@@-commands kept. It is possible to make changes to the @var{$style_texi} and +return a modified string, still with @@-commands. The modified string +is formatted in the main program. +@end deftypefn + +After that, for each of the floats with that style, first there is a +possibility to modify the float style and the float caption before they +are formatted in the main program, with the following function references: + +@deftypefn {Function Reference} $float_style_texi_returned listoffloats_float_style $style_texi \%float +@var{$style_texi} is the style, and @var{\%float} is the structure described +above. This function reference returns a style to be formatted in the +main program. +@end deftypefn + +@deftypefn {Function Reference} $caption_texi_returned listoffloats_caption \%float +@var{\%float} is the structure described +above. This function reference returns a caption to be formatted in the +main program. +@end deftypefn + +Each entry is formatted by: + +@deftypefn {Function Reference} $listoffloats_entry listoffloats_entry $style_texi \%float $float_style $caption $href +@var{$style_texi} is the style with @@-commands, @var{$float_style} is the +style returned by the above function and formatted. @var{$caption} is the +caption returned by the above function formatted. @var{\%float} is the +structure corresponding with the float, and @var{$href} is an href pointing to +the float location. +@end deftypefn + +Lastly, the whole @code{@@listoffloats} is formatted by: + +@deftypefn {Function Reference} $listoffloats listoffloats $style_texi $style \@@listoffloats_entries +@var{$style_texi} is the style with @@-commands, @var{$style} is the +style returned by the above function and formatted. The array reference +@var{\@@listoffloats_entries} holds the entries formatted by the above +function. +@end deftypefn + +@c -------------------------------------------------------- +@node Footnotes +@section Customizing the footnotes formatting + +Each footnote is associated with a footnote entry. Several footnote entries +are grouped in a footnote section. When a footnote appears, two things must +be formatted: in the main text the place where the footnote appear +and the footnote text. + +Two functions, with corresponding function references control the formatting +of the footnotes: + +@deftypefn {Function Reference} {(\@@lines $text_for_document)} foot_line_and_ref $number_in_doc $number_in_page $footnote_id $place_id $document_file $footnote_file \@@lines \%state +@var{$number_in_doc} is the footnote number in the whole document, +@var{$number_in_page} is the footnote number in the current page. +@var{$footnote_id} is an identifier for the footnote in the footnote text +which should be used to make target for references to that footnote, +while @var{$place_id} is an identifier for the location of the footnote +in the main document. Similarly, @var{$document_file} is the file name +of the file containing the text where the footnote appears in the main +document, while @var{$footnote_file} is the file name of the file where +the footnote text appears. + +@var{\@@lines} is a reference on an array containing the footnote text +lines, allready formatted. +And @var{\%state} holds informations about the context at the footnote +place in the main document. As usual the most usefull entry is +@code{preformatted} which is true if the footnote appears in a preformatted +context. + +This function returns a reference on an array, @var{\@@lines} containing +the updated footnote text for the footnote entry, and @var{$text_for_document}, +the text appearing at the footnote place in the main document, linking +to the footnote entry. +@end deftypefn + +The following function is only used when footnotes are at the bottom +of a page and the document is split. +For customization of the footnotes page in case they are on a separated +page or section, @ref{Special pages layout}. For +the determination of the footnote locations, @ref{Page layout options}. + +@deffn {Function Reference} foot_section \@@footnotes_lines +This function formats a group of footnotes. @var{\@@footnotes_lines} is a +reference on an array holding the lines of all the footnote entries +formatted as explained above. This function modifies the reference. +@end deffn + +@c -------------------------------------------------------- + +@node Other and unknown commands +@section Customizing other commands, and unknown commands + +@c -------------------------------------------------------- +@c @node Skipped commands +@c @section Customizing ignored commands and text + +@cindex skipped command +@cindex unknown command + +Many commands without braces are available in texinfo, sometimes with +a specific syntax. For example we have @code{@@sp}, @code{@@noindent}, +@code{@@documentlanguage}, @code{@@oddheading}, @code{@@headings}, +@code{@@shortcontents}, @code{@@shorttitlepage} or @code{@@comment}. +@command{texi2html} interprets +some of these commands and some functions or variables are used for +their formatting or to access their information. +In the default case, however, most of these constructs are ignored. + +It is possible to change how the things following these commands +on the line are handled, what is considered to be an arg for those +commands and it is also possible to keep them instead of discarding +them such that it is possible to handle them specially, with the +same function than the one used for unknown commands. + +Those special commands without braces are the key of a hash: +@variable{%misc_command}. The associated value is a reference on a +hash enabling to set the properties of these commands. The +keys of this hash reference is the name of a property, the value +is the value of the property. For example here we have @code{line} +for the @code{arg} property for the @code{command} @@-command. + +@example +$misc_command@{'command'@} = @{'arg' => 'line', 'skip' => 'space'@}; +@end example + +The properties and possible values are: + +@table @code +@item skip +This property enables to set what is skipped after the command arguments. +Here are the possible values: +@table @code +@item line +The remaining of the line is skipped. +@item space +Spaces are skipped but not newline. +@item whitespace +Spaces are skipped +@item linewhitespace +Spaces are skipped if there are only spaces remaining on the line. +@item linespace +Spaces are skipped, but not newline if +there are only spaces remaining on the line +@end table + +@item arg +If the associated value is @code{line} the line is considered to be the +argument. If it is a number it is the number of args (separated by spaces). +@item texi +If true the arguments are considered to real texinfo, therefore + @code{@@value} and @code{@@macro} are expanded. +@item keep +If true the args and the macro are kept, otherwise they are discarded. +The defaut is to have @code{keep} undef for all the commands. +If @code{keep} is true for @code{@@verbatiminclude} the default +action for this macro isn't done. +@end table + + +Commands which don't appear in the hashes +@c @variable{%things_map} @variable{%pre_map} +@variable{%simple_map}, @variable{%simple_map_pre}, +@variable{%simple_map_texi} and @code{%misc_command}, or that appear in +@code{%misc_command} but with @code{keep} true are processed by the +following function reference: + +@deftypefn {Function Reference} {($result_line, $result, $result_text, $message)} unknown $command $line +@var{$command} is the @@-command, @var{$line} is the line following the +@var{$command}. @var{$result} is a boolean. If it is true then the other return +values are taken into account otherwise the default actions are +used. In case @var{$result} is true, @var{$result_line} is the new line +to be processed further, @var{$result_text} is the resulting formatted text +and @var{$message}, if defined is a message outputted to the output +with line number added by @command{texi2html}. +@end deftypefn + +Commands with braces not specified above +nor in @variable{%style_map}, @variable{%style_map_pre} and +@variable{%style_map_texi} are processed +by the following function reference + +@deftypefn {Function Reference} {($result, $result_text, $message)} unknown_style $command $text +@var{$command} is the @@-command, @var{$text} is the text appearing within +the braces (allready formatted). @var{$result} is a boolean. If it is true then +the other return +values are taken into account otherwise the default actions are +used. In case @var{$result} is true, @var{$result_text} is the resulting +formatted text +and @var{$message}, if defined is a message outputted to the output +with line number added by @command{texi2html}. +@end deftypefn + + +@c -------------------------------------------------------- +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@c ======================================================== +@c ======================================================== + +@node Internationalization +@appendix Internationalization + +The strings written in the document are selected based on the +document language. This can be used to customize the strings, +as described in @ref{Strings}. This also enables translation of the +strings. + +@menu +* Translating strings:: +* Adding new strings:: +@end menu + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Translating strings +@appendixsec Translating strings + +@cindex Translation +@cindex i18n +@vindex $LANGUAGES +@vindex $T2H_OBSOLETE_STRINGS + +If the language is allready supported, then there will be a file +in the @file{i18n} directory with name the two-letter +ISO-639 language code. In that case you can enhance the translations by +editing this file. There is a @code{$LANGUAGES->@{'@var{language}'@}} +hash in that file. The keys are the english strings, in @code{''}, the +values (in @code{''} after @code{=>}) are the translations. +When a string contains a @samp{%} followed by @samp{@{} @var{name} @samp{@}} +it means that the string will be expanded by @command{texi2html}. For +an example, see @ref{Strings}. + +After that you should run the command @command{./manage_i18n.pl all} in +the top directory, it should merge your file with the existing files in +@file{translations.pl}, which is incorporated to the @file{texi2html} script +by @command{./configure}. + +If the language isn't currently supported, copy the @file{en} file in +@file{i18n} to a file with name the two-letter ISO-639 +language code of your language + and then add your translations to the strings. You could also add your +two-letter language code in the @file{manage_i18n.pl} file in the +@code{@@known_languages} array. + +After that you should similarly run the command +@command{./manage_i18n.pl all} in +the top directory. + +Obsoleted strings are not removed from the files, they are still present +in the @code{$T2H_OBSOLETE_STRINGS->@{'@var{language}'@}} hash in case +the string is reused later. + +If you made change to strings specified in installed files +(@pxref{Installation}) +you will have to reinstall them otherwise the installated files will +take precedence (@pxref{Using init files}). + +@c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +@node Adding new strings +@appendixsec Adding new strings written to document + +@cindex internationalized strings +@cindex @command{manage_i18n.pl} + +If you need to write strings, for example the new string @var{a string} +to the resulting document, call @code{&$I('a string')}. Use simple quotes. +If you want to substitute a value in the string put +@code{%@{@var{string_value}@}}, in the string, and give a second argument +to @code{&$I}, a hash reference with key @var{string_value} and value +the what you want to substitute. +Here is an example: + +@example +return &$I('%@{name@} of %@{class@}', @{ 'name' => $name, 'class' => $class @}); +@end example + +In that case @code{%@{name@}} is substituted by @code{$name} in the translated +string. + +After that you should run the command @command{./manage_i18n.pl all} in the top +directory, it should add your new strings to all the files in the @file{i18n} +directory. + +@c -------------------------------------------------------- +@c commandline option index. +@node Indexop +@appendix Command Line Option Index +@printindex op +@c -------------------------------------------------------- +@node Indexvr +@appendix Variable Index +@printindex vr +@c -------------------------------------------------------- +@node Indexcp +@appendix Concept Index +@printindex cp +@bye diff --git a/Build/source/utils/texi2html/doc/texinfo.tex b/Build/source/utils/texi2html/doc/texinfo.tex new file mode 100644 index 00000000000..b88e12dec42 --- /dev/null +++ b/Build/source/utils/texi2html/doc/texinfo.tex @@ -0,0 +1,6882 @@ +% texinfo.tex -- TeX macros to handle Texinfo files. +% +% Load plain if necessary, i.e., if running under initex. +\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi +% +\def\texinfoversion{2004-02-06.08} +% +% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, +% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software +% Foundation, Inc. +% +% This texinfo.tex file is free software; you can redistribute it and/or +% modify it under the terms of the GNU General Public License as +% published by the Free Software Foundation; either version 2, or (at +% your option) any later version. +% +% This texinfo.tex file is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied warranty +% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +% General Public License for more details. +% +% You should have received a copy of the GNU General Public License +% along with this texinfo.tex file; see the file COPYING. If not, write +% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, +% Boston, MA 02111-1307, USA. +% +% As a special exception, when this file is read by TeX when processing +% a Texinfo source document, you may use the result without +% restriction. (This has been our intent since Texinfo was invented.) +% +% Please try the latest version of texinfo.tex before submitting bug +% reports; you can get the latest version from: +% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or +% ftp://tug.org/tex/texinfo.tex +% (and all CTAN mirrors, see http://www.ctan.org). +% The texinfo.tex in any given distribution could well be out +% of date, so if that's what you're using, please check. +% +% Send bug reports to bug-texinfo@gnu.org. Please include including a +% complete document in each bug report with which we can reproduce the +% problem. Patches are, of course, greatly appreciated. +% +% To process a Texinfo manual with TeX, it's most reliable to use the +% texi2dvi shell script that comes with the distribution. For a simple +% manual foo.texi, however, you can get away with this: +% tex foo.texi +% texindex foo.?? +% tex foo.texi +% tex foo.texi +% dvips foo.dvi -o # or whatever; this makes foo.ps. +% The extra TeX runs get the cross-reference information correct. +% Sometimes one run after texindex suffices, and sometimes you need more +% than two; texi2dvi does it as many times as necessary. +% +% It is possible to adapt texinfo.tex for other languages, to some +% extent. You can get the existing language-specific files from the +% full Texinfo distribution. +% +% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. + + +\message{Loading texinfo [version \texinfoversion]:} + +% If in a .fmt file, print the version number +% and turn on active characters that we couldn't do earlier because +% they might have appeared in the input file name. +\everyjob{\message{[Texinfo version \texinfoversion]}% + \catcode`+=\active \catcode`\_=\active} + +\message{Basics,} +\chardef\other=12 + +% We never want plain's \outer definition of \+ in Texinfo. +% For @tex, we can use \tabalign. +\let\+ = \relax + +% Save some plain tex macros whose names we will redefine. +\let\ptexb=\b +\let\ptexbullet=\bullet +\let\ptexc=\c +\let\ptexcomma=\, +\let\ptexdot=\. +\let\ptexdots=\dots +\let\ptexend=\end +\let\ptexequiv=\equiv +\let\ptexexclam=\! +\let\ptexfootnote=\footnote +\let\ptexgtr=> +\let\ptexhat=^ +\let\ptexi=\i +\let\ptexindent=\indent +\let\ptexnoindent=\noindent +\let\ptexinsert=\insert +\let\ptexlbrace=\{ +\let\ptexless=< +\let\ptexplus=+ +\let\ptexrbrace=\} +\let\ptexslash=\/ +\let\ptexstar=\* +\let\ptext=\t + +% If this character appears in an error message or help string, it +% starts a new line in the output. +\newlinechar = `^^J + +% Use TeX 3.0's \inputlineno to get the line number, for better error +% messages, but if we're using an old version of TeX, don't do anything. +% +\ifx\inputlineno\thisisundefined + \let\linenumber = \empty % Pre-3.0. +\else + \def\linenumber{l.\the\inputlineno:\space} +\fi + +% Set up fixed words for English if not already set. +\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi +\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi +\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi +\ifx\putwordin\undefined \gdef\putwordin{in}\fi +\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi +\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi +\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi +\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi +\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi +\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi +\ifx\putwordof\undefined \gdef\putwordof{of}\fi +\ifx\putwordon\undefined \gdef\putwordon{on}\fi +\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi +\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi +\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi +\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi +\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi +\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi +\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi +% +\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi +\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi +\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi +\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi +\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi +\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi +\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi +\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi +\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi +\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi +\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi +\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi +% +\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi +\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi +\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi +\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi +\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi + +% In some macros, we cannot use the `\? notation---the left quote is +% in some cases the escape char. +\chardef\colonChar = `\: +\chardef\commaChar = `\, +\chardef\dotChar = `\. +\chardef\exclamChar= `\! +\chardef\questChar = `\? +\chardef\semiChar = `\; +\chardef\underChar = `\_ + +\chardef\spaceChar = `\ % +\chardef\spacecat = 10 +\def\spaceisspace{\catcode\spaceChar=\spacecat} + +% Ignore a token. +% +\def\gobble#1{} + +% The following is used inside several \edef's. +\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} + +% Hyphenation fixes. +\hyphenation{ap-pen-dix} +\hyphenation{eshell} +\hyphenation{mini-buf-fer mini-buf-fers} +\hyphenation{time-stamp} +\hyphenation{white-space} + +% Margin to add to right of even pages, to left of odd pages. +\newdimen\bindingoffset +\newdimen\normaloffset +\newdimen\pagewidth \newdimen\pageheight + +% For a final copy, take out the rectangles +% that mark overfull boxes (in case you have decided +% that the text looks ok even though it passes the margin). +% +\def\finalout{\overfullrule=0pt} + +% @| inserts a changebar to the left of the current line. It should +% surround any changed text. This approach does *not* work if the +% change spans more than two lines of output. To handle that, we would +% have adopt a much more difficult approach (putting marks into the main +% vertical list for the beginning and end of each change). +% +\def\|{% + % \vadjust can only be used in horizontal mode. + \leavevmode + % + % Append this vertical mode material after the current line in the output. + \vadjust{% + % We want to insert a rule with the height and depth of the current + % leading; that is exactly what \strutbox is supposed to record. + \vskip-\baselineskip + % + % \vadjust-items are inserted at the left edge of the type. So + % the \llap here moves out into the left-hand margin. + \llap{% + % + % For a thicker or thinner bar, change the `1pt'. + \vrule height\baselineskip width1pt + % + % This is the space between the bar and the text. + \hskip 12pt + }% + }% +} + +% Sometimes it is convenient to have everything in the transcript file +% and nothing on the terminal. We don't just call \tracingall here, +% since that produces some useless output on the terminal. We also make +% some effort to order the tracing commands to reduce output in the log +% file; cf. trace.sty in LaTeX. +% +\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% +\def\loggingall{% + \tracingstats2 + \tracingpages1 + \tracinglostchars2 % 2 gives us more in etex + \tracingparagraphs1 + \tracingoutput1 + \tracingmacros2 + \tracingrestores1 + \showboxbreadth\maxdimen \showboxdepth\maxdimen + \ifx\eTeXversion\undefined\else % etex gives us more logging + \tracingscantokens1 + \tracingifs1 + \tracinggroups1 + \tracingnesting2 + \tracingassigns1 + \fi + \tracingcommands3 % 3 gives us more in etex + \errorcontextlines16 +}% + +% add check for \lastpenalty to plain's definitions. If the last thing +% we did was a \nobreak, we don't want to insert more space. +% +\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount + \removelastskip\penalty-50\smallskip\fi\fi} +\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount + \removelastskip\penalty-100\medskip\fi\fi} +\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount + \removelastskip\penalty-200\bigskip\fi\fi} + +% For @cropmarks command. +% Do @cropmarks to get crop marks. +% +\newif\ifcropmarks +\let\cropmarks = \cropmarkstrue +% +% Dimensions to add cropmarks at corners. +% Added by P. A. MacKay, 12 Nov. 1986 +% +\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines +\newdimen\cornerlong \cornerlong=1pc +\newdimen\cornerthick \cornerthick=.3pt +\newdimen\topandbottommargin \topandbottommargin=.75in + +% Main output routine. +\chardef\PAGE = 255 +\output = {\onepageout{\pagecontents\PAGE}} + +\newbox\headlinebox +\newbox\footlinebox + +% \onepageout takes a vbox as an argument. Note that \pagecontents +% does insertions, but you have to call it yourself. +\def\onepageout#1{% + \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi + % + \ifodd\pageno \advance\hoffset by \bindingoffset + \else \advance\hoffset by -\bindingoffset\fi + % + % Do this outside of the \shipout so @code etc. will be expanded in + % the headline as they should be, not taken literally (outputting ''code). + \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% + \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% + % + {% + % Have to do this stuff outside the \shipout because we want it to + % take effect in \write's, yet the group defined by the \vbox ends + % before the \shipout runs. + % + \escapechar = `\\ % use backslash in output files. + \indexdummies % don't expand commands in the output. + \normalturnoffactive % \ in index entries must not stay \, e.g., if + % the page break happens to be in the middle of an example. + \shipout\vbox{% + % Do this early so pdf references go to the beginning of the page. + \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi + % + \ifcropmarks \vbox to \outervsize\bgroup + \hsize = \outerhsize + \vskip-\topandbottommargin + \vtop to0pt{% + \line{\ewtop\hfil\ewtop}% + \nointerlineskip + \line{% + \vbox{\moveleft\cornerthick\nstop}% + \hfill + \vbox{\moveright\cornerthick\nstop}% + }% + \vss}% + \vskip\topandbottommargin + \line\bgroup + \hfil % center the page within the outer (page) hsize. + \ifodd\pageno\hskip\bindingoffset\fi + \vbox\bgroup + \fi + % + \unvbox\headlinebox + \pagebody{#1}% + \ifdim\ht\footlinebox > 0pt + % Only leave this space if the footline is nonempty. + % (We lessened \vsize for it in \oddfootingxxx.) + % The \baselineskip=24pt in plain's \makefootline has no effect. + \vskip 2\baselineskip + \unvbox\footlinebox + \fi + % + \ifcropmarks + \egroup % end of \vbox\bgroup + \hfil\egroup % end of (centering) \line\bgroup + \vskip\topandbottommargin plus1fill minus1fill + \boxmaxdepth = \cornerthick + \vbox to0pt{\vss + \line{% + \vbox{\moveleft\cornerthick\nsbot}% + \hfill + \vbox{\moveright\cornerthick\nsbot}% + }% + \nointerlineskip + \line{\ewbot\hfil\ewbot}% + }% + \egroup % \vbox from first cropmarks clause + \fi + }% end of \shipout\vbox + }% end of group with \normalturnoffactive + \advancepageno + \ifnum\outputpenalty>-20000 \else\dosupereject\fi +} + +\newinsert\margin \dimen\margin=\maxdimen + +\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} +{\catcode`\@ =11 +\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi +% marginal hacks, juha@viisa.uucp (Juha Takala) +\ifvoid\margin\else % marginal info is present + \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi +\dimen@=\dp#1 \unvbox#1 +\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi +\ifr@ggedbottom \kern-\dimen@ \vfil \fi} +} + +% Here are the rules for the cropmarks. Note that they are +% offset so that the space between them is truly \outerhsize or \outervsize +% (P. A. MacKay, 12 November, 1986) +% +\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} +\def\nstop{\vbox + {\hrule height\cornerthick depth\cornerlong width\cornerthick}} +\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} +\def\nsbot{\vbox + {\hrule height\cornerlong depth\cornerthick width\cornerthick}} + +% Parse an argument, then pass it to #1. The argument is the rest of +% the input line (except we remove a trailing comment). #1 should be a +% macro which expects an ordinary undelimited TeX argument. +% +\def\parsearg{\parseargusing{}} +\def\parseargusing#1#2{% + \def\next{#2}% + \begingroup + \obeylines + \spaceisspace + #1% + \parseargline\empty% Insert the \empty token, see \finishparsearg below. +} + +{\obeylines % + \gdef\parseargline#1^^M{% + \endgroup % End of the group started in \parsearg. + \argremovecomment #1\comment\ArgTerm% + }% +} + +% First remove any @comment, then any @c comment. +\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} +\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} + +% Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space. +% +% \argremovec might leave us with trailing space, e.g., +% @end itemize @c foo +% This space token undergoes the same procedure and is eventually removed +% by \finishparsearg. +% +\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} +\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} +\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% + \def\temp{#3}% + \ifx\temp\empty + % We cannot use \next here, as it holds the macro to run; + % thus we reuse \temp. + \let\temp\finishparsearg + \else + \let\temp\argcheckspaces + \fi + % Put the space token in: + \temp#1 #3\ArgTerm +} + +% If a _delimited_ argument is enclosed in braces, they get stripped; so +% to get _exactly_ the rest of the line, we had to prevent such situation. +% We prepended an \empty token at the very beginning and we expand it now, +% just before passing the control to \next. +% (Similarily, we have to think about #3 of \argcheckspacesY above: it is +% either the null string, or it ends with \^^M---thus there is no danger +% that a pair of braces would be stripped. +% +% But first, we have to remove the trailing space token. +% +\def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}} + +% \parseargdef\foo{...} +% is roughly equivalent to +% \def\foo{\parsearg\Xfoo} +% \def\Xfoo#1{...} +% +% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my +% favourite TeX trick. --kasal, 16nov03 + +\def\parseargdef#1{% + \expandafter \doparseargdef \csname\string#1\endcsname #1% +} +\def\doparseargdef#1#2{% + \def#2{\parsearg#1}% + \def#1##1% +} + +% Several utility definitions with active space: +{ + \obeyspaces + \gdef\obeyedspace{ } + + % Make each space character in the input produce a normal interword + % space in the output. Don't allow a line break at this space, as this + % is used only in environments like @example, where each line of input + % should produce a line of output anyway. + % + \gdef\sepspaces{\obeyspaces\let =\tie} + + % If an index command is used in an @example environment, any spaces + % therein should become regular spaces in the raw index file, not the + % expansion of \tie (\leavevmode \penalty \@M \ ). + \gdef\unsepspaces{\let =\space} +} + + +\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} + +% Define the framework for environments in texinfo.tex. It's used like this: +% +% \envdef\foo{...} +% \def\Efoo{...} +% +% It's the responsibility of \envdef to insert \begingroup before the +% actual body; @end closes the group after calling \Efoo. \envdef also +% defines \thisenv, so the current environment is known; @end checks +% whether the environment name matches. The \checkenv macro can also be +% used to check whether the current environment is the one expected. +% +% Non-false conditionals (@iftex, @ifset) don't fit into this, so they +% are not treated as enviroments; they don't open a group. (The +% implementation of @end takes care not to call \endgroup in this +% special case.) + + +% At runtime, environments start with this: +\def\startenvironment#1{\begingroup\def\thisenv{#1}} +% initialize +\let\thisenv\empty + +% ... but they get defined via ``\envdef\foo{...}'': +\long\def\envdef#1#2{\def#1{\startenvironment#1#2}} +\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} + +% Check whether we're in the right environment: +\def\checkenv#1{% + \def\temp{#1}% + \ifx\thisenv\temp + \else + \badenverr + \fi +} + +% Evironment mismatch, #1 expected: +\def\badenverr{% + \errhelp = \EMsimple + \errmessage{This command can appear only \inenvironment\temp, + not \inenvironment\thisenv}% +} +\def\inenvironment#1{% + \ifx#1\empty + out of any environment% + \else + in environment \expandafter\string#1% + \fi +} + +% @end foo executes the definition of \Efoo. +% But first, it executes a specialized version of \checkenv +% +\parseargdef\end{% + \if 1\csname iscond.#1\endcsname + \else + % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 + \expandafter\checkenv\csname#1\endcsname + \csname E#1\endcsname + \endgroup + \fi +} + +\newhelp\EMsimple{Press RETURN to continue.} + + +%% Simple single-character @ commands + +% @@ prints an @ +% Kludge this until the fonts are right (grr). +\def\@{{\tt\char64}} + +% This is turned off because it was never documented +% and you can use @w{...} around a quote to suppress ligatures. +%% Define @` and @' to be the same as ` and ' +%% but suppressing ligatures. +%\def\`{{`}} +%\def\'{{'}} + +% Used to generate quoted braces. +\def\mylbrace {{\tt\char123}} +\def\myrbrace {{\tt\char125}} +\let\{=\mylbrace +\let\}=\myrbrace +\begingroup + % Definitions to produce \{ and \} commands for indices, + % and @{ and @} for the aux file. + \catcode`\{ = \other \catcode`\} = \other + \catcode`\[ = 1 \catcode`\] = 2 + \catcode`\! = 0 \catcode`\\ = \other + !gdef!lbracecmd[\{]% + !gdef!rbracecmd[\}]% + !gdef!lbraceatcmd[@{]% + !gdef!rbraceatcmd[@}]% +!endgroup + +% @comma{} to avoid , parsing problems. +\let\comma = , + +% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent +% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. +\let\, = \c +\let\dotaccent = \. +\def\ringaccent#1{{\accent23 #1}} +\let\tieaccent = \t +\let\ubaraccent = \b +\let\udotaccent = \d + +% Other special characters: @questiondown @exclamdown @ordf @ordm +% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. +\def\questiondown{?`} +\def\exclamdown{!`} +\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} +\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} + +% Dotless i and dotless j, used for accents. +\def\imacro{i} +\def\jmacro{j} +\def\dotless#1{% + \def\temp{#1}% + \ifx\temp\imacro \ptexi + \else\ifx\temp\jmacro \j + \else \errmessage{@dotless can be used only with i or j}% + \fi\fi +} + +% The \TeX{} logo, as in plain, but resetting the spacing so that a +% period following counts as ending a sentence. (Idea found in latex.) +% +\edef\TeX{\TeX \spacefactor=3000 } + +% @LaTeX{} logo. Not quite the same results as the definition in +% latex.ltx, since we use a different font for the raised A; it's most +% convenient for us to use an explicitly smaller font, rather than using +% the \scriptstyle font (since we don't reset \scriptstyle and +% \scriptscriptstyle). +% +\def\LaTeX{% + L\kern-.36em + {\setbox0=\hbox{T}% + \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% + \kern-.15em + \TeX +} + +% Be sure we're in horizontal mode when doing a tie, since we make space +% equivalent to this in @example-like environments. Otherwise, a space +% at the beginning of a line will start with \penalty -- and +% since \penalty is valid in vertical mode, we'd end up putting the +% penalty on the vertical list instead of in the new paragraph. +{\catcode`@ = 11 + % Avoid using \@M directly, because that causes trouble + % if the definition is written into an index file. + \global\let\tiepenalty = \@M + \gdef\tie{\leavevmode\penalty\tiepenalty\ } +} + +% @: forces normal size whitespace following. +\def\:{\spacefactor=1000 } + +% @* forces a line break. +\def\*{\hfil\break\hbox{}\ignorespaces} + +% @/ allows a line break. +\let\/=\allowbreak + +% @. is an end-of-sentence period. +\def\.{.\spacefactor=3000 } + +% @! is an end-of-sentence bang. +\def\!{!\spacefactor=3000 } + +% @? is an end-of-sentence query. +\def\?{?\spacefactor=3000 } + +% @w prevents a word break. Without the \leavevmode, @w at the +% beginning of a paragraph, when TeX is still in vertical mode, would +% produce a whole line of output instead of starting the paragraph. +\def\w#1{\leavevmode\hbox{#1}} + +% @group ... @end group forces ... to be all on one page, by enclosing +% it in a TeX vbox. We use \vtop instead of \vbox to construct the box +% to keep its height that of a normal line. According to the rules for +% \topskip (p.114 of the TeXbook), the glue inserted is +% max (\topskip - \ht (first item), 0). If that height is large, +% therefore, no glue is inserted, and the space between the headline and +% the text is small, which looks bad. +% +% Another complication is that the group might be very large. This can +% cause the glue on the previous page to be unduly stretched, because it +% does not have much material. In this case, it's better to add an +% explicit \vfill so that the extra space is at the bottom. The +% threshold for doing this is if the group is more than \vfilllimit +% percent of a page (\vfilllimit can be changed inside of @tex). +% +\newbox\groupbox +\def\vfilllimit{0.7} +% +\envdef\group{% + \ifnum\catcode`\^^M=\active \else + \errhelp = \groupinvalidhelp + \errmessage{@group invalid in context where filling is enabled}% + \fi + \startsavinginserts + % + \setbox\groupbox = \vtop\bgroup + % Do @comment since we are called inside an environment such as + % @example, where each end-of-line in the input causes an + % end-of-line in the output. We don't want the end-of-line after + % the `@group' to put extra space in the output. Since @group + % should appear on a line by itself (according to the Texinfo + % manual), we don't worry about eating any user text. + \comment +} +% +% The \vtop produces a box with normal height and large depth; thus, TeX puts +% \baselineskip glue before it, and (when the next line of text is done) +% \lineskip glue after it. Thus, space below is not quite equal to space +% above. But it's pretty close. +\def\Egroup{% + % To get correct interline space between the last line of the group + % and the first line afterwards, we have to propagate \prevdepth. + \endgraf % Not \par, as it may have been set to \lisppar. + \global\dimen1 = \prevdepth + \egroup % End the \vtop. + % \dimen0 is the vertical size of the group's box. + \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox + % \dimen2 is how much space is left on the page (more or less). + \dimen2 = \pageheight \advance\dimen2 by -\pagetotal + % if the group doesn't fit on the current page, and it's a big big + % group, force a page break. + \ifdim \dimen0 > \dimen2 + \ifdim \pagetotal < \vfilllimit\pageheight + \page + \fi + \fi + \box\groupbox + \prevdepth = \dimen1 + \checkinserts +} +% +% TeX puts in an \escapechar (i.e., `@') at the beginning of the help +% message, so this ends up printing `@group can only ...'. +% +\newhelp\groupinvalidhelp{% +group can only be used in environments such as @example,^^J% +where each line of input produces a line of output.} + +% @need space-in-mils +% forces a page break if there is not space-in-mils remaining. + +\newdimen\mil \mil=0.001in + +% Old definition--didn't work. +%\parseargdef\need{\par % +%% This method tries to make TeX break the page naturally +%% if the depth of the box does not fit. +%{\baselineskip=0pt% +%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak +%\prevdepth=-1000pt +%}} + +\parseargdef\need{% + % Ensure vertical mode, so we don't make a big box in the middle of a + % paragraph. + \par + % + % If the @need value is less than one line space, it's useless. + \dimen0 = #1\mil + \dimen2 = \ht\strutbox + \advance\dimen2 by \dp\strutbox + \ifdim\dimen0 > \dimen2 + % + % Do a \strut just to make the height of this box be normal, so the + % normal leading is inserted relative to the preceding line. + % And a page break here is fine. + \vtop to #1\mil{\strut\vfil}% + % + % TeX does not even consider page breaks if a penalty added to the + % main vertical list is 10000 or more. But in order to see if the + % empty box we just added fits on the page, we must make it consider + % page breaks. On the other hand, we don't want to actually break the + % page after the empty box. So we use a penalty of 9999. + % + % There is an extremely small chance that TeX will actually break the + % page at this \penalty, if there are no other feasible breakpoints in + % sight. (If the user is using lots of big @group commands, which + % almost-but-not-quite fill up a page, TeX will have a hard time doing + % good page breaking, for example.) However, I could not construct an + % example where a page broke at this \penalty; if it happens in a real + % document, then we can reconsider our strategy. + \penalty9999 + % + % Back up by the size of the box, whether we did a page break or not. + \kern -#1\mil + % + % Do not allow a page break right after this kern. + \nobreak + \fi +} + +% @br forces paragraph break (and is undocumented). + +\let\br = \par + +% @page forces the start of a new page. +% +\def\page{\par\vfill\supereject} + +% @exdent text.... +% outputs text on separate line in roman font, starting at standard page margin + +% This records the amount of indent in the innermost environment. +% That's how much \exdent should take out. +\newskip\exdentamount + +% This defn is used inside fill environments such as @defun. +\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} + +% This defn is used inside nofill environments such as @example. +\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount + \leftline{\hskip\leftskip{\rm#1}}}} + +% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current +% paragraph. For more general purposes, use the \margin insertion +% class. WHICH is `l' or `r'. +% +\newskip\inmarginspacing \inmarginspacing=1cm +\def\strutdepth{\dp\strutbox} +% +\def\doinmargin#1#2{\strut\vadjust{% + \nobreak + \kern-\strutdepth + \vtop to \strutdepth{% + \baselineskip=\strutdepth + \vss + % if you have multiple lines of stuff to put here, you'll need to + % make the vbox yourself of the appropriate size. + \ifx#1l% + \llap{\ignorespaces #2\hskip\inmarginspacing}% + \else + \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% + \fi + \null + }% +}} +\def\inleftmargin{\doinmargin l} +\def\inrightmargin{\doinmargin r} +% +% @inmargin{TEXT [, RIGHT-TEXT]} +% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; +% else use TEXT for both). +% +\def\inmargin#1{\parseinmargin #1,,\finish} +\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \def\lefttext{#1}% have both texts + \def\righttext{#2}% + \else + \def\lefttext{#1}% have only one text + \def\righttext{#1}% + \fi + % + \ifodd\pageno + \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin + \else + \def\temp{\inleftmargin\lefttext}% + \fi + \temp +} + +% @include file insert text of that file as input. +% +\def\include{\parseargusing\filenamecatcodes\includezzz} +\def\includezzz#1{% + \pushthisfilestack + \def\thisfile{#1}% + {% + \makevalueexpandable + \def\temp{\input #1 }% + \expandafter + }\temp + \popthisfilestack +} +\def\filenamecatcodes{% + \catcode`\\=\other + \catcode`~=\other + \catcode`^=\other + \catcode`_=\other + \catcode`|=\other + \catcode`<=\other + \catcode`>=\other + \catcode`+=\other + \catcode`-=\other +} + +\def\pushthisfilestack{% + \expandafter\pushthisfilestackX\popthisfilestack\StackTerm +} +\def\pushthisfilestackX{% + \expandafter\pushthisfilestackY\thisfile\StackTerm +} +\def\pushthisfilestackY #1\StackTerm #2\StackTerm {% + \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% +} + +\def\popthisfilestack{\errthisfilestackempty} +\def\errthisfilestackempty{\errmessage{Internal error: + the stack of filenames is empty.}} + +\def\thisfile{} + +% @center line +% outputs that line, centered. +% +\parseargdef\center{% + \ifhmode + \let\next\centerH + \else + \let\next\centerV + \fi + \next{\hfil \ignorespaces#1\unskip \hfil}% +} +\def\centerH#1{% + {% + \hfil\break + \advance\hsize by -\leftskip + \advance\hsize by -\rightskip + \line{#1}% + \break + }% +} +\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} + +% @sp n outputs n lines of vertical space + +\parseargdef\sp{\vskip #1\baselineskip} + +% @comment ...line which is ignored... +% @c is the same as @comment +% @ignore ... @end ignore is another way to write a comment + +\def\comment{\begingroup \catcode`\^^M=\other% +\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% +\commentxxx} +{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} + +\let\c=\comment + +% @paragraphindent NCHARS +% We'll use ems for NCHARS, close enough. +% NCHARS can also be the word `asis' or `none'. +% We cannot feasibly implement @paragraphindent asis, though. +% +\def\asisword{asis} % no translation, these are keywords +\def\noneword{none} +% +\parseargdef\paragraphindent{% + \def\temp{#1}% + \ifx\temp\asisword + \else + \ifx\temp\noneword + \defaultparindent = 0pt + \else + \defaultparindent = #1em + \fi + \fi + \parindent = \defaultparindent +} + +% @exampleindent NCHARS +% We'll use ems for NCHARS like @paragraphindent. +% It seems @exampleindent asis isn't necessary, but +% I preserve it to make it similar to @paragraphindent. +\parseargdef\exampleindent{% + \def\temp{#1}% + \ifx\temp\asisword + \else + \ifx\temp\noneword + \lispnarrowing = 0pt + \else + \lispnarrowing = #1em + \fi + \fi +} + +% @firstparagraphindent WORD +% If WORD is `none', then suppress indentation of the first paragraph +% after a section heading. If WORD is `insert', then do indent at such +% paragraphs. +% +% The paragraph indentation is suppressed or not by calling +% \suppressfirstparagraphindent, which the sectioning commands do. +% We switch the definition of this back and forth according to WORD. +% By default, we suppress indentation. +% +\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} +\newdimen\currentparindent +% +\def\insertword{insert} +% +\parseargdef\firstparagraphindent{% + \def\temp{#1}% + \ifx\temp\noneword + \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent + \else\ifx\temp\insertword + \let\suppressfirstparagraphindent = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @firstparagraphindent option `\temp'}% + \fi\fi +} + +% Here is how we actually suppress indentation. Redefine \everypar to +% \kern backwards by \parindent, and then reset itself to empty. +% +% We also make \indent itself not actually do anything until the next +% paragraph. +% +\gdef\dosuppressfirstparagraphindent{% + \gdef\indent{% + \restorefirstparagraphindent + \indent + }% + \gdef\noindent{% + \restorefirstparagraphindent + \noindent + }% + \global\everypar = {% + \kern -\parindent + \restorefirstparagraphindent + }% +} + +\gdef\restorefirstparagraphindent{% + \global \let \indent = \ptexindent + \global \let \noindent = \ptexnoindent + \global \everypar = {}% +} + + +% @asis just yields its argument. Used with @table, for example. +% +\def\asis#1{#1} + +% @math outputs its argument in math mode. +% +% One complication: _ usually means subscripts, but it could also mean +% an actual _ character, as in @math{@var{some_variable} + 1}. So make +% _ active, and distinguish by seeing if the current family is \slfam, +% which is what @var uses. +{ + \catcode\underChar = \active + \gdef\mathunderscore{% + \catcode\underChar=\active + \def_{\ifnum\fam=\slfam \_\else\sb\fi}% + } +} +% Another complication: we want \\ (and @\) to output a \ character. +% FYI, plain.tex uses \\ as a temporary control sequence (why?), but +% this is not advertised and we don't care. Texinfo does not +% otherwise define @\. +% +% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. +\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} +% +\def\math{% + \tex + \mathunderscore + \let\\ = \mathbackslash + \mathactive + $\finishmath +} +\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. + +% Some active characters (such as <) are spaced differently in math. +% We have to reset their definitions in case the @math was an argument +% to a command which sets the catcodes (such as @item or @section). +% +{ + \catcode`^ = \active + \catcode`< = \active + \catcode`> = \active + \catcode`+ = \active + \gdef\mathactive{% + \let^ = \ptexhat + \let< = \ptexless + \let> = \ptexgtr + \let+ = \ptexplus + } +} + +% @bullet and @minus need the same treatment as @math, just above. +\def\bullet{$\ptexbullet$} +\def\minus{$-$} + +% @dots{} outputs an ellipsis using the current font. +% We do .5em per period so that it has the same spacing in a typewriter +% font as three actual period characters. +% +\def\dots{% + \leavevmode + \hbox to 1.5em{% + \hskip 0pt plus 0.25fil + .\hfil.\hfil.% + \hskip 0pt plus 0.5fil + }% +} + +% @enddots{} is an end-of-sentence ellipsis. +% +\def\enddots{% + \dots + \spacefactor=3000 +} + +% @comma{} is so commas can be inserted into text without messing up +% Texinfo's parsing. +% +\let\comma = , + +% @refill is a no-op. +\let\refill=\relax + +% If working on a large document in chapters, it is convenient to +% be able to disable indexing, cross-referencing, and contents, for test runs. +% This is done with @novalidate (before @setfilename). +% +\newif\iflinks \linkstrue % by default we want the aux files. +\let\novalidate = \linksfalse + +% @setfilename is done at the beginning of every texinfo file. +% So open here the files we need to have open while reading the input. +% This makes it possible to make a .fmt file for texinfo. +\def\setfilename{% + \fixbackslash % Turn off hack to swallow `\input texinfo'. + \iflinks + \tryauxfile + % Open the new aux file. TeX will close it automatically at exit. + \immediate\openout\auxfile=\jobname.aux + \fi % \openindices needs to do some work in any case. + \openindices + \let\setfilename=\comment % Ignore extra @setfilename cmds. + % + % If texinfo.cnf is present on the system, read it. + % Useful for site-wide @afourpaper, etc. + \openin 1 texinfo.cnf + \ifeof 1 \else \input texinfo.cnf \fi + \closein 1 + % + \comment % Ignore the actual filename. +} + +% Called from \setfilename. +% +\def\openindices{% + \newindex{cp}% + \newcodeindex{fn}% + \newcodeindex{vr}% + \newcodeindex{tp}% + \newcodeindex{ky}% + \newcodeindex{pg}% +} + +% @bye. +\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} + + +\message{pdf,} +% adobe `portable' document format +\newcount\tempnum +\newcount\lnkcount +\newtoks\filename +\newcount\filenamelength +\newcount\pgn +\newtoks\toksA +\newtoks\toksB +\newtoks\toksC +\newtoks\toksD +\newbox\boxA +\newcount\countA +\newif\ifpdf +\newif\ifpdfmakepagedest + +\ifx\pdfoutput\undefined + \pdffalse + \let\pdfmkdest = \gobble + \let\pdfurl = \gobble + \let\endlink = \relax + \let\linkcolor = \relax + \let\pdfmakeoutlines = \relax +\else + \pdftrue + \pdfoutput = 1 + \input pdfcolor + \pdfcatalog{/PageMode /UseOutlines}% + \def\dopdfimage#1#2#3{% + \def\imagewidth{#2}% + \def\imageheight{#3}% + % without \immediate, pdftex seg faults when the same image is + % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) + \ifnum\pdftexversion < 14 + \immediate\pdfimage + \else + \immediate\pdfximage + \fi + \ifx\empty\imagewidth\else width \imagewidth \fi + \ifx\empty\imageheight\else height \imageheight \fi + \ifnum\pdftexversion<13 + #1.pdf% + \else + {#1.pdf}% + \fi + \ifnum\pdftexversion < 14 \else + \pdfrefximage \pdflastximage + \fi} + \def\pdfmkdest#1{{% + % We have to set dummies so commands such as @code in a section title + % aren't expanded. + \atdummies + \normalturnoffactive + \pdfdest name{#1} xyz% + }} + \def\pdfmkpgn#1{#1} + \let\linkcolor = \Blue % was Cyan, but that seems light? + \def\endlink{\Black\pdfendlink} + % Adding outlines to PDF; macros for calculating structure of outlines + % come from Petr Olsak + \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% + \else \csname#1\endcsname \fi} + \def\advancenumber#1{\tempnum=\expnumber{#1}\relax + \advance\tempnum by 1 + \expandafter\xdef\csname#1\endcsname{\the\tempnum}} + % + % #1 is the section text. #2 is the pdf expression for the number + % of subentries (or empty, for subsubsections). #3 is the node + % text, which might be empty if this toc entry had no + % corresponding node. #4 is the page number. + % + \def\dopdfoutline#1#2#3#4{% + % Generate a link to the node text if that exists; else, use the + % page number. We could generate a destination for the section + % text in the case where a section has no node, but it doesn't + % seem worthwhile, since most documents are normally structured. + \def\pdfoutlinedest{#3}% + \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi + % + \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}% + } + % + \def\pdfmakeoutlines{% + \begingroup + % Thanh's hack / proper braces in bookmarks + \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace + \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace + % + % Read toc silently, to get counts of subentries for \pdfoutline. + \def\numchapentry##1##2##3##4{% + \def\thischapnum{##2}% + \let\thissecnum\empty + \let\thissubsecnum\empty + }% + \def\numsecentry##1##2##3##4{% + \advancenumber{chap\thischapnum}% + \def\thissecnum{##2}% + \let\thissubsecnum\empty + }% + \def\numsubsecentry##1##2##3##4{% + \advancenumber{sec\thissecnum}% + \def\thissubsecnum{##2}% + }% + \def\numsubsubsecentry##1##2##3##4{% + \advancenumber{subsec\thissubsecnum}% + }% + \let\thischapnum\empty + \let\thissecnum\empty + \let\thissubsecnum\empty + % + % use \def rather than \let here because we redefine \chapentry et + % al. a second time, below. + \def\appentry{\numchapentry}% + \def\appsecentry{\numsecentry}% + \def\appsubsecentry{\numsubsecentry}% + \def\appsubsubsecentry{\numsubsubsecentry}% + \def\unnchapentry{\numchapentry}% + \def\unnsecentry{\numsecentry}% + \def\unnsubsecentry{\numsubsecentry}% + \def\unnsubsubsecentry{\numsubsubsecentry}% + \input \jobname.toc + % + % Read toc second time, this time actually producing the outlines. + % The `-' means take the \expnumber as the absolute number of + % subentries, which we calculated on our first read of the .toc above. + % + % We use the node names as the destinations. + \def\numchapentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% + \def\numsecentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% + \def\numsubsecentry##1##2##3##4{% + \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% + \def\numsubsubsecentry##1##2##3##4{% count is always zero + \dopdfoutline{##1}{}{##3}{##4}}% + % + % PDF outlines are displayed using system fonts, instead of + % document fonts. Therefore we cannot use special characters, + % since the encoding is unknown. For example, the eogonek from + % Latin 2 (0xea) gets translated to a | character. Info from + % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. + % + % xx to do this right, we have to translate 8-bit characters to + % their "best" equivalent, based on the @documentencoding. Right + % now, I guess we'll just let the pdf reader have its way. + \indexnofonts + \turnoffactive + \input \jobname.toc + \endgroup + } + % + \def\makelinks #1,{% + \def\params{#1}\def\E{END}% + \ifx\params\E + \let\nextmakelinks=\relax + \else + \let\nextmakelinks=\makelinks + \ifnum\lnkcount>0,\fi + \picknum{#1}% + \startlink attr{/Border [0 0 0]} + goto name{\pdfmkpgn{\the\pgn}}% + \linkcolor #1% + \advance\lnkcount by 1% + \endlink + \fi + \nextmakelinks + } + \def\picknum#1{\expandafter\pn#1} + \def\pn#1{% + \def\p{#1}% + \ifx\p\lbrace + \let\nextpn=\ppn + \else + \let\nextpn=\ppnn + \def\first{#1} + \fi + \nextpn + } + \def\ppn#1{\pgn=#1\gobble} + \def\ppnn{\pgn=\first} + \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,} + \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} + \def\skipspaces#1{\def\PP{#1}\def\D{|}% + \ifx\PP\D\let\nextsp\relax + \else\let\nextsp\skipspaces + \ifx\p\space\else\addtokens{\filename}{\PP}% + \advance\filenamelength by 1 + \fi + \fi + \nextsp} + \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} + \ifnum\pdftexversion < 14 + \let \startlink \pdfannotlink + \else + \let \startlink \pdfstartlink + \fi + \def\pdfurl#1{% + \begingroup + \normalturnoffactive\def\@{@}% + \makevalueexpandable + \leavevmode\Red + \startlink attr{/Border [0 0 0]}% + user{/Subtype /Link /A << /S /URI /URI (#1) >>}% + % #1 + \endgroup} + \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} + \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} + \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} + \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} + \def\maketoks{% + \expandafter\poptoks\the\toksA|ENDTOKS| + \ifx\first0\adn0 + \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 + \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 + \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 + \else + \ifnum0=\countA\else\makelink\fi + \ifx\first.\let\next=\done\else + \let\next=\maketoks + \addtokens{\toksB}{\the\toksD} + \ifx\first,\addtokens{\toksB}{\space}\fi + \fi + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi + \next} + \def\makelink{\addtokens{\toksB}% + {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} + \def\pdflink#1{% + \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} + \linkcolor #1\endlink} + \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} +\fi % \ifx\pdfoutput + + +\message{fonts,} + +% Change the current font style to #1, remembering it in \curfontstyle. +% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in +% italics, not bold italics. +% +\def\setfontstyle#1{% + \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. + \csname ten#1\endcsname % change the current font +} + +% Select #1 fonts with the current style. +% +\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} + +\def\rm{\fam=0 \setfontstyle{rm}} +\def\it{\fam=\itfam \setfontstyle{it}} +\def\sl{\fam=\slfam \setfontstyle{sl}} +\def\bf{\fam=\bffam \setfontstyle{bf}} +\def\tt{\fam=\ttfam \setfontstyle{tt}} + +% Texinfo sort of supports the sans serif font style, which plain TeX does not. +% So we set up a \sf. +\newfam\sffam +\def\sf{\fam=\sffam \setfontstyle{sf}} +\let\li = \sf % Sometimes we call it \li, not \sf. + +% We don't need math for this font style. +\def\ttsl{\setfontstyle{ttsl}} + +% Default leading. +\newdimen\textleading \textleading = 13.2pt + +% Set the baselineskip to #1, and the lineskip and strut size +% correspondingly. There is no deep meaning behind these magic numbers +% used as factors; they just match (closely enough) what Knuth defined. +% +\def\lineskipfactor{.08333} +\def\strutheightpercent{.70833} +\def\strutdepthpercent {.29167} +% +\def\setleading#1{% + \normalbaselineskip = #1\relax + \normallineskip = \lineskipfactor\normalbaselineskip + \normalbaselines + \setbox\strutbox =\hbox{% + \vrule width0pt height\strutheightpercent\baselineskip + depth \strutdepthpercent \baselineskip + }% +} + +% Set the font macro #1 to the font named #2, adding on the +% specified font prefix (normally `cm'). +% #3 is the font's design size, #4 is a scale factor +\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} + +% Use cm as the default font prefix. +% To specify the font prefix, you must define \fontprefix +% before you read in texinfo.tex. +\ifx\fontprefix\undefined +\def\fontprefix{cm} +\fi +% Support font families that don't use the same naming scheme as CM. +\def\rmshape{r} +\def\rmbshape{bx} %where the normal face is bold +\def\bfshape{b} +\def\bxshape{bx} +\def\ttshape{tt} +\def\ttbshape{tt} +\def\ttslshape{sltt} +\def\itshape{ti} +\def\itbshape{bxti} +\def\slshape{sl} +\def\slbshape{bxsl} +\def\sfshape{ss} +\def\sfbshape{ss} +\def\scshape{csc} +\def\scbshape{csc} + +% Text fonts (11.2pt, magstep1). +\newcount\mainmagstep +\ifx\bigger\relax + % not really supported. + \mainmagstep=\magstep1 + \setfont\textrm\rmshape{12}{1000} + \setfont\texttt\ttshape{12}{1000} +\else + \mainmagstep=\magstephalf + \setfont\textrm\rmshape{10}{\mainmagstep} + \setfont\texttt\ttshape{10}{\mainmagstep} +\fi +\setfont\textbf\bfshape{10}{\mainmagstep} +\setfont\textit\itshape{10}{\mainmagstep} +\setfont\textsl\slshape{10}{\mainmagstep} +\setfont\textsf\sfshape{10}{\mainmagstep} +\setfont\textsc\scshape{10}{\mainmagstep} +\setfont\textttsl\ttslshape{10}{\mainmagstep} +\font\texti=cmmi10 scaled \mainmagstep +\font\textsy=cmsy10 scaled \mainmagstep + +% A few fonts for @defun names and args. +\setfont\defbf\bfshape{10}{\magstep1} +\setfont\deftt\ttshape{10}{\magstep1} +\setfont\defttsl\ttslshape{10}{\magstep1} +\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} + +% Fonts for indices, footnotes, small examples (9pt). +\setfont\smallrm\rmshape{9}{1000} +\setfont\smalltt\ttshape{9}{1000} +\setfont\smallbf\bfshape{10}{900} +\setfont\smallit\itshape{9}{1000} +\setfont\smallsl\slshape{9}{1000} +\setfont\smallsf\sfshape{9}{1000} +\setfont\smallsc\scshape{10}{900} +\setfont\smallttsl\ttslshape{10}{900} +\font\smalli=cmmi9 +\font\smallsy=cmsy9 + +% Fonts for small examples (8pt). +\setfont\smallerrm\rmshape{8}{1000} +\setfont\smallertt\ttshape{8}{1000} +\setfont\smallerbf\bfshape{10}{800} +\setfont\smallerit\itshape{8}{1000} +\setfont\smallersl\slshape{8}{1000} +\setfont\smallersf\sfshape{8}{1000} +\setfont\smallersc\scshape{10}{800} +\setfont\smallerttsl\ttslshape{10}{800} +\font\smalleri=cmmi8 +\font\smallersy=cmsy8 + +% Fonts for title page (20.4pt): +\setfont\titlerm\rmbshape{12}{\magstep3} +\setfont\titleit\itbshape{10}{\magstep4} +\setfont\titlesl\slbshape{10}{\magstep4} +\setfont\titlett\ttbshape{12}{\magstep3} +\setfont\titlettsl\ttslshape{10}{\magstep4} +\setfont\titlesf\sfbshape{17}{\magstep1} +\let\titlebf=\titlerm +\setfont\titlesc\scbshape{10}{\magstep4} +\font\titlei=cmmi12 scaled \magstep3 +\font\titlesy=cmsy10 scaled \magstep4 +\def\authorrm{\secrm} +\def\authortt{\sectt} + +% Chapter (and unnumbered) fonts (17.28pt). +\setfont\chaprm\rmbshape{12}{\magstep2} +\setfont\chapit\itbshape{10}{\magstep3} +\setfont\chapsl\slbshape{10}{\magstep3} +\setfont\chaptt\ttbshape{12}{\magstep2} +\setfont\chapttsl\ttslshape{10}{\magstep3} +\setfont\chapsf\sfbshape{17}{1000} +\let\chapbf=\chaprm +\setfont\chapsc\scbshape{10}{\magstep3} +\font\chapi=cmmi12 scaled \magstep2 +\font\chapsy=cmsy10 scaled \magstep3 + +% Section fonts (14.4pt). +\setfont\secrm\rmbshape{12}{\magstep1} +\setfont\secit\itbshape{10}{\magstep2} +\setfont\secsl\slbshape{10}{\magstep2} +\setfont\sectt\ttbshape{12}{\magstep1} +\setfont\secttsl\ttslshape{10}{\magstep2} +\setfont\secsf\sfbshape{12}{\magstep1} +\let\secbf\secrm +\setfont\secsc\scbshape{10}{\magstep2} +\font\seci=cmmi12 scaled \magstep1 +\font\secsy=cmsy10 scaled \magstep2 + +% Subsection fonts (13.15pt). +\setfont\ssecrm\rmbshape{12}{\magstephalf} +\setfont\ssecit\itbshape{10}{1315} +\setfont\ssecsl\slbshape{10}{1315} +\setfont\ssectt\ttbshape{12}{\magstephalf} +\setfont\ssecttsl\ttslshape{10}{1315} +\setfont\ssecsf\sfbshape{12}{\magstephalf} +\let\ssecbf\ssecrm +\setfont\ssecsc\scbshape{10}{1315} +\font\sseci=cmmi12 scaled \magstephalf +\font\ssecsy=cmsy10 scaled 1315 + +% Reduced fonts for @acro in text (10pt). +\setfont\reducedrm\rmshape{10}{1000} +\setfont\reducedtt\ttshape{10}{1000} +\setfont\reducedbf\bfshape{10}{1000} +\setfont\reducedit\itshape{10}{1000} +\setfont\reducedsl\slshape{10}{1000} +\setfont\reducedsf\sfshape{10}{1000} +\setfont\reducedsc\scshape{10}{1000} +\setfont\reducedttsl\ttslshape{10}{1000} +\font\reducedi=cmmi10 +\font\reducedsy=cmsy10 + +% In order for the font changes to affect most math symbols and letters, +% we have to define the \textfont of the standard families. Since +% texinfo doesn't allow for producing subscripts and superscripts except +% in the main text, we don't bother to reset \scriptfont and +% \scriptscriptfont (which would also require loading a lot more fonts). +% +\def\resetmathfonts{% + \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy + \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf + \textfont\ttfam=\tentt \textfont\sffam=\tensf +} + +% The font-changing commands redefine the meanings of \tenSTYLE, instead +% of just \STYLE. We do this because \STYLE needs to also set the +% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire +% \tenSTYLE to set the current font. +% +% Each font-changing command also sets the names \lsize (one size lower) +% and \lllsize (three sizes lower). These relative commands are used in +% the LaTeX logo and acronyms. +% +% This all needs generalizing, badly. +% +\def\textfonts{% + \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl + \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc + \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy + \let\tenttsl=\textttsl + \def\lsize{reduced}\def\lllsize{smaller}% + \resetmathfonts \setleading{\textleading}} +\def\titlefonts{% + \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl + \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc + \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy + \let\tenttsl=\titlettsl + \def\lsize{chap}\def\lllsize{subsec}% + \resetmathfonts \setleading{25pt}} +\def\titlefont#1{{\titlefonts\rm #1}} +\def\chapfonts{% + \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl + \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc + \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl + \def\lsize{sec}\def\lllsize{text}% + \resetmathfonts \setleading{19pt}} +\def\secfonts{% + \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl + \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc + \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy + \let\tenttsl=\secttsl + \def\lsize{subsec}\def\lllsize{reduced}% + \resetmathfonts \setleading{16pt}} +\def\subsecfonts{% + \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl + \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc + \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy + \let\tenttsl=\ssecttsl + \def\lsize{text}\def\lllsize{small}% + \resetmathfonts \setleading{15pt}} +\let\subsubsecfonts = \subsecfonts +\def\reducedfonts{% + \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl + \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc + \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy + \let\tenttsl=\reducedttsl + \def\lsize{small}\def\lllsize{smaller}% + \resetmathfonts \setleading{10.5pt}} +\def\smallfonts{% + \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl + \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc + \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy + \let\tenttsl=\smallttsl + \def\lsize{smaller}\def\lllsize{smaller}% + \resetmathfonts \setleading{10.5pt}} +\def\smallerfonts{% + \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl + \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc + \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy + \let\tenttsl=\smallerttsl + \def\lsize{smaller}\def\lllsize{smaller}% + \resetmathfonts \setleading{9.5pt}} + +% Set the fonts to use with the @small... environments. +\let\smallexamplefonts = \smallfonts + +% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample +% can fit this many characters: +% 8.5x11=86 smallbook=72 a4=90 a5=69 +% If we use \scriptfonts (8pt), then we can fit this many characters: +% 8.5x11=90+ smallbook=80 a4=90+ a5=77 +% For me, subjectively, the few extra characters that fit aren't worth +% the additional smallness of 8pt. So I'm making the default 9pt. +% +% By the way, for comparison, here's what fits with @example (10pt): +% 8.5x11=71 smallbook=60 a4=75 a5=58 +% +% I wish the USA used A4 paper. +% --karl, 24jan03. + + +% Set up the default fonts, so we can use them for creating boxes. +% +\textfonts \rm + +% Define these so they can be easily changed for other fonts. +\def\angleleft{$\langle$} +\def\angleright{$\rangle$} + +% Count depth in font-changes, for error checks +\newcount\fontdepth \fontdepth=0 + +% Fonts for short table of contents. +\setfont\shortcontrm\rmshape{12}{1000} +\setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 +\setfont\shortcontsl\slshape{12}{1000} +\setfont\shortconttt\ttshape{12}{1000} + +%% Add scribe-like font environments, plus @l for inline lisp (usually sans +%% serif) and @ii for TeX italic + +% \smartitalic{ARG} outputs arg in italics, followed by an italic correction +% unless the following character is such as not to need one. +\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else + \ptexslash\fi\fi\fi} +\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} +\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} + +% like \smartslanted except unconditionally uses \ttsl. +% @var is set to this for defun arguments. +\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} + +% like \smartslanted except unconditionally use \sl. We never want +% ttsl for book titles, do we? +\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} + +\let\i=\smartitalic +\let\var=\smartslanted +\let\dfn=\smartslanted +\let\emph=\smartitalic + +\def\b#1{{\bf #1}} +\let\strong=\b + +% We can't just use \exhyphenpenalty, because that only has effect at +% the end of a paragraph. Restore normal hyphenation at the end of the +% group within which \nohyphenation is presumably called. +% +\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} +\def\restorehyphenation{\hyphenchar\font = `- } + +% Set sfcode to normal for the chars that usually have another value. +% Can't use plain's \frenchspacing because it uses the `\x notation, and +% sometimes \x has an active definition that messes things up. +% +\catcode`@=11 + \def\frenchspacing{% + \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m + \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m + } +\catcode`@=\other + +\def\t#1{% + {\tt \rawbackslash \frenchspacing #1}% + \null +} +\def\samp#1{`\tclose{#1}'\null} +\setfont\keyrm\rmshape{8}{1000} +\font\keysy=cmsy9 +\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% + \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% + \vbox{\hrule\kern-0.4pt + \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% + \kern-0.4pt\hrule}% + \kern-.06em\raise0.4pt\hbox{\angleright}}}} +% The old definition, with no lozenge: +%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} +\def\ctrl #1{{\tt \rawbackslash \hat}#1} + +% @file, @option are the same as @samp. +\let\file=\samp +\let\option=\samp + +% @code is a modification of @t, +% which makes spaces the same size as normal in the surrounding text. +\def\tclose#1{% + {% + % Change normal interword space to be same as for the current font. + \spaceskip = \fontdimen2\font + % + % Switch to typewriter. + \tt + % + % But `\ ' produces the large typewriter interword space. + \def\ {{\spaceskip = 0pt{} }}% + % + % Turn off hyphenation. + \nohyphenation + % + \rawbackslash + \frenchspacing + #1% + }% + \null +} + +% We *must* turn on hyphenation at `-' and `_' in @code. +% Otherwise, it is too hard to avoid overfull hboxes +% in the Emacs manual, the Library manual, etc. + +% Unfortunately, TeX uses one parameter (\hyphenchar) to control +% both hyphenation at - and hyphenation within words. +% We must therefore turn them both off (\tclose does that) +% and arrange explicitly to hyphenate at a dash. +% -- rms. +{ + \catcode`\-=\active + \catcode`\_=\active + % + \global\def\code{\begingroup + \catcode`\-=\active \let-\codedash + \catcode`\_=\active \let_\codeunder + \codex + } +} + +\def\realdash{-} +\def\codedash{-\discretionary{}{}{}} +\def\codeunder{% + % this is all so @math{@code{var_name}+1} can work. In math mode, _ + % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) + % will therefore expand the active definition of _, which is us + % (inside @code that is), therefore an endless loop. + \ifusingtt{\ifmmode + \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. + \else\normalunderscore \fi + \discretionary{}{}{}}% + {\_}% +} +\def\codex #1{\tclose{#1}\endgroup} + +% @kbd is like @code, except that if the argument is just one @key command, +% then @kbd has no effect. + +% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), +% `example' (@kbd uses ttsl only inside of @example and friends), +% or `code' (@kbd uses normal tty font always). +\parseargdef\kbdinputstyle{% + \def\arg{#1}% + \ifx\arg\worddistinct + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% + \else\ifx\arg\wordexample + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% + \else\ifx\arg\wordcode + \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% + \else + \errhelp = \EMsimple + \errmessage{Unknown @kbdinputstyle option `\arg'}% + \fi\fi\fi +} +\def\worddistinct{distinct} +\def\wordexample{example} +\def\wordcode{code} + +% Default is `distinct.' +\kbdinputstyle distinct + +\def\xkey{\key} +\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% +\ifx\one\xkey\ifx\threex\three \key{#2}% +\else{\tclose{\kbdfont\look}}\fi +\else{\tclose{\kbdfont\look}}\fi} + +% For @url, @env, @command quotes seem unnecessary, so use \code. +\let\url=\code +\let\env=\code +\let\command=\code + +% @uref (abbreviation for `urlref') takes an optional (comma-separated) +% second argument specifying the text to display and an optional third +% arg as text to display instead of (rather than in addition to) the url +% itself. First (mandatory) arg is the url. Perhaps eventually put in +% a hypertex \special here. +% +\def\uref#1{\douref #1,,,\finish} +\def\douref#1,#2,#3,#4\finish{\begingroup + \unsepspaces + \pdfurl{#1}% + \setbox0 = \hbox{\ignorespaces #3}% + \ifdim\wd0 > 0pt + \unhbox0 % third arg given, show only that + \else + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \ifpdf + \unhbox0 % PDF: 2nd arg given, show only it + \else + \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url + \fi + \else + \code{#1}% only url given, so show it + \fi + \fi + \endlink +\endgroup} + +% rms does not like angle brackets --karl, 17may97. +% So now @email is just like @uref, unless we are pdf. +% +%\def\email#1{\angleleft{\tt #1}\angleright} +\ifpdf + \def\email#1{\doemail#1,,\finish} + \def\doemail#1,#2,#3\finish{\begingroup + \unsepspaces + \pdfurl{mailto:#1}% + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi + \endlink + \endgroup} +\else + \let\email=\uref +\fi + +% Check if we are currently using a typewriter font. Since all the +% Computer Modern typewriter fonts have zero interword stretch (and +% shrink), and it is reasonable to expect all typewriter fonts to have +% this property, we can check that font parameter. +% +\def\ifmonospace{\ifdim\fontdimen3\font=0pt } + +% Typeset a dimension, e.g., `in' or `pt'. The only reason for the +% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. +% +\def\dmn#1{\thinspace #1} + +\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} + +% @l was never documented to mean ``switch to the Lisp font'', +% and it is not used as such in any manual I can find. We need it for +% Polish suppressed-l. --karl, 22sep96. +%\def\l#1{{\li #1}\null} + +% Explicit font changes: @r, @sc, undocumented @ii. +\def\r#1{{\rm #1}} % roman font +\def\sc#1{{\smallcaps#1}} % smallcaps font +\def\ii#1{{\it #1}} % italic font + +\def\acronym#1{\doacronym #1,,\finish} +\def\doacronym#1,#2,#3\finish{% + {\selectfonts\lsize #1}% + \def\temp{#2}% + \ifx\temp\empty \else + \space ({\unsepspaces \ignorespaces \temp \unskip})% + \fi +} + +% @pounds{} is a sterling sign, which is in the CM italic font. +% +\def\pounds{{\it\$}} + +% @registeredsymbol - R in a circle. The font for the R should really +% be smaller yet, but lllsize is the best we can do for now. +% Adapted from the plain.tex definition of \copyright. +% +\def\registeredsymbol{% + $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% + \hfil\crcr\Orb}}% + }$% +} + + +\message{page headings,} + +\newskip\titlepagetopglue \titlepagetopglue = 1.5in +\newskip\titlepagebottomglue \titlepagebottomglue = 2pc + +% First the title page. Must do @settitle before @titlepage. +\newif\ifseenauthor +\newif\iffinishedtitlepage + +% Do an implicit @contents or @shortcontents after @end titlepage if the +% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. +% +\newif\ifsetcontentsaftertitlepage + \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue +\newif\ifsetshortcontentsaftertitlepage + \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue + +\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% + \endgroup\page\hbox{}\page} + +\envdef\titlepage{% + % Open one extra group, as we want to close it in the middle of \Etitlepage. + \begingroup + \parindent=0pt \textfonts + % Leave some space at the very top of the page. + \vglue\titlepagetopglue + % No rule at page bottom unless we print one at the top with @title. + \finishedtitlepagetrue + % + % Most title ``pages'' are actually two pages long, with space + % at the top of the second. We don't want the ragged left on the second. + \let\oldpage = \page + \def\page{% + \iffinishedtitlepage\else + \finishtitlepage + \fi + \let\page = \oldpage + \page + \null + }% +} + +\def\Etitlepage{% + \iffinishedtitlepage\else + \finishtitlepage + \fi + % It is important to do the page break before ending the group, + % because the headline and footline are only empty inside the group. + % If we use the new definition of \page, we always get a blank page + % after the title page, which we certainly don't want. + \oldpage + \endgroup + % + % Need this before the \...aftertitlepage checks so that if they are + % in effect the toc pages will come out with page numbers. + \HEADINGSon + % + % If they want short, they certainly want long too. + \ifsetshortcontentsaftertitlepage + \shortcontents + \contents + \global\let\shortcontents = \relax + \global\let\contents = \relax + \fi + % + \ifsetcontentsaftertitlepage + \contents + \global\let\contents = \relax + \global\let\shortcontents = \relax + \fi +} + +\def\finishtitlepage{% + \vskip4pt \hrule height 2pt width \hsize + \vskip\titlepagebottomglue + \finishedtitlepagetrue +} + +%%% Macros to be used within @titlepage: + +\let\subtitlerm=\tenrm +\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} + +\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines + \let\tt=\authortt} + +\parseargdef\title{% + \checkenv\titlepage + \leftline{\titlefonts\rm #1} + % print a rule at the page bottom also. + \finishedtitlepagefalse + \vskip4pt \hrule height 4pt width \hsize \vskip4pt +} + +\parseargdef\subtitle{% + \checkenv\titlepage + {\subtitlefont \rightline{#1}}% +} + +% @author should come last, but may come many times. +\parseargdef\author{% + \def\temp{\quotation}% + \ifx\thisenv\temp + This edition of the manual is dedicated to Karl Berry who should + really make affiliations work. + \else + \checkenv\titlepage + \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi + {\authorfont \leftline{#1}}% + \fi +} + + +%%% Set up page headings and footings. + +\let\thispage=\folio + +\newtoks\evenheadline % headline on even pages +\newtoks\oddheadline % headline on odd pages +\newtoks\evenfootline % footline on even pages +\newtoks\oddfootline % footline on odd pages + +% Now make TeX use those variables +\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline + \else \the\evenheadline \fi}} +\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline + \else \the\evenfootline \fi}\HEADINGShook} +\let\HEADINGShook=\relax + +% Commands to set those variables. +% For example, this is what @headings on does +% @evenheading @thistitle|@thispage|@thischapter +% @oddheading @thischapter|@thispage|@thistitle +% @evenfooting @thisfile|| +% @oddfooting ||@thisfile + + +\def\evenheading{\parsearg\evenheadingxxx} +\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} +\def\evenheadingyyy #1\|#2\|#3\|#4\finish{% +\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\def\oddheading{\parsearg\oddheadingxxx} +\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} +\def\oddheadingyyy #1\|#2\|#3\|#4\finish{% +\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% + +\def\evenfooting{\parsearg\evenfootingxxx} +\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} +\def\evenfootingyyy #1\|#2\|#3\|#4\finish{% +\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} + +\def\oddfooting{\parsearg\oddfootingxxx} +\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} +\def\oddfootingyyy #1\|#2\|#3\|#4\finish{% + \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% + % + % Leave some space for the footline. Hopefully ok to assume + % @evenfooting will not be used by itself. + \global\advance\pageheight by -\baselineskip + \global\advance\vsize by -\baselineskip +} + +\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} + + +% @headings double turns headings on for double-sided printing. +% @headings single turns headings on for single-sided printing. +% @headings off turns them off. +% @headings on same as @headings double, retained for compatibility. +% @headings after turns on double-sided headings after this page. +% @headings doubleafter turns on double-sided headings after this page. +% @headings singleafter turns on single-sided headings after this page. +% By default, they are off at the start of a document, +% and turned `on' after @end titlepage. + +\def\headings #1 {\csname HEADINGS#1\endcsname} + +\def\HEADINGSoff{% +\global\evenheadline={\hfil} \global\evenfootline={\hfil} +\global\oddheadline={\hfil} \global\oddfootline={\hfil}} +\HEADINGSoff +% When we turn headings on, set the page number to 1. +% For double-sided printing, put current file name in lower left corner, +% chapter name on inside top of right hand pages, document +% title on inside top of left hand pages, and page numbers on outside top +% edge of all pages. +\def\HEADINGSdouble{% +\global\pageno=1 +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\folio\hfil\thistitle}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chapoddpage +} +\let\contentsalignmacro = \chappager + +% For single-sided printing, chapter title goes across top left of page, +% page number on top right. +\def\HEADINGSsingle{% +\global\pageno=1 +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\thischapter\hfil\folio}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chappager +} +\def\HEADINGSon{\HEADINGSdouble} + +\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} +\let\HEADINGSdoubleafter=\HEADINGSafter +\def\HEADINGSdoublex{% +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\folio\hfil\thistitle}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chapoddpage +} + +\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} +\def\HEADINGSsinglex{% +\global\evenfootline={\hfil} +\global\oddfootline={\hfil} +\global\evenheadline={\line{\thischapter\hfil\folio}} +\global\oddheadline={\line{\thischapter\hfil\folio}} +\global\let\contentsalignmacro = \chappager +} + +% Subroutines used in generating headings +% This produces Day Month Year style of output. +% Only define if not already defined, in case a txi-??.tex file has set +% up a different format (e.g., txi-cs.tex does this). +\ifx\today\undefined +\def\today{% + \number\day\space + \ifcase\month + \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr + \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug + \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec + \fi + \space\number\year} +\fi + +% @settitle line... specifies the title of the document, for headings. +% It generates no output of its own. +\def\thistitle{\putwordNoTitle} +\def\settitle{\parsearg{\gdef\thistitle}} + + +\message{tables,} +% Tables -- @table, @ftable, @vtable, @item(x). + +% default indentation of table text +\newdimen\tableindent \tableindent=.8in +% default indentation of @itemize and @enumerate text +\newdimen\itemindent \itemindent=.3in +% margin between end of table item and start of table text. +\newdimen\itemmargin \itemmargin=.1in + +% used internally for \itemindent minus \itemmargin +\newdimen\itemmax + +% Note @table, @ftable, and @vtable define @item, @itemx, etc., with +% these defs. +% They also define \itemindex +% to index the item name in whatever manner is desired (perhaps none). + +\newif\ifitemxneedsnegativevskip + +\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} + +\def\internalBitem{\smallbreak \parsearg\itemzzz} +\def\internalBitemx{\itemxpar \parsearg\itemzzz} + +\def\itemzzz #1{\begingroup % + \advance\hsize by -\rightskip + \advance\hsize by -\tableindent + \setbox0=\hbox{\itemindicate{#1}}% + \itemindex{#1}% + \nobreak % This prevents a break before @itemx. + % + % If the item text does not fit in the space we have, put it on a line + % by itself, and do not allow a page break either before or after that + % line. We do not start a paragraph here because then if the next + % command is, e.g., @kindex, the whatsit would get put into the + % horizontal list on a line by itself, resulting in extra blank space. + \ifdim \wd0>\itemmax + % + % Make this a paragraph so we get the \parskip glue and wrapping, + % but leave it ragged-right. + \begingroup + \advance\leftskip by-\tableindent + \advance\hsize by\tableindent + \advance\rightskip by0pt plus1fil + \leavevmode\unhbox0\par + \endgroup + % + % We're going to be starting a paragraph, but we don't want the + % \parskip glue -- logically it's part of the @item we just started. + \nobreak \vskip-\parskip + % + % Stop a page break at the \parskip glue coming up. (Unfortunately + % we can't prevent a possible page break at the following + % \baselineskip glue.) However, if what follows is an environment + % such as @example, there will be no \parskip glue; then + % the negative vskip we just would cause the example and the item to + % crash together. So we use this bizarre value of 10001 as a signal + % to \aboveenvbreak to insert \parskip glue after all. + % (Possibly there are other commands that could be followed by + % @example which need the same treatment, but not section titles; or + % maybe section titles are the only special case and they should be + % penalty 10001...) + \penalty 10001 + \endgroup + \itemxneedsnegativevskipfalse + \else + % The item text fits into the space. Start a paragraph, so that the + % following text (if any) will end up on the same line. + \noindent + % Do this with kerns and \unhbox so that if there is a footnote in + % the item text, it can migrate to the main vertical list and + % eventually be printed. + \nobreak\kern-\tableindent + \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 + \unhbox0 + \nobreak\kern\dimen0 + \endgroup + \itemxneedsnegativevskiptrue + \fi +} + +\def\item{\errmessage{@item while not in a list environment}} +\def\itemx{\errmessage{@itemx while not in a list environment}} + +% @table, @ftable, @vtable. +\envdef\table{% + \let\itemindex\gobble + \tablex +} +\envdef\ftable{% + \def\itemindex ##1{\doind {fn}{\code{##1}}}% + \tablex +} +\envdef\vtable{% + \def\itemindex ##1{\doind {vr}{\code{##1}}}% + \tablex +} +\def\tablex#1{% + \def\itemindicate{#1}% + \parsearg\tabley +} +\def\tabley#1{% + {% + \makevalueexpandable + \edef\temp{\noexpand\tablez #1\space\space\space}% + \expandafter + }\temp \endtablez +} +\def\tablez #1 #2 #3 #4\endtablez{% + \aboveenvbreak + \ifnum 0#1>0 \advance \leftskip by #1\mil \fi + \ifnum 0#2>0 \tableindent=#2\mil \fi + \ifnum 0#3>0 \advance \rightskip by #3\mil \fi + \itemmax=\tableindent + \advance \itemmax by -\itemmargin + \advance \leftskip by \tableindent + \exdentamount=\tableindent + \parindent = 0pt + \parskip = \smallskipamount + \ifdim \parskip=0pt \parskip=2pt \fi + \let\item = \internalBitem + \let\itemx = \internalBitemx +} +\def\Etable{\endgraf\afterenvbreak} +\let\Eftable\Etable +\let\Evtable\Etable +\let\Eitemize\Etable +\let\Eenumerate\Etable + +% This is the counter used by @enumerate, which is really @itemize + +\newcount \itemno + +\envdef\itemize{\parsearg\doitemize} + +\def\doitemize#1{% + \aboveenvbreak + \itemmax=\itemindent + \advance\itemmax by -\itemmargin + \advance\leftskip by \itemindent + \exdentamount=\itemindent + \parindent=0pt + \parskip=\smallskipamount + \ifdim\parskip=0pt \parskip=2pt \fi + \def\itemcontents{#1}% + % @itemize with no arg is equivalent to @itemize @bullet. + \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi + \let\item=\itemizeitem +} + +% Definition of @item while inside @itemize and @enumerate. +% +\def\itemizeitem{% + \advance\itemno by 1 % for enumerations + {\let\par=\endgraf \smallbreak}% reasonable place to break + {% + % If the document has an @itemize directly after a section title, a + % \nobreak will be last on the list, and \sectionheading will have + % done a \vskip-\parskip. In that case, we don't want to zero + % parskip, or the item text will crash with the heading. On the + % other hand, when there is normal text preceding the item (as there + % usually is), we do want to zero parskip, or there would be too much + % space. In that case, we won't have a \nobreak before. At least + % that's the theory. + \ifnum\lastpenalty<10000 \parskip=0in \fi + \noindent + \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% + \vadjust{\penalty 1200}}% not good to break after first line of item. + \flushcr +} + +% \splitoff TOKENS\endmark defines \first to be the first token in +% TOKENS, and \rest to be the remainder. +% +\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% + +% Allow an optional argument of an uppercase letter, lowercase letter, +% or number, to specify the first label in the enumerated list. No +% argument is the same as `1'. +% +\envparseargdef\enumerate{\enumeratey #1 \endenumeratey} +\def\enumeratey #1 #2\endenumeratey{% + % If we were given no argument, pretend we were given `1'. + \def\thearg{#1}% + \ifx\thearg\empty \def\thearg{1}\fi + % + % Detect if the argument is a single token. If so, it might be a + % letter. Otherwise, the only valid thing it can be is a number. + % (We will always have one token, because of the test we just made. + % This is a good thing, since \splitoff doesn't work given nothing at + % all -- the first parameter is undelimited.) + \expandafter\splitoff\thearg\endmark + \ifx\rest\empty + % Only one token in the argument. It could still be anything. + % A ``lowercase letter'' is one whose \lccode is nonzero. + % An ``uppercase letter'' is one whose \lccode is both nonzero, and + % not equal to itself. + % Otherwise, we assume it's a number. + % + % We need the \relax at the end of the \ifnum lines to stop TeX from + % continuing to look for a <number>. + % + \ifnum\lccode\expandafter`\thearg=0\relax + \numericenumerate % a number (we hope) + \else + % It's a letter. + \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax + \lowercaseenumerate % lowercase letter + \else + \uppercaseenumerate % uppercase letter + \fi + \fi + \else + % Multiple tokens in the argument. We hope it's a number. + \numericenumerate + \fi +} + +% An @enumerate whose labels are integers. The starting integer is +% given in \thearg. +% +\def\numericenumerate{% + \itemno = \thearg + \startenumeration{\the\itemno}% +} + +% The starting (lowercase) letter is in \thearg. +\def\lowercaseenumerate{% + \itemno = \expandafter`\thearg + \startenumeration{% + % Be sure we're not beyond the end of the alphabet. + \ifnum\itemno=0 + \errmessage{No more lowercase letters in @enumerate; get a bigger + alphabet}% + \fi + \char\lccode\itemno + }% +} + +% The starting (uppercase) letter is in \thearg. +\def\uppercaseenumerate{% + \itemno = \expandafter`\thearg + \startenumeration{% + % Be sure we're not beyond the end of the alphabet. + \ifnum\itemno=0 + \errmessage{No more uppercase letters in @enumerate; get a bigger + alphabet} + \fi + \char\uccode\itemno + }% +} + +% Call \doitemize, adding a period to the first argument and supplying the +% common last two arguments. Also subtract one from the initial value in +% \itemno, since @item increments \itemno. +% +\def\startenumeration#1{% + \advance\itemno by -1 + \doitemize{#1.}\flushcr +} + +% @alphaenumerate and @capsenumerate are abbreviations for giving an arg +% to @enumerate. +% +\def\alphaenumerate{\enumerate{a}} +\def\capsenumerate{\enumerate{A}} +\def\Ealphaenumerate{\Eenumerate} +\def\Ecapsenumerate{\Eenumerate} + + +% @multitable macros +% Amy Hendrickson, 8/18/94, 3/6/96 +% +% @multitable ... @end multitable will make as many columns as desired. +% Contents of each column will wrap at width given in preamble. Width +% can be specified either with sample text given in a template line, +% or in percent of \hsize, the current width of text on page. + +% Table can continue over pages but will only break between lines. + +% To make preamble: +% +% Either define widths of columns in terms of percent of \hsize: +% @multitable @columnfractions .25 .3 .45 +% @item ... +% +% Numbers following @columnfractions are the percent of the total +% current hsize to be used for each column. You may use as many +% columns as desired. + + +% Or use a template: +% @multitable {Column 1 template} {Column 2 template} {Column 3 template} +% @item ... +% using the widest term desired in each column. + +% Each new table line starts with @item, each subsequent new column +% starts with @tab. Empty columns may be produced by supplying @tab's +% with nothing between them for as many times as empty columns are needed, +% ie, @tab@tab@tab will produce two empty columns. + +% @item, @tab do not need to be on their own lines, but it will not hurt +% if they are. + +% Sample multitable: + +% @multitable {Column 1 template} {Column 2 template} {Column 3 template} +% @item first col stuff @tab second col stuff @tab third col +% @item +% first col stuff +% @tab +% second col stuff +% @tab +% third col +% @item first col stuff @tab second col stuff +% @tab Many paragraphs of text may be used in any column. +% +% They will wrap at the width determined by the template. +% @item@tab@tab This will be in third column. +% @end multitable + +% Default dimensions may be reset by user. +% @multitableparskip is vertical space between paragraphs in table. +% @multitableparindent is paragraph indent in table. +% @multitablecolmargin is horizontal space to be left between columns. +% @multitablelinespace is space to leave between table items, baseline +% to baseline. +% 0pt means it depends on current normal line spacing. +% +\newskip\multitableparskip +\newskip\multitableparindent +\newdimen\multitablecolspace +\newskip\multitablelinespace +\multitableparskip=0pt +\multitableparindent=6pt +\multitablecolspace=12pt +\multitablelinespace=0pt + +% Macros used to set up halign preamble: +% +\let\endsetuptable\relax +\def\xendsetuptable{\endsetuptable} +\let\columnfractions\relax +\def\xcolumnfractions{\columnfractions} +\newif\ifsetpercent + +% #1 is the part of the @columnfraction before the decimal point, which +% is presumably either 0 or the empty string (but we don't check, we +% just throw it away). #2 is the decimal part, which we use as the +% percent of \hsize for this column. +\def\pickupwholefraction#1.#2 {% + \global\advance\colcount by 1 + \expandafter\xdef\csname col\the\colcount\endcsname{.#2\hsize}% + \setuptable +} + +\newcount\colcount +\def\setuptable#1{% + \def\firstarg{#1}% + \ifx\firstarg\xendsetuptable + \let\go = \relax + \else + \ifx\firstarg\xcolumnfractions + \global\setpercenttrue + \else + \ifsetpercent + \let\go\pickupwholefraction + \else + \global\advance\colcount by 1 + \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a + % separator; typically that is always in the input, anyway. + \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% + \fi + \fi + \ifx\go\pickupwholefraction + % Put the argument back for the \pickupwholefraction call, so + % we'll always have a period there to be parsed. + \def\go{\pickupwholefraction#1}% + \else + \let\go = \setuptable + \fi% + \fi + \go +} + +% multitable-only commands. +% +% @headitem starts a heading row, which we typeset in bold. +% Assignments have to be global since we are inside the implicit group +% of an alignment entry. Note that \everycr resets \everytab. +\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% +% +% A \tab used to include \hskip1sp. But then the space in a template +% line is not enough. That is bad. So let's go back to just `&' until +% we encounter the problem it was intended to solve again. +% --karl, nathan@acm.org, 20apr99. +\def\tab{\checkenv\multitable &\the\everytab}% + +% @multitable ... @end multitable definitions: +% +\newtoks\everytab % insert after every tab. +% +\envdef\multitable{% + \vskip\parskip + \startsavinginserts + % + % @item within a multitable starts a normal row. + \let\item\crcr + % + \tolerance=9500 + \hbadness=9500 + \setmultitablespacing + \parskip=\multitableparskip + \parindent=\multitableparindent + \overfullrule=0pt + \global\colcount=0 + % + \everycr = {% + \noalign{% + \global\everytab={}% + \global\colcount=0 % Reset the column counter. + % Check for saved footnotes, etc. + \checkinserts + % Keeps underfull box messages off when table breaks over pages. + %\filbreak + % Maybe so, but it also creates really weird page breaks when the + % table breaks over pages. Wouldn't \vfil be better? Wait until the + % problem manifests itself, so it can be fixed for real --karl. + }% + }% + % + \parsearg\domultitable +} +\def\domultitable#1{% + % To parse everything between @multitable and @item: + \setuptable#1 \endsetuptable + % + % This preamble sets up a generic column definition, which will + % be used as many times as user calls for columns. + % \vtop will set a single line and will also let text wrap and + % continue for many paragraphs if desired. + \halign\bgroup &% + \global\advance\colcount by 1 + \multistrut + \vtop{% + % Use the current \colcount to find the correct column width: + \hsize=\expandafter\csname col\the\colcount\endcsname + % + % In order to keep entries from bumping into each other + % we will add a \leftskip of \multitablecolspace to all columns after + % the first one. + % + % If a template has been used, we will add \multitablecolspace + % to the width of each template entry. + % + % If the user has set preamble in terms of percent of \hsize we will + % use that dimension as the width of the column, and the \leftskip + % will keep entries from bumping into each other. Table will start at + % left margin and final column will justify at right margin. + % + % Make sure we don't inherit \rightskip from the outer environment. + \rightskip=0pt + \ifnum\colcount=1 + % The first column will be indented with the surrounding text. + \advance\hsize by\leftskip + \else + \ifsetpercent \else + % If user has not set preamble in terms of percent of \hsize + % we will advance \hsize by \multitablecolspace. + \advance\hsize by \multitablecolspace + \fi + % In either case we will make \leftskip=\multitablecolspace: + \leftskip=\multitablecolspace + \fi + % Ignoring space at the beginning and end avoids an occasional spurious + % blank line, when TeX decides to break the line at the space before the + % box from the multistrut, so the strut ends up on a line by itself. + % For example: + % @multitable @columnfractions .11 .89 + % @item @code{#} + % @tab Legal holiday which is valid in major parts of the whole country. + % Is automatically provided with highlighting sequences respectively + % marking characters. + \noindent\ignorespaces##\unskip\multistrut + }\cr +} +\def\Emultitable{% + \crcr + \egroup % end the \halign + \global\setpercentfalse +} + +\def\setmultitablespacing{% test to see if user has set \multitablelinespace. +% If so, do nothing. If not, give it an appropriate dimension based on +% current baselineskip. +\ifdim\multitablelinespace=0pt +\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip +\global\advance\multitablelinespace by-\ht0 +%% strut to put in table in case some entry doesn't have descenders, +%% to keep lines equally spaced +\let\multistrut = \strut +\else +%% FIXME: what is \box0 supposed to be? +\gdef\multistrut{\vrule height\multitablelinespace depth\dp0 +width0pt\relax} \fi +%% Test to see if parskip is larger than space between lines of +%% table. If not, do nothing. +%% If so, set to same dimension as multitablelinespace. +\ifdim\multitableparskip>\multitablelinespace +\global\multitableparskip=\multitablelinespace +\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller + %% than skip between lines in the table. +\fi% +\ifdim\multitableparskip=0pt +\global\multitableparskip=\multitablelinespace +\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller + %% than skip between lines in the table. +\fi} + + +\message{conditionals,} + +% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, +% @ifnotxml always succeed. They currently do nothing; we don't +% attempt to check whether the conditionals are properly nested. But we +% have to remember that they are conditionals, so that @end doesn't +% attempt to close an environment group. +% +\def\makecond#1{% + \expandafter\let\csname #1\endcsname = \relax + \expandafter\let\csname iscond.#1\endcsname = 1 +} +\makecond{iftex} +\makecond{ifnotdocbook} +\makecond{ifnothtml} +\makecond{ifnotinfo} +\makecond{ifnotplaintext} +\makecond{ifnotxml} + +% Ignore @ignore, @ifhtml, @ifinfo, and the like. +% +\def\direntry{\doignore{direntry}} +\def\documentdescription{\doignore{documentdescription}} +\def\docbook{\doignore{docbook}} +\def\html{\doignore{html}} +\def\ifdocbook{\doignore{ifdocbook}} +\def\ifhtml{\doignore{ifhtml}} +\def\ifinfo{\doignore{ifinfo}} +\def\ifnottex{\doignore{ifnottex}} +\def\ifplaintext{\doignore{ifplaintext}} +\def\ifxml{\doignore{ifxml}} +\def\ignore{\doignore{ignore}} +\def\menu{\doignore{menu}} +\def\xml{\doignore{xml}} + +% Ignore text until a line `@end #1', keeping track of nested conditionals. +% +% A count to remember the depth of nesting. +\newcount\doignorecount + +\def\doignore#1{\begingroup + % Scan in ``verbatim'' mode: + \catcode`\@ = \other + \catcode`\{ = \other + \catcode`\} = \other + % + % Make sure that spaces turn into tokens that match what \doignoretext wants. + \spaceisspace + % + % Count number of #1's that we've seen. + \doignorecount = 0 + % + % Swallow text until we reach the matching `@end #1'. + \dodoignore {#1}% +} + +{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. + \obeylines % + % + \gdef\dodoignore#1{% + % #1 contains the string `ifinfo'. + % + % Define a command to find the next `@end #1', which must be on a line + % by itself. + \long\def\doignoretext##1^^M@end #1{\doignoretextyyy##1^^M@#1\_STOP_}% + % And this command to find another #1 command, at the beginning of a + % line. (Otherwise, we would consider a line `@c @ifset', for + % example, to count as an @ifset for nesting.) + \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% + % + % And now expand that command. + \obeylines % + \doignoretext ^^M% + }% +} + +\def\doignoreyyy#1{% + \def\temp{#1}% + \ifx\temp\empty % Nothing found. + \let\next\doignoretextzzz + \else % Found a nested condition, ... + \advance\doignorecount by 1 + \let\next\doignoretextyyy % ..., look for another. + % If we're here, #1 ends with ^^M\ifinfo (for example). + \fi + \next #1% the token \_STOP_ is present just after this macro. +} + +% We have to swallow the remaining "\_STOP_". +% +\def\doignoretextzzz#1{% + \ifnum\doignorecount = 0 % We have just found the outermost @end. + \let\next\enddoignore + \else % Still inside a nested condition. + \advance\doignorecount by -1 + \let\next\doignoretext % Look for the next @end. + \fi + \next +} + +% Finish off ignored text. +\def\enddoignore{\endgroup\ignorespaces} + + +% @set VAR sets the variable VAR to an empty value. +% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. +% +% Since we want to separate VAR from REST-OF-LINE (which might be +% empty), we can't just use \parsearg; we have to insert a space of our +% own to delimit the rest of the line, and then take it out again if we +% didn't need it. +% We rely on the fact that \parsearg sets \catcode`\ =10. +% +\parseargdef\set{\setyyy#1 \endsetyyy} +\def\setyyy#1 #2\endsetyyy{% + {% + \makevalueexpandable + \def\temp{#2}% + \edef\next{\gdef\makecsname{SET#1}}% + \ifx\temp\empty + \next{}% + \else + \setzzz#2\endsetzzz + \fi + }% +} +% Remove the trailing space \setxxx inserted. +\def\setzzz#1 \endsetzzz{\next{#1}} + +% @clear VAR clears (i.e., unsets) the variable VAR. +% +\parseargdef\clear{% + {% + \makevalueexpandable + \global\expandafter\let\csname SET#1\endcsname=\relax + }% +} + +% @value{foo} gets the text saved in variable foo. +\def\value{\begingroup\makevalueexpandable\valuexxx} +\def\valuexxx#1{\expandablevalue{#1}\endgroup} +{ + \catcode`\- = \active \catcode`\_ = \active + % + \gdef\makevalueexpandable{% + \let\value = \expandablevalue + % We don't want these characters active, ... + \catcode`\-=\other \catcode`\_=\other + % ..., but we might end up with active ones in the argument if + % we're called from @code, as @code{@value{foo-bar_}}, though. + % So \let them to their normal equivalents. + \let-\realdash \let_\normalunderscore + } +} + +% We have this subroutine so that we can handle at least some @value's +% properly in indexes (we call \makevalueexpandable in \indexdummies). +% The command has to be fully expandable (if the variable is set), since +% the result winds up in the index file. This means that if the +% variable's value contains other Texinfo commands, it's almost certain +% it will fail (although perhaps we could fix that with sufficient work +% to do a one-level expansion on the result, instead of complete). +% +\def\expandablevalue#1{% + \expandafter\ifx\csname SET#1\endcsname\relax + {[No value for ``#1'']}% + \message{Variable `#1', used in @value, is not set.}% + \else + \csname SET#1\endcsname + \fi +} + +% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined +% with @set. +% +% To get special treatment of `@end ifset,' call \makeond and the redefine. +% +\makecond{ifset} +\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} +\def\doifset#1#2{% + {% + \makevalueexpandable + \let\next=\empty + \expandafter\ifx\csname SET#2\endcsname\relax + #1% If not set, redefine \next. + \fi + \expandafter + }\next +} +\def\ifsetfail{\doignore{ifset}} + +% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been +% defined with @set, or has been undefined with @clear. +% +% The `\else' inside the `\doifset' parameter is a trick to reuse the +% above code: if the variable is not set, do nothing, if it is set, +% then redefine \next to \ifclearfail. +% +\makecond{ifclear} +\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} +\def\ifclearfail{\doignore{ifclear}} + +% @dircategory CATEGORY -- specify a category of the dir file +% which this file should belong to. Ignore this in TeX. +\let\dircategory=\comment + +% @defininfoenclose. +\let\definfoenclose=\comment + + +\message{indexing,} +% Index generation facilities + +% Define \newwrite to be identical to plain tex's \newwrite +% except not \outer, so it can be used within \newindex. +{\catcode`\@=11 +\gdef\newwrite{\alloc@7\write\chardef\sixt@@n}} + +% \newindex {foo} defines an index named foo. +% It automatically defines \fooindex such that +% \fooindex ...rest of line... puts an entry in the index foo. +% It also defines \fooindfile to be the number of the output channel for +% the file that accumulates this index. The file's extension is foo. +% The name of an index should be no more than 2 characters long +% for the sake of vms. +% +\def\newindex#1{% + \iflinks + \expandafter\newwrite \csname#1indfile\endcsname + \openout \csname#1indfile\endcsname \jobname.#1 % Open the file + \fi + \expandafter\xdef\csname#1index\endcsname{% % Define @#1index + \noexpand\doindex{#1}} +} + +% @defindex foo == \newindex{foo} +% +\def\defindex{\parsearg\newindex} + +% Define @defcodeindex, like @defindex except put all entries in @code. +% +\def\defcodeindex{\parsearg\newcodeindex} +% +\def\newcodeindex#1{% + \iflinks + \expandafter\newwrite \csname#1indfile\endcsname + \openout \csname#1indfile\endcsname \jobname.#1 + \fi + \expandafter\xdef\csname#1index\endcsname{% + \noexpand\docodeindex{#1}}% +} + + +% @synindex foo bar makes index foo feed into index bar. +% Do this instead of @defindex foo if you don't want it as a separate index. +% +% @syncodeindex foo bar similar, but put all entries made for index foo +% inside @code. +% +\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} +\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} + +% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), +% #3 the target index (bar). +\def\dosynindex#1#2#3{% + % Only do \closeout if we haven't already done it, else we'll end up + % closing the target index. + \expandafter \ifx\csname donesynindex#2\endcsname \undefined + % The \closeout helps reduce unnecessary open files; the limit on the + % Acorn RISC OS is a mere 16 files. + \expandafter\closeout\csname#2indfile\endcsname + \expandafter\let\csname\donesynindex#2\endcsname = 1 + \fi + % redefine \fooindfile: + \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname + \expandafter\let\csname#2indfile\endcsname=\temp + % redefine \fooindex: + \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% +} + +% Define \doindex, the driver for all \fooindex macros. +% Argument #1 is generated by the calling \fooindex macro, +% and it is "foo", the name of the index. + +% \doindex just uses \parsearg; it calls \doind for the actual work. +% This is because \doind is more useful to call from other macros. + +% There is also \dosubind {index}{topic}{subtopic} +% which makes an entry in a two-level index such as the operation index. + +\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} +\def\singleindexer #1{\doind{\indexname}{#1}} + +% like the previous two, but they put @code around the argument. +\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} +\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} + +% Take care of Texinfo commands that can appear in an index entry. +% Since there are some commands we want to expand, and others we don't, +% we have to laboriously prevent expansion for those that we don't. +% +\def\indexdummies{% + \def\@{@}% change to @@ when we switch to @ as escape char in index files. + \def\ {\realbackslash\space }% + % Need these in case \tex is in effect and \{ is a \delimiter again. + % But can't use \lbracecmd and \rbracecmd because texindex assumes + % braces and backslashes are used only as delimiters. + \let\{ = \mylbrace + \let\} = \myrbrace + % + % \definedummyword defines \#1 as \realbackslash #1\space, thus + % effectively preventing its expansion. This is used only for control + % words, not control letters, because the \space would be incorrect + % for control characters, but is needed to separate the control word + % from whatever follows. + % + % For control letters, we have \definedummyletter, which omits the + % space. + % + % These can be used both for control words that take an argument and + % those that do not. If it is followed by {arg} in the input, then + % that will dutifully get written to the index (or wherever). + % + \def\definedummyword##1{% + \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}% + }% + \def\definedummyletter##1{% + \expandafter\def\csname ##1\endcsname{\realbackslash ##1}% + }% + % + % Do the redefinitions. + \commondummies +} + +% For the aux file, @ is the escape character. So we want to redefine +% everything using @ instead of \realbackslash. When everything uses +% @, this will be simpler. +% +\def\atdummies{% + \def\@{@@}% + \def\ {@ }% + \let\{ = \lbraceatcmd + \let\} = \rbraceatcmd + % + % (See comments in \indexdummies.) + \def\definedummyword##1{% + \expandafter\def\csname ##1\endcsname{@##1\space}% + }% + \def\definedummyletter##1{% + \expandafter\def\csname ##1\endcsname{@##1}% + }% + % + % Do the redefinitions. + \commondummies +} + +% Called from \indexdummies and \atdummies. \definedummyword and +% \definedummyletter must be defined first. +% +\def\commondummies{% + % + \normalturnoffactive + % + \commondummiesnofonts + % + \definedummyletter{_}% + % + % Non-English letters. + \definedummyword{AA}% + \definedummyword{AE}% + \definedummyword{L}% + \definedummyword{OE}% + \definedummyword{O}% + \definedummyword{aa}% + \definedummyword{ae}% + \definedummyword{l}% + \definedummyword{oe}% + \definedummyword{o}% + \definedummyword{ss}% + \definedummyword{exclamdown}% + \definedummyword{questiondown}% + \definedummyword{ordf}% + \definedummyword{ordm}% + % + % Although these internal commands shouldn't show up, sometimes they do. + \definedummyword{bf}% + \definedummyword{gtr}% + \definedummyword{hat}% + \definedummyword{less}% + \definedummyword{sf}% + \definedummyword{sl}% + \definedummyword{tclose}% + \definedummyword{tt}% + % + \definedummyword{LaTeX}% + \definedummyword{TeX}% + % + % Assorted special characters. + \definedummyword{bullet}% + \definedummyword{copyright}% + \definedummyword{registeredsymbol}% + \definedummyword{dots}% + \definedummyword{enddots}% + \definedummyword{equiv}% + \definedummyword{error}% + \definedummyword{expansion}% + \definedummyword{minus}% + \definedummyword{pounds}% + \definedummyword{point}% + \definedummyword{print}% + \definedummyword{result}% + % + % Handle some cases of @value -- where it does not contain any + % (non-fully-expandable) commands. + \makevalueexpandable + % + % Normal spaces, not active ones. + \unsepspaces + % + % No macro expansion. + \turnoffmacros +} + +% \commondummiesnofonts: common to \commondummies and \indexnofonts. +% +% Better have this without active chars. +{ + \catcode`\~=\other + \gdef\commondummiesnofonts{% + % Control letters and accents. + \definedummyletter{!}% + \definedummyletter{"}% + \definedummyletter{'}% + \definedummyletter{*}% + \definedummyletter{,}% + \definedummyletter{.}% + \definedummyletter{/}% + \definedummyletter{:}% + \definedummyletter{=}% + \definedummyletter{?}% + \definedummyletter{^}% + \definedummyletter{`}% + \definedummyletter{~}% + \definedummyword{u}% + \definedummyword{v}% + \definedummyword{H}% + \definedummyword{dotaccent}% + \definedummyword{ringaccent}% + \definedummyword{tieaccent}% + \definedummyword{ubaraccent}% + \definedummyword{udotaccent}% + \definedummyword{dotless}% + % + % Texinfo font commands. + \definedummyword{b}% + \definedummyword{i}% + \definedummyword{r}% + \definedummyword{sc}% + \definedummyword{t}% + % + % Commands that take arguments. + \definedummyword{acronym}% + \definedummyword{cite}% + \definedummyword{code}% + \definedummyword{command}% + \definedummyword{dfn}% + \definedummyword{emph}% + \definedummyword{env}% + \definedummyword{file}% + \definedummyword{kbd}% + \definedummyword{key}% + \definedummyword{math}% + \definedummyword{option}% + \definedummyword{samp}% + \definedummyword{strong}% + \definedummyword{tie}% + \definedummyword{uref}% + \definedummyword{url}% + \definedummyword{var}% + \definedummyword{verb}% + \definedummyword{w}% + } +} + +% \indexnofonts is used when outputting the strings to sort the index +% by, and when constructing control sequence names. It eliminates all +% control sequences and just writes whatever the best ASCII sort string +% would be for a given command (usually its argument). +% +\def\indexnofonts{% + \def\definedummyword##1{% + \expandafter\let\csname ##1\endcsname\asis + }% + \let\definedummyletter=\definedummyword + % + \commondummiesnofonts + % + % Don't no-op \tt, since it isn't a user-level command + % and is used in the definitions of the active chars like <, >, |, etc. + % Likewise with the other plain tex font commands. + %\let\tt=\asis + % + \def\ { }% + \def\@{@}% + % how to handle braces? + \def\_{\normalunderscore}% + % + % Non-English letters. + \def\AA{AA}% + \def\AE{AE}% + \def\L{L}% + \def\OE{OE}% + \def\O{O}% + \def\aa{aa}% + \def\ae{ae}% + \def\l{l}% + \def\oe{oe}% + \def\o{o}% + \def\ss{ss}% + \def\exclamdown{!}% + \def\questiondown{?}% + \def\ordf{a}% + \def\ordm{o}% + % + \def\LaTeX{LaTeX}% + \def\TeX{TeX}% + % + % Assorted special characters. + % (The following {} will end up in the sort string, but that's ok.) + \def\bullet{bullet}% + \def\copyright{copyright}% + \def\registeredsymbol{R}% + \def\dots{...}% + \def\enddots{...}% + \def\equiv{==}% + \def\error{error}% + \def\expansion{==>}% + \def\minus{-}% + \def\pounds{pounds}% + \def\point{.}% + \def\print{-|}% + \def\result{=>}% +} + +\let\indexbackslash=0 %overridden during \printindex. +\let\SETmarginindex=\relax % put index entries in margin (undocumented)? + +% Most index entries go through here, but \dosubind is the general case. +% #1 is the index name, #2 is the entry text. +\def\doind#1#2{\dosubind{#1}{#2}{}} + +% Workhorse for all \fooindexes. +% #1 is name of index, #2 is stuff to put there, #3 is subentry -- +% empty if called from \doind, as we usually are (the main exception +% is with most defuns, which call us directly). +% +\def\dosubind#1#2#3{% + \iflinks + {% + % Store the main index entry text (including the third arg). + \toks0 = {#2}% + % If third arg is present, precede it with a space. + \def\thirdarg{#3}% + \ifx\thirdarg\empty \else + \toks0 = \expandafter{\the\toks0 \space #3}% + \fi + % + \edef\writeto{\csname#1indfile\endcsname}% + % + \ifvmode + \dosubindsanitize + \else + \dosubindwrite + \fi + }% + \fi +} + +% Write the entry in \toks0 to the index file: +% +\def\dosubindwrite{% + % Put the index entry in the margin if desired. + \ifx\SETmarginindex\relax\else + \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% + \fi + % + % Remember, we are within a group. + \indexdummies % Must do this here, since \bf, etc expand at this stage + \escapechar=`\\ + \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now + % so it will be output as is; and it will print as backslash. + % + % Process the index entry with all font commands turned off, to + % get the string to sort by. + {\indexnofonts + \edef\temp{\the\toks0}% need full expansion + \xdef\indexsorttmp{\temp}% + }% + % + % Set up the complete index entry, with both the sort key and + % the original text, including any font commands. We write + % three arguments to \entry to the .?? file (four in the + % subentry case), texindex reduces to two when writing the .??s + % sorted result. + \edef\temp{% + \write\writeto{% + \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% + }% + \temp +} + +% Take care of unwanted page breaks: +% +% If a skip is the last thing on the list now, preserve it +% by backing up by \lastskip, doing the \write, then inserting +% the skip again. Otherwise, the whatsit generated by the +% \write will make \lastskip zero. The result is that sequences +% like this: +% @end defun +% @tindex whatever +% @defun ... +% will have extra space inserted, because the \medbreak in the +% start of the @defun won't see the skip inserted by the @end of +% the previous defun. +% +% But don't do any of this if we're not in vertical mode. We +% don't want to do a \vskip and prematurely end a paragraph. +% +% Avoid page breaks due to these extra skips, too. +% +% But wait, there is a catch there: +% We'll have to check whether \lastskip is zero skip. \ifdim is not +% sufficient for this purpose, as it ignores stretch and shrink parts +% of the skip. The only way seems to be to check the textual +% representation of the skip. +% +% The following is almost like \def\zeroskipmacro{0.0pt} except that +% the ``p'' and ``t'' characters have catcode \other, not 11 (letter). +% +\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} +% +% ..., ready, GO: +% +\def\dosubindsanitize{% + % \lastskip and \lastpenalty cannot both be nonzero simultaneously. + \skip0 = \lastskip + \edef\lastskipmacro{\the\lastskip}% + \count255 = \lastpenalty + % + % If \lastskip is nonzero, that means the last item was a + % skip. And since a skip is discardable, that means this + % -\skip0 glue we're inserting is preceded by a + % non-discardable item, therefore it is not a potential + % breakpoint, therefore no \nobreak needed. + \ifx\lastskipmacro\zeroskipmacro + \else + \vskip-\skip0 + \fi + % + \dosubindwrite + % + \ifx\lastskipmacro\zeroskipmacro + % if \lastskip was zero, perhaps the last item was a + % penalty, and perhaps it was >=10000, e.g., a \nobreak. + % In that case, we want to re-insert the penalty; since we + % just inserted a non-discardable item, any following glue + % (such as a \parskip) would be a breakpoint. For example: + % @deffn deffn-whatever + % @vindex index-whatever + % Description. + % would allow a break between the index-whatever whatsit + % and the "Description." paragraph. + \ifnum\count255>9999 \nobreak \fi + \else + % On the other hand, if we had a nonzero \lastskip, + % this make-up glue would be preceded by a non-discardable item + % (the whatsit from the \write), so we must insert a \nobreak. + \nobreak\vskip\skip0 + \fi +} + +% The index entry written in the file actually looks like +% \entry {sortstring}{page}{topic} +% or +% \entry {sortstring}{page}{topic}{subtopic} +% The texindex program reads in these files and writes files +% containing these kinds of lines: +% \initial {c} +% before the first topic whose initial is c +% \entry {topic}{pagelist} +% for a topic that is used without subtopics +% \primary {topic} +% for the beginning of a topic that is used with subtopics +% \secondary {subtopic}{pagelist} +% for each subtopic. + +% Define the user-accessible indexing commands +% @findex, @vindex, @kindex, @cindex. + +\def\findex {\fnindex} +\def\kindex {\kyindex} +\def\cindex {\cpindex} +\def\vindex {\vrindex} +\def\tindex {\tpindex} +\def\pindex {\pgindex} + +\def\cindexsub {\begingroup\obeylines\cindexsub} +{\obeylines % +\gdef\cindexsub "#1" #2^^M{\endgroup % +\dosubind{cp}{#2}{#1}}} + +% Define the macros used in formatting output of the sorted index material. + +% @printindex causes a particular index (the ??s file) to get printed. +% It does not print any chapter heading (usually an @unnumbered). +% +\parseargdef\printindex{\begingroup + \dobreak \chapheadingskip{10000}% + % + \smallfonts \rm + \tolerance = 9500 + \everypar = {}% don't want the \kern\-parindent from indentation suppression. + % + % See if the index file exists and is nonempty. + % Change catcode of @ here so that if the index file contains + % \initial {@} + % as its first line, TeX doesn't complain about mismatched braces + % (because it thinks @} is a control sequence). + \catcode`\@ = 11 + \openin 1 \jobname.#1s + \ifeof 1 + % \enddoublecolumns gets confused if there is no text in the index, + % and it loses the chapter title and the aux file entries for the + % index. The easiest way to prevent this problem is to make sure + % there is some text. + \putwordIndexNonexistent + \else + % + % If the index file exists but is empty, then \openin leaves \ifeof + % false. We have to make TeX try to read something from the file, so + % it can discover if there is anything in it. + \read 1 to \temp + \ifeof 1 + \putwordIndexIsEmpty + \else + % Index files are almost Texinfo source, but we use \ as the escape + % character. It would be better to use @, but that's too big a change + % to make right now. + \def\indexbackslash{\backslashcurfont}% + \catcode`\\ = 0 + \escapechar = `\\ + \begindoublecolumns + \input \jobname.#1s + \enddoublecolumns + \fi + \fi + \closein 1 +\endgroup} + +% These macros are used by the sorted index file itself. +% Change them to control the appearance of the index. + +\def\initial#1{{% + % Some minor font changes for the special characters. + \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt + % + % Remove any glue we may have, we'll be inserting our own. + \removelastskip + % + % We like breaks before the index initials, so insert a bonus. + \penalty -300 + % + % Typeset the initial. Making this add up to a whole number of + % baselineskips increases the chance of the dots lining up from column + % to column. It still won't often be perfect, because of the stretch + % we need before each entry, but it's better. + % + % No shrink because it confuses \balancecolumns. + \vskip 1.67\baselineskip plus .5\baselineskip + \leftline{\secbf #1}% + \vskip .33\baselineskip plus .1\baselineskip + % + % Do our best not to break after the initial. + \nobreak +}} + +% \entry typesets a paragraph consisting of the text (#1), dot leaders, and +% then page number (#2) flushed to the right margin. It is used for index +% and table of contents entries. The paragraph is indented by \leftskip. +% +% A straightforward implementation would start like this: +% \def\entry#1#2{... +% But this frozes the catcodes in the argument, and can cause problems to +% @code, which sets - active. This problem was fixed by a kludge--- +% ``-'' was active throughout whole index, but this isn't really right. +% +% The right solution is to prevent \entry from swallowing the whole text. +% --kasal, 21nov03 +\def\entry{% + \begingroup + % + % Start a new paragraph if necessary, so our assignments below can't + % affect previous text. + \par + % + % Do not fill out the last line with white space. + \parfillskip = 0in + % + % No extra space above this paragraph. + \parskip = 0in + % + % Do not prefer a separate line ending with a hyphen to fewer lines. + \finalhyphendemerits = 0 + % + % \hangindent is only relevant when the entry text and page number + % don't both fit on one line. In that case, bob suggests starting the + % dots pretty far over on the line. Unfortunately, a large + % indentation looks wrong when the entry text itself is broken across + % lines. So we use a small indentation and put up with long leaders. + % + % \hangafter is reset to 1 (which is the value we want) at the start + % of each paragraph, so we need not do anything with that. + \hangindent = 2em + % + % When the entry text needs to be broken, just fill out the first line + % with blank space. + \rightskip = 0pt plus1fil + % + % A bit of stretch before each entry for the benefit of balancing + % columns. + \vskip 0pt plus1pt + % + % Swallow the left brace of the text (first parameter): + \afterassignment\doentry + \let\temp = +} +\def\doentry{% + \bgroup % Instead of the swallowed brace. + \noindent + \aftergroup\finishentry + % And now comes the text of the entry. +} +\def\finishentry#1{% + % #1 is the page number. + % + % The following is kludged to not output a line of dots in the index if + % there are no page numbers. The next person who breaks this will be + % cursed by a Unix daemon. + \def\tempa{{\rm }}% + \def\tempb{#1}% + \edef\tempc{\tempa}% + \edef\tempd{\tempb}% + \ifx\tempc\tempd + \ % + \else + % + % If we must, put the page number on a line of its own, and fill out + % this line with blank space. (The \hfil is overwhelmed with the + % fill leaders glue in \indexdotfill if the page number does fit.) + \hfil\penalty50 + \null\nobreak\indexdotfill % Have leaders before the page number. + % + % The `\ ' here is removed by the implicit \unskip that TeX does as + % part of (the primitive) \par. Without it, a spurious underfull + % \hbox ensues. + \ifpdf + \pdfgettoks#1.\ \the\toksA + \else + \ #1% + \fi + \fi + \par + \endgroup +} + +% Like \dotfill except takes at least 1 em. +\def\indexdotfill{\cleaders + \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \mkern1.5mu$}\hskip 1em plus 1fill} + +\def\primary #1{\line{#1\hfil}} + +\newskip\secondaryindent \secondaryindent=0.5cm +\def\secondary#1#2{{% + \parfillskip=0in + \parskip=0in + \hangindent=1in + \hangafter=1 + \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill + \ifpdf + \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. + \else + #2 + \fi + \par +}} + +% Define two-column mode, which we use to typeset indexes. +% Adapted from the TeXbook, page 416, which is to say, +% the manmac.tex format used to print the TeXbook itself. +\catcode`\@=11 + +\newbox\partialpage +\newdimen\doublecolumnhsize + +\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns + % Grab any single-column material above us. + \output = {% + % + % Here is a possibility not foreseen in manmac: if we accumulate a + % whole lot of material, we might end up calling this \output + % routine twice in a row (see the doublecol-lose test, which is + % essentially a couple of indexes with @setchapternewpage off). In + % that case we just ship out what is in \partialpage with the normal + % output routine. Generally, \partialpage will be empty when this + % runs and this will be a no-op. See the indexspread.tex test case. + \ifvoid\partialpage \else + \onepageout{\pagecontents\partialpage}% + \fi + % + \global\setbox\partialpage = \vbox{% + % Unvbox the main output page. + \unvbox\PAGE + \kern-\topskip \kern\baselineskip + }% + }% + \eject % run that output routine to set \partialpage + % + % Use the double-column output routine for subsequent pages. + \output = {\doublecolumnout}% + % + % Change the page size parameters. We could do this once outside this + % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 + % format, but then we repeat the same computation. Repeating a couple + % of assignments once per index is clearly meaningless for the + % execution time, so we may as well do it in one place. + % + % First we halve the line length, less a little for the gutter between + % the columns. We compute the gutter based on the line length, so it + % changes automatically with the paper format. The magic constant + % below is chosen so that the gutter has the same value (well, +-<1pt) + % as it did when we hard-coded it. + % + % We put the result in a separate register, \doublecolumhsize, so we + % can restore it in \pagesofar, after \hsize itself has (potentially) + % been clobbered. + % + \doublecolumnhsize = \hsize + \advance\doublecolumnhsize by -.04154\hsize + \divide\doublecolumnhsize by 2 + \hsize = \doublecolumnhsize + % + % Double the \vsize as well. (We don't need a separate register here, + % since nobody clobbers \vsize.) + \vsize = 2\vsize +} + +% The double-column output routine for all double-column pages except +% the last. +% +\def\doublecolumnout{% + \splittopskip=\topskip \splitmaxdepth=\maxdepth + % Get the available space for the double columns -- the normal + % (undoubled) page height minus any material left over from the + % previous page. + \dimen@ = \vsize + \divide\dimen@ by 2 + \advance\dimen@ by -\ht\partialpage + % + % box0 will be the left-hand column, box2 the right. + \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ + \onepageout\pagesofar + \unvbox255 + \penalty\outputpenalty +} +% +% Re-output the contents of the output page -- any previous material, +% followed by the two boxes we just split, in box0 and box2. +\def\pagesofar{% + \unvbox\partialpage + % + \hsize = \doublecolumnhsize + \wd0=\hsize \wd2=\hsize + \hbox to\pagewidth{\box0\hfil\box2}% +} +% +% All done with double columns. +\def\enddoublecolumns{% + \output = {% + % Split the last of the double-column material. Leave it on the + % current page, no automatic page break. + \balancecolumns + % + % If we end up splitting too much material for the current page, + % though, there will be another page break right after this \output + % invocation ends. Having called \balancecolumns once, we do not + % want to call it again. Therefore, reset \output to its normal + % definition right away. (We hope \balancecolumns will never be + % called on to balance too much material, but if it is, this makes + % the output somewhat more palatable.) + \global\output = {\onepageout{\pagecontents\PAGE}}% + }% + \eject + \endgroup % started in \begindoublecolumns + % + % \pagegoal was set to the doubled \vsize above, since we restarted + % the current page. We're now back to normal single-column + % typesetting, so reset \pagegoal to the normal \vsize (after the + % \endgroup where \vsize got restored). + \pagegoal = \vsize +} +% +% Called at the end of the double column material. +\def\balancecolumns{% + \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. + \dimen@ = \ht0 + \advance\dimen@ by \topskip + \advance\dimen@ by-\baselineskip + \divide\dimen@ by 2 % target to split to + %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% + \splittopskip = \topskip + % Loop until we get a decent breakpoint. + {% + \vbadness = 10000 + \loop + \global\setbox3 = \copy0 + \global\setbox1 = \vsplit3 to \dimen@ + \ifdim\ht3>\dimen@ + \global\advance\dimen@ by 1pt + \repeat + }% + %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% + \setbox0=\vbox to\dimen@{\unvbox1}% + \setbox2=\vbox to\dimen@{\unvbox3}% + % + \pagesofar +} +\catcode`\@ = \other + + +\message{sectioning,} +% Chapters, sections, etc. + +% \unnumberedno is an oxymoron, of course. But we count the unnumbered +% sections so that we can refer to them unambiguously in the pdf +% outlines by their "section number". We avoid collisions with chapter +% numbers by starting them at 10000. (If a document ever has 10000 +% chapters, we're in trouble anyway, I'm sure.) +\newcount\unnumberedno \unnumberedno = 10000 +\newcount\chapno +\newcount\secno \secno=0 +\newcount\subsecno \subsecno=0 +\newcount\subsubsecno \subsubsecno=0 + +% This counter is funny since it counts through charcodes of letters A, B, ... +\newcount\appendixno \appendixno = `\@ +% +% \def\appendixletter{\char\the\appendixno} +% We do the following ugly conditional instead of the above simple +% construct for the sake of pdftex, which needs the actual +% letter in the expansion, not just typeset. +% +\def\appendixletter{% + \ifnum\appendixno=`A A% + \else\ifnum\appendixno=`B B% + \else\ifnum\appendixno=`C C% + \else\ifnum\appendixno=`D D% + \else\ifnum\appendixno=`E E% + \else\ifnum\appendixno=`F F% + \else\ifnum\appendixno=`G G% + \else\ifnum\appendixno=`H H% + \else\ifnum\appendixno=`I I% + \else\ifnum\appendixno=`J J% + \else\ifnum\appendixno=`K K% + \else\ifnum\appendixno=`L L% + \else\ifnum\appendixno=`M M% + \else\ifnum\appendixno=`N N% + \else\ifnum\appendixno=`O O% + \else\ifnum\appendixno=`P P% + \else\ifnum\appendixno=`Q Q% + \else\ifnum\appendixno=`R R% + \else\ifnum\appendixno=`S S% + \else\ifnum\appendixno=`T T% + \else\ifnum\appendixno=`U U% + \else\ifnum\appendixno=`V V% + \else\ifnum\appendixno=`W W% + \else\ifnum\appendixno=`X X% + \else\ifnum\appendixno=`Y Y% + \else\ifnum\appendixno=`Z Z% + % The \the is necessary, despite appearances, because \appendixletter is + % expanded while writing the .toc file. \char\appendixno is not + % expandable, thus it is written literally, thus all appendixes come out + % with the same letter (or @) in the toc without it. + \else\char\the\appendixno + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi + \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} + +% Each @chapter defines this as the name of the chapter. +% page headings and footings can use it. @section does likewise. +% However, they are not reliable, because we don't use marks. +\def\thischapter{} +\def\thissection{} + +\newcount\absseclevel % used to calculate proper heading level +\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count + +% @raisesections: treat @section as chapter, @subsection as section, etc. +\def\raisesections{\global\advance\secbase by -1} +\let\up=\raisesections % original BFox name + +% @lowersections: treat @chapter as section, @section as subsection, etc. +\def\lowersections{\global\advance\secbase by 1} +\let\down=\lowersections % original BFox name + +% Choose a numbered-heading macro +% #1 is heading level if unmodified by @raisesections or @lowersections +% #2 is text for heading +\def\numhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 +\ifcase\absseclevel + \chapterzzz{#2}% + \or \seczzz{#2}% + \or \numberedsubseczzz{#2}% + \or \numberedsubsubseczzz{#2}% + \else + \ifnum \absseclevel<0 \chapterzzz{#2}% + \else \numberedsubsubseczzz{#2}% + \fi + \fi + \suppressfirstparagraphindent +} + +% like \numhead, but chooses appendix heading levels +\def\apphead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 +\ifcase\absseclevel + \appendixzzz{#2}% + \or \appendixsectionzzz{#2}% + \or \appendixsubseczzz{#2}% + \or \appendixsubsubseczzz{#2}% + \else + \ifnum \absseclevel<0 \appendixzzz{#2}% + \else \appendixsubsubseczzz{#2}% + \fi + \fi + \suppressfirstparagraphindent +} + +% like \numhead, but chooses numberless heading levels +\def\unnmhead#1#2{\absseclevel=\secbase\advance\absseclevel by #1 + \ifcase\absseclevel + \unnumberedzzz{#2}% + \or \unnumberedseczzz{#2}% + \or \unnumberedsubseczzz{#2}% + \or \unnumberedsubsubseczzz{#2}% + \else + \ifnum \absseclevel<0 \unnumberedzzz{#2}% + \else \unnumberedsubsubseczzz{#2}% + \fi + \fi + \suppressfirstparagraphindent +} + +% @chapter, @appendix, @unnumbered. Increment top-level counter, reset +% all lower-level sectioning counters to zero. +% +% Also set \chaplevelprefix, which we prepend to @float sequence numbers +% (e.g., figures), q.v. By default (before any chapter), that is empty. +\let\chaplevelprefix = \empty +% +\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz +\def\chapterzzz#1{% + % section resetting is \global in case the chapter is in a group, such + % as an @include file. + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\chapno by 1 + % + % Used for \float. + \gdef\chaplevelprefix{\the\chapno.}% + \resetallfloatnos + % + \message{\putwordChapter\space \the\chapno}% + % + % Write the actual heading. + \chapmacro{#1}{Ynumbered}{\the\chapno}% + % + % So @section and the like are numbered underneath this chapter. + \global\let\section = \numberedsec + \global\let\subsection = \numberedsubsec + \global\let\subsubsection = \numberedsubsubsec +} + +\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz +\def\appendixzzz#1{% + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\appendixno by 1 + \gdef\chaplevelprefix{\appendixletter.}% + \resetallfloatnos + % + \def\appendixnum{\putwordAppendix\space \appendixletter}% + \message{\appendixnum}% + % + \chapmacro{#1}{Yappendix}{\appendixletter}% + % + \global\let\section = \appendixsec + \global\let\subsection = \appendixsubsec + \global\let\subsubsection = \appendixsubsubsec +} + +% @centerchap is like @unnumbered, but the heading is centered. +\outer\parseargdef\centerchap{{\unnumberedyyy{#1}}} + +\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz +\def\unnumberedzzz#1{% + \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 + \global\advance\unnumberedno by 1 + % + % Since an unnumbered has no number, no prefix for figures. + \global\let\chaplevelprefix = \empty + \resetallfloatnos + % + % This used to be simply \message{#1}, but TeX fully expands the + % argument to \message. Therefore, if #1 contained @-commands, TeX + % expanded them. For example, in `@unnumbered The @cite{Book}', TeX + % expanded @cite (which turns out to cause errors because \cite is meant + % to be executed, not expanded). + % + % Anyway, we don't want the fully-expanded definition of @cite to appear + % as a result of the \message, we just want `@cite' itself. We use + % \the<toks register> to achieve this: TeX expands \the<toks> only once, + % simply yielding the contents of <toks register>. (We also do this for + % the toc entries.) + \toks0 = {#1}% + \message{(\the\toks0)}% + % + \chapmacro{#1}{Ynothing}{\the\unnumberedno}% + % + \global\let\section = \unnumberedsec + \global\let\subsection = \unnumberedsubsec + \global\let\subsubsection = \unnumberedsubsubsec +} + +% @top is like @unnumbered. +\let\top\unnumbered + +% Sections. +\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz +\def\seczzz#1{% + \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 + \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% +} + +\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz +\def\appendixsectionzzz#1{% + \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 + \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% +} +\let\appendixsec\appendixsection + +\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz +\def\unnumberedseczzz#1{% + \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 + \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% +} + +% Subsections. +\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz +\def\numberedsubseczzz#1{% + \global\subsubsecno=0 \global\advance\subsecno by 1 + \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% +} + +\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz +\def\appendixsubseczzz#1{% + \global\subsubsecno=0 \global\advance\subsecno by 1 + \sectionheading{#1}{subsec}{Yappendix}% + {\appendixletter.\the\secno.\the\subsecno}% +} + +\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz +\def\unnumberedsubseczzz#1{% + \global\subsubsecno=0 \global\advance\subsecno by 1 + \sectionheading{#1}{subsec}{Ynothing}% + {\the\unnumberedno.\the\secno.\the\subsecno}% +} + +% Subsubsections. +\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz +\def\numberedsubsubseczzz#1{% + \global\advance\subsubsecno by 1 + \sectionheading{#1}{subsubsec}{Ynumbered}% + {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% +} + +\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz +\def\appendixsubsubseczzz#1{% + \global\advance\subsubsecno by 1 + \sectionheading{#1}{subsubsec}{Yappendix}% + {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% +} + +\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz +\def\unnumberedsubsubseczzz#1{% + \global\advance\subsubsecno by 1 + \sectionheading{#1}{subsubsec}{Ynothing}% + {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% +} + +% These are variants which are not "outer", so they can appear in @ifinfo. +% Actually, they are now be obsolete; ordinary section commands should work. +\def\infotop{\parsearg\unnumberedzzz} +\def\infounnumbered{\parsearg\unnumberedzzz} +\def\infounnumberedsec{\parsearg\unnumberedseczzz} +\def\infounnumberedsubsec{\parsearg\unnumberedsubseczzz} +\def\infounnumberedsubsubsec{\parsearg\unnumberedsubsubseczzz} + +\def\infoappendix{\parsearg\appendixzzz} +\def\infoappendixsec{\parsearg\appendixseczzz} +\def\infoappendixsubsec{\parsearg\appendixsubseczzz} +\def\infoappendixsubsubsec{\parsearg\appendixsubsubseczzz} + +\def\infochapter{\parsearg\chapterzzz} +\def\infosection{\parsearg\sectionzzz} +\def\infosubsection{\parsearg\subsectionzzz} +\def\infosubsubsection{\parsearg\subsubsectionzzz} + +% These macros control what the section commands do, according +% to what kind of chapter we are in (ordinary, appendix, or unnumbered). +% Define them by default for a numbered chapter. +\let\section = \numberedsec +\let\subsection = \numberedsubsec +\let\subsubsection = \numberedsubsubsec + +% Define @majorheading, @heading and @subheading + +% NOTE on use of \vbox for chapter headings, section headings, and such: +% 1) We use \vbox rather than the earlier \line to permit +% overlong headings to fold. +% 2) \hyphenpenalty is set to 10000 because hyphenation in a +% heading is obnoxious; this forbids it. +% 3) Likewise, headings look best if no \parindent is used, and +% if justification is not attempted. Hence \raggedright. + + +\def\majorheading{% + {\advance\chapheadingskip by 10pt \chapbreak }% + \parsearg\chapheadingzzz +} + +\def\chapheading{\chapbreak \parsearg\chapheadingzzz} +\def\chapheadingzzz#1{% + {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 + \parindent=0pt\raggedright + \rm #1\hfill}}% + \bigskip \par\penalty 200\relax + \suppressfirstparagraphindent +} + +% @heading, @subheading, @subsubheading. +\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} +\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} +\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} + \suppressfirstparagraphindent} + +% These macros generate a chapter, section, etc. heading only +% (including whitespace, linebreaking, etc. around it), +% given all the information in convenient, parsed form. + +%%% Args are the skip and penalty (usually negative) +\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} + +\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} + +%%% Define plain chapter starts, and page on/off switching for it +% Parameter controlling skip before chapter headings (if needed) + +\newskip\chapheadingskip + +\def\chapbreak{\dobreak \chapheadingskip {-4000}} +\def\chappager{\par\vfill\supereject} +\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} + +\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} + +\def\CHAPPAGoff{% +\global\let\contentsalignmacro = \chappager +\global\let\pchapsepmacro=\chapbreak +\global\let\pagealignmacro=\chappager} + +\def\CHAPPAGon{% +\global\let\contentsalignmacro = \chappager +\global\let\pchapsepmacro=\chappager +\global\let\pagealignmacro=\chappager +\global\def\HEADINGSon{\HEADINGSsingle}} + +\def\CHAPPAGodd{% +\global\let\contentsalignmacro = \chapoddpage +\global\let\pchapsepmacro=\chapoddpage +\global\let\pagealignmacro=\chapoddpage +\global\def\HEADINGSon{\HEADINGSdouble}} + +\CHAPPAGon + +\def\CHAPFplain{% +\global\let\chapmacro=\chfplain +\global\let\centerchapmacro=\centerchfplain} + +% Normal chapter opening. +% +% #1 is the text, #2 is the section type (Ynumbered, Ynothing, +% Yappendix, Yomitfromtoc), #3 the chapter number. +% +% To test against our argument. +\def\Ynothingkeyword{Ynothing} +\def\Yomitfromtockeyword{Yomitfromtoc} +\def\Yappendixkeyword{Yappendix} +% +\def\chfplain#1#2#3{% + \pchapsepmacro + {% + \chapfonts \rm + % + % Have to define \thissection before calling \donoderef, because the + % xref code eventually uses it. On the other hand, it has to be called + % after \pchapsepmacro, or the headline will change too soon. + \gdef\thissection{#1}% + \gdef\thischaptername{#1}% + % + % Only insert the separating space if we have a chapter/appendix + % number, and don't print the unnumbered ``number''. + \def\temptype{#2}% + \ifx\temptype\Ynothingkeyword + \setbox0 = \hbox{}% + \def\toctype{unnchap}% + \def\thischapter{#1}% + \else\ifx\temptype\Yomitfromtockeyword + \setbox0 = \hbox{}% contents like unnumbered, but no toc entry + \def\toctype{omit}% + \xdef\thischapter{}% + \else\ifx\temptype\Yappendixkeyword + \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% + \def\toctype{app}% + % We don't substitute the actual chapter name into \thischapter + % because we don't want its macros evaluated now. And we don't + % use \thissection because that changes with each section. + % + \xdef\thischapter{\putwordAppendix{} \appendixletter: + \noexpand\thischaptername}% + \else + \setbox0 = \hbox{#3\enspace}% + \def\toctype{numchap}% + \xdef\thischapter{\putwordChapter{} \the\chapno: + \noexpand\thischaptername}% + \fi\fi\fi + % + % Write the toc entry for this chapter. Must come before the + % \donoderef, because we include the current node name in the toc + % entry, and \donoderef resets it to empty. + \writetocentry{\toctype}{#1}{#3}% + % + % For pdftex, we have to write out the node definition (aka, make + % the pdfdest) after any page break, but before the actual text has + % been typeset. If the destination for the pdf outline is after the + % text, then jumping from the outline may wind up with the text not + % being visible, for instance under high magnification. + \donoderef{#2}% + % + % Typeset the actual heading. + \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright + \hangindent=\wd0 \centerparametersmaybe + \unhbox0 #1\par}% + }% + \nobreak\bigskip % no page break after a chapter title + \nobreak +} + +% @centerchap -- centered and unnumbered. +\let\centerparametersmaybe = \relax +\def\centerchfplain#1{{% + \def\centerparametersmaybe{% + \advance\rightskip by 3\rightskip + \leftskip = \rightskip + \parfillskip = 0pt + }% + \chfplain{#1}{Ynothing}{}% +}} + +\CHAPFplain % The default + +% I don't think this chapter style is supported any more, so I'm not +% updating it with the new noderef stuff. We'll see. --karl, 11aug03. +% +\def\unnchfopen #1{% +\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 + \parindent=0pt\raggedright + \rm #1\hfill}}\bigskip \par\nobreak +} + +\def\chfopen #1#2{\chapoddpage {\chapfonts +\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% +\par\penalty 5000 % +} + +\def\centerchfopen #1{% +\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 + \parindent=0pt + \hfill {\rm #1}\hfill}}\bigskip \par\nobreak +} + +\def\CHAPFopen{% +\global\let\chapmacro=\chfopen +\global\let\centerchapmacro=\centerchfopen} + + +% Section titles. These macros combine the section number parts and +% call the generic \sectionheading to do the printing. +% +\newskip\secheadingskip +\def\secheadingbreak{\dobreak \secheadingskip{-1000}} + +% Subsection titles. +\newskip\subsecheadingskip +\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} + +% Subsubsection titles. +\def\subsubsecheadingskip{\subsecheadingskip} +\def\subsubsecheadingbreak{\subsecheadingbreak} + + +% Print any size, any type, section title. +% +% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is +% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the +% section number. +% +\def\sectionheading#1#2#3#4{% + {% + % Switch to the right set of fonts. + \csname #2fonts\endcsname \rm + % + % Insert space above the heading. + \csname #2headingbreak\endcsname + % + % Only insert the space after the number if we have a section number. + \def\sectionlevel{#2}% + \def\temptype{#3}% + % + \ifx\temptype\Ynothingkeyword + \setbox0 = \hbox{}% + \def\toctype{unn}% + \gdef\thissection{#1}% + \else\ifx\temptype\Yomitfromtockeyword + % for @headings -- no section number, don't include in toc, + % and don't redefine \thissection. + \setbox0 = \hbox{}% + \def\toctype{omit}% + \let\sectionlevel=\empty + \else\ifx\temptype\Yappendixkeyword + \setbox0 = \hbox{#4\enspace}% + \def\toctype{app}% + \gdef\thissection{#1}% + \else + \setbox0 = \hbox{#4\enspace}% + \def\toctype{num}% + \gdef\thissection{#1}% + \fi\fi\fi + % + % Write the toc entry (before \donoderef). See comments in \chfplain. + \writetocentry{\toctype\sectionlevel}{#1}{#4}% + % + % Write the node reference (= pdf destination for pdftex). + % Again, see comments in \chfplain. + \donoderef{#3}% + % + % Output the actual section heading. + \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright + \hangindent=\wd0 % zero if no section number + \unhbox0 #1}% + }% + % Add extra space after the heading -- half of whatever came above it. + % Don't allow stretch, though. + \kern .5 \csname #2headingskip\endcsname + % + % Do not let the kern be a potential breakpoint, as it would be if it + % was followed by glue. + \nobreak + % + % We'll almost certainly start a paragraph next, so don't let that + % glue accumulate. (Not a breakpoint because it's preceded by a + % discardable item.) + \vskip-\parskip + % + % This \nobreak is purely so the last item on the list is a \penalty + % of 10000. This is so other code, for instance \parsebodycommon, can + % check for and avoid allowing breakpoints. Otherwise, it would + % insert a valid breakpoint between: + % @section sec-whatever + % @deffn def-whatever + \nobreak +} + + +\message{toc,} +% Table of contents. +\newwrite\tocfile + +% Write an entry to the toc file, opening it if necessary. +% Called from @chapter, etc. +% +% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} +% We append the current node name (if any) and page number as additional +% arguments for the \{chap,sec,...}entry macros which will eventually +% read this. The node name is used in the pdf outlines as the +% destination to jump to. +% +% We open the .toc file for writing here instead of at @setfilename (or +% any other fixed time) so that @contents can be anywhere in the document. +% But if #1 is `omit', then we don't do anything. This is used for the +% table of contents chapter openings themselves. +% +\newif\iftocfileopened +\def\omitkeyword{omit}% +% +\def\writetocentry#1#2#3{% + \edef\writetoctype{#1}% + \ifx\writetoctype\omitkeyword \else + \iftocfileopened\else + \immediate\openout\tocfile = \jobname.toc + \global\tocfileopenedtrue + \fi + % + \iflinks + \toks0 = {#2}% + \toks2 = \expandafter{\lastnode}% + \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}% + {\the\toks2}{\noexpand\folio}}}% + \temp + \fi + \fi + % + % Tell \shipout to create a pdf destination on each page, if we're + % writing pdf. These are used in the table of contents. We can't + % just write one on every page because the title pages are numbered + % 1 and 2 (the page numbers aren't printed), and so are the first + % two pages of the document. Thus, we'd have two destinations named + % `1', and two named `2'. + \ifpdf \global\pdfmakepagedesttrue \fi +} + +\newskip\contentsrightmargin \contentsrightmargin=1in +\newcount\savepageno +\newcount\lastnegativepageno \lastnegativepageno = -1 + +% Prepare to read what we've written to \tocfile. +% +\def\startcontents#1{% + % If @setchapternewpage on, and @headings double, the contents should + % start on an odd page, unlike chapters. Thus, we maintain + % \contentsalignmacro in parallel with \pagealignmacro. + % From: Torbjorn Granlund <tege@matematik.su.se> + \contentsalignmacro + \immediate\closeout\tocfile + % + % Don't need to put `Contents' or `Short Contents' in the headline. + % It is abundantly clear what they are. + \def\thischapter{}% + \chapmacro{#1}{Yomitfromtoc}{}% + % + \savepageno = \pageno + \begingroup % Set up to handle contents files properly. + \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 + % We can't do this, because then an actual ^ in a section + % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. + %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi + \raggedbottom % Worry more about breakpoints than the bottom. + \advance\hsize by -\contentsrightmargin % Don't use the full line length. + % + % Roman numerals for page numbers. + \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi +} + + +% Normal (long) toc. +\def\contents{% + \startcontents{\putwordTOC}% + \openin 1 \jobname.toc + \ifeof 1 \else + \input \jobname.toc + \fi + \vfill \eject + \contentsalignmacro % in case @setchapternewpage odd is in effect + \ifeof 1 \else + \pdfmakeoutlines + \fi + \closein 1 + \endgroup + \lastnegativepageno = \pageno + \global\pageno = \savepageno +} + +% And just the chapters. +\def\summarycontents{% + \startcontents{\putwordShortTOC}% + % + \let\numchapentry = \shortchapentry + \let\appentry = \shortchapentry + \let\unnchapentry = \shortunnchapentry + % We want a true roman here for the page numbers. + \secfonts + \let\rm=\shortcontrm \let\bf=\shortcontbf + \let\sl=\shortcontsl \let\tt=\shortconttt + \rm + \hyphenpenalty = 10000 + \advance\baselineskip by 1pt % Open it up a little. + \def\numsecentry##1##2##3##4{} + \let\appsecentry = \numsecentry + \let\unnsecentry = \numsecentry + \let\numsubsecentry = \numsecentry + \let\appsubsecentry = \numsecentry + \let\unnsubsecentry = \numsecentry + \let\numsubsubsecentry = \numsecentry + \let\appsubsubsecentry = \numsecentry + \let\unnsubsubsecentry = \numsecentry + \openin 1 \jobname.toc + \ifeof 1 \else + \input \jobname.toc + \fi + \closein 1 + \vfill \eject + \contentsalignmacro % in case @setchapternewpage odd is in effect + \endgroup + \lastnegativepageno = \pageno + \global\pageno = \savepageno +} +\let\shortcontents = \summarycontents + +% Typeset the label for a chapter or appendix for the short contents. +% The arg is, e.g., `A' for an appendix, or `3' for a chapter. +% +\def\shortchaplabel#1{% + % This space should be enough, since a single number is .5em, and the + % widest letter (M) is 1em, at least in the Computer Modern fonts. + % But use \hss just in case. + % (This space doesn't include the extra space that gets added after + % the label; that gets put in by \shortchapentry above.) + % + % We'd like to right-justify chapter numbers, but that looks strange + % with appendix letters. And right-justifying numbers and + % left-justifying letters looks strange when there is less than 10 + % chapters. Have to read the whole toc once to know how many chapters + % there are before deciding ... + \hbox to 1em{#1\hss}% +} + +% These macros generate individual entries in the table of contents. +% The first argument is the chapter or section name. +% The last argument is the page number. +% The arguments in between are the chapter number, section number, ... + +% Chapters, in the main contents. +\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} +% +% Chapters, in the short toc. +% See comments in \dochapentry re vbox and related settings. +\def\shortchapentry#1#2#3#4{% + \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% +} + +% Appendices, in the main contents. +% Need the word Appendix, and a fixed-size box. +% +\def\appendixbox#1{% + % We use M since it's probably the widest letter. + \setbox0 = \hbox{\putwordAppendix{} M}% + \hbox to \wd0{\putwordAppendix{} #1\hss}} +% +\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} + +% Unnumbered chapters. +\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} +\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} + +% Sections. +\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} +\let\appsecentry=\numsecentry +\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} + +% Subsections. +\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} +\let\appsubsecentry=\numsubsecentry +\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} + +% And subsubsections. +\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} +\let\appsubsubsecentry=\numsubsubsecentry +\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} + +% This parameter controls the indentation of the various levels. +% Same as \defaultparindent. +\newdimen\tocindent \tocindent = 15pt + +% Now for the actual typesetting. In all these, #1 is the text and #2 is the +% page number. +% +% If the toc has to be broken over pages, we want it to be at chapters +% if at all possible; hence the \penalty. +\def\dochapentry#1#2{% + \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip + \begingroup + \chapentryfonts + \tocentry{#1}{\dopageno\bgroup#2\egroup}% + \endgroup + \nobreak\vskip .25\baselineskip plus.1\baselineskip +} + +\def\dosecentry#1#2{\begingroup + \secentryfonts \leftskip=\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +\def\dosubsecentry#1#2{\begingroup + \subsecentryfonts \leftskip=2\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +\def\dosubsubsecentry#1#2{\begingroup + \subsubsecentryfonts \leftskip=3\tocindent + \tocentry{#1}{\dopageno\bgroup#2\egroup}% +\endgroup} + +% We use the same \entry macro as for the index entries. +\let\tocentry = \entry + +% Space between chapter (or whatever) number and the title. +\def\labelspace{\hskip1em \relax} + +\def\dopageno#1{{\rm #1}} +\def\doshortpageno#1{{\rm #1}} + +\def\chapentryfonts{\secfonts \rm} +\def\secentryfonts{\textfonts} +\def\subsecentryfonts{\textfonts} +\def\subsubsecentryfonts{\textfonts} + + +\message{environments,} +% @foo ... @end foo. + +% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. +% +% Since these characters are used in examples, it should be an even number of +% \tt widths. Each \tt character is 1en, so two makes it 1em. +% +\def\point{$\star$} +\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} +\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} +\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} +\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} + +% The @error{} command. +% Adapted from the TeXbook's \boxit. +% +\newbox\errorbox +% +{\tentt \global\dimen0 = 3em}% Width of the box. +\dimen2 = .55pt % Thickness of rules +% The text. (`r' is open on the right, `e' somewhat less so on the left.) +\setbox0 = \hbox{\kern-.75pt \tensf error\kern-1.5pt} +% +\setbox\errorbox=\hbox to \dimen0{\hfil + \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. + \advance\hsize by -2\dimen2 % Rules. + \vbox{% + \hrule height\dimen2 + \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. + \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. + \kern3pt\vrule width\dimen2}% Space to right. + \hrule height\dimen2} + \hfil} +% +\def\error{\leavevmode\lower.7ex\copy\errorbox} + +% @tex ... @end tex escapes into raw Tex temporarily. +% One exception: @ is still an escape character, so that @end tex works. +% But \@ or @@ will get a plain tex @ character. + +\envdef\tex{% + \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 + \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 + \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie + \catcode `\%=14 + \catcode `\+=\other + \catcode `\"=\other + \catcode `\|=\other + \catcode `\<=\other + \catcode `\>=\other + \escapechar=`\\ + % + \let\b=\ptexb + \let\bullet=\ptexbullet + \let\c=\ptexc + \let\,=\ptexcomma + \let\.=\ptexdot + \let\dots=\ptexdots + \let\equiv=\ptexequiv + \let\!=\ptexexclam + \let\i=\ptexi + \let\indent=\ptexindent + \let\noindent=\ptexnoindent + \let\{=\ptexlbrace + \let\+=\tabalign + \let\}=\ptexrbrace + \let\/=\ptexslash + \let\*=\ptexstar + \let\t=\ptext + % + \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% + \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% + \def\@{@}% +} +% There is no need to define \Etex. + +% Define @lisp ... @end lisp. +% @lisp environment forms a group so it can rebind things, +% including the definition of @end lisp (which normally is erroneous). + +% Amount to narrow the margins by for @lisp. +\newskip\lispnarrowing \lispnarrowing=0.4in + +% This is the definition that ^^M gets inside @lisp, @example, and other +% such environments. \null is better than a space, since it doesn't +% have any width. +\def\lisppar{\null\endgraf} + +% This space is always present above and below environments. +\newskip\envskipamount \envskipamount = 0pt + +% Make spacing and below environment symmetrical. We use \parskip here +% to help in doing that, since in @example-like environments \parskip +% is reset to zero; thus the \afterenvbreak inserts no space -- but the +% start of the next paragraph will insert \parskip. +% +\def\aboveenvbreak{{% + % =10000 instead of <10000 because of a special case in \itemzzz, q.v. + \ifnum \lastpenalty=10000 \else + \advance\envskipamount by \parskip + \endgraf + \ifdim\lastskip<\envskipamount + \removelastskip + % it's not a good place to break if the last penalty was \nobreak + % or better ... + \ifnum\lastpenalty<10000 \penalty-50 \fi + \vskip\envskipamount + \fi + \fi +}} + +\let\afterenvbreak = \aboveenvbreak + +% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins. +\let\nonarrowing=\relax + +% @cartouche ... @end cartouche: draw rectangle w/rounded corners around +% environment contents. +\font\circle=lcircle10 +\newdimen\circthick +\newdimen\cartouter\newdimen\cartinner +\newskip\normbskip\newskip\normpskip\newskip\normlskip +\circthick=\fontdimen8\circle +% +\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth +\def\ctr{{\hskip 6pt\circle\char'010}} +\def\cbl{{\circle\char'012\hskip -6pt}} +\def\cbr{{\hskip 6pt\circle\char'011}} +\def\carttop{\hbox to \cartouter{\hskip\lskip + \ctl\leaders\hrule height\circthick\hfil\ctr + \hskip\rskip}} +\def\cartbot{\hbox to \cartouter{\hskip\lskip + \cbl\leaders\hrule height\circthick\hfil\cbr + \hskip\rskip}} +% +\newskip\lskip\newskip\rskip + +\envdef\cartouche{% + \ifhmode\par\fi % can't be in the midst of a paragraph. + \startsavinginserts + \lskip=\leftskip \rskip=\rightskip + \leftskip=0pt\rightskip=0pt % we want these *outside*. + \cartinner=\hsize \advance\cartinner by-\lskip + \advance\cartinner by-\rskip + \cartouter=\hsize + \advance\cartouter by 18.4pt % allow for 3pt kerns on either + % side, and for 6pt waste from + % each corner char, and rule thickness + \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip + % Flag to tell @lisp, etc., not to narrow margin. + \let\nonarrowing=\comment + \vbox\bgroup + \baselineskip=0pt\parskip=0pt\lineskip=0pt + \carttop + \hbox\bgroup + \hskip\lskip + \vrule\kern3pt + \vbox\bgroup + \kern3pt + \hsize=\cartinner + \baselineskip=\normbskip + \lineskip=\normlskip + \parskip=\normpskip + \vskip -\parskip + \comment % For explanation, see the end of \def\group. +} +\def\Ecartouche{% + \ifhmode\par\fi + \kern3pt + \egroup + \kern3pt\vrule + \hskip\rskip + \egroup + \cartbot + \egroup + \checkinserts +} + + +% This macro is called at the beginning of all the @example variants, +% inside a group. +\def\nonfillstart{% + \aboveenvbreak + \hfuzz = 12pt % Don't be fussy + \sepspaces % Make spaces be word-separators rather than space tokens. + \let\par = \lisppar % don't ignore blank lines + \obeylines % each line of input is a line of output + \parskip = 0pt + \parindent = 0pt + \emergencystretch = 0pt % don't try to avoid overfull boxes + % @cartouche defines \nonarrowing to inhibit narrowing + % at next level down. + \ifx\nonarrowing\relax + \advance \leftskip by \lispnarrowing + \exdentamount=\lispnarrowing + \fi + \let\exdent=\nofillexdent +} + +% If you want all examples etc. small: @set dispenvsize small. +% If you want even small examples the full size: @set dispenvsize nosmall. +% This affects the following displayed environments: +% @example, @display, @format, @lisp +% +\def\smallword{small} +\def\nosmallword{nosmall} +\let\SETdispenvsize\relax +\def\setnormaldispenv{% + \ifx\SETdispenvsize\smallword + \smallexamplefonts \rm + \fi +} +\def\setsmalldispenv{% + \ifx\SETdispenvsize\nosmallword + \else + \smallexamplefonts \rm + \fi +} + +% We often define two environments, @foo and @smallfoo. +% Let's do it by one command: +\def\makedispenv #1#2{ + \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} + \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} + \expandafter\let\csname E#1\endcsname \afterenvbreak + \expandafter\let\csname Esmall#1\endcsname \afterenvbreak +} + +% Define two synonyms: +\def\maketwodispenvs #1#2#3{ + \makedispenv{#1}{#3} + \makedispenv{#2}{#3} +} + +% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. +% +% @smallexample and @smalllisp: use smaller fonts. +% Originally contributed by Pavel@xerox. +% +\maketwodispenvs {lisp}{example}{% + \nonfillstart + \tt + \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. + \gobble % eat return +} + +% @display/@smalldisplay: same as @lisp except keep current font. +% +\makedispenv {display}{% + \nonfillstart + \gobble +} + +% @format/@smallformat: same as @display except don't narrow margins. +% +\makedispenv{format}{% + \let\nonarrowing = t% + \nonfillstart + \gobble +} + +% @flushleft: same as @format, but doesn't obey \SETdispenvsize. +\envdef\flushleft{% + \let\nonarrowing = t% + \nonfillstart + \gobble +} +\let\Eflushleft = \afterenvbreak + +% @flushright. +% +\envdef\flushright{% + \let\nonarrowing = t% + \nonfillstart + \advance\leftskip by 0pt plus 1fill + \gobble +} +\let\Eflushright = \afterenvbreak + + +% @quotation does normal linebreaking (hence we can't use \nonfillstart) +% and narrows the margins. +% +\envdef\quotation{% + {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip + \parindent=0pt + % + % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \ifx\nonarrowing\relax + \advance\leftskip by \lispnarrowing + \advance\rightskip by \lispnarrowing + \exdentamount = \lispnarrowing + \let\nonarrowing = \relax + \fi + \parsearg\quotationlabel +} + +% We have retained a nonzero parskip for the environment, since we're +% doing normal filling. So to avoid extra space below the environment... +\def\Equotation{\parskip = 0pt \afterenvbreak} + +% If we're given an argument, typeset it in bold with a colon after. +\def\quotationlabel#1{% + \def\temp{#1}% + \ifx\temp\empty \else + {\bf #1: }% + \fi +} + + +% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} +% If we want to allow any <char> as delimiter, +% we need the curly braces so that makeinfo sees the @verb command, eg: +% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org +% +% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. +% +% [Knuth] p.344; only we need to do the other characters Texinfo sets +% active too. Otherwise, they get lost as the first character on a +% verbatim line. +\def\dospecials{% + \do\ \do\\\do\{\do\}\do\$\do\&% + \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% + \do\<\do\>\do\|\do\@\do+\do\"% +} +% +% [Knuth] p. 380 +\def\uncatcodespecials{% + \def\do##1{\catcode`##1=\other}\dospecials} +% +% [Knuth] pp. 380,381,391 +% Disable Spanish ligatures ?` and !` of \tt font +\begingroup + \catcode`\`=\active\gdef`{\relax\lq} +\endgroup +% +% Setup for the @verb command. +% +% Eight spaces for a tab +\begingroup + \catcode`\^^I=\active + \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} +\endgroup +% +\def\setupverb{% + \tt % easiest (and conventionally used) font for verbatim + \def\par{\leavevmode\endgraf}% + \catcode`\`=\active + \tabeightspaces + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces +} + +% Setup for the @verbatim environment +% +% Real tab expansion +\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount +% +\def\starttabbox{\setbox0=\hbox\bgroup} +\begingroup + \catcode`\^^I=\active + \gdef\tabexpand{% + \catcode`\^^I=\active + \def^^I{\leavevmode\egroup + \dimen0=\wd0 % the width so far, or since the previous tab + \divide\dimen0 by\tabw + \multiply\dimen0 by\tabw % compute previous multiple of \tabw + \advance\dimen0 by\tabw % advance to next multiple of \tabw + \wd0=\dimen0 \box0 \starttabbox + }% + } +\endgroup +\def\setupverbatim{% + \nonfillstart + \advance\leftskip by -\defbodyindent + % Easiest (and conventionally used) font for verbatim + \tt + \def\par{\leavevmode\egroup\box0\endgraf}% + \catcode`\`=\active + \tabexpand + % Respect line breaks, + % print special symbols as themselves, and + % make each space count + % must do in this order: + \obeylines \uncatcodespecials \sepspaces + \everypar{\starttabbox}% +} + +% Do the @verb magic: verbatim text is quoted by unique +% delimiter characters. Before first delimiter expect a +% right brace, after last delimiter expect closing brace: +% +% \def\doverb'{'<char>#1<char>'}'{#1} +% +% [Knuth] p. 382; only eat outer {} +\begingroup + \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other + \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] +\endgroup +% +\def\verb{\begingroup\setupverb\doverb} +% +% +% Do the @verbatim magic: define the macro \doverbatim so that +% the (first) argument ends when '@end verbatim' is reached, ie: +% +% \def\doverbatim#1@end verbatim{#1} +% +% For Texinfo it's a lot easier than for LaTeX, +% because texinfo's \verbatim doesn't stop at '\end{verbatim}': +% we need not redefine '\', '{' and '}'. +% +% Inspired by LaTeX's verbatim command set [latex.ltx] +% +\begingroup + \catcode`\ =\active + \obeylines % + % ignore everything up to the first ^^M, that's the newline at the end + % of the @verbatim input line itself. Otherwise we get an extra blank + % line in the output. + \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% + % We really want {...\end verbatim} in the body of the macro, but + % without the active space; thus we have to use \xdef and \gobble. +\endgroup +% +\envdef\verbatim{% + \setupverbatim\doverbatim +} +\let\Everbatim = \afterenvbreak + + +% @verbatiminclude FILE - insert text of file in verbatim environment. +% +\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} +% +\def\doverbatiminclude#1{% + {% + \makevalueexpandable + \setupverbatim + \input #1 + \afterenvbreak + }% +} + +% @copying ... @end copying. +% Save the text away for @insertcopying later. Many commands won't be +% allowed in this context, but that's ok. +% +% We save the uninterpreted tokens, rather than creating a box. +% Saving the text in a box would be much easier, but then all the +% typesetting commands (@smallbook, font changes, etc.) have to be done +% beforehand -- and a) we want @copying to be done first in the source +% file; b) letting users define the frontmatter in as flexible order as +% possible is very desirable. +% +\def\copying{\begingroup + % Define a command to swallow text until we reach `@end copying'. + % \ is the escape char in this texinfo.tex file, so it is the + % delimiter for the command; @ will be the escape char when we read + % it, but that doesn't matter. + \long\def\docopying##1\end copying{\gdef\copyingtext{##1}\enddocopying}% + % + % We must preserve ^^M's in the input file; see \insertcopying below. + \catcode`\^^M = \active + \docopying +} + +% What we do to finish off the copying text. +% +\def\enddocopying{\endgroup\ignorespaces} + +% @insertcopying. Here we must play games with ^^M's. On the one hand, +% we need them to delimit commands such as `@end quotation', so they +% must be active. On the other hand, we certainly don't want every +% end-of-line to be a \par, as would happen with the normal active +% definition of ^^M. On the third hand, two ^^M's in a row should still +% generate a \par. +% +% Our approach is to make ^^M insert a space and a penalty1 normally; +% then it can also check if \lastpenalty=1. If it does, then manually +% do \par. +% +% This messes up the normal definitions of @c[omment], so we redefine +% it. Similarly for @ignore. (These commands are used in the gcc +% manual for man page generation.) +% +% Seems pretty fragile, most line-oriented commands will presumably +% fail, but for the limited use of getting the copying text (which +% should be quite simple) inserted, we can hope it's ok. +% +{\catcode`\^^M=\active % +\gdef\insertcopying{\begingroup % + \parindent = 0pt % looks wrong on title page + \def^^M{% + \ifnum \lastpenalty=1 % + \par % + \else % + \space \penalty 1 % + \fi % + }% + % + % Fix @c[omment] for catcode 13 ^^M's. + \def\c##1^^M{\ignorespaces}% + \let\comment = \c % + % + % Don't bother jumping through all the hoops that \doignore does, it + % would be very hard since the catcodes are already set. + \long\def\ignore##1\end ignore{\ignorespaces}% + % + \copyingtext % +\endgroup}% +} + +\message{defuns,} +% @defun etc. + +\newskip\defbodyindent \defbodyindent=.4in +\newskip\defargsindent \defargsindent=50pt +\newskip\deflastargmargin \deflastargmargin=18pt + +% Start the processing of @deffn: +\def\startdefun{% + \ifnum\lastpenalty<10000 + \medbreak + \else + % If there are two @def commands in a row, we'll have a \nobreak, + % which is there to keep the function description together with its + % header. But if there's nothing but headers, we need to allow a + % break somewhere. Check for penalty 10002 (inserted by + % \defargscommonending) instead of 10000, since the sectioning + % commands insert a \penalty10000, and we don't want to allow a break + % between a section heading and a defun. + \ifnum\lastpenalty=10002 \penalty2000 \fi + % + % Similarly, after a section heading, do not allow a break. + % But do insert the glue. + \medskip % preceded by discardable penalty, so not a breakpoint + \fi + % + \parindent=0in + \advance\leftskip by \defbodyindent + \exdentamount=\defbodyindent +} + +\def\dodefunx#1{% + % First, check whether we are in the right environment: + \checkenv#1% + % + % As above, allow line break if we have multiple x headers in a row. + % It's not a great place, though. + \ifnum\lastpenalty=10002 \penalty3000 \fi + % + % And now, it's time to reuse the body of the original defun: + \expandafter\gobbledefun#1% +} +\def\gobbledefun#1\startdefun{} + +% \printdefunline \deffnheader{text} +% +\def\printdefunline#1#2{% + \begingroup + % call \deffnheader: + #1#2 \endheader + % common ending: + \interlinepenalty = 10000 + \advance\rightskip by 0pt plus 1fil + \endgraf + \nobreak\vskip -\parskip + \penalty 10002 % signal to \startdefun and \dodefunx + % Some of the @defun-type tags do not enable magic parentheses, + % rendering the following check redundant. But we don't optimize. + \checkparencounts + \endgroup +} + +\def\Edefun{\endgraf\medbreak} + +% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; +% the only thing remainnig is to define \deffnheader. +% +\def\makedefun#1{% + \expandafter\let\csname E#1\endcsname = \Edefun + \edef\temp{\noexpand\domakedefun + \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% + \temp +} + +% \domakedefun \deffn \deffnx \deffnheader +% +% Define \deffn and \deffnx, without parameters. +% \deffnheader has to be defined explicitly. +% +\def\domakedefun#1#2#3{% + \envdef#1{% + \startdefun + \parseargusing\activeparens{\printdefunline#3}% + }% + \def#2{\dodefunx#1}% + \def#3% +} + +%%% Untyped functions: + +% @deffn category name args +\makedefun{deffn}{\deffngeneral{}} + +% @deffn category class name args +\makedefun{defop}#1 {\defopon{#1\ \putwordon}} + +% \defopon {category on}class name args +\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } + +% \deffngeneral {subind}category name args +% +\def\deffngeneral#1#2 #3 #4\endheader{% + % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. + \dosubind{fn}{\code{#3}}{#1}% + \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% +} + +%%% Typed functions: + +% @deftypefn category type name args +\makedefun{deftypefn}{\deftypefngeneral{}} + +% @deftypeop category class type name args +\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} + +% \deftypeopon {category on}class type name args +\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } + +% \deftypefngeneral {subind}category type name args +% +\def\deftypefngeneral#1#2 #3 #4 #5\endheader{% + \dosubind{fn}{\code{#4}}{#1}% + \defname{#2}{#3}{#4}\defunargs{#5\unskip}% +} + +%%% Typed variables: + +% @deftypevr category type var args +\makedefun{deftypevr}{\deftypecvgeneral{}} + +% @deftypecv category class type var args +\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} + +% \deftypecvof {category of}class type var args +\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } + +% \deftypecvgeneral {subind}category type var args +% +\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% + \dosubind{vr}{\code{#4}}{#1}% + \defname{#2}{#3}{#4}\defunargs{#5\unskip}% +} + +%%% Untyped variables: + +% @defvr category var args +\makedefun{defvr}#1 {\deftypevrheader{#1} {} } + +% @defcv category class var args +\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} + +% \defcvof {category of}class var args +\def\defcvof#1#2 {\deftypecvof{#1}#2 {} } + +%%% Type: +% @deftp category name args +\makedefun{deftp}#1 #2 #3\endheader{% + \doind{tp}{\code{#2}}% + \defname{#1}{}{#2}\defunargs{#3\unskip}% +} + +% Remaining @defun-like shortcuts: +\makedefun{defun}{\deffnheader{\putwordDeffunc} } +\makedefun{defmac}{\deffnheader{\putwordDefmac} } +\makedefun{defspec}{\deffnheader{\putwordDefspec} } +\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } +\makedefun{defvar}{\defvrheader{\putwordDefvar} } +\makedefun{defopt}{\defvrheader{\putwordDefopt} } +\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } +\makedefun{defmethod}{\defopon\putwordMethodon} +\makedefun{deftypemethod}{\deftypeopon\putwordMethodon} +\makedefun{defivar}{\defcvof\putwordInstanceVariableof} +\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} + +% \defname, which formats the name of the @def (not the args). +% #1 is the category, such as "Function". +% #2 is the return type, if any. +% #3 is the function name. +% +% We are followed by (but not passed) the arguments, if any. +% +\def\defname#1#2#3{% + % Get the values of \leftskip and \rightskip as they were outside the @def... + \advance\leftskip by -\defbodyindent + % + % How we'll format the type name. Putting it in brackets helps + % distinguish it from the body text that may end up on the next line + % just below it. + \def\temp{#1}% + \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} + % + % Figure out line sizes for the paragraph shape. + % The first line needs space for \box0; but if \rightskip is nonzero, + % we need only space for the part of \box0 which exceeds it: + \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip + % The continuations: + \dimen2=\hsize \advance\dimen2 by -\defargsindent + % (plain.tex says that \dimen1 should be used only as global.) + \parshape 2 0in \dimen0 \defargsindent \dimen2 + % + % Put the type name to the right margin. + \noindent + \hbox to 0pt{% + \hfil\box0 \kern-\hsize + % \hsize has to be shortened this way: + \kern\leftskip + % Intentionally do not respect \rightskip, since we need the space. + }% + % + % Allow all lines to be underfull without complaint: + \tolerance=10000 \hbadness=10000 + \exdentamount=\defbodyindent + {% + % defun fonts. We use typewriter by default (used to be bold) because: + % . we're printing identifiers, they should be in tt in principle. + % . in languages with many accents, such as Czech or French, it's + % common to leave accents off identifiers. The result looks ok in + % tt, but exceedingly strange in rm. + % . we don't want -- and --- to be treated as ligatures. + % . this still does not fix the ?` and !` ligatures, but so far no + % one has made identifiers using them :). + \df \tt + \def\temp{#2}% return value type + \ifx\temp\empty\else \tclose{\temp} \fi + #3% output function name + }% + {\rm\enskip}% hskip 0.5 em of \tenrm + % + \boldbrax + % arguments will be output next, if any. +} + +% Print arguments in slanted typewriter, prevent hyphenation at `-' chars. +% +\def\defunargs#1{% + % use sl by default (not ttsl), inconsistently with using tt for the + % name. This is because literal text is sometimes needed in the + % argument list (groff manual), and ttsl and tt are not very + % distinguishable. + % tt for the names. + \df \sl \hyphenchar\font=0 + % On the other hand, if an argument has two dashes (for instance), we + % want a way to get ttsl. Let's try @var for that. + \let\var=\ttslanted + #1% + \sl\hyphenchar\font=45 +} + +% We want ()&[] to print specially on the defun line. +% +\def\activeparens{% + \catcode`\(=\active \catcode`\)=\active + \catcode`\[=\active \catcode`\]=\active + \catcode`\&=\active +} + +% Make control sequences which act like normal parenthesis chars. +\let\lparen = ( \let\rparen = ) + +% Be sure that we always have a definition for `(', etc. For example, +% if the fn name has parens in it, \boldbrax will not be in effect yet, +% so TeX would otherwise complain about undefined control sequence. +{ + \activeparens + \global\let(=\lparen \global\let)=\rparen + \global\let[=\lbrack \global\let]=\rbrack + \global\let& = \& + + \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} + \gdef\magicamp{\let&=\amprm} +} + +\newcount\parencount + +% If we encounter &foo, then turn on ()-hacking afterwards +\newif\ifampseen +\def\amprm#1 {\ampseentrue{\bf\ }} + +\def\parenfont{% + \ifampseen + % At the first level, print parens in roman, + % otherwise use the default font. + \ifnum \parencount=1 \rm \fi + \else + % The \sf parens (in \boldbrax) actually are a little bolder than + % the contained text. This is especially needed for [ and ] . + \sf + \fi +} +\def\infirstlevel#1{% + \ifampseen + \ifnum\parencount=1 + #1% + \fi + \fi +} +\def\bfafterword#1 {#1 \bf} + +\def\opnr{% + \global\advance\parencount by 1 + {\parenfont(}% + \infirstlevel \bfafterword +} +\def\clnr{% + {\parenfont)}% + \infirstlevel \sl + \global\advance\parencount by -1 +} + +\newcount\brackcount +\def\lbrb{% + \global\advance\brackcount by 1 + {\bf[}% +} +\def\rbrb{% + {\bf]}% + \global\advance\brackcount by -1 +} + +\def\checkparencounts{% + \ifnum\parencount=0 \else \badparencount \fi + \ifnum\brackcount=0 \else \badbrackcount \fi +} +\def\badparencount{% + \errmessage{Unbalanced parentheses in @def}% + \global\parencount=0 +} +\def\badbrackcount{% + \errmessage{Unbalanced square braces in @def}% + \global\brackcount=0 +} + + +\message{macros,} +% @macro. + +% To do this right we need a feature of e-TeX, \scantokens, +% which we arrange to emulate with a temporary file in ordinary TeX. +\ifx\eTeXversion\undefined + \newwrite\macscribble + \def\scantokens#1{% + \toks0={#1\endinput}% + \immediate\openout\macscribble=\jobname.tmp + \immediate\write\macscribble{\the\toks0}% + \immediate\closeout\macscribble + \input \jobname.tmp + } +\fi + +\def\scanmacro#1{% + \begingroup + \newlinechar`\^^M + \let\xeatspaces\eatspaces + % Undo catcode changes of \startcontents and \doprintindex + \catcode`\@=0 \catcode`\\=\other \escapechar=`\@ + % ... and \example + \spaceisspace + % + % Append \endinput to make sure that TeX does not see the ending newline. + % + % I've verified that it is necessary both for e-TeX and for ordinary TeX + % --kasal, 29nov03 + \scantokens{#1\endinput}% + \endgroup +} + +\newcount\paramno % Count of parameters +\newtoks\macname % Macro name +\newif\ifrecursive % Is it recursive? +\def\macrolist{} % List of all defined macros in the form + % \do\macro1\do\macro2... + +% Utility routines. +% This does \let #1 = #2, except with \csnames. +\def\cslet#1#2{% +\expandafter\expandafter +\expandafter\let +\expandafter\expandafter +\csname#1\endcsname +\csname#2\endcsname} + +% Trim leading and trailing spaces off a string. +% Concepts from aro-bend problem 15 (see CTAN). +{\catcode`\@=11 +\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} +\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} +\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} +\def\unbrace#1{#1} +\unbrace{\gdef\trim@@@ #1 } #2@{#1} +} + +% Trim a single trailing ^^M off a string. +{\catcode`\^^M=\other \catcode`\Q=3% +\gdef\eatcr #1{\eatcra #1Q^^MQ}% +\gdef\eatcra#1^^MQ{\eatcrb#1Q}% +\gdef\eatcrb#1Q#2Q{#1}% +} + +% Macro bodies are absorbed as an argument in a context where +% all characters are catcode 10, 11 or 12, except \ which is active +% (as in normal texinfo). It is necessary to change the definition of \. + +% It's necessary to have hard CRs when the macro is executed. This is +% done by making ^^M (\endlinechar) catcode 12 when reading the macro +% body, and then making it the \newlinechar in \scanmacro. + +\def\macrobodyctxt{% + \catcode`\~=\other + \catcode`\^=\other + \catcode`\_=\other + \catcode`\|=\other + \catcode`\<=\other + \catcode`\>=\other + \catcode`\+=\other + \catcode`\{=\other + \catcode`\}=\other + \catcode`\@=\other + \catcode`\^^M=\other + \usembodybackslash} + +\def\macroargctxt{% + \catcode`\~=\other + \catcode`\^=\other + \catcode`\_=\other + \catcode`\|=\other + \catcode`\<=\other + \catcode`\>=\other + \catcode`\+=\other + \catcode`\@=\other + \catcode`\\=\other} + +% \mbodybackslash is the definition of \ in @macro bodies. +% It maps \foo\ => \csname macarg.foo\endcsname => #N +% where N is the macro parameter number. +% We define \csname macarg.\endcsname to be \realbackslash, so +% \\ in macro replacement text gets you a backslash. + +{\catcode`@=0 @catcode`@\=@active + @gdef@usembodybackslash{@let\=@mbodybackslash} + @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} +} +\expandafter\def\csname macarg.\endcsname{\realbackslash} + +\def\macro{\recursivefalse\parsearg\macroxxx} +\def\rmacro{\recursivetrue\parsearg\macroxxx} + +\def\macroxxx#1{% + \getargs{#1}% now \macname is the macname and \argl the arglist + \ifx\argl\empty % no arguments + \paramno=0% + \else + \expandafter\parsemargdef \argl;% + \fi + \if1\csname ismacro.\the\macname\endcsname + \message{Warning: redefining \the\macname}% + \else + \expandafter\ifx\csname \the\macname\endcsname \relax + \else \errmessage{Macro name \the\macname\space already defined}\fi + \global\cslet{macsave.\the\macname}{\the\macname}% + \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% + % Add the macroname to \macrolist + \toks0 = \expandafter{\macrolist\do}% + \xdef\macrolist{\the\toks0 + \expandafter\noexpand\csname\the\macname\endcsname}% + \fi + \begingroup \macrobodyctxt + \ifrecursive \expandafter\parsermacbody + \else \expandafter\parsemacbody + \fi} + +\parseargdef\unmacro{% + \if1\csname ismacro.#1\endcsname + \global\cslet{#1}{macsave.#1}% + \global\expandafter\let \csname ismacro.#1\endcsname=0% + % Remove the macro name from \macrolist: + \begingroup + \expandafter\let\csname#1\endcsname \relax + \let\do\unmacrodo + \xdef\macrolist{\macrolist}% + \endgroup + \else + \errmessage{Macro #1 not defined}% + \fi +} + +% Called by \do from \dounmacro on each macro. The idea is to omit any +% macro definitions that have been changed to \relax. +% +\def\unmacrodo#1{% + \ifx#1\relax + % remove this + \else + \noexpand\do \noexpand #1% + \fi +} + +% This makes use of the obscure feature that if the last token of a +% <parameter list> is #, then the preceding argument is delimited by +% an opening brace, and that opening brace is not consumed. +\def\getargs#1{\getargsxxx#1{}} +\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} +\def\getmacname #1 #2\relax{\macname={#1}} +\def\getmacargs#1{\def\argl{#1}} + +% Parse the optional {params} list. Set up \paramno and \paramlist +% so \defmacro knows what to do. Define \macarg.blah for each blah +% in the params list, to be ##N where N is the position in that list. +% That gets used by \mbodybackslash (above). + +% We need to get `macro parameter char #' into several definitions. +% The technique used is stolen from LaTeX: let \hash be something +% unexpandable, insert that wherever you need a #, and then redefine +% it to # just before using the token list produced. +% +% The same technique is used to protect \eatspaces till just before +% the macro is used. + +\def\parsemargdef#1;{\paramno=0\def\paramlist{}% + \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} +\def\parsemargdefxxx#1,{% + \if#1;\let\next=\relax + \else \let\next=\parsemargdefxxx + \advance\paramno by 1% + \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname + {\xeatspaces{\hash\the\paramno}}% + \edef\paramlist{\paramlist\hash\the\paramno,}% + \fi\next} + +% These two commands read recursive and nonrecursive macro bodies. +% (They're different since rec and nonrec macros end differently.) + +\long\def\parsemacbody#1@end macro% +{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% +\long\def\parsermacbody#1@end rmacro% +{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% + +% This defines the macro itself. There are six cases: recursive and +% nonrecursive macros of zero, one, and many arguments. +% Much magic with \expandafter here. +% \xdef is used so that macro definitions will survive the file +% they're defined in; @include reads the file inside a group. +\def\defmacro{% + \let\hash=##% convert placeholders to macro parameter chars + \ifrecursive + \ifcase\paramno + % 0 + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\scanmacro{\temp}}% + \or % 1 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\braceorline + \expandafter\noexpand\csname\the\macname xxx\endcsname}% + \expandafter\xdef\csname\the\macname xxx\endcsname##1{% + \egroup\noexpand\scanmacro{\temp}}% + \else % many + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{\egroup\noexpand\scanmacro{\temp}}% + \fi + \else + \ifcase\paramno + % 0 + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \or % 1 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\braceorline + \expandafter\noexpand\csname\the\macname xxx\endcsname}% + \expandafter\xdef\csname\the\macname xxx\endcsname##1{% + \egroup + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \else % many + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \expandafter\noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{% + \egroup + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \fi + \fi} + +\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} + +% \braceorline decides whether the next nonwhitespace character is a +% {. If so it reads up to the closing }, if not, it reads the whole +% line. Whatever was read is then fed to the next control sequence +% as an argument (by \parsebrace or \parsearg) +\def\braceorline#1{\let\next=#1\futurelet\nchar\braceorlinexxx} +\def\braceorlinexxx{% + \ifx\nchar\bgroup\else + \expandafter\parsearg + \fi \next} + +% We mant to disable all macros during \shipout so that they are not +% expanded by \write. +\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}% + \edef\next{\macrolist}\expandafter\endgroup\next} + + +% @alias. +% We need some trickery to remove the optional spaces around the equal +% sign. Just make them active and then expand them all to nothing. +\def\alias{\parseargusing\obeyspaces\aliasxxx} +\def\aliasxxx #1{\aliasyyy#1\relax} +\def\aliasyyy #1=#2\relax{% + {% + \expandafter\let\obeyedspace=\empty + \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% + }% + \next +} + + +\message{cross references,} + +\newwrite\auxfile + +\newif\ifhavexrefs % True if xref values are known. +\newif\ifwarnedxrefs % True if we warned once that they aren't known. + +% @inforef is relatively simple. +\def\inforef #1{\inforefzzz #1,,,,**} +\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, + node \samp{\ignorespaces#1{}}} + +% @node's only job in TeX is to define \lastnode, which is used in +% cross-references. +\parseargdef\node{\checkenv{}\nodexxx #1,\finishnodeparse} +\def\nodexxx#1,#2\finishnodeparse{\gdef\lastnode{#1}} +\let\nwnode=\node +\let\lastnode=\empty + +% Write a cross-reference definition for the current node. #1 is the +% type (Ynumbered, Yappendix, Ynothing). +% +\def\donoderef#1{% + \ifx\lastnode\empty\else + \setref{\lastnode}{#1}% + \global\let\lastnode=\empty + \fi +} + +% @anchor{NAME} -- define xref target at arbitrary point. +% +\newcount\savesfregister +% +\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} +\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} +\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} + +% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an +% anchor), which consists of three parts: +% 1) NAME-title - the current sectioning name taken from \thissection, +% or the anchor name. +% 2) NAME-snt - section number and type, passed as the SNT arg, or +% empty for anchors. +% 3) NAME-pg - the page number. +% +% This is called from \donoderef, \anchor, and \dofloat. In the case of +% floats, there is an additional part, which is not written here: +% 4) NAME-lof - the text as it should appear in a @listoffloats. +% +\def\setref#1#2{% + \pdfmkdest{#1}% + \iflinks + {% + \atdummies % preserve commands, but don't expand them + \turnoffactive + \otherbackslash + \edef\writexrdef##1##2{% + \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef + ##1}{##2}}% these are parameters of \writexrdef + }% + \toks0 = \expandafter{\thissection}% + \immediate \writexrdef{title}{\the\toks0 }% + \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. + \writexrdef{pg}{\folio}% will be written later, during \shipout + }% + \fi +} + +% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is +% the node name, #2 the name of the Info cross-reference, #3 the printed +% node name, #4 the name of the Info file, #5 the name of the printed +% manual. All but the node name can be omitted. +% +\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} +\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} +\def\ref#1{\xrefX[#1,,,,,,,]} +\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup + \unsepspaces + \def\printedmanual{\ignorespaces #5}% + \def\printedrefname{\ignorespaces #3}% + \setbox1=\hbox{\printedmanual\unskip}% + \setbox0=\hbox{\printedrefname\unskip}% + \ifdim \wd0 = 0pt + % No printed node name was explicitly given. + \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax + % Use the node name inside the square brackets. + \def\printedrefname{\ignorespaces #1}% + \else + % Use the actual chapter/section title appear inside + % the square brackets. Use the real section title if we have it. + \ifdim \wd1 > 0pt + % It is in another manual, so we don't have it. + \def\printedrefname{\ignorespaces #1}% + \else + \ifhavexrefs + % We know the real title if we have the xref values. + \def\printedrefname{\refx{#1-title}{}}% + \else + % Otherwise just copy the Info node name. + \def\printedrefname{\ignorespaces #1}% + \fi% + \fi + \fi + \fi + % + % Make link in pdf output. + \ifpdf + \leavevmode + \getfilename{#4}% + {\turnoffactive \otherbackslash + \ifnum\filenamelength>0 + \startlink attr{/Border [0 0 0]}% + goto file{\the\filename.pdf} name{#1}% + \else + \startlink attr{/Border [0 0 0]}% + goto name{\pdfmkpgn{#1}}% + \fi + }% + \linkcolor + \fi + % + % Float references are printed completely differently: "Figure 1.2" + % instead of "[somenode], p.3". We distinguish them by the + % LABEL-title being set to a magic string. + {% + % Have to otherify everything special to allow the \csname to + % include an _ in the xref name, etc. + \indexnofonts + \turnoffactive + \otherbackslash + \expandafter\global\expandafter\let\expandafter\Xthisreftitle + \csname XR#1-title\endcsname + }% + \iffloat\Xthisreftitle + % If the user specified the print name (third arg) to the ref, + % print it instead of our usual "Figure 1.2". + \ifdim\wd0 = 0pt + \refx{#1-snt}% + \else + \printedrefname + \fi + % + % if the user also gave the printed manual name (fifth arg), append + % "in MANUALNAME". + \ifdim \wd1 > 0pt + \space \putwordin{} \cite{\printedmanual}% + \fi + \else + % node/anchor (non-float) references. + % + % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not + % insert empty discretionaries after hyphens, which means that it will + % not find a line break at a hyphen in a node names. Since some manuals + % are best written with fairly long node names, containing hyphens, this + % is a loss. Therefore, we give the text of the node name again, so it + % is as if TeX is seeing it for the first time. + \ifdim \wd1 > 0pt + \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% + \else + % _ (for example) has to be the character _ for the purposes of the + % control sequence corresponding to the node, but it has to expand + % into the usual \leavevmode...\vrule stuff for purposes of + % printing. So we \turnoffactive for the \refx-snt, back on for the + % printing, back off for the \refx-pg. + {\turnoffactive \otherbackslash + % Only output a following space if the -snt ref is nonempty; for + % @unnumbered and @anchor, it won't be. + \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% + \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi + }% + % output the `[mynode]' via a macro so it can be overridden. + \xrefprintnodename\printedrefname + % + % But we always want a comma and a space: + ,\space + % + % output the `page 3'. + \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}% + \fi + \fi + \endlink +\endgroup} + +% This macro is called from \xrefX for the `[nodename]' part of xref +% output. It's a separate macro only so it can be changed more easily, +% since square brackets don't work well in some documents. Particularly +% one that Bob is working on :). +% +\def\xrefprintnodename#1{[#1]} + +% Things referred to by \setref. +% +\def\Ynothing{} +\def\Yomitfromtoc{} +\def\Ynumbered{% + \ifnum\secno=0 + \putwordChapter@tie \the\chapno + \else \ifnum\subsecno=0 + \putwordSection@tie \the\chapno.\the\secno + \else \ifnum\subsubsecno=0 + \putwordSection@tie \the\chapno.\the\secno.\the\subsecno + \else + \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno + \fi\fi\fi +} +\def\Yappendix{% + \ifnum\secno=0 + \putwordAppendix@tie @char\the\appendixno{}% + \else \ifnum\subsecno=0 + \putwordSection@tie @char\the\appendixno.\the\secno + \else \ifnum\subsubsecno=0 + \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno + \else + \putwordSection@tie + @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno + \fi\fi\fi +} + +% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. +% If its value is nonempty, SUFFIX is output afterward. +% +\def\refx#1#2{% + {% + \indexnofonts + \otherbackslash + \expandafter\global\expandafter\let\expandafter\thisrefX + \csname XR#1\endcsname + }% + \ifx\thisrefX\relax + % If not defined, say something at least. + \angleleft un\-de\-fined\angleright + \iflinks + \ifhavexrefs + \message{\linenumber Undefined cross reference `#1'.}% + \else + \ifwarnedxrefs\else + \global\warnedxrefstrue + \message{Cross reference values unknown; you must run TeX again.}% + \fi + \fi + \fi + \else + % It's defined, so just use it. + \thisrefX + \fi + #2% Output the suffix in any case. +} + +% This is the macro invoked by entries in the aux file. Usually it's +% just a \def (we prepend XR to the control sequence name to avoid +% collisions). But if this is a float type, we have more work to do. +% +\def\xrdef#1#2{% + \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value. + % + % Was that xref control sequence that we just defined for a float? + \expandafter\iffloat\csname XR#1\endcsname + % it was a float, and we have the (safe) float type in \iffloattype. + \expandafter\let\expandafter\floatlist + \csname floatlist\iffloattype\endcsname + % + % Is this the first time we've seen this float type? + \expandafter\ifx\floatlist\relax + \toks0 = {\do}% yes, so just \do + \else + % had it before, so preserve previous elements in list. + \toks0 = \expandafter{\floatlist\do}% + \fi + % + % Remember this xref in the control sequence \floatlistFLOATTYPE, + % for later use in \listoffloats. + \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}% + \fi +} + +% Read the last existing aux file, if any. No error if none exists. +% +\def\tryauxfile{% + \openin 1 \jobname.aux + \ifeof 1 \else + \readauxfile + \global\havexrefstrue + \fi + \closein 1 +} + +\def\readauxfile{\begingroup + \catcode`\^^@=\other + \catcode`\^^A=\other + \catcode`\^^B=\other + \catcode`\^^C=\other + \catcode`\^^D=\other + \catcode`\^^E=\other + \catcode`\^^F=\other + \catcode`\^^G=\other + \catcode`\^^H=\other + \catcode`\^^K=\other + \catcode`\^^L=\other + \catcode`\^^N=\other + \catcode`\^^P=\other + \catcode`\^^Q=\other + \catcode`\^^R=\other + \catcode`\^^S=\other + \catcode`\^^T=\other + \catcode`\^^U=\other + \catcode`\^^V=\other + \catcode`\^^W=\other + \catcode`\^^X=\other + \catcode`\^^Z=\other + \catcode`\^^[=\other + \catcode`\^^\=\other + \catcode`\^^]=\other + \catcode`\^^^=\other + \catcode`\^^_=\other + % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. + % in xref tags, i.e., node names. But since ^^e4 notation isn't + % supported in the main text, it doesn't seem desirable. Furthermore, + % that is not enough: for node names that actually contain a ^ + % character, we would end up writing a line like this: 'xrdef {'hat + % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first + % argument, and \hat is not an expandable control sequence. It could + % all be worked out, but why? Either we support ^^ or we don't. + % + % The other change necessary for this was to define \auxhat: + % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter + % and then to call \auxhat in \setq. + % + \catcode`\^=\other + % + % Special characters. Should be turned off anyway, but... + \catcode`\~=\other + \catcode`\[=\other + \catcode`\]=\other + \catcode`\"=\other + \catcode`\_=\other + \catcode`\|=\other + \catcode`\<=\other + \catcode`\>=\other + \catcode`\$=\other + \catcode`\#=\other + \catcode`\&=\other + \catcode`\%=\other + \catcode`+=\other % avoid \+ for paranoia even though we've turned it off + % + % This is to support \ in node names and titles, since the \ + % characters end up in a \csname. It's easier than + % leaving it active and making its active definition an actual \ + % character. What I don't understand is why it works in the *value* + % of the xrdef. Seems like it should be a catcode12 \, and that + % should not typeset properly. But it works, so I'm moving on for + % now. --karl, 15jan04. + \catcode`\\=\other + % + % Make the characters 128-255 be printing characters. + {% + \count 1=128 + \def\loop{% + \catcode\count 1=\other + \advance\count 1 by 1 + \ifnum \count 1<256 \loop \fi + }% + }% + % + % @ is our escape character in .aux files, and we need braces. + \catcode`\{=1 + \catcode`\}=2 + \catcode`\@=0 + % + \input \jobname.aux +\endgroup} + + +\message{insertions,} +% including footnotes. + +\newcount \footnoteno + +% The trailing space in the following definition for supereject is +% vital for proper filling; pages come out unaligned when you do a +% pagealignmacro call if that space before the closing brace is +% removed. (Generally, numeric constants should always be followed by a +% space to prevent strange expansion errors.) +\def\supereject{\par\penalty -20000\footnoteno =0 } + +% @footnotestyle is meaningful for info output only. +\let\footnotestyle=\comment + +{\catcode `\@=11 +% +% Auto-number footnotes. Otherwise like plain. +\gdef\footnote{% + \let\indent=\ptexindent + \let\noindent=\ptexnoindent + \global\advance\footnoteno by \@ne + \edef\thisfootno{$^{\the\footnoteno}$}% + % + % In case the footnote comes at the end of a sentence, preserve the + % extra spacing after we do the footnote number. + \let\@sf\empty + \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi + % + % Remove inadvertent blank space before typesetting the footnote number. + \unskip + \thisfootno\@sf + \dofootnote +}% + +% Don't bother with the trickery in plain.tex to not require the +% footnote text as a parameter. Our footnotes don't need to be so general. +% +% Oh yes, they do; otherwise, @ifset (and anything else that uses +% \parseargline) fails inside footnotes because the tokens are fixed when +% the footnote is read. --karl, 16nov96. +% +\gdef\dofootnote{% + \insert\footins\bgroup + % We want to typeset this text as a normal paragraph, even if the + % footnote reference occurs in (for example) a display environment. + % So reset some parameters. + \hsize=\pagewidth + \interlinepenalty\interfootnotelinepenalty + \splittopskip\ht\strutbox % top baseline for broken footnotes + \splitmaxdepth\dp\strutbox + \floatingpenalty\@MM + \leftskip\z@skip + \rightskip\z@skip + \spaceskip\z@skip + \xspaceskip\z@skip + \parindent\defaultparindent + % + \smallfonts \rm + % + % Because we use hanging indentation in footnotes, a @noindent appears + % to exdent this text, so make it be a no-op. makeinfo does not use + % hanging indentation so @noindent can still be needed within footnote + % text after an @example or the like (not that this is good style). + \let\noindent = \relax + % + % Hang the footnote text off the number. Use \everypar in case the + % footnote extends for more than one paragraph. + \everypar = {\hang}% + \textindent{\thisfootno}% + % + % Don't crash into the line above the footnote text. Since this + % expands into a box, it must come within the paragraph, lest it + % provide a place where TeX can split the footnote. + \footstrut + \futurelet\next\fo@t +} +}%end \catcode `\@=11 + +% In case a @footnote appears in a vbox, save the footnote text and create +% the real \insert just after the vbox finished. Otherwise, the insertion +% would be lost. +% Similarily, if a @footnote appears inside an alignment, save the footnote +% text to a box and make the \insert when a row of the table is finished. +% And the same can be done for other insert classes. --kasal, 16nov03. + +% Replace the \insert primitive by a cheating macro. +% Deeper inside, just make sure that the saved insertions are not spilled +% out prematurely. +% +\def\startsavinginserts{% + \ifx \insert\ptexinsert + \let\insert\saveinsert + \else + \let\checkinserts\relax + \fi +} + +% This \insert replacement works for both \insert\footins{foo} and +% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. +% +\def\saveinsert#1{% + \edef\next{\noexpand\savetobox \makeSAVEname#1}% + \afterassignment\next + % swallow the left brace + \let\temp = +} +\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} +\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} + +\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} + +\def\placesaveins#1{% + \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname + {\box#1}% +} + +% eat @SAVE -- beware, all of them have catcode \other: +{ + \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) + \gdef\gobblesave @SAVE{} +} + +% initialization: +\def\newsaveins #1{% + \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% + \next +} +\def\newsaveinsX #1{% + \csname newbox\endcsname #1% + \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts + \checksaveins #1}% +} + +% initialize: +\let\checkinserts\empty +\newsaveins\footins +\newsaveins\margin + + +% @image. We use the macros from epsf.tex to support this. +% If epsf.tex is not installed and @image is used, we complain. +% +% Check for and read epsf.tex up front. If we read it only at @image +% time, we might be inside a group, and then its definitions would get +% undone and the next image would fail. +\openin 1 = epsf.tex +\ifeof 1 \else + % Do not bother showing banner with epsf.tex v2.7k (available in + % doc/epsf.tex and on ctan). + \def\epsfannounce{\toks0 = }% + \input epsf.tex +\fi +\closein 1 +% +% We will only complain once about lack of epsf.tex. +\newif\ifwarnednoepsf +\newhelp\noepsfhelp{epsf.tex must be installed for images to + work. It is also included in the Texinfo distribution, or you can get + it from ftp://tug.org/tex/epsf.tex.} +% +\def\image#1{% + \ifx\epsfbox\undefined + \ifwarnednoepsf \else + \errhelp = \noepsfhelp + \errmessage{epsf.tex not found, images will be ignored}% + \global\warnednoepsftrue + \fi + \else + \imagexxx #1,,,,,\finish + \fi +} +% +% Arguments to @image: +% #1 is (mandatory) image filename; we tack on .eps extension. +% #2 is (optional) width, #3 is (optional) height. +% #4 is (ignored optional) html alt text. +% #5 is (ignored optional) extension. +% #6 is just the usual extra ignored arg for parsing this stuff. +\newif\ifimagevmode +\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup + \catcode`\^^M = 5 % in case we're inside an example + \normalturnoffactive % allow _ et al. in names + % If the image is by itself, center it. + \ifvmode + \imagevmodetrue + \nobreak\bigskip + % Usually we'll have text after the image which will insert + % \parskip glue, so insert it here too to equalize the space + % above and below. + \nobreak\vskip\parskip + \nobreak + \line\bgroup\hss + \fi + % + % Output the image. + \ifpdf + \dopdfimage{#1}{#2}{#3}% + \else + % \epsfbox itself resets \epsf?size at each figure. + \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi + \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi + \epsfbox{#1.eps}% + \fi + % + \ifimagevmode \hss \egroup \bigbreak \fi % space after the image +\endgroup} + + +% @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc. +% We don't actually implement floating yet, we just plop the float "here". +% But it seemed the best name for the future. +% +\envparseargdef\float{\dofloat #1,,,\finish} + +% #1 is the optional FLOATTYPE, the text label for this float, typically +% "Figure", "Table", "Example", etc. Can't contain commas. If omitted, +% this float will not be numbered and cannot be referred to. +% +% #2 is the optional xref label. Also must be present for the float to +% be referable. +% +% #3 is the optional positioning argument; for now, it is ignored. It +% will somehow specify the positions allowed to float to (here, top, bottom). +% +% We keep a separate counter for each FLOATTYPE, which we reset at each +% chapter-level command. +\let\resetallfloatnos=\empty +% +\def\dofloat#1,#2,#3,#4\finish{% + % don't lose footnotes inside @float. + \startsavinginserts + % + \vtop\bgroup + \def\floattype{#1}% + \def\floatlabel{#2}% + \def\floatloc{#3}% we do nothing with this yet. + % + \ifx\floattype\empty + \let\safefloattype=\empty + \else + {% + % the floattype might have accents or other special characters, + % but we need to use it in a control sequence name. + \indexnofonts + \turnoffactive + \xdef\safefloattype{\floattype}% + }% + \fi + % + % If label is given but no type, we handle that as the empty type. + \ifx\floatlabel\empty \else + % We want each FLOATTYPE to be numbered separately (Figure 1, + % Table 1, Figure 2, ...). (And if no label, no number.) + % + \expandafter\getfloatno\csname\safefloattype floatno\endcsname + \global\advance\floatno by 1 + % + {% + % This magic value for \thissection is output by \setref as the + % XREFLABEL-title value. \xrefX uses it to distinguish float + % labels (which have a completely different output format) from + % node and anchor labels. And \xrdef uses it to construct the + % lists of floats. + % + \edef\thissection{\floatmagic=\safefloattype}% + \setref{\floatlabel}{Yfloat}% + }% + \fi +} + +% we have these possibilities: +% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap +% @float Foo,lbl & no caption: Foo 1.1 +% @float ,lbl & Caption{Cap}: 1.1: Cap +% @float ,lbl & no caption: 1.1 +% @float & @caption{Cap}: Cap +% @float & no caption: +% +\def\Efloat{% + \let\printedsomething = \empty + % + \ifx\floattype\empty \else + \vskip.5\parskip % space above caption + % + % Print the float number preceded by the chapter-level number + % (empty in the case of unnumbered), as in "Figure 1.1". Although + % there are other styles of float numbering, we hardwire this one. + \def\floatident{\floattype\tie\chaplevelprefix\the\floatno}% + \floatident + \let\printedsomething = t% + % + % Write the text that goes in the list of floats to the aux file + % as \floatlabel-lof. Besides the float ident, we include the + % short caption if specified, else the full caption if specified, + % else nothing. + {% + \atdummies \turnoffactive \otherbackslash + \immediate\write\auxfile{@xrdef{\floatlabel-lof}{% + \floatident + \ifx\thisshortcaption\empty + \ifx\thiscaption\empty \else + : \thiscaption + \fi + \else + : \thisshortcaption + \fi + }}% + }% + \fi % end have xref label for this float + % + \ifx\thiscaption\empty \else + \ifx\printedsomething\empty + \vskip.5\parskip % space above caption + \else + :\space % had a number, so print a colon before the caption. + \fi + % + % Print caption text. + \thiscaption + \let\printedsomething = t% + \fi + % + % Space below caption, if we printed anything. + \ifx\printedsomething\empty \else \vskip\parskip \fi + \egroup % end of \vtop + \checkinserts +} + +\def\caption#1{\checkenv\float \def\thiscaption{#1}} +\def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}} +\let\thiscaption=\empty +\let\thisshortcaption=\empty + +% The parameter is the control sequence identifying the counter we are +% going to use. Create it if it doesn't exist and assign it to \floatno. +\def\getfloatno#1{% + \ifx#1\relax + % Haven't seen this figure type before. + \csname newcount\endcsname #1% + % + % Remember to reset this floatno at the next chap. + \expandafter\gdef\expandafter\resetallfloatnos + \expandafter{\resetallfloatnos #1=0 }% + \fi + \let\floatno#1% +} + +% \setref calls this to get the XREFLABEL-snt value. We want an @xref +% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we +% first read the @float command. +% +\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% + +% Magic string used for the XREFLABEL-title value, so \xrefX can +% distinguish floats from other xref types. +\def\floatmagic{!!float!!} + +% #1 is the control sequence we are passed; we expand into a conditional +% which is true if #1 represents a float ref. That is, the magic +% \thissection value which we \setref above. +% +\def\iffloat#1{\expandafter\doiffloat#1==\finish} +% +% #1 is (maybe) the \floatmagic string. If so, #2 will be the +% (safe) float type for this float. We set \iffloattype to #2. +% +\def\doiffloat#1=#2=#3\finish{% + \def\temp{#1}% + \def\iffloattype{#2}% + \ifx\temp\floatmagic +} + +% @listoffloats FLOATTYPE - print a list of floats like a table of contents. +% +\parseargdef\listoffloats{% + \def\floattype{#1}% floattype + {% + % the floattype might have accents or other special characters, + % but we need to use it in a control sequence name. + \indexnofonts + \turnoffactive + \xdef\safefloattype{\floattype}% + }% + % + % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. + \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax + \ifhavexrefs + % if the user said @listoffloats foo but never @float foo. + \message{\linenumber No `\safefloattype' floats to list.}% + \fi + \else + \begingroup + \leftskip=\tocindent % indent these entries like a toc + \let\do=\listoffloatsdo + \csname floatlist\safefloattype\endcsname + \endgroup + \fi +} + +% This is called on each entry in a list of floats. We're passed the +% xref label, in the form LABEL-title, which is how we save it in the +% aux file. We strip off the -title and look up \XRLABEL-lof, which +% has the text we're supposed to typeset here. +% +% Figures without xref labels will not be included in the list (since +% they won't appear in the aux file). +% +\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} +\def\listoffloatsdoentry#1-title\finish{% + % use the same \entry we use for the TOC. + \entry{\csname XR#1-lof\endcsname}{\csname XR#1-pg\endcsname}% +} + +\message{localization,} +% and i18n. + +% @documentlanguage is usually given very early, just after +% @setfilename. If done too late, it may not override everything +% properly. Single argument is the language abbreviation. +% It would be nice if we could set up a hyphenation file here. +% +\parseargdef\documentlanguage{% + \tex % read txi-??.tex file in plain TeX. + % Read the file if it exists. + \openin 1 txi-#1.tex + \ifeof 1 + \errhelp = \nolanghelp + \errmessage{Cannot read language file txi-#1.tex}% + \else + \input txi-#1.tex + \fi + \closein 1 + \endgroup +} +\newhelp\nolanghelp{The given language definition file cannot be found or +is empty. Maybe you need to install it? In the current directory +should work if nowhere else does.} + + +% @documentencoding should change something in TeX eventually, most +% likely, but for now just recognize it. +\let\documentencoding = \comment + + +% Page size parameters. +% +\newdimen\defaultparindent \defaultparindent = 15pt + +\chapheadingskip = 15pt plus 4pt minus 2pt +\secheadingskip = 12pt plus 3pt minus 2pt +\subsecheadingskip = 9pt plus 2pt minus 2pt + +% Prevent underfull vbox error messages. +\vbadness = 10000 + +% Don't be so finicky about underfull hboxes, either. +\hbadness = 2000 + +% Following George Bush, just get rid of widows and orphans. +\widowpenalty=10000 +\clubpenalty=10000 + +% Use TeX 3.0's \emergencystretch to help line breaking, but if we're +% using an old version of TeX, don't do anything. We want the amount of +% stretch added to depend on the line length, hence the dependence on +% \hsize. We call this whenever the paper size is set. +% +\def\setemergencystretch{% + \ifx\emergencystretch\thisisundefined + % Allow us to assign to \emergencystretch anyway. + \def\emergencystretch{\dimen0}% + \else + \emergencystretch = .15\hsize + \fi +} + +% Parameters in order: 1) textheight; 2) textwidth; 3) voffset; +% 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8) +% physical page width. +% +% We also call \setleading{\textleading}, so the caller should define +% \textleading. The caller should also set \parskip. +% +\def\internalpagesizes#1#2#3#4#5#6#7#8{% + \voffset = #3\relax + \topskip = #6\relax + \splittopskip = \topskip + % + \vsize = #1\relax + \advance\vsize by \topskip + \outervsize = \vsize + \advance\outervsize by 2\topandbottommargin + \pageheight = \vsize + % + \hsize = #2\relax + \outerhsize = \hsize + \advance\outerhsize by 0.5in + \pagewidth = \hsize + % + \normaloffset = #4\relax + \bindingoffset = #5\relax + % + \ifpdf + \pdfpageheight #7\relax + \pdfpagewidth #8\relax + \fi + % + \setleading{\textleading} + % + \parindent = \defaultparindent + \setemergencystretch +} + +% @letterpaper (the default). +\def\letterpaper{{\globaldefs = 1 + \parskip = 3pt plus 2pt minus 1pt + \textleading = 13.2pt + % + % If page is nothing but text, make it come out even. + \internalpagesizes{46\baselineskip}{6in}% + {\voffset}{.25in}% + {\bindingoffset}{36pt}% + {11in}{8.5in}% +}} + +% Use @smallbook to reset parameters for 7x9.5 (or so) format. +\def\smallbook{{\globaldefs = 1 + \parskip = 2pt plus 1pt + \textleading = 12pt + % + \internalpagesizes{7.5in}{5in}% + {\voffset}{.25in}% + {\bindingoffset}{16pt}% + {9.25in}{7in}% + % + \lispnarrowing = 0.3in + \tolerance = 700 + \hfuzz = 1pt + \contentsrightmargin = 0pt + \defbodyindent = .5cm +}} + +% Use @afourpaper to print on European A4 paper. +\def\afourpaper{{\globaldefs = 1 + \parskip = 3pt plus 2pt minus 1pt + \textleading = 13.2pt + % + % Double-side printing via postscript on Laserjet 4050 + % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. + % To change the settings for a different printer or situation, adjust + % \normaloffset until the front-side and back-side texts align. Then + % do the same for \bindingoffset. You can set these for testing in + % your texinfo source file like this: + % @tex + % \global\normaloffset = -6mm + % \global\bindingoffset = 10mm + % @end tex + \internalpagesizes{51\baselineskip}{160mm} + {\voffset}{\hoffset}% + {\bindingoffset}{44pt}% + {297mm}{210mm}% + % + \tolerance = 700 + \hfuzz = 1pt + \contentsrightmargin = 0pt + \defbodyindent = 5mm +}} + +% Use @afivepaper to print on European A5 paper. +% From romildo@urano.iceb.ufop.br, 2 July 2000. +% He also recommends making @example and @lisp be small. +\def\afivepaper{{\globaldefs = 1 + \parskip = 2pt plus 1pt minus 0.1pt + \textleading = 12.5pt + % + \internalpagesizes{160mm}{120mm}% + {\voffset}{\hoffset}% + {\bindingoffset}{8pt}% + {210mm}{148mm}% + % + \lispnarrowing = 0.2in + \tolerance = 800 + \hfuzz = 1.2pt + \contentsrightmargin = 0pt + \defbodyindent = 2mm + \tableindent = 12mm +}} + +% A specific text layout, 24x15cm overall, intended for A4 paper. +\def\afourlatex{{\globaldefs = 1 + \afourpaper + \internalpagesizes{237mm}{150mm}% + {\voffset}{4.6mm}% + {\bindingoffset}{7mm}% + {297mm}{210mm}% + % + % Must explicitly reset to 0 because we call \afourpaper. + \globaldefs = 0 +}} + +% Use @afourwide to print on A4 paper in landscape format. +\def\afourwide{{\globaldefs = 1 + \afourpaper + \internalpagesizes{241mm}{165mm}% + {\voffset}{-2.95mm}% + {\bindingoffset}{7mm}% + {297mm}{210mm}% + \globaldefs = 0 +}} + +% @pagesizes TEXTHEIGHT[,TEXTWIDTH] +% Perhaps we should allow setting the margins, \topskip, \parskip, +% and/or leading, also. Or perhaps we should compute them somehow. +% +\parseargdef\pagesizes{\pagesizesyyy #1,,\finish} +\def\pagesizesyyy#1,#2,#3\finish{{% + \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi + \globaldefs = 1 + % + \parskip = 3pt plus 2pt minus 1pt + \setleading{\textleading}% + % + \dimen0 = #1 + \advance\dimen0 by \voffset + % + \dimen2 = \hsize + \advance\dimen2 by \normaloffset + % + \internalpagesizes{#1}{\hsize}% + {\voffset}{\normaloffset}% + {\bindingoffset}{44pt}% + {\dimen0}{\dimen2}% +}} + +% Set default to letter. +% +\letterpaper + + +\message{and turning on texinfo input format.} + +% Define macros to output various characters with catcode for normal text. +\catcode`\"=\other +\catcode`\~=\other +\catcode`\^=\other +\catcode`\_=\other +\catcode`\|=\other +\catcode`\<=\other +\catcode`\>=\other +\catcode`\+=\other +\catcode`\$=\other +\def\normaldoublequote{"} +\def\normaltilde{~} +\def\normalcaret{^} +\def\normalunderscore{_} +\def\normalverticalbar{|} +\def\normalless{<} +\def\normalgreater{>} +\def\normalplus{+} +\def\normaldollar{$}%$ font-lock fix + +% This macro is used to make a character print one way in \tt +% (where it can probably be output as-is), and another way in other fonts, +% where something hairier probably needs to be done. +% +% #1 is what to print if we are indeed using \tt; #2 is what to print +% otherwise. Since all the Computer Modern typewriter fonts have zero +% interword stretch (and shrink), and it is reasonable to expect all +% typewriter fonts to have this, we can check that font parameter. +% +\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} + +% Same as above, but check for italic font. Actually this also catches +% non-italic slanted fonts since it is impossible to distinguish them from +% italic fonts. But since this is only used by $ and it uses \sl anyway +% this is not a problem. +\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} + +% Turn off all special characters except @ +% (and those which the user can use as if they were ordinary). +% Most of these we simply print from the \tt font, but for some, we can +% use math or other variants that look better in normal text. + +\catcode`\"=\active +\def\activedoublequote{{\tt\char34}} +\let"=\activedoublequote +\catcode`\~=\active +\def~{{\tt\char126}} +\chardef\hat=`\^ +\catcode`\^=\active +\def^{{\tt \hat}} + +\catcode`\_=\active +\def_{\ifusingtt\normalunderscore\_} +% Subroutine for the previous macro. +\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } + +\catcode`\|=\active +\def|{{\tt\char124}} +\chardef \less=`\< +\catcode`\<=\active +\def<{{\tt \less}} +\chardef \gtr=`\> +\catcode`\>=\active +\def>{{\tt \gtr}} +\catcode`\+=\active +\def+{{\tt \char 43}} +\catcode`\$=\active +\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix + +% If a .fmt file is being used, characters that might appear in a file +% name cannot be active until we have parsed the command line. +% So turn them off again, and have \everyjob (or @setfilename) turn them on. +% \otherifyactive is called near the end of this file. +\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} + +\catcode`\@=0 + +% \backslashcurfont outputs one backslash character in current font, +% as in \char`\\. +\global\chardef\backslashcurfont=`\\ +\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work + +% \rawbackslash defines an active \ to do \backslashcurfont. +% \otherbackslash defines an active \ to be a literal `\' character with +% catcode other. +{\catcode`\\=\active + @gdef@rawbackslash{@let\=@backslashcurfont} + @gdef@otherbackslash{@let\=@realbackslash} +} + +% \realbackslash is an actual character `\' with catcode other. +{\catcode`\\=\other @gdef@realbackslash{\}} + +% \normalbackslash outputs one backslash in fixed width font. +\def\normalbackslash{{\tt\backslashcurfont}} + +\catcode`\\=\active + +% Used sometimes to turn off (effectively) the active characters +% even after parsing them. +@def@turnoffactive{% + @let"=@normaldoublequote + @let\=@realbackslash + @let~=@normaltilde + @let^=@normalcaret + @let_=@normalunderscore + @let|=@normalverticalbar + @let<=@normalless + @let>=@normalgreater + @let+=@normalplus + @let$=@normaldollar %$ font-lock fix + @unsepspaces +} + +% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of +% the literal character `\'. (Thus, \ is not expandable when this is in +% effect.) +% +@def@normalturnoffactive{@turnoffactive @let\=@normalbackslash} + +% Make _ and + \other characters, temporarily. +% This is canceled by @fixbackslash. +@otherifyactive + +% If a .fmt file is being used, we don't want the `\input texinfo' to show up. +% That is what \eatinput is for; after that, the `\' should revert to printing +% a backslash. +% +@gdef@eatinput input texinfo{@fixbackslash} +@global@let\ = @eatinput + +% On the other hand, perhaps the file did not have a `\input texinfo'. Then +% the first `\{ in the file would cause an error. This macro tries to fix +% that, assuming it is called before the first `\' could plausibly occur. +% Also back turn on active characters that might appear in the input +% file name, in case not using a pre-dumped format. +% +@gdef@fixbackslash{% + @ifx\@eatinput @let\ = @normalbackslash @fi + @catcode`+=@active + @catcode`@_=@active +} + +% Say @foo, not \foo, in error messages. +@escapechar = `@@ + +% These look ok in all fonts, so just make them not special. +@catcode`@& = @other +@catcode`@# = @other +@catcode`@% = @other + + +@c Local variables: +@c eval: (add-hook 'write-file-hooks 'time-stamp) +@c page-delimiter: "^\\\\message" +@c time-stamp-start: "def\\\\texinfoversion{" +@c time-stamp-format: "%:y-%02m-%02d.%02H" +@c time-stamp-end: "}" +@c End: + +@c vim:sw=2: + +@ignore + arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 +@end ignore diff --git a/Build/source/utils/texi2html/doc/version.texi b/Build/source/utils/texi2html/doc/version.texi new file mode 100644 index 00000000000..103d48daaa0 --- /dev/null +++ b/Build/source/utils/texi2html/doc/version.texi @@ -0,0 +1,4 @@ +@set UPDATED 1 February 2005 +@set UPDATED-MONTH February 2005 +@set EDITION 1.76 +@set VERSION 1.76 |