diff options
131 files changed, 0 insertions, 55540 deletions
diff --git a/Build/source/utils/README b/Build/source/utils/README index 9b9f3313559..2b4f1057d78 100644 --- a/Build/source/utils/README +++ b/Build/source/utils/README @@ -31,9 +31,6 @@ psutils p17 - ok 25nov06 t1utils 1.34 - checked 2mar08 http://www.lcdf.org/~eddietwo/type/ -texi2html 1.76 - ok 25nov06 - https://texi2html.cvshome.org/servlets/ProjectDocumentList - texinfo 4.8 - ok 25nov06 vlna - only for Windows diff --git a/Build/source/utils/texi2html/AUTHORS b/Build/source/utils/texi2html/AUTHORS deleted file mode 100644 index 1703eca32bb..00000000000 --- a/Build/source/utils/texi2html/AUTHORS +++ /dev/null @@ -1,5 +0,0 @@ -Lionel Cons, Karl Berry, Olaf Bachmann, Karl-Heinz Marbaise (texi2html -manual) and many others. - -Images in the images directory come from the Singular project: -http://www.singular.uni-kl.de/ diff --git a/Build/source/utils/texi2html/COPYING b/Build/source/utils/texi2html/COPYING deleted file mode 100644 index d60c31a97a5..00000000000 --- a/Build/source/utils/texi2html/COPYING +++ /dev/null @@ -1,340 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - 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 of the License, 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 - - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. diff --git a/Build/source/utils/texi2html/ChangeLog b/Build/source/utils/texi2html/ChangeLog deleted file mode 100644 index 4aa8056761d..00000000000 --- a/Build/source/utils/texi2html/ChangeLog +++ /dev/null @@ -1,2188 +0,0 @@ -2008-02-21 Peter Breitenlohner <peb@mppmu.mpg.de> - - * configure.ac: --enable-muliplatform modifies libdir. - -2007-01-14 Karl Berry <karl@tug.org> - - * texi2html.pl: use /usr/bin/env perl for TL. - -2005-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: don't use exists for reference in an array, for - old perl. Report from Sven de Vries. - * T2h_i18n.pm: remove useless use that prevented to run on IRIX. - Report from ezra peisach. - * Tests/*: remove some $Id: ChangeLog,v 1.179 2005/02/04 00:14:39 pertusus Exp $ rcs tags - -2005-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: require perl 5.00405 for File::Spec (report from - Ezra peisach). - -2005-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: don't use open with three args, use binmode (for - old perl, reported by Sven de Vries). - * doc/Makefile.am: rebuild the manual based on the sources, not - on the script, as it is remade by ./configure. Use the rebuild - of the manual as a check target (ideas from Derek). - * Tests/*: test for results with USE_UNICODE set to 0. - -2005-02-01 Derek Price <derek@ximbiot.com> - - * configure.ac: Revert most of the PERL change. - -2005-02-01 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, examples/chm.init: remove our keywords for old - perl (reported by Sven de Vries). - -2005-02-01 Derek Price <derek@ximbiot.com> - - * Makefile.am (EXTRA_DIST): Include missing-texi2html. - -2005-02-01 Derek Price <derek@ximbiot.com> - - * NEWS: Note that Perl is no longer required to build. - * configure.ac: Don't search for texinfo programs handled by Automake. - Declare PERL a precious var. Exit when not found and not set. Warn - when set to a relative path. - * missing-texi2html, doc/texi2html.html: New files. - * doc/.cvsignore: Add more intermediate files. - * doc/Makefile.am: Remove targets autogenerated by Automake. - (EXTRA_DIST): Distribute texi2html.html. - (texi2html.html): Call texi2html via missing-texi2html. - -2005-01-31 Derek Price <derek@ximbiot.com> - - * configure.in, NEWS: Update for development. - * configure.in: Rename to... - * configure.ac: ...this, to match current Autoconf standards. - -2005-01-31 Derek Price <derek@ximbiot.com> - - * configure.in, NEWS: Update for the 1.74 release. - -2005-01-16 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: more robust handling of deffn lines. - The argument may be in bracket, therefore there is no difference - beteen arg and other item specification for def like commands. - * Tests: test for more deffn lines, and for @-commands in floats. - * doc/texi2html.texi: update. - -2005-01-16 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: close quotes within html elements. Apply commands - to @item lines in table after leading and trailing spaces removal. - * Tests: regenerate. - -2005-01-06 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: handle explicitely formats that don't - trigger paragraph opening. Handle all commands even those that aren't - used. End lines more correctly. - -2004-12-29 Derek Price <derek@ximbiot.com> - - * NEWS: Date the 1.72 release. - -2004-12-29 Derek Price <derek@ximbiot.com> - - * configure.in: Update for 1.72 release. - * Makefile.in, aclocal.m4, configure, Tests/Makefile.in, - doc/Makefile.in, doc/stamp-vti, doc/version.texi: Regenerated. - -2004-12-29 Derek Price <derek@ximbiot.com> - - * README: Remove obsolete note about using shar for binary attachments - to mailing lists. - -2004-12-29 Derek Price <derek@ximbiot.com> - - * config.guess, config.sub: New files from Automake. - -2004-12-13 Patrice Dumas <dumas@centre-cired.fr> - - * INTRODUCTION, README: update with dev mailing list. Advertise the - manual as being rather complete. - * Makefile.am,Makefile.in: build in . before doc, as texi2html is - needed to rebuild the doc. - -2004-12-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init,examples/roff.init,examples/html32.init, - examples/inlinestyle.init,NEWS: add support for @euro, @sansserif. - * Tests: test for @euro, @sansserif, deff arguments with braces - appearing within the argument (and not at the beginning). Sync. - -2004-12-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: internal targets and targets of - cross refs are valid as XML identifiers. This is compatible with the - updated specification presented in the texinfo manual in the node - HTML Xref. - * doc,Tests: sync. - -2004-11-22 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: handle right deff arguments with braces appearing - within the argument (and not at the beginning). - -2004-10-08 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: add a mail address to the --help screen (idea from - Karl Berry). - -2004-10-06 Patrice Dumas <dumas@centre-cired.fr> - - * configure.in: add the lines asked for by Thomas Esser for addition - to teTeX. - * Makefile.in...: regenerate with automake 1.9.1. - -2004-10-06 Patrice Dumas <dumas@centre-cired.fr> - - * Makefile.am: use $(PERL) and $(srcdir) in manage_i18n.pl rule - (idea of Karl Berry). - -2004-08-13 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: Cross refs are done according to the - specification presented in the texinfo manual in the node HTML Xref. - The "external source of information" is also used although it isn't - formally part of the specification. - Handle novalidate better. - * Tests: sync. - -2004-08-07 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: handle @slanted and @abbr. - -2004-06-27 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, T2h_i18n.pm, manage_i18n.pl: Re enable compatibility - with perl older that 5.6, by changing most of our to use vars, and - some other to my. - -2004-06-13 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: split close_stack in 2, one for the last pass the other - for the previous passes. - Simplification of the code handling paragraph closing. - More macros don't begin paragraphs. - Pass opened commands through @tab and @item. - Every @def* is considered to have arguments. - continue the @def* line if there is a @ at the end line. - * texi2html.pl, texi2html.init: Handle @float, @listoffloats, - @caption, @shortcaption, - @ordf, @ordm, @registeredsymbol, @deftypecv, @LaTeX, @indicateurl, - @docbook, @ifdocbook, @ifnotdocbook, - @comma, @headitem, @quotation second arg, @acronym second arg. - @url is now a synonym for @uref. - * doc/texi2html.texi: bring up-to-date. - -2004-04-28 Patrice Dumas <dumas@centre-cired.fr> - - * T2h_i18n.pl, texi2html.pl: pass the state to the internationalized - strings if needed. - -2004-04-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: generate unformatted text with - text protected and %unformatted_text_* hashs used. - use unformatted text in <title> element. - put preparation of special styles in texi2html.init. - copying_comment formats the copying comment. - -2004-04-26 Patrice Dumas <dumas@centre-cired.fr> - - * example/book.init: stick to the same style for manual not split at - node. - * texi2html.pl: handle better @today even in non english cases. - don't use (encoding) in open, but set it in binmode (perl seems - unhappy otherwise ?). - * texi2html.init: don't enclose paragraph in <p> when it is the first - paragraph of enumerate or itemize, as the <li> is allready something - like a begining of paragraph. - -2004-03-25 Derek Price <derek@ximbiot.com> - - * .cvsignore: Ignore texi2html.spec. - -2004-03-25 Derek Price <derek@ximbiot.com> - - * NEWS: Add section for 1.72. - * configure.in: Update to dev version 1.71. Generate texi2html.spec. - * texi2html.spec: Move this file... - * texi2html.spec.in: ...here and replace some strings with text - generated by configure. - * Makefile.in, configure, doc/stamp-vti, doc/version.texi: Regenerated. - -2004-03-24 Patrice Dumas <dumas@centre-cired.fr> - - * NEWS: fill 1.70 section. - * configure.in, texi2html.spec: update version. - * Makefile.in: regenerate, now it doesn't want config.guess. - -2004-03-23 Patrice Dumas <dumas@centre-cired.fr> - - * Makefile.am, texi2html.spec: add a spec file usefull to build - a rpm. - * doc/Makefile.am: install texi2html.html in $(datadir)/texinfo/html - as discussed on the texinfo/automake mailing lists. - -2004-03-22 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: get language files before testing for language hash. - * Makefile.am: add a rule for translations.pl. - -2004-03-20 Derek Price <derek@ximbiot.com> - - * NEWS: Add section for 1.70 release. - * configure.in: Update for 1.69 dev version. - * configure: Regenerated. - -2004-03-20 Derek Price <derek@ximbiot.com> - - * NEWS: Add date to 1.68 release. - -2004-03-20 Derek Price <derek@ximbiot.com> - - * NEWS: Update Automake & Autoconf versions in developer info section. - -2004-03-20 Derek Price <derek@ximbiot.com> - - * .cvsignore: Ignore the distribution archives. - * Makefile.am (texi2html_SOURCES): Add and use to avoid having to - maintain two lists of files. - * configure.in: Update to version 1.68 for release. - * Makefile.in, configure: Regenerated. - * doc/stamp-vti, doc/version.texi: Regenerated. - -2004-02-26 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: change $DOCUMENTDESCRIPTION to - $DOCUMENT_DESCRIPTION for consistency. - if $ENCODING is '' don't put it in the headers. - add a new entry to $Texi2HTML::THISDOC: 'title_texi', the title - with texinfo @-commands. - * examples/chm.init: don't convert to utf8 in the html files - generated (unless the encoding is really utf8), but produce - utf8 in hhc, hhk and hhp files whatever the encoding is. - * doc/texi2html.texi: update. - -2004-02-23 Patrice Dumas <dumas@centre-cired.fr> - - * Makefile.am: ask for a version above 1.7 for automake. - * Makefile.in...: regenerate with automake 1.8.2 autoconf 2.59. - * texi2tml.pl, texi2html.init, examples/chm.init: add a new variable - $DOCUMENTDESCRIPTION. If it is undef, @documentdescription is used - or the long title. If it is set but empty no description <meta> element - is used, if it isn't empty, the value is used in the description - <meta> element. - -2004-02-11 Patrice Dumas <dumas@centre-cired.fr> - - * Makefile.am: add T2h_i18n.pm texi2html.init MySimple.pm and l2h.init - to the distribution. - -2004-02-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: use the manual name (file basename) as default output - directory when split. - * NEWS, Tests/test.sh: update. - -2004-02-11 Derek Price <derek@ximbiot.com> - - * Tests/GermanNodeTest/.cvsignore, Tests/index_table/.cvsignore, - Tests/macros/.cvsignore, Tests/sectionning/.cvsignore, - Tests/ccvs/.cvsignore, Tests/nodes_texinfo/.cvsignore, - Tests/texi2html/.cvsignore, Tests/texinfo/.cvsignore, - Tests/viper/.cvsignore, Tests/viper_monolithic/.cvsignore, - Tests/xemacs/.cvsignore, Tests/xemacs_frame/.cvsignore, - Tests/formatting/.cvsignore: New files to suppress warnings about files - created by the test scripts. - -2004-02-11 Derek Price <derek@ximbiot.com> - - * Makefile.am (bin_PROGRAMS): Move... - (bin_SCRIPTS): ...here. - (texi2html_SOURCES): Remove unused variable. - -2004-02-10 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: put the code related with cross references in the - main namespace. - * Makefile.am: remove T2h_unicode.pm, T2h_nounicode.pm. - -2004-02-10 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: put cross manual reference and unicode related - functions in the main program (instead of T2h_unicode.pm, - T2h_nounicode.pm). - Don't add no-... options when there are allready the options added. - * T2h_unicode.pm, T2h_nounicode.pm: remove. - -2004-02-07 Patrice Dumas <dumas@centre-cired.fr> - - * T2h_unicode.pm, T2h_nounicode.pm: make global variables lexical - variables. - * texi2html.init: output header if there is only one section. - * Tests/: more tests for the new cross references scheme. - * doc/: use a newer texinfo.tex. Be texi2dvi friendly. - * Tests/Makefile.am: comment out check-local, it isn't ready. - -2004-02-06 Derek Price <derek@ximbiot.com> - - * T2h_unicode.pm, T2h_nounicode.pm: Declare some otherwise undeclared - variables as global variables. - -2004-02-06 Derek Price <derek@ximbiot.com> - - * doc/Makefile.am (txt): New targets to convert .texinfo files into - text. - * doc/.cvsignore: Ignore texi2html.txt. - -2004-02-06 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, T2h_unicode.pm, T2h_nounicode.pm: - when called with --test, @today value is fixed. - Find the relative path leading back to the current directory from - the output directory, such that the path to the image files are right. - Use a ref on the Texi2HTML::Config hashes such that changing the - hash used is easy. This is used in T2h_unicode.pm and - T2h_nounicode.pm for expansion of nodes in external refs. - Add special styles early. - A new variable NEW_CROSSREF_STYLE. If true the new scheme for html - cross refs proposed onthe texinfo list is used for @ref. - * Tests/formatting/test_refs.texi, Tests/formatting/cross_refs.init: - new files used to test the new cross ref scheme. - -2004-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: call the $index_summary_file_* - function references for all the indices, even those not printed. - * examples/chm.init: enhancements based on the Peter Verhás - implementation (t2h.pl) and languages codes based on the docbook - xslt. - -2004-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: add $EXTENSION variable, holding - the extension for files. - Add $Texi2HTML::THISDOC{'file_base_name'} and - $Texi2HTML::THISDOC{'destination_directory'} such that it is possible - to construct file and directory names in init files. - Add $finish_out function reference called at the end of document - outputting. - Add $index_summary_file_begin and $index_summary_file_end to ease - special index files generation. - * examples/noheaders.init: perform better when split. - * examples/chm.init: new init file to generate chm files (after - compilation by a windows application, leads to windows help files). - After José Fonseca (jrfonseca at users dot berlios dot de) work on - an older texi2html. - * l2h.init: Set NO_SUBDIRS to 1, don't set html version. - -2004-01-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: reopen styles in preformatted environments. - When there is a complex format or a table or the like the opened - styles are kept such that they are reopened when there is a paragraph - or a preformatted within the format. - * T2h_unicode.pm: use the right code point for dotless i. - * Tests/*: add tests for formats imbricated in style command. - add tests for latin1 and utf8 encoded files. - add tests for ifset and ifclear in macros. - * Makefile.am: add the new source files and init files. - -2004-01-25 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, T2h_unicode.pm, T2h_nounicode.pm: - Handle encodings. - It is possible to customize what is outputted in string context, when - removing texinfo commands. - Handle @email and @image better in string context. - Use unicode instead of utf8 in variable names when it is really - unicode. - cross_manual_links is done in Texi2HTML::Config in T2h_unicode.pm - in case the perl version is above 5.8, in T2h_nounicode.pm otherwise. - add @NODE_FOOTER_BUTTONS for buttons at the footer of nodes. - Add two more function references, element_file_name and node_file_name - used to customize the file names. - Don't warn when the character is not a precomposed unicode character, - as it is possible to have totally valid character, not precomposed. - Use us-ascii as default charset encoding. - * examples/book.init: an init file based on the scriptbasic manuals - file which formats manuals like books (no menu but tables of - contents for the element under each element). - * examples/utf8.init: use utf8 in strings. - * doc/texi2html.texi: document the new elements of the interface. - - -2004-01-19 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, examples/*: New variables $DO_CONTENTS - and $DO_SCONTENTS, $OPEN_QUOTE_SYMBOL and $CLOSE_QUOTE_SYMBOL. - Use a hash for the files such that each element may be associated with - any file name and written down to that file. This should enable - customization of the file names. - print_Top_header and print_Top_footer are called from the main program. - Add Texi2HTML::THIS_ELEMENT holding the current element structure. - - * doc/texi2html.texi: document the new variables and the new interface - with a hash reference for style @-commands. - -2004-01-12 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: --- and `` are kept in first arg of - uref and email - -2004-01-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: parse arguments separated with , in - main program. - Use a new interface for style commands with a hash instead of a string. - The old interface is still available. - Give a type to the style_map commands (accent, style, simple or - special). - Normalise spaces for @url, @uref and @email. - Handle better ignored regions end (at end of file or before @). - Don't reinject @-commands after closing paragraphs. - Add a hash for commands if paragraphs should not be done in these - commands. - -2004-01-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: handle @flushleft and @flushright - like normal formats and do something special at the end of line - for @center. - Put the @-command name in the paragraph_style stack (not the align - attribute). - use a new function reference init_out instead of set_buttons_text - and set_body_text, called just before the outputting is done. - Handle a lower level element appearing before a higher level element. - * texi2html.pl, examples: call or prepare for calling of ascii_accents - instead of rewriting the function each time. - * examples/utf8.init: prepare for transcoding in utf8. - * Tests/sectionning/section_before_chapter.texi: test for sectionning - element before chapter. - -2003-12-16 Peter Pentchev <roam@ringlet.net> - - * texi2html.pl: don't use symbolic refs at all, instead eval the - code (for the style functions) or use a local glob for the filehandle. - -2003-12-15 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: add hashes for the ascii - representations of @-commands and a function for ascii accents. - Give style functions the style @-command stack. - New function duplicate_state to be used when special text is expanded - within a normal context. - substitute_line accepts a $state argument. - -2003-12-10 Patrice Dumas <dumas@centre-cired.fr> - - * INTRODUCTION, NEWS, README, TODO, texi2html.1.in, doc/TODO: bring - those files a bit more up-to-date and correct typos. - * doc/IDEA: removed, the content was obsolete or in TODO. - * texi2html.pl: add no-... options for the options needing it. - echo less options with --help. - -2003-12-10 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, TODO: add hashes for unicode encodings - of accented letter and characters. - A function cross_manual_links can expand node name according to the - proposal I made on the texinfo-pretest list (currently unused). - - * examples/utf8.init: add an init file for outputting of utf8 encoded - characters. - -2003-12-05 Derek Price <derek@ximbiot.com> - - * texi2html.pl: Suggest `--help' rather than `-help' in error messages. - -2003-12-05 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: @sp without arg is considered to be @sp 1 - * Tests/formatting/formatting.texi: add test for @sp - * TODO: begin a list of UTF8 characters corresponding with accented - texinfo letters, in order to implement cross manual references scheme - described on the bug-texinfo mailing list and maybe output utf8. - -2003-12-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: don't collect @copying lines in the first pass - but in the second. - Use the same mechanism to collect @copying, @documentdescription - and @titlepage lines. - -2003-12-01 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: new option -macro-expand which generates a file - with expanded macros and @include. - don't close environments until last pass, except for @verb, raw - environments and macro stuff. - * texi2html.init: use @emph instead of @i in strings. - -2003-11-25 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: format titlepage lines, resulting - text is put in $Texi2HTML::TITLEPAGE. Use a new function reference - $titlepage to finalize $Texi2HTML::TITLEPAGE. - titles, subtitles and authors are put in arrays in - $Texi2HTML::THISDOC{'titles'} and so on... - All the skipped commands are kept for the second pass. - Handle @noindent and @exdent like other skipped commands. A new - type of skipped commands 'whitespace' with newline skipped - and 'space' no newline skipped. - change name of functions to default_`function'. - - * examples/roff.init: add a roff formatter added. - -2003-11-20 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: Echoes error messages when loading - init files. - Keep spaces in menu entries and menu descriptions. - Clean menu entries code. - When handling menu entries, give the formatted node, the name and - the remaining of the line to the formatting functions. - In enumerate give the style of the enumerate, the item number and - a prepared number or letter to the formatting functions. - Don't keep the enumerate style in the text. - -2003-11-18 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: change protect_html to protect_text. - More arguments given to paragraph, preformatted region, list item, - table item formatting functions, usefull when the paragraph or - preformatted region is within a table or list to give more possibility - for use of the formatting command appearing with the table or - itemize command. - Handle better new lines. - new formatting function, normal_text, used to process ---, --, '' and - ``. - new formatting function, empty_line used to format an empty line, - leave the empty line as is by default. - 2 new formatting functions are used when the macro isn't handled - by the normal functions: unknown and unknown_style. - give the file name to the image. - - * doc/texi2html.texi, Tests/*: sync with code. - -2003-11-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: the format is applied by a customizable function. - More arguments (index name, entry) given to the index label - formatting function. - When menus are not expanded, don't keep @menu or @end menu. - * texi2html.init: warn when an accent is associated with a - wrong argument. Produce valid html entities only. - * texi2html.init, T2h_i18n.pm: Use @-commands in internationalized - strings, not html. - * i18n/fr, i18n/es, i18n/pt: use @-commands instead of html. - -2003-11-07 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: remove unusefull arguments to - functions formatting paragraphs. - -2003-11-06 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: the style is applied by a customizable function. - * examples/noheader.init: style with no headers. - -2003-11-05 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: don't add the leading command if it is a simple - command to all the paragraphs in itemize and add it before the - paragraph or preformatted section. - -2003-11-05 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: in itemize, apply the command to the - inside of the paragraph or preformatted section. - titlefont don't open paragraphs. - -2003-11-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: keep texi as is in @image and protect html characters. - accept @| as macro, but remove it. - cleaning of code for commands with texi kept as is - * doc/formatting.texi: add test of flushleft, flushright and center - -2003-11-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: -- and so on are kept as is in @image except - for alt text. Use alt text. File for image is really used, too. - handle better @inforef. - * doc/clean.texi: add formatting/clean.texi, a test for code - acceptable by makeinfo without error. - -2003-10-28 Patrice Dumas <dumas@centre-cired.fr> - - * doc/texi2html.texi: add informations about internationalization - -2003-10-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: if not split and there is a leading directory - specified with --out, create that directory. - If a directory creation fails, abort. - test the writability of the results directory, even when it is - the current directory. - -2003-10-28 Patrice Dumas <dumas@centre-cired.fr> - - * doc/: remove unneeded .texi files, now included in texi2html.texi. - * Makefile.am, doc/Makefile.am: include info file in distribution. - -2003-10-26 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: support for @verbatiminclude. When split use the - -output specification in every cases. - * texi2html.init: use `•' instead of `*' for node menu entries. - * Makefile.am: fixes for the inclusion of files in packages. - * doc/texi2html.texi: add the explanation of the default for all the - variables. Explain how the strings are customized and how - internationalization works. - -2003-10-19 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, examples/html32.init: don't expand - html automatically, only if it is in @EXPAND. Put html in @EXPAND. - USE_ISO is now in the default case, but false in html32.init. - new hash, %iso_symbols for USE_ISO symbols. Rewroted in the public - domain in texi2html.init. Use iso symbols in preformatted environment - too. - When removing texi @-commands with arguments (@table, @deffn...) are - better handled. Ignore content of @anchor, @footnote, @*ref when - removing texi. - * doc/texi2html.texi: merge content of doc/custpage.texi, - doc/custhtml.texi in doc/texi2html.texi. - * Tests/formatting/formatting.texi: test for all the constructs in - the @copying/@end copying section (to test remove_texi). - -2003-10-17 Derek Price <derek@ximbiot.com> - - * doc/stamp-vti, doc/version.texi: Regenerated. - -2003-10-17 Derek Price <derek@ximbiot.com> - - * texi2html.pl (do_text): Compile-once flag is okay as long as the - pattern portion (left side) of a s/// statement is free of change. - -2003-10-15 Patrice Dumas <derek@ximbiot.com> - - * doc/custhtml.texi, doc/custpage.texi: sync with current code - (no more $ADDRESS but $end_page, only 2 functions for references). - * texi2html.pl: -- in normal text is changed in - - ---, -- '' and `` are kept as is in @code, @kbd and so on. - -2003-10-14 Derek Price <derek@ximbiot.com> - - * doc/texi2html.texi: Use @code{} for Perl vars. @var{} is for user - supplied data to commands and function calls and the like. Fix EOL - indiscretion in the three index macros. - * doc/stamp-vti, doc/version.texi: Regenerated. - -2003-10-14 Derek Price <derek@ximbiot.com> - - * doc/custhtml.texi, doc/custpage.texi, doc/texi2html.texi: Misc - revisions to Pat's major revisions. Some global changes and reviewed - through section 4.3. Consolidate copyleft notice into a macro. - Consolidate variable and option references into macros which include - an index reference. Make use of appropriate macros from version.texi - rather than relying on manual updates. - * doc/stamp-vti, doc/version.texi: Regenerated. - -2003-10-14 Derek Price <derek@ximbiot.com> - - * doc/.cvsignore: Add texinfo.info-? files. - -2003-10-33 Patrice Dumas <dumas@centre-cired.fr> - - * Tests/formatting/formatting.texi: test for --- and `` in various - constructs. - -2003-09-23 Patrice Dumas <dumas@centre-cired.fr> - - * NEWS: More changes taken from the conversion of the singular - manual init file. - -2003-09-23 Patrice Dumas <dumas@centre-cired.fr> - - * NEWS: Note more changes. - * Tests/*: Test for novalidate. - -2003-09-22 Derek Price <derek@ximbiot.com> - - * NEWS: Reorganize. Note some more changes. - -2003-09-21 Patrice Dumas <dumas@centre-cired.fr> - - * Makefile.am: package i18n/en - * doc/testkb.texi doc/umalaut.texi: remove these test files, they are - now in Tests/formatting - -2003-09-21 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: source 'Config' file in the configuration directories - instead of texi2htmlrc and ~/.texi2htmlrc for the system wide and - user configuration. - * manage_i18n.pl: language files are the files appearing in the - i18n directory. Use 'en' for the file with english strings. - -2003-09-17 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: change 'about (this page)' to - 'about (help)' as this appears in the title= of the <a> element. - ignore @afourlatex, @afourwide, @firstparagraphindent, @exampleindent, - handle @definfoenclose, @kbdinputstyle, @novalidate, @centerchap (but - without centering), @documentdescription. - add -no-validate option. - -2003-09-15 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: add &$Texi2HTML::Config::one_section - for formatting of document with only one section. - find when an element is the first element on a page. - add &$Texi2HTML::Config::end_section, called when an element is - finished unless it is the end of a page and do less in print_section - Don't use $ADDRESS anymore. - Change &$Texi2HTML::Config::external_ref such that it is easier to - internationalize. - -2003-09-13 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: mark strings of buttons, about, - definitions and footers for internationalization. - new function reference $set_buttons_text used to generate the - button text hashes dynamically (for internationalization). - require all files in i18n/* for languages. - * i18n/fr: translate strings related with buttons, about, - definitions and footers in french. - -2003-09-12 Patrice Dumas <dumas@centre-cired.fr> - - * manage_i18n.pl: remove \ from strings when finding out strings - to translate. - * i18n/fr: translate strings related with references. - -2003-09-12 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: 0 is accepted as a value for - the reference arguments. - rewrite from scratch the functions handling references in .init - files to put them in the public domain. Avoid string concatenation - to ease internationalization. - -2003-09-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, T2h_i18n.pm, manage_i18n.pl, - configure.in: - The ideas come from Derek. - new script manage_i18n.pl used to manage translation files. - remove -i18n switch. - parse source files to extract strings to be translated. - complete these strings with the element of %$template_strings - in manage_i18n.pl and fill the i18n/template file with - these strings in the 'en' language hash. - With the 'all' arg given to manage_i18n.pl the template is - regenerated the language files are updated and merged in - translations.pl. translations.pl is pasted in texi2html.pl. - give arguments to the string to be translated: when something - like %{arg} appears in the string and { 'arg' => 'some string'} - is given as second argument, %{arg} is replaced by 'some string' - after retrieval of the translated string. - -2003-09-06 Patrice Dumas <dumas@centre-cired.fr> - - * images, AUTHORS: add images from the Singular project. - -2003-09-06 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, T2h_i18n.pm, texi2html.init: new handling of - languages in documents. - instead of using the hash reference $Texi2HTML::I18n::WORDS for - translation of words, call &Texi2HTML::I18n::get_string (more - precisely use &$I, a reference on the function). The strings - are the real english strings and not identifiers. - The date formatting depends on the language. - Use translations for months and not a months array. - Put translations in one file per language and not in T2h_i18n.pm. - Those files are in the i18n directory. They are to be concatenated - in the file translated.pl which is required or pasted in texi2html. - Add a switch -i18n for the specification of a management command - related with internationalization: if the command is merge, - the files in the i18n directory are concatenated into translated.pl; - if the command is update the files are updated with their own - informations and the list of valid strings appearing in T2h_i18n.pm, - invalid strings are obsoleted but kept. - * test.sh: add a test for internationalization. - -2003-09-05 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: detect @item on @itemize and table line to avoid - infinite recursion. - -2003-09-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: handle better @itemize and @table, - by appending the text appearing on the format command line. - Use %special_list_commands to inhibit calling the formatting command - on an item in a given format command. - if '-' is given to the -output option, output on STDOUT. - Find more format command mismatches, and handle better formats not - closed. - -2003-09-02 Patrice Dumas <dumas@centre-cired.fr> - - * Tests/macros/glossary.texi: test for nested macros definitions - -2003-08-29 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: support nested macro definitions. - -2003-08-29 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: hide m_cedilla. - new handling of definition commands, with a specification of the - definition line parsing. - get HTML attributes from hash values of %format_map and %style_map. - Simplify the handling of tables. The default is to use %format_map - or otherwise a user defined function, $table_list. - All the css commands are in %css_map. 'pre_style' in $complex_formats - is taken from %css_map. - handle @sp. - Remove $Texi2HTML::STOC_LINES (use $Texi2HTML::OVERVIEW), remove - $Texi2HTML::TOC (use $Texi2HTML::TOC_LINES), remove $T2H_TOP. - use references on arrays everywhere (instead of arrays) for - Texi2HTML::OVERVIEW and Texi2HTML::TOC_LINES. - Use OVERVIEW consistently. - use $docu_top when needed, instead of $docu_name.$docu_ext, which - is wrong if -o is used. - prepare index entries label text in main program. - rewrite from scratch most of the function in .init files to put - them in the public domain. - expand macros in macro arguments. - \ protects @end macro in macros body. This may be wrong. - ignore space and newline following a region opening command. - rename -css-file to -css-include. - Add 'This' to the hashes for buttons, icons and so on. - Add option -toc-links, create links from headings to toc entries - with 9 lines from - Martin Herbert Dietze <martin@the-little-red-haired-girl.org> - macros are expanded in macro arguments, taking care of context (in - @verbatim, @ignore, @comment...). - Don't remove empty lines from output. - Reenable handling of -idx-sum. - * Tests/*: add tests for macros expansion in macro arguments, and - for command line option style which are not default. - * examples/*: use code in the public domain. - In makeinfo.init use makeinfo style for index formatting. - -2003-08-29 Derek Price <derek@ximbiot.com> - - * MySimple.pm (helpOptions): Prepend a second `-' before options. - -2003-08-29 Derek Price <derek@ximbiot.com> - - * doc/stamp-vti, doc/version.texi: Regenerated. - -2003-08-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, texi2html.pl: don't always open paragraphs - in tables and such, only when needed. - option -output obsoletes -out_file and -subdir. It is the - same than -out_file when output is not split, and the same than - -subdir when it is split. - Handle empty indices. - Handle better @-commands with letters mixed with other characters. - Be more carefull about NUMBER_SECTION, such that nothing is numbered - when it is false. - Support for @documentencoding. - * Tests/*: add tests from the doc directory in formatting. - * doc/*: add a section about installation and make the manual more - makeinfo friendly. - -2003-08-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init, Tests/test.sh, Tests/ccvs: don't expand info - section in default settings. Expand info sections for the xemacs - manual, the viper manual and the texinfo manual. - The cvs manual is updated. - -2003-08-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: pass line numbers to all the - functions echoing error messages and use these line numbers - in error messages. Some error messages rewrited. - Correct tag for sectionning commands in case raisesection or - lowersection were used. - -P option prepends before the document directory, and use an - array, @Texi2HTML::Config::PREPEND_DIRS. - Add options --ifhtml, --ifinfo and so on (similar with makeinfo - options). It is also possible not to expand html now. - Add entries for xml. - when a region is expanded the corresponding ifnot region isn't. - Add support for -css-file option which does the same than in - makeinfo (parse the file, and echo the @import part before the - texi2html css rules, the rules part after the texi2html css rules). - If split at node and NODE_FILES is true but USE_NODES is not, - the correct file nema is used for nodes not associated with - sections and a redirection file is made. - ignore spaces or not for def*index, pagesizes, syn*index properly. - bugfixes: line beginning by any command not ignored begins a - paragraph, don't ignore text before macro with unknown character). - no empty style in pass_text. - misc element have always a navigation printed at foot. - * Tests/*: add singular test, test for css files, test all html - formatting and macro within another macro. - -2003-08-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: don't remove empty line in the - second pass, pass_structure. - collect line numbers/file name/macro expanding text in pass_texi. - pass these informations down to pass_structure. - take care of arguments not provided in some @-commands (no file - in @image, no node in @inforef and so on). - remove unneeded code in macro text expansion. - remove leading spaces and newlines in macros arguments. - add support for @\ (ignore). - put code extracted from texi2html.pl and placed in texi2html.init, - covered by the GPL back to texi2html.pl. - Document the API between texi2html.pl and texi2html.init, i.e. - document how the formatting functions called by texi2html.pl - should behave. - add print_section_header to format section headers. - -2003-08-01 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: add option '-noexpand' as a synonym for '-no-expand' - like Derek suggested. - -2003-07-31 Derek Price <derek@ximbiot.com> - - * texi2html.pl (T2H_OPTIONS->{'no-expand'}): Remove useless linkage. - -2003-07-31 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: A new option -no-expand which does - the reverse of -expand. - Text before the first @node or sectionning command is - outputted as part of the first section. A new option enables the - reverse: if -ignore-preamble-text is set (variable - $IGNORE_PREAMBLE_TEXT) this text is ignored. - Handle macros appearing in that part of texinfo files (@direntry - and @dircategory ignored, @shorttitlepage handled). - Ignore everything at the beginning of the file until \input or an - @-command preceded by optionnal spaces. - better handling of @titlefont. - -2003-07-29 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: if split, top and misc elements (about, - toc, ...) always have a bottom navigation panel. - If there is no @top and the @node Top isn't associated with any section - it is considered to be the top element. - The top name is Top when there is no name nor title (previously was - "Untitled Document"). - bugfix: top element handled as top even when it is the last element. - -2003-07-22 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, examples/*: add support for @cartouche - and @titlefont. - preliminary support for css. All the element needing style have a - class attribute. The commands which are associated with a class by - makeinfo have that class too. The styles are in the <head> in <style>. - A new init file, inlinestyle.init, should be used when style - attributes within html elements are wanted. - A new option, "-U value" does the same than "@clear value" (makeinfo - has that option, too). - A new configuration variable L2H_HTML_VERSION for the html version - passed to latex2html. - @tex or @math don't start a new paragraph. - * Tests/*: test for @raisesections and @lowersections, and for - @cartouche. - -2003-07-11 Patrice Dumas <dumas@centre-cired.fr> - - * Tests/ccvs: update cvs manual. This should fixe the issue of rcs - tags expanding in html manual files in ccvs_res. - * Tests/*: sync with code. Add missing test result files. - * Tests/Makefile.am: add new test subdirs. Better cleaning. - * l2h.init: add init file for latex2html. - -2003-07-10 Derek Price <derek@ximbiot.com> - - * Tests/nodes_texinfo/--and-hyphenation.html: Removed this accidentally - added file at Pat's request. - -2003-07-10 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, Tests/test.sh: command line option names use '-' - instead of '_' between words (for example dump_texi becomes dump-texi). - * Tests/*: remove unneeded html and passfirst files. - -2003-07-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, *.init: use a separate namespace for the config - variables: Texi2HTML::Config. Use the Texi2HTML:: namespace for - variables set in texi2html and used in the init files subroutines. - Use Texi2HTML::LaTeX2HTML namespace for latex2html related code. - Use Texi2HTML::I18n namespace for internationalisation. - Variables related with latex2html are removed from texi2html.init - and put in l2h.init. - harmonize function names style (all like get_index and not GetIndex). - * Makefine.am, texi2html.pl: install examples init files in shared - directory. - try to find init files in the current directory, then the .texi2html - user directory, the local texi2html directory and lastly the shared - texi2html directory. - -2003-06-17 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: error messages go to STDERR instead of STDIN - * Tests/test.sh: add -x to perl invocation to avoid perl trying - to execute @PERL@. Small fixes. - * Tests/README: added README file in Tests to explain how to make - tests. - -2003-06-16 Derek Price <derek@ximbiot.com> - - * NEWS: Add some of Patrice's features, note new AC/AM versions, note - --enable-maintainer-mode requirement. - * Makefile.am (all): Remove automake supplied target. - (texi2html): Update dependencies. - (EXTRA_DIST): Update these. - (MAINTAINER_CLEAN_FILES): Remove automatically included files. - (TEXI2HTML): Remove unused variable. - (AUTOMAKE_OPTIONS): Move to... - * configure.in (AM_INIT_AUTOMAKE): ...here. - (AC_ARG_PROGRAM): Remove call - AM_INIT_AUTOMAKE handles it. - (T2H_VERSION): Rename to... - (PACKAGE_VERSION): ...to avoid extra cruft since Autoconf already sets - this automatically. - (T2H_DATE): Rename to... - (PACKAGE_DATE): ...this in keeping with Autoconf naming convention and - set it automatically using mdate-sh. - (extrasub): Remove uneeded cruft. - (AM_MAINTAINER_MODE): Call this macro to make things easier on - inexperienced users. - (AC_OUTPUT): Move these files into... - (AC_CONFIG_FILES): ...calls to this macro and update some calls to set - the executable bit on files which need it. - * check_texinfo.pl.in: s/@BANGPERL@/! @PERL@/g; - * texi2html.1.in: s/@T2H_VERSION@/@PACKAGE_VERSION@/g; - s/@T2H_DATE@/@PACKAGE_DATE@/g. - * texi2html.init: Correct opening comment. - * texi2html.pl: s/@BANGPERL@/! @PERL@/g; - s/@T2H_VERSION@/@PACKAGE_VERSION@/g. - * Tests/Makefile.am (test): Rename to... - (check-local): ...this to conform with Automake requirements & GNU - standards. - (clean): Rename to... - (clean-local): ...for compatibility with Automake. - - * Makefile.in: Regenerated. - * aclocal.m4: Ditto. - * configure: Ditto. - * Tests/Makefile.in: Ditto. - * doc/Makefile.in: Ditto. - -2003-06-16 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: @include replaced by an empty line - no end of line after last line when expanding macros - include of files within lines expanded from macros happen - at the right place - better handling of format command in section names and of empty - raw formats (like @html@end html) - * Tests/*: sync with code - -2003-05-20 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: split pass_texi in 2 pass. pass_texi - rearranges texi expanding macros and values, removing comments. - pass_structure remove unneeded empty lines and find out the structure - of the document. - use a different formatting for menu entries in other environments than - menus. - cleaning of code. - use close_stack in all the passes to close environments not rightly - closed. Fix some places where stack wasn't closed rightly. - New direction, 'NodeNext' and 'NodePrev' which contains the prev node - and next node which may be different from Next and Prev for sections. - use style font-size:smaller in pre instead of <font> for smallexample - and friends to produce valid html. - spaces and arguments following commands are removed or kept in the - same way than makeinfo does. - * Tests/*: add tests for environments not closed. Sync with code. - -2003-05-09 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: refs to other manuals conforms to - makeinfo with separated files for nodes. - If $T2H_NODE_FILES (-node-files) is true one file per node is created - which redirects to the real file or is the node file (if T2H_SPLIT - at node), to allow for cross manual references. - Add a T2H_NO_TEXI hash similar with T2H_HREF, T2H_NODES... - and T2H_THISDOC{title_no_texi} to have a texi free and thus html free - text for nodes/sections/title to be used in the <title> which element - which cannot contain other html elements. Also usefull for files with - node names generation. - t2h_set_body_text and t2h_protect_html put in texi2html.init to be - able to make changes more easily. - $T2H_TOC_LIST_STYLE is used for style in toc. Makes customisation - easier too. - * examples/html32.init: init file for html 3.2 generation - * Tests/test.sh: add validation - * Tests/*: tests for files with node names generation - -2003-05-07 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: put a label in splitted index. - splitted indices which are not at the level of splitting are kept - in the same file but in different sections. - different horizontal rules are global variables. - functions formatting index summary and index entry split between - a function in texi2html.pl and smaller functions doing the real - formatting in texi2html.init. - no formatting is done in texi2html.init. - heading appears in documents with only one section. - if $T2H_SEPARATED_FOOTNOTES is false (-noseparated_footnotes) - the footnotes are on the page they appear. More possibility - of customization of footnotes (insert things before and after each - footnotes and all footnotes). - use top file for the top element even when there is no @top section. - when there is a top element and splitting, no other element than - the top element appear in the top file. - * examples/makeinfo.init: format footnotes like makeinfo - * examples/xhtml.init: init file for xhtml - * Tests/test.sh: little fixes - * Tests/*: all tex stuff taken from verbatim_html and put in tex.texi. - tests for index entries in top and before top. - tests for documents with only one section or node or no node. - -2003-05-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: 3 split commands: split at - chapter, section or for every node (previously node and section - where the same than node now). - specific section footer. - find prev and next like makeinfo. - new directions, for nodes: NodeUp (up for node) and Following (next - node in reading order). - if in detailmenu menu entries are not used to find next and prev. - only one Top in nodes and anchors. Any case combination accepted - for any reference. - don't close { when not associated with an @command. - reintroduced code for counting words. - new possibilities for buttons. If this is a ref to a scalar, the - text appears in navigation. If it is an array, the first element - is a direction used for the href, the second element is a scalar - ref for the text (see makeinfo.init in examples for an example). - * Tests/*: test for recursive nodes references and other little - tests - * examples/*: new directory for examples of config files. There - is a file which tries to have an output which looks like makeinfo - --html output (makeinfo.init). - -2003-04-30 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: add the node as element when there - is a @printindex split accross pages between node and section. - * Tests/*: tests for documents with indices in top and between node - and section. - -2003-04-29 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: add $T2H_MENU_SYMBOL before nodes in - menu and optionnaly before unnumbered section names in menu entry. - next are not menu childs but next node in menu. - it is possible not to have next or prev for node. - any case combination of top is accepted in nodes, menus and - nodes directions. Not changed in anchors and refs (makeinfo shows - that kind of inconsistencies too). - the top_element it the @top section, then the Top node - and last the first element. - '(file) node' and '(file)' accepted in menus and nodes references. - better looking verbose output. - * Tests/*: tests for documents without sections and double top - -2003-04-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: No heading for top, as print_Top - allready does it. - if $T2H_USE_NODES (command line -use-nodes) is set, the nodes are - used as sections when they are not associated with a section. - find sections structure before handling nodes. - no more use of menu level for structuring. - @html sections don't close paragraphs. - * Tests/*: tests for document structure. Sync with code. - -2003-04-23 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: when there is no section nodes are used instead - * .cvsignore: add autom4te-2.53.cache and check_texinfo.pl - * Tests/.cvsignore: create .cvsignore for Tests - * Tests/ccvs: update to latest cvs manual - -2003-04-22 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: constants declared early as they are used in - texi2html.init (at least $WARN is used) - * Makefile.in, Tests/Makefile.in, Tests/Makefile.am: add .passfirst - and .2 files in regenerate and clean - * Tests/*: results of tests added - -2003-04-10 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: labels were put 2 times in special - sections (Top, about, toc...). - in vtable, ftable and table, even with an empty first item we - begin a <dd> as only <dd> and <dt> are allowed to follow <dl>. - Right labels are put in special sections and files are omitted - when the href is on the same file. - change œ to œ and Œ to Œ (as tidy do) - * Tests/*/nodetest.texi: test for more simple special commands - -2003-04-09 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: formatting put in texi2html.init - hrefs to anchors and index entries which are in footnotes are right - scan_texi changed to have a stack - verbose and debug goes to STDERR - unusefull empty lines removed - new option -dump_texi used to debug, dumps the result of pass_texi - to a file - menu_comments are always preformatted - better handling of @math and @sc - * Tests/*: a little more things tested. - -2003-04-04 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: deffn and the like better handled - preformatted sections are closed when there is a new format - and reopened right after the format such that there is no - validation error. The preformatted state is kept within - menu, deff body, simple formats, tables, with tt instead of - pre for terms, as pre isn't allowed in dt, but not in - indices. - simple macros are better handled when texi macros are removed - or in preformatted sections. - copying/end copying and insertcopying handled - @head_lines containing things which should be before the navigation - panel are used to get the labels for elements. - first page of index is handled like a normal format - * Tests/*: more tests for imbrications. - -2003-04-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: footnotes better handled, they have a separated - stack, state and text. - footnotes, anchors and refs can be mixed with better results. - $value{_title}... have only their texinfo expanded during - pass_texi, including values, macros and so on and the html - is generated during pass_text. - * Tests/*: minor changes, more tests. - -2003-04-02 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: macros splitted by 3 paragraphs are better handled. - more isolation of formatting. - better generation of index keys from commands, with more macros - replaced by the right letter or symbol. - better handling of @things{} in preformatted sections. - preformatted sections handled with a new format, preformatted (similar - with what is done for paragraphs). Some validation errors avoided. - commands for tables are handled. - index entries have the right file/id from their place. - The files are omitted from hrefs when the href points to the same file. - * Tests/*: formatting/imbrications.texi added. Sync with code. - -2003-03-27 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: rewrite of the parsing of texi - and of the handling of sectionning. - pass0 is now pass_texi. It still only generates texinfo. - pass_texi now also collects informations from sectionning commands - index entries, printindex commands. - pass1 through pass4 are now in just one pass, pass_text. - between pass_texi and pass_text, the information is used to figure - out the document and indices structure. - pass_text reparses the texinfo generated by pass_texi and - produces html. All the formatting is done in isolated subroutines - such that it is easy to change the formatting witout bothering - with the parsing. - pass_text uses scan_line to process a line. - A stack is used which holds opened macros and formats. Thus the - html is always closed and should be valid. - The document structure seems right with this approach, unnumbered - sections are at the right level and indices don't break the document - structure anymore. - * Tests/*: more tests for the @macros. Other minor modifications. - sync with new code. - -2003-03-06 Patrice Dumas <dumas@centre-cired.fr> - - * T2h_i18n.pm: added the licence - * texi2html.pl, texi2html.init, check_texinfo.pl.in: check function - put in check_texinfo.pl.in. T2H_EXPAND is now an array such that - more than one type may be expanded - * texi2html.pl: added a new pass before the other ones, pass0 and - a function scan_line0 used in that pass. During that pass the - ifhtml, ifnot*, the comments and multiple empty lines, the macros, - values and includes are handled. No html is generated. the - different things that are expanded can now be within a line and - not necessarily at the begining of the line. - The handling of values and macros is not changed. - scan_line handles more constructs (newlines (still bugged), - verbatim, html and tex, deffn (incomplete)). - new function close_stack which might be used to close the things - forgotten by users or between paragraphs. - new function substitute_text which uses scan_line to render - arbitrary text. - little improvements in menu comments handling. - accent_map/do_accent should handle all the accents. - * Tests/test.sh: minor changes. - * Tests/*: regenerated tests to keep in sync. - added formatting/imbrications.texi to test for imbricated things. - * configure, configure.in: added check_texinfo.pl.in. - -2003-02-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init, T2h_i18n.pm: options specifications - moved from texi2html.init to texi2html.pl, such that texi2html.init - resembles a regular user init file. internationalization move - from texi2html.init to T2h_i18n.pm. - * configure.in: added substitution of T2h_i18n.pm within - texi2html.pl - * configure, doc/Makefile.in, Makefile.in, aclocal.m4, - Tests/Makefile.in: regenerated with automake-1.6.3, autoconf-2.53 - -2003-02-24 Patrice Dumas <dumas@centre-cired.fr> - - * Tests: small fixes, more tests showing brokeness of texi2html - for some features and info and tex differences. - A change in texinfo.txi to permit handling of verb despite some - substitutions have allready been done - * texi2html.pl: add comment about the formats in texinfo 4.5 - setlocale is used in case of tests to avoid change in ordering of - indices while testing against a reference file - footnotes refs and image handled by parse_line, which calls a - sub routine (do_footnote, do_ref or do_image). - for footnotes, _$doc_num instead of $docu_doc - appended tp keep track of the file of the footnote, such that it - is easier to match. - instead of <!--::${section}::--> added before printindex, _$sec_num - is appended to printindex, to keep track of the - section number. - images extention is taken from the @image tag if available - everything which was splitted accross pass2, pass3 and pass4 is - now done in pass2. - in pass3 only very little cleaning is done, pass4 is removed. - -2003-02-21 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: added handling of overbar accent @= is transformed - in = - the handling of multi lines macro is done in a function, scan_line - which scans a line, keeping a record of the text allready ready, - the macro stack and a state which for now only contains 'verb' if in - @verb macro. The @verb macro is handled by this function (but since - things have allready been substituted, it cannot give the right - result easily) - -2003-02-19 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: T2H_DEFAULT_button_icon_img behaves - better when it has some undef arguments - the variables which may be redefined by the user are now global. - They are grouped in texi2html.init, and also in the Declaration in - texi2html.pl and sorted by class. - new elements in %T2H_THISDOC for items which are global but shouldn't - be redefined by the user (instead of $T2H_HOMEPAGE, $THISPROG...). - t2h_Init_global has been removed and the code scattered according to - the principles above - other minor fixes - -2003-02-18 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: handle @verbatim, and @html differently. Added - push_until function which shift from a lines array and push to another - array until @end tag. Remove PROTECTTAG - remove unneeded push of index entry for vtable or ftable which - created 2 indices entry - * Tests: added more tests - -2003-02-13 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: avoid using $_ in functions, as it is a global - variable, use my variables instead - * Tests/test.sh: if called with arguments, the test specified by - the arguments is the only one done - * Tests/*: add Makefile.in, more subdirectories, synchronise - reference files with changes in the code - -2003-02-12 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: add prototype for the functions ; remove - & in front of functions ; remove the unusefull main() - and Unprotect_texi functions - * Tests/Makefile.am, Tests/test.sh: add regenerate target to - redo the reference files - add test with tidy, remove cvs/rcs tags when doing diffs - -2003-02-11 Patrice Dumas <dumas@centre-cired.fr> - - * Tests/Makefile.am, Tests/test.sh: changes to reflect change - in directory name for the cvs manual from cvs to ccvs - -2003-02-11 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: unused variables removed - use_bibliography removed, lots of global variables made lexical. - open renamed open_file to avoid clashing with perl builtin. - remove sub init_input, the initialization is done in the - script itself. - add meta http-equiv="Content-Type" tag for the charset - declaration. - -2003-02-06 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl, texi2html.init: some unused variables removed - use_acc not used anymore, accents are always handled - Remove a lot of global variables. Use global lexical or lexically - scoped variables (with my) when possible. Pass variables as arguments - when the function is in texi2html.init - bugfixes: frame target is the top file, and not the toc file - during pass1 some lines where pushed in @lines2 instead of @lines - * Tests/test.sh: ignore CVS directory when doing diffs - -2003-02-03 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: Remove handling of setref which is a TeX macro. The - corresponding texinfo macro is anchor. - Remove an unneeded protect_texi - * configure.in, Makefile.am, Tests/test.sh, Tests/Makefile.am Tests/*: - Files used for testing added, texinfo manuals and the html results for - some of the texinfo manuals - -2003-01-30 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: fix nesting of multi line style macros (previously, - @kbd{@code{my - thing}} - became - <kbd>my thing<kbd><code></code> (or something approaching) - no style substitution is done in indexes (indexes are already good - html). Added %sec2index which is undef for a section name not in index, - 1 if the section name is in index. - the value of $docu_doc set if $T2H_OUT was set (option -o) wasn't - used to define docu_doc_file, thus the output file was the basename - of the texinfo file with extension appended, and not $T2H_OUT. - - -2003-01-28 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: fixes in the handling of characters which are - special in html (&, "), involving some rewriting/replacements - of other functions which were bugged - normalise_node now really uses protect_html - new function protect_space_style used to normalise nodes without - calling protect_html - -2003-01-24 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: fixes for @multitables: - size detection, elements out of bounds are ignored - @item and @tab may appear anywhere within table lines - - -2003-01-22 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: Ref to info files are handled correctly - @ref{(perl)Top} is transformed into @ref{Top,,,perl}. - Any character is allowed in menu comments - In menu, lines begining with * which are not menu entries are allowed - and treated as comments - Added a style handle for @bullet (do_bullet) such that @bullet{text} - is handled - Cedilla are now accepted in node names. Added protect_cedilla and - unprotect_cedilla functions. - * texi2html.pl, texi2html.init: Add -test option which sets - $T2H_TODAY $T2H_USER $THISPROG to given values. This is in order - to be able to compare with reference files for testing purproses. - -2003-01-16 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: @H{a} is changed in a'' and not á which was - wrong, as there are 2 acute accents on @H{a}. - -2003-01-09 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.pl: Suppress warnings for undefined patterns or - variables when running with -w - -2003-01-08 Patrice Dumas <dumas@centre-cired.fr> - - * texi2html.init: small typo in a french word corrected - * texi2html.pl: @dotless macros are processed before accents - constructs like @'{a} are handled, typo in variable names corrected - -2002-06-25 Derek Price <oberon@umich.edu> - - * texi2html.init, texi2html.pl: - Miscellaneous HTML improvements, towards strictness and - easier transition to XHTML later; lowercase elements and - attributes, avoid using deprecated elements and attributes, - always quote attribute values, avoid use of minimized - attributes. Internal cleanups. - (Patch from Ville Skyttä <ville.skytta@xemacs.org> through - Adrian Aichner <adrian@xemacs.org>.) - -2002-06-08 Derek Price <oberon@umich.edu> - - * configure: Update to a new development release number. - * NEWS: Add news template for next release. - - * configure.in: Regenerated. - * doc/stamp-vti: Ditto. - * doc/version.texi: Ditto. - -2002-06-08 Derek Price <oberon@umich.edu> - - * configure.in: Update Texi2HTML date. - * NEWS: Update for new release. - * .cvsignore: Add autom4te.cache for new version of Autoconf. - - * Makefile.in: Regenerated. - * aclocal.m4: Ditto. - * configure: Ditto. - * doc/Makefile.in: Ditto. - * doc/stamp-vti: Ditto. - * doc/version.texi: Ditto. - -2001-11-27 Adrian Aichner <adrian@xemacs.org> - - * texi2html.pl (pass5): Improve wording to say "# writing X - sections ...". - * texi2html.pl (next_doc): Skip over $docu_top_file and issue - warning. - -2001-11-25 Adrian Aichner <adrian@xemacs.org> - - * texi2html.init (T2H_InitGlobals): Improve documentation. - Prepend $T2H_ADDRESS, which contains nothing but the address now, - with "by". - * texi2html.init (T2H_DEFAULT_print_page_foot): Prepend - $T2H_ADDRESS, which contains nothing but the address now, with - "by". - * texi2html.init (T2H_PRE_ABOUT): Ditto. - * texi2html.init (T2H_AFTER_ABOUT): Make it a lexical. - * texi2html.pl: Remove trailing whitespace from lines. Use - protect_html of HREF and NAME. Use /o where possible in - substitutions. - * texi2html.pl (T2H_HOMEPAGE): Get rid of newlines. - * texi2html.pl (T2H_ADDRESS): Move to texi2html.init. - * texi2html.pl (pass1): Fix severe top node matching bug. - * texi2html.pl (do_uref): Don't markup obviously bad uref. - * texi2html.pl (t2h_anchor): Use protect_html to allow - double-quoting of all html attributes. - -2001-11-19 Adrian Aichner <adrian@xemacs.org> - - * texi2html.init: Initialize T2H_INCLUDE_DIRS to the empty list. - * texi2html.pl (LocateIncludeFile): Don't look in ., unless it's - part of T2H_INCLUDE_DIRS. - -2001-09-18 Derek Price <dprice@collab.net> - - * texi2html.pl (T2H_HOMEPAGE): Use new link. - (T2H_AUTHORS): Direct to dev@texi2html.cvshome.org for maintainer. - (T2H_ADDRESS): Default to "an unknown user". - -2001-09-18 Derek Price <dprice@collab.net> - - * doc/.cvsignore: Add several files generated by pdftex. - -2001-09-18 Derek Price <dprice@collab.net> - - * doc/Makefile.am (texi2html_TEXINFOS): Remove version.texi - AM - includes it automatically. - (texi2html.html): Include version.texi as a dependency. - (texi2html.pdf): Use pdftex to create instead of ps2pdf - hyperlinks! - - * doc/Makefile.in: Regenerated. - -2001-09-18 Derek Price <dprice@collab.net> - - * configure.in: Bump package version number. - * Makefile.am (AUTOMAKE_OPTIONS): Bump required Automake version to - 1.5. - * doc/texinfo.tex: New File. - * TODO: Add note about `make distcheck' being broken and about lack of - a comprehensive test suite. - - * Makefile.in: Regenerated using Automake 1.5. - * aclocal.m4: Ditto. - * configure: Ditto. - * doc/Makefile.in: Ditto. - * doc/stamp-vti: Ditto. - * doc/version.texi: Ditto. - -2001-09-17 Derek Price <dprice@collab.net> - - * texi2html.init (T2H_WORDS_FR, MONTH_NAMES_FR): Add French - translations. - (Patch from Dumas Patrice <dumas@centre-cired.fr>.) - -2001-09-17 Derek Price <dprice@collab.net> - - * texi2html.1.in (AVAILABILITY): Add detail. - -2001-09-17 Derek Price <dprice@collab.net> - - * .cvsignore: Add `texi2html.1'. - -2001-09-17 Derek Price <dprice@collab.net> - - * texi2html.1: Removed this file since it is generated by configure. - -2001-08-10 Derek Price <dprice@collab.net> - - * INTRODUCTION: Fix email addresses and links. - * README: Ditto. - * NEWS: Update. - -2001-08-10 Derek Price <dprice@collab.net> - - * doc/Makefile.am: Made a few changes so we can build in a dir other - than $(srcdir). - (Bug report from Richard Pixley <rpixley@zhone.com>.) - - * Makefile.am: Remove some useless comments. - * doc/Makefile.am: Simplify some targets which Automake already knew - how to handle. - - * aclocal.m4: Regenerated. - * configure: Regenerated. - * Makefile.in: Regenerated. - * doc/Makefile.in: Ditto. - -2001-01-20 Adrian Aichner <adrian@xemacs.org> - - * INTRODUCTION (http): Typo fixes. - * texi2html.init (T2H_DEFAULT_print_toc_frame): Improve wording. - * texi2html.pl: Avoid newlines around URL in $T2H_HOMEPAGE. - * texi2html.pl (pass1): Remove incorrect "node is undefined ..." - warnings (as pointed out by larry.jones@sdrc.com (Larry Jones) in - <200011152253.RAA16633@thor.sdrc.com>. - * texi2html.pl (Sec2PrevNode): Fix bug of calculating next node - instead of previous. - * texi2html.pl (main): Provide Windows NT workaround for $T2H_USER - until getpwuid gets implemented there. - -2000-11-15 Adrian Aichner <adrian@xemacs.org> - - * texi2html.pl: Comment out warnings pragma which, according to - larry.jones@sdrc.com (Larry Jones), is not available in - perl5.004_02. - -2000-11-12 Adrian Aichner <adrian@xemacs.org> - - * doc/custhtml.texi: Fix @node and @menu commands according to - feedback from makeinfo and texi2html, which reports undefined - nodes now. - * doc/custhtml.texi (CustHTMLBody): Ditto. - * doc/custhtml.texi (CustHTMLBodyText): Ditto. - * doc/custhtml.texi (CustHTMLAfterBody): Ditto. - * doc/custpage.texi: Ditto. - * doc/custpage.texi (TipsNewDesign): Ditto. - * doc/custpage.texi (CustPagePhil): Ditto. - * doc/custpage.texi (CustPagePhilNav): Ditto. - * doc/custpage.texi (CustPageMiscPage): Ditto. - * doc/custpage.texi (CustPagePageHeadToc): Ditto. - * doc/custpage.texi (CustPagePageHead): Ditto. - * doc/initfile.texi: Ditto. - * doc/initfile.texi (InitFileBasics): Ditto. - * doc/reference.texi: Ditto. - * doc/reference.texi (Refptocframe): Ditto. - * doc/stamp-vti: Updated. - * doc/texi2html.texi: Ditto. - * doc/texi2html.texi (Top): Ditto. - * doc/texi2html.texi (Indexvr): Ditto. - * doc/version.texi: Ditto. - - -2000-11-12 Adrian Aichner <adrian@xemacs.org> - - * texi2html.init: Re-format file according to M-x cperl-set-style - RET C++ RET. Following subs are affected by re-indentatition and - bug fixes due to use of warnings pragma. - * texi2html.init (T2H_DEFAULT_print_section): - * texi2html.init (T2H_DEFAULT_print_Top_header): - * texi2html.init (T2H_DEFAULT_print_Top): - * texi2html.init (T2H_DEFAULT_print_misc_header): - * texi2html.init (T2H_DEFAULT_print_misc): - * texi2html.init (T2H_DEFAULT_print_chapter_header): - * texi2html.init (T2H_DEFAULT_print_chapter_footer): - * texi2html.init (T2H_InitGlobals): - * texi2html.init (T2H_DEFAULT_print_page_head): - * texi2html.init (T2H_DEFAULT_print_page_foot): - * texi2html.init (T2H_DEFAULT_print_foot_navigation): - * texi2html.init (T2H_DEFAULT_button_icon_img): - * texi2html.init (T2H_DEFAULT_print_navigation): - * texi2html.init (T2H_DEFAULT_print_frame): - * texi2html.init (T2H_DEFAULT_print_toc_frame): - * texi2html.init (T2H_DEFAULT_about_body): - * texi2html.pl: Re-format file according to M-x cperl-set-style - RET C++ RET. Add pragma: - use warnings; - Following subs are affected by re-indentatition and bug fixes due - to use of warnings pragma. - * texi2html.pl (LoadInitFile): - * texi2html.pl (SetDocumentLanguage): - * texi2html.pl (l2h_Init): - * texi2html.pl (l2h_InitToLatex): - * texi2html.pl (l2h_ToLatex): - * texi2html.pl (l2h_FinishToLatex): - * texi2html.pl (l2h_ToHtml): - * texi2html.pl (getcwd): - * texi2html.pl (l2h_InitFromHtml): - * texi2html.pl (l2h_FromHtml): - * texi2html.pl (l2h_ExtractFromHtml): - * texi2html.pl (l2h_Finish): - * texi2html.pl (l2h_InitCache): - * texi2html.pl (l2h_StoreCache): - * texi2html.pl (l2h_FromCache): - * texi2html.pl (l2h_ToCache): - * texi2html.pl (pass1): - * texi2html.pl (EnterIndexEntry): - * texi2html.pl (IndexName2Prefix): - * texi2html.pl (GetIndexEntries): - * texi2html.pl (byAlpha): - * texi2html.pl (GetIndexPages): - * texi2html.pl (GetIndexSummary): - * texi2html.pl (PrintIndexPage): - * texi2html.pl (PrintIndex): - -2000-11-05 Adrian Aichner <adrian@xemacs.org> - - * MySimple.pm (getOptions): Correct typo found with "use strict;". - * texi2html.init: Convert from dynamically to lexically scoped - variables. - * texi2html.init (pretty_date): Ditto. This sub is defined in - texi2html.pl as well! - * texi2html.pl: Ditto. - * texi2html.pl (l2h_FromHtml): Ditto. - * texi2html.pl (pass1): Ditto. - * texi2html.pl (pass2): Ditto. - * texi2html.pl (pass3): Ditto. - * texi2html.pl (pass4): Ditto. - * texi2html.pl (update_sec_num): Ditto. - * texi2html.pl (open): Ditto. - * texi2html.pl (next_line): Ditto. - * texi2html.pl (html_debug): Ditto. - * texi2html.pl (debug): Ditto. - * texi2html.pl (do_email): Ditto. - * texi2html.pl (do_math): Ditto. - * texi2html.pl (do_uref): Ditto. - * texi2html.pl (apply_style): Ditto. - * texi2html.pl (substitute_style): Ditto, except $_. - * texi2html.pl (t2h_anchor): Ditto. - * texi2html.pl (pretty_date): Ditto. This sub is defined in - texi2html.init as well! - -2000-11-05 Adrian Aichner <adrian@xemacs.org> - - * texi2html.pl (pass1): Generate valid HTML for <a name=...> - anchors produced for @itemx?. - -2000-11-05 Adrian Aichner <adrian@xemacs.org> - - * texi2html.init: Eliminate bare-word use of variable T2H_OPTIONS. - -2000-11-05 Adrian Aichner <adrian@xemacs.org> - - * texi2html.pl: Use strict pragma to detect potential bugs. - Declare local variables (currently 396!). Fix HTML syntax in - $complex_format_map. Eliminate bare-word use of variables - (eg. use $T2H_LANG instead of T2H_LANG). - * texi2html.pl (GetIndexSummary): Remove <br> after <table>. - * texi2html.pl (Sec2NextNode): Re-write section-number regexp for - readability and to make cperl-mode happy. - * texi2html.pl (Sec2PrevNode): Ditto. - * texi2html.pl (main): New sub encapsulating top-level code. - * texi2html.pl (pass1): Ditto. Re-write texinfo comment regexp - for readability and to make cperl-mode happy. End HTML <p> before - @printindex, <dl>, and </dl>. - * texi2html.pl (pass2): Ditto. Quote <table> attributes. - * texi2html.pl (pass3): Ditto. - * texi2html.pl (pass4): Ditto. Remove </p> before first paragraph! - * texi2html.pl (pass5): Ditto. - * texi2html.pl (open): Use no strict "refs" to allow symbolic - reference. - * texi2html.pl (apply_style): Ditto. - -2000-11-04 Adrian Aichner <adrian@xemacs.org> - - * texi2html.init ($T2H_DOCTYPE): Add SystemLiteral to identify the - canonical DTD. - * texi2html.init (T2H_DEFAULT_about_body): Fix HTML syntax of - Subsubsection One-Two-Three example. - * texi2html.pl: Close HTML <p> before HTML <table> and HTML - <dl>. Correct handling of texinfo menu comment lines. - * texi2html.pl (protect_html): Simplify. This subroutine was way - too smart! Use Character entity references (eg <) instead of - Numeric character references (eg. <). - * texi2html.pl (unprotect_html): Use Character entity references - (eg <) instead of Numeric character references (eg. <). - -2000-09-14 Eric Sunshine <sunshine@sunshineco.com> - - * doc/Makefile.in: Added missing doc/Makefile.in since its absence - caused 'configure' and make targets (such as 'distclean') to bomb. - -2000-09-14 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * applied patches/fixes from Eric Marsden <emarsden@mail.dotcom.fr>. - o DTD now at the beginning of the document - o default language to 'en' wasn't working which led to empty LANG="" - in <BODY> - o missing </FONT> in footer blurb - o when the ToC was generated in some cases, the code used - <UL></UL> to indent, but didn't have any <LI> tags. <blockquote> - is now used in such cases, instead. - -2000-09-11 Eric Sunshine <sunshine@sunshineco.com> - - * texi2html.pl: Fixed severe macro expansion bug. Macro argument - parsing code did not handle nested braces ('{' and '}') at - all, thus valid macro invocations such as - "@mymacro{Hello @emph{there} @strong{world}.}" would fail. - Prior to this fix, @mymacro would be handed the argument - "Hello @emph{there", which is clearly incorrect. Now @mymacro - correctly receives "Hello @emph{there} @strong{world}." as its - argument. This fix also deals properly with the protected brace - sequences \{, \}, @{, and @}. - - * texi2html.pl: Fixed severe macro expansion bug. Macro argument - parsing code did not handle arguments split over multiple lines, - such as "@mymacro{Hello \n world.}". Now it correctly handles - macro invocations split across any number of lines, and properly - flags an error at the correct location if the user forgets the - closing brace '}'. - - * texi2html.pl: Fixed formatting errors in expansions of @SPACE, - @TAB, and @NL (where SPACE, TAB, and NL represent the actual - space, tab, and newline characters). The Texinfo manual - explicitly states that each of these sequences should expand to a - "printable" space in the [rendered] output. The example given in - the manual shows that "Spacey@ @ @ @ example" should expand to - "Spacey example". However, texi2html was only emitting the - insignificant whitespace ' ' and '\n' into the HTML output which - did not properly preserve the hard spaces in "Spacey example". - Now each of these directives expands to ' ' instead. - - * texi2html.pl: Made aesthetic improvement to the output of @file{}, - @option{}, and @samp{}. The argument string is now quoted with - ` and ' _after_ the style has been applied. For instance, - @samp{perl} now expands to "`<samp>perl</samp>'", whereas it used - to expand to "<samp>`perl'</samp>". In my tests, this change - results in more aesthetically pleasing rendered output on various - browsers. - -2000-08-16 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: Bug fix from: "joseph" <joseph@freenet.de> - MySimple.pm should be 'require'd, but checked is still texi2html.init. - -2000-08-14 Karl Heinz Marbaise <khmarbaise@gmx.de> - * new command line switch (Test purposes only!) - to show new layout in HTML for @def stuff. - * Texinfo-Documentation updated. - - New chapter about ``customizing HTML'' started. - - multiple files instead of one. - - subdirectory doc. - -2000-07-27 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: Fixed Getopt::Long::Configure("pass_through") for - older versions of Getopt::Long which do not support his function. - -2000-07-11 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * implemented @documentlanguage: - - sets language of document, unless overwritten by -lang, or - explicitly set $T2H_LANG - - * introduced T2H_OBSOLETE_OPTIONS to prevent obsolete options to - ambiguate current options - -2000-07-09 Karl Heinz Marbaise <khmarbaise@gmx.de> - * Texinfo-Documentation: - - fixes from Peter Moulder <pjm@bofh.asn.au> incorporated - into manual. - - Updated Manual - o improved - o indices for options, variables of script. - o much more. - * texi2html.init: - - improvements for different languages - (month names, words in different languages). - -2000-07-05 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * Provided CVS anonymous read-access to Texi2html: - cvs -d :pserver:t2h-anon@urmel.mathematik.uni-kl.de:/usr/local/Singular/cvsroot login - cvs -d :pserver:t2h-anon@urmel.mathematik.uni-kl.de:/usr/local/Singular/cvsroot co Texi2html - Passwd: texi2html - * Provided CVS write-access to Texi2html: contact me for - instructions - -2000-07-01 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * primitive support for some toher def stuff (needs to be fixed, - though) - * Distribution: Incorporated texi2html.texi authored by Karl Heinz - Marbaise <khmarbaise@gmx.de> (THANKS!) - - * texi2html.1.in: Updates to reflect new cmd-line options - - * Rewrote handling of command-line options: - - based on (My)Simple.pm, and Getopt::Long - -help now works and is up-to-date - -help 1 lists also "not-so-important" options - -help 2 lists also obsolete options - - the following options were renamed: (old options still work, but - are marked as obsolete) - verbose ==> Verbose - section_navigation ==> sec_nav - output_file ==> out_file - - the following options are obsoleted (still work, though): - no-section_navigation ==> -nosec_nav - use_acc ==> ALWAYS use accents - expandinfo ==> -expand info - expandtex ==> -expand tex - no_verbose ==> default case - monolithic ==> default case - split_node ==> -split section - split_chapter ==> -split chapter - -2000-06-27 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * Fixed bug in anchor generation (reported by various people who - noticed that @anchor may not be on one line with @item) - * Fixed infinite loop on missing '@end macro' - * texi2html.pl: -expandinfo and -expandtex command-line options - for backward compatibility - - * texi2html.init: Use ISO 639 language codes for keys in $T2H_LANG - hash. - -2000-06-26 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: new command-line options: - -nonumber, -nomenu to unset the default -number -menu - - * texi2html.pl: As suggested by "Richard Y. Kim" <ryk@coho.net>: - insert <A NAME="#nodename"></A> for each - nodename in a document (nodename is exactly as in texinfo - source). - - * From: "Richard Y. Kim" <ryk@coho.net> - o $T2H_FRAMES internal boolean variable which defaults to 0 - o -frames command line option which changes $T2H_FRAMES to 1. - o If $T2H_FRAMES is 1, then two additional files are output. - If mydoc.html is output normally, then mydoc_frame.html - and mydoc_frame_toc.html files are output. - o The functions T2H_print_frame, and T2H_print_toc_frame are used to - generate contents of these files. - o The T2H_DEFAULT_print_frame and T2H_DEFAULT_print_toc_frame - (defined in texi2html.ini) do the following: - mydoc_frame.html is the short file with <FRAME> tags. - mydoc_frame_toc.html is basically the short table of contents - which goes on the narrow left frame. - - * texi2html.pl: @,{c} --> ç - -2000-06-23 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * released version 1.63 - * texi2html.init (T2H_DEFAULT_print_page_head): - make <html> tag very first thing in every file - * fixed macro quoting and special cases of macro invocation - * from "Richard Y. Kim" <ryk@coho.net>: - o handle \} in macro arguments - * from brlewis@alum.mit.edu: - o Changes to facilitate CSS - o -toc_file option for those who want the TOC to be index.html - o Config variable $T2H_HREF_DIR_INSTEAD_FILE: - if set (e.g., to index.html) replace hrefs to this file - (i.e., to index.html) by ./ - * texi2html.pl: index generation after value substitution - -2000-05-31 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: for def_map stuff <A NAME=..> before output - * texi2html.pl: applied patch from "Richard Y. Kim" <ryk@ap.com> - for @refs with 2 or 3 args: use 3rd or 2nd argor - section (in that order) as text for reference. - -2000-04-18 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: Applied patches of <sunshine@sunshineco.com> to - make texi2html work with older versions of Perl - -2000-04-13 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: fixed unmacro - * distribution: applied patches from Peter Moulder and Teun - Burgers. - * fixed "Duplicate section found" -- section may now have - duplicate names - * fixed bug related to $T2H_AVOID_MENU_REDUNDANCY - -2000-04-12 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * release 1.62 - * added $T2H_NODE_NAME_IN_MENU for enforcing node - names in meny entries, and $T2H_AVOID_MENU_REDUNDANCY to - avoid display of duplicate meny entry information - -2000-04-11 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: fixed two small bugs reported by - sunshine@sunshineco.com (</TR> in menu, <P> after itemize). - * implemented @ftable, @vtable - * index generation reimplemented: - - Can be split over several pages, depending on the value of - $T2H_SPLIT_INDEX - - typesetting in fixed-width font is observed - * texi2html.init: T2H_IDX_SUMMARY either set or not set, takes no - argument. - -2000-04-08 Peter Moulder <pjm@bofh.asn.au> - - * Makefile.am, configure.in: Generate texi2html in - configure script instead of Makefile. (Due mostly to - Teun Burgers.) - - * README, TODO, texi2html.1.in, texi2html.init, texi2html.pl: - Misc. documentation changes. - -2000-04-07 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.init: $T2H_INDEX_CHAPTER introduced: - if set, use this chapter for Index button, else - use first chapter whose name matches 'index' (case insensitive) - * fixed atuomatic pointer creation for appendix chapters - * fixed handling of menu entries with description going into the - next line, use numbered section names, if $T2H_NUMBER_SECTIONS - * texi2html.init: $T2H_TOP_HEADING for explicitly specifying - heading of top node - * fixed handling of headings (no new page on -split section) - * fixed bug in index (generation of section names) - * stoc in _ovr.html within BLOCKQUOTES - * get rid of bullets in ToC, if $T2H_NUMBER_SECTIONS - -2000-04-06 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * fixed bug in creation of index entries (eval of section names) - * fixed table within itemize and parapgraphs - * surpress <P></P> when within <pre> - * allow @include within top node - -2000-04-03 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.init: By default, T2H_TOP_FILE is set to '' - * texi2html.pl: $docu_top=$T2H_TOP_FILE || $docu_name. $docu_ext; - -2000-03-31 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: $complex_format_map for complex enclosing - constructs where which: - * texi2html.init:$T2H_EXAMPLE_INDENT_CELL, - $T2H_SMALL_EXAMPLE_INDENT_CELL, $T2H_SMALL_FONT_SIZE for - customizing indent/font size of block-enclosing texinfo command - (@example, @format, @display, etc). - * Release version 1.61. - -2000-03-29 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * Cleaned up texi2html.pl and added loading of init file (when - texi2html.pl is run) such that it can directly be used as script - (otherwise, debugging is much harder). - - * fixed getpwuid - - * Added T2H_print_chapter_header, T2H_print_chapter_footer for - more fine-grained control of T2H_SPLIT eq 'chapter', added option - -section_navigation, $T2H_SECTION_NAVIGATION to suppress output of - navigation panels per section - - * Changed naming and and calling convention of customizable subs: - They all have prefix T2H_, are called with &$T2H_, are assigned by - $T2H_<name> = \&T2H_DEFAULT_<name>. - - * texi2html.init: Incorporated changed of Peter Moulder: - -2000-03-27 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * debian/*: deleted - * texi2html.pl: Incorporated changes of Peter Moulder - * texi2html.pl: Automatic node pointer creation added - * texi2html.pl: @enddots, @exclamdown, etc added - -2000-03-26 Peter Moulder <reiter@netspace.net.au> - - * texi2html.init: Address a couple of weblint/tidy warnings. - - * texi2html.init: - * texi2html.pl: The init file is inserted into the executable at - build time (see Makefile.am). - - * texi2html.pl: Source each of @sysconfdir@/texi2htmlrc and - $HOME/.texi2htmlrc if it exists, after processing texi2html.init - but before anything on the command-line. - - Allow -split_chapter, -split_node, -monolithic options, which is - what previous versions of texi2html used. - - Support `@command{...}'. - - Add --help, --version options. - - -sidx isn't used, so comment out. - - * configure.in: - * Makefile.am: - * autogen.sh: New files. - - * configure.in: Change version number from 1.60Beta to 1.59.2. - - * debian/*: New files. - - * texi2html.1.in: - * texi2html.pl: Extract the man page into a separate file. At the - moment, the man page is even installed separately (with - texi2html.pl having `.so @MANPAGE_PATH@' in place of the - manpage). Conceivably we could add a configure option to - construct everything as one file like we used to; just replace - that text with `@EMBEDDED_MANPAGE@', which would be replaced with - either the existing `.so @MANPAGE_PATH@' or with texi2html.1 - contents the way texi2html.init is done. - -2000-03-14 Olaf Bachmann <obachman@mathematik.uni-kl.de> - - * texi2html.pl: center @image by default, can be overwritten by - T2H_CENTER_IMAGE (sunshine@sunshineco.com) - -# vim:tabstop=8:shiftwidth=8 diff --git a/Build/source/utils/texi2html/INSTALL b/Build/source/utils/texi2html/INSTALL deleted file mode 100644 index b42a17ac464..00000000000 --- a/Build/source/utils/texi2html/INSTALL +++ /dev/null @@ -1,182 +0,0 @@ -Basic Installation -================== - - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes awhile. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=PATH' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`configure' also accepts some other, not widely useful, options. diff --git a/Build/source/utils/texi2html/INTRODUCTION b/Build/source/utils/texi2html/INTRODUCTION deleted file mode 100644 index bf7051de557..00000000000 --- a/Build/source/utils/texi2html/INTRODUCTION +++ /dev/null @@ -1,88 +0,0 @@ -Getting Started with texi2html -============================== - -'texi2html' converts texinfo documents to HTML. - -Texinfo is the official documentation format of the GNU project. It -uses a single source file to produce both on-line information and -printed output. For more details about texinfo, see -http://www.texinfo.org. - -In contrast to the HTML produced by 'makeinfo --html' (the 'makeinfo' -program is part of the Texinfo distribution), the HTML output of -'texi2html' is highly configurable. Among others, with 'texi2html' you -can customize your entire page layout (like headers, footers, style -sheets, etc), split documents at various levels and use 'latex2html' to -convert @tex sections. - -'texi2html' should reasonably convert all Texinfo 4.8 constructs. If -not, please send a bug report to 'dev@texi2html.cvshome.org'. - - -To create HTML of texinfo documents -=================================== - -Make sure that you have 'texi2html' correctly installed on your -system. The general synopsis of 'texi2html' is - - texi2html [options] texinfo-source-file - -Without any options, this will create the file <docname>.html where -<docname> is the basename of your texinfo files. - -See the beginning of the file 'texi2html.init' for explanations of -command-line options and their default values, or run 'texi2html -h' -for a short overview of the most important options. - - -Customizing texi2html -===================== - -Initialisation options are read first from -'/usr/local/etc/texi2html/Config' (the exact location being changeable with -the '--sysconfdir=dir' option to the configure script), then from -$HOME/.texi2html/Config, then any command-line options including -init-file -options; with later settings overriding earlier ones. - -The default initialisation options are defined in the -'texi2html.init' file contained in the Texi2html distribution (in -fact, 'configure' pastes this file into beginning of texi2html.pl and -generates the actual 'texi2html' script this way.). - -To customize 'texi2html' it is best if you copy the appropriate -sections from the 'texi2html.init' file into an appropriate local -initialization file, make the necessary changes there, and then have -'texi2html' read this initialisation file by one of the means described -above. - -For an example on what you can produce with 'texi2html' have a look -at the following sites: - -* http://www.singular.uni-kl.de/Manual/html/ - -(Please send me your sites, if you'd like to have them listed here). - - -Documentation of texi2html -========================== -The texi2html Texinfo manual should be rather complete. In addition, - you might want to have a look at the comments in the 'texi2html.init' -file for explanations about customizable parameters and at the (not -up-to-date) texi2html man page for an overview of texi2html's synopsis. - -More information -================ - -Texi2html's home page can be found at http://texi2html.cvshome.org - -The newest version of Texi2html can be obtained from -http://texi2html.cvshome.org/servlets/ProjectDownloadList -or, via anonymous cvs (see -http://texi2html.cvshome.org/servlets/ProjectSource for instructions). - -Send email to dev@texi2html.cvshome.org for bug reports, enhancement -suggestions, and to users@texi2html.cvshome.org for authoring questions -and general discussion. - - -Good luck and enjoy !! diff --git a/Build/source/utils/texi2html/Makefile.am b/Build/source/utils/texi2html/Makefile.am deleted file mode 100644 index 88074f64733..00000000000 --- a/Build/source/utils/texi2html/Makefile.am +++ /dev/null @@ -1,125 +0,0 @@ -## Process this file with automake to produce Makefile.in - -SUBDIRS = . doc Tests -imagesdir = $(pkgdatadir)/images -i18ndir = $(pkgdatadir)/i18n - -# -# This is to prevent texinfo.tex from being included -# in the top-level distribution directory. -TEXINFO_TEX = doc/texinfo.tex - -bin_SCRIPTS = texi2html -texi2html_SOURCES = \ - MySimple.pm \ - T2h_i18n.pm \ - texi2html.init \ - texi2html.pl \ - translations.pl - -noinst_SCRIPTS = manage_i18n.pl -man_MANS = texi2html.1 - -EXTRA_DIST = \ - INTRODUCTION \ - MySimple.pod \ - autogen.sh \ - manage_i18n.pl \ - missing-texi2html \ - l2h.init \ - texi2html.spec \ - $(texi2html_SOURCES) - -dist_pkgdata_DATA = l2h.init \ - examples/makeinfo.init \ - examples/xhtml.init \ - examples/html32.init \ - examples/book.init \ - examples/noheaders.init \ - examples/inlinestyle.init \ - examples/utf8.init \ - examples/chm.init \ - examples/roff.init - -dist_i18n_DATA = i18n/en \ - i18n/de \ - i18n/es \ - i18n/fr \ - i18n/nl \ - i18n/no \ - i18n/pt - -dist_images_DATA = images/a_begin.gif \ - images/a_begin_na.gif \ - images/a_document.gif \ - images/a_document_na.gif \ - images/a_empty.gif \ - images/a_end.gif \ - images/a_end_na.gif \ - images/a_help.gif \ - images/a_help_na.gif \ - images/a_index.gif \ - images/a_index_na.gif \ - images/a_leftdouble.gif \ - images/a_leftdouble_na.gif \ - images/a_left.gif \ - images/a_left_na.gif \ - images/a_page.gif \ - images/a_page_na.gif \ - images/a_rightdouble.gif \ - images/a_rightdouble_na.gif \ - images/a_right.gif \ - images/a_right_na.gif \ - images/a_searchdoc.gif \ - images/a_searchdoc_na.gif \ - images/a_search.gif \ - images/a_search_na.gif \ - images/a_tableofcon.gif \ - images/a_tableofcon_na.gif \ - images/a_top.gif \ - images/a_top_na.gif \ - images/a_up.gif \ - images/a_up_na.gif \ - images/bg.jpg \ - images/bg_left.gif \ - images/bg_right.gif \ - images/blue_dir.gif \ - images/blue_down.gif \ - images/blue_grab.gif \ - images/blue_help.gif \ - images/blue_next.gif \ - images/blue_nnext.gif \ - images/blue_pprev.gif \ - images/blue_prev.gif \ - images/blue_readme.gif \ - images/blue_top.gif \ - images/blue_up.gif \ - images/blue_uup.gif \ - images/contents_motif.gif \ - images/COPYING \ - images/index_motif.gif \ - images/Mybg.gif \ - images/next_motif.gif \ - images/next_motif_gr.gif \ - images/previous_motif.gif \ - images/previous_motif_gr.gif \ - images/spacer3.gif \ - images/xy_contents.gif \ - images/xy_foot.gif \ - images/xy_next.gif \ - images/xy_next_gr.gif \ - images/xy_nextsection.gif \ - images/xy_nextsection_gr.gif \ - images/xy_previous.gif \ - images/xy_previous_gr.gif \ - images/xy_previoussection.gif \ - images/xy_previoussection_gr.gif \ - images/xy_up.gif \ - images/xy_up_gr.gif - -texi2html: $(texi2html_SOURCES) - - -translations.pl: texi2html.pl texi2html.init T2h_i18n.pm examples/roff.init \ - examples/noheaders.init i18n/de i18n/nl i18n/es i18n/no i18n/pt i18n/fr - $(PERL) $(srcdir)/manage_i18n.pl all diff --git a/Build/source/utils/texi2html/Makefile.in b/Build/source/utils/texi2html/Makefile.in deleted file mode 100644 index 78b792fe6ed..00000000000 --- a/Build/source/utils/texi2html/Makefile.in +++ /dev/null @@ -1,836 +0,0 @@ -# Makefile.in generated by automake 1.9.6 from Makefile.am. -# @configure_input@ - -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005 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@ -DIST_COMMON = README $(am__configure_deps) $(dist_i18n_DATA) \ - $(dist_images_DATA) $(dist_pkgdata_DATA) $(srcdir)/Makefile.am \ - $(srcdir)/Makefile.in $(srcdir)/check_texinfo.pl.in \ - $(srcdir)/texi2html.1.in $(srcdir)/texi2html.pl \ - $(srcdir)/texi2html.spec.in $(top_srcdir)/configure AUTHORS \ - COPYING ChangeLog INSTALL NEWS TODO config.guess config.sub \ - install-sh mdate-sh missing mkinstalldirs -subdir = . -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) -am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \ - configure.lineno configure.status.lineno -mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs -CONFIG_CLEAN_FILES = texi2html check_texinfo.pl texi2html.1 \ - texi2html.spec -am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(man1dir)" \ - "$(DESTDIR)$(i18ndir)" "$(DESTDIR)$(imagesdir)" \ - "$(DESTDIR)$(pkgdatadir)" -binSCRIPT_INSTALL = $(INSTALL_SCRIPT) -SCRIPTS = $(bin_SCRIPTS) $(noinst_SCRIPTS) -SOURCES = -DIST_SOURCES = -RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ - html-recursive info-recursive install-data-recursive \ - install-exec-recursive install-info-recursive \ - install-recursive installcheck-recursive installdirs-recursive \ - pdf-recursive ps-recursive uninstall-info-recursive \ - uninstall-recursive -man1dir = $(mandir)/man1 -NROFF = nroff -MANS = $(man_MANS) -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|^.*/||'`; -dist_i18nDATA_INSTALL = $(INSTALL_DATA) -dist_imagesDATA_INSTALL = $(INSTALL_DATA) -dist_pkgdataDATA_INSTALL = $(INSTALL_DATA) -DATA = $(dist_i18n_DATA) $(dist_images_DATA) $(dist_pkgdata_DATA) -ETAGS = etags -CTAGS = ctags -DIST_SUBDIRS = $(SUBDIRS) -DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) -distdir = $(PACKAGE)-$(VERSION) -top_distdir = $(distdir) -am__remove_distdir = \ - { test ! -d $(distdir) \ - || { find $(distdir) -type d ! -perm -200 -exec chmod u+w {} ';' \ - && rm -fr $(distdir); }; } -DIST_ARCHIVES = $(distdir).tar.gz $(distdir).tar.bz2 -GZIP_ENV = --best -distuninstallcheck_listfiles = find . -type f -print -distcleancheck_listfiles = find . -type f -print -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@ -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@ -datarootdir = @datarootdir@ -docdir = @docdir@ -dvidir = @dvidir@ -exec_prefix = @exec_prefix@ -host = @host@ -host_alias = @host_alias@ -host_cpu = @host_cpu@ -host_os = @host_os@ -host_vendor = @host_vendor@ -htmldir = @htmldir@ -includedir = @includedir@ -infodir = @infodir@ -install_sh = @install_sh@ -libdir = @libdir@ -libexecdir = @libexecdir@ -localedir = @localedir@ -localstatedir = @localstatedir@ -mandir = @mandir@ -mkdir_p = @mkdir_p@ -oldincludedir = @oldincludedir@ -pdfdir = @pdfdir@ -prefix = @prefix@ -program_transform_name = @program_transform_name@ -psdir = @psdir@ -sbindir = @sbindir@ -sharedstatedir = @sharedstatedir@ -sysconfdir = @sysconfdir@ -target_alias = @target_alias@ -SUBDIRS = . doc Tests -imagesdir = $(pkgdatadir)/images -i18ndir = $(pkgdatadir)/i18n - -# -# This is to prevent texinfo.tex from being included -# in the top-level distribution directory. -TEXINFO_TEX = doc/texinfo.tex -bin_SCRIPTS = texi2html -texi2html_SOURCES = \ - MySimple.pm \ - T2h_i18n.pm \ - texi2html.init \ - texi2html.pl \ - translations.pl - -noinst_SCRIPTS = manage_i18n.pl -man_MANS = texi2html.1 -EXTRA_DIST = \ - INTRODUCTION \ - MySimple.pod \ - autogen.sh \ - manage_i18n.pl \ - missing-texi2html \ - l2h.init \ - texi2html.spec \ - $(texi2html_SOURCES) - -dist_pkgdata_DATA = l2h.init \ - examples/makeinfo.init \ - examples/xhtml.init \ - examples/html32.init \ - examples/book.init \ - examples/noheaders.init \ - examples/inlinestyle.init \ - examples/utf8.init \ - examples/chm.init \ - examples/roff.init - -dist_i18n_DATA = i18n/en \ - i18n/de \ - i18n/es \ - i18n/fr \ - i18n/nl \ - i18n/no \ - i18n/pt - -dist_images_DATA = images/a_begin.gif \ - images/a_begin_na.gif \ - images/a_document.gif \ - images/a_document_na.gif \ - images/a_empty.gif \ - images/a_end.gif \ - images/a_end_na.gif \ - images/a_help.gif \ - images/a_help_na.gif \ - images/a_index.gif \ - images/a_index_na.gif \ - images/a_leftdouble.gif \ - images/a_leftdouble_na.gif \ - images/a_left.gif \ - images/a_left_na.gif \ - images/a_page.gif \ - images/a_page_na.gif \ - images/a_rightdouble.gif \ - images/a_rightdouble_na.gif \ - images/a_right.gif \ - images/a_right_na.gif \ - images/a_searchdoc.gif \ - images/a_searchdoc_na.gif \ - images/a_search.gif \ - images/a_search_na.gif \ - images/a_tableofcon.gif \ - images/a_tableofcon_na.gif \ - images/a_top.gif \ - images/a_top_na.gif \ - images/a_up.gif \ - images/a_up_na.gif \ - images/bg.jpg \ - images/bg_left.gif \ - images/bg_right.gif \ - images/blue_dir.gif \ - images/blue_down.gif \ - images/blue_grab.gif \ - images/blue_help.gif \ - images/blue_next.gif \ - images/blue_nnext.gif \ - images/blue_pprev.gif \ - images/blue_prev.gif \ - images/blue_readme.gif \ - images/blue_top.gif \ - images/blue_up.gif \ - images/blue_uup.gif \ - images/contents_motif.gif \ - images/COPYING \ - images/index_motif.gif \ - images/Mybg.gif \ - images/next_motif.gif \ - images/next_motif_gr.gif \ - images/previous_motif.gif \ - images/previous_motif_gr.gif \ - images/spacer3.gif \ - images/xy_contents.gif \ - images/xy_foot.gif \ - images/xy_next.gif \ - images/xy_next_gr.gif \ - images/xy_nextsection.gif \ - images/xy_nextsection_gr.gif \ - images/xy_previous.gif \ - images/xy_previous_gr.gif \ - images/xy_previoussection.gif \ - images/xy_previoussection_gr.gif \ - images/xy_up.gif \ - images/xy_up_gr.gif - -all: all-recursive - -.SUFFIXES: -am--refresh: - @: -$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) - @for dep in $?; do \ - case '$(am__configure_deps)' in \ - *$$dep*) \ - echo ' cd $(srcdir) && $(AUTOMAKE) --gnu '; \ - cd $(srcdir) && $(AUTOMAKE) --gnu \ - && exit 0; \ - exit 1;; \ - esac; \ - done; \ - echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu Makefile'; \ - cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu Makefile -.PRECIOUS: Makefile -Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status - @case '$?' in \ - *config.status*) \ - echo ' $(SHELL) ./config.status'; \ - $(SHELL) ./config.status;; \ - *) \ - echo ' cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__depfiles_maybe)'; \ - cd $(top_builddir) && $(SHELL) ./config.status $@ $(am__depfiles_maybe);; \ - esac; - -$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) - $(SHELL) ./config.status --recheck - -$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) - cd $(srcdir) && $(AUTOCONF) -$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) - cd $(srcdir) && $(ACLOCAL) $(ACLOCAL_AMFLAGS) -texi2html: $(top_builddir)/config.status $(srcdir)/texi2html.pl - cd $(top_builddir) && $(SHELL) ./config.status $@ -check_texinfo.pl: $(top_builddir)/config.status $(srcdir)/check_texinfo.pl.in - cd $(top_builddir) && $(SHELL) ./config.status $@ -texi2html.1: $(top_builddir)/config.status $(srcdir)/texi2html.1.in - cd $(top_builddir) && $(SHELL) ./config.status $@ -texi2html.spec: $(top_builddir)/config.status $(srcdir)/texi2html.spec.in - cd $(top_builddir) && $(SHELL) ./config.status $@ -install-binSCRIPTS: $(bin_SCRIPTS) - @$(NORMAL_INSTALL) - test -z "$(bindir)" || $(mkdir_p) "$(DESTDIR)$(bindir)" - @list='$(bin_SCRIPTS)'; for p in $$list; do \ - if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ - if test -f $$d$$p; then \ - f=`echo "$$p" | sed 's|^.*/||;$(transform)'`; \ - echo " $(binSCRIPT_INSTALL) '$$d$$p' '$(DESTDIR)$(bindir)/$$f'"; \ - $(binSCRIPT_INSTALL) "$$d$$p" "$(DESTDIR)$(bindir)/$$f"; \ - else :; fi; \ - done - -uninstall-binSCRIPTS: - @$(NORMAL_UNINSTALL) - @list='$(bin_SCRIPTS)'; for p in $$list; do \ - f=`echo "$$p" | sed 's|^.*/||;$(transform)'`; \ - echo " rm -f '$(DESTDIR)$(bindir)/$$f'"; \ - rm -f "$(DESTDIR)$(bindir)/$$f"; \ - done -uninstall-info-am: -install-man1: $(man1_MANS) $(man_MANS) - @$(NORMAL_INSTALL) - test -z "$(man1dir)" || $(mkdir_p) "$(DESTDIR)$(man1dir)" - @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \ - l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ - for i in $$l2; do \ - case "$$i" in \ - *.1*) list="$$list $$i" ;; \ - esac; \ - done; \ - for i in $$list; do \ - if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ - else file=$$i; fi; \ - ext=`echo $$i | sed -e 's/^.*\\.//'`; \ - case "$$ext" in \ - 1*) ;; \ - *) ext='1' ;; \ - esac; \ - inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ - inst=`echo $$inst | sed -e 's/^.*\///'`; \ - inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ - $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \ - done -uninstall-man1: - @$(NORMAL_UNINSTALL) - @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \ - l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ - for i in $$l2; do \ - case "$$i" in \ - *.1*) list="$$list $$i" ;; \ - esac; \ - done; \ - for i in $$list; do \ - ext=`echo $$i | sed -e 's/^.*\\.//'`; \ - case "$$ext" in \ - 1*) ;; \ - *) ext='1' ;; \ - esac; \ - inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ - inst=`echo $$inst | sed -e 's/^.*\///'`; \ - inst=`echo $$inst | sed '$(transform)'`.$$ext; \ - echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \ - rm -f "$(DESTDIR)$(man1dir)/$$inst"; \ - done -install-dist_i18nDATA: $(dist_i18n_DATA) - @$(NORMAL_INSTALL) - test -z "$(i18ndir)" || $(mkdir_p) "$(DESTDIR)$(i18ndir)" - @list='$(dist_i18n_DATA)'; for p in $$list; do \ - if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ - f=$(am__strip_dir) \ - echo " $(dist_i18nDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(i18ndir)/$$f'"; \ - $(dist_i18nDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(i18ndir)/$$f"; \ - done - -uninstall-dist_i18nDATA: - @$(NORMAL_UNINSTALL) - @list='$(dist_i18n_DATA)'; for p in $$list; do \ - f=$(am__strip_dir) \ - echo " rm -f '$(DESTDIR)$(i18ndir)/$$f'"; \ - rm -f "$(DESTDIR)$(i18ndir)/$$f"; \ - done -install-dist_imagesDATA: $(dist_images_DATA) - @$(NORMAL_INSTALL) - test -z "$(imagesdir)" || $(mkdir_p) "$(DESTDIR)$(imagesdir)" - @list='$(dist_images_DATA)'; for p in $$list; do \ - if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ - f=$(am__strip_dir) \ - echo " $(dist_imagesDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(imagesdir)/$$f'"; \ - $(dist_imagesDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(imagesdir)/$$f"; \ - done - -uninstall-dist_imagesDATA: - @$(NORMAL_UNINSTALL) - @list='$(dist_images_DATA)'; for p in $$list; do \ - f=$(am__strip_dir) \ - echo " rm -f '$(DESTDIR)$(imagesdir)/$$f'"; \ - rm -f "$(DESTDIR)$(imagesdir)/$$f"; \ - done -install-dist_pkgdataDATA: $(dist_pkgdata_DATA) - @$(NORMAL_INSTALL) - test -z "$(pkgdatadir)" || $(mkdir_p) "$(DESTDIR)$(pkgdatadir)" - @list='$(dist_pkgdata_DATA)'; for p in $$list; do \ - if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ - f=$(am__strip_dir) \ - echo " $(dist_pkgdataDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(pkgdatadir)/$$f'"; \ - $(dist_pkgdataDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(pkgdatadir)/$$f"; \ - done - -uninstall-dist_pkgdataDATA: - @$(NORMAL_UNINSTALL) - @list='$(dist_pkgdata_DATA)'; for p in $$list; do \ - f=$(am__strip_dir) \ - echo " rm -f '$(DESTDIR)$(pkgdatadir)/$$f'"; \ - rm -f "$(DESTDIR)$(pkgdatadir)/$$f"; \ - done - -# This directory's subdirectories are mostly independent; you can cd -# into them and run `make' without going through this Makefile. -# To change the values of `make' variables: instead of editing Makefiles, -# (1) if the variable is set in `config.status', edit `config.status' -# (which will cause the Makefiles to be regenerated when you run `make'); -# (2) otherwise, pass the desired values on the `make' command line. -$(RECURSIVE_TARGETS): - @failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ - dot_seen=no; \ - target=`echo $@ | sed s/-recursive//`; \ - list='$(SUBDIRS)'; for subdir in $$list; do \ - echo "Making $$target in $$subdir"; \ - if test "$$subdir" = "."; then \ - dot_seen=yes; \ - local_target="$$target-am"; \ - else \ - local_target="$$target"; \ - fi; \ - (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ - || eval $$failcom; \ - done; \ - if test "$$dot_seen" = "no"; then \ - $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ - fi; test -z "$$fail" - -mostlyclean-recursive clean-recursive distclean-recursive \ -maintainer-clean-recursive: - @failcom='exit 1'; \ - for f in x $$MAKEFLAGS; do \ - case $$f in \ - *=* | --[!k]*);; \ - *k*) failcom='fail=yes';; \ - esac; \ - done; \ - dot_seen=no; \ - case "$@" in \ - distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ - *) list='$(SUBDIRS)' ;; \ - esac; \ - rev=''; for subdir in $$list; do \ - if test "$$subdir" = "."; then :; else \ - rev="$$subdir $$rev"; \ - fi; \ - done; \ - rev="$$rev ."; \ - target=`echo $@ | sed s/-recursive//`; \ - for subdir in $$rev; do \ - echo "Making $$target in $$subdir"; \ - if test "$$subdir" = "."; then \ - local_target="$$target-am"; \ - else \ - local_target="$$target"; \ - fi; \ - (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ - || eval $$failcom; \ - done && test -z "$$fail" -tags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ - done -ctags-recursive: - list='$(SUBDIRS)'; for subdir in $$list; do \ - test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ - done - -ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ - mkid -fID $$unique -tags: TAGS - -TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) - tags=; \ - here=`pwd`; \ - if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ - include_option=--etags-include; \ - empty_fix=.; \ - else \ - include_option=--include; \ - empty_fix=; \ - fi; \ - list='$(SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ - test ! -f $$subdir/TAGS || \ - tags="$$tags $$include_option=$$here/$$subdir/TAGS"; \ - fi; \ - done; \ - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ - if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \ - test -n "$$unique" || unique=$$empty_fix; \ - $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ - $$tags $$unique; \ - fi -ctags: CTAGS -CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ - $(TAGS_FILES) $(LISP) - tags=; \ - here=`pwd`; \ - list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ - unique=`for i in $$list; do \ - if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ - done | \ - $(AWK) ' { files[$$0] = 1; } \ - END { for (i in files) print i; }'`; \ - test -z "$(CTAGS_ARGS)$$tags$$unique" \ - || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ - $$tags $$unique - -GTAGS: - here=`$(am__cd) $(top_builddir) && pwd` \ - && cd $(top_srcdir) \ - && gtags -i $(GTAGS_ARGS) $$here - -distclean-tags: - -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags - -distdir: $(DISTFILES) - $(am__remove_distdir) - mkdir $(distdir) - $(mkdir_p) $(distdir)/. $(distdir)/examples $(distdir)/i18n $(distdir)/images - @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 - list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ - test -d "$(distdir)/$$subdir" \ - || $(mkdir_p) "$(distdir)/$$subdir" \ - || exit 1; \ - distdir=`$(am__cd) $(distdir) && pwd`; \ - top_distdir=`$(am__cd) $(top_distdir) && pwd`; \ - (cd $$subdir && \ - $(MAKE) $(AM_MAKEFLAGS) \ - top_distdir="$$top_distdir" \ - distdir="$$distdir/$$subdir" \ - distdir) \ - || exit 1; \ - fi; \ - done - -find $(distdir) -type d ! -perm -777 -exec chmod a+rwx {} \; -o \ - ! -type d ! -perm -444 -links 1 -exec chmod a+r {} \; -o \ - ! -type d ! -perm -400 -exec chmod a+r {} \; -o \ - ! -type d ! -perm -444 -exec $(SHELL) $(install_sh) -c -m a+r {} {} \; \ - || chmod -R a+r $(distdir) -dist-gzip: distdir - tardir=$(distdir) && $(am__tar) | GZIP=$(GZIP_ENV) gzip -c >$(distdir).tar.gz - $(am__remove_distdir) -dist-bzip2: distdir - tardir=$(distdir) && $(am__tar) | bzip2 -9 -c >$(distdir).tar.bz2 - $(am__remove_distdir) - -dist-tarZ: distdir - tardir=$(distdir) && $(am__tar) | compress -c >$(distdir).tar.Z - $(am__remove_distdir) - -dist-shar: distdir - shar $(distdir) | GZIP=$(GZIP_ENV) gzip -c >$(distdir).shar.gz - $(am__remove_distdir) - -dist-zip: distdir - -rm -f $(distdir).zip - zip -rq $(distdir).zip $(distdir) - $(am__remove_distdir) - -dist dist-all: distdir - tardir=$(distdir) && $(am__tar) | GZIP=$(GZIP_ENV) gzip -c >$(distdir).tar.gz - tardir=$(distdir) && $(am__tar) | bzip2 -9 -c >$(distdir).tar.bz2 - $(am__remove_distdir) - -# This target untars the dist file and tries a VPATH configuration. Then -# it guarantees that the distribution is self-contained by making another -# tarfile. -distcheck: dist - case '$(DIST_ARCHIVES)' in \ - *.tar.gz*) \ - GZIP=$(GZIP_ENV) gunzip -c $(distdir).tar.gz | $(am__untar) ;;\ - *.tar.bz2*) \ - bunzip2 -c $(distdir).tar.bz2 | $(am__untar) ;;\ - *.tar.Z*) \ - uncompress -c $(distdir).tar.Z | $(am__untar) ;;\ - *.shar.gz*) \ - GZIP=$(GZIP_ENV) gunzip -c $(distdir).shar.gz | unshar ;;\ - *.zip*) \ - unzip $(distdir).zip ;;\ - esac - chmod -R a-w $(distdir); chmod a+w $(distdir) - mkdir $(distdir)/_build - mkdir $(distdir)/_inst - chmod a-w $(distdir) - dc_install_base=`$(am__cd) $(distdir)/_inst && pwd | sed -e 's,^[^:\\/]:[\\/],/,'` \ - && dc_destdir="$${TMPDIR-/tmp}/am-dc-$$$$/" \ - && cd $(distdir)/_build \ - && ../configure --srcdir=.. --prefix="$$dc_install_base" \ - $(DISTCHECK_CONFIGURE_FLAGS) \ - && $(MAKE) $(AM_MAKEFLAGS) \ - && $(MAKE) $(AM_MAKEFLAGS) dvi \ - && $(MAKE) $(AM_MAKEFLAGS) check \ - && $(MAKE) $(AM_MAKEFLAGS) install \ - && $(MAKE) $(AM_MAKEFLAGS) installcheck \ - && $(MAKE) $(AM_MAKEFLAGS) uninstall \ - && $(MAKE) $(AM_MAKEFLAGS) distuninstallcheck_dir="$$dc_install_base" \ - distuninstallcheck \ - && chmod -R a-w "$$dc_install_base" \ - && ({ \ - (cd ../.. && umask 077 && mkdir "$$dc_destdir") \ - && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" install \ - && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" uninstall \ - && $(MAKE) $(AM_MAKEFLAGS) DESTDIR="$$dc_destdir" \ - distuninstallcheck_dir="$$dc_destdir" distuninstallcheck; \ - } || { rm -rf "$$dc_destdir"; exit 1; }) \ - && rm -rf "$$dc_destdir" \ - && $(MAKE) $(AM_MAKEFLAGS) dist \ - && rm -rf $(DIST_ARCHIVES) \ - && $(MAKE) $(AM_MAKEFLAGS) distcleancheck - $(am__remove_distdir) - @(echo "$(distdir) archives ready for distribution: "; \ - list='$(DIST_ARCHIVES)'; for i in $$list; do echo $$i; done) | \ - sed -e '1{h;s/./=/g;p;x;}' -e '$${p;x;}' -distuninstallcheck: - @cd $(distuninstallcheck_dir) \ - && test `$(distuninstallcheck_listfiles) | wc -l` -le 1 \ - || { echo "ERROR: files left after uninstall:" ; \ - if test -n "$(DESTDIR)"; then \ - echo " (check DESTDIR support)"; \ - fi ; \ - $(distuninstallcheck_listfiles) ; \ - exit 1; } >&2 -distcleancheck: distclean - @if test '$(srcdir)' = . ; then \ - echo "ERROR: distcleancheck can only run from a VPATH build" ; \ - exit 1 ; \ - fi - @test `$(distcleancheck_listfiles) | wc -l` -eq 0 \ - || { echo "ERROR: files left in build directory after distclean:" ; \ - $(distcleancheck_listfiles) ; \ - exit 1; } >&2 -check-am: all-am -check: check-recursive -all-am: Makefile $(SCRIPTS) $(MANS) $(DATA) -installdirs: installdirs-recursive -installdirs-am: - for dir in "$(DESTDIR)$(bindir)" "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(i18ndir)" "$(DESTDIR)$(imagesdir)" "$(DESTDIR)$(pkgdatadir)"; do \ - test -z "$$dir" || $(mkdir_p) "$$dir"; \ - done -install: install-recursive -install-exec: install-exec-recursive -install-data: install-data-recursive -uninstall: uninstall-recursive - -install-am: all-am - @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am - -installcheck: installcheck-recursive -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-recursive - -clean-am: clean-generic mostlyclean-am - -distclean: distclean-recursive - -rm -f $(am__CONFIG_DISTCLEAN_FILES) - -rm -f Makefile -distclean-am: clean-am distclean-generic distclean-tags - -dvi: dvi-recursive - -dvi-am: - -html: html-recursive - -info: info-recursive - -info-am: - -install-data-am: install-dist_i18nDATA install-dist_imagesDATA \ - install-dist_pkgdataDATA install-man - -install-exec-am: install-binSCRIPTS - -install-info: install-info-recursive - -install-man: install-man1 - -installcheck-am: - -maintainer-clean: maintainer-clean-recursive - -rm -f $(am__CONFIG_DISTCLEAN_FILES) - -rm -rf $(top_srcdir)/autom4te.cache - -rm -f Makefile -maintainer-clean-am: distclean-am maintainer-clean-generic - -mostlyclean: mostlyclean-recursive - -mostlyclean-am: mostlyclean-generic - -pdf: pdf-recursive - -pdf-am: - -ps: ps-recursive - -ps-am: - -uninstall-am: uninstall-binSCRIPTS uninstall-dist_i18nDATA \ - uninstall-dist_imagesDATA uninstall-dist_pkgdataDATA \ - uninstall-info-am uninstall-man - -uninstall-info: uninstall-info-recursive - -uninstall-man: uninstall-man1 - -.PHONY: $(RECURSIVE_TARGETS) CTAGS GTAGS all all-am am--refresh check \ - check-am clean clean-generic clean-recursive ctags \ - ctags-recursive dist dist-all dist-bzip2 dist-gzip dist-shar \ - dist-tarZ dist-zip distcheck distclean distclean-generic \ - distclean-recursive distclean-tags distcleancheck distdir \ - distuninstallcheck dvi dvi-am html html-am info info-am \ - install install-am install-binSCRIPTS install-data \ - install-data-am install-dist_i18nDATA install-dist_imagesDATA \ - install-dist_pkgdataDATA install-exec install-exec-am \ - install-info install-info-am install-man install-man1 \ - install-strip installcheck installcheck-am installdirs \ - installdirs-am maintainer-clean maintainer-clean-generic \ - maintainer-clean-recursive mostlyclean mostlyclean-generic \ - mostlyclean-recursive pdf pdf-am ps ps-am tags tags-recursive \ - uninstall uninstall-am uninstall-binSCRIPTS \ - uninstall-dist_i18nDATA uninstall-dist_imagesDATA \ - uninstall-dist_pkgdataDATA uninstall-info-am uninstall-man \ - uninstall-man1 - - -texi2html: $(texi2html_SOURCES) - -translations.pl: texi2html.pl texi2html.init T2h_i18n.pm examples/roff.init \ - examples/noheaders.init i18n/de i18n/nl i18n/es i18n/no i18n/pt i18n/fr - $(PERL) $(srcdir)/manage_i18n.pl all -# 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/MySimple.pm b/Build/source/utils/texi2html/MySimple.pm deleted file mode 100644 index 75c25dc5d0d..00000000000 --- a/Build/source/utils/texi2html/MySimple.pm +++ /dev/null @@ -1,236 +0,0 @@ -package Getopt::MySimple; - -# Name: -# Getopt::MySimple. -# -# Documentation: -# POD-style (incomplete) documentation is in file MySimple.pod -# -# Tabs: -# 4 spaces || die. -# -# Author: -# Ron Savage rpsavage@ozemail.com.au. -# 1.00 19-Aug-97 Initial version. -# 1.10 13-Oct-97 Add arrays of switches (eg '=s@'). -# 1.20 3-Dec-97 Add 'Help' on a per-switch basis. -# 1.30 11-Dec-97 Change 'Help' to 'verbose'. Make all hash keys lowercase. -# 1.40 10-Nov-98 Change width of help report. Restructure tests. -# 1-Jul-00 Modifications for Texi2html - -# -------------------------------------------------------------------------- -# Locally modified by obachman (Display type instead of env, order by cmp) -# $Id: MySimple.pm,v 1.4 2004/02/10 00:12:42 pertusus Exp $ - -# use strict; -# no strict 'refs'; - -use vars qw(@EXPORT @EXPORT_OK @ISA); -use vars qw($fieldWidth $opt $VERSION); - -use Exporter(); -use Getopt::Long; - -@ISA = qw(Exporter); -@EXPORT = qw(); -@EXPORT_OK = qw($opt); # An alias for $self -> {'opt'}. - -# -------------------------------------------------------------------------- - -$fieldWidth = 20; -$VERSION = '1.41'; - -# -------------------------------------------------------------------------- - -sub byOrder -{ - my($self) = @_; - - return uc($a) cmp (uc($b)); -} - -# -------------------------------------------------------------------------- - -sub dumpOptions -{ - my($self) = @_; - - print 'Option', ' ' x ($fieldWidth - length('Option') ), "Value\n"; - - for (sort byOrder keys(%{$self -> {'opt'} }) ) - { - print "-$_", ' ' x ($fieldWidth - (1 + length) ), "${$self->{'opt'} }{$_}\n"; - } - - print "\n"; - -} # End of dumpOptions. - -# -------------------------------------------------------------------------- -# Return: -# 0 -> Error. -# 1 -> Ok. - -sub getOptions -{ - push(@_, 0) if ($#_ == 2); # Default for $ignoreCase is 0. - push(@_, 1) if ($#_ == 3); # Default for $helpThenExit is 1. - - my($self, $default, $helpText, $versionText, - $helpThenExit, $versionThenExit, $ignoreCase) = @_; - - $helpThenExit = 1 unless (defined($helpThenExit)); - $versionThenExit = 1 unless (defined($versionThenExit)); - $ignoreCase = 0 unless (defined($ignoreCase)); - - $self -> {'default'} = $default; - $self -> {'helpText'} = $helpText; - $self -> {'versionText'} = $versionText; - $Getopt::Long::ignorecase = $ignoreCase; - - unless (defined($self -> {'default'}{'help'})) - { - $self -> {'default'}{'help'} = - { - type => ':i', - default => '', - linkage => sub {$self->helpOptions($_[1]); sleep 5;exit (0) if $helpThenExit;}, - verbose => "print help and exit" - }; - } - - unless (defined($self -> {'default'}{'version'})) - { - $self -> {'default'}{'version'} = - { - type => '', - default => '', - linkage => sub {print $self->{'versionText'}; exit (0) if $versionThenExit;}, - verbose => "print version and exit" - }; - } - - for (keys(%{$self -> {'default'} }) ) - { - my $type = ${$self -> {'default'} }{$_}{'type'}; - push(@{$self -> {'type'} }, "$_$type"); - $self->{'opt'}->{$_} = ${$self -> {'default'} }{$_}{'linkage'} - if ${$self -> {'default'} }{$_}{'linkage'}; - } - - my($result) = &GetOptions($self -> {'opt'}, @{$self -> {'type'} }); - - return $result unless $result; - - for (keys(%{$self -> {'default'} }) ) - { - if (! defined(${$self -> {'opt'} }{$_})) #{ - { - ${$self -> {'opt'} }{$_} = ${$self -> {'default'} }{$_}{'default'}; - } - } - - $result; -} # End of getOptions. - -# -------------------------------------------------------------------------- - -sub helpOptions -{ - my($self) = shift; - my($noHelp) = shift; - $noHelp = 0 unless $noHelp; - my($optwidth, $typewidth, $defaultwidth, $maxlinewidth, $valind, $valwidth) - = (10, 5, 9, 78, 4, 11); - - print "$self->{'helpText'}" if ($self -> {'helpText'}); - - print ' Option', ' ' x ($optwidth - length('Option') -1 ), - 'Type', ' ' x ($typewidth - length('Type') + 1), - 'Default', ' ' x ($defaultwidth - length('Default') ), - "Description\n"; - - for (sort byOrder keys(%{$self -> {'default'} }) ) - { - my($line, $help, $option, $val); - $option = $_; - next if ${$self->{'default'} }{$_}{'noHelp'} && ${$self->{'default'} }{$_}{'noHelp'} > $noHelp; - #$line = " -$_" . ' ' x ($optwidth - (2 + length) ) . - # "${$self->{'default'} }{$_}{'type'} ". - # ' ' x ($typewidth - (1+length(${$self -> {'default'} }{$_}{'type'}) )); - $line = " --$_" . "${$self->{'default'} }{$_}{'type'}". - ' ' x ($typewidth - (1+length(${$self -> {'default'} }{$_}{'type'}) )); - - $val = ${$self->{'default'} }{$_}{'linkage'}; - if ($val) - { - if (ref($val) eq 'SCALAR') - { - $val = $$val; - } - else - { - $val = ''; - } - } - else - { - $val = ${$self->{'default'} }{$_}{'default'}; - } - $line .= "$val "; - $line .= ' ' x ($optwidth + $typewidth + $defaultwidth + 1 - length($line)); - - if (defined(${$self -> {'default'} }{$_}{'verbose'}) && - ${$self -> {'default'} }{$_}{'verbose'} ne '') - { - $help = "${$self->{'default'} }{$_}{'verbose'}"; - } - else - { - $help = ' '; - } - if ((length("$line") + length($help)) < $maxlinewidth) - { - print $line , $help, "\n"; - } - else - { - print $line, "\n", ' ' x $valind, $help, "\n"; - } - for $val (sort byOrder keys(%{${$self->{'default'}}{$option}{'values'}})) - { - print ' ' x ($valind + 2); - print $val, ' ', ' ' x ($valwidth - length($val) - 2); - print ${$self->{'default'}}{$option}{'values'}{$val}, "\n"; - } - } - - print <<EOT; -Note: 'Options' may be abbreviated. 'Type' specifications mean: - <none>| ! no argument: variable is set to 1 on -foo (or, to 0 on -nofoo) - =s | :s mandatory (or, optional) string argument - =i | :i mandatory (or, optional) integer argument -EOT -} # End of helpOptions. - -#------------------------------------------------------------------- - -sub new -{ - my($class) = @_; - my($self) = {}; - $self -> {'default'} = {}; - $self -> {'helpText'} = ''; - $self -> {'opt'} = {}; - $opt = $self -> {'opt'}; # An alias for $self -> {'opt'}. - $self -> {'type'} = (); - - return bless $self, $class; - -} # End of new. - -# -------------------------------------------------------------------------- - -1; - -# End MySimple.pm diff --git a/Build/source/utils/texi2html/MySimple.pod b/Build/source/utils/texi2html/MySimple.pod deleted file mode 100644 index 100f9759fcd..00000000000 --- a/Build/source/utils/texi2html/MySimple.pod +++ /dev/null @@ -1,187 +0,0 @@ -=head1 NAME - -C<Getopt::MySimple> - Provide a simple wrapper around Getopt::Long. -=head NOTE -Based on GetOpt::Simple, with some (here undocumented) modifications -to fit texi2hml needs. - -=head1 SYNOPSIS - - use Getopt::MySimple; - - # Or ... - # use Getopt::MySimple qw($opt); - - my($options) = - { - 'help' => - { - 'type' => '', - 'default' => '', -# 'verbose' => '', # Not needed on every key. - }, - 'username' => - { - 'type' => '=s', # As per Getopt::Long. - 'default' => $ENV{'USER'} || 'RonSavage', # In case $USER is undef. - 'verbose' => 'Specify the username on the remote machine', - }, - 'password' => - { - 'type' => '=s', - 'default' => 'password', - 'verbose' => 'Specify the password on the remote machine', - }, - }; - - my($option) = new Getopt::MySimple; - - if (! $option -> getOptions($options, "Usage: testMySimple.pl [options]") ) - { - exit(-1); # Failure. - } - - print "username: $option->{'opt'}{'username'}. \n"; - print "password: $option->{'opt'}{'password'}. \n"; - - # Or, after 'use Getopt::MySimple qw($opt);' ... - # print "username: $opt->{'username'}. \n"; - # print "password: $opt->{'password'}. \n"; - -=head1 DESCRIPTION - -The C<Getopt::MySimple> module provides a simple way of specifying: - -=over 4 - -=item * - -Command line optes - -=item * - -Type information for opt values - -=item * - -Default values for the optes - -=item * - -Help text per opt - -=back - -=head1 The C<getOptions()> function - -The C<getOptions()> function takes 4 parameters: - -=over 4 - -=item * - -A hash defining the command line optes - -=item * - -A string to display as a help text heading - -=item * - -A Boolean. 0 = (Default) Use case-sensitive opt names. 1 = Ignore case - -=item * - -A Boolean. 0 = Return after displaying help. 1 = (Default) Terminate with exit(0) -after displaying help - -=back - -=head1 The $classRef -> {'opt'} hash reference - -Command line option values are accessed in your code by dereferencing -the hash reference $classRef -> {'opt'}. Two examples are given above, -under synopsis. - -Alternately, you can use the hash reference $opt. See below. - -=head1 The $opt hash reference - -Command line option values are accessed in your code by dereferencing -the hash reference $opt. Two examples are given above, -under synopsis. - -Alternately, you can use the hash reference $classRef -> {'opt'}. See above. - -=head1 The C<dumpOptions()> function - -C<dumpOptions()> prints all your option's keys and their current values. - -=head1 The C<helpOptions()> function - -C<helpOptions()> prints nicely formatted help text. - -=head1 WARNING re Perl bug - -As always, be aware that these 2 lines mean the same thing, sometimes: - -=over 4 - -=item * - -$self -> {'thing'} - -=item * - -$self->{'thing'} - -=back - -The problem is the spaces around the ->. Inside double quotes, "...", the -first space stops the dereference taking place. Outside double quotes the -scanner correctly associates the $self token with the {'thing'} token. - -I regard this as a bug. - -=head1 REQUIRED MODULES - -=over 4 - -=item * - -Exporter - -=item * - -Getopt::Long - -=back - -=head1 RETURN VALUES - -=over 4 - -=item * - -C<dumpOptions()> returns nothing - -=item * - -C<helpOptions()> returns nothing - -=item * - -C<getOptions()> returns 0 for failure and 1 for success - -=back - -=head1 AUTHOR - -C<Getopt::MySimple> was written by Ron Savage I<E<lt>rpsavage@ozemail.com.auE<gt>> in 1997. - -Modifications for texi2html by Olaf Bachmann -I<E<lt>obachman@mathtematik.uni-kl.deE<gt>> in 2000. -=head1 LICENCE - -This program is free software; you can redistribute it and/or modify it under -the same terms as Perl itself. diff --git a/Build/source/utils/texi2html/NEWS b/Build/source/utils/texi2html/NEWS deleted file mode 100644 index 84b2aac7bae..00000000000 --- a/Build/source/utils/texi2html/NEWS +++ /dev/null @@ -1,399 +0,0 @@ -This file records noteworthy changes. - -1.76 (February 3 2005) - -* BUG FIXES - --------- - -* Perl no longer needs to be installed at build time, but when it is not, the - path to `perl' that will be used at run time must be passed to the - `configure' script. - -1.74 (January 31 2005) - -* COMPATIBILITY - ------------- - -* The argument on def like commands line (@deffn and friends) may be - bracketed, therefore there is no difference between this element and - others. There is no need of items with { in front in the %def_map - anymore. - -* NEW FEATURES - ------------ - -* More @-commands are available to the user, that were ignored before. - Most of these @-commands are those related with structure or printed - output. - -* BUG FIXES - --------- - -* many deffn and friends line parsing bugs fixed. - -1.72 (December 29 2004) - -* NEW FEATURES - ------------ - -* Handle texinfo 4.7 constructs: - @caption, @shortcaption, @ordf, @ordm, @registeredsymbol, @deftypecv, - @LaTeX, @indicateurl, @docbook, @ifdocbook, @ifnotdocbook, @comma, - @headitem, @quotation second arg, @acronym second arg. - @url is now a synonym for @uref. @ at the end of a @def* line continues the - line. - Handle texinfo 4.8 constructs: - @abbr, @slanted, @euro and @sansserif. -* Cross refs are done according to the specification presented in the texinfo - manual in the node HTML Xref. - -* BUG FIXES - --------- - -* Re enable compatibility with perl older that 5.6. - -1.70 (March 24 2004) - -* BUG FIXES - --------- - -* use i18n files even when translations.pl is not included. Include - translations.pl. - -* COMPATIBILITY - ------------- - -* install html manual in $datadir/texinfo/html. - -* NEW FEATURES - ------------ - -* Add a spec file, usefull to build a rpm. - -* FOR DEVELOPERS - -------------- - -* Standardized on Autoconf 2.59 & Automake 1.8.3 - -1.68 (March 20 2004) - -* COMPATIBILITY - ------------- - -* When the manual is split the default is to put resulting files in a - directory with name the manual file basename (previously they were left in - the current directory). To avoid that, call texi2html with '-output .'. - -* The main configuration files are now ./Config, ~/.texi2html/Config, - $sysconfdir/texi2html/Config and last $datadir/texi2html/Config. They are - sourced in that order. - In the future `/etc/texi2htmlrc' and `~/.texi2htmlrc' will no longer be - sourced and any existing site or user configuration should be moved to the - new locations if you wish it to be used by newer versions of Texi2HTML. - -* Translation files are now stored in $datadir/texi2html/i18n/*, - $sysconfdir/texi2html/i18n/*, ~/.texi2html/i18n/*, and sourced in that order. - The translated strings are now associated with the english strings. - Please see the documentation for the format of the new translation files. - -* First index page is the first page with a non empty index (with @printindex). - -* The glossary and bibliography terms aren't searched anymore. You should use - @macro to simulate these features (look at Tests/macros/glossary.texi for - an example). - -* We've standardized on GNU-style `--' prefixed long options, rather than the - old single-dash prefixed long options in the help, but the single-dash style - is still accepted on the command line for the time being. - We also changed `_' to `-' in option names. - -* @setref handling is removed as the right corresponding @-command is @anchor. - -* No more global variables outside of namespaces. - Global variables are now in the Texi2HTML namespace. - leading T2H_ is stripped from variable, hashes and array names. You should - change your variable names for the new release. As the global variables - (%THISDOC, $THIS_SECTION...) are in the Texi2HTML namespace you should use, - for example, $Texi2HTML::THISDOC{'fulltitle'} now. - functions from the main program should now be qualified in the main - namespace. t2h_ is stripped from the function names too. - t2h_anchor is now a function reference in init file, and thus should - be called like &$anchor(...). - toc file and main file are arguments for print_frame, overview lines are - arguments for print_toc_frame (instead of global variables). - -* $THISPROG, $T2H_HOMEPAGE, $T2H_AUTHORS, $T2H_TODAY, $T2H_USER are now - values associated with the following keys in %Texi2HTML::THISDOC: - `program', `program_homepage', `today', `user'. - -* Changes in the function reference used for the page layout: - print_section don't do the end of page or section anymore (except when - split at node), end_section does the end of a section, and print_*_footer - does the end of page. - the print_*_header, print_*_footer... functions take a ref on the buttons - array as argument, instead of using the $T2H_BUTTONS global variable. - Have a look at the texi2html.init file to update your configuration files. - -* T2H_InitGlobals is not used anymore. Use the function reference init_out - to define $BODYTEXT dynamically and %Texi2HTML::THISDOC values in - print_page_foot and about_body to recreate the address instead of the - $T2H_ADDRESS. - You can have a look at program_string in texi2html.init which recreates - the address. $T2H_ADDRESS isn't used anymore. - -* variables for latex2html are not in texi2html init file anymore but in - l2h.init. - -* don't expand @ifinfo regions by default. - -* option --output obsoletes -out_file and -subdir. It is the same than - --out_file when output is not split, and the same than --subdir when it is - split. - -* If not split, the resulting file has a leading directory, and the directory - doesn't exist, it is created. - -* If a directory creation fails the program aborts. - -* Don't use T2H_CENTER_IMAGE, @center should be used. - -* the init_out function redefines dynamically %NAVIGATION_TEXT, %BUTTONS_GOTO - and $BODYTEXT. You should redefine the hash values in that function. If you - want to reuse the values of the default values set by init_out, - you could do something like: - - 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; - } - -* NEW FEATURES - ------------ - -* Many changes towards output of stricter HTML. - -* initialization files for html 3.2, xhtml, html 4.0 with inline style, - no header, utf8 characters outputted, makeinfo style, book style, conversion - to chm files and conversion to roff. Initialization files are searched - in ./, ~/.texi2html, $sysconfdir/texi2html and last $datadir/texi2html. - The file names are html32.init, xhtml.init, inlinestyle.init, - noheaders.init, utf8.init, makeinfo.init, book.init, chm.init and roff.init. - -* The test suite is much more comprehensive and uses validate and tidy to - assess the correctness of the HTML. - -* Handling of @html, @verbatim, @verb, @sp, @=, @copying, @insertcopying, - @cartouche, @titlefont, @dircategory, @direntry, @shorttitlepage, @\, - @afourlatex, @afourwide, @firstparagraphindent, @exampleindent, @novalidate, - @definfoenclose, @kbdinputstyle, @centerchap, @documentdescription, - @documentencoding, @contents, @shortcontents, @verbatiminclude. - -* With --no-validate node cross-reference validation is suppressed (like - @novalidate). - -* --expand may be specified more than once such that more than one additional - region could be expanded. --noexpand does the reverse. --iftex, --ifinfo... - and --no-ifinfo... can be used instead. - -* add http-equiv="Content-Type" tag for the charset declaration. - -* HTML formatting is isolated in customizable functions located in the - initialization files. - -* menu comments are in a preformatted context. - -* Any combination of caps for `top' leads to the top node. - -* @ref{(perl)Top} leads to a ref to the info manual. - -* References to external manual in @ref and menus are links to the html - pages (with the same convention than makeinfo --html use). - --html-xref-prefix is the base dir for external manual references. - -* With --node-files do a file per node which can be used as a target for - cross references from other manuals (including manuals generated with - makeinfo --html). - -* With --use-nodes nodes are sectionning commands whe they are not associated - with a structuring command. - -* With --toc-links create links from headings to toc entries. - -* distinct directions (next, prev...) for nodes and sections, more directions. - -* split at chapter, section or for every node. - -* new possibilities for buttons. If this is a ref to a scalar, the text - appears in navigation. If it is an array, the first element is a direction - used for the href, the second element is a scalar ref for the text. - -* With --noseparated-footnotes the footnotes are in the same page than the - text. - -* %NO_TEXI hash similar with %HREF but without texinfo commands, - %THISDOC{'title_no_texi'} - -* "-U value" does the same than "@clear value". - -* -P option prepends directory for include files before the document directory. - -* -macro-expand generates a file with expanded macros and @include. - -* pass $L2H_HTML_VERSION for the html version to latex2html. - -* support for css. The --css-include option does the same than in makeinfo - (parse the file, and echo the @import part before the texi2html css rules, - the rules part after the texi2html css rules). - The texi2html css commands may be customized too. - -* Text before the first @node or sectionning command is part of the first - section unless -ignore-preamble-text is set. - -* if `-' is given to the -output option, output on STDOUT. - -* Add images from the Singular project. - -* All the strings appearing in the HTML are internationalized. - -* centering and flushing is really handled. - -* Format titlepage (even though the formatted text isn't used by default). - -* Handle all the encodings perl knows about. - -* BUG FIXES - --------- - -* @multitable size determination, out of bounds columns ignored. - -* In @table and @itemize, @item is replaced by the @-command argument. - -* nested @-commands are better handled. - -* in index keys @-commands are replaced by the right symbols. - -* files are omitted in hrefs when they points to the same file. - -* $value{_title}... are expanded during HTML generation. - -* @H{a} leads to a'' and not á - -* cedilla are accepted in node names. - -* Any characters are accepted in menu comments. - -* frame target is the top file, and not the toc file. - -* rewriting of the @macro code completely. This likely fixed some bugs but - this hasn't been verified by running the new, more complex test cases - against the old code. - -* rewriting of the document structure resolution. - unnumbered regions are at the right level and splitted indices don't break - the document structure anymore. - index entries and footnotes are more precisely located. - -* @-commands ignored are ignored with the line, the arg or following spaces - like makeinfo does. - -* FOR DEVELOPERS - -------------- - -* Standardized on Autoconf 2.59 & Automake 1.8.2 - -* The --enable-maintainer-mode option is now required by configure to enable - what is considered the maintainer-specific portions of Makefiles. This - includes the portions which automatically rebuild the configure and build - files (configure, aclocal, Makefile.in, etc) when configure.in or other - dependencies are changed. - -* The config is in the Texi2HTML::Config namespace. The latex2html related - functions are in the Texi2HTML::LaTeX2HTML namespace. The - internationalization functions are in the Texi2HTML::I18n namespace in - T2h_i18n.pm. - -1.66 (June 8 2002) -* Many bug fixes. - -1.65 (August 26 2001) -* Many bug fixes. -* The operation of the previously broken << (FastBack) and >> (FastForward) - buttons has changed slightly. FastBack now returns to the beginning of the - current chapter and FastForward now jumps to the beginning of the next - chapter. - -1.64 (July 3 2000) -* Incorporated first version of Texi2html Texinfo manual, authored by - Karl Heinz Marbaise <khmarbaise@gmx.de> -* New handling of command line options: - - can be abbreviated to shortest unique prefix - -help now works and is up-to-date - -1.63 (June 23 2000) -* New customization variable: - $T2H_HREF_DIR_INSTEAD_FILE: - if set (e.g., to index.html) replace hrefs to this file - (i.e., to index.html) by ./ -* New command-line option: - -toc_file FILE - for those who want the TOC to be in FILE -* bug fixes related to macro invocation - -1.62 (12 April 2000) -* New customization variables: - $T2H_SPLIT_INDEX [default: = 100] - index pages are split at next letter, if more than that many entries - $T2H_NODE_NAME_IN_MENU [default = 0] - for enforcing node names in meny entries - $T2H_AVOID_MENU_REDUNDANCY [default = 1] - to avoid display of duplicate meny entry information - $T2H_INDEX_CHAPTER [default = ''] - if set, use chapter of this name for 'Index' Button in - navigation bars, else use first chapter whose name matches - "index" (case insensitive). - $T2H_TOP_HEADING [ default = ''] - if non-empty, and no heading is in Top node, then use this as heading - for top node/section; otherwise, use @settitle, @shorttitle. -* index generation: observes typesetting in fixed-width font, @ftable, - @vtable implemented -* Peter Moulder & Teun Burgers: Misc documentation and distribution - changes -* numerous small bugs fixed (handling of menu entries, paragraphs in - lists/tables, etc). - - -1.61 (31 March 2000) -* By default, $T2H_TOP_FILE is not set, and so $docu_name.html is used. -* Added T2H_print_chapter_header, T2H_print_chapter_footer for more - fine-grained control of T2H_SPLIT eq 'chapter', added option - -section_navigation, $T2H_SECTION_NAVIGATION to supress output of - navigation panels per section -* naming scheme and calling convention of customizable subs changed: - prefix T2H_, call &$T2H_, assignment $T2H_<name> = \&T2H_DEFAULT_<name> -* mailinglist created: texi2html@mathematik.uni-kl.de -* conversion to standard gnu package with Makefile.am, README, - AUTHORS, etc. (Peter Moulder <reiter@netspace.net.au>) -* Initialization as suggested by Peter Moulder: - 1. /usr/local/etc/texi2htmlrc (or whatever given by --sysconfdir to - configure) - 2. $HOME/.texi2htmlrc - 3. command-line options, including -init_file - where later options override previous ones. -* incoporated patches from Peter Moulder (backward-compatible - command-line options, separate man-page, etc). -* Automatic node pointer creation added -* @enddots, @exclamdown, @pounds, and relatives added. - -Major Changes from 1.58 to 1.60 -* primitve foreign language support -* support of all "Umlaute" -* anchors, macros -* latex2html incooperation -* customizable page layout (texi2html.init) -* index as table with corresponding sections - - diff --git a/Build/source/utils/texi2html/README b/Build/source/utils/texi2html/README deleted file mode 100644 index ee5a2027ec1..00000000000 --- a/Build/source/utils/texi2html/README +++ /dev/null @@ -1,113 +0,0 @@ -This is the README file for the GNU texi2html distribution. -The primary distribution point is -http://texi2html.cvshome.org/servlets/ProjectDownloadList - -For generic installation instructions on compiling and installing this -Automake-based distribution, please read the file `INSTALL'. -Installation notes specific to Texi2html: -* Installation is fairly simple, no compilers are required. -* You need to have perl version 5 or higher installed on your system - to run 'texi2html'. -* To generate Makefile.in etc., run `./autogen.sh' - -This distribution includes the following files, among others: - README This file. - - NEWS Summary of new features by release. - - INTRODUCTION Brief introduction to texi2html and - its usage. - - INSTALL Generic installation instructions. - - TODO Things which are yet to be done. - -Texi2html source files: - - texi2html Actual script to run. Generated by - 'configure' from texi2html.pl, - texi2html.init, MySimple.pm, T2h_i18n.pm, - l2h.init and translations.pl. - - texi2html.pl Main source file of the converter. - - texi2html.init Default values of configurable - parameters. `configure' inserts this - file into texi2html.pl when it generates - the actual `texi2html' script. - - MySimple.pm Perl module which handles the - processing of command-line options. - `configure' inserts this file into - texi2html.pl when it generates - the actual `texi2html' script. - - T2h_i18n.pm Code used to handle strings - internationalization. - - translations.pl translations of strings generated by - the script `manage_i18n.pl' from source - files and files in the `i18n' directory. - - l2h.init default configuration file for `latex2html' - used to convert maths and TeX. - - i18n/ Directory containing one file per language - with translation of strings. - -Helper scripts - - manage_i18n.pl Helper script used to regenerate translations - from the source files and the files in the - `i18n/' directory. - -Documentation files: - - texi2html.texi Texinfo manual of texi2html. This - manual is currently under construction. - - texi2html.1.in Template for generation of man pages - of texi2html (`texi2html.1'). This man - page is incomplete. - -Installation files: - - configure This file creates creates a Makefile - which in turn creates an `info' or - `makeinfo' executable, or a C sources - distribution. - - configure.in This is a template for creating - `configure' using Autoconf. - - Makefile.in This is a template for `configure' - to use to make a Makefile. Created by - Automake. - - Makefile.am This is a template for Automake - to use to make a Makefile.in. - - -WWW home page: -http://texi2html.cvshome.org - -Mailing lists: -- users@texi2html.cvshome.org for enhancement suggestions, - authoring questions and general discussion. - to subscribe to this mailinglist, visit - http://texi2html.cvshome.org/servlets/ProjectMailingListList - or send mail to users-subscribe@texi2html.cvshome.org . -- dev@texi2html.cvshome.org for bug reports, patches, discussions - about code. -There are no corresponding newsgroups. - -For bug reports, please include enough information for the maintainers -to reproduce the problem. Generally speaking, that means: -- the version number of Texi2html and the program(s) involved (use --version). -- the contents of any input files necessary to reproduce the bug (crucial!). -- a description of the problem and any samples of the erroneous output. -- anything else that you think would be helpful. - -Patches are most welcome; if possible, please make them against the -source files (e.g., against texi2html.pl, or texi2html.init) with -`diff -c' or `diff -u' and include ChangeLog entries. diff --git a/Build/source/utils/texi2html/T2h_i18n.pm b/Build/source/utils/texi2html/T2h_i18n.pm deleted file mode 100644 index 2ea77ddb930..00000000000 --- a/Build/source/utils/texi2html/T2h_i18n.pm +++ /dev/null @@ -1,400 +0,0 @@ -#+############################################################################## -# -# T2h_i18n.pm: Internationalization for texi2html -# -# Copyright (C) 1999, 2000 Free Software Foundation, Inc. -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, 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 -# -#-############################################################################## - -# This requires perl version 5 or higher -require 5.0; - -package Texi2HTML::I18n; - -use strict; - -use vars qw( -@ISA -@EXPORT -); - -use Exporter; -@ISA = qw(Exporter); -@EXPORT = qw(pretty_date); - -my $language; -my $i18n_dir = 'i18n'; # name of the directory containing the per language files -#my $translation_file = 'translations.pl'; # file containing all the translations -#my @known_languages = ('de', 'nl', 'es', 'no', 'pt', 'fr'); # The supported - # languages - -######################################################################## -# Language dependencies: -# To add a new language extend the WORDS hash and create $T2H_<...>_WORDS hash -# To redefine one word, simply do: -# $T2h_i18n::T2H_LANGUAGES->{<language>}->{<word>} = 'whatever' in your personal init file. -# -my $T2H_WORDS_EN = -{ - # titles of pages - #'Table of Contents' => 'Table of Contents', - #'Short Table of Contents' => 'Short Table of Contents', - #'Index' => 'Index', - #'About This Document' => 'About This Document', - #'Footnotes' => 'Footnotes', - #'See' => 'See', - #'see' => 'see', - #'section' => 'section', - 'About This Document' => '', - 'Table of Contents' => '', - 'Short Table of Contents', => '', - 'Index' => '', - 'Footnotes' => '', - 'See' => '', - 'see' => '', - 'section' => '', - 'Top' => '', - 'Untitled Document' => '', - # If necessary, we could extend this as follows: - # # text for buttons - # 'Top_Button' => 'Top', - # 'ToC_Button' => 'Contents', - # 'Overview_Button' => 'Overview', - # 'Index_button' => 'Index', - # 'Back_Button' => 'Back', - # 'FastBack_Button' => 'FastBack', - # 'Prev_Button' => 'Prev', - # 'Up_Button' => 'Up', - # 'Next_Button' => 'Next', - # 'Forward_Button' =>'Forward', - # 'FastWorward_Button' => 'FastForward', - # 'First_Button' => 'First', - # 'Last_Button' => 'Last', - # 'About_Button' => 'About' - 'January' => '', - 'February' => '', - 'March' => '', - 'April' => '', - 'May' => '', - 'June' => '', - 'July' => '', - 'August' => '', - 'September' => '', - 'October' => '', - 'November' => '', - 'December' => '', - 'T2H_today' => '%s, %d %d', -}; - -my $T2H_WORDS_DE = -{ - 'Table of Contents' => 'Inhaltsverzeichniss', - 'Short Table of Contents' => 'Kurzes Inhaltsverzeichniss', - 'Index' => 'Index', - 'About This Document' => 'Über dieses Dokument', - 'Footnotes' => 'Fußnoten', - 'See' => 'Siehe', - 'see' => 'siehe', - 'section' => 'Abschnitt', - 'January' => 'Januar', - 'February' => 'Februar', - 'March' => 'März', - 'April' => 'April', - 'May' => 'Mai', - 'June' => 'Juni', - 'July' => 'Juli', - 'August' => 'August', - 'September' => 'September', - 'October' => 'Oktober', - 'November' => 'November', - 'December' => 'Dezember', -}; - -my $T2H_WORDS_NL = -{ - 'Table of Contents' => 'Inhoudsopgave', - 'Short Table of Contents' => 'Korte inhoudsopgave', - 'Index' => 'Index', #Not sure ;-) - 'About This Document' => 'No translation available!', #No translation available! - 'Footnotes' => 'No translation available!', #No translation available! - 'See' => 'Zie', - 'see' => 'zie', - 'section' => 'sectie', - 'January' => 'Januari', - 'February' => 'Februari', - 'March' => 'Maart', - 'April' => 'April', - 'May' => 'Mei', - 'June' => 'Juni', - 'July' => 'Juli', - 'August' => 'Augustus', - 'September' => 'September', - 'October' => 'Oktober', - 'November' => 'November', - 'December' => 'December', -}; - -my $T2H_WORDS_ES = -{ - 'Table of Contents' => 'índice General', - 'Short Table of Contents' => 'Resumen del Contenido', - 'Index' => 'Index', #Not sure ;-) - 'About This Document' => 'No translation available!', #No translation available! - 'Footnotes' => 'Fußnoten', - 'See' => 'Véase', - 'see' => 'véase', - 'section' => 'sección', - 'January' => 'enero', - 'February' => 'febrero', - 'March' => 'marzo', - 'April' => 'abril', - 'May' => 'mayo', - 'June' => 'junio', - 'July' => 'julio', - 'August' => 'agosto', - 'September' => 'septiembre', - 'October' => 'octubre', - 'November' => 'noviembre', - 'December' => 'diciembre', -}; - -my $T2H_WORDS_NO = -{ - 'Table of Contents' => 'Innholdsfortegnelse', - 'Short Table of Contents' => 'Kort innholdsfortegnelse', - 'Index' => 'Indeks', #Not sure ;-) - 'About This Document' => 'No translation available!', #No translation available! - 'Footnotes' => 'No translation available!', - 'See' => 'Se', - 'see' => 'se', - 'section' => 'avsnitt', - 'January' => 'januar', - 'February' => 'februar', - 'March' => 'mars', - 'April' => 'april', - 'May' => 'mai', - 'June' => 'juni', - 'July' => 'juli', - 'August' => 'august', - 'September' => 'september', - 'October' => 'oktober', - 'November' => 'november', - 'December' => 'desember', -}; - -my $T2H_WORDS_PT = -{ - 'Table of Contents' => 'Sumário', - 'Short Table of Contents' => 'Breve Sumário', - 'Index' => 'Índice', #Not sure ;-) - 'About This Document' => 'No translation available!', #No translation available! - 'Footnotes' => 'No translation available!', - 'See' => 'Veja', - 'see' => 'veja', - 'section' => 'Seção', - 'January' => 'Janeiro', - 'February' => 'Fevereiro', - 'March' => 'Março', - 'April' => 'Abril', - 'May' => 'Maio', - 'June' => 'Junho', - 'July' => 'Julho', - 'August' => 'Agosto', - 'September' => 'Setembro', - 'October' => 'Outubro', - 'November' => 'Novembro', - 'December' => 'Dezembro', -}; - -my $T2H_WORDS_FR = -{ - 'Table of Contents' => 'Table des matières', - 'Short Table of Contents' => 'Résumée du contenu', - 'Index' => 'Index', - 'About This Document' => 'A propos de ce document', - 'Footnotes' => 'Notes de bas de page', - 'See' => 'Voir', - 'see' => 'voir', - 'section' => 'section', - 'January' => 'Janvier', - 'February' => 'Février', - 'March' => 'Mars', - 'April' => 'Avril', - 'May' => 'Mai', - 'June' => 'Juin', - 'July' => 'Juillet', - 'August' => 'Août', - 'September' => 'Septembre', - 'October' => 'Octobre', - 'November' => 'Novembre', - 'December' => 'Décembre', - 'T2H_today' => 'le %2$d %1$s %3$d' -}; - -#$T2H_LANGUAGES = -#{ -# 'en' => $T2H_WORDS_EN, -# 'de' => $T2H_WORDS_DE, -# 'nl' => $T2H_WORDS_NL, -# 'es' => $T2H_WORDS_ES, -# 'no' => $T2H_WORDS_NO, -# 'pt' => $T2H_WORDS_PT, -# 'fr' => $T2H_WORDS_FR, -#}; - -sub set_language($) -{ - my $lang = shift; - if (defined($lang) && exists($Texi2HTML::Config::LANGUAGES->{$lang}) && defined($Texi2HTML::Config::LANGUAGES->{$lang})) - { - $language = $lang; - return 1; - } - else - { - return 0; - } -} - - -my @MONTH_NAMES = - ( - 'January', 'February', 'March', 'April', 'May', - 'June', 'July', 'August', 'September', 'October', - 'November', 'December' - ); - -my $I = \&get_string; - -sub pretty_date($) -{ - my $lang = shift; - my($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst); - - ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = localtime(time); - $year += ($year < 70) ? 2000 : 1900; - # obachman: Let's do it as the Americans do - #return($MONTH_NAMES->{$lang}[$mon] . ", " . $mday . " " . $year); - #return(sprintf(&$I('T2H_today'), (get_string($MONTH_NAMES[$mon]), $mday, $year))); - return &$I('%{month}, %{day} %{year}', { 'month' => get_string($MONTH_NAMES[$mon]), - 'day' => $mday, 'year' => $year }); -} - -my $error_no_en = 0; -sub get_string($;$$) -{ - my $string = shift; - my $arguments = shift; - my $state = shift; - my $T2H_LANGUAGES = $Texi2HTML::Config::LANGUAGES; - if (! exists($T2H_LANGUAGES->{'en'})) - { - unless($error_no_en) - { - print STDERR "i18n: no LANGUAGES->{'en'} hash\n"; - $error_no_en = 1; - } - } - else - { - print STDERR "i18n: missing string $string\n" unless (exists ($T2H_LANGUAGES->{'en'}->{$string})); - if (defined ($T2H_LANGUAGES->{$language}->{$string}) and - ($T2H_LANGUAGES->{$language}->{$string} ne '')) - { - $string = $T2H_LANGUAGES->{$language}->{$string}; - } - elsif (defined ($T2H_LANGUAGES->{'en'}->{$string}) and - ($T2H_LANGUAGES->{'en'}->{$string} ne '')) - { - $string = $T2H_LANGUAGES->{'en'}->{$string}; - } - } - return main::substitute_line($string, $state) unless (defined($arguments) or !keys(%$arguments)); - my $result = ''; - while ($string) - { - if ($string =~ s/^([^%]*)%//) - { - $result .= $1 if (defined($1)); - $result .= '%'; - if ($string =~ s/^%//) - { - $result .= '%'; - } - elsif ($string =~ /^\{(\w+)\}/ and exists($arguments->{$1})) - { - $string =~ s/^\{(\w+)\}//; - if (!$state->{'keep_texi'}) - { - $result .= "\@\{$1\@\}"; - } - else - { - $result .= "\{$1\}"; - } - } - else - { - $result .= '%'; - } - next; - } - else - { - $result .= $string; - last; - } - } - if (!$state->{'keep_texi'}) - { - $string = main::substitute_line($result, $state); - } - else - { - $string = $result; - } - $result = ''; - while ($string) - { - if ($string =~ s/^([^%]*)%//) - { - $result .= $1 if (defined($1)); - if ($string =~ s/^%//) - { - $result .= '%'; - } - elsif ($string =~ /^\{(\w+)\}/ and exists($arguments->{$1})) - { - $string =~ s/^\{(\w+)\}//; - $result .= $arguments->{$1}; - } - else - { - $result .= '%'; - } - next; - } - else - { - $result .= $string; - last; - } - } - return $result; -} - -1; diff --git a/Build/source/utils/texi2html/TODO b/Build/source/utils/texi2html/TODO deleted file mode 100644 index 21047c62a82..00000000000 --- a/Build/source/utils/texi2html/TODO +++ /dev/null @@ -1,89 +0,0 @@ -This file contains a list of things yet to be done (see also in doc/IDEAS): - -* Create detailed texinfo documentation (see in doc) - -* add sample init files for different layouts - - use events (onmousover, etc) for anchors - - use style-sheets for formatting of various elements (like @example, - etc). - - xhtml with in line style - - Singular manual style - - How complicated could it be to get a creation of XML, what about SGML ? - -* document css classes, and have similar classes with makeinfo -- makeinfo classes: -ul menu, -ul index-cp index-*, -div node (navigation bar), - -- texi2html classes: -table index-cp index-*, -table menu, -h3 node -ul toc, - -- same classes: -pre verbatim, -pre example display..., -table cartouche, -small dots, small enddots, -div contents shortcontents, div footnote, -h? unnumbered chapter appendix..., -h1 settitle (title before contents, if not set by titlefont), -h1 titlefont (@titlefont), - -* use <link> for navigation, maybe wait before this is done in makeinfo -(see http://www.w3.org/TR/REC-html40/types.html#h-6.12 and -http://www.w3.org/TR/REC-html40/struct/links.html#h-12.3.3) - -* Document Texi2HTML::THIS_ELEMENT - -* Document $NEW_CROSSREF_STYLE, $EXTERNAL_CROSSREF_SPLIT, - $Texi2HTML::THISDOC{'htmlxref'} - -* Test the back path stuff for images. - -* Test refs with no unicode support. - Test for @ commands in refs, and refs in ascii 8 bit/utf8 manuals. - -* add a configure switch --with-encode - -* don't double in title when the @top and @settitle are the same - -* handle right things like --> error with @item on same line than @table -@xref{node, -@table @emph -@item line -text -@end table -} - -@code{ -@printindex cp -} - -* maybe some @-commands appearing on lines should stop paragraphs, namely -@page. That's not sure. Maybe this should be up to the writer to add -a line. - -* handle better things like -@itemize @bullet -@cindex example -@item -In the example -@end itemize - -* @m_cedilla appears in output with --macro-expand. That's a bug. - -* in chm.init (Jose Fonseca) - -[WINDOWS] - -Default=,"ug.hhc","ug.hhk","ug.html","ug.html",,,,,0x22520,,0x384e,,,,,,,,0 - -The numbers are a bitmask of the enabled buttons. The ones here are -IMO a good default. In the future you may also add that as an -option, as the Docbook XSL stylesheets do (see in -http://docbook.sourceforge.net/release/xsl/snapshot/doc/html/rn20.html -all the CHM related parameters one can change). diff --git a/Build/source/utils/texi2html/Tests/Makefile.am b/Build/source/utils/texi2html/Tests/Makefile.am deleted file mode 100644 index 657754722cc..00000000000 --- a/Build/source/utils/texi2html/Tests/Makefile.am +++ /dev/null @@ -1,24 +0,0 @@ -SUBDIR_TESTS = GermanNodeTest xemacs texinfo sectionning ccvs viper \ - viper_monolithic texi2html xemacs_frame index_table formatting macros \ - nodes_texinfo singular floats - - -#check-local: -# $(srcdir)/test.sh - -regenerate: - for dir in ${SUBDIR_TESTS}; do \ - [ -d $${dir}_res ] && cp $$dir/*.passfirst $$dir/*.html $$dir/*.htm $$dir/*.2 $$dir/*.passtexi $${dir}_res;\ - done - -clean-local: - for dir in ${SUBDIR_TESTS}; do \ - (if [ -d $$dir ]; then cd $$dir && $(RM) -- $$dir $$dir-* *.toc *.aux *.log *.op *.cp *.cps \ - *.fn *.fns *.ky *.kys *.pg *.pgs *.tp *.tps *.vr *.vrs \ - *.dvi *.html *.htm *.info *.info-? *.info-?? *.info-??? *.html_tempnotag \ - *.2 *.passfirst *.passtexi \ - *_?.png *_??.png *_???.png *_l2h_img?.old *_l2h_img??.old *_l2h_img???.old \ - *_l2h_img?.png *_l2h_img??.png *_l2h_img???.png \ - *_l2h.tex *_l2h.css *_l2h_images.pl *_l2h_images.tex \ - *_l2h_labels.pl l2h_cache.pm; fi) ; \ - done diff --git a/Build/source/utils/texi2html/Tests/Makefile.in b/Build/source/utils/texi2html/Tests/Makefile.in deleted file mode 100644 index f4e484829a9..00000000000 --- a/Build/source/utils/texi2html/Tests/Makefile.in +++ /dev/null @@ -1,299 +0,0 @@ -# Makefile.in generated by automake 1.9.6 from Makefile.am. -# @configure_input@ - -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005 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 = Tests -DIST_COMMON = README $(srcdir)/Makefile.am $(srcdir)/Makefile.in -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 = -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@ -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@ -datarootdir = @datarootdir@ -docdir = @docdir@ -dvidir = @dvidir@ -exec_prefix = @exec_prefix@ -host = @host@ -host_alias = @host_alias@ -host_cpu = @host_cpu@ -host_os = @host_os@ -host_vendor = @host_vendor@ -htmldir = @htmldir@ -includedir = @includedir@ -infodir = @infodir@ -install_sh = @install_sh@ -libdir = @libdir@ -libexecdir = @libexecdir@ -localedir = @localedir@ -localstatedir = @localstatedir@ -mandir = @mandir@ -mkdir_p = @mkdir_p@ -oldincludedir = @oldincludedir@ -pdfdir = @pdfdir@ -prefix = @prefix@ -program_transform_name = @program_transform_name@ -psdir = @psdir@ -sbindir = @sbindir@ -sharedstatedir = @sharedstatedir@ -sysconfdir = @sysconfdir@ -target_alias = @target_alias@ -SUBDIR_TESTS = GermanNodeTest xemacs texinfo sectionning ccvs viper \ - viper_monolithic texi2html xemacs_frame index_table formatting macros \ - nodes_texinfo singular floats - -all: all-am - -.SUFFIXES: -$(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 Tests/Makefile'; \ - cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu Tests/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 -uninstall-info-am: -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 -check-am: all-am -check: check-am -all-am: Makefile -installdirs: -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 clean-local mostlyclean-am - -distclean: distclean-am - -rm -f Makefile -distclean-am: clean-am distclean-generic - -dvi: dvi-am - -dvi-am: - -html: html-am - -info: info-am - -info-am: - -install-data-am: - -install-exec-am: - -install-info: install-info-am - -install-man: - -installcheck-am: - -maintainer-clean: maintainer-clean-am - -rm -f Makefile -maintainer-clean-am: distclean-am maintainer-clean-generic - -mostlyclean: mostlyclean-am - -mostlyclean-am: mostlyclean-generic - -pdf: pdf-am - -pdf-am: - -ps: ps-am - -ps-am: - -uninstall-am: uninstall-info-am - -.PHONY: all all-am check check-am clean clean-generic clean-local \ - 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 installcheck installcheck-am \ - installdirs maintainer-clean maintainer-clean-generic \ - mostlyclean mostlyclean-generic pdf pdf-am ps ps-am uninstall \ - uninstall-am uninstall-info-am - - -#check-local: -# $(srcdir)/test.sh - -regenerate: - for dir in ${SUBDIR_TESTS}; do \ - [ -d $${dir}_res ] && cp $$dir/*.passfirst $$dir/*.html $$dir/*.htm $$dir/*.2 $$dir/*.passtexi $${dir}_res;\ - done - -clean-local: - for dir in ${SUBDIR_TESTS}; do \ - (if [ -d $$dir ]; then cd $$dir && $(RM) -- $$dir $$dir-* *.toc *.aux *.log *.op *.cp *.cps \ - *.fn *.fns *.ky *.kys *.pg *.pgs *.tp *.tps *.vr *.vrs \ - *.dvi *.html *.htm *.info *.info-? *.info-?? *.info-??? *.html_tempnotag \ - *.2 *.passfirst *.passtexi \ - *_?.png *_??.png *_???.png *_l2h_img?.old *_l2h_img??.old *_l2h_img???.old \ - *_l2h_img?.png *_l2h_img??.png *_l2h_img???.png \ - *_l2h.tex *_l2h.css *_l2h_images.pl *_l2h_images.tex \ - *_l2h_labels.pl l2h_cache.pm; fi) ; \ - done -# 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/Tests/README b/Build/source/utils/texi2html/Tests/README deleted file mode 100644 index 2a34ac5171e..00000000000 --- a/Build/source/utils/texi2html/Tests/README +++ /dev/null @@ -1,112 +0,0 @@ -Running the tests and understanding the results ------------------------------------------------ - -To run all the tests just do -$ ./test.sh - -For each test the output begins with the line: -making test: dir/file options... - -dir is the dir where the test is made, file is the texinfo file processed and -the optional options are the options passed to texi2html when doing the test. -Then the test results are outputted. There are 5 type of results outputed: - -status -> always -stderr line count -> always -diffs -> optionnal -test with tidy -> optionnal -test validity -> optionnal - -For each of these, the type is outputted indented. The results appear on -lines below, more indented. When the test fails there is !!! on the line. -For example: - -making test: formatting/not_closed_in_menu.texi - status: - passed - stderr line count: - !!! bad line count: 7 != 0 - -I now turn the the individual result type: - -* status -The exit status of the command is tested for success or failure. - -* stderr line count -The number of stderr lines is compared against a reference. - -* diffs -out files are diffed against reference files present in dir_res. A '.' -means a successfull comparison. If there are more than one test in that -dir, there might be files differing or files not found if the files -haven't allready been regenerated. - -* test with tidy -tidy is run on resulting html files. - -* test validity -validate is run on resulting html files. - - -Adding a test -------------- - -To add a test, you have to add a line in test.sh, near the end. -Here is the syntax: - -test_texi dir file "option1 option2" stderr_lines suffix basename ignore_tags validate test_tidy fail - -dir is the only mandatory argument. There are defaults for the other -arguments when not given. However if you want to specify, say, basename -and use the defaults for the preceding ones, you have to set them -explicitely. - -dir: the directory where the files are. -file: the texinfo file. If not present dir.texi is used -"option1 option2": options passed to texi2html. Default is no option -stderr_lines: number of lines of stderr. Default is 0 -suffix: suffix of the file, used to find the basename. 'texi' is assumed -basename: basename of the generated files. The basename of file is the default -ignore_tags: if set to 'ignore_tags' or 'yes' rcs tags are ignored -validate: if unset or set to 'validate' validation is tried -test_tidy: if unset or set to 'tidy' or 'test_tidy', tidy is tried -fail: if unset or set to 'success' the exit code should be 0 - -* Simple example: -test_texi macros - -test macros.texi in the macros dir, without options, assuming generated -files beginning with macros. - -* Complex example: -test_texi sectionning no_node.texi "-prefix chapter_split_no_node -split chapter" 0 texi chapter_split_no_node - -Test no_node.texi in the sectionning dir, with the options: --prefix chapter_split_no_node -split chapter -no lines on stderr, suffix is texi and basename for generated files is -chapter_split_no_node (which matches the option -prefix chapter_split_no_node). - -Remarks: -The stderr output is in basename.2, the result of the first pass in -basename.passtexi, of the second pass in basename.passfirst. -the -test option is always passed. -To run a single test you can run test.sh with the arguments you would have -passed to test_texi. For example - -$./test.sh viper viper.texi "-split chapter" - -will run a test for viper.texi in the viper directory with option --split chapter - - -Regenerating tests ------------------- - -make regenerate copy all the *.html, *.2, *.passtexi and *.passfirst from -the test directories to the result directories (test directory with _res -appended). -This is usefull when the new result is the good result and you want to -avoid manually copying the good files to the result directory. - -To add a new test directory add it to the SUBDIR_TESTS variable in -Makefile.am (and rerun automake, autoconf...). diff --git a/Build/source/utils/texi2html/aclocal.m4 b/Build/source/utils/texi2html/aclocal.m4 deleted file mode 100644 index bd3efdaf85f..00000000000 --- a/Build/source/utils/texi2html/aclocal.m4 +++ /dev/null @@ -1,603 +0,0 @@ -# generated automatically by aclocal 1.9.6 -*- Autoconf -*- - -# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, -# 2005 Free Software Foundation, Inc. -# This file 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. - -# Copyright (C) 2002, 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# AM_AUTOMAKE_VERSION(VERSION) -# ---------------------------- -# Automake X.Y traces this macro to ensure aclocal.m4 has been -# generated from the m4 files accompanying Automake X.Y. -AC_DEFUN([AM_AUTOMAKE_VERSION], [am__api_version="1.9"]) - -# AM_SET_CURRENT_AUTOMAKE_VERSION -# ------------------------------- -# Call AM_AUTOMAKE_VERSION so it can be traced. -# This function is AC_REQUIREd by AC_INIT_AUTOMAKE. -AC_DEFUN([AM_SET_CURRENT_AUTOMAKE_VERSION], - [AM_AUTOMAKE_VERSION([1.9.6])]) - -# AM_AUX_DIR_EXPAND -*- Autoconf -*- - -# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# For projects using AC_CONFIG_AUX_DIR([foo]), Autoconf sets -# $ac_aux_dir to `$srcdir/foo'. In other projects, it is set to -# `$srcdir', `$srcdir/..', or `$srcdir/../..'. -# -# Of course, Automake must honor this variable whenever it calls a -# tool from the auxiliary directory. The problem is that $srcdir (and -# therefore $ac_aux_dir as well) can be either absolute or relative, -# depending on how configure is run. This is pretty annoying, since -# it makes $ac_aux_dir quite unusable in subdirectories: in the top -# source directory, any form will work fine, but in subdirectories a -# relative path needs to be adjusted first. -# -# $ac_aux_dir/missing -# fails when called from a subdirectory if $ac_aux_dir is relative -# $top_srcdir/$ac_aux_dir/missing -# fails if $ac_aux_dir is absolute, -# fails when called from a subdirectory in a VPATH build with -# a relative $ac_aux_dir -# -# The reason of the latter failure is that $top_srcdir and $ac_aux_dir -# are both prefixed by $srcdir. In an in-source build this is usually -# harmless because $srcdir is `.', but things will broke when you -# start a VPATH build or use an absolute $srcdir. -# -# So we could use something similar to $top_srcdir/$ac_aux_dir/missing, -# iff we strip the leading $srcdir from $ac_aux_dir. That would be: -# am_aux_dir='\$(top_srcdir)/'`expr "$ac_aux_dir" : "$srcdir//*\(.*\)"` -# and then we would define $MISSING as -# MISSING="\${SHELL} $am_aux_dir/missing" -# This will work as long as MISSING is not called from configure, because -# unfortunately $(top_srcdir) has no meaning in configure. -# However there are other variables, like CC, which are often used in -# configure, and could therefore not use this "fixed" $ac_aux_dir. -# -# Another solution, used here, is to always expand $ac_aux_dir to an -# absolute PATH. The drawback is that using absolute paths prevent a -# configured tree to be moved without reconfiguration. - -AC_DEFUN([AM_AUX_DIR_EXPAND], -[dnl Rely on autoconf to set up CDPATH properly. -AC_PREREQ([2.50])dnl -# expand $ac_aux_dir to an absolute path -am_aux_dir=`cd $ac_aux_dir && pwd` -]) - -# AM_CONDITIONAL -*- Autoconf -*- - -# Copyright (C) 1997, 2000, 2001, 2003, 2004, 2005 -# Free Software Foundation, Inc. -# -# This file 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. - -# serial 7 - -# AM_CONDITIONAL(NAME, SHELL-CONDITION) -# ------------------------------------- -# Define a conditional. -AC_DEFUN([AM_CONDITIONAL], -[AC_PREREQ(2.52)dnl - ifelse([$1], [TRUE], [AC_FATAL([$0: invalid condition: $1])], - [$1], [FALSE], [AC_FATAL([$0: invalid condition: $1])])dnl -AC_SUBST([$1_TRUE]) -AC_SUBST([$1_FALSE]) -if $2; then - $1_TRUE= - $1_FALSE='#' -else - $1_TRUE='#' - $1_FALSE= -fi -AC_CONFIG_COMMANDS_PRE( -[if test -z "${$1_TRUE}" && test -z "${$1_FALSE}"; then - AC_MSG_ERROR([[conditional "$1" was never defined. -Usually this means the macro was only invoked conditionally.]]) -fi])]) - -# Do all the work for Automake. -*- Autoconf -*- - -# Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 -# Free Software Foundation, Inc. -# -# This file 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. - -# serial 12 - -# This macro actually does too much. Some checks are only needed if -# your package does certain things. But this isn't really a big deal. - -# AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE]) -# AM_INIT_AUTOMAKE([OPTIONS]) -# ----------------------------------------------- -# The call with PACKAGE and VERSION arguments is the old style -# call (pre autoconf-2.50), which is being phased out. PACKAGE -# and VERSION should now be passed to AC_INIT and removed from -# the call to AM_INIT_AUTOMAKE. -# We support both call styles for the transition. After -# the next Automake release, Autoconf can make the AC_INIT -# arguments mandatory, and then we can depend on a new Autoconf -# release and drop the old call support. -AC_DEFUN([AM_INIT_AUTOMAKE], -[AC_PREREQ([2.58])dnl -dnl Autoconf wants to disallow AM_ names. We explicitly allow -dnl the ones we care about. -m4_pattern_allow([^AM_[A-Z]+FLAGS$])dnl -AC_REQUIRE([AM_SET_CURRENT_AUTOMAKE_VERSION])dnl -AC_REQUIRE([AC_PROG_INSTALL])dnl -# test to see if srcdir already configured -if test "`cd $srcdir && pwd`" != "`pwd`" && - test -f $srcdir/config.status; then - AC_MSG_ERROR([source directory already configured; run "make distclean" there first]) -fi - -# test whether we have cygpath -if test -z "$CYGPATH_W"; then - if (cygpath --version) >/dev/null 2>/dev/null; then - CYGPATH_W='cygpath -w' - else - CYGPATH_W=echo - fi -fi -AC_SUBST([CYGPATH_W]) - -# Define the identity of the package. -dnl Distinguish between old-style and new-style calls. -m4_ifval([$2], -[m4_ifval([$3], [_AM_SET_OPTION([no-define])])dnl - AC_SUBST([PACKAGE], [$1])dnl - AC_SUBST([VERSION], [$2])], -[_AM_SET_OPTIONS([$1])dnl - AC_SUBST([PACKAGE], ['AC_PACKAGE_TARNAME'])dnl - AC_SUBST([VERSION], ['AC_PACKAGE_VERSION'])])dnl - -_AM_IF_OPTION([no-define],, -[AC_DEFINE_UNQUOTED(PACKAGE, "$PACKAGE", [Name of package]) - AC_DEFINE_UNQUOTED(VERSION, "$VERSION", [Version number of package])])dnl - -# Some tools Automake needs. -AC_REQUIRE([AM_SANITY_CHECK])dnl -AC_REQUIRE([AC_ARG_PROGRAM])dnl -AM_MISSING_PROG(ACLOCAL, aclocal-${am__api_version}) -AM_MISSING_PROG(AUTOCONF, autoconf) -AM_MISSING_PROG(AUTOMAKE, automake-${am__api_version}) -AM_MISSING_PROG(AUTOHEADER, autoheader) -AM_MISSING_PROG(MAKEINFO, makeinfo) -AM_PROG_INSTALL_SH -AM_PROG_INSTALL_STRIP -AC_REQUIRE([AM_PROG_MKDIR_P])dnl -# We need awk for the "check" target. The system "awk" is bad on -# some platforms. -AC_REQUIRE([AC_PROG_AWK])dnl -AC_REQUIRE([AC_PROG_MAKE_SET])dnl -AC_REQUIRE([AM_SET_LEADING_DOT])dnl -_AM_IF_OPTION([tar-ustar], [_AM_PROG_TAR([ustar])], - [_AM_IF_OPTION([tar-pax], [_AM_PROG_TAR([pax])], - [_AM_PROG_TAR([v7])])]) -_AM_IF_OPTION([no-dependencies],, -[AC_PROVIDE_IFELSE([AC_PROG_CC], - [_AM_DEPENDENCIES(CC)], - [define([AC_PROG_CC], - defn([AC_PROG_CC])[_AM_DEPENDENCIES(CC)])])dnl -AC_PROVIDE_IFELSE([AC_PROG_CXX], - [_AM_DEPENDENCIES(CXX)], - [define([AC_PROG_CXX], - defn([AC_PROG_CXX])[_AM_DEPENDENCIES(CXX)])])dnl -]) -]) - - -# When config.status generates a header, we must update the stamp-h file. -# This file resides in the same directory as the config header -# that is generated. The stamp files are numbered to have different names. - -# Autoconf calls _AC_AM_CONFIG_HEADER_HOOK (when defined) in the -# loop where config.status creates the headers, so we can generate -# our stamp files there. -AC_DEFUN([_AC_AM_CONFIG_HEADER_HOOK], -[# Compute $1's index in $config_headers. -_am_stamp_count=1 -for _am_header in $config_headers :; do - case $_am_header in - $1 | $1:* ) - break ;; - * ) - _am_stamp_count=`expr $_am_stamp_count + 1` ;; - esac -done -echo "timestamp for $1" >`AS_DIRNAME([$1])`/stamp-h[]$_am_stamp_count]) - -# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# AM_PROG_INSTALL_SH -# ------------------ -# Define $install_sh. -AC_DEFUN([AM_PROG_INSTALL_SH], -[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl -install_sh=${install_sh-"$am_aux_dir/install-sh"} -AC_SUBST(install_sh)]) - -# Copyright (C) 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# serial 2 - -# Check whether the underlying file-system supports filenames -# with a leading dot. For instance MS-DOS doesn't. -AC_DEFUN([AM_SET_LEADING_DOT], -[rm -rf .tst 2>/dev/null -mkdir .tst 2>/dev/null -if test -d .tst; then - am__leading_dot=. -else - am__leading_dot=_ -fi -rmdir .tst 2>/dev/null -AC_SUBST([am__leading_dot])]) - -# Add --enable-maintainer-mode option to configure. -*- Autoconf -*- -# From Jim Meyering - -# Copyright (C) 1996, 1998, 2000, 2001, 2002, 2003, 2004, 2005 -# Free Software Foundation, Inc. -# -# This file 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. - -# serial 4 - -AC_DEFUN([AM_MAINTAINER_MODE], -[AC_MSG_CHECKING([whether to enable maintainer-specific portions of Makefiles]) - dnl maintainer-mode is disabled by default - AC_ARG_ENABLE(maintainer-mode, -[ --enable-maintainer-mode enable make rules and dependencies not useful - (and sometimes confusing) to the casual installer], - USE_MAINTAINER_MODE=$enableval, - USE_MAINTAINER_MODE=no) - AC_MSG_RESULT([$USE_MAINTAINER_MODE]) - AM_CONDITIONAL(MAINTAINER_MODE, [test $USE_MAINTAINER_MODE = yes]) - MAINT=$MAINTAINER_MODE_TRUE - AC_SUBST(MAINT)dnl -] -) - -AU_DEFUN([jm_MAINTAINER_MODE], [AM_MAINTAINER_MODE]) - -# Fake the existence of programs that GNU maintainers use. -*- Autoconf -*- - -# Copyright (C) 1997, 1999, 2000, 2001, 2003, 2005 -# Free Software Foundation, Inc. -# -# This file 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. - -# serial 4 - -# AM_MISSING_PROG(NAME, PROGRAM) -# ------------------------------ -AC_DEFUN([AM_MISSING_PROG], -[AC_REQUIRE([AM_MISSING_HAS_RUN]) -$1=${$1-"${am_missing_run}$2"} -AC_SUBST($1)]) - - -# AM_MISSING_HAS_RUN -# ------------------ -# Define MISSING if not defined so far and test if it supports --run. -# If it does, set am_missing_run to use it, otherwise, to nothing. -AC_DEFUN([AM_MISSING_HAS_RUN], -[AC_REQUIRE([AM_AUX_DIR_EXPAND])dnl -test x"${MISSING+set}" = xset || MISSING="\${SHELL} $am_aux_dir/missing" -# Use eval to expand $SHELL -if eval "$MISSING --run true"; then - am_missing_run="$MISSING --run " -else - am_missing_run= - AC_MSG_WARN([`missing' script is too old or missing]) -fi -]) - -# Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# AM_PROG_MKDIR_P -# --------------- -# Check whether `mkdir -p' is supported, fallback to mkinstalldirs otherwise. -# -# Automake 1.8 used `mkdir -m 0755 -p --' to ensure that directories -# created by `make install' are always world readable, even if the -# installer happens to have an overly restrictive umask (e.g. 077). -# This was a mistake. There are at least two reasons why we must not -# use `-m 0755': -# - it causes special bits like SGID to be ignored, -# - it may be too restrictive (some setups expect 775 directories). -# -# Do not use -m 0755 and let people choose whatever they expect by -# setting umask. -# -# We cannot accept any implementation of `mkdir' that recognizes `-p'. -# Some implementations (such as Solaris 8's) are not thread-safe: if a -# parallel make tries to run `mkdir -p a/b' and `mkdir -p a/c' -# concurrently, both version can detect that a/ is missing, but only -# one can create it and the other will error out. Consequently we -# restrict ourselves to GNU make (using the --version option ensures -# this.) -AC_DEFUN([AM_PROG_MKDIR_P], -[if mkdir -p --version . >/dev/null 2>&1 && test ! -d ./--version; then - # We used to keeping the `.' as first argument, in order to - # allow $(mkdir_p) to be used without argument. As in - # $(mkdir_p) $(somedir) - # where $(somedir) is conditionally defined. However this is wrong - # for two reasons: - # 1. if the package is installed by a user who cannot write `.' - # make install will fail, - # 2. the above comment should most certainly read - # $(mkdir_p) $(DESTDIR)$(somedir) - # so it does not work when $(somedir) is undefined and - # $(DESTDIR) is not. - # To support the latter case, we have to write - # test -z "$(somedir)" || $(mkdir_p) $(DESTDIR)$(somedir), - # so the `.' trick is pointless. - mkdir_p='mkdir -p --' -else - # On NextStep and OpenStep, the `mkdir' command does not - # recognize any option. It will interpret all options as - # directories to create, and then abort because `.' already - # exists. - for d in ./-p ./--version; - do - test -d $d && rmdir $d - done - # $(mkinstalldirs) is defined by Automake if mkinstalldirs exists. - if test -f "$ac_aux_dir/mkinstalldirs"; then - mkdir_p='$(mkinstalldirs)' - else - mkdir_p='$(install_sh) -d' - fi -fi -AC_SUBST([mkdir_p])]) - -# Helper functions for option handling. -*- Autoconf -*- - -# Copyright (C) 2001, 2002, 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# serial 3 - -# _AM_MANGLE_OPTION(NAME) -# ----------------------- -AC_DEFUN([_AM_MANGLE_OPTION], -[[_AM_OPTION_]m4_bpatsubst($1, [[^a-zA-Z0-9_]], [_])]) - -# _AM_SET_OPTION(NAME) -# ------------------------------ -# Set option NAME. Presently that only means defining a flag for this option. -AC_DEFUN([_AM_SET_OPTION], -[m4_define(_AM_MANGLE_OPTION([$1]), 1)]) - -# _AM_SET_OPTIONS(OPTIONS) -# ---------------------------------- -# OPTIONS is a space-separated list of Automake options. -AC_DEFUN([_AM_SET_OPTIONS], -[AC_FOREACH([_AM_Option], [$1], [_AM_SET_OPTION(_AM_Option)])]) - -# _AM_IF_OPTION(OPTION, IF-SET, [IF-NOT-SET]) -# ------------------------------------------- -# Execute IF-SET if OPTION is set, IF-NOT-SET otherwise. -AC_DEFUN([_AM_IF_OPTION], -[m4_ifset(_AM_MANGLE_OPTION([$1]), [$2], [$3])]) - -# Check to make sure that the build environment is sane. -*- Autoconf -*- - -# Copyright (C) 1996, 1997, 2000, 2001, 2003, 2005 -# Free Software Foundation, Inc. -# -# This file 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. - -# serial 4 - -# AM_SANITY_CHECK -# --------------- -AC_DEFUN([AM_SANITY_CHECK], -[AC_MSG_CHECKING([whether build environment is sane]) -# Just in case -sleep 1 -echo timestamp > conftest.file -# Do `set' in a subshell so we don't clobber the current shell's -# arguments. Must try -L first in case configure is actually a -# symlink; some systems play weird games with the mod time of symlinks -# (eg FreeBSD returns the mod time of the symlink's containing -# directory). -if ( - set X `ls -Lt $srcdir/configure conftest.file 2> /dev/null` - if test "$[*]" = "X"; then - # -L didn't work. - set X `ls -t $srcdir/configure conftest.file` - fi - rm -f conftest.file - if test "$[*]" != "X $srcdir/configure conftest.file" \ - && test "$[*]" != "X conftest.file $srcdir/configure"; then - - # If neither matched, then we have a broken ls. This can happen - # if, for instance, CONFIG_SHELL is bash and it inherits a - # broken ls alias from the environment. This has actually - # happened. Such a system could not be considered "sane". - AC_MSG_ERROR([ls -t appears to fail. Make sure there is not a broken -alias in your environment]) - fi - - test "$[2]" = conftest.file - ) -then - # Ok. - : -else - AC_MSG_ERROR([newly created file is older than distributed files! -Check your system clock]) -fi -AC_MSG_RESULT(yes)]) - -# Copyright (C) 2001, 2003, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# AM_PROG_INSTALL_STRIP -# --------------------- -# One issue with vendor `install' (even GNU) is that you can't -# specify the program used to strip binaries. This is especially -# annoying in cross-compiling environments, where the build's strip -# is unlikely to handle the host's binaries. -# Fortunately install-sh will honor a STRIPPROG variable, so we -# always use install-sh in `make install-strip', and initialize -# STRIPPROG with the value of the STRIP variable (set by the user). -AC_DEFUN([AM_PROG_INSTALL_STRIP], -[AC_REQUIRE([AM_PROG_INSTALL_SH])dnl -# Installed binaries are usually stripped using `strip' when the user -# run `make install-strip'. However `strip' might not be the right -# tool to use in cross-compilation environments, therefore Automake -# will honor the `STRIP' environment variable to overrule this program. -dnl Don't test for $cross_compiling = yes, because it might be `maybe'. -if test "$cross_compiling" != no; then - AC_CHECK_TOOL([STRIP], [strip], :) -fi -INSTALL_STRIP_PROGRAM="\${SHELL} \$(install_sh) -c -s" -AC_SUBST([INSTALL_STRIP_PROGRAM])]) - -# Check how to create a tarball. -*- Autoconf -*- - -# Copyright (C) 2004, 2005 Free Software Foundation, Inc. -# -# This file 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. - -# serial 2 - -# _AM_PROG_TAR(FORMAT) -# -------------------- -# Check how to create a tarball in format FORMAT. -# FORMAT should be one of `v7', `ustar', or `pax'. -# -# Substitute a variable $(am__tar) that is a command -# writing to stdout a FORMAT-tarball containing the directory -# $tardir. -# tardir=directory && $(am__tar) > result.tar -# -# Substitute a variable $(am__untar) that extract such -# a tarball read from stdin. -# $(am__untar) < result.tar -AC_DEFUN([_AM_PROG_TAR], -[# Always define AMTAR for backward compatibility. -AM_MISSING_PROG([AMTAR], [tar]) -m4_if([$1], [v7], - [am__tar='${AMTAR} chof - "$$tardir"'; am__untar='${AMTAR} xf -'], - [m4_case([$1], [ustar],, [pax],, - [m4_fatal([Unknown tar format])]) -AC_MSG_CHECKING([how to create a $1 tar archive]) -# Loop over all known methods to create a tar archive until one works. -_am_tools='gnutar m4_if([$1], [ustar], [plaintar]) pax cpio none' -_am_tools=${am_cv_prog_tar_$1-$_am_tools} -# Do not fold the above two line into one, because Tru64 sh and -# Solaris sh will not grok spaces in the rhs of `-'. -for _am_tool in $_am_tools -do - case $_am_tool in - gnutar) - for _am_tar in tar gnutar gtar; - do - AM_RUN_LOG([$_am_tar --version]) && break - done - am__tar="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$$tardir"' - am__tar_="$_am_tar --format=m4_if([$1], [pax], [posix], [$1]) -chf - "'"$tardir"' - am__untar="$_am_tar -xf -" - ;; - plaintar) - # Must skip GNU tar: if it does not support --format= it doesn't create - # ustar tarball either. - (tar --version) >/dev/null 2>&1 && continue - am__tar='tar chf - "$$tardir"' - am__tar_='tar chf - "$tardir"' - am__untar='tar xf -' - ;; - pax) - am__tar='pax -L -x $1 -w "$$tardir"' - am__tar_='pax -L -x $1 -w "$tardir"' - am__untar='pax -r' - ;; - cpio) - am__tar='find "$$tardir" -print | cpio -o -H $1 -L' - am__tar_='find "$tardir" -print | cpio -o -H $1 -L' - am__untar='cpio -i -H $1 -d' - ;; - none) - am__tar=false - am__tar_=false - am__untar=false - ;; - esac - - # If the value was cached, stop now. We just wanted to have am__tar - # and am__untar set. - test -n "${am_cv_prog_tar_$1}" && break - - # tar/untar a dummy directory, and stop if the command works - rm -rf conftest.dir - mkdir conftest.dir - echo GrepMe > conftest.dir/file - AM_RUN_LOG([tardir=conftest.dir && eval $am__tar_ >conftest.tar]) - rm -rf conftest.dir - if test -s conftest.tar; then - AM_RUN_LOG([$am__untar <conftest.tar]) - grep GrepMe conftest.dir/file >/dev/null 2>&1 && break - fi -done -rm -rf conftest.dir - -AC_CACHE_VAL([am_cv_prog_tar_$1], [am_cv_prog_tar_$1=$_am_tool]) -AC_MSG_RESULT([$am_cv_prog_tar_$1])]) -AC_SUBST([am__tar]) -AC_SUBST([am__untar]) -]) # _AM_PROG_TAR - diff --git a/Build/source/utils/texi2html/autogen.sh b/Build/source/utils/texi2html/autogen.sh deleted file mode 100755 index e46ef51478c..00000000000 --- a/Build/source/utils/texi2html/autogen.sh +++ /dev/null @@ -1,14 +0,0 @@ -#! /bin/sh -# Run this to generate all the initial makefiles, etc. - -test -f Makefile.am || cd "`dirname \"$0\"`" - -# Create `aclocal.m4'. -aclocal - -# Create `Makefile.in' from `Makefile.am', and symlink `install-sh', -# `missing' and `mkinstalldirs' from /usr/share/automake. -automake --add-missing - -# Create `configure' from `configure.in'. -autoconf diff --git a/Build/source/utils/texi2html/check_texinfo.pl.in b/Build/source/utils/texi2html/check_texinfo.pl.in deleted file mode 100755 index feef22a9957..00000000000 --- a/Build/source/utils/texi2html/check_texinfo.pl.in +++ /dev/null @@ -1,83 +0,0 @@ -#! @PERL@ -#+############################################################################## -# -# check_texinfo.pl: Extract texinfo commands from files -# -# Copyright (C) 1999, 2000 Free Software Foundation, Inc. -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, 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 -# -#-############################################################################## - -# This requires perl version 5 or higher -require 5.0; - - - -use strict; -use Getopt::Long; -my $verbose; -if (!GetOptions ("verbose" => \$verbose)) -{ - die "usage: $0 [-v] file...\n"; -} - -die "Need file to check\n" unless @ARGV > 0; - -my (%seen, %context); - -while (<>) -{ - if (/\@(\*|\.|\:|\@|\{|\})/) - { - $seen{$&}++; - $context{$&} .= "> $_" if $verbose; - $_ = "$`XX$'"; - redo; - } - if (/\@(\w+)/) - { - my ($before, $match, $after); - ($before, $match, $after) = ($`, $&, $'); - if ($before =~ /\b[-\w]+$/ && $after =~ /^[-\w.]*\b/) - { # e-mail address - $seen{'e-mail address'}++; - $context{'e-mail address'} .= "> $_" if $verbose; - } - else - { - $seen{$match}++; - $context{$match} .= "> $_" if $verbose; - } - $match =~ s/^\@/X/; - $_ = "$before$match$after"; - redo; - } -} - -foreach (sort(keys(%seen))) -{ - if ($verbose) - { - print "$_\n"; - print $context{$_}; - } - else - { - print "$_ ($seen{$_})\n"; - } -} - - diff --git a/Build/source/utils/texi2html/config.guess b/Build/source/utils/texi2html/config.guess deleted file mode 100755 index 6cc26cd3df1..00000000000 --- a/Build/source/utils/texi2html/config.guess +++ /dev/null @@ -1,1513 +0,0 @@ -#! /bin/sh -# Attempt to guess a canonical system name. -# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, -# 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, -# Inc. - -timestamp='2007-01-15' - -# This 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 of the License, 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., 51 Franklin Street - Fifth Floor, Boston, MA -# 02110-1301, USA. -# -# As a special exception to the GNU General Public License, if you -# distribute this file as part of a program that contains a -# configuration script generated by Autoconf, you may include it under -# the same distribution terms that you use for the rest of that program. - - -# Originally written by Per Bothner <per@bothner.com>. -# Please send patches to <config-patches@gnu.org>. Submit a context -# diff and a properly formatted ChangeLog entry. -# -# This script attempts to guess a canonical system name similar to -# config.sub. If it succeeds, it prints the system name on stdout, and -# exits with 0. Otherwise, it exits with 1. -# -# The plan is that this can be called by configure scripts if you -# don't specify an explicit build system type. - -me=`echo "$0" | sed -e 's,.*/,,'` - -usage="\ -Usage: $0 [OPTION] - -Output the configuration name of the system \`$me' is run on. - -Operation modes: - -h, --help print this help, then exit - -t, --time-stamp print date of last modification, then exit - -v, --version print version number, then exit - -Report bugs and patches to <config-patches@gnu.org>." - -version="\ -GNU config.guess ($timestamp) - -Originally written by Per Bothner. -Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 -Free Software Foundation, Inc. - -This is free software; see the source for copying conditions. There is NO -warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." - -help=" -Try \`$me --help' for more information." - -# Parse command line -while test $# -gt 0 ; do - case $1 in - --time-stamp | --time* | -t ) - echo "$timestamp" ; exit ;; - --version | -v ) - echo "$version" ; exit ;; - --help | --h* | -h ) - echo "$usage"; exit ;; - -- ) # Stop option processing - shift; break ;; - - ) # Use stdin as input. - break ;; - -* ) - echo "$me: invalid option $1$help" >&2 - exit 1 ;; - * ) - break ;; - esac -done - -if test $# != 0; then - echo "$me: too many arguments$help" >&2 - exit 1 -fi - -trap 'exit 1' 1 2 15 - -# CC_FOR_BUILD -- compiler used by this script. Note that the use of a -# compiler to aid in system detection is discouraged as it requires -# temporary files to be created and, as you can see below, it is a -# headache to deal with in a portable fashion. - -# Historically, `CC_FOR_BUILD' used to be named `HOST_CC'. We still -# use `HOST_CC' if defined, but it is deprecated. - -# Portable tmp directory creation inspired by the Autoconf team. - -set_cc_for_build=' -trap "exitcode=\$?; (rm -f \$tmpfiles 2>/dev/null; rmdir \$tmp 2>/dev/null) && exit \$exitcode" 0 ; -trap "rm -f \$tmpfiles 2>/dev/null; rmdir \$tmp 2>/dev/null; exit 1" 1 2 13 15 ; -: ${TMPDIR=/tmp} ; - { tmp=`(umask 077 && mktemp -d "$TMPDIR/cgXXXXXX") 2>/dev/null` && test -n "$tmp" && test -d "$tmp" ; } || - { test -n "$RANDOM" && tmp=$TMPDIR/cg$$-$RANDOM && (umask 077 && mkdir $tmp) ; } || - { tmp=$TMPDIR/cg-$$ && (umask 077 && mkdir $tmp) && echo "Warning: creating insecure temp directory" >&2 ; } || - { echo "$me: cannot create a temporary directory in $TMPDIR" >&2 ; exit 1 ; } ; -dummy=$tmp/dummy ; -tmpfiles="$dummy.c $dummy.o $dummy.rel $dummy" ; -case $CC_FOR_BUILD,$HOST_CC,$CC in - ,,) echo "int x;" > $dummy.c ; - for c in cc gcc c89 c99 ; do - if ($c -c -o $dummy.o $dummy.c) >/dev/null 2>&1 ; then - CC_FOR_BUILD="$c"; break ; - fi ; - done ; - if test x"$CC_FOR_BUILD" = x ; then - CC_FOR_BUILD=no_compiler_found ; - fi - ;; - ,,*) CC_FOR_BUILD=$CC ;; - ,*,*) CC_FOR_BUILD=$HOST_CC ;; -esac ; set_cc_for_build= ;' - -# This is needed to find uname on a Pyramid OSx when run in the BSD universe. -# (ghazi@noc.rutgers.edu 1994-08-24) -if (test -f /.attbin/uname) >/dev/null 2>&1 ; then - PATH=$PATH:/.attbin ; export PATH -fi - -UNAME_MACHINE=`(uname -m) 2>/dev/null` || UNAME_MACHINE=unknown -UNAME_RELEASE=`(uname -r) 2>/dev/null` || UNAME_RELEASE=unknown -UNAME_SYSTEM=`(uname -s) 2>/dev/null` || UNAME_SYSTEM=unknown -UNAME_VERSION=`(uname -v) 2>/dev/null` || UNAME_VERSION=unknown - -# Note: order is significant - the case branches are not exclusive. - -case "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" in - *:NetBSD:*:*) - # NetBSD (nbsd) targets should (where applicable) match one or - # more of the tupples: *-*-netbsdelf*, *-*-netbsdaout*, - # *-*-netbsdecoff* and *-*-netbsd*. For targets that recently - # switched to ELF, *-*-netbsd* would select the old - # object file format. This provides both forward - # compatibility and a consistent mechanism for selecting the - # object file format. - # - # Note: NetBSD doesn't particularly care about the vendor - # portion of the name. We always set it to "unknown". - sysctl="sysctl -n hw.machine_arch" - UNAME_MACHINE_ARCH=`(/sbin/$sysctl 2>/dev/null || \ - /usr/sbin/$sysctl 2>/dev/null || echo unknown)` - case "${UNAME_MACHINE_ARCH}" in - armeb) machine=armeb-unknown ;; - arm*) machine=arm-unknown ;; - sh3el) machine=shl-unknown ;; - sh3eb) machine=sh-unknown ;; - sh5el) machine=sh5le-unknown ;; - *) machine=${UNAME_MACHINE_ARCH}-unknown ;; - esac - # The Operating System including object format, if it has switched - # to ELF recently, or will in the future. - case "${UNAME_MACHINE_ARCH}" in - arm*|i386|m68k|ns32k|sh3*|sparc|vax) - eval $set_cc_for_build - if echo __ELF__ | $CC_FOR_BUILD -E - 2>/dev/null \ - | grep __ELF__ >/dev/null - then - # Once all utilities can be ECOFF (netbsdecoff) or a.out (netbsdaout). - # Return netbsd for either. FIX? - os=netbsd - else - os=netbsdelf - fi - ;; - *) - os=netbsd - ;; - esac - # The OS release - # Debian GNU/NetBSD machines have a different userland, and - # thus, need a distinct triplet. However, they do not need - # kernel version information, so it can be replaced with a - # suitable tag, in the style of linux-gnu. - case "${UNAME_VERSION}" in - Debian*) - release='-gnu' - ;; - *) - release=`echo ${UNAME_RELEASE}|sed -e 's/[-_].*/\./'` - ;; - esac - # Since CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM: - # contains redundant information, the shorter form: - # CPU_TYPE-MANUFACTURER-OPERATING_SYSTEM is used. - echo "${machine}-${os}${release}" - exit ;; - *:OpenBSD:*:*) - UNAME_MACHINE_ARCH=`arch | sed 's/OpenBSD.//'` - echo ${UNAME_MACHINE_ARCH}-unknown-openbsd${UNAME_RELEASE} - exit ;; - *:ekkoBSD:*:*) - echo ${UNAME_MACHINE}-unknown-ekkobsd${UNAME_RELEASE} - exit ;; - *:SolidBSD:*:*) - echo ${UNAME_MACHINE}-unknown-solidbsd${UNAME_RELEASE} - exit ;; - macppc:MirBSD:*:*) - echo powerpc-unknown-mirbsd${UNAME_RELEASE} - exit ;; - *:MirBSD:*:*) - echo ${UNAME_MACHINE}-unknown-mirbsd${UNAME_RELEASE} - exit ;; - alpha:OSF1:*:*) - case $UNAME_RELEASE in - *4.0) - UNAME_RELEASE=`/usr/sbin/sizer -v | awk '{print $3}'` - ;; - *5.*) - UNAME_RELEASE=`/usr/sbin/sizer -v | awk '{print $4}'` - ;; - esac - # According to Compaq, /usr/sbin/psrinfo has been available on - # OSF/1 and Tru64 systems produced since 1995. I hope that - # covers most systems running today. This code pipes the CPU - # types through head -n 1, so we only detect the type of CPU 0. - ALPHA_CPU_TYPE=`/usr/sbin/psrinfo -v | sed -n -e 's/^ The alpha \(.*\) processor.*$/\1/p' | head -n 1` - case "$ALPHA_CPU_TYPE" in - "EV4 (21064)") - UNAME_MACHINE="alpha" ;; - "EV4.5 (21064)") - UNAME_MACHINE="alpha" ;; - "LCA4 (21066/21068)") - UNAME_MACHINE="alpha" ;; - "EV5 (21164)") - UNAME_MACHINE="alphaev5" ;; - "EV5.6 (21164A)") - UNAME_MACHINE="alphaev56" ;; - "EV5.6 (21164PC)") - UNAME_MACHINE="alphapca56" ;; - "EV5.7 (21164PC)") - UNAME_MACHINE="alphapca57" ;; - "EV6 (21264)") - UNAME_MACHINE="alphaev6" ;; - "EV6.7 (21264A)") - UNAME_MACHINE="alphaev67" ;; - "EV6.8CB (21264C)") - UNAME_MACHINE="alphaev68" ;; - "EV6.8AL (21264B)") - UNAME_MACHINE="alphaev68" ;; - "EV6.8CX (21264D)") - UNAME_MACHINE="alphaev68" ;; - "EV6.9A (21264/EV69A)") - UNAME_MACHINE="alphaev69" ;; - "EV7 (21364)") - UNAME_MACHINE="alphaev7" ;; - "EV7.9 (21364A)") - UNAME_MACHINE="alphaev79" ;; - esac - # A Pn.n version is a patched version. - # A Vn.n version is a released version. - # A Tn.n version is a released field test version. - # A Xn.n version is an unreleased experimental baselevel. - # 1.2 uses "1.2" for uname -r. - echo ${UNAME_MACHINE}-dec-osf`echo ${UNAME_RELEASE} | sed -e 's/^[PVTX]//' | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'` - exit ;; - Alpha\ *:Windows_NT*:*) - # How do we know it's Interix rather than the generic POSIX subsystem? - # Should we change UNAME_MACHINE based on the output of uname instead - # of the specific Alpha model? - echo alpha-pc-interix - exit ;; - 21064:Windows_NT:50:3) - echo alpha-dec-winnt3.5 - exit ;; - Amiga*:UNIX_System_V:4.0:*) - echo m68k-unknown-sysv4 - exit ;; - *:[Aa]miga[Oo][Ss]:*:*) - echo ${UNAME_MACHINE}-unknown-amigaos - exit ;; - *:[Mm]orph[Oo][Ss]:*:*) - echo ${UNAME_MACHINE}-unknown-morphos - exit ;; - *:OS/390:*:*) - echo i370-ibm-openedition - exit ;; - *:z/VM:*:*) - echo s390-ibm-zvmoe - exit ;; - *:OS400:*:*) - echo powerpc-ibm-os400 - exit ;; - arm:RISC*:1.[012]*:*|arm:riscix:1.[012]*:*) - echo arm-acorn-riscix${UNAME_RELEASE} - exit ;; - arm:riscos:*:*|arm:RISCOS:*:*) - echo arm-unknown-riscos - exit ;; - SR2?01:HI-UX/MPP:*:* | SR8000:HI-UX/MPP:*:*) - echo hppa1.1-hitachi-hiuxmpp - exit ;; - Pyramid*:OSx*:*:* | MIS*:OSx*:*:* | MIS*:SMP_DC-OSx*:*:*) - # akee@wpdis03.wpafb.af.mil (Earle F. Ake) contributed MIS and NILE. - if test "`(/bin/universe) 2>/dev/null`" = att ; then - echo pyramid-pyramid-sysv3 - else - echo pyramid-pyramid-bsd - fi - exit ;; - NILE*:*:*:dcosx) - echo pyramid-pyramid-svr4 - exit ;; - DRS?6000:unix:4.0:6*) - echo sparc-icl-nx6 - exit ;; - DRS?6000:UNIX_SV:4.2*:7* | DRS?6000:isis:4.2*:7*) - case `/usr/bin/uname -p` in - sparc) echo sparc-icl-nx7; exit ;; - esac ;; - sun4H:SunOS:5.*:*) - echo sparc-hal-solaris2`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'` - exit ;; - sun4*:SunOS:5.*:* | tadpole*:SunOS:5.*:*) - echo sparc-sun-solaris2`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'` - exit ;; - i86pc:SunOS:5.*:*) - echo i386-pc-solaris2`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'` - exit ;; - sun4*:SunOS:6*:*) - # According to config.sub, this is the proper way to canonicalize - # SunOS6. Hard to guess exactly what SunOS6 will be like, but - # it's likely to be more like Solaris than SunOS4. - echo sparc-sun-solaris3`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'` - exit ;; - sun4*:SunOS:*:*) - case "`/usr/bin/arch -k`" in - Series*|S4*) - UNAME_RELEASE=`uname -v` - ;; - esac - # Japanese Language versions have a version number like `4.1.3-JL'. - echo sparc-sun-sunos`echo ${UNAME_RELEASE}|sed -e 's/-/_/'` - exit ;; - sun3*:SunOS:*:*) - echo m68k-sun-sunos${UNAME_RELEASE} - exit ;; - sun*:*:4.2BSD:*) - UNAME_RELEASE=`(sed 1q /etc/motd | awk '{print substr($5,1,3)}') 2>/dev/null` - test "x${UNAME_RELEASE}" = "x" && UNAME_RELEASE=3 - case "`/bin/arch`" in - sun3) - echo m68k-sun-sunos${UNAME_RELEASE} - ;; - sun4) - echo sparc-sun-sunos${UNAME_RELEASE} - ;; - esac - exit ;; - aushp:SunOS:*:*) - echo sparc-auspex-sunos${UNAME_RELEASE} - exit ;; - # The situation for MiNT is a little confusing. The machine name - # can be virtually everything (everything which is not - # "atarist" or "atariste" at least should have a processor - # > m68000). The system name ranges from "MiNT" over "FreeMiNT" - # to the lowercase version "mint" (or "freemint"). Finally - # the system name "TOS" denotes a system which is actually not - # MiNT. But MiNT is downward compatible to TOS, so this should - # be no problem. - atarist[e]:*MiNT:*:* | atarist[e]:*mint:*:* | atarist[e]:*TOS:*:*) - echo m68k-atari-mint${UNAME_RELEASE} - exit ;; - atari*:*MiNT:*:* | atari*:*mint:*:* | atarist[e]:*TOS:*:*) - echo m68k-atari-mint${UNAME_RELEASE} - exit ;; - *falcon*:*MiNT:*:* | *falcon*:*mint:*:* | *falcon*:*TOS:*:*) - echo m68k-atari-mint${UNAME_RELEASE} - exit ;; - milan*:*MiNT:*:* | milan*:*mint:*:* | *milan*:*TOS:*:*) - echo m68k-milan-mint${UNAME_RELEASE} - exit ;; - hades*:*MiNT:*:* | hades*:*mint:*:* | *hades*:*TOS:*:*) - echo m68k-hades-mint${UNAME_RELEASE} - exit ;; - *:*MiNT:*:* | *:*mint:*:* | *:*TOS:*:*) - echo m68k-unknown-mint${UNAME_RELEASE} - exit ;; - m68k:machten:*:*) - echo m68k-apple-machten${UNAME_RELEASE} - exit ;; - powerpc:machten:*:*) - echo powerpc-apple-machten${UNAME_RELEASE} - exit ;; - RISC*:Mach:*:*) - echo mips-dec-mach_bsd4.3 - exit ;; - RISC*:ULTRIX:*:*) - echo mips-dec-ultrix${UNAME_RELEASE} - exit ;; - VAX*:ULTRIX*:*:*) - echo vax-dec-ultrix${UNAME_RELEASE} - exit ;; - 2020:CLIX:*:* | 2430:CLIX:*:*) - echo clipper-intergraph-clix${UNAME_RELEASE} - exit ;; - mips:*:*:UMIPS | mips:*:*:RISCos) - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c -#ifdef __cplusplus -#include <stdio.h> /* for printf() prototype */ - int main (int argc, char *argv[]) { -#else - int main (argc, argv) int argc; char *argv[]; { -#endif - #if defined (host_mips) && defined (MIPSEB) - #if defined (SYSTYPE_SYSV) - printf ("mips-mips-riscos%ssysv\n", argv[1]); exit (0); - #endif - #if defined (SYSTYPE_SVR4) - printf ("mips-mips-riscos%ssvr4\n", argv[1]); exit (0); - #endif - #if defined (SYSTYPE_BSD43) || defined(SYSTYPE_BSD) - printf ("mips-mips-riscos%sbsd\n", argv[1]); exit (0); - #endif - #endif - exit (-1); - } -EOF - $CC_FOR_BUILD -o $dummy $dummy.c && - dummyarg=`echo "${UNAME_RELEASE}" | sed -n 's/\([0-9]*\).*/\1/p'` && - SYSTEM_NAME=`$dummy $dummyarg` && - { echo "$SYSTEM_NAME"; exit; } - echo mips-mips-riscos${UNAME_RELEASE} - exit ;; - Motorola:PowerMAX_OS:*:*) - echo powerpc-motorola-powermax - exit ;; - Motorola:*:4.3:PL8-*) - echo powerpc-harris-powermax - exit ;; - Night_Hawk:*:*:PowerMAX_OS | Synergy:PowerMAX_OS:*:*) - echo powerpc-harris-powermax - exit ;; - Night_Hawk:Power_UNIX:*:*) - echo powerpc-harris-powerunix - exit ;; - m88k:CX/UX:7*:*) - echo m88k-harris-cxux7 - exit ;; - m88k:*:4*:R4*) - echo m88k-motorola-sysv4 - exit ;; - m88k:*:3*:R3*) - echo m88k-motorola-sysv3 - exit ;; - AViiON:dgux:*:*) - # DG/UX returns AViiON for all architectures - UNAME_PROCESSOR=`/usr/bin/uname -p` - if [ $UNAME_PROCESSOR = mc88100 ] || [ $UNAME_PROCESSOR = mc88110 ] - then - if [ ${TARGET_BINARY_INTERFACE}x = m88kdguxelfx ] || \ - [ ${TARGET_BINARY_INTERFACE}x = x ] - then - echo m88k-dg-dgux${UNAME_RELEASE} - else - echo m88k-dg-dguxbcs${UNAME_RELEASE} - fi - else - echo i586-dg-dgux${UNAME_RELEASE} - fi - exit ;; - M88*:DolphinOS:*:*) # DolphinOS (SVR3) - echo m88k-dolphin-sysv3 - exit ;; - M88*:*:R3*:*) - # Delta 88k system running SVR3 - echo m88k-motorola-sysv3 - exit ;; - XD88*:*:*:*) # Tektronix XD88 system running UTekV (SVR3) - echo m88k-tektronix-sysv3 - exit ;; - Tek43[0-9][0-9]:UTek:*:*) # Tektronix 4300 system running UTek (BSD) - echo m68k-tektronix-bsd - exit ;; - *:IRIX*:*:*) - echo mips-sgi-irix`echo ${UNAME_RELEASE}|sed -e 's/-/_/g'` - exit ;; - ????????:AIX?:[12].1:2) # AIX 2.2.1 or AIX 2.1.1 is RT/PC AIX. - echo romp-ibm-aix # uname -m gives an 8 hex-code CPU id - exit ;; # Note that: echo "'`uname -s`'" gives 'AIX ' - i*86:AIX:*:*) - echo i386-ibm-aix - exit ;; - ia64:AIX:*:*) - if [ -x /usr/bin/oslevel ] ; then - IBM_REV=`/usr/bin/oslevel` - else - IBM_REV=${UNAME_VERSION}.${UNAME_RELEASE} - fi - echo ${UNAME_MACHINE}-ibm-aix${IBM_REV} - exit ;; - *:AIX:2:3) - if grep bos325 /usr/include/stdio.h >/dev/null 2>&1; then - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - #include <sys/systemcfg.h> - - main() - { - if (!__power_pc()) - exit(1); - puts("powerpc-ibm-aix3.2.5"); - exit(0); - } -EOF - if $CC_FOR_BUILD -o $dummy $dummy.c && SYSTEM_NAME=`$dummy` - then - echo "$SYSTEM_NAME" - else - echo rs6000-ibm-aix3.2.5 - fi - elif grep bos324 /usr/include/stdio.h >/dev/null 2>&1; then - echo rs6000-ibm-aix3.2.4 - else - echo rs6000-ibm-aix3.2 - fi - exit ;; - *:AIX:*:[45]) - IBM_CPU_ID=`/usr/sbin/lsdev -C -c processor -S available | sed 1q | awk '{ print $1 }'` - if /usr/sbin/lsattr -El ${IBM_CPU_ID} | grep ' POWER' >/dev/null 2>&1; then - IBM_ARCH=rs6000 - else - IBM_ARCH=powerpc - fi - if [ -x /usr/bin/oslevel ] ; then - IBM_REV=`/usr/bin/oslevel` - else - IBM_REV=${UNAME_VERSION}.${UNAME_RELEASE} - fi - echo ${IBM_ARCH}-ibm-aix${IBM_REV} - exit ;; - *:AIX:*:*) - echo rs6000-ibm-aix - exit ;; - ibmrt:4.4BSD:*|romp-ibm:BSD:*) - echo romp-ibm-bsd4.4 - exit ;; - ibmrt:*BSD:*|romp-ibm:BSD:*) # covers RT/PC BSD and - echo romp-ibm-bsd${UNAME_RELEASE} # 4.3 with uname added to - exit ;; # report: romp-ibm BSD 4.3 - *:BOSX:*:*) - echo rs6000-bull-bosx - exit ;; - DPX/2?00:B.O.S.:*:*) - echo m68k-bull-sysv3 - exit ;; - 9000/[34]??:4.3bsd:1.*:*) - echo m68k-hp-bsd - exit ;; - hp300:4.4BSD:*:* | 9000/[34]??:4.3bsd:2.*:*) - echo m68k-hp-bsd4.4 - exit ;; - 9000/[34678]??:HP-UX:*:*) - HPUX_REV=`echo ${UNAME_RELEASE}|sed -e 's/[^.]*.[0B]*//'` - case "${UNAME_MACHINE}" in - 9000/31? ) HP_ARCH=m68000 ;; - 9000/[34]?? ) HP_ARCH=m68k ;; - 9000/[678][0-9][0-9]) - if [ -x /usr/bin/getconf ]; then - sc_cpu_version=`/usr/bin/getconf SC_CPU_VERSION 2>/dev/null` - sc_kernel_bits=`/usr/bin/getconf SC_KERNEL_BITS 2>/dev/null` - case "${sc_cpu_version}" in - 523) HP_ARCH="hppa1.0" ;; # CPU_PA_RISC1_0 - 528) HP_ARCH="hppa1.1" ;; # CPU_PA_RISC1_1 - 532) # CPU_PA_RISC2_0 - case "${sc_kernel_bits}" in - 32) HP_ARCH="hppa2.0n" ;; - 64) HP_ARCH="hppa2.0w" ;; - '') HP_ARCH="hppa2.0" ;; # HP-UX 10.20 - esac ;; - esac - fi - if [ "${HP_ARCH}" = "" ]; then - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - - #define _HPUX_SOURCE - #include <stdlib.h> - #include <unistd.h> - - int main () - { - #if defined(_SC_KERNEL_BITS) - long bits = sysconf(_SC_KERNEL_BITS); - #endif - long cpu = sysconf (_SC_CPU_VERSION); - - switch (cpu) - { - case CPU_PA_RISC1_0: puts ("hppa1.0"); break; - case CPU_PA_RISC1_1: puts ("hppa1.1"); break; - case CPU_PA_RISC2_0: - #if defined(_SC_KERNEL_BITS) - switch (bits) - { - case 64: puts ("hppa2.0w"); break; - case 32: puts ("hppa2.0n"); break; - default: puts ("hppa2.0"); break; - } break; - #else /* !defined(_SC_KERNEL_BITS) */ - puts ("hppa2.0"); break; - #endif - default: puts ("hppa1.0"); break; - } - exit (0); - } -EOF - (CCOPTS= $CC_FOR_BUILD -o $dummy $dummy.c 2>/dev/null) && HP_ARCH=`$dummy` - test -z "$HP_ARCH" && HP_ARCH=hppa - fi ;; - esac - if [ ${HP_ARCH} = "hppa2.0w" ] - then - eval $set_cc_for_build - - # hppa2.0w-hp-hpux* has a 64-bit kernel and a compiler generating - # 32-bit code. hppa64-hp-hpux* has the same kernel and a compiler - # generating 64-bit code. GNU and HP use different nomenclature: - # - # $ CC_FOR_BUILD=cc ./config.guess - # => hppa2.0w-hp-hpux11.23 - # $ CC_FOR_BUILD="cc +DA2.0w" ./config.guess - # => hppa64-hp-hpux11.23 - - if echo __LP64__ | (CCOPTS= $CC_FOR_BUILD -E - 2>/dev/null) | - grep __LP64__ >/dev/null - then - HP_ARCH="hppa2.0w" - else - HP_ARCH="hppa64" - fi - fi - echo ${HP_ARCH}-hp-hpux${HPUX_REV} - exit ;; - ia64:HP-UX:*:*) - HPUX_REV=`echo ${UNAME_RELEASE}|sed -e 's/[^.]*.[0B]*//'` - echo ia64-hp-hpux${HPUX_REV} - exit ;; - 3050*:HI-UX:*:*) - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - #include <unistd.h> - int - main () - { - long cpu = sysconf (_SC_CPU_VERSION); - /* The order matters, because CPU_IS_HP_MC68K erroneously returns - true for CPU_PA_RISC1_0. CPU_IS_PA_RISC returns correct - results, however. */ - if (CPU_IS_PA_RISC (cpu)) - { - switch (cpu) - { - case CPU_PA_RISC1_0: puts ("hppa1.0-hitachi-hiuxwe2"); break; - case CPU_PA_RISC1_1: puts ("hppa1.1-hitachi-hiuxwe2"); break; - case CPU_PA_RISC2_0: puts ("hppa2.0-hitachi-hiuxwe2"); break; - default: puts ("hppa-hitachi-hiuxwe2"); break; - } - } - else if (CPU_IS_HP_MC68K (cpu)) - puts ("m68k-hitachi-hiuxwe2"); - else puts ("unknown-hitachi-hiuxwe2"); - exit (0); - } -EOF - $CC_FOR_BUILD -o $dummy $dummy.c && SYSTEM_NAME=`$dummy` && - { echo "$SYSTEM_NAME"; exit; } - echo unknown-hitachi-hiuxwe2 - exit ;; - 9000/7??:4.3bsd:*:* | 9000/8?[79]:4.3bsd:*:* ) - echo hppa1.1-hp-bsd - exit ;; - 9000/8??:4.3bsd:*:*) - echo hppa1.0-hp-bsd - exit ;; - *9??*:MPE/iX:*:* | *3000*:MPE/iX:*:*) - echo hppa1.0-hp-mpeix - exit ;; - hp7??:OSF1:*:* | hp8?[79]:OSF1:*:* ) - echo hppa1.1-hp-osf - exit ;; - hp8??:OSF1:*:*) - echo hppa1.0-hp-osf - exit ;; - i*86:OSF1:*:*) - if [ -x /usr/sbin/sysversion ] ; then - echo ${UNAME_MACHINE}-unknown-osf1mk - else - echo ${UNAME_MACHINE}-unknown-osf1 - fi - exit ;; - parisc*:Lites*:*:*) - echo hppa1.1-hp-lites - exit ;; - C1*:ConvexOS:*:* | convex:ConvexOS:C1*:*) - echo c1-convex-bsd - exit ;; - C2*:ConvexOS:*:* | convex:ConvexOS:C2*:*) - if getsysinfo -f scalar_acc - then echo c32-convex-bsd - else echo c2-convex-bsd - fi - exit ;; - C34*:ConvexOS:*:* | convex:ConvexOS:C34*:*) - echo c34-convex-bsd - exit ;; - C38*:ConvexOS:*:* | convex:ConvexOS:C38*:*) - echo c38-convex-bsd - exit ;; - C4*:ConvexOS:*:* | convex:ConvexOS:C4*:*) - echo c4-convex-bsd - exit ;; - CRAY*Y-MP:*:*:*) - echo ymp-cray-unicos${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/' - exit ;; - CRAY*[A-Z]90:*:*:*) - echo ${UNAME_MACHINE}-cray-unicos${UNAME_RELEASE} \ - | sed -e 's/CRAY.*\([A-Z]90\)/\1/' \ - -e y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/ \ - -e 's/\.[^.]*$/.X/' - exit ;; - CRAY*TS:*:*:*) - echo t90-cray-unicos${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/' - exit ;; - CRAY*T3E:*:*:*) - echo alphaev5-cray-unicosmk${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/' - exit ;; - CRAY*SV1:*:*:*) - echo sv1-cray-unicos${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/' - exit ;; - *:UNICOS/mp:*:*) - echo craynv-cray-unicosmp${UNAME_RELEASE} | sed -e 's/\.[^.]*$/.X/' - exit ;; - F30[01]:UNIX_System_V:*:* | F700:UNIX_System_V:*:*) - FUJITSU_PROC=`uname -m | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'` - FUJITSU_SYS=`uname -p | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/\///'` - FUJITSU_REL=`echo ${UNAME_RELEASE} | sed -e 's/ /_/'` - echo "${FUJITSU_PROC}-fujitsu-${FUJITSU_SYS}${FUJITSU_REL}" - exit ;; - 5000:UNIX_System_V:4.*:*) - FUJITSU_SYS=`uname -p | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/\///'` - FUJITSU_REL=`echo ${UNAME_RELEASE} | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz' | sed -e 's/ /_/'` - echo "sparc-fujitsu-${FUJITSU_SYS}${FUJITSU_REL}" - exit ;; - i*86:BSD/386:*:* | i*86:BSD/OS:*:* | *:Ascend\ Embedded/OS:*:*) - echo ${UNAME_MACHINE}-pc-bsdi${UNAME_RELEASE} - exit ;; - sparc*:BSD/OS:*:*) - echo sparc-unknown-bsdi${UNAME_RELEASE} - exit ;; - *:BSD/OS:*:*) - echo ${UNAME_MACHINE}-unknown-bsdi${UNAME_RELEASE} - exit ;; - *:FreeBSD:*:*) - case ${UNAME_MACHINE} in - pc98) - echo i386-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` ;; - amd64) - echo x86_64-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` ;; - *) - echo ${UNAME_MACHINE}-unknown-freebsd`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` ;; - esac - exit ;; - i*:CYGWIN*:*) - echo ${UNAME_MACHINE}-pc-cygwin - exit ;; - *:MINGW*:*) - echo ${UNAME_MACHINE}-pc-mingw32 - exit ;; - i*:windows32*:*) - # uname -m includes "-pc" on this system. - echo ${UNAME_MACHINE}-mingw32 - exit ;; - i*:PW*:*) - echo ${UNAME_MACHINE}-pc-pw32 - exit ;; - x86:Interix*:[3456]*) - echo i586-pc-interix${UNAME_RELEASE} - exit ;; - EM64T:Interix*:[3456]* | authenticamd:Interix*:[3456]*) - echo x86_64-unknown-interix${UNAME_RELEASE} - exit ;; - [345]86:Windows_95:* | [345]86:Windows_98:* | [345]86:Windows_NT:*) - echo i${UNAME_MACHINE}-pc-mks - exit ;; - i*:Windows_NT*:* | Pentium*:Windows_NT*:*) - # How do we know it's Interix rather than the generic POSIX subsystem? - # It also conflicts with pre-2.0 versions of AT&T UWIN. Should we - # UNAME_MACHINE based on the output of uname instead of i386? - echo i586-pc-interix - exit ;; - i*:UWIN*:*) - echo ${UNAME_MACHINE}-pc-uwin - exit ;; - amd64:CYGWIN*:*:* | x86_64:CYGWIN*:*:*) - echo x86_64-unknown-cygwin - exit ;; - p*:CYGWIN*:*) - echo powerpcle-unknown-cygwin - exit ;; - prep*:SunOS:5.*:*) - echo powerpcle-unknown-solaris2`echo ${UNAME_RELEASE}|sed -e 's/[^.]*//'` - exit ;; - *:GNU:*:*) - # the GNU system - echo `echo ${UNAME_MACHINE}|sed -e 's,[-/].*$,,'`-unknown-gnu`echo ${UNAME_RELEASE}|sed -e 's,/.*$,,'` - exit ;; - *:GNU/*:*:*) - # other systems with GNU libc and userland - echo ${UNAME_MACHINE}-unknown-`echo ${UNAME_SYSTEM} | sed 's,^[^/]*/,,' | tr '[A-Z]' '[a-z]'``echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'`-gnu - exit ;; - i*86:Minix:*:*) - echo ${UNAME_MACHINE}-pc-minix - exit ;; - arm*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - avr32*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - cris:Linux:*:*) - echo cris-axis-linux-gnu - exit ;; - crisv32:Linux:*:*) - echo crisv32-axis-linux-gnu - exit ;; - frv:Linux:*:*) - echo frv-unknown-linux-gnu - exit ;; - ia64:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - m32r*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - m68*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - mips:Linux:*:*) - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - #undef CPU - #undef mips - #undef mipsel - #if defined(__MIPSEL__) || defined(__MIPSEL) || defined(_MIPSEL) || defined(MIPSEL) - CPU=mipsel - #else - #if defined(__MIPSEB__) || defined(__MIPSEB) || defined(_MIPSEB) || defined(MIPSEB) - CPU=mips - #else - CPU= - #endif - #endif -EOF - eval "`$CC_FOR_BUILD -E $dummy.c 2>/dev/null | sed -n ' - /^CPU/{ - s: ::g - p - }'`" - test x"${CPU}" != x && { echo "${CPU}-unknown-linux-gnu"; exit; } - ;; - mips64:Linux:*:*) - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - #undef CPU - #undef mips64 - #undef mips64el - #if defined(__MIPSEL__) || defined(__MIPSEL) || defined(_MIPSEL) || defined(MIPSEL) - CPU=mips64el - #else - #if defined(__MIPSEB__) || defined(__MIPSEB) || defined(_MIPSEB) || defined(MIPSEB) - CPU=mips64 - #else - CPU= - #endif - #endif -EOF - eval "`$CC_FOR_BUILD -E $dummy.c 2>/dev/null | sed -n ' - /^CPU/{ - s: ::g - p - }'`" - test x"${CPU}" != x && { echo "${CPU}-unknown-linux-gnu"; exit; } - ;; - or32:Linux:*:*) - echo or32-unknown-linux-gnu - exit ;; - ppc:Linux:*:*) - echo powerpc-unknown-linux-gnu - exit ;; - ppc64:Linux:*:*) - echo powerpc64-unknown-linux-gnu - exit ;; - alpha:Linux:*:*) - case `sed -n '/^cpu model/s/^.*: \(.*\)/\1/p' < /proc/cpuinfo` in - EV5) UNAME_MACHINE=alphaev5 ;; - EV56) UNAME_MACHINE=alphaev56 ;; - PCA56) UNAME_MACHINE=alphapca56 ;; - PCA57) UNAME_MACHINE=alphapca56 ;; - EV6) UNAME_MACHINE=alphaev6 ;; - EV67) UNAME_MACHINE=alphaev67 ;; - EV68*) UNAME_MACHINE=alphaev68 ;; - esac - objdump --private-headers /bin/sh | grep ld.so.1 >/dev/null - if test "$?" = 0 ; then LIBC="libc1" ; else LIBC="" ; fi - echo ${UNAME_MACHINE}-unknown-linux-gnu${LIBC} - exit ;; - parisc:Linux:*:* | hppa:Linux:*:*) - # Look for CPU level - case `grep '^cpu[^a-z]*:' /proc/cpuinfo 2>/dev/null | cut -d' ' -f2` in - PA7*) echo hppa1.1-unknown-linux-gnu ;; - PA8*) echo hppa2.0-unknown-linux-gnu ;; - *) echo hppa-unknown-linux-gnu ;; - esac - exit ;; - parisc64:Linux:*:* | hppa64:Linux:*:*) - echo hppa64-unknown-linux-gnu - exit ;; - s390:Linux:*:* | s390x:Linux:*:*) - echo ${UNAME_MACHINE}-ibm-linux - exit ;; - sh64*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - sh*:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - sparc:Linux:*:* | sparc64:Linux:*:*) - echo ${UNAME_MACHINE}-unknown-linux-gnu - exit ;; - vax:Linux:*:*) - echo ${UNAME_MACHINE}-dec-linux-gnu - exit ;; - x86_64:Linux:*:*) - echo x86_64-unknown-linux-gnu - exit ;; - xtensa:Linux:*:*) - echo xtensa-unknown-linux-gnu - exit ;; - i*86:Linux:*:*) - # The BFD linker knows what the default object file format is, so - # first see if it will tell us. cd to the root directory to prevent - # problems with other programs or directories called `ld' in the path. - # Set LC_ALL=C to ensure ld outputs messages in English. - ld_supported_targets=`cd /; LC_ALL=C ld --help 2>&1 \ - | sed -ne '/supported targets:/!d - s/[ ][ ]*/ /g - s/.*supported targets: *// - s/ .*// - p'` - case "$ld_supported_targets" in - elf32-i386) - TENTATIVE="${UNAME_MACHINE}-pc-linux-gnu" - ;; - a.out-i386-linux) - echo "${UNAME_MACHINE}-pc-linux-gnuaout" - exit ;; - coff-i386) - echo "${UNAME_MACHINE}-pc-linux-gnucoff" - exit ;; - "") - # Either a pre-BFD a.out linker (linux-gnuoldld) or - # one that does not give us useful --help. - echo "${UNAME_MACHINE}-pc-linux-gnuoldld" - exit ;; - esac - # Determine whether the default compiler is a.out or elf - eval $set_cc_for_build - sed 's/^ //' << EOF >$dummy.c - #include <features.h> - #ifdef __ELF__ - # ifdef __GLIBC__ - # if __GLIBC__ >= 2 - LIBC=gnu - # else - LIBC=gnulibc1 - # endif - # else - LIBC=gnulibc1 - # endif - #else - #if defined(__INTEL_COMPILER) || defined(__PGI) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) - LIBC=gnu - #else - LIBC=gnuaout - #endif - #endif - #ifdef __dietlibc__ - LIBC=dietlibc - #endif -EOF - eval "`$CC_FOR_BUILD -E $dummy.c 2>/dev/null | sed -n ' - /^LIBC/{ - s: ::g - p - }'`" - test x"${LIBC}" != x && { - echo "${UNAME_MACHINE}-pc-linux-${LIBC}" - exit - } - test x"${TENTATIVE}" != x && { echo "${TENTATIVE}"; exit; } - ;; - i*86:DYNIX/ptx:4*:*) - # ptx 4.0 does uname -s correctly, with DYNIX/ptx in there. - # earlier versions are messed up and put the nodename in both - # sysname and nodename. - echo i386-sequent-sysv4 - exit ;; - i*86:UNIX_SV:4.2MP:2.*) - # Unixware is an offshoot of SVR4, but it has its own version - # number series starting with 2... - # I am not positive that other SVR4 systems won't match this, - # I just have to hope. -- rms. - # Use sysv4.2uw... so that sysv4* matches it. - echo ${UNAME_MACHINE}-pc-sysv4.2uw${UNAME_VERSION} - exit ;; - i*86:OS/2:*:*) - # If we were able to find `uname', then EMX Unix compatibility - # is probably installed. - echo ${UNAME_MACHINE}-pc-os2-emx - exit ;; - i*86:XTS-300:*:STOP) - echo ${UNAME_MACHINE}-unknown-stop - exit ;; - i*86:atheos:*:*) - echo ${UNAME_MACHINE}-unknown-atheos - exit ;; - i*86:syllable:*:*) - echo ${UNAME_MACHINE}-pc-syllable - exit ;; - i*86:LynxOS:2.*:* | i*86:LynxOS:3.[01]*:* | i*86:LynxOS:4.0*:*) - echo i386-unknown-lynxos${UNAME_RELEASE} - exit ;; - i*86:*DOS:*:*) - echo ${UNAME_MACHINE}-pc-msdosdjgpp - exit ;; - i*86:*:4.*:* | i*86:SYSTEM_V:4.*:*) - UNAME_REL=`echo ${UNAME_RELEASE} | sed 's/\/MP$//'` - if grep Novell /usr/include/link.h >/dev/null 2>/dev/null; then - echo ${UNAME_MACHINE}-univel-sysv${UNAME_REL} - else - echo ${UNAME_MACHINE}-pc-sysv${UNAME_REL} - fi - exit ;; - i*86:*:5:[678]*) - # UnixWare 7.x, OpenUNIX and OpenServer 6. - case `/bin/uname -X | grep "^Machine"` in - *486*) UNAME_MACHINE=i486 ;; - *Pentium) UNAME_MACHINE=i586 ;; - *Pent*|*Celeron) UNAME_MACHINE=i686 ;; - esac - echo ${UNAME_MACHINE}-unknown-sysv${UNAME_RELEASE}${UNAME_SYSTEM}${UNAME_VERSION} - exit ;; - i*86:*:3.2:*) - if test -f /usr/options/cb.name; then - UNAME_REL=`sed -n 's/.*Version //p' </usr/options/cb.name` - echo ${UNAME_MACHINE}-pc-isc$UNAME_REL - elif /bin/uname -X 2>/dev/null >/dev/null ; then - UNAME_REL=`(/bin/uname -X|grep Release|sed -e 's/.*= //')` - (/bin/uname -X|grep i80486 >/dev/null) && UNAME_MACHINE=i486 - (/bin/uname -X|grep '^Machine.*Pentium' >/dev/null) \ - && UNAME_MACHINE=i586 - (/bin/uname -X|grep '^Machine.*Pent *II' >/dev/null) \ - && UNAME_MACHINE=i686 - (/bin/uname -X|grep '^Machine.*Pentium Pro' >/dev/null) \ - && UNAME_MACHINE=i686 - echo ${UNAME_MACHINE}-pc-sco$UNAME_REL - else - echo ${UNAME_MACHINE}-pc-sysv32 - fi - exit ;; - pc:*:*:*) - # Left here for compatibility: - # uname -m prints for DJGPP always 'pc', but it prints nothing about - # the processor, so we play safe by assuming i386. - echo i386-pc-msdosdjgpp - exit ;; - Intel:Mach:3*:*) - echo i386-pc-mach3 - exit ;; - paragon:*:*:*) - echo i860-intel-osf1 - exit ;; - i860:*:4.*:*) # i860-SVR4 - if grep Stardent /usr/include/sys/uadmin.h >/dev/null 2>&1 ; then - echo i860-stardent-sysv${UNAME_RELEASE} # Stardent Vistra i860-SVR4 - else # Add other i860-SVR4 vendors below as they are discovered. - echo i860-unknown-sysv${UNAME_RELEASE} # Unknown i860-SVR4 - fi - exit ;; - mini*:CTIX:SYS*5:*) - # "miniframe" - echo m68010-convergent-sysv - exit ;; - mc68k:UNIX:SYSTEM5:3.51m) - echo m68k-convergent-sysv - exit ;; - M680?0:D-NIX:5.3:*) - echo m68k-diab-dnix - exit ;; - M68*:*:R3V[5678]*:*) - test -r /sysV68 && { echo 'm68k-motorola-sysv'; exit; } ;; - 3[345]??:*:4.0:3.0 | 3[34]??A:*:4.0:3.0 | 3[34]??,*:*:4.0:3.0 | 3[34]??/*:*:4.0:3.0 | 4400:*:4.0:3.0 | 4850:*:4.0:3.0 | SKA40:*:4.0:3.0 | SDS2:*:4.0:3.0 | SHG2:*:4.0:3.0 | S7501*:*:4.0:3.0) - OS_REL='' - test -r /etc/.relid \ - && OS_REL=.`sed -n 's/[^ ]* [^ ]* \([0-9][0-9]\).*/\1/p' < /etc/.relid` - /bin/uname -p 2>/dev/null | grep 86 >/dev/null \ - && { echo i486-ncr-sysv4.3${OS_REL}; exit; } - /bin/uname -p 2>/dev/null | /bin/grep entium >/dev/null \ - && { echo i586-ncr-sysv4.3${OS_REL}; exit; } ;; - 3[34]??:*:4.0:* | 3[34]??,*:*:4.0:*) - /bin/uname -p 2>/dev/null | grep 86 >/dev/null \ - && { echo i486-ncr-sysv4; exit; } ;; - m68*:LynxOS:2.*:* | m68*:LynxOS:3.0*:*) - echo m68k-unknown-lynxos${UNAME_RELEASE} - exit ;; - mc68030:UNIX_System_V:4.*:*) - echo m68k-atari-sysv4 - exit ;; - TSUNAMI:LynxOS:2.*:*) - echo sparc-unknown-lynxos${UNAME_RELEASE} - exit ;; - rs6000:LynxOS:2.*:*) - echo rs6000-unknown-lynxos${UNAME_RELEASE} - exit ;; - PowerPC:LynxOS:2.*:* | PowerPC:LynxOS:3.[01]*:* | PowerPC:LynxOS:4.0*:*) - echo powerpc-unknown-lynxos${UNAME_RELEASE} - exit ;; - SM[BE]S:UNIX_SV:*:*) - echo mips-dde-sysv${UNAME_RELEASE} - exit ;; - RM*:ReliantUNIX-*:*:*) - echo mips-sni-sysv4 - exit ;; - RM*:SINIX-*:*:*) - echo mips-sni-sysv4 - exit ;; - *:SINIX-*:*:*) - if uname -p 2>/dev/null >/dev/null ; then - UNAME_MACHINE=`(uname -p) 2>/dev/null` - echo ${UNAME_MACHINE}-sni-sysv4 - else - echo ns32k-sni-sysv - fi - exit ;; - PENTIUM:*:4.0*:*) # Unisys `ClearPath HMP IX 4000' SVR4/MP effort - # says <Richard.M.Bartel@ccMail.Census.GOV> - echo i586-unisys-sysv4 - exit ;; - *:UNIX_System_V:4*:FTX*) - # From Gerald Hewes <hewes@openmarket.com>. - # How about differentiating between stratus architectures? -djm - echo hppa1.1-stratus-sysv4 - exit ;; - *:*:*:FTX*) - # From seanf@swdc.stratus.com. - echo i860-stratus-sysv4 - exit ;; - i*86:VOS:*:*) - # From Paul.Green@stratus.com. - echo ${UNAME_MACHINE}-stratus-vos - exit ;; - *:VOS:*:*) - # From Paul.Green@stratus.com. - echo hppa1.1-stratus-vos - exit ;; - mc68*:A/UX:*:*) - echo m68k-apple-aux${UNAME_RELEASE} - exit ;; - news*:NEWS-OS:6*:*) - echo mips-sony-newsos6 - exit ;; - R[34]000:*System_V*:*:* | R4000:UNIX_SYSV:*:* | R*000:UNIX_SV:*:*) - if [ -d /usr/nec ]; then - echo mips-nec-sysv${UNAME_RELEASE} - else - echo mips-unknown-sysv${UNAME_RELEASE} - fi - exit ;; - BeBox:BeOS:*:*) # BeOS running on hardware made by Be, PPC only. - echo powerpc-be-beos - exit ;; - BeMac:BeOS:*:*) # BeOS running on Mac or Mac clone, PPC only. - echo powerpc-apple-beos - exit ;; - BePC:BeOS:*:*) # BeOS running on Intel PC compatible. - echo i586-pc-beos - exit ;; - SX-4:SUPER-UX:*:*) - echo sx4-nec-superux${UNAME_RELEASE} - exit ;; - SX-5:SUPER-UX:*:*) - echo sx5-nec-superux${UNAME_RELEASE} - exit ;; - SX-6:SUPER-UX:*:*) - echo sx6-nec-superux${UNAME_RELEASE} - exit ;; - SX-7:SUPER-UX:*:*) - echo sx7-nec-superux${UNAME_RELEASE} - exit ;; - SX-8:SUPER-UX:*:*) - echo sx8-nec-superux${UNAME_RELEASE} - exit ;; - SX-8R:SUPER-UX:*:*) - echo sx8r-nec-superux${UNAME_RELEASE} - exit ;; - Power*:Rhapsody:*:*) - echo powerpc-apple-rhapsody${UNAME_RELEASE} - exit ;; - *:Rhapsody:*:*) - echo ${UNAME_MACHINE}-apple-rhapsody${UNAME_RELEASE} - exit ;; - *:Darwin:*:*) - UNAME_PROCESSOR=`uname -p` || UNAME_PROCESSOR=unknown - case $UNAME_PROCESSOR in - unknown) UNAME_PROCESSOR=powerpc ;; - esac - echo ${UNAME_PROCESSOR}-apple-darwin${UNAME_RELEASE} - exit ;; - *:procnto*:*:* | *:QNX:[0123456789]*:*) - UNAME_PROCESSOR=`uname -p` - if test "$UNAME_PROCESSOR" = "x86"; then - UNAME_PROCESSOR=i386 - UNAME_MACHINE=pc - fi - echo ${UNAME_PROCESSOR}-${UNAME_MACHINE}-nto-qnx${UNAME_RELEASE} - exit ;; - *:QNX:*:4*) - echo i386-pc-qnx - exit ;; - NSE-?:NONSTOP_KERNEL:*:*) - echo nse-tandem-nsk${UNAME_RELEASE} - exit ;; - NSR-?:NONSTOP_KERNEL:*:*) - echo nsr-tandem-nsk${UNAME_RELEASE} - exit ;; - *:NonStop-UX:*:*) - echo mips-compaq-nonstopux - exit ;; - BS2000:POSIX*:*:*) - echo bs2000-siemens-sysv - exit ;; - DS/*:UNIX_System_V:*:*) - echo ${UNAME_MACHINE}-${UNAME_SYSTEM}-${UNAME_RELEASE} - exit ;; - *:Plan9:*:*) - # "uname -m" is not consistent, so use $cputype instead. 386 - # is converted to i386 for consistency with other x86 - # operating systems. - if test "$cputype" = "386"; then - UNAME_MACHINE=i386 - else - UNAME_MACHINE="$cputype" - fi - echo ${UNAME_MACHINE}-unknown-plan9 - exit ;; - *:TOPS-10:*:*) - echo pdp10-unknown-tops10 - exit ;; - *:TENEX:*:*) - echo pdp10-unknown-tenex - exit ;; - KS10:TOPS-20:*:* | KL10:TOPS-20:*:* | TYPE4:TOPS-20:*:*) - echo pdp10-dec-tops20 - exit ;; - XKL-1:TOPS-20:*:* | TYPE5:TOPS-20:*:*) - echo pdp10-xkl-tops20 - exit ;; - *:TOPS-20:*:*) - echo pdp10-unknown-tops20 - exit ;; - *:ITS:*:*) - echo pdp10-unknown-its - exit ;; - SEI:*:*:SEIUX) - echo mips-sei-seiux${UNAME_RELEASE} - exit ;; - *:DragonFly:*:*) - echo ${UNAME_MACHINE}-unknown-dragonfly`echo ${UNAME_RELEASE}|sed -e 's/[-(].*//'` - exit ;; - *:*VMS:*:*) - UNAME_MACHINE=`(uname -p) 2>/dev/null` - case "${UNAME_MACHINE}" in - A*) echo alpha-dec-vms ; exit ;; - I*) echo ia64-dec-vms ; exit ;; - V*) echo vax-dec-vms ; exit ;; - esac ;; - *:XENIX:*:SysV) - echo i386-pc-xenix - exit ;; - i*86:skyos:*:*) - echo ${UNAME_MACHINE}-pc-skyos`echo ${UNAME_RELEASE}` | sed -e 's/ .*$//' - exit ;; - i*86:rdos:*:*) - echo ${UNAME_MACHINE}-pc-rdos - exit ;; -esac - -#echo '(No uname command or uname output not recognized.)' 1>&2 -#echo "${UNAME_MACHINE}:${UNAME_SYSTEM}:${UNAME_RELEASE}:${UNAME_VERSION}" 1>&2 - -eval $set_cc_for_build -cat >$dummy.c <<EOF -#ifdef _SEQUENT_ -# include <sys/types.h> -# include <sys/utsname.h> -#endif -main () -{ -#if defined (sony) -#if defined (MIPSEB) - /* BFD wants "bsd" instead of "newsos". Perhaps BFD should be changed, - I don't know.... */ - printf ("mips-sony-bsd\n"); exit (0); -#else -#include <sys/param.h> - printf ("m68k-sony-newsos%s\n", -#ifdef NEWSOS4 - "4" -#else - "" -#endif - ); exit (0); -#endif -#endif - -#if defined (__arm) && defined (__acorn) && defined (__unix) - printf ("arm-acorn-riscix\n"); exit (0); -#endif - -#if defined (hp300) && !defined (hpux) - printf ("m68k-hp-bsd\n"); exit (0); -#endif - -#if defined (NeXT) -#if !defined (__ARCHITECTURE__) -#define __ARCHITECTURE__ "m68k" -#endif - int version; - version=`(hostinfo | sed -n 's/.*NeXT Mach \([0-9]*\).*/\1/p') 2>/dev/null`; - if (version < 4) - printf ("%s-next-nextstep%d\n", __ARCHITECTURE__, version); - else - printf ("%s-next-openstep%d\n", __ARCHITECTURE__, version); - exit (0); -#endif - -#if defined (MULTIMAX) || defined (n16) -#if defined (UMAXV) - printf ("ns32k-encore-sysv\n"); exit (0); -#else -#if defined (CMU) - printf ("ns32k-encore-mach\n"); exit (0); -#else - printf ("ns32k-encore-bsd\n"); exit (0); -#endif -#endif -#endif - -#if defined (__386BSD__) - printf ("i386-pc-bsd\n"); exit (0); -#endif - -#if defined (sequent) -#if defined (i386) - printf ("i386-sequent-dynix\n"); exit (0); -#endif -#if defined (ns32000) - printf ("ns32k-sequent-dynix\n"); exit (0); -#endif -#endif - -#if defined (_SEQUENT_) - struct utsname un; - - uname(&un); - - if (strncmp(un.version, "V2", 2) == 0) { - printf ("i386-sequent-ptx2\n"); exit (0); - } - if (strncmp(un.version, "V1", 2) == 0) { /* XXX is V1 correct? */ - printf ("i386-sequent-ptx1\n"); exit (0); - } - printf ("i386-sequent-ptx\n"); exit (0); - -#endif - -#if defined (vax) -# if !defined (ultrix) -# include <sys/param.h> -# if defined (BSD) -# if BSD == 43 - printf ("vax-dec-bsd4.3\n"); exit (0); -# else -# if BSD == 199006 - printf ("vax-dec-bsd4.3reno\n"); exit (0); -# else - printf ("vax-dec-bsd\n"); exit (0); -# endif -# endif -# else - printf ("vax-dec-bsd\n"); exit (0); -# endif -# else - printf ("vax-dec-ultrix\n"); exit (0); -# endif -#endif - -#if defined (alliant) && defined (i860) - printf ("i860-alliant-bsd\n"); exit (0); -#endif - - exit (1); -} -EOF - -$CC_FOR_BUILD -o $dummy $dummy.c 2>/dev/null && SYSTEM_NAME=`$dummy` && - { echo "$SYSTEM_NAME"; exit; } - -# Apollos put the system type in the environment. - -test -d /usr/apollo && { echo ${ISP}-apollo-${SYSTYPE}; exit; } - -# Convex versions that predate uname can use getsysinfo(1) - -if [ -x /usr/convex/getsysinfo ] -then - case `getsysinfo -f cpu_type` in - c1*) - echo c1-convex-bsd - exit ;; - c2*) - if getsysinfo -f scalar_acc - then echo c32-convex-bsd - else echo c2-convex-bsd - fi - exit ;; - c34*) - echo c34-convex-bsd - exit ;; - c38*) - echo c38-convex-bsd - exit ;; - c4*) - echo c4-convex-bsd - exit ;; - esac -fi - -cat >&2 <<EOF -$0: unable to guess system type - -This script, last modified $timestamp, has failed to recognize -the operating system you are using. It is advised that you -download the most up to date version of the config scripts from - - http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.guess -and - http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/config.sub - -If the version you run ($0) is already up to date, please -send the following data and any information you think might be -pertinent to <config-patches@gnu.org> in order to provide the needed -information to handle your system. - -config.guess timestamp = $timestamp - -uname -m = `(uname -m) 2>/dev/null || echo unknown` -uname -r = `(uname -r) 2>/dev/null || echo unknown` -uname -s = `(uname -s) 2>/dev/null || echo unknown` -uname -v = `(uname -v) 2>/dev/null || echo unknown` - -/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null` -/bin/uname -X = `(/bin/uname -X) 2>/dev/null` - -hostinfo = `(hostinfo) 2>/dev/null` -/bin/universe = `(/bin/universe) 2>/dev/null` -/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null` -/bin/arch = `(/bin/arch) 2>/dev/null` -/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null` -/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null` - -UNAME_MACHINE = ${UNAME_MACHINE} -UNAME_RELEASE = ${UNAME_RELEASE} -UNAME_SYSTEM = ${UNAME_SYSTEM} -UNAME_VERSION = ${UNAME_VERSION} -EOF - -exit 1 - -# Local variables: -# eval: (add-hook 'write-file-hooks 'time-stamp) -# time-stamp-start: "timestamp='" -# time-stamp-format: "%:y-%02m-%02d" -# time-stamp-end: "'" -# End: diff --git a/Build/source/utils/texi2html/config.sub b/Build/source/utils/texi2html/config.sub deleted file mode 100755 index 5defff65a6e..00000000000 --- a/Build/source/utils/texi2html/config.sub +++ /dev/null @@ -1,1622 +0,0 @@ -#! /bin/sh -# Configuration validation subroutine script. -# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, -# 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, -# Inc. - -timestamp='2007-01-18' - -# This file is (in principle) common to ALL GNU software. -# The presence of a machine in this file suggests that SOME GNU software -# can handle that machine. It does not imply ALL GNU software can. -# -# This 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 of the License, 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., 51 Franklin Street - Fifth Floor, Boston, MA -# 02110-1301, USA. -# -# As a special exception to the GNU General Public License, if you -# distribute this file as part of a program that contains a -# configuration script generated by Autoconf, you may include it under -# the same distribution terms that you use for the rest of that program. - - -# Please send patches to <config-patches@gnu.org>. Submit a context -# diff and a properly formatted ChangeLog entry. -# -# Configuration subroutine to validate and canonicalize a configuration type. -# Supply the specified configuration type as an argument. -# If it is invalid, we print an error message on stderr and exit with code 1. -# Otherwise, we print the canonical config type on stdout and succeed. - -# This file is supposed to be the same for all GNU packages -# and recognize all the CPU types, system types and aliases -# that are meaningful with *any* GNU software. -# Each package is responsible for reporting which valid configurations -# it does not support. The user should be able to distinguish -# a failure to support a valid configuration from a meaningless -# configuration. - -# The goal of this file is to map all the various variations of a given -# machine specification into a single specification in the form: -# CPU_TYPE-MANUFACTURER-OPERATING_SYSTEM -# or in some cases, the newer four-part form: -# CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM -# It is wrong to echo any other type of specification. - -me=`echo "$0" | sed -e 's,.*/,,'` - -usage="\ -Usage: $0 [OPTION] CPU-MFR-OPSYS - $0 [OPTION] ALIAS - -Canonicalize a configuration name. - -Operation modes: - -h, --help print this help, then exit - -t, --time-stamp print date of last modification, then exit - -v, --version print version number, then exit - -Report bugs and patches to <config-patches@gnu.org>." - -version="\ -GNU config.sub ($timestamp) - -Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 -Free Software Foundation, Inc. - -This is free software; see the source for copying conditions. There is NO -warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." - -help=" -Try \`$me --help' for more information." - -# Parse command line -while test $# -gt 0 ; do - case $1 in - --time-stamp | --time* | -t ) - echo "$timestamp" ; exit ;; - --version | -v ) - echo "$version" ; exit ;; - --help | --h* | -h ) - echo "$usage"; exit ;; - -- ) # Stop option processing - shift; break ;; - - ) # Use stdin as input. - break ;; - -* ) - echo "$me: invalid option $1$help" - exit 1 ;; - - *local*) - # First pass through any local machine types. - echo $1 - exit ;; - - * ) - break ;; - esac -done - -case $# in - 0) echo "$me: missing argument$help" >&2 - exit 1;; - 1) ;; - *) echo "$me: too many arguments$help" >&2 - exit 1;; -esac - -# Separate what the user gave into CPU-COMPANY and OS or KERNEL-OS (if any). -# Here we must recognize all the valid KERNEL-OS combinations. -maybe_os=`echo $1 | sed 's/^\(.*\)-\([^-]*-[^-]*\)$/\2/'` -case $maybe_os in - nto-qnx* | linux-gnu* | linux-dietlibc | linux-newlib* | linux-uclibc* | \ - uclinux-uclibc* | uclinux-gnu* | kfreebsd*-gnu* | knetbsd*-gnu* | netbsd*-gnu* | \ - storm-chaos* | os2-emx* | rtmk-nova*) - os=-$maybe_os - basic_machine=`echo $1 | sed 's/^\(.*\)-\([^-]*-[^-]*\)$/\1/'` - ;; - *) - basic_machine=`echo $1 | sed 's/-[^-]*$//'` - if [ $basic_machine != $1 ] - then os=`echo $1 | sed 's/.*-/-/'` - else os=; fi - ;; -esac - -### Let's recognize common machines as not being operating systems so -### that things like config.sub decstation-3100 work. We also -### recognize some manufacturers as not being operating systems, so we -### can provide default operating systems below. -case $os in - -sun*os*) - # Prevent following clause from handling this invalid input. - ;; - -dec* | -mips* | -sequent* | -encore* | -pc532* | -sgi* | -sony* | \ - -att* | -7300* | -3300* | -delta* | -motorola* | -sun[234]* | \ - -unicom* | -ibm* | -next | -hp | -isi* | -apollo | -altos* | \ - -convergent* | -ncr* | -news | -32* | -3600* | -3100* | -hitachi* |\ - -c[123]* | -convex* | -sun | -crds | -omron* | -dg | -ultra | -tti* | \ - -harris | -dolphin | -highlevel | -gould | -cbm | -ns | -masscomp | \ - -apple | -axis | -knuth | -cray) - os= - basic_machine=$1 - ;; - -sim | -cisco | -oki | -wec | -winbond) - os= - basic_machine=$1 - ;; - -scout) - ;; - -wrs) - os=-vxworks - basic_machine=$1 - ;; - -chorusos*) - os=-chorusos - basic_machine=$1 - ;; - -chorusrdb) - os=-chorusrdb - basic_machine=$1 - ;; - -hiux*) - os=-hiuxwe2 - ;; - -sco6) - os=-sco5v6 - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco5) - os=-sco3.2v5 - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco4) - os=-sco3.2v4 - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco3.2.[4-9]*) - os=`echo $os | sed -e 's/sco3.2./sco3.2v/'` - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco3.2v[4-9]*) - # Don't forget version if it is 3.2v4 or newer. - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco5v6*) - # Don't forget version if it is 3.2v4 or newer. - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -sco*) - os=-sco3.2v2 - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -udk*) - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -isc) - os=-isc2.2 - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -clix*) - basic_machine=clipper-intergraph - ;; - -isc*) - basic_machine=`echo $1 | sed -e 's/86-.*/86-pc/'` - ;; - -lynx*) - os=-lynxos - ;; - -ptx*) - basic_machine=`echo $1 | sed -e 's/86-.*/86-sequent/'` - ;; - -windowsnt*) - os=`echo $os | sed -e 's/windowsnt/winnt/'` - ;; - -psos*) - os=-psos - ;; - -mint | -mint[0-9]*) - basic_machine=m68k-atari - os=-mint - ;; -esac - -# Decode aliases for certain CPU-COMPANY combinations. -case $basic_machine in - # Recognize the basic CPU types without company name. - # Some are omitted here because they have special meanings below. - 1750a | 580 \ - | a29k \ - | alpha | alphaev[4-8] | alphaev56 | alphaev6[78] | alphapca5[67] \ - | alpha64 | alpha64ev[4-8] | alpha64ev56 | alpha64ev6[78] | alpha64pca5[67] \ - | am33_2.0 \ - | arc | arm | arm[bl]e | arme[lb] | armv[2345] | armv[345][lb] | avr | avr32 \ - | bfin \ - | c4x | clipper \ - | d10v | d30v | dlx | dsp16xx \ - | fido | fr30 | frv \ - | h8300 | h8500 | hppa | hppa1.[01] | hppa2.0 | hppa2.0[nw] | hppa64 \ - | i370 | i860 | i960 | ia64 \ - | ip2k | iq2000 \ - | m32c | m32r | m32rle | m68000 | m68k | m88k \ - | maxq | mb | microblaze | mcore | mep \ - | mips | mipsbe | mipseb | mipsel | mipsle \ - | mips16 \ - | mips64 | mips64el \ - | mips64vr | mips64vrel \ - | mips64orion | mips64orionel \ - | mips64vr4100 | mips64vr4100el \ - | mips64vr4300 | mips64vr4300el \ - | mips64vr5000 | mips64vr5000el \ - | mips64vr5900 | mips64vr5900el \ - | mipsisa32 | mipsisa32el \ - | mipsisa32r2 | mipsisa32r2el \ - | mipsisa64 | mipsisa64el \ - | mipsisa64r2 | mipsisa64r2el \ - | mipsisa64sb1 | mipsisa64sb1el \ - | mipsisa64sr71k | mipsisa64sr71kel \ - | mipstx39 | mipstx39el \ - | mn10200 | mn10300 \ - | mt \ - | msp430 \ - | nios | nios2 \ - | ns16k | ns32k \ - | or32 \ - | pdp10 | pdp11 | pj | pjl \ - | powerpc | powerpc64 | powerpc64le | powerpcle | ppcbe \ - | pyramid \ - | score \ - | sh | sh[1234] | sh[24]a | sh[23]e | sh[34]eb | sheb | shbe | shle | sh[1234]le | sh3ele \ - | sh64 | sh64le \ - | sparc | sparc64 | sparc64b | sparc64v | sparc86x | sparclet | sparclite \ - | sparcv8 | sparcv9 | sparcv9b | sparcv9v \ - | spu | strongarm \ - | tahoe | thumb | tic4x | tic80 | tron \ - | v850 | v850e \ - | we32k \ - | x86 | xc16x | xscale | xscalee[bl] | xstormy16 | xtensa \ - | z8k) - basic_machine=$basic_machine-unknown - ;; - m6811 | m68hc11 | m6812 | m68hc12) - # Motorola 68HC11/12. - basic_machine=$basic_machine-unknown - os=-none - ;; - m88110 | m680[12346]0 | m683?2 | m68360 | m5200 | v70 | w65 | z8k) - ;; - ms1) - basic_machine=mt-unknown - ;; - - # We use `pc' rather than `unknown' - # because (1) that's what they normally are, and - # (2) the word "unknown" tends to confuse beginning users. - i*86 | x86_64) - basic_machine=$basic_machine-pc - ;; - # Object if more than one company name word. - *-*-*) - echo Invalid configuration \`$1\': machine \`$basic_machine\' not recognized 1>&2 - exit 1 - ;; - # Recognize the basic CPU types with company name. - 580-* \ - | a29k-* \ - | alpha-* | alphaev[4-8]-* | alphaev56-* | alphaev6[78]-* \ - | alpha64-* | alpha64ev[4-8]-* | alpha64ev56-* | alpha64ev6[78]-* \ - | alphapca5[67]-* | alpha64pca5[67]-* | arc-* \ - | arm-* | armbe-* | armle-* | armeb-* | armv*-* \ - | avr-* | avr32-* \ - | bfin-* | bs2000-* \ - | c[123]* | c30-* | [cjt]90-* | c4x-* | c54x-* | c55x-* | c6x-* \ - | clipper-* | craynv-* | cydra-* \ - | d10v-* | d30v-* | dlx-* \ - | elxsi-* \ - | f30[01]-* | f700-* | fido-* | fr30-* | frv-* | fx80-* \ - | h8300-* | h8500-* \ - | hppa-* | hppa1.[01]-* | hppa2.0-* | hppa2.0[nw]-* | hppa64-* \ - | i*86-* | i860-* | i960-* | ia64-* \ - | ip2k-* | iq2000-* \ - | m32c-* | m32r-* | m32rle-* \ - | m68000-* | m680[012346]0-* | m68360-* | m683?2-* | m68k-* \ - | m88110-* | m88k-* | maxq-* | mcore-* \ - | mips-* | mipsbe-* | mipseb-* | mipsel-* | mipsle-* \ - | mips16-* \ - | mips64-* | mips64el-* \ - | mips64vr-* | mips64vrel-* \ - | mips64orion-* | mips64orionel-* \ - | mips64vr4100-* | mips64vr4100el-* \ - | mips64vr4300-* | mips64vr4300el-* \ - | mips64vr5000-* | mips64vr5000el-* \ - | mips64vr5900-* | mips64vr5900el-* \ - | mipsisa32-* | mipsisa32el-* \ - | mipsisa32r2-* | mipsisa32r2el-* \ - | mipsisa64-* | mipsisa64el-* \ - | mipsisa64r2-* | mipsisa64r2el-* \ - | mipsisa64sb1-* | mipsisa64sb1el-* \ - | mipsisa64sr71k-* | mipsisa64sr71kel-* \ - | mipstx39-* | mipstx39el-* \ - | mmix-* \ - | mt-* \ - | msp430-* \ - | nios-* | nios2-* \ - | none-* | np1-* | ns16k-* | ns32k-* \ - | orion-* \ - | pdp10-* | pdp11-* | pj-* | pjl-* | pn-* | power-* \ - | powerpc-* | powerpc64-* | powerpc64le-* | powerpcle-* | ppcbe-* \ - | pyramid-* \ - | romp-* | rs6000-* \ - | sh-* | sh[1234]-* | sh[24]a-* | sh[23]e-* | sh[34]eb-* | sheb-* | shbe-* \ - | shle-* | sh[1234]le-* | sh3ele-* | sh64-* | sh64le-* \ - | sparc-* | sparc64-* | sparc64b-* | sparc64v-* | sparc86x-* | sparclet-* \ - | sparclite-* \ - | sparcv8-* | sparcv9-* | sparcv9b-* | sparcv9v-* | strongarm-* | sv1-* | sx?-* \ - | tahoe-* | thumb-* \ - | tic30-* | tic4x-* | tic54x-* | tic55x-* | tic6x-* | tic80-* \ - | tron-* \ - | v850-* | v850e-* | vax-* \ - | we32k-* \ - | x86-* | x86_64-* | xc16x-* | xps100-* | xscale-* | xscalee[bl]-* \ - | xstormy16-* | xtensa-* \ - | ymp-* \ - | z8k-*) - ;; - # Recognize the various machine names and aliases which stand - # for a CPU type and a company and sometimes even an OS. - 386bsd) - basic_machine=i386-unknown - os=-bsd - ;; - 3b1 | 7300 | 7300-att | att-7300 | pc7300 | safari | unixpc) - basic_machine=m68000-att - ;; - 3b*) - basic_machine=we32k-att - ;; - a29khif) - basic_machine=a29k-amd - os=-udi - ;; - abacus) - basic_machine=abacus-unknown - ;; - adobe68k) - basic_machine=m68010-adobe - os=-scout - ;; - alliant | fx80) - basic_machine=fx80-alliant - ;; - altos | altos3068) - basic_machine=m68k-altos - ;; - am29k) - basic_machine=a29k-none - os=-bsd - ;; - amd64) - basic_machine=x86_64-pc - ;; - amd64-*) - basic_machine=x86_64-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - amdahl) - basic_machine=580-amdahl - os=-sysv - ;; - amiga | amiga-*) - basic_machine=m68k-unknown - ;; - amigaos | amigados) - basic_machine=m68k-unknown - os=-amigaos - ;; - amigaunix | amix) - basic_machine=m68k-unknown - os=-sysv4 - ;; - apollo68) - basic_machine=m68k-apollo - os=-sysv - ;; - apollo68bsd) - basic_machine=m68k-apollo - os=-bsd - ;; - aux) - basic_machine=m68k-apple - os=-aux - ;; - balance) - basic_machine=ns32k-sequent - os=-dynix - ;; - c90) - basic_machine=c90-cray - os=-unicos - ;; - convex-c1) - basic_machine=c1-convex - os=-bsd - ;; - convex-c2) - basic_machine=c2-convex - os=-bsd - ;; - convex-c32) - basic_machine=c32-convex - os=-bsd - ;; - convex-c34) - basic_machine=c34-convex - os=-bsd - ;; - convex-c38) - basic_machine=c38-convex - os=-bsd - ;; - cray | j90) - basic_machine=j90-cray - os=-unicos - ;; - craynv) - basic_machine=craynv-cray - os=-unicosmp - ;; - cr16c) - basic_machine=cr16c-unknown - os=-elf - ;; - crds | unos) - basic_machine=m68k-crds - ;; - crisv32 | crisv32-* | etraxfs*) - basic_machine=crisv32-axis - ;; - cris | cris-* | etrax*) - basic_machine=cris-axis - ;; - crx) - basic_machine=crx-unknown - os=-elf - ;; - da30 | da30-*) - basic_machine=m68k-da30 - ;; - decstation | decstation-3100 | pmax | pmax-* | pmin | dec3100 | decstatn) - basic_machine=mips-dec - ;; - decsystem10* | dec10*) - basic_machine=pdp10-dec - os=-tops10 - ;; - decsystem20* | dec20*) - basic_machine=pdp10-dec - os=-tops20 - ;; - delta | 3300 | motorola-3300 | motorola-delta \ - | 3300-motorola | delta-motorola) - basic_machine=m68k-motorola - ;; - delta88) - basic_machine=m88k-motorola - os=-sysv3 - ;; - djgpp) - basic_machine=i586-pc - os=-msdosdjgpp - ;; - dpx20 | dpx20-*) - basic_machine=rs6000-bull - os=-bosx - ;; - dpx2* | dpx2*-bull) - basic_machine=m68k-bull - os=-sysv3 - ;; - ebmon29k) - basic_machine=a29k-amd - os=-ebmon - ;; - elxsi) - basic_machine=elxsi-elxsi - os=-bsd - ;; - encore | umax | mmax) - basic_machine=ns32k-encore - ;; - es1800 | OSE68k | ose68k | ose | OSE) - basic_machine=m68k-ericsson - os=-ose - ;; - fx2800) - basic_machine=i860-alliant - ;; - genix) - basic_machine=ns32k-ns - ;; - gmicro) - basic_machine=tron-gmicro - os=-sysv - ;; - go32) - basic_machine=i386-pc - os=-go32 - ;; - h3050r* | hiux*) - basic_machine=hppa1.1-hitachi - os=-hiuxwe2 - ;; - h8300hms) - basic_machine=h8300-hitachi - os=-hms - ;; - h8300xray) - basic_machine=h8300-hitachi - os=-xray - ;; - h8500hms) - basic_machine=h8500-hitachi - os=-hms - ;; - harris) - basic_machine=m88k-harris - os=-sysv3 - ;; - hp300-*) - basic_machine=m68k-hp - ;; - hp300bsd) - basic_machine=m68k-hp - os=-bsd - ;; - hp300hpux) - basic_machine=m68k-hp - os=-hpux - ;; - hp3k9[0-9][0-9] | hp9[0-9][0-9]) - basic_machine=hppa1.0-hp - ;; - hp9k2[0-9][0-9] | hp9k31[0-9]) - basic_machine=m68000-hp - ;; - hp9k3[2-9][0-9]) - basic_machine=m68k-hp - ;; - hp9k6[0-9][0-9] | hp6[0-9][0-9]) - basic_machine=hppa1.0-hp - ;; - hp9k7[0-79][0-9] | hp7[0-79][0-9]) - basic_machine=hppa1.1-hp - ;; - hp9k78[0-9] | hp78[0-9]) - # FIXME: really hppa2.0-hp - basic_machine=hppa1.1-hp - ;; - hp9k8[67]1 | hp8[67]1 | hp9k80[24] | hp80[24] | hp9k8[78]9 | hp8[78]9 | hp9k893 | hp893) - # FIXME: really hppa2.0-hp - basic_machine=hppa1.1-hp - ;; - hp9k8[0-9][13679] | hp8[0-9][13679]) - basic_machine=hppa1.1-hp - ;; - hp9k8[0-9][0-9] | hp8[0-9][0-9]) - basic_machine=hppa1.0-hp - ;; - hppa-next) - os=-nextstep3 - ;; - hppaosf) - basic_machine=hppa1.1-hp - os=-osf - ;; - hppro) - basic_machine=hppa1.1-hp - os=-proelf - ;; - i370-ibm* | ibm*) - basic_machine=i370-ibm - ;; -# I'm not sure what "Sysv32" means. Should this be sysv3.2? - i*86v32) - basic_machine=`echo $1 | sed -e 's/86.*/86-pc/'` - os=-sysv32 - ;; - i*86v4*) - basic_machine=`echo $1 | sed -e 's/86.*/86-pc/'` - os=-sysv4 - ;; - i*86v) - basic_machine=`echo $1 | sed -e 's/86.*/86-pc/'` - os=-sysv - ;; - i*86sol2) - basic_machine=`echo $1 | sed -e 's/86.*/86-pc/'` - os=-solaris2 - ;; - i386mach) - basic_machine=i386-mach - os=-mach - ;; - i386-vsta | vsta) - basic_machine=i386-unknown - os=-vsta - ;; - iris | iris4d) - basic_machine=mips-sgi - case $os in - -irix*) - ;; - *) - os=-irix4 - ;; - esac - ;; - isi68 | isi) - basic_machine=m68k-isi - os=-sysv - ;; - m88k-omron*) - basic_machine=m88k-omron - ;; - magnum | m3230) - basic_machine=mips-mips - os=-sysv - ;; - merlin) - basic_machine=ns32k-utek - os=-sysv - ;; - mingw32) - basic_machine=i386-pc - os=-mingw32 - ;; - miniframe) - basic_machine=m68000-convergent - ;; - *mint | -mint[0-9]* | *MiNT | *MiNT[0-9]*) - basic_machine=m68k-atari - os=-mint - ;; - mips3*-*) - basic_machine=`echo $basic_machine | sed -e 's/mips3/mips64/'` - ;; - mips3*) - basic_machine=`echo $basic_machine | sed -e 's/mips3/mips64/'`-unknown - ;; - monitor) - basic_machine=m68k-rom68k - os=-coff - ;; - morphos) - basic_machine=powerpc-unknown - os=-morphos - ;; - msdos) - basic_machine=i386-pc - os=-msdos - ;; - ms1-*) - basic_machine=`echo $basic_machine | sed -e 's/ms1-/mt-/'` - ;; - mvs) - basic_machine=i370-ibm - os=-mvs - ;; - ncr3000) - basic_machine=i486-ncr - os=-sysv4 - ;; - netbsd386) - basic_machine=i386-unknown - os=-netbsd - ;; - netwinder) - basic_machine=armv4l-rebel - os=-linux - ;; - news | news700 | news800 | news900) - basic_machine=m68k-sony - os=-newsos - ;; - news1000) - basic_machine=m68030-sony - os=-newsos - ;; - news-3600 | risc-news) - basic_machine=mips-sony - os=-newsos - ;; - necv70) - basic_machine=v70-nec - os=-sysv - ;; - next | m*-next ) - basic_machine=m68k-next - case $os in - -nextstep* ) - ;; - -ns2*) - os=-nextstep2 - ;; - *) - os=-nextstep3 - ;; - esac - ;; - nh3000) - basic_machine=m68k-harris - os=-cxux - ;; - nh[45]000) - basic_machine=m88k-harris - os=-cxux - ;; - nindy960) - basic_machine=i960-intel - os=-nindy - ;; - mon960) - basic_machine=i960-intel - os=-mon960 - ;; - nonstopux) - basic_machine=mips-compaq - os=-nonstopux - ;; - np1) - basic_machine=np1-gould - ;; - nsr-tandem) - basic_machine=nsr-tandem - ;; - op50n-* | op60c-*) - basic_machine=hppa1.1-oki - os=-proelf - ;; - openrisc | openrisc-*) - basic_machine=or32-unknown - ;; - os400) - basic_machine=powerpc-ibm - os=-os400 - ;; - OSE68000 | ose68000) - basic_machine=m68000-ericsson - os=-ose - ;; - os68k) - basic_machine=m68k-none - os=-os68k - ;; - pa-hitachi) - basic_machine=hppa1.1-hitachi - os=-hiuxwe2 - ;; - paragon) - basic_machine=i860-intel - os=-osf - ;; - pbd) - basic_machine=sparc-tti - ;; - pbb) - basic_machine=m68k-tti - ;; - pc532 | pc532-*) - basic_machine=ns32k-pc532 - ;; - pc98) - basic_machine=i386-pc - ;; - pc98-*) - basic_machine=i386-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - pentium | p5 | k5 | k6 | nexgen | viac3) - basic_machine=i586-pc - ;; - pentiumpro | p6 | 6x86 | athlon | athlon_*) - basic_machine=i686-pc - ;; - pentiumii | pentium2 | pentiumiii | pentium3) - basic_machine=i686-pc - ;; - pentium4) - basic_machine=i786-pc - ;; - pentium-* | p5-* | k5-* | k6-* | nexgen-* | viac3-*) - basic_machine=i586-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - pentiumpro-* | p6-* | 6x86-* | athlon-*) - basic_machine=i686-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - pentiumii-* | pentium2-* | pentiumiii-* | pentium3-*) - basic_machine=i686-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - pentium4-*) - basic_machine=i786-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - pn) - basic_machine=pn-gould - ;; - power) basic_machine=power-ibm - ;; - ppc) basic_machine=powerpc-unknown - ;; - ppc-*) basic_machine=powerpc-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - ppcle | powerpclittle | ppc-le | powerpc-little) - basic_machine=powerpcle-unknown - ;; - ppcle-* | powerpclittle-*) - basic_machine=powerpcle-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - ppc64) basic_machine=powerpc64-unknown - ;; - ppc64-*) basic_machine=powerpc64-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - ppc64le | powerpc64little | ppc64-le | powerpc64-little) - basic_machine=powerpc64le-unknown - ;; - ppc64le-* | powerpc64little-*) - basic_machine=powerpc64le-`echo $basic_machine | sed 's/^[^-]*-//'` - ;; - ps2) - basic_machine=i386-ibm - ;; - pw32) - basic_machine=i586-unknown - os=-pw32 - ;; - rdos) - basic_machine=i386-pc - os=-rdos - ;; - rom68k) - basic_machine=m68k-rom68k - os=-coff - ;; - rm[46]00) - basic_machine=mips-siemens - ;; - rtpc | rtpc-*) - basic_machine=romp-ibm - ;; - s390 | s390-*) - basic_machine=s390-ibm - ;; - s390x | s390x-*) - basic_machine=s390x-ibm - ;; - sa29200) - basic_machine=a29k-amd - os=-udi - ;; - sb1) - basic_machine=mipsisa64sb1-unknown - ;; - sb1el) - basic_machine=mipsisa64sb1el-unknown - ;; - sde) - basic_machine=mipsisa32-sde - os=-elf - ;; - sei) - basic_machine=mips-sei - os=-seiux - ;; - sequent) - basic_machine=i386-sequent - ;; - sh) - basic_machine=sh-hitachi - os=-hms - ;; - sh5el) - basic_machine=sh5le-unknown - ;; - sh64) - basic_machine=sh64-unknown - ;; - sparclite-wrs | simso-wrs) - basic_machine=sparclite-wrs - os=-vxworks - ;; - sps7) - basic_machine=m68k-bull - os=-sysv2 - ;; - spur) - basic_machine=spur-unknown - ;; - st2000) - basic_machine=m68k-tandem - ;; - stratus) - basic_machine=i860-stratus - os=-sysv4 - ;; - sun2) - basic_machine=m68000-sun - ;; - sun2os3) - basic_machine=m68000-sun - os=-sunos3 - ;; - sun2os4) - basic_machine=m68000-sun - os=-sunos4 - ;; - sun3os3) - basic_machine=m68k-sun - os=-sunos3 - ;; - sun3os4) - basic_machine=m68k-sun - os=-sunos4 - ;; - sun4os3) - basic_machine=sparc-sun - os=-sunos3 - ;; - sun4os4) - basic_machine=sparc-sun - os=-sunos4 - ;; - sun4sol2) - basic_machine=sparc-sun - os=-solaris2 - ;; - sun3 | sun3-*) - basic_machine=m68k-sun - ;; - sun4) - basic_machine=sparc-sun - ;; - sun386 | sun386i | roadrunner) - basic_machine=i386-sun - ;; - sv1) - basic_machine=sv1-cray - os=-unicos - ;; - symmetry) - basic_machine=i386-sequent - os=-dynix - ;; - t3e) - basic_machine=alphaev5-cray - os=-unicos - ;; - t90) - basic_machine=t90-cray - os=-unicos - ;; - tic54x | c54x*) - basic_machine=tic54x-unknown - os=-coff - ;; - tic55x | c55x*) - basic_machine=tic55x-unknown - os=-coff - ;; - tic6x | c6x*) - basic_machine=tic6x-unknown - os=-coff - ;; - tx39) - basic_machine=mipstx39-unknown - ;; - tx39el) - basic_machine=mipstx39el-unknown - ;; - toad1) - basic_machine=pdp10-xkl - os=-tops20 - ;; - tower | tower-32) - basic_machine=m68k-ncr - ;; - tpf) - basic_machine=s390x-ibm - os=-tpf - ;; - udi29k) - basic_machine=a29k-amd - os=-udi - ;; - ultra3) - basic_machine=a29k-nyu - os=-sym1 - ;; - v810 | necv810) - basic_machine=v810-nec - os=-none - ;; - vaxv) - basic_machine=vax-dec - os=-sysv - ;; - vms) - basic_machine=vax-dec - os=-vms - ;; - vpp*|vx|vx-*) - basic_machine=f301-fujitsu - ;; - vxworks960) - basic_machine=i960-wrs - os=-vxworks - ;; - vxworks68) - basic_machine=m68k-wrs - os=-vxworks - ;; - vxworks29k) - basic_machine=a29k-wrs - os=-vxworks - ;; - w65*) - basic_machine=w65-wdc - os=-none - ;; - w89k-*) - basic_machine=hppa1.1-winbond - os=-proelf - ;; - xbox) - basic_machine=i686-pc - os=-mingw32 - ;; - xps | xps100) - basic_machine=xps100-honeywell - ;; - ymp) - basic_machine=ymp-cray - os=-unicos - ;; - z8k-*-coff) - basic_machine=z8k-unknown - os=-sim - ;; - none) - basic_machine=none-none - os=-none - ;; - -# Here we handle the default manufacturer of certain CPU types. It is in -# some cases the only manufacturer, in others, it is the most popular. - w89k) - basic_machine=hppa1.1-winbond - ;; - op50n) - basic_machine=hppa1.1-oki - ;; - op60c) - basic_machine=hppa1.1-oki - ;; - romp) - basic_machine=romp-ibm - ;; - mmix) - basic_machine=mmix-knuth - ;; - rs6000) - basic_machine=rs6000-ibm - ;; - vax) - basic_machine=vax-dec - ;; - pdp10) - # there are many clones, so DEC is not a safe bet - basic_machine=pdp10-unknown - ;; - pdp11) - basic_machine=pdp11-dec - ;; - we32k) - basic_machine=we32k-att - ;; - sh[1234] | sh[24]a | sh[34]eb | sh[1234]le | sh[23]ele) - basic_machine=sh-unknown - ;; - sparc | sparcv8 | sparcv9 | sparcv9b | sparcv9v) - basic_machine=sparc-sun - ;; - cydra) - basic_machine=cydra-cydrome - ;; - orion) - basic_machine=orion-highlevel - ;; - orion105) - basic_machine=clipper-highlevel - ;; - mac | mpw | mac-mpw) - basic_machine=m68k-apple - ;; - pmac | pmac-mpw) - basic_machine=powerpc-apple - ;; - *-unknown) - # Make sure to match an already-canonicalized machine name. - ;; - *) - echo Invalid configuration \`$1\': machine \`$basic_machine\' not recognized 1>&2 - exit 1 - ;; -esac - -# Here we canonicalize certain aliases for manufacturers. -case $basic_machine in - *-digital*) - basic_machine=`echo $basic_machine | sed 's/digital.*/dec/'` - ;; - *-commodore*) - basic_machine=`echo $basic_machine | sed 's/commodore.*/cbm/'` - ;; - *) - ;; -esac - -# Decode manufacturer-specific aliases for certain operating systems. - -if [ x"$os" != x"" ] -then -case $os in - # First match some system type aliases - # that might get confused with valid system types. - # -solaris* is a basic system type, with this one exception. - -solaris1 | -solaris1.*) - os=`echo $os | sed -e 's|solaris1|sunos4|'` - ;; - -solaris) - os=-solaris2 - ;; - -svr4*) - os=-sysv4 - ;; - -unixware*) - os=-sysv4.2uw - ;; - -gnu/linux*) - os=`echo $os | sed -e 's|gnu/linux|linux-gnu|'` - ;; - # First accept the basic system types. - # The portable systems comes first. - # Each alternative MUST END IN A *, to match a version number. - # -sysv* is not here because it comes later, after sysvr4. - -gnu* | -bsd* | -mach* | -minix* | -genix* | -ultrix* | -irix* \ - | -*vms* | -sco* | -esix* | -isc* | -aix* | -sunos | -sunos[34]*\ - | -hpux* | -unos* | -osf* | -luna* | -dgux* | -solaris* | -sym* \ - | -amigaos* | -amigados* | -msdos* | -newsos* | -unicos* | -aof* \ - | -aos* \ - | -nindy* | -vxsim* | -vxworks* | -ebmon* | -hms* | -mvs* \ - | -clix* | -riscos* | -uniplus* | -iris* | -rtu* | -xenix* \ - | -hiux* | -386bsd* | -knetbsd* | -mirbsd* | -netbsd* \ - | -openbsd* | -solidbsd* \ - | -ekkobsd* | -kfreebsd* | -freebsd* | -riscix* | -lynxos* \ - | -bosx* | -nextstep* | -cxux* | -aout* | -elf* | -oabi* \ - | -ptx* | -coff* | -ecoff* | -winnt* | -domain* | -vsta* \ - | -udi* | -eabi* | -lites* | -ieee* | -go32* | -aux* \ - | -chorusos* | -chorusrdb* \ - | -cygwin* | -pe* | -psos* | -moss* | -proelf* | -rtems* \ - | -mingw32* | -linux-gnu* | -linux-newlib* | -linux-uclibc* \ - | -uxpv* | -beos* | -mpeix* | -udk* \ - | -interix* | -uwin* | -mks* | -rhapsody* | -darwin* | -opened* \ - | -openstep* | -oskit* | -conix* | -pw32* | -nonstopux* \ - | -storm-chaos* | -tops10* | -tenex* | -tops20* | -its* \ - | -os2* | -vos* | -palmos* | -uclinux* | -nucleus* \ - | -morphos* | -superux* | -rtmk* | -rtmk-nova* | -windiss* \ - | -powermax* | -dnix* | -nx6 | -nx7 | -sei* | -dragonfly* \ - | -skyos* | -haiku* | -rdos* | -toppers* | -drops*) - # Remember, each alternative MUST END IN *, to match a version number. - ;; - -qnx*) - case $basic_machine in - x86-* | i*86-*) - ;; - *) - os=-nto$os - ;; - esac - ;; - -nto-qnx*) - ;; - -nto*) - os=`echo $os | sed -e 's|nto|nto-qnx|'` - ;; - -sim | -es1800* | -hms* | -xray | -os68k* | -none* | -v88r* \ - | -windows* | -osx | -abug | -netware* | -os9* | -beos* | -haiku* \ - | -macos* | -mpw* | -magic* | -mmixware* | -mon960* | -lnews*) - ;; - -mac*) - os=`echo $os | sed -e 's|mac|macos|'` - ;; - -linux-dietlibc) - os=-linux-dietlibc - ;; - -linux*) - os=`echo $os | sed -e 's|linux|linux-gnu|'` - ;; - -sunos5*) - os=`echo $os | sed -e 's|sunos5|solaris2|'` - ;; - -sunos6*) - os=`echo $os | sed -e 's|sunos6|solaris3|'` - ;; - -opened*) - os=-openedition - ;; - -os400*) - os=-os400 - ;; - -wince*) - os=-wince - ;; - -osfrose*) - os=-osfrose - ;; - -osf*) - os=-osf - ;; - -utek*) - os=-bsd - ;; - -dynix*) - os=-bsd - ;; - -acis*) - os=-aos - ;; - -atheos*) - os=-atheos - ;; - -syllable*) - os=-syllable - ;; - -386bsd) - os=-bsd - ;; - -ctix* | -uts*) - os=-sysv - ;; - -nova*) - os=-rtmk-nova - ;; - -ns2 ) - os=-nextstep2 - ;; - -nsk*) - os=-nsk - ;; - # Preserve the version number of sinix5. - -sinix5.*) - os=`echo $os | sed -e 's|sinix|sysv|'` - ;; - -sinix*) - os=-sysv4 - ;; - -tpf*) - os=-tpf - ;; - -triton*) - os=-sysv3 - ;; - -oss*) - os=-sysv3 - ;; - -svr4) - os=-sysv4 - ;; - -svr3) - os=-sysv3 - ;; - -sysvr4) - os=-sysv4 - ;; - # This must come after -sysvr4. - -sysv*) - ;; - -ose*) - os=-ose - ;; - -es1800*) - os=-ose - ;; - -xenix) - os=-xenix - ;; - -*mint | -mint[0-9]* | -*MiNT | -MiNT[0-9]*) - os=-mint - ;; - -aros*) - os=-aros - ;; - -kaos*) - os=-kaos - ;; - -zvmoe) - os=-zvmoe - ;; - -none) - ;; - *) - # Get rid of the `-' at the beginning of $os. - os=`echo $os | sed 's/[^-]*-//'` - echo Invalid configuration \`$1\': system \`$os\' not recognized 1>&2 - exit 1 - ;; -esac -else - -# Here we handle the default operating systems that come with various machines. -# The value should be what the vendor currently ships out the door with their -# machine or put another way, the most popular os provided with the machine. - -# Note that if you're going to try to match "-MANUFACTURER" here (say, -# "-sun"), then you have to tell the case statement up towards the top -# that MANUFACTURER isn't an operating system. Otherwise, code above -# will signal an error saying that MANUFACTURER isn't an operating -# system, and we'll never get to this point. - -case $basic_machine in - score-*) - os=-elf - ;; - spu-*) - os=-elf - ;; - *-acorn) - os=-riscix1.2 - ;; - arm*-rebel) - os=-linux - ;; - arm*-semi) - os=-aout - ;; - c4x-* | tic4x-*) - os=-coff - ;; - # This must come before the *-dec entry. - pdp10-*) - os=-tops20 - ;; - pdp11-*) - os=-none - ;; - *-dec | vax-*) - os=-ultrix4.2 - ;; - m68*-apollo) - os=-domain - ;; - i386-sun) - os=-sunos4.0.2 - ;; - m68000-sun) - os=-sunos3 - # This also exists in the configure program, but was not the - # default. - # os=-sunos4 - ;; - m68*-cisco) - os=-aout - ;; - mep-*) - os=-elf - ;; - mips*-cisco) - os=-elf - ;; - mips*-*) - os=-elf - ;; - or32-*) - os=-coff - ;; - *-tti) # must be before sparc entry or we get the wrong os. - os=-sysv3 - ;; - sparc-* | *-sun) - os=-sunos4.1.1 - ;; - *-be) - os=-beos - ;; - *-haiku) - os=-haiku - ;; - *-ibm) - os=-aix - ;; - *-knuth) - os=-mmixware - ;; - *-wec) - os=-proelf - ;; - *-winbond) - os=-proelf - ;; - *-oki) - os=-proelf - ;; - *-hp) - os=-hpux - ;; - *-hitachi) - os=-hiux - ;; - i860-* | *-att | *-ncr | *-altos | *-motorola | *-convergent) - os=-sysv - ;; - *-cbm) - os=-amigaos - ;; - *-dg) - os=-dgux - ;; - *-dolphin) - os=-sysv3 - ;; - m68k-ccur) - os=-rtu - ;; - m88k-omron*) - os=-luna - ;; - *-next ) - os=-nextstep - ;; - *-sequent) - os=-ptx - ;; - *-crds) - os=-unos - ;; - *-ns) - os=-genix - ;; - i370-*) - os=-mvs - ;; - *-next) - os=-nextstep3 - ;; - *-gould) - os=-sysv - ;; - *-highlevel) - os=-bsd - ;; - *-encore) - os=-bsd - ;; - *-sgi) - os=-irix - ;; - *-siemens) - os=-sysv4 - ;; - *-masscomp) - os=-rtu - ;; - f30[01]-fujitsu | f700-fujitsu) - os=-uxpv - ;; - *-rom68k) - os=-coff - ;; - *-*bug) - os=-coff - ;; - *-apple) - os=-macos - ;; - *-atari*) - os=-mint - ;; - *) - os=-none - ;; -esac -fi - -# Here we handle the case where we know the os, and the CPU type, but not the -# manufacturer. We pick the logical manufacturer. -vendor=unknown -case $basic_machine in - *-unknown) - case $os in - -riscix*) - vendor=acorn - ;; - -sunos*) - vendor=sun - ;; - -aix*) - vendor=ibm - ;; - -beos*) - vendor=be - ;; - -hpux*) - vendor=hp - ;; - -mpeix*) - vendor=hp - ;; - -hiux*) - vendor=hitachi - ;; - -unos*) - vendor=crds - ;; - -dgux*) - vendor=dg - ;; - -luna*) - vendor=omron - ;; - -genix*) - vendor=ns - ;; - -mvs* | -opened*) - vendor=ibm - ;; - -os400*) - vendor=ibm - ;; - -ptx*) - vendor=sequent - ;; - -tpf*) - vendor=ibm - ;; - -vxsim* | -vxworks* | -windiss*) - vendor=wrs - ;; - -aux*) - vendor=apple - ;; - -hms*) - vendor=hitachi - ;; - -mpw* | -macos*) - vendor=apple - ;; - -*mint | -mint[0-9]* | -*MiNT | -MiNT[0-9]*) - vendor=atari - ;; - -vos*) - vendor=stratus - ;; - esac - basic_machine=`echo $basic_machine | sed "s/unknown/$vendor/"` - ;; -esac - -echo $basic_machine$os -exit - -# Local variables: -# eval: (add-hook 'write-file-hooks 'time-stamp) -# time-stamp-start: "timestamp='" -# time-stamp-format: "%:y-%02m-%02d" -# time-stamp-end: "'" -# End: diff --git a/Build/source/utils/texi2html/configure b/Build/source/utils/texi2html/configure deleted file mode 100755 index 4b482a4ec9f..00000000000 --- a/Build/source/utils/texi2html/configure +++ /dev/null @@ -1,3518 +0,0 @@ -#! /bin/sh -# Guess values for system-dependent variables and create Makefiles. -# Generated by GNU Autoconf 2.61 for texi2html 1.76. -# -# Report bugs to <users@texi2html.cvshome.org>. -# -# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, -# 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. -# This configure script is free software; the Free Software Foundation -# gives unlimited permission to copy, distribute and modify it. -## --------------------- ## -## M4sh Initialization. ## -## --------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then - emulate sh - NULLCMD=: - # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in - *posix*) set -o posix ;; -esac - -fi - - - - -# PATH needs CR -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - echo "#! /bin/sh" >conf$$.sh - echo "exit 0" >>conf$$.sh - chmod +x conf$$.sh - if (PATH="/nonexistent;."; conf$$.sh) >/dev/null 2>&1; then - PATH_SEPARATOR=';' - else - PATH_SEPARATOR=: - fi - rm -f conf$$.sh -fi - -# Support unset when possible. -if ( (MAIL=60; unset MAIL) || exit) >/dev/null 2>&1; then - as_unset=unset -else - as_unset=false -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -as_nl=' -' -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break -done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - { (exit 1); exit 1; } -fi - -# Work around bugs in pre-3.0 UWIN ksh. -for as_var in ENV MAIL MAILPATH -do ($as_unset $as_var) >/dev/null 2>&1 && $as_unset $as_var -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -for as_var in \ - LANG LANGUAGE LC_ADDRESS LC_ALL LC_COLLATE LC_CTYPE LC_IDENTIFICATION \ - LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER \ - LC_TELEPHONE LC_TIME -do - if (set +x; test -z "`(eval $as_var=C; export $as_var) 2>&1`"); then - eval $as_var=C; export $as_var - else - ($as_unset $as_var) >/dev/null 2>&1 && $as_unset $as_var - fi -done - -# Required to use basename. -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - - -# Name of the executable. -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# CDPATH. -$as_unset CDPATH - - -if test "x$CONFIG_SHELL" = x; then - if (eval ":") 2>/dev/null; then - as_have_required=yes -else - as_have_required=no -fi - - if test $as_have_required = yes && (eval ": -(as_func_return () { - (exit \$1) -} -as_func_success () { - as_func_return 0 -} -as_func_failure () { - as_func_return 1 -} -as_func_ret_success () { - return 0 -} -as_func_ret_failure () { - return 1 -} - -exitcode=0 -if as_func_success; then - : -else - exitcode=1 - echo as_func_success failed. -fi - -if as_func_failure; then - exitcode=1 - echo as_func_failure succeeded. -fi - -if as_func_ret_success; then - : -else - exitcode=1 - echo as_func_ret_success failed. -fi - -if as_func_ret_failure; then - exitcode=1 - echo as_func_ret_failure succeeded. -fi - -if ( set x; as_func_ret_success y && test x = \"\$1\" ); then - : -else - exitcode=1 - echo positional parameters were not saved. -fi - -test \$exitcode = 0) || { (exit 1); exit 1; } - -( - as_lineno_1=\$LINENO - as_lineno_2=\$LINENO - test \"x\$as_lineno_1\" != \"x\$as_lineno_2\" && - test \"x\`expr \$as_lineno_1 + 1\`\" = \"x\$as_lineno_2\") || { (exit 1); exit 1; } -") 2> /dev/null; then - : -else - as_candidate_shells= - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - case $as_dir in - /*) - for as_base in sh bash ksh sh5; do - as_candidate_shells="$as_candidate_shells $as_dir/$as_base" - done;; - esac -done -IFS=$as_save_IFS - - - for as_shell in $as_candidate_shells $SHELL; do - # Try only shells that exist, to save several forks. - if { test -f "$as_shell" || test -f "$as_shell.exe"; } && - { ("$as_shell") 2> /dev/null <<\_ASEOF -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then - emulate sh - NULLCMD=: - # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in - *posix*) set -o posix ;; -esac - -fi - - -: -_ASEOF -}; then - CONFIG_SHELL=$as_shell - as_have_required=yes - if { "$as_shell" 2> /dev/null <<\_ASEOF -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then - emulate sh - NULLCMD=: - # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in - *posix*) set -o posix ;; -esac - -fi - - -: -(as_func_return () { - (exit $1) -} -as_func_success () { - as_func_return 0 -} -as_func_failure () { - as_func_return 1 -} -as_func_ret_success () { - return 0 -} -as_func_ret_failure () { - return 1 -} - -exitcode=0 -if as_func_success; then - : -else - exitcode=1 - echo as_func_success failed. -fi - -if as_func_failure; then - exitcode=1 - echo as_func_failure succeeded. -fi - -if as_func_ret_success; then - : -else - exitcode=1 - echo as_func_ret_success failed. -fi - -if as_func_ret_failure; then - exitcode=1 - echo as_func_ret_failure succeeded. -fi - -if ( set x; as_func_ret_success y && test x = "$1" ); then - : -else - exitcode=1 - echo positional parameters were not saved. -fi - -test $exitcode = 0) || { (exit 1); exit 1; } - -( - as_lineno_1=$LINENO - as_lineno_2=$LINENO - test "x$as_lineno_1" != "x$as_lineno_2" && - test "x`expr $as_lineno_1 + 1`" = "x$as_lineno_2") || { (exit 1); exit 1; } - -_ASEOF -}; then - break -fi - -fi - - done - - if test "x$CONFIG_SHELL" != x; then - for as_var in BASH_ENV ENV - do ($as_unset $as_var) >/dev/null 2>&1 && $as_unset $as_var - done - export CONFIG_SHELL - exec "$CONFIG_SHELL" "$as_myself" ${1+"$@"} -fi - - - if test $as_have_required = no; then - echo This script requires a shell more modern than all the - echo shells that I found on your system. Please install a - echo modern shell, or manually run the script under such a - echo shell if you do have one. - { (exit 1); exit 1; } -fi - - -fi - -fi - - - -(eval "as_func_return () { - (exit \$1) -} -as_func_success () { - as_func_return 0 -} -as_func_failure () { - as_func_return 1 -} -as_func_ret_success () { - return 0 -} -as_func_ret_failure () { - return 1 -} - -exitcode=0 -if as_func_success; then - : -else - exitcode=1 - echo as_func_success failed. -fi - -if as_func_failure; then - exitcode=1 - echo as_func_failure succeeded. -fi - -if as_func_ret_success; then - : -else - exitcode=1 - echo as_func_ret_success failed. -fi - -if as_func_ret_failure; then - exitcode=1 - echo as_func_ret_failure succeeded. -fi - -if ( set x; as_func_ret_success y && test x = \"\$1\" ); then - : -else - exitcode=1 - echo positional parameters were not saved. -fi - -test \$exitcode = 0") || { - echo No shell found that supports shell functions. - echo Please tell autoconf@gnu.org about your system, - echo including any error possibly output before this - echo message -} - - - - as_lineno_1=$LINENO - as_lineno_2=$LINENO - test "x$as_lineno_1" != "x$as_lineno_2" && - test "x`expr $as_lineno_1 + 1`" = "x$as_lineno_2" || { - - # Create $as_me.lineno as a copy of $as_myself, but with $LINENO - # uniformly replaced by the line number. The first 'sed' inserts a - # line-number line after each line using $LINENO; the second 'sed' - # does the real work. The second script uses 'N' to pair each - # line-number line with the line containing $LINENO, and appends - # trailing '-' during substitution so that $LINENO is not a special - # case at line end. - # (Raja R Harinath suggested sed '=', and Paul Eggert wrote the - # scripts with optimization help from Paolo Bonzini. Blame Lee - # E. McMahon (1931-1989) for sed's syntax. :-) - sed -n ' - p - /[$]LINENO/= - ' <$as_myself | - sed ' - s/[$]LINENO.*/&-/ - t lineno - b - :lineno - N - :loop - s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ - t loop - s/-\n.*// - ' >$as_me.lineno && - chmod +x "$as_me.lineno" || - { echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2 - { (exit 1); exit 1; }; } - - # Don't try to exec as it changes $[0], causing all sort of problems - # (the dirname of $[0] is not the place where we might find the - # original and so on. Autoconf is especially sensitive to this). - . "./$as_me.lineno" - # Exit status is that of the last command. - exit -} - - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in --n*) - case `echo 'x\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - *) ECHO_C='\c';; - esac;; -*) - ECHO_N='-n';; -esac - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir -fi -echo >conf$$.file -if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' -elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - -if mkdir -p . 2>/dev/null; then - as_mkdir_p=: -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - - -exec 7<&0 </dev/null 6>&1 - -# Name of the host. -# hostname on some systems (SVR3.2, Linux) returns a bogus exit status, -# so uname gets run too. -ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` - -# -# Initializations. -# -ac_default_prefix=/usr/local -ac_clean_files= -ac_config_libobj_dir=. -LIBOBJS= -cross_compiling=no -subdirs= -MFLAGS= -MAKEFLAGS= -SHELL=${CONFIG_SHELL-/bin/sh} - -# Identity of this package. -PACKAGE_NAME='texi2html' -PACKAGE_TARNAME='texi2html' -PACKAGE_VERSION='1.76' -PACKAGE_STRING='texi2html 1.76' -PACKAGE_BUGREPORT='users@texi2html.cvshome.org' - -ac_subst_vars='SHELL -PATH_SEPARATOR -PACKAGE_NAME -PACKAGE_TARNAME -PACKAGE_VERSION -PACKAGE_STRING -PACKAGE_BUGREPORT -exec_prefix -prefix -program_transform_name -bindir -sbindir -libexecdir -datarootdir -datadir -sysconfdir -sharedstatedir -localstatedir -includedir -oldincludedir -docdir -infodir -htmldir -dvidir -pdfdir -psdir -libdir -localedir -mandir -DEFS -ECHO_C -ECHO_N -ECHO_T -LIBS -build_alias -host_alias -target_alias -INSTALL_PROGRAM -INSTALL_SCRIPT -INSTALL_DATA -CYGPATH_W -PACKAGE -VERSION -ACLOCAL -AUTOCONF -AUTOMAKE -AUTOHEADER -MAKEINFO -install_sh -STRIP -INSTALL_STRIP_PROGRAM -mkdir_p -AWK -SET_MAKE -am__leading_dot -AMTAR -am__tar -am__untar -MAINTAINER_MODE_TRUE -MAINTAINER_MODE_FALSE -MAINT -PACKAGE_DATE -USE_UNICODE -PERL -build -build_cpu -build_vendor -build_os -host -host_cpu -host_vendor -host_os -LIBOBJS -LTLIBOBJS' -ac_subst_files='INIT -MYSIMPLE -T2H_I18N -T2H_L2H_FILE -T2H_TRANSLATIONS_FILE' - ac_precious_vars='build_alias -host_alias -target_alias -PERL' - - -# Initialize some variables set by options. -ac_init_help= -ac_init_version=false -# The variables have the same names as the options, with -# dashes changed to underlines. -cache_file=/dev/null -exec_prefix=NONE -no_create= -no_recursion= -prefix=NONE -program_prefix=NONE -program_suffix=NONE -program_transform_name=s,x,x, -silent= -site= -srcdir= -verbose= -x_includes=NONE -x_libraries=NONE - -# Installation directory options. -# These are left unexpanded so users can "make install exec_prefix=/foo" -# and all the variables that are supposed to be based on exec_prefix -# by default will actually change. -# Use braces instead of parens because sh, perl, etc. also accept them. -# (The list follows the same order as the GNU Coding Standards.) -bindir='${exec_prefix}/bin' -sbindir='${exec_prefix}/sbin' -libexecdir='${exec_prefix}/libexec' -datarootdir='${prefix}/share' -datadir='${datarootdir}' -sysconfdir='${prefix}/etc' -sharedstatedir='${prefix}/com' -localstatedir='${prefix}/var' -includedir='${prefix}/include' -oldincludedir='/usr/include' -docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' -infodir='${datarootdir}/info' -htmldir='${docdir}' -dvidir='${docdir}' -pdfdir='${docdir}' -psdir='${docdir}' -libdir='${exec_prefix}/lib' -localedir='${datarootdir}/locale' -mandir='${datarootdir}/man' - -ac_prev= -ac_dashdash= -for ac_option -do - # If the previous option needs an argument, assign it. - if test -n "$ac_prev"; then - eval $ac_prev=\$ac_option - ac_prev= - continue - fi - - case $ac_option in - *=*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; - *) ac_optarg=yes ;; - esac - - # Accept the important Cygnus configure options, so we can diagnose typos. - - case $ac_dashdash$ac_option in - --) - ac_dashdash=yes ;; - - -bindir | --bindir | --bindi | --bind | --bin | --bi) - ac_prev=bindir ;; - -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) - bindir=$ac_optarg ;; - - -build | --build | --buil | --bui | --bu) - ac_prev=build_alias ;; - -build=* | --build=* | --buil=* | --bui=* | --bu=*) - build_alias=$ac_optarg ;; - - -cache-file | --cache-file | --cache-fil | --cache-fi \ - | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) - ac_prev=cache_file ;; - -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ - | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) - cache_file=$ac_optarg ;; - - --config-cache | -C) - cache_file=config.cache ;; - - -datadir | --datadir | --datadi | --datad) - ac_prev=datadir ;; - -datadir=* | --datadir=* | --datadi=* | --datad=*) - datadir=$ac_optarg ;; - - -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ - | --dataroo | --dataro | --datar) - ac_prev=datarootdir ;; - -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ - | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) - datarootdir=$ac_optarg ;; - - -disable-* | --disable-*) - ac_feature=`expr "x$ac_option" : 'x-*disable-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_feature" : ".*[^-._$as_cr_alnum]" >/dev/null && - { echo "$as_me: error: invalid feature name: $ac_feature" >&2 - { (exit 1); exit 1; }; } - ac_feature=`echo $ac_feature | sed 's/[-.]/_/g'` - eval enable_$ac_feature=no ;; - - -docdir | --docdir | --docdi | --doc | --do) - ac_prev=docdir ;; - -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) - docdir=$ac_optarg ;; - - -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) - ac_prev=dvidir ;; - -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) - dvidir=$ac_optarg ;; - - -enable-* | --enable-*) - ac_feature=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_feature" : ".*[^-._$as_cr_alnum]" >/dev/null && - { echo "$as_me: error: invalid feature name: $ac_feature" >&2 - { (exit 1); exit 1; }; } - ac_feature=`echo $ac_feature | sed 's/[-.]/_/g'` - eval enable_$ac_feature=\$ac_optarg ;; - - -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ - | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ - | --exec | --exe | --ex) - ac_prev=exec_prefix ;; - -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ - | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ - | --exec=* | --exe=* | --ex=*) - exec_prefix=$ac_optarg ;; - - -gas | --gas | --ga | --g) - # Obsolete; use --with-gas. - with_gas=yes ;; - - -help | --help | --hel | --he | -h) - ac_init_help=long ;; - -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) - ac_init_help=recursive ;; - -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) - ac_init_help=short ;; - - -host | --host | --hos | --ho) - ac_prev=host_alias ;; - -host=* | --host=* | --hos=* | --ho=*) - host_alias=$ac_optarg ;; - - -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) - ac_prev=htmldir ;; - -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ - | --ht=*) - htmldir=$ac_optarg ;; - - -includedir | --includedir | --includedi | --included | --include \ - | --includ | --inclu | --incl | --inc) - ac_prev=includedir ;; - -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ - | --includ=* | --inclu=* | --incl=* | --inc=*) - includedir=$ac_optarg ;; - - -infodir | --infodir | --infodi | --infod | --info | --inf) - ac_prev=infodir ;; - -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) - infodir=$ac_optarg ;; - - -libdir | --libdir | --libdi | --libd) - ac_prev=libdir ;; - -libdir=* | --libdir=* | --libdi=* | --libd=*) - libdir=$ac_optarg ;; - - -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ - | --libexe | --libex | --libe) - ac_prev=libexecdir ;; - -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ - | --libexe=* | --libex=* | --libe=*) - libexecdir=$ac_optarg ;; - - -localedir | --localedir | --localedi | --localed | --locale) - ac_prev=localedir ;; - -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) - localedir=$ac_optarg ;; - - -localstatedir | --localstatedir | --localstatedi | --localstated \ - | --localstate | --localstat | --localsta | --localst | --locals) - ac_prev=localstatedir ;; - -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ - | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) - localstatedir=$ac_optarg ;; - - -mandir | --mandir | --mandi | --mand | --man | --ma | --m) - ac_prev=mandir ;; - -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) - mandir=$ac_optarg ;; - - -nfp | --nfp | --nf) - # Obsolete; use --without-fp. - with_fp=no ;; - - -no-create | --no-create | --no-creat | --no-crea | --no-cre \ - | --no-cr | --no-c | -n) - no_create=yes ;; - - -no-recursion | --no-recursion | --no-recursio | --no-recursi \ - | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) - no_recursion=yes ;; - - -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ - | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ - | --oldin | --oldi | --old | --ol | --o) - ac_prev=oldincludedir ;; - -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ - | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ - | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) - oldincludedir=$ac_optarg ;; - - -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) - ac_prev=prefix ;; - -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) - prefix=$ac_optarg ;; - - -program-prefix | --program-prefix | --program-prefi | --program-pref \ - | --program-pre | --program-pr | --program-p) - ac_prev=program_prefix ;; - -program-prefix=* | --program-prefix=* | --program-prefi=* \ - | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) - program_prefix=$ac_optarg ;; - - -program-suffix | --program-suffix | --program-suffi | --program-suff \ - | --program-suf | --program-su | --program-s) - ac_prev=program_suffix ;; - -program-suffix=* | --program-suffix=* | --program-suffi=* \ - | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) - program_suffix=$ac_optarg ;; - - -program-transform-name | --program-transform-name \ - | --program-transform-nam | --program-transform-na \ - | --program-transform-n | --program-transform- \ - | --program-transform | --program-transfor \ - | --program-transfo | --program-transf \ - | --program-trans | --program-tran \ - | --progr-tra | --program-tr | --program-t) - ac_prev=program_transform_name ;; - -program-transform-name=* | --program-transform-name=* \ - | --program-transform-nam=* | --program-transform-na=* \ - | --program-transform-n=* | --program-transform-=* \ - | --program-transform=* | --program-transfor=* \ - | --program-transfo=* | --program-transf=* \ - | --program-trans=* | --program-tran=* \ - | --progr-tra=* | --program-tr=* | --program-t=*) - program_transform_name=$ac_optarg ;; - - -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) - ac_prev=pdfdir ;; - -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) - pdfdir=$ac_optarg ;; - - -psdir | --psdir | --psdi | --psd | --ps) - ac_prev=psdir ;; - -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) - psdir=$ac_optarg ;; - - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - silent=yes ;; - - -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) - ac_prev=sbindir ;; - -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ - | --sbi=* | --sb=*) - sbindir=$ac_optarg ;; - - -sharedstatedir | --sharedstatedir | --sharedstatedi \ - | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ - | --sharedst | --shareds | --shared | --share | --shar \ - | --sha | --sh) - ac_prev=sharedstatedir ;; - -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ - | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ - | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ - | --sha=* | --sh=*) - sharedstatedir=$ac_optarg ;; - - -site | --site | --sit) - ac_prev=site ;; - -site=* | --site=* | --sit=*) - site=$ac_optarg ;; - - -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) - ac_prev=srcdir ;; - -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) - srcdir=$ac_optarg ;; - - -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ - | --syscon | --sysco | --sysc | --sys | --sy) - ac_prev=sysconfdir ;; - -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ - | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) - sysconfdir=$ac_optarg ;; - - -target | --target | --targe | --targ | --tar | --ta | --t) - ac_prev=target_alias ;; - -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) - target_alias=$ac_optarg ;; - - -v | -verbose | --verbose | --verbos | --verbo | --verb) - verbose=yes ;; - - -version | --version | --versio | --versi | --vers | -V) - ac_init_version=: ;; - - -with-* | --with-*) - ac_package=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_package" : ".*[^-._$as_cr_alnum]" >/dev/null && - { echo "$as_me: error: invalid package name: $ac_package" >&2 - { (exit 1); exit 1; }; } - ac_package=`echo $ac_package | sed 's/[-.]/_/g'` - eval with_$ac_package=\$ac_optarg ;; - - -without-* | --without-*) - ac_package=`expr "x$ac_option" : 'x-*without-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_package" : ".*[^-._$as_cr_alnum]" >/dev/null && - { echo "$as_me: error: invalid package name: $ac_package" >&2 - { (exit 1); exit 1; }; } - ac_package=`echo $ac_package | sed 's/[-.]/_/g'` - eval with_$ac_package=no ;; - - --x) - # Obsolete; use --with-x. - with_x=yes ;; - - -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ - | --x-incl | --x-inc | --x-in | --x-i) - ac_prev=x_includes ;; - -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ - | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) - x_includes=$ac_optarg ;; - - -x-libraries | --x-libraries | --x-librarie | --x-librari \ - | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) - ac_prev=x_libraries ;; - -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ - | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) - x_libraries=$ac_optarg ;; - - -*) { echo "$as_me: error: unrecognized option: $ac_option -Try \`$0 --help' for more information." >&2 - { (exit 1); exit 1; }; } - ;; - - *=*) - ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` - # Reject names that are not valid shell variable names. - expr "x$ac_envvar" : ".*[^_$as_cr_alnum]" >/dev/null && - { echo "$as_me: error: invalid variable name: $ac_envvar" >&2 - { (exit 1); exit 1; }; } - eval $ac_envvar=\$ac_optarg - export $ac_envvar ;; - - *) - # FIXME: should be removed in autoconf 3.0. - echo "$as_me: WARNING: you should use --build, --host, --target" >&2 - expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && - echo "$as_me: WARNING: invalid host type: $ac_option" >&2 - : ${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option} - ;; - - esac -done - -if test -n "$ac_prev"; then - ac_option=--`echo $ac_prev | sed 's/_/-/g'` - { echo "$as_me: error: missing argument to $ac_option" >&2 - { (exit 1); exit 1; }; } -fi - -# Be sure to have absolute directory names. -for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ - datadir sysconfdir sharedstatedir localstatedir includedir \ - oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ - libdir localedir mandir -do - eval ac_val=\$$ac_var - case $ac_val in - [\\/$]* | ?:[\\/]* ) continue;; - NONE | '' ) case $ac_var in *prefix ) continue;; esac;; - esac - { echo "$as_me: error: expected an absolute directory name for --$ac_var: $ac_val" >&2 - { (exit 1); exit 1; }; } -done - -# There might be people who depend on the old broken behavior: `$host' -# used to hold the argument of --host etc. -# FIXME: To remove some day. -build=$build_alias -host=$host_alias -target=$target_alias - -# FIXME: To remove some day. -if test "x$host_alias" != x; then - if test "x$build_alias" = x; then - cross_compiling=maybe - echo "$as_me: WARNING: If you wanted to set the --build type, don't use --host. - If a cross compiler is detected then cross compile mode will be used." >&2 - elif test "x$build_alias" != "x$host_alias"; then - cross_compiling=yes - fi -fi - -ac_tool_prefix= -test -n "$host_alias" && ac_tool_prefix=$host_alias- - -test "$silent" = yes && exec 6>/dev/null - - -ac_pwd=`pwd` && test -n "$ac_pwd" && -ac_ls_di=`ls -di .` && -ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || - { echo "$as_me: error: Working directory cannot be determined" >&2 - { (exit 1); exit 1; }; } -test "X$ac_ls_di" = "X$ac_pwd_ls_di" || - { echo "$as_me: error: pwd does not report name of working directory" >&2 - { (exit 1); exit 1; }; } - - -# Find the source files, if location was not specified. -if test -z "$srcdir"; then - ac_srcdir_defaulted=yes - # Try the directory containing this script, then the parent directory. - ac_confdir=`$as_dirname -- "$0" || -$as_expr X"$0" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$0" : 'X\(//\)[^/]' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -echo X"$0" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - srcdir=$ac_confdir - if test ! -r "$srcdir/$ac_unique_file"; then - srcdir=.. - fi -else - ac_srcdir_defaulted=no -fi -if test ! -r "$srcdir/$ac_unique_file"; then - test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." - { echo "$as_me: error: cannot find sources ($ac_unique_file) in $srcdir" >&2 - { (exit 1); exit 1; }; } -fi -ac_msg="sources are in $srcdir, but \`cd $srcdir' does not work" -ac_abs_confdir=`( - cd "$srcdir" && test -r "./$ac_unique_file" || { echo "$as_me: error: $ac_msg" >&2 - { (exit 1); exit 1; }; } - pwd)` -# When building in place, set srcdir=. -if test "$ac_abs_confdir" = "$ac_pwd"; then - srcdir=. -fi -# Remove unnecessary trailing slashes from srcdir. -# Double slashes in file names in object file debugging info -# mess up M-x gdb in Emacs. -case $srcdir in -*/) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; -esac -for ac_var in $ac_precious_vars; do - eval ac_env_${ac_var}_set=\${${ac_var}+set} - eval ac_env_${ac_var}_value=\$${ac_var} - eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} - eval ac_cv_env_${ac_var}_value=\$${ac_var} -done - -# -# Report the --help message. -# -if test "$ac_init_help" = "long"; then - # Omit some internal or obsolete options to make the list less imposing. - # This message is too long to be a string in the A/UX 3.1 sh. - cat <<_ACEOF -\`configure' configures texi2html 1.76 to adapt to many kinds of systems. - -Usage: $0 [OPTION]... [VAR=VALUE]... - -To assign environment variables (e.g., CC, CFLAGS...), specify them as -VAR=VALUE. See below for descriptions of some of the useful variables. - -Defaults for the options are specified in brackets. - -Configuration: - -h, --help display this help and exit - --help=short display options specific to this package - --help=recursive display the short help of all the included packages - -V, --version display version information and exit - -q, --quiet, --silent do not print \`checking...' messages - --cache-file=FILE cache test results in FILE [disabled] - -C, --config-cache alias for \`--cache-file=config.cache' - -n, --no-create do not create output files - --srcdir=DIR find the sources in DIR [configure dir or \`..'] - -Installation directories: - --prefix=PREFIX install architecture-independent files in PREFIX - [$ac_default_prefix] - --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX - [PREFIX] - -By default, \`make install' will install all the files in -\`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify -an installation prefix other than \`$ac_default_prefix' using \`--prefix', -for instance \`--prefix=\$HOME'. - -For better control, use the options below. - -Fine tuning of the installation directories: - --bindir=DIR user executables [EPREFIX/bin] - --sbindir=DIR system admin executables [EPREFIX/sbin] - --libexecdir=DIR program executables [EPREFIX/libexec] - --sysconfdir=DIR read-only single-machine data [PREFIX/etc] - --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] - --localstatedir=DIR modifiable single-machine data [PREFIX/var] - --libdir=DIR object code libraries [EPREFIX/lib] - --includedir=DIR C header files [PREFIX/include] - --oldincludedir=DIR C header files for non-gcc [/usr/include] - --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] - --datadir=DIR read-only architecture-independent data [DATAROOTDIR] - --infodir=DIR info documentation [DATAROOTDIR/info] - --localedir=DIR locale-dependent data [DATAROOTDIR/locale] - --mandir=DIR man documentation [DATAROOTDIR/man] - --docdir=DIR documentation root [DATAROOTDIR/doc/texi2html] - --htmldir=DIR html documentation [DOCDIR] - --dvidir=DIR dvi documentation [DOCDIR] - --pdfdir=DIR pdf documentation [DOCDIR] - --psdir=DIR ps documentation [DOCDIR] -_ACEOF - - cat <<\_ACEOF - -Program names: - --program-prefix=PREFIX prepend PREFIX to installed program names - --program-suffix=SUFFIX append SUFFIX to installed program names - --program-transform-name=PROGRAM run sed PROGRAM on installed program names - -System types: - --build=BUILD configure for building on BUILD [guessed] - --host=HOST cross-compile to build programs to run on HOST [BUILD] -_ACEOF -fi - -if test -n "$ac_init_help"; then - case $ac_init_help in - short | recursive ) echo "Configuration of texi2html 1.76:";; - esac - cat <<\_ACEOF - -Optional Features: - --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) - --enable-FEATURE[=ARG] include FEATURE [ARG=yes] - --enable-maintainer-mode enable make rules and dependencies not useful - (and sometimes confusing) to the casual installer - --enable-multiplatform put executables into bin/PLATFORM and libraries into - lib/PLATFORM - -Optional Packages: - --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] - --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) - --with-encode use encode (default: detected) - -Some influential environment variables: - PERL The path to the `perl' executable. - -Use these variables to override the choices made by `configure' or to help -it to find libraries and programs with nonstandard names/locations. - -Report bugs to <users@texi2html.cvshome.org>. -_ACEOF -ac_status=$? -fi - -if test "$ac_init_help" = "recursive"; then - # If there are subdirs, report their specific --help. - for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue - test -d "$ac_dir" || continue - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`echo "$ac_dir" | sed 's,^\.[\\/],,'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`echo "$ac_dir_suffix" | sed 's,/[^\\/]*,/..,g;s,/,,'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - cd "$ac_dir" || { ac_status=$?; continue; } - # Check for guested configure. - if test -f "$ac_srcdir/configure.gnu"; then - echo && - $SHELL "$ac_srcdir/configure.gnu" --help=recursive - elif test -f "$ac_srcdir/configure"; then - echo && - $SHELL "$ac_srcdir/configure" --help=recursive - else - echo "$as_me: WARNING: no configuration information is in $ac_dir" >&2 - fi || ac_status=$? - cd "$ac_pwd" || { ac_status=$?; break; } - done -fi - -test -n "$ac_init_help" && exit $ac_status -if $ac_init_version; then - cat <<\_ACEOF -texi2html configure 1.76 -generated by GNU Autoconf 2.61 - -Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, -2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. -This configure script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it. -_ACEOF - exit -fi -cat >config.log <<_ACEOF -This file contains any messages produced by compilers while -running configure, to aid debugging if configure makes a mistake. - -It was created by texi2html $as_me 1.76, which was -generated by GNU Autoconf 2.61. Invocation command line was - - $ $0 $@ - -_ACEOF -exec 5>>config.log -{ -cat <<_ASUNAME -## --------- ## -## Platform. ## -## --------- ## - -hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` -uname -m = `(uname -m) 2>/dev/null || echo unknown` -uname -r = `(uname -r) 2>/dev/null || echo unknown` -uname -s = `(uname -s) 2>/dev/null || echo unknown` -uname -v = `(uname -v) 2>/dev/null || echo unknown` - -/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` -/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` - -/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` -/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` -/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` -/usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` -/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` -/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` -/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` - -_ASUNAME - -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - echo "PATH: $as_dir" -done -IFS=$as_save_IFS - -} >&5 - -cat >&5 <<_ACEOF - - -## ----------- ## -## Core tests. ## -## ----------- ## - -_ACEOF - - -# Keep a trace of the command line. -# Strip out --no-create and --no-recursion so they do not pile up. -# Strip out --silent because we don't want to record it for future runs. -# Also quote any args containing shell meta-characters. -# Make two passes to allow for proper duplicate-argument suppression. -ac_configure_args= -ac_configure_args0= -ac_configure_args1= -ac_must_keep_next=false -for ac_pass in 1 2 -do - for ac_arg - do - case $ac_arg in - -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - continue ;; - *\'*) - ac_arg=`echo "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; - esac - case $ac_pass in - 1) ac_configure_args0="$ac_configure_args0 '$ac_arg'" ;; - 2) - ac_configure_args1="$ac_configure_args1 '$ac_arg'" - if test $ac_must_keep_next = true; then - ac_must_keep_next=false # Got value, back to normal. - else - case $ac_arg in - *=* | --config-cache | -C | -disable-* | --disable-* \ - | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ - | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ - | -with-* | --with-* | -without-* | --without-* | --x) - case "$ac_configure_args0 " in - "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; - esac - ;; - -* ) ac_must_keep_next=true ;; - esac - fi - ac_configure_args="$ac_configure_args '$ac_arg'" - ;; - esac - done -done -$as_unset ac_configure_args0 || test "${ac_configure_args0+set}" != set || { ac_configure_args0=; export ac_configure_args0; } -$as_unset ac_configure_args1 || test "${ac_configure_args1+set}" != set || { ac_configure_args1=; export ac_configure_args1; } - -# When interrupted or exit'd, cleanup temporary files, and complete -# config.log. We remove comments because anyway the quotes in there -# would cause problems or look ugly. -# WARNING: Use '\'' to represent an apostrophe within the trap. -# WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. -trap 'exit_status=$? - # Save into config.log some information that might help in debugging. - { - echo - - cat <<\_ASBOX -## ---------------- ## -## Cache variables. ## -## ---------------- ## -_ASBOX - echo - # The following way of writing the cache mishandles newlines in values, -( - for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { echo "$as_me:$LINENO: WARNING: Cache variable $ac_var contains a newline." >&5 -echo "$as_me: WARNING: Cache variable $ac_var contains a newline." >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - *) $as_unset $ac_var ;; - esac ;; - esac - done - (set) 2>&1 | - case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - sed -n \ - "s/'\''/'\''\\\\'\'''\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" - ;; #( - *) - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) - echo - - cat <<\_ASBOX -## ----------------- ## -## Output variables. ## -## ----------------- ## -_ASBOX - echo - for ac_var in $ac_subst_vars - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - echo "$ac_var='\''$ac_val'\''" - done | sort - echo - - if test -n "$ac_subst_files"; then - cat <<\_ASBOX -## ------------------- ## -## File substitutions. ## -## ------------------- ## -_ASBOX - echo - for ac_var in $ac_subst_files - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - echo "$ac_var='\''$ac_val'\''" - done | sort - echo - fi - - if test -s confdefs.h; then - cat <<\_ASBOX -## ----------- ## -## confdefs.h. ## -## ----------- ## -_ASBOX - echo - cat confdefs.h - echo - fi - test "$ac_signal" != 0 && - echo "$as_me: caught signal $ac_signal" - echo "$as_me: exit $exit_status" - } >&5 - rm -f core *.core core.conftest.* && - rm -f -r conftest* confdefs* conf$$* $ac_clean_files && - exit $exit_status -' 0 -for ac_signal in 1 2 13 15; do - trap 'ac_signal='$ac_signal'; { (exit 1); exit 1; }' $ac_signal -done -ac_signal=0 - -# confdefs.h avoids OS command line length limits that DEFS can exceed. -rm -f -r conftest* confdefs.h - -# Predefined preprocessor variables. - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_NAME "$PACKAGE_NAME" -_ACEOF - - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_TARNAME "$PACKAGE_TARNAME" -_ACEOF - - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_VERSION "$PACKAGE_VERSION" -_ACEOF - - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_STRING "$PACKAGE_STRING" -_ACEOF - - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_BUGREPORT "$PACKAGE_BUGREPORT" -_ACEOF - - -# Let the site file select an alternate cache file if it wants to. -# Prefer explicitly selected file to automatically selected ones. -if test -n "$CONFIG_SITE"; then - set x "$CONFIG_SITE" -elif test "x$prefix" != xNONE; then - set x "$prefix/share/config.site" "$prefix/etc/config.site" -else - set x "$ac_default_prefix/share/config.site" \ - "$ac_default_prefix/etc/config.site" -fi -shift -for ac_site_file -do - if test -r "$ac_site_file"; then - { echo "$as_me:$LINENO: loading site script $ac_site_file" >&5 -echo "$as_me: loading site script $ac_site_file" >&6;} - sed 's/^/| /' "$ac_site_file" >&5 - . "$ac_site_file" - fi -done - -if test -r "$cache_file"; then - # Some versions of bash will fail to source /dev/null (special - # files actually), so we avoid doing that. - if test -f "$cache_file"; then - { echo "$as_me:$LINENO: loading cache $cache_file" >&5 -echo "$as_me: loading cache $cache_file" >&6;} - case $cache_file in - [\\/]* | ?:[\\/]* ) . "$cache_file";; - *) . "./$cache_file";; - esac - fi -else - { echo "$as_me:$LINENO: creating cache $cache_file" >&5 -echo "$as_me: creating cache $cache_file" >&6;} - >$cache_file -fi - -# Check that the precious variables saved in the cache have kept the same -# value. -ac_cache_corrupted=false -for ac_var in $ac_precious_vars; do - eval ac_old_set=\$ac_cv_env_${ac_var}_set - eval ac_new_set=\$ac_env_${ac_var}_set - eval ac_old_val=\$ac_cv_env_${ac_var}_value - eval ac_new_val=\$ac_env_${ac_var}_value - case $ac_old_set,$ac_new_set in - set,) - { echo "$as_me:$LINENO: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 -echo "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,set) - { echo "$as_me:$LINENO: error: \`$ac_var' was not set in the previous run" >&5 -echo "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,);; - *) - if test "x$ac_old_val" != "x$ac_new_val"; then - { echo "$as_me:$LINENO: error: \`$ac_var' has changed since the previous run:" >&5 -echo "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} - { echo "$as_me:$LINENO: former value: $ac_old_val" >&5 -echo "$as_me: former value: $ac_old_val" >&2;} - { echo "$as_me:$LINENO: current value: $ac_new_val" >&5 -echo "$as_me: current value: $ac_new_val" >&2;} - ac_cache_corrupted=: - fi;; - esac - # Pass precious variables to config.status. - if test "$ac_new_set" = set; then - case $ac_new_val in - *\'*) ac_arg=$ac_var=`echo "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; - *) ac_arg=$ac_var=$ac_new_val ;; - esac - case " $ac_configure_args " in - *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. - *) ac_configure_args="$ac_configure_args '$ac_arg'" ;; - esac - fi -done -if $ac_cache_corrupted; then - { echo "$as_me:$LINENO: error: changes in the environment can compromise the build" >&5 -echo "$as_me: error: changes in the environment can compromise the build" >&2;} - { { echo "$as_me:$LINENO: error: run \`make distclean' and/or \`rm $cache_file' and start over" >&5 -echo "$as_me: error: run \`make distclean' and/or \`rm $cache_file' and start over" >&2;} - { (exit 1); exit 1; }; } -fi - - - - - - - - - - - - - - - - - - - - - - - - - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - - -am__api_version="1.9" -ac_aux_dir= -for ac_dir in "$srcdir" "$srcdir/.." "$srcdir/../.."; do - if test -f "$ac_dir/install-sh"; then - ac_aux_dir=$ac_dir - ac_install_sh="$ac_aux_dir/install-sh -c" - break - elif test -f "$ac_dir/install.sh"; then - ac_aux_dir=$ac_dir - ac_install_sh="$ac_aux_dir/install.sh -c" - break - elif test -f "$ac_dir/shtool"; then - ac_aux_dir=$ac_dir - ac_install_sh="$ac_aux_dir/shtool install -c" - break - fi -done -if test -z "$ac_aux_dir"; then - { { echo "$as_me:$LINENO: error: cannot find install-sh or install.sh in \"$srcdir\" \"$srcdir/..\" \"$srcdir/../..\"" >&5 -echo "$as_me: error: cannot find install-sh or install.sh in \"$srcdir\" \"$srcdir/..\" \"$srcdir/../..\"" >&2;} - { (exit 1); exit 1; }; } -fi - -# These three variables are undocumented and unsupported, -# and are intended to be withdrawn in a future Autoconf release. -# They can cause serious problems if a builder's source tree is in a directory -# whose full name contains unusual characters. -ac_config_guess="$SHELL $ac_aux_dir/config.guess" # Please don't use this var. -ac_config_sub="$SHELL $ac_aux_dir/config.sub" # Please don't use this var. -ac_configure="$SHELL $ac_aux_dir/configure" # Please don't use this var. - - -# Find a good install program. We prefer a C program (faster), -# so one script is as good as another. But avoid the broken or -# incompatible versions: -# SysV /etc/install, /usr/sbin/install -# SunOS /usr/etc/install -# IRIX /sbin/install -# AIX /bin/install -# AmigaOS /C/install, which installs bootblocks on floppy discs -# AIX 4 /usr/bin/installbsd, which doesn't work without a -g flag -# AFS /usr/afsws/bin/install, which mishandles nonexistent args -# SVR4 /usr/ucb/install, which tries to use the nonexistent group "staff" -# OS/2's system install, which has a completely different semantic -# ./install, which can be erroneously created by make from ./install.sh. -{ echo "$as_me:$LINENO: checking for a BSD-compatible install" >&5 -echo $ECHO_N "checking for a BSD-compatible install... $ECHO_C" >&6; } -if test -z "$INSTALL"; then -if test "${ac_cv_path_install+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - # Account for people who put trailing slashes in PATH elements. -case $as_dir/ in - ./ | .// | /cC/* | \ - /etc/* | /usr/sbin/* | /usr/etc/* | /sbin/* | /usr/afsws/bin/* | \ - ?:\\/os2\\/install\\/* | ?:\\/OS2\\/INSTALL\\/* | \ - /usr/ucb/* ) ;; - *) - # OSF1 and SCO ODT 3.0 have their own names for install. - # Don't use installbsd from OSF since it installs stuff as root - # by default. - for ac_prog in ginstall scoinst install; do - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_prog$ac_exec_ext" && $as_test_x "$as_dir/$ac_prog$ac_exec_ext"; }; then - if test $ac_prog = install && - grep dspmsg "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then - # AIX install. It has an incompatible calling convention. - : - elif test $ac_prog = install && - grep pwplus "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then - # program-specific install script used by HP pwplus--don't use. - : - else - ac_cv_path_install="$as_dir/$ac_prog$ac_exec_ext -c" - break 3 - fi - fi - done - done - ;; -esac -done -IFS=$as_save_IFS - - -fi - if test "${ac_cv_path_install+set}" = set; then - INSTALL=$ac_cv_path_install - else - # As a last resort, use the slow shell script. Don't cache a - # value for INSTALL within a source directory, because that will - # break other packages using the cache if that directory is - # removed, or if the value is a relative name. - INSTALL=$ac_install_sh - fi -fi -{ echo "$as_me:$LINENO: result: $INSTALL" >&5 -echo "${ECHO_T}$INSTALL" >&6; } - -# Use test -z because SunOS4 sh mishandles braces in ${var-val}. -# It thinks the first close brace ends the variable substitution. -test -z "$INSTALL_PROGRAM" && INSTALL_PROGRAM='${INSTALL}' - -test -z "$INSTALL_SCRIPT" && INSTALL_SCRIPT='${INSTALL}' - -test -z "$INSTALL_DATA" && INSTALL_DATA='${INSTALL} -m 644' - -{ echo "$as_me:$LINENO: checking whether build environment is sane" >&5 -echo $ECHO_N "checking whether build environment is sane... $ECHO_C" >&6; } -# Just in case -sleep 1 -echo timestamp > conftest.file -# Do `set' in a subshell so we don't clobber the current shell's -# arguments. Must try -L first in case configure is actually a -# symlink; some systems play weird games with the mod time of symlinks -# (eg FreeBSD returns the mod time of the symlink's containing -# directory). -if ( - set X `ls -Lt $srcdir/configure conftest.file 2> /dev/null` - if test "$*" = "X"; then - # -L didn't work. - set X `ls -t $srcdir/configure conftest.file` - fi - rm -f conftest.file - if test "$*" != "X $srcdir/configure conftest.file" \ - && test "$*" != "X conftest.file $srcdir/configure"; then - - # If neither matched, then we have a broken ls. This can happen - # if, for instance, CONFIG_SHELL is bash and it inherits a - # broken ls alias from the environment. This has actually - # happened. Such a system could not be considered "sane". - { { echo "$as_me:$LINENO: error: ls -t appears to fail. Make sure there is not a broken -alias in your environment" >&5 -echo "$as_me: error: ls -t appears to fail. Make sure there is not a broken -alias in your environment" >&2;} - { (exit 1); exit 1; }; } - fi - - test "$2" = conftest.file - ) -then - # Ok. - : -else - { { echo "$as_me:$LINENO: error: newly created file is older than distributed files! -Check your system clock" >&5 -echo "$as_me: error: newly created file is older than distributed files! -Check your system clock" >&2;} - { (exit 1); exit 1; }; } -fi -{ echo "$as_me:$LINENO: result: yes" >&5 -echo "${ECHO_T}yes" >&6; } -test "$program_prefix" != NONE && - program_transform_name="s&^&$program_prefix&;$program_transform_name" -# Use a double $ so make ignores it. -test "$program_suffix" != NONE && - program_transform_name="s&\$&$program_suffix&;$program_transform_name" -# Double any \ or $. echo might interpret backslashes. -# By default was `s,x,x', remove it if useless. -cat <<\_ACEOF >conftest.sed -s/[\\$]/&&/g;s/;s,x,x,$// -_ACEOF -program_transform_name=`echo $program_transform_name | sed -f conftest.sed` -rm -f conftest.sed - -# expand $ac_aux_dir to an absolute path -am_aux_dir=`cd $ac_aux_dir && pwd` - -test x"${MISSING+set}" = xset || MISSING="\${SHELL} $am_aux_dir/missing" -# Use eval to expand $SHELL -if eval "$MISSING --run true"; then - am_missing_run="$MISSING --run " -else - am_missing_run= - { echo "$as_me:$LINENO: WARNING: \`missing' script is too old or missing" >&5 -echo "$as_me: WARNING: \`missing' script is too old or missing" >&2;} -fi - -if mkdir -p --version . >/dev/null 2>&1 && test ! -d ./--version; then - # We used to keeping the `.' as first argument, in order to - # allow $(mkdir_p) to be used without argument. As in - # $(mkdir_p) $(somedir) - # where $(somedir) is conditionally defined. However this is wrong - # for two reasons: - # 1. if the package is installed by a user who cannot write `.' - # make install will fail, - # 2. the above comment should most certainly read - # $(mkdir_p) $(DESTDIR)$(somedir) - # so it does not work when $(somedir) is undefined and - # $(DESTDIR) is not. - # To support the latter case, we have to write - # test -z "$(somedir)" || $(mkdir_p) $(DESTDIR)$(somedir), - # so the `.' trick is pointless. - mkdir_p='mkdir -p --' -else - # On NextStep and OpenStep, the `mkdir' command does not - # recognize any option. It will interpret all options as - # directories to create, and then abort because `.' already - # exists. - for d in ./-p ./--version; - do - test -d $d && rmdir $d - done - # $(mkinstalldirs) is defined by Automake if mkinstalldirs exists. - if test -f "$ac_aux_dir/mkinstalldirs"; then - mkdir_p='$(mkinstalldirs)' - else - mkdir_p='$(install_sh) -d' - fi -fi - -for ac_prog in gawk mawk nawk awk -do - # Extract the first word of "$ac_prog", so it can be a program name with args. -set dummy $ac_prog; ac_word=$2 -{ echo "$as_me:$LINENO: checking for $ac_word" >&5 -echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6; } -if test "${ac_cv_prog_AWK+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - if test -n "$AWK"; then - ac_cv_prog_AWK="$AWK" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_AWK="$ac_prog" - echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done -done -IFS=$as_save_IFS - -fi -fi -AWK=$ac_cv_prog_AWK -if test -n "$AWK"; then - { echo "$as_me:$LINENO: result: $AWK" >&5 -echo "${ECHO_T}$AWK" >&6; } -else - { echo "$as_me:$LINENO: result: no" >&5 -echo "${ECHO_T}no" >&6; } -fi - - - test -n "$AWK" && break -done - -{ echo "$as_me:$LINENO: checking whether ${MAKE-make} sets \$(MAKE)" >&5 -echo $ECHO_N "checking whether ${MAKE-make} sets \$(MAKE)... $ECHO_C" >&6; } -set x ${MAKE-make}; ac_make=`echo "$2" | sed 's/+/p/g; s/[^a-zA-Z0-9_]/_/g'` -if { as_var=ac_cv_prog_make_${ac_make}_set; eval "test \"\${$as_var+set}\" = set"; }; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - cat >conftest.make <<\_ACEOF -SHELL = /bin/sh -all: - @echo '@@@%%%=$(MAKE)=@@@%%%' -_ACEOF -# GNU make sometimes prints "make[1]: Entering...", which would confuse us. -case `${MAKE-make} -f conftest.make 2>/dev/null` in - *@@@%%%=?*=@@@%%%*) - eval ac_cv_prog_make_${ac_make}_set=yes;; - *) - eval ac_cv_prog_make_${ac_make}_set=no;; -esac -rm -f conftest.make -fi -if eval test \$ac_cv_prog_make_${ac_make}_set = yes; then - { echo "$as_me:$LINENO: result: yes" >&5 -echo "${ECHO_T}yes" >&6; } - SET_MAKE= -else - { echo "$as_me:$LINENO: result: no" >&5 -echo "${ECHO_T}no" >&6; } - SET_MAKE="MAKE=${MAKE-make}" -fi - -rm -rf .tst 2>/dev/null -mkdir .tst 2>/dev/null -if test -d .tst; then - am__leading_dot=. -else - am__leading_dot=_ -fi -rmdir .tst 2>/dev/null - -# test to see if srcdir already configured -if test "`cd $srcdir && pwd`" != "`pwd`" && - test -f $srcdir/config.status; then - { { echo "$as_me:$LINENO: error: source directory already configured; run \"make distclean\" there first" >&5 -echo "$as_me: error: source directory already configured; run \"make distclean\" there first" >&2;} - { (exit 1); exit 1; }; } -fi - -# test whether we have cygpath -if test -z "$CYGPATH_W"; then - if (cygpath --version) >/dev/null 2>/dev/null; then - CYGPATH_W='cygpath -w' - else - CYGPATH_W=echo - fi -fi - - -# Define the identity of the package. - PACKAGE='texi2html' - VERSION='1.76' - - -cat >>confdefs.h <<_ACEOF -#define PACKAGE "$PACKAGE" -_ACEOF - - -cat >>confdefs.h <<_ACEOF -#define VERSION "$VERSION" -_ACEOF - -# Some tools Automake needs. - -ACLOCAL=${ACLOCAL-"${am_missing_run}aclocal-${am__api_version}"} - - -AUTOCONF=${AUTOCONF-"${am_missing_run}autoconf"} - - -AUTOMAKE=${AUTOMAKE-"${am_missing_run}automake-${am__api_version}"} - - -AUTOHEADER=${AUTOHEADER-"${am_missing_run}autoheader"} - - -MAKEINFO=${MAKEINFO-"${am_missing_run}makeinfo"} - -install_sh=${install_sh-"$am_aux_dir/install-sh"} - -# Installed binaries are usually stripped using `strip' when the user -# run `make install-strip'. However `strip' might not be the right -# tool to use in cross-compilation environments, therefore Automake -# will honor the `STRIP' environment variable to overrule this program. -if test "$cross_compiling" != no; then - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}strip", so it can be a program name with args. -set dummy ${ac_tool_prefix}strip; ac_word=$2 -{ echo "$as_me:$LINENO: checking for $ac_word" >&5 -echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6; } -if test "${ac_cv_prog_STRIP+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - if test -n "$STRIP"; then - ac_cv_prog_STRIP="$STRIP" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_STRIP="${ac_tool_prefix}strip" - echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done -done -IFS=$as_save_IFS - -fi -fi -STRIP=$ac_cv_prog_STRIP -if test -n "$STRIP"; then - { echo "$as_me:$LINENO: result: $STRIP" >&5 -echo "${ECHO_T}$STRIP" >&6; } -else - { echo "$as_me:$LINENO: result: no" >&5 -echo "${ECHO_T}no" >&6; } -fi - - -fi -if test -z "$ac_cv_prog_STRIP"; then - ac_ct_STRIP=$STRIP - # Extract the first word of "strip", so it can be a program name with args. -set dummy strip; ac_word=$2 -{ echo "$as_me:$LINENO: checking for $ac_word" >&5 -echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6; } -if test "${ac_cv_prog_ac_ct_STRIP+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - if test -n "$ac_ct_STRIP"; then - ac_cv_prog_ac_ct_STRIP="$ac_ct_STRIP" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_ac_ct_STRIP="strip" - echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done -done -IFS=$as_save_IFS - -fi -fi -ac_ct_STRIP=$ac_cv_prog_ac_ct_STRIP -if test -n "$ac_ct_STRIP"; then - { echo "$as_me:$LINENO: result: $ac_ct_STRIP" >&5 -echo "${ECHO_T}$ac_ct_STRIP" >&6; } -else - { echo "$as_me:$LINENO: result: no" >&5 -echo "${ECHO_T}no" >&6; } -fi - - if test "x$ac_ct_STRIP" = x; then - STRIP=":" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ echo "$as_me:$LINENO: WARNING: In the future, Autoconf will not detect cross-tools -whose name does not start with the host triplet. If you think this -configuration is useful to you, please write to autoconf@gnu.org." >&5 -echo "$as_me: WARNING: In the future, Autoconf will not detect cross-tools -whose name does not start with the host triplet. If you think this -configuration is useful to you, please write to autoconf@gnu.org." >&2;} -ac_tool_warned=yes ;; -esac - STRIP=$ac_ct_STRIP - fi -else - STRIP="$ac_cv_prog_STRIP" -fi - -fi -INSTALL_STRIP_PROGRAM="\${SHELL} \$(install_sh) -c -s" - -# We need awk for the "check" target. The system "awk" is bad on -# some platforms. -# Always define AMTAR for backward compatibility. - -AMTAR=${AMTAR-"${am_missing_run}tar"} - -am__tar='${AMTAR} chof - "$$tardir"'; am__untar='${AMTAR} xf -' - - - - - - -{ echo "$as_me:$LINENO: checking whether to enable maintainer-specific portions of Makefiles" >&5 -echo $ECHO_N "checking whether to enable maintainer-specific portions of Makefiles... $ECHO_C" >&6; } - # Check whether --enable-maintainer-mode was given. -if test "${enable_maintainer_mode+set}" = set; then - enableval=$enable_maintainer_mode; USE_MAINTAINER_MODE=$enableval -else - USE_MAINTAINER_MODE=no -fi - - { echo "$as_me:$LINENO: result: $USE_MAINTAINER_MODE" >&5 -echo "${ECHO_T}$USE_MAINTAINER_MODE" >&6; } - - -if test $USE_MAINTAINER_MODE = yes; then - MAINTAINER_MODE_TRUE= - MAINTAINER_MODE_FALSE='#' -else - MAINTAINER_MODE_TRUE='#' - MAINTAINER_MODE_FALSE= -fi - - MAINT=$MAINTAINER_MODE_TRUE - - - -PACKAGE_DATE=`"$srcdir"/mdate-sh "$srcdir"/configure.ac` - -INIT=$srcdir/texi2html.init - -MYSIMPLE=$srcdir/MySimple.pm - -T2H_I18N=$srcdir/T2h_i18n.pm - -T2H_L2H_FILE=$srcdir/l2h.init - -T2H_TRANSLATIONS_FILE=$srcdir/translations.pl - - -# Check whether --with-encode was given. -if test "${with_encode+set}" = set; then - withval=$with_encode; if test $withval = 'no'; then - USE_UNICODE=0 - else - USE_UNICODE=1 - fi -else - - if perl -e "use Encode; use Unicode::Normalize;" > /dev/null 2>&1; - then USE_UNICODE=1 - else - USE_UNICODE=0 - fi - -fi - - - - -# Extract the first word of "perl", so it can be a program name with args. -set dummy perl; ac_word=$2 -{ echo "$as_me:$LINENO: checking for $ac_word" >&5 -echo $ECHO_N "checking for $ac_word... $ECHO_C" >&6; } -if test "${ac_cv_path_PERL+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - case $PERL in - [\\/]* | ?:[\\/]*) - ac_cv_path_PERL="$PERL" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="/opt/perl5/bin:"$PATH"" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_PERL="$as_dir/$ac_word$ac_exec_ext" - echo "$as_me:$LINENO: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done -done -IFS=$as_save_IFS - - test -z "$ac_cv_path_PERL" && ac_cv_path_PERL="/usr/bin/env perl" - ;; -esac -fi -PERL=$ac_cv_path_PERL -if test -n "$PERL"; then - { echo "$as_me:$LINENO: result: $PERL" >&5 -echo "${ECHO_T}$PERL" >&6; } -else - { echo "$as_me:$LINENO: result: no" >&5 -echo "${ECHO_T}no" >&6; } -fi - - - -# Find a good install program. We prefer a C program (faster), -# so one script is as good as another. But avoid the broken or -# incompatible versions: -# SysV /etc/install, /usr/sbin/install -# SunOS /usr/etc/install -# IRIX /sbin/install -# AIX /bin/install -# AmigaOS /C/install, which installs bootblocks on floppy discs -# AIX 4 /usr/bin/installbsd, which doesn't work without a -g flag -# AFS /usr/afsws/bin/install, which mishandles nonexistent args -# SVR4 /usr/ucb/install, which tries to use the nonexistent group "staff" -# OS/2's system install, which has a completely different semantic -# ./install, which can be erroneously created by make from ./install.sh. -{ echo "$as_me:$LINENO: checking for a BSD-compatible install" >&5 -echo $ECHO_N "checking for a BSD-compatible install... $ECHO_C" >&6; } -if test -z "$INSTALL"; then -if test "${ac_cv_path_install+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - # Account for people who put trailing slashes in PATH elements. -case $as_dir/ in - ./ | .// | /cC/* | \ - /etc/* | /usr/sbin/* | /usr/etc/* | /sbin/* | /usr/afsws/bin/* | \ - ?:\\/os2\\/install\\/* | ?:\\/OS2\\/INSTALL\\/* | \ - /usr/ucb/* ) ;; - *) - # OSF1 and SCO ODT 3.0 have their own names for install. - # Don't use installbsd from OSF since it installs stuff as root - # by default. - for ac_prog in ginstall scoinst install; do - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_prog$ac_exec_ext" && $as_test_x "$as_dir/$ac_prog$ac_exec_ext"; }; then - if test $ac_prog = install && - grep dspmsg "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then - # AIX install. It has an incompatible calling convention. - : - elif test $ac_prog = install && - grep pwplus "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then - # program-specific install script used by HP pwplus--don't use. - : - else - ac_cv_path_install="$as_dir/$ac_prog$ac_exec_ext -c" - break 3 - fi - fi - done - done - ;; -esac -done -IFS=$as_save_IFS - - -fi - if test "${ac_cv_path_install+set}" = set; then - INSTALL=$ac_cv_path_install - else - # As a last resort, use the slow shell script. Don't cache a - # value for INSTALL within a source directory, because that will - # break other packages using the cache if that directory is - # removed, or if the value is a relative name. - INSTALL=$ac_install_sh - fi -fi -{ echo "$as_me:$LINENO: result: $INSTALL" >&5 -echo "${ECHO_T}$INSTALL" >&6; } - -# Use test -z because SunOS4 sh mishandles braces in ${var-val}. -# It thinks the first close brace ends the variable substitution. -test -z "$INSTALL_PROGRAM" && INSTALL_PROGRAM='${INSTALL}' - -test -z "$INSTALL_SCRIPT" && INSTALL_SCRIPT='${INSTALL}' - -test -z "$INSTALL_DATA" && INSTALL_DATA='${INSTALL} -m 644' - - - - - - -# For teTeX and TeX Live. -# Make sure we can run config.sub. -$SHELL "$ac_aux_dir/config.sub" sun4 >/dev/null 2>&1 || - { { echo "$as_me:$LINENO: error: cannot run $SHELL $ac_aux_dir/config.sub" >&5 -echo "$as_me: error: cannot run $SHELL $ac_aux_dir/config.sub" >&2;} - { (exit 1); exit 1; }; } - -{ echo "$as_me:$LINENO: checking build system type" >&5 -echo $ECHO_N "checking build system type... $ECHO_C" >&6; } -if test "${ac_cv_build+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - ac_build_alias=$build_alias -test "x$ac_build_alias" = x && - ac_build_alias=`$SHELL "$ac_aux_dir/config.guess"` -test "x$ac_build_alias" = x && - { { echo "$as_me:$LINENO: error: cannot guess build type; you must specify one" >&5 -echo "$as_me: error: cannot guess build type; you must specify one" >&2;} - { (exit 1); exit 1; }; } -ac_cv_build=`$SHELL "$ac_aux_dir/config.sub" $ac_build_alias` || - { { echo "$as_me:$LINENO: error: $SHELL $ac_aux_dir/config.sub $ac_build_alias failed" >&5 -echo "$as_me: error: $SHELL $ac_aux_dir/config.sub $ac_build_alias failed" >&2;} - { (exit 1); exit 1; }; } - -fi -{ echo "$as_me:$LINENO: result: $ac_cv_build" >&5 -echo "${ECHO_T}$ac_cv_build" >&6; } -case $ac_cv_build in -*-*-*) ;; -*) { { echo "$as_me:$LINENO: error: invalid value of canonical build" >&5 -echo "$as_me: error: invalid value of canonical build" >&2;} - { (exit 1); exit 1; }; };; -esac -build=$ac_cv_build -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_build -shift -build_cpu=$1 -build_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -build_os=$* -IFS=$ac_save_IFS -case $build_os in *\ *) build_os=`echo "$build_os" | sed 's/ /-/g'`;; esac - - -{ echo "$as_me:$LINENO: checking host system type" >&5 -echo $ECHO_N "checking host system type... $ECHO_C" >&6; } -if test "${ac_cv_host+set}" = set; then - echo $ECHO_N "(cached) $ECHO_C" >&6 -else - if test "x$host_alias" = x; then - ac_cv_host=$ac_cv_build -else - ac_cv_host=`$SHELL "$ac_aux_dir/config.sub" $host_alias` || - { { echo "$as_me:$LINENO: error: $SHELL $ac_aux_dir/config.sub $host_alias failed" >&5 -echo "$as_me: error: $SHELL $ac_aux_dir/config.sub $host_alias failed" >&2;} - { (exit 1); exit 1; }; } -fi - -fi -{ echo "$as_me:$LINENO: result: $ac_cv_host" >&5 -echo "${ECHO_T}$ac_cv_host" >&6; } -case $ac_cv_host in -*-*-*) ;; -*) { { echo "$as_me:$LINENO: error: invalid value of canonical host" >&5 -echo "$as_me: error: invalid value of canonical host" >&2;} - { (exit 1); exit 1; }; };; -esac -host=$ac_cv_host -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_host -shift -host_cpu=$1 -host_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -host_os=$* -IFS=$ac_save_IFS -case $host_os in *\ *) host_os=`echo "$host_os" | sed 's/ /-/g'`;; esac - - -# Check whether --enable-multiplatform was given. -if test "${enable_multiplatform+set}" = set; then - enableval=$enable_multiplatform; -fi -# if enable_multiplatform is set in the environment, use that. -if test "x$enable_multiplatform" = xyes; then - test "x$bindir" = 'x${exec_prefix}/bin' && bindir="$bindir/$host" - test "x$libdir" = 'x${exec_prefix}/lib' && libdir="$libdir/$host" -fi - -ac_config_files="$ac_config_files texi2html:texi2html.pl" - -ac_config_files="$ac_config_files check_texinfo.pl" - - -ac_config_files="$ac_config_files Makefile Tests/Makefile doc/Makefile texi2html.1 texi2html.spec" - -cat >confcache <<\_ACEOF -# This file is a shell script that caches the results of configure -# tests run on this system so they can be shared between configure -# scripts and configure runs, see configure's option --config-cache. -# It is not useful on other systems. If it contains results you don't -# want to keep, you may remove or edit it. -# -# config.status only pays attention to the cache file if you give it -# the --recheck option to rerun configure. -# -# `ac_cv_env_foo' variables (set or unset) will be overridden when -# loading this file, other *unset* `ac_cv_foo' will be assigned the -# following values. - -_ACEOF - -# The following way of writing the cache mishandles newlines in values, -# but we know of no workaround that is simple, portable, and efficient. -# So, we kill variables containing newlines. -# Ultrix sh set writes to stderr and can't be redirected directly, -# and sets the high bit in the cache file unless we assign to the vars. -( - for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { echo "$as_me:$LINENO: WARNING: Cache variable $ac_var contains a newline." >&5 -echo "$as_me: WARNING: Cache variable $ac_var contains a newline." >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - *) $as_unset $ac_var ;; - esac ;; - esac - done - - (set) 2>&1 | - case $as_nl`(ac_space=' '; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - # `set' does not quote correctly, so add quotes (double-quote - # substitution turns \\\\ into \\, and sed turns \\ into \). - sed -n \ - "s/'/'\\\\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" - ;; #( - *) - # `set' quotes correctly as required by POSIX, so do not add quotes. - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) | - sed ' - /^ac_cv_env_/b end - t clear - :clear - s/^\([^=]*\)=\(.*[{}].*\)$/test "${\1+set}" = set || &/ - t end - s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ - :end' >>confcache -if diff "$cache_file" confcache >/dev/null 2>&1; then :; else - if test -w "$cache_file"; then - test "x$cache_file" != "x/dev/null" && - { echo "$as_me:$LINENO: updating cache $cache_file" >&5 -echo "$as_me: updating cache $cache_file" >&6;} - cat confcache >$cache_file - else - { echo "$as_me:$LINENO: not updating unwritable cache $cache_file" >&5 -echo "$as_me: not updating unwritable cache $cache_file" >&6;} - fi -fi -rm -f confcache - -test "x$prefix" = xNONE && prefix=$ac_default_prefix -# Let make expand exec_prefix. -test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' - -# Transform confdefs.h into DEFS. -# Protect against shell expansion while executing Makefile rules. -# Protect against Makefile macro expansion. -# -# If the first sed substitution is executed (which looks for macros that -# take arguments), then branch to the quote section. Otherwise, -# look for a macro that doesn't take arguments. -ac_script=' -t clear -:clear -s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g -t quote -s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g -t quote -b any -:quote -s/[ `~#$^&*(){}\\|;'\''"<>?]/\\&/g -s/\[/\\&/g -s/\]/\\&/g -s/\$/$$/g -H -:any -${ - g - s/^\n// - s/\n/ /g - p -} -' -DEFS=`sed -n "$ac_script" confdefs.h` - - -ac_libobjs= -ac_ltlibobjs= -for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue - # 1. Remove the extension, and $U if already installed. - ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' - ac_i=`echo "$ac_i" | sed "$ac_script"` - # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR - # will be set to the directory where LIBOBJS objects are built. - ac_libobjs="$ac_libobjs \${LIBOBJDIR}$ac_i\$U.$ac_objext" - ac_ltlibobjs="$ac_ltlibobjs \${LIBOBJDIR}$ac_i"'$U.lo' -done -LIBOBJS=$ac_libobjs - -LTLIBOBJS=$ac_ltlibobjs - - -if test -z "${MAINTAINER_MODE_TRUE}" && test -z "${MAINTAINER_MODE_FALSE}"; then - { { echo "$as_me:$LINENO: error: conditional \"MAINTAINER_MODE\" was never defined. -Usually this means the macro was only invoked conditionally." >&5 -echo "$as_me: error: conditional \"MAINTAINER_MODE\" was never defined. -Usually this means the macro was only invoked conditionally." >&2;} - { (exit 1); exit 1; }; } -fi - -: ${CONFIG_STATUS=./config.status} -ac_clean_files_save=$ac_clean_files -ac_clean_files="$ac_clean_files $CONFIG_STATUS" -{ echo "$as_me:$LINENO: creating $CONFIG_STATUS" >&5 -echo "$as_me: creating $CONFIG_STATUS" >&6;} -cat >$CONFIG_STATUS <<_ACEOF -#! $SHELL -# Generated by $as_me. -# Run this file to recreate the current configuration. -# Compiler output produced by configure, useful for debugging -# configure, is in config.log if it exists. - -debug=false -ac_cs_recheck=false -ac_cs_silent=false -SHELL=\${CONFIG_SHELL-$SHELL} -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF -## --------------------- ## -## M4sh Initialization. ## -## --------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then - emulate sh - NULLCMD=: - # Zsh 3.x and 4.x performs word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in - *posix*) set -o posix ;; -esac - -fi - - - - -# PATH needs CR -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - echo "#! /bin/sh" >conf$$.sh - echo "exit 0" >>conf$$.sh - chmod +x conf$$.sh - if (PATH="/nonexistent;."; conf$$.sh) >/dev/null 2>&1; then - PATH_SEPARATOR=';' - else - PATH_SEPARATOR=: - fi - rm -f conf$$.sh -fi - -# Support unset when possible. -if ( (MAIL=60; unset MAIL) || exit) >/dev/null 2>&1; then - as_unset=unset -else - as_unset=false -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -as_nl=' -' -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break -done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - { (exit 1); exit 1; } -fi - -# Work around bugs in pre-3.0 UWIN ksh. -for as_var in ENV MAIL MAILPATH -do ($as_unset $as_var) >/dev/null 2>&1 && $as_unset $as_var -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -for as_var in \ - LANG LANGUAGE LC_ADDRESS LC_ALL LC_COLLATE LC_CTYPE LC_IDENTIFICATION \ - LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER \ - LC_TELEPHONE LC_TIME -do - if (set +x; test -z "`(eval $as_var=C; export $as_var) 2>&1`"); then - eval $as_var=C; export $as_var - else - ($as_unset $as_var) >/dev/null 2>&1 && $as_unset $as_var - fi -done - -# Required to use basename. -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - - -# Name of the executable. -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# CDPATH. -$as_unset CDPATH - - - - as_lineno_1=$LINENO - as_lineno_2=$LINENO - test "x$as_lineno_1" != "x$as_lineno_2" && - test "x`expr $as_lineno_1 + 1`" = "x$as_lineno_2" || { - - # Create $as_me.lineno as a copy of $as_myself, but with $LINENO - # uniformly replaced by the line number. The first 'sed' inserts a - # line-number line after each line using $LINENO; the second 'sed' - # does the real work. The second script uses 'N' to pair each - # line-number line with the line containing $LINENO, and appends - # trailing '-' during substitution so that $LINENO is not a special - # case at line end. - # (Raja R Harinath suggested sed '=', and Paul Eggert wrote the - # scripts with optimization help from Paolo Bonzini. Blame Lee - # E. McMahon (1931-1989) for sed's syntax. :-) - sed -n ' - p - /[$]LINENO/= - ' <$as_myself | - sed ' - s/[$]LINENO.*/&-/ - t lineno - b - :lineno - N - :loop - s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ - t loop - s/-\n.*// - ' >$as_me.lineno && - chmod +x "$as_me.lineno" || - { echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2 - { (exit 1); exit 1; }; } - - # Don't try to exec as it changes $[0], causing all sort of problems - # (the dirname of $[0] is not the place where we might find the - # original and so on. Autoconf is especially sensitive to this). - . "./$as_me.lineno" - # Exit status is that of the last command. - exit -} - - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in --n*) - case `echo 'x\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - *) ECHO_C='\c';; - esac;; -*) - ECHO_N='-n';; -esac - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir -fi -echo >conf$$.file -if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' -elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - -if mkdir -p . 2>/dev/null; then - as_mkdir_p=: -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - -exec 6>&1 - -# Save the log message, to keep $[0] and so on meaningful, and to -# report actual input values of CONFIG_FILES etc. instead of their -# values after options handling. -ac_log=" -This file was extended by texi2html $as_me 1.76, which was -generated by GNU Autoconf 2.61. Invocation command line was - - CONFIG_FILES = $CONFIG_FILES - CONFIG_HEADERS = $CONFIG_HEADERS - CONFIG_LINKS = $CONFIG_LINKS - CONFIG_COMMANDS = $CONFIG_COMMANDS - $ $0 $@ - -on `(hostname || uname -n) 2>/dev/null | sed 1q` -" - -_ACEOF - -cat >>$CONFIG_STATUS <<_ACEOF -# Files that config.status was made for. -config_files="$ac_config_files" - -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF -ac_cs_usage="\ -\`$as_me' instantiates files from templates according to the -current configuration. - -Usage: $0 [OPTIONS] [FILE]... - - -h, --help print this help, then exit - -V, --version print version number and configuration settings, then exit - -q, --quiet do not print progress messages - -d, --debug don't remove temporary files - --recheck update $as_me by reconfiguring in the same conditions - --file=FILE[:TEMPLATE] - instantiate the configuration file FILE - -Configuration files: -$config_files - -Report bugs to <bug-autoconf@gnu.org>." - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF -ac_cs_version="\\ -texi2html config.status 1.76 -configured by $0, generated by GNU Autoconf 2.61, - with options \\"`echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`\\" - -Copyright (C) 2006 Free Software Foundation, Inc. -This config.status script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it." - -ac_pwd='$ac_pwd' -srcdir='$srcdir' -INSTALL='$INSTALL' -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF -# If no file are specified by the user, then we need to provide default -# value. By we need to know if files were specified by the user. -ac_need_defaults=: -while test $# != 0 -do - case $1 in - --*=*) - ac_option=`expr "X$1" : 'X\([^=]*\)='` - ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` - ac_shift=: - ;; - *) - ac_option=$1 - ac_optarg=$2 - ac_shift=shift - ;; - esac - - case $ac_option in - # Handling of the options. - -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) - ac_cs_recheck=: ;; - --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) - echo "$ac_cs_version"; exit ;; - --debug | --debu | --deb | --de | --d | -d ) - debug=: ;; - --file | --fil | --fi | --f ) - $ac_shift - CONFIG_FILES="$CONFIG_FILES $ac_optarg" - ac_need_defaults=false;; - --he | --h | --help | --hel | -h ) - echo "$ac_cs_usage"; exit ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil | --si | --s) - ac_cs_silent=: ;; - - # This is an error. - -*) { echo "$as_me: error: unrecognized option: $1 -Try \`$0 --help' for more information." >&2 - { (exit 1); exit 1; }; } ;; - - *) ac_config_targets="$ac_config_targets $1" - ac_need_defaults=false ;; - - esac - shift -done - -ac_configure_extra_args= - -if $ac_cs_silent; then - exec 6>/dev/null - ac_configure_extra_args="$ac_configure_extra_args --silent" -fi - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF -if \$ac_cs_recheck; then - echo "running CONFIG_SHELL=$SHELL $SHELL $0 "$ac_configure_args \$ac_configure_extra_args " --no-create --no-recursion" >&6 - CONFIG_SHELL=$SHELL - export CONFIG_SHELL - exec $SHELL "$0"$ac_configure_args \$ac_configure_extra_args --no-create --no-recursion -fi - -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF -exec 5>>config.log -{ - echo - sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX -## Running $as_me. ## -_ASBOX - echo "$ac_log" -} >&5 - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF - -# Handling of arguments. -for ac_config_target in $ac_config_targets -do - case $ac_config_target in - "texi2html") CONFIG_FILES="$CONFIG_FILES texi2html:texi2html.pl" ;; - "check_texinfo.pl") CONFIG_FILES="$CONFIG_FILES check_texinfo.pl" ;; - "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; - "Tests/Makefile") CONFIG_FILES="$CONFIG_FILES Tests/Makefile" ;; - "doc/Makefile") CONFIG_FILES="$CONFIG_FILES doc/Makefile" ;; - "texi2html.1") CONFIG_FILES="$CONFIG_FILES texi2html.1" ;; - "texi2html.spec") CONFIG_FILES="$CONFIG_FILES texi2html.spec" ;; - - *) { { echo "$as_me:$LINENO: error: invalid argument: $ac_config_target" >&5 -echo "$as_me: error: invalid argument: $ac_config_target" >&2;} - { (exit 1); exit 1; }; };; - esac -done - - -# If the user did not use the arguments to specify the items to instantiate, -# then the envvar interface is used. Set only those that are not. -# We use the long form for the default assignment because of an extremely -# bizarre bug on SunOS 4.1.3. -if $ac_need_defaults; then - test "${CONFIG_FILES+set}" = set || CONFIG_FILES=$config_files -fi - -# Have a temporary directory for convenience. Make it in the build tree -# simply because there is no reason against having it here, and in addition, -# creating and moving files from /tmp can sometimes cause problems. -# Hook for its removal unless debugging. -# Note that there is a small window in which the directory will not be cleaned: -# after its creation but before its name has been assigned to `$tmp'. -$debug || -{ - tmp= - trap 'exit_status=$? - { test -z "$tmp" || test ! -d "$tmp" || rm -fr "$tmp"; } && exit $exit_status -' 0 - trap '{ (exit 1); exit 1; }' 1 2 13 15 -} -# Create a (secure) tmp directory for tmp files. - -{ - tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && - test -n "$tmp" && test -d "$tmp" -} || -{ - tmp=./conf$$-$RANDOM - (umask 077 && mkdir "$tmp") -} || -{ - echo "$me: cannot create a temporary directory in ." >&2 - { (exit 1); exit 1; } -} - -# -# Set up the sed scripts for CONFIG_FILES section. -# - -# No need to generate the scripts if there are no CONFIG_FILES. -# This happens for instance when ./config.status config.h -if test -n "$CONFIG_FILES"; then - -_ACEOF - -# Create sed commands to just substitute file output variables. - -# Remaining file output variables are in a fragment that also has non-file -# output varibles. - - - -ac_delim='%!_!# ' -for ac_last_try in false false false false false :; do - cat >conf$$subs.sed <<_ACEOF -SHELL!$SHELL$ac_delim -PATH_SEPARATOR!$PATH_SEPARATOR$ac_delim -PACKAGE_NAME!$PACKAGE_NAME$ac_delim -PACKAGE_TARNAME!$PACKAGE_TARNAME$ac_delim -PACKAGE_VERSION!$PACKAGE_VERSION$ac_delim -PACKAGE_STRING!$PACKAGE_STRING$ac_delim -PACKAGE_BUGREPORT!$PACKAGE_BUGREPORT$ac_delim -exec_prefix!$exec_prefix$ac_delim -prefix!$prefix$ac_delim -program_transform_name!$program_transform_name$ac_delim -bindir!$bindir$ac_delim -sbindir!$sbindir$ac_delim -libexecdir!$libexecdir$ac_delim -datarootdir!$datarootdir$ac_delim -datadir!$datadir$ac_delim -sysconfdir!$sysconfdir$ac_delim -sharedstatedir!$sharedstatedir$ac_delim -localstatedir!$localstatedir$ac_delim -includedir!$includedir$ac_delim -oldincludedir!$oldincludedir$ac_delim -docdir!$docdir$ac_delim -infodir!$infodir$ac_delim -htmldir!$htmldir$ac_delim -dvidir!$dvidir$ac_delim -pdfdir!$pdfdir$ac_delim -psdir!$psdir$ac_delim -libdir!$libdir$ac_delim -localedir!$localedir$ac_delim -mandir!$mandir$ac_delim -DEFS!$DEFS$ac_delim -ECHO_C!$ECHO_C$ac_delim -ECHO_N!$ECHO_N$ac_delim -ECHO_T!$ECHO_T$ac_delim -LIBS!$LIBS$ac_delim -build_alias!$build_alias$ac_delim -host_alias!$host_alias$ac_delim -target_alias!$target_alias$ac_delim -INSTALL_PROGRAM!$INSTALL_PROGRAM$ac_delim -INSTALL_SCRIPT!$INSTALL_SCRIPT$ac_delim -INSTALL_DATA!$INSTALL_DATA$ac_delim -CYGPATH_W!$CYGPATH_W$ac_delim -PACKAGE!$PACKAGE$ac_delim -VERSION!$VERSION$ac_delim -ACLOCAL!$ACLOCAL$ac_delim -AUTOCONF!$AUTOCONF$ac_delim -AUTOMAKE!$AUTOMAKE$ac_delim -AUTOHEADER!$AUTOHEADER$ac_delim -MAKEINFO!$MAKEINFO$ac_delim -install_sh!$install_sh$ac_delim -STRIP!$STRIP$ac_delim -INSTALL_STRIP_PROGRAM!$INSTALL_STRIP_PROGRAM$ac_delim -mkdir_p!$mkdir_p$ac_delim -AWK!$AWK$ac_delim -SET_MAKE!$SET_MAKE$ac_delim -am__leading_dot!$am__leading_dot$ac_delim -AMTAR!$AMTAR$ac_delim -am__tar!$am__tar$ac_delim -am__untar!$am__untar$ac_delim -MAINTAINER_MODE_TRUE!$MAINTAINER_MODE_TRUE$ac_delim -MAINTAINER_MODE_FALSE!$MAINTAINER_MODE_FALSE$ac_delim -MAINT!$MAINT$ac_delim -PACKAGE_DATE!$PACKAGE_DATE$ac_delim -USE_UNICODE!$USE_UNICODE$ac_delim -PERL!$PERL$ac_delim -build!$build$ac_delim -build_cpu!$build_cpu$ac_delim -build_vendor!$build_vendor$ac_delim -build_os!$build_os$ac_delim -host!$host$ac_delim -host_cpu!$host_cpu$ac_delim -host_vendor!$host_vendor$ac_delim -host_os!$host_os$ac_delim -LIBOBJS!$LIBOBJS$ac_delim -LTLIBOBJS!$LTLIBOBJS$ac_delim -_ACEOF - - if test `sed -n "s/.*$ac_delim\$/X/p" conf$$subs.sed | grep -c X` = 74; then - break - elif $ac_last_try; then - { { echo "$as_me:$LINENO: error: could not make $CONFIG_STATUS" >&5 -echo "$as_me: error: could not make $CONFIG_STATUS" >&2;} - { (exit 1); exit 1; }; } - else - ac_delim="$ac_delim!$ac_delim _$ac_delim!! " - fi -done - -ac_eof=`sed -n '/^CEOF[0-9]*$/s/CEOF/0/p' conf$$subs.sed` -if test -n "$ac_eof"; then - ac_eof=`echo "$ac_eof" | sort -nru | sed 1q` - ac_eof=`expr $ac_eof + 1` -fi - -cat >>$CONFIG_STATUS <<_ACEOF -cat >"\$tmp/subs-1.sed" <<\CEOF$ac_eof -/@[a-zA-Z_][a-zA-Z_0-9]*@/!b end -/^[ ]*@INIT@[ ]*$/{ -r $INIT -d -} -/^[ ]*@MYSIMPLE@[ ]*$/{ -r $MYSIMPLE -d -} -/^[ ]*@T2H_I18N@[ ]*$/{ -r $T2H_I18N -d -} -/^[ ]*@T2H_L2H_FILE@[ ]*$/{ -r $T2H_L2H_FILE -d -} -/^[ ]*@T2H_TRANSLATIONS_FILE@[ ]*$/{ -r $T2H_TRANSLATIONS_FILE -d -} -_ACEOF -sed ' -s/[,\\&]/\\&/g; s/@/@|#_!!_#|/g -s/^/s,@/; s/!/@,|#_!!_#|/ -:n -t n -s/'"$ac_delim"'$/,g/; t -s/$/\\/; p -N; s/^.*\n//; s/[,\\&]/\\&/g; s/@/@|#_!!_#|/g; b n -' >>$CONFIG_STATUS <conf$$subs.sed -rm -f conf$$subs.sed -cat >>$CONFIG_STATUS <<_ACEOF -:end -s/|#_!!_#|//g -CEOF$ac_eof -_ACEOF - - -# VPATH may cause trouble with some makes, so we remove $(srcdir), -# ${srcdir} and @srcdir@ from VPATH if srcdir is ".", strip leading and -# trailing colons and then remove the whole line if VPATH becomes empty -# (actually we leave an empty line to preserve line numbers). -if test "x$srcdir" = x.; then - ac_vpsub='/^[ ]*VPATH[ ]*=/{ -s/:*\$(srcdir):*/:/ -s/:*\${srcdir}:*/:/ -s/:*@srcdir@:*/:/ -s/^\([^=]*=[ ]*\):*/\1/ -s/:*$// -s/^[^=]*=[ ]*$// -}' -fi - -cat >>$CONFIG_STATUS <<\_ACEOF -fi # test -n "$CONFIG_FILES" - - -for ac_tag in :F $CONFIG_FILES -do - case $ac_tag in - :[FHLC]) ac_mode=$ac_tag; continue;; - esac - case $ac_mode$ac_tag in - :[FHL]*:*);; - :L* | :C*:*) { { echo "$as_me:$LINENO: error: Invalid tag $ac_tag." >&5 -echo "$as_me: error: Invalid tag $ac_tag." >&2;} - { (exit 1); exit 1; }; };; - :[FH]-) ac_tag=-:-;; - :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; - esac - ac_save_IFS=$IFS - IFS=: - set x $ac_tag - IFS=$ac_save_IFS - shift - ac_file=$1 - shift - - case $ac_mode in - :L) ac_source=$1;; - :[FH]) - ac_file_inputs= - for ac_f - do - case $ac_f in - -) ac_f="$tmp/stdin";; - *) # Look for the file first in the build tree, then in the source tree - # (if the path is not absolute). The absolute path cannot be DOS-style, - # because $ac_f cannot contain `:'. - test -f "$ac_f" || - case $ac_f in - [\\/$]*) false;; - *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; - esac || - { { echo "$as_me:$LINENO: error: cannot find input file: $ac_f" >&5 -echo "$as_me: error: cannot find input file: $ac_f" >&2;} - { (exit 1); exit 1; }; };; - esac - ac_file_inputs="$ac_file_inputs $ac_f" - done - - # Let's still pretend it is `configure' which instantiates (i.e., don't - # use $as_me), people would be surprised to read: - # /* config.h. Generated by config.status. */ - configure_input="Generated from "`IFS=: - echo $* | sed 's|^[^:]*/||;s|:[^:]*/|, |g'`" by configure." - if test x"$ac_file" != x-; then - configure_input="$ac_file. $configure_input" - { echo "$as_me:$LINENO: creating $ac_file" >&5 -echo "$as_me: creating $ac_file" >&6;} - fi - - case $ac_tag in - *:-:* | *:-) cat >"$tmp/stdin";; - esac - ;; - esac - - ac_dir=`$as_dirname -- "$ac_file" || -$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$ac_file" : 'X\(//\)[^/]' \| \ - X"$ac_file" : 'X\(//\)$' \| \ - X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || -echo X"$ac_file" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - { as_dir="$ac_dir" - case $as_dir in #( - -*) as_dir=./$as_dir;; - esac - test -d "$as_dir" || { $as_mkdir_p && mkdir -p "$as_dir"; } || { - as_dirs= - while :; do - case $as_dir in #( - *\'*) as_qdir=`echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #( - *) as_qdir=$as_dir;; - esac - as_dirs="'$as_qdir' $as_dirs" - as_dir=`$as_dirname -- "$as_dir" || -$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_dir" : 'X\(//\)[^/]' \| \ - X"$as_dir" : 'X\(//\)$' \| \ - X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || -echo X"$as_dir" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - test -d "$as_dir" && break - done - test -z "$as_dirs" || eval "mkdir $as_dirs" - } || test -d "$as_dir" || { { echo "$as_me:$LINENO: error: cannot create directory $as_dir" >&5 -echo "$as_me: error: cannot create directory $as_dir" >&2;} - { (exit 1); exit 1; }; }; } - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`echo "$ac_dir" | sed 's,^\.[\\/],,'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`echo "$ac_dir_suffix" | sed 's,/[^\\/]*,/..,g;s,/,,'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - - case $ac_mode in - :F) - # - # CONFIG_FILE - # - - case $INSTALL in - [\\/$]* | ?:[\\/]* ) ac_INSTALL=$INSTALL ;; - *) ac_INSTALL=$ac_top_build_prefix$INSTALL ;; - esac -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF -# If the template does not know about datarootdir, expand it. -# FIXME: This hack should be removed a few years after 2.60. -ac_datarootdir_hack=; ac_datarootdir_seen= - -case `sed -n '/datarootdir/ { - p - q -} -/@datadir@/p -/@docdir@/p -/@infodir@/p -/@localedir@/p -/@mandir@/p -' $ac_file_inputs` in -*datarootdir*) ac_datarootdir_seen=yes;; -*@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) - { echo "$as_me:$LINENO: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 -echo "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF - ac_datarootdir_hack=' - s&@datadir@&$datadir&g - s&@docdir@&$docdir&g - s&@infodir@&$infodir&g - s&@localedir@&$localedir&g - s&@mandir@&$mandir&g - s&\\\${datarootdir}&$datarootdir&g' ;; -esac -_ACEOF - -# Neutralize VPATH when `$srcdir' = `.'. -# Shell code in configure.ac might set extrasub. -# FIXME: do we really want to maintain this feature? -cat >>$CONFIG_STATUS <<_ACEOF - sed "$ac_vpsub -$extrasub -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF -:t -/@[a-zA-Z_][a-zA-Z_0-9]*@/!b -s&@configure_input@&$configure_input&;t t -s&@top_builddir@&$ac_top_builddir_sub&;t t -s&@srcdir@&$ac_srcdir&;t t -s&@abs_srcdir@&$ac_abs_srcdir&;t t -s&@top_srcdir@&$ac_top_srcdir&;t t -s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t -s&@builddir@&$ac_builddir&;t t -s&@abs_builddir@&$ac_abs_builddir&;t t -s&@abs_top_builddir@&$ac_abs_top_builddir&;t t -s&@INSTALL@&$ac_INSTALL&;t t -$ac_datarootdir_hack -" $ac_file_inputs | sed -f "$tmp/subs-1.sed" >$tmp/out - -test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && - { ac_out=`sed -n '/\${datarootdir}/p' "$tmp/out"`; test -n "$ac_out"; } && - { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' "$tmp/out"`; test -z "$ac_out"; } && - { echo "$as_me:$LINENO: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&5 -echo "$as_me: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&2;} - - rm -f "$tmp/stdin" - case $ac_file in - -) cat "$tmp/out"; rm -f "$tmp/out";; - *) rm -f "$ac_file"; mv "$tmp/out" $ac_file;; - esac - ;; - - - - esac - - - case $ac_file$ac_mode in - "texi2html":F) chmod +x texi2html ;; - "check_texinfo.pl":F) chmod +x check_texinfo.pl ;; - - esac -done # for ac_tag - - -{ (exit 0); exit 0; } -_ACEOF -chmod +x $CONFIG_STATUS -ac_clean_files=$ac_clean_files_save - - -# configure is writing to config.log, and then calls config.status. -# config.status does its own redirection, appending to config.log. -# Unfortunately, on DOS this fails, as config.log is still kept open -# by configure, so config.status won't be able to write to it; its -# output is simply discarded. So we exec the FD to /dev/null, -# effectively closing config.log, so it can be properly (re)opened and -# appended to by config.status. When coming back to configure, we -# need to make the FD available again. -if test "$no_create" != yes; then - ac_cs_success=: - ac_config_status_args= - test "$silent" = yes && - ac_config_status_args="$ac_config_status_args --quiet" - exec 5>/dev/null - $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false - exec 5>>config.log - # Use ||, not &&, to avoid exiting from the if with $? = 1, which - # would make configure fail if this is the last instruction. - $ac_cs_success || { (exit 1); exit 1; } -fi - diff --git a/Build/source/utils/texi2html/configure.ac b/Build/source/utils/texi2html/configure.ac deleted file mode 100644 index 8e69486a6a9..00000000000 --- a/Build/source/utils/texi2html/configure.ac +++ /dev/null @@ -1,76 +0,0 @@ -dnl Process this file with autoconf to produce a configure script. -AC_PREREQ(2.53) -AC_INIT([texi2html], [1.76], [users@texi2html.cvshome.org]) -AM_INIT_AUTOMAKE([gnu 1.7 dist-bzip2]) - -dnl Disable Autoconf, Automake, and some other maintainer tools without the -dnl --enable-maintainer-mode argument. -AM_MAINTAINER_MODE - -dnl Misc variable settings -PACKAGE_DATE=`"$srcdir"/mdate-sh "$srcdir"/configure.ac` -AC_SUBST([PACKAGE_DATE]) -INIT=$srcdir/texi2html.init -AC_SUBST_FILE([INIT]) -MYSIMPLE=$srcdir/MySimple.pm -AC_SUBST_FILE([MYSIMPLE]) -T2H_I18N=$srcdir/T2h_i18n.pm -AC_SUBST_FILE([T2H_I18N]) -T2H_L2H_FILE=$srcdir/l2h.init -AC_SUBST_FILE([T2H_L2H_FILE]) -T2H_TRANSLATIONS_FILE=$srcdir/translations.pl -AC_SUBST_FILE([T2H_TRANSLATIONS_FILE]) -AC_ARG_WITH([encode], - AC_HELP_STRING([--with-encode], - [use encode (default: detected)]), - [if test $withval = 'no'; then - USE_UNICODE=0 - else - USE_UNICODE=1 - fi], - [ - if perl -e "use Encode; use Unicode::Normalize;" > /dev/null 2>&1; - then USE_UNICODE=1 - else - USE_UNICODE=0 - fi - ]) -AC_SUBST([USE_UNICODE]) - -dnl Checks for programs. -AC_ARG_VAR([PERL], [The path to the `perl' executable.]) -AC_PATH_PROG([PERL], [perl], [/usr/bin/env perl], [/opt/perl5/bin:"$PATH"]) - -AC_PROG_INSTALL - -dnl Checks for libraries. - -dnl Checks for header files. - -dnl Checks for typedefs, structures, and compiler characteristics. - -dnl Checks for library functions. - -# For teTeX and TeX Live. -AC_CANONICAL_HOST -AC_ARG_ENABLE([multiplatform], - [AS_HELP_STRING([--enable-multiplatform], - [put executables into bin/PLATFORM and libraries into lib/PLATFORM])])dnl -# if enable_multiplatform is set in the environment, use that. -if test "x$enable_multiplatform" = xyes; then - test "x$bindir" = 'x${exec_prefix}/bin' && bindir="$bindir/$host" - test "x$libdir" = 'x${exec_prefix}/lib' && libdir="$libdir/$host" -fi - -AC_CONFIG_FILES([texi2html:texi2html.pl], [chmod +x texi2html]) -AC_CONFIG_FILES([check_texinfo.pl], [chmod +x check_texinfo.pl]) - -dnl The bulk config files. -AC_CONFIG_FILES([\ - Makefile \ - Tests/Makefile \ - doc/Makefile \ - texi2html.1 \ - texi2html.spec \ - ]) -AC_OUTPUT diff --git a/Build/source/utils/texi2html/doc/Makefile.am b/Build/source/utils/texi2html/doc/Makefile.am deleted file mode 100644 index 817fef7bc7a..00000000000 --- a/Build/source/utils/texi2html/doc/Makefile.am +++ /dev/null @@ -1,41 +0,0 @@ -# -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 deleted file mode 100644 index b73c082eeb1..00000000000 --- a/Build/source/utils/texi2html/doc/Makefile.in +++ /dev/null @@ -1,522 +0,0 @@ -# Makefile.in generated by automake 1.9.6 from Makefile.am. -# @configure_input@ - -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005 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@ -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@ -datarootdir = @datarootdir@ -docdir = @docdir@ -dvidir = @dvidir@ -exec_prefix = @exec_prefix@ -host = @host@ -host_alias = @host_alias@ -host_cpu = @host_cpu@ -host_os = @host_os@ -host_vendor = @host_vendor@ -htmldir = @htmldir@ -includedir = @includedir@ -infodir = @infodir@ -install_sh = @install_sh@ -libdir = @libdir@ -libexecdir = @libexecdir@ -localedir = @localedir@ -localstatedir = @localstatedir@ -mandir = @mandir@ -mkdir_p = @mkdir_p@ -oldincludedir = @oldincludedir@ -pdfdir = @pdfdir@ -prefix = @prefix@ -program_transform_name = @program_transform_name@ -psdir = @psdir@ -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 && \ - if ($(MAKEINFO) --version) >/dev/null 2>&1; then \ - 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; \ - else :; fi && \ - 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: - TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ - $(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 " cd '$(DESTDIR)$(infodir)' && 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 \ - texi2html.html - -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 deleted file mode 100644 index 9cad5c458b1..00000000000 --- a/Build/source/utils/texi2html/doc/TODO +++ /dev/null @@ -1,5 +0,0 @@ -- 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 deleted file mode 100755 index 37171f21fbd..00000000000 --- a/Build/source/utils/texi2html/doc/mdate-sh +++ /dev/null @@ -1,92 +0,0 @@ -#!/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 deleted file mode 100644 index bb25b39fd3a..00000000000 --- a/Build/source/utils/texi2html/doc/stamp-vti +++ /dev/null @@ -1,4 +0,0 @@ -@set UPDATED 17 January 2006 -@set UPDATED-MONTH January 2006 -@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 deleted file mode 100644 index d55c003b90f..00000000000 --- a/Build/source/utils/texi2html/doc/texi2html.html +++ /dev/null @@ -1,6072 +0,0 @@ -<!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 deleted file mode 100644 index 300390d9a26..00000000000 --- a/Build/source/utils/texi2html/doc/texi2html.info +++ /dev/null @@ -1,3638 +0,0 @@ -This is ../../../../TeXlive-svn/utils/texi2html/doc/texi2html.info, -produced by makeinfo version 4.11 from -../../../../TeXlive-svn/utils/texi2html/doc/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 17 January 2006, 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 17 January 2006, 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 - -1 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 - -1.1 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 - -2 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 - -3 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 - -4 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 - -4.1 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 - -4.2 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 - -4.3 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 - -4.4 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 - -4.5 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 - -4.6 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 - -4.7 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 - -4.8 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 - -5 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 - -5.1 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 - -5.2 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 - -6 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 - -6.1 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 - -6.2 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 - -6.3 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 - -6.3.1 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 - -6.3.2 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 - -6.3.3 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 - -6.4 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 - -6.4.1 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 - -6.4.2 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 - -6.4.3 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 - -6.5 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 - -6.6 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 - -6.7 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::. - - -File: texi2html.info, Node: Customizing header, Next: Customizing section, Prev: css, Up: Changing the page layout - -6.8 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 - -6.9 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 - -6.10 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 - -6.11 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 - -6.11.1 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 - -6.11.1.1 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 - -6.11.1.2 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 - -6.11.1.3 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 - -6.11.1.4 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 - -6.11.2 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 - -6.12 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 - -6.13 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 - -7 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 - -7.1 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 - -7.2 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 - -7.3 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 - -7.3.1 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 - -7.3.2 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 - -7.3.3 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 - -7.4 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 - -7.5 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 - -7.6 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 - -7.7 References -============== - -* Menu: - -* Reference to external manual:: -* Internal reference:: - - -File: texi2html.info, Node: Reference to external manual, Next: Internal reference, Up: References - -7.7.1 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 - -7.7.2 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 - -7.8 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 - -7.9 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 - -7.9.1 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 - -7.9.2 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 - -7.10 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 - -7.11 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 - -7.11.1 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'. - - -File: texi2html.info, Node: Whole table list, Prev: Table and list items, Up: Lists tables - -7.11.2 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 - -7.12 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 - -7.12.1 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 - -7.12.2 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 - -7.13 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 - -7.14 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 - -7.15 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 - -7.15.1 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 - -7.15.2 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 - -7.16 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 - -7.16.1 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 - -7.16.2 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 - -7.17 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 - -7.17.1 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 - -7.17.2 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 - -7.18 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 - -7.19 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 - -Appendix A 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 - -A.1 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 - -A.2 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 - -Appendix B Command Line Option Index -************************************ - - -* Menu: - -* css-include=FILE: Style options. (line 24) -* def-table: Style options. (line 39) -* doctype=DTD: Style options. (line 8) -* DVAR: Texinfo related options. - (line 14) -* frames: Page layout options. (line 6) -* frameset-doctype: Style options. (line 10) -* frameset-doctype=DTD: Style options. (line 9) -* html-xref-prefix=PATH: Style options. (line 35) -* IDIR: Texinfo related options. - (line 25) -* if<region>: Expansion. (line 10) -* include-css: css. (line 22) -* init-file: Using init files. (line 13) -* iso: Style options. (line 19) -* l2h: Expanding TeX regions. - (line 8) -* l2h-file: Expanding TeX regions. - (line 21) -* l2h-l2h=PROGRAM: Expanding TeX regions. - (line 13) -* l2h-tmp: Expanding TeX regions. - (line 17) -* lang <1>: Strings. (line 9) -* lang: Using init files. (line 22) -* lang=LANG: Texinfo related options. - (line 9) -* menu: Invoking texi2html. (line 18) -* no-if<region>: Expansion. (line 12) -* node-files: Output files. (line 61) -* nomenu <1>: Expansion. (line 17) -* nomenu: Invoking texi2html. (line 18) -* nosec-nav: Page layout options. (line 11) -* number: Style options. (line 48) -* output: Output files. (line 35) -* PDIR: Texinfo related options. - (line 20) -* pkgdatadir=dir: Using init files. (line 8) -* pkgdatadir=DIR: Installation. (line 46) -* prefix: Output files. (line 39) -* separated-footnotes: Page layout options. (line 15) -* short-ext: Output files. (line 40) -* short-ref: Style options. (line 44) -* split: Splitting output. (line 8) -* sysconfdir=dir: Using init files. (line 10) -* toc-file: Output files. (line 43) -* toc-links: Style options. (line 52) -* top-file: Output files. (line 41) -* use-nodes: Splitting output. (line 38) -* UVAR: Texinfo related options. - (line 17) - - -File: texi2html.info, Node: Indexvr, Next: Indexcp, Prev: Indexop, Up: Top - -Appendix C Variable Index -************************* - - -* Menu: - -* $AFTER_BODY_OPEN: Customizing header. (line 8) -* $AFTER_OVERVIEW: Contents and Overview text. - (line 21) -* $AFTER_TOC_LINES: Contents and Overview text. - (line 28) -* $anchor <1>: Anchors images and spaces. - (line 10) -* $anchor: Redefining functions. (line 15) -* $AVOID_MENU_REDUNDANCY: Menu formatting. (line 8) -* $BEFORE_OVERVIEW: Contents and Overview text. - (line 17) -* $BEFORE_TOC_LINES: Contents and Overview text. - (line 25) -* $BIG_RULE: The page layout. (line 12) -* $BODYTEXT <1>: Customizing header. (line 22) -* $BODYTEXT: Output initialization. - (line 20) -* $cell: Table and list items. (line 81) -* $CLOSE_QUOTE_SYMBOL <1>: String interface. (line 8) -* $CLOSE_QUOTE_SYMBOL: Hash reference interface. - (line 65) -* $complex_format_map: Complex formats. (line 12) -* $CSS_LINES: css. (line 10) -* $DEF_TABLE: Style options. (line 41) -* $DEFAULT_RULE: The page layout. (line 11) -* $definition_category: Definition formatting. - (line 20) -* $DO_CONTENTS: Contents and Overview text. - (line 9) -* $DO_SCONTENTS: Contents and Overview text. - (line 13) -* $DOCTYPE: Style options. (line 12) -* $DOCUMENT_DESCRIPTION: Customizing header. (line 16) -* $DOCUMENT_ENCODING: Customizing header. (line 11) -* $ENCODING: Customizing header. (line 14) -* $EXTENSION: File names. (line 8) -* $EXTERNAL_DIR: Style options. (line 37) -* $EXTRA_HEAD: Customizing header. (line 7) -* $FRAMES: Page layout options. (line 9) -* $FRAMESET_DOCTYPE: Style options. (line 12) -* $ICONS: General purpose variables. - (line 13) -* $IDX_SUMMARY: External index files. (line 9) -* $INDEX_CHAPTER: The page layout. (line 66) -* $L2H_L2H: Expanding TeX regions. - (line 14) -* $L2H_TMP: Expanding TeX regions. - (line 18) -* $LANG <1>: Strings. (line 9) -* $LANG <2>: Using init files. (line 22) -* $LANG: Texinfo related options. - (line 11) -* $LANGUAGES <1>: Translating strings. (line 6) -* $LANGUAGES: Strings. (line 13) -* $MENU_PRE_STYLE: Menu formatting. (line 19) -* $MENU_SYMBOL: Menu formatting. (line 13) -* $MIDDLE_RULE: The page layout. (line 11) -* $NODE_FILES <1>: File names. (line 9) -* $NODE_FILES: Output files. (line 62) -* $NODE_NAME_IN_MENU: Menu formatting. (line 7) -* $NUMBER_SECTIONS: Style options. (line 49) -* $OPEN_QUOTE_SYMBOL <1>: String interface. (line 8) -* $OPEN_QUOTE_SYMBOL: Hash reference interface. - (line 65) -* $OUT: Output files. (line 35) -* $PRE_BODY_CLOSE: Customizing footer. (line 7) -* $PREFIX: Output files. (line 39) -* $print_chapter_footer: Customizing footer. (line 20) -* $print_chapter_header: Customizing header. (line 38) -* $print_foot_navigation: Customizing footer. (line 9) -* $print_head_navigation: Customizing header. (line 26) -* $print_misc: Special pages layout. (line 33) -* $print_misc_footer: Special pages layout. (line 34) -* $print_misc_header: Special pages layout. (line 33) -* $print_page_foot: Customizing footer. (line 23) -* $print_page_head: Customizing header. (line 37) -* $print_section_footer: Customizing footer. (line 21) -* $print_section_header: Customizing header. (line 40) -* $print_Top: Special pages layout. (line 31) -* $print_Top_footer: Special pages layout. (line 32) -* $print_Top_header: Special pages layout. (line 31) -* $SECTION_NAVIGATION <1>: General purpose variables. - (line 16) -* $SECTION_NAVIGATION: Page layout options. (line 12) -* $SEPARATED_FOOTNOTES: Page layout options. (line 15) -* $SHORT_REF: Style options. (line 46) -* $SHORTEXTN: Output files. (line 41) -* $SHOW_MENU: Expansion. (line 18) -* $SMALL_RULE: The page layout. (line 11) -* $SPLIT: Splitting output. (line 9) -* $SPLIT_INDEX: Index list. (line 15) -* $T2H_OBSOLETE_STRINGS: Translating strings. (line 6) -* $Texi2HTML::NODE{Next}: Button specifications. - (line 59) -* $Texi2HTML::OVERVIEW <1>: Contents and Overview text. - (line 77) -* $Texi2HTML::OVERVIEW: Global informations. (line 89) -* $Texi2HTML::THIS_HEADER: Global informations. (line 85) -* $Texi2HTML::THIS_SECTION <1>: Global functions. (line 12) -* $Texi2HTML::THIS_SECTION: Global informations. (line 82) -* $Texi2HTML::TOC_LINES <1>: Contents and Overview text. - (line 77) -* $Texi2HTML::TOC_LINES: Global informations. (line 92) -* $TOC_FILE: Output files. (line 44) -* $TOC_LINKS: Style options. (line 54) -* $TOC_LIST_ATTRIBUTE: Contents and Overview text. - (line 35) -* $TOC_LIST_STYLE: Contents and Overview text. - (line 31) -* $TOP_FILE: Output files. (line 42) -* $TOP_HEADING: The page layout. (line 47) -* $UNNUMBERED_SYMBOL_IN_MENU: Menu formatting. (line 14) -* $USE_ISO: Style options. (line 21) -* $USE_NODES: Splitting output. (line 39) -* $VERTICAL_HEAD_NAVIGATION: General purpose variables. - (line 9) -* $WORDS_IN_PAGE <1>: Global functions. (line 14) -* $WORDS_IN_PAGE: Button specifications. - (line 21) -* %accent_map: Style and accent commands. - (line 26) -* %ACTIVE_ICONS: Button specifications. - (line 71) -* %BUTTONS_GOTO: Output initialization. - (line 21) -* %css_map: css. (line 7) -* %def_map: Definition line. (line 6) -* %format_in_paragraph: Avoiding paragraphs. (line 8) -* %format_map: Whole table list. (line 6) -* %main::value: Global informations. (line 67) -* %misc_command: Other and unknown commands. - (line 20) -* %NAVIGATION_TEXT <1>: Output initialization. - (line 21) -* %NAVIGATION_TEXT: Button specifications. - (line 64) -* %paragraph_style: Alignement commands. (line 8) -* %PASSIVE_ICONS: Button specifications. - (line 72) -* %pre_map: Commands without argument. - (line 23) -* %simple_map <1>: Other and unknown commands. - (line 65) -* %simple_map: Commands without argument. - (line 22) -* %simple_map_pre <1>: Other and unknown commands. - (line 65) -* %simple_map_pre: Commands without argument. - (line 22) -* %simple_map_texi <1>: Other and unknown commands. - (line 65) -* %simple_map_texi: Commands without argument. - (line 22) -* %special_list_commands: Table and list items. (line 12) -* %style_map <1>: Other and unknown commands. - (line 79) -* %style_map: Style and accent commands. - (line 10) -* %style_map_pre <1>: Other and unknown commands. - (line 79) -* %style_map_pre: Style and accent commands. - (line 11) -* %style_map_texi <1>: Other and unknown commands. - (line 80) -* %style_map_texi: Style and accent commands. - (line 11) -* %Texi2HTML::HREF: Elements hashes. (line 12) -* %Texi2HTML::NAME: Elements hashes. (line 9) -* %Texi2HTML::NO_TEXI: Elements hashes. (line 18) -* %Texi2HTML::NODE: Elements hashes. (line 15) -* %Texi2HTML::THISDOC: Global informations. (line 12) -* %texi_map: Commands without argument. - (line 23) -* %things_map: Commands without argument. - (line 23) -* @CHAPTER_BUTTONS: Button specifications. - (line 27) -* @CSS_FILES: Style options. (line 27) -* @EXPAND: Expansion. (line 13) -* @INCLUDE_DIRS: Texinfo related options. - (line 27) -* @MISC_BUTTONS: Button specifications. - (line 32) -* @NODE_FOOTER_BUTTONS: Button specifications. - (line 17) -* @PREPEND_DIRS: Texinfo related options. - (line 22) -* @SECTION_BUTTONS: Button specifications. - (line 10) -* @SECTION_FOOTER_BUTTONS: Button specifications. - (line 16) - - -File: texi2html.info, Node: Indexcp, Prev: Indexvr, Up: Top - -Appendix D Concept Index -************************ - - -* Menu: - -* Avoid paragraph opening: Avoiding paragraphs. (line 6) -* bug report: Top. (line 6) -* centering: Alignement commands. (line 6) -* complex format: Complex formats. (line 6) -* Config: Using init files. (line 6) -* configure: Installation. (line 6) -* downloading texi2html source: Obtaining texi2html. (line 6) -* examples of manuals: Overview. (line 6) -* external manual: Reference to external manual. - (line 6) -* flushing text: Alignement commands. (line 6) -* i18n <1>: Translating strings. (line 6) -* i18n: Strings. (line 6) -* Installation: Installation. (line 6) -* internationalization: Using init files. (line 6) -* internationalized strings: Adding new strings. (line 6) -* makeinfo: whytexi2html. (line 6) -* manage_i18n.pl: Adding new strings. (line 6) -* paragraph: Paragraph and preformatted formatting. - (line 6) -* preformatted region: Paragraph and preformatted formatting. - (line 6) -* reference: References. (line 6) -* skipped command: Other and unknown commands. - (line 6) -* source code for texi2html, downloading: Obtaining texi2html. (line 6) -* texi2html source, downloading: Obtaining texi2html. (line 6) -* Texinfo: Overview. (line 6) -* text alignement: Alignement commands. (line 6) -* Translation: Translating strings. (line 6) -* unknown command: Other and unknown commands. - (line 6) - - - -Tag Table: -Node: Top3068 -Node: Overview5696 -Node: whytexi2html7486 -Node: Obtaining texi2html9569 -Node: Installation9852 -Node: Invoking texi2html12042 -Node: Splitting output13222 -Node: Output files16556 -Node: Expansion19818 -Node: Texinfo related options20727 -Node: Page layout options21794 -Node: Style options22691 -Node: Expanding TeX regions25011 -Node: Using init files26157 -Node: Initialization files28046 -Node: Redefining functions29993 -Node: Function prototypes31059 -Node: Changing the page layout32135 -Node: The different pages33493 -Node: The page layout35211 -Ref: Element labels36495 -Node: Navigation panel38224 -Node: General purpose variables38887 -Node: Button specifications39664 -Node: Panel formatting function43000 -Node: Program variables43799 -Node: Elements hashes44509 -Node: Global informations45028 -Node: Global functions47548 -Node: Output initialization48293 -Node: Output finalization49756 -Node: css50233 -Node: Customizing header51305 -Node: Customizing section54118 -Node: Customizing footer55122 -Node: Special pages57002 -Node: Special pages content57336 -Node: Top element text57640 -Node: Contents and Overview text58929 -Node: Footnotes text61678 -Node: About text61986 -Node: Special pages layout63506 -Node: File names64707 -Node: External index files66588 -Node: Customizing HTML68718 -Node: Three contexts70440 -Node: Commands without argument71214 -Node: Style and accent commands72636 -Node: Hash reference interface74129 -Ref: Reference hash args75005 -Node: String interface77375 -Node: Define your own interface79360 -Node: Anchors images and spaces81080 -Node: Text83954 -Node: Strings85290 -Node: References86880 -Node: Reference to external manual87087 -Node: Internal reference89091 -Node: Alignement commands90027 -Node: Paragraph and preformatted region90991 -Node: Paragraph and preformatted formatting91327 -Node: Avoiding paragraphs95064 -Node: Complex formats95469 -Node: Lists tables97166 -Node: Table and list items97638 -Node: Whole table list101583 -Node: Definitions103137 -Node: Definition line103619 -Node: Definition formatting105072 -Node: Headings106524 -Node: Special regions107491 -Node: Menus109529 -Node: Menu parts109981 -Node: Menu formatting111410 -Node: Indices114317 -Node: Index entry place114994 -Node: Index list115617 -Node: Floats and lists of floats118722 -Node: Floats120207 -Node: Lists of floats121523 -Node: Footnotes123752 -Node: Other and unknown commands126267 -Node: Internationalization130216 -Node: Translating strings130646 -Node: Adding new strings132304 -Node: Indexop133181 -Node: Indexvr137025 -Node: Indexcp150810 - -End Tag Table diff --git a/Build/source/utils/texi2html/doc/texi2html.texi b/Build/source/utils/texi2html/doc/texi2html.texi deleted file mode 100644 index b4e2662badb..00000000000 --- a/Build/source/utils/texi2html/doc/texi2html.texi +++ /dev/null @@ -1,3426 +0,0 @@ -\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 deleted file mode 100644 index b88e12dec42..00000000000 --- a/Build/source/utils/texi2html/doc/texinfo.tex +++ /dev/null @@ -1,6882 +0,0 @@ -% 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 deleted file mode 100644 index bb25b39fd3a..00000000000 --- a/Build/source/utils/texi2html/doc/version.texi +++ /dev/null @@ -1,4 +0,0 @@ -@set UPDATED 17 January 2006 -@set UPDATED-MONTH January 2006 -@set EDITION 1.76 -@set VERSION 1.76 diff --git a/Build/source/utils/texi2html/examples/book.init b/Build/source/utils/texi2html/examples/book.init deleted file mode 100644 index a4147a38305..00000000000 --- a/Build/source/utils/texi2html/examples/book.init +++ /dev/null @@ -1,197 +0,0 @@ -# This is based on the scriptbasic style - -$DO_CONTENTS = 1; - -@SECTION_BUTTONS = - ( - 'Back', 'Forward', ' ', 'Contents', 'Index', 'About' - ); - -@CHAPTER_BUTTONS = - ( - 'Back', 'Forward', ' ', 'Contents', 'Index', 'About' - ); - -@MISC_BUTTONS = ('Contents', 'Index', 'About'); - -@SECTION_FOOTER_BUTTONS = ('Contents', 'Index', 'About'); - -@NODE_FOOTER_BUTTONS = ('Back', 'Forward'); - -$WORDS_IN_PAGE = undef; -$SHOW_MENU = 0; - -$BIG_RULE = '<hr size="2">'; - -sub print_sub_toc($$); - -sub print_sub_toc($$) -{ - my $parent_element = shift; - my $element = shift; - my $result = &$anchor('', main::href($element, $parent_element->{'file'}), $element->{'text'}) . " <br>\n"; -#print STDERR "SUB_TOC $element->{'text'}\n"; #sleep 1; - if (exists($element->{'child'})) - { -#print STDERR "SUB_TOC child $element->{'child'}->{'text'}\n"; - $result .= "<ul>\n". print_sub_toc($parent_element, $element->{'child'}) ."</ul>\n"; - } - if (exists($element->{'next'})) - { -#print STDERR "SUB_TOC next($element->{'text'}) $element->{'next'}->{'text'}\n"; - $result .= print_sub_toc($parent_element, $element->{'next'}); - } - return $result; -} - -sub print_up_toc($$) -{ - my $fh = shift; - my $element = shift; - my $current_element = $element; - my @elements; - while (defined($current_element->{'up'}) and ($current_element->{'up'} ne $current_element)) - { - unshift (@elements, $current_element->{'up'}); - $current_element = $current_element->{'up'}; - } - #print $fh "<ul>" . &$anchor('', $Texi2HTML::HREF{Contents}, '[' . $Texi2HTML::NAME{Contents} . ']') . " <br>\n"; - foreach my $elem (@elements) - { - print $fh "<ul>" . &$anchor('', main::href($elem, $element->{'file'}), $elem->{'text'}) . " <br>\n"; - } - foreach my $elem (@elements) - { - print $fh "</ul>\n"; - } - print $fh "</ul>\n"; -} - -$print_section = \&book_print_section; -$print_Top = \&book_print_Top; -$print_Toc = \&book_print_Toc; -$element_file_name = \&book_element_file_name; - -sub book_print_section($$$) -{ - my $fh = shift; - my $first_in_page = shift; - my $previous_is_top = shift; - my $buttons = \@SECTION_BUTTONS; - - if ($first_in_page and $SECTION_NAVIGATION) - { - #print_up_toc($fh, $Texi2HTML::THIS_ELEMENT) if ($SPLIT eq 'node'); - print_up_toc($fh, $Texi2HTML::THIS_ELEMENT); - &$print_head_navigation($fh, $buttons); - } - else - { # got to do this here, as it isn't done in print_head_navigation - main::print_lines($fh, $Texi2HTML::THIS_HEADER); - &$print_navigation($fh, $buttons) if ($SECTION_NAVIGATION); - } - my $nw = main::print_lines($fh); - if (defined $SPLIT - and (($SPLIT eq 'node') && $SECTION_NAVIGATION)) - { - &$print_foot_navigation($fh); - print $fh "$SMALL_RULE\n"; - &$print_navigation($fh, \@NODE_FOOTER_BUTTONS) if (!defined($WORDS_IN_PAGE) or (defined ($nw) - and $nw >= $WORDS_IN_PAGE)); - } -} - -sub book_print_Top($$) -{ - my $fh = shift; - my $has_top_heading = shift; - - my $buttons = \@MISC_BUTTONS; - &$print_head_navigation($fh, $buttons); - print $fh $Texi2HTML::TITLEPAGE; - print $fh "<h1 class=\"settitle\">$Texi2HTML::NAME{Top}</h1>\n" - unless ($has_top_heading); - main::print_lines($fh, $Texi2HTML::THIS_SECTION); - print $fh '<h2> ' . $Texi2HTML::NAME{'Contents'} . "</h2>\n" ; - main::print_lines($fh, $Texi2HTML::TOC_LINES); -} - -sub book_print_Toc -{ - my $fh = shift; - &$print_page_head($fh) if $SPLIT; - #print $fh $Texi2HTML::TITLEPAGE; - print $fh '<h2> ' . $Texi2HTML::NAME{'Contents'} . "</h2>\n" ; - main::print_lines($fh); - &$print_misc_footer($fh, \@MISC_BUTTONS); -} - -my $unumbered_nr = -1; -my $previous_nr; -my $previous_file_name; - -sub book_element_file_name($$$) -{ - my $element = shift; - my $is_top = shift; - my $prefix = shift; - - if (defined($previous_nr) and ($element->{'doc_nr'} == $previous_nr)) - { - return $previous_file_name; - } - if ($is_top) - { - $previous_file_name = "${prefix}_top.html"; - } - elsif (defined($element->{'number'}) and ($element->{'number'} ne '')) - { - my $number = $element->{'number'}; - $number .= '.' unless ($number =~ /\.$/); - $previous_file_name = "${prefix}_$number" . 'html'; - } - else - { - $unumbered_nr++; - $previous_file_name = "${prefix}_U." . $unumbered_nr . '.html'; - } - $previous_nr = $element->{'doc_nr'}; - return $previous_file_name; -} - -$heading = \&book_heading; - -sub book_heading($) -{ - my $element = shift; - my $level = 3; - if (!$element->{'node'}) - { - $level = $element->{'level'}; - } - $level = 1 if ($level == 0); - my $text = $element->{'text'}; - if (!$element->{'node'} and (!$NUMBER_SECTIONS)) - { - $text = $element->{'name'}; - } - return '' if ($text !~ /\S/); - my $class = $element->{'tag_level'}; - $class = 'unnumbered' if ($class eq 'top'); - if (defined($element->{'tocid'}) and $TOC_LINKS) - { - $text = &$anchor ('', "$Texi2HTML::THISDOC{'toc_file'}#$element->{'tocid'}", $text); - } - $text = "<h$level class=\"$class\"> $text </h$level>\n"; - #if (defined($SPLIT) and ($SPLIT eq 'node') - if (exists($element->{'child'}) - and ($element->{'tag_level'} !~ /heading/)) - { - $text .= "<ul>\n"; - $text .= "" . print_sub_toc($element, $element->{'child'}); - $text .= "</ul>\n"; - } - return $text; -} - -1; diff --git a/Build/source/utils/texi2html/examples/chm.init b/Build/source/utils/texi2html/examples/chm.init deleted file mode 100644 index a809ec87704..00000000000 --- a/Build/source/utils/texi2html/examples/chm.init +++ /dev/null @@ -1,366 +0,0 @@ -# -*-perl-*- - -main::load_init_file('', 'noheaders.init'); - -$SHOW_MENU = 0; -$SPLIT = 'node'; -$DO_CONTENT = 1; -$SPLIT_INDEX = undef; -$IDX_SUMMARY = 1; - -$SMALL_RULE = ''; -$DEFAULT_RULE = ''; -$MIDDLE_RULE = ''; -$BIG_RULE = ''; - -$DOCUMENT_DESCRIPTION = ''; -$SEPARATED_FOOTNOTES = 0; - -$index_summary_file_entry = \&chm_index_summary_file_entry; -$index_summary_file_begin = \&chm_index_summary_file_begin; -$index_summary_file_end = \&chm_index_summary_file_end; - -$print_page_foot = \&chm_print_page_foot; - -my $default_toc_body = $toc_body; -$toc_body = \&chm_toc_body; - -$finish_out = \&chm_finish_out; -my $default_init_out = $init_out; - -$init_out = \&chm_init_out; - -my %chm_languages = ( - 'en' => '0x409 English (United States)', - 'sq' => '0x041c Albanian', -# 'ar' => '0x1401 Arabic (ALGERIA)', -# 'es' => '0x2c0a Spanish (ARGENTINA)', -# 'en' => '0x0c09 English (AUSTRALIA)', -# 'de' => '0x0c07 German (AUSTRIA)', -# 'ar' => '0x3c01 Arabic (BAHRAIN)', - 'be' => '0x0423 Byelorussian', -# 'fr' => '0x080c French (BELGIUM)', -# 'en' => '0x2809 English (BELIZE)', -# 'es' => '0x400a Spanish (BOLIVIA)', -# 'pt' => '0x0416 Portuguese (BRAZIL)', -# 'ms' => '0x083e Malay (BRUNEI DARUSSALAM)', - 'bg' => '0x0402 Bulgarian', -# 'fr' => '0x0c0c French (CANADA)', -# 'es' => '0x340a Spanish (CHILE)', - 'zh' => '0x0804 Chinese (CHINA)', -# 'es' => '0x240a Spanish (COLOMBIA)', -# 'es' => '0x140a Spanish (COSTA RICA)', - 'hr' => '0x041a Croatian', - 'cs' => '0x0405 Czech', - 'da' => '0x0406 Danish', -# 'es' => '0x1c0a Spanish (DOMINICAN REPUBLIC)', -# 'es' => '0x300a Spanish (ECUADOR)', -# 'ar' => '0x0c01 Arabic (EGYPT)', -# 'es' => '0x440a Spanish (EL SALVADOR)', - 'et' => '0x0425 Estonian', - 'fo' => '0x0438 Faeroese', - 'fi' => '0x040b Finnish', - 'fr' => '0x040c French (FRANCE)', - 'de' => '0x0407 German (GERMANY)', - 'el' => '0x0408 Greek', -# 'es' => '0x100a Spanish (GUATEMALA)', -# 'es' => '0x480a Spanish (HONDURAS)', -# 'zh' => '0x0c04 Chinese (HONG KONG)', - 'hu' => '0x040e Hungarian', - 'is' => '0x040f Icelandic', - 'hi' => '0x0439 Hindi', - 'in' => '0x04', - 'fa' => '0x0429 Farsi', -# 'ar' => '0x0801 Arabic (IRAQ)', -# 'en' => '0x1809 English (IRELAND)', - 'iw' => '0x04', - 'it' => '0x0410 Italian', -# 'en' => '0x2009 English (JAMAICA)', - 'ja' => '0x0411 Japanese', -# 'ar' => '0x2c01 Arabic (JORDAN)', - 'sw' => '0x0441 Swahili', - 'ko' => '0x0412 Korean', -# 'ar' => '0x3401 Arabic (KUWAIT)', - 'al' => '0x0426 Latvian (Lettish)', -# 'ar' => '0x3001 Arabic (LEBANON)', -# 'ar' => '0x1001 Arabic (LIBYAN ARAB JAMAHIRIYA)', -# 'de' => '0x1407 German (LIECHTENSTEIN)', - 'lt' => '0x0427 Lithuanian', -# 'de' => '0x1007 German (LUXEMBOURG)', -# 'zh' => '0x1404 Chinese (MACAU)', - 'mk' => '0x042f Macedonian', -# 'ms' => '0x043e Malay (MALAYSIA)', -# 'es' => '0x080a Spanish (MEXICO)', -# 'fr' => '0x180c French (MONACO)', -# 'ar' => '0x1801 Arabic (MOROCCO)', - 'nl' => '0x0413 Dutch', -# 'en' => '0x1409 English (NEW ZEALAND)', -# 'es' => '0x4c0a Spanish (NICARAGUA)', - 'no' => '0x0414 Norwegian', -# 'ar' => '0x2001 Arabic (OMAN)', - 'ur' => '0x0420 Urdu', -# 'es' => '0x180a Spanish (PANAMA)', -# 'es' => '0x3c0a Spanish (PARAGUAY)', -# 'es' => '0x280a Spanish (PERU)', -# 'en' => '0x3409 English (PHILIPPINES)', - 'pl' => '0x0415 Polish', - 'pt' => '0x0816 Portuguese (PORTUGAL)', -# 'es' => '0x500a Spanish (PUERTO RICO)', -# 'ar' => '0x4001 Arabic (QATAR)', - 'ro' => '0x0418 Romanian', - 'ru' => '0x0419 Russian', - 'ar' => '0x0401 Arabic (SAUDI ARABIA)', -# 'zh' => '0x1004 Chinese (SINGAPORE)', - 'sk' => '0x041b Slovak', - 'sl' => '0x0424 Slovenian', - 'af' => '0x0436 Afrikaans', - 'ca' => '0x0403 Catalan', - 'sv' => '0x041d Swedish', -# 'de' => '0x0807 German (SWITZERLAND)', -# 'ar' => '0x2801 Arabic (SYRIAN ARAB REPUBLIC)', -# 'zh' => '0x0404 Chinese (TAIWAN, PROVINCE OF CHINA)', - 'th' => '0x041e Thai', -# 'en' => '0x2c09 English (TRINIDAD AND TOBAGO)', -# 'ar' => '0x1c01 Arabic (TUNISIA)', - 'tr' => '0x041f Turkish', - 'uk' => '0x0422 Ukrainian', -# 'ar' => '0x3801 Arabic (UNITED ARAB EMIRATES)', -# 'en' => '0x0809 English (UNITED KINGDOM)', -# 'en' => '0x0409 English (UNITED STATES)', -# 'es' => '0x380a Spanish (URUGUAY)', -# 'es' => '0x200a Spanish (VENEZUELA)', - 'vi' => '0x242a Vietnamese', -# 'ar' => '0x2401 Arabic (YEMEN)', -# 'en' => '0x3009 English (ZIMBABWE)', - #'' => '', -); - -my %hhk_global_property = ( - 'ImageType' => 'Folder', -); - -my %hhc_global_property = ( - 'ImageType' => 'Folder', -); - -# We prepare a environment for conversion of texi to unicode (maybe this -# could be in utf8.init ?) -my %chm_texi_map = %texi_map; -my %chm_simple_map_texi = %simple_map_texi; -my %chm_style_map_texi = (); - -foreach my $command (keys(%style_map_texi)) -{ - $chm_style_map_texi{$command} = {}; - foreach my $key (keys (%{$style_map_texi{$command}})) - { -#print STDERR "$command, $key, $style_map_texi{$command}->{$key}\n"; - $chm_style_map_texi{$command}->{$key} = - $style_map_texi{$command}->{$key}; - } -} - -foreach my $key (keys(%unicode_accents)) -{ - $chm_style_map_texi{$key}->{'function'} = \&t2h_utf8_accent; -} - -foreach my $key (%things_map) -{ - if (exists($unicode_map{$key}) and ($unicode_map{$key} ne '')) - { - $chm_texi_map{$key} = chr(hex($unicode_map{$key})); - } -} - -$chm_simple_map_texi{"\n"} = ' '; - -my $hhp_lines = ''; - -sub chm_init_out() -{ - my $encoding = &$default_init_out(); - $TOC_FILE = $Texi2HTML::THISDOC{'file_base_name'}.'.hhc'; - my $hhk_file = "$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}" . ".hhk"; - open(IDXFILE, ">:encoding(utf8)", $hhk_file) - || die "Can't open $file_name for writing: $!\n"; - print "# writing HTML Help index in $hhk_file...\n" if $VERBOSE; - print IDXFILE "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n<HTML>\n"; - print IDXFILE "<HEAD>\n<meta name=\"GENERATOR\" content=\"$Texi2HTML::THISDOC{program}\">\n"; - print IDXFILE "<!-- Sitemap 1.0 -->\n</HEAD>\n<BODY>\n"; - print IDXFILE "<OBJECT type=\"text/site properties\">\n"; - foreach my $property (keys(%hhk_global_property)) - { - print IDXFILE "<param name=\"$property\" value=\"$hhk_global_property{$property}\">\n"; - - } - print IDXFILE "</OBJECT>\n"; - - my $hhp_file = "$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}.hhp"; - print "# writing HTML Help project in $hhp_file...\n" if $VERBOSE; - open (HHPFILE, ">:encoding(utf8)", $hhp_file) or - die "Can't open $hhp_file for writing: $!\n"; - my $language = $chm_languages{'en'}; - if (exists ($chm_languages{$LANG})) - { - $language = $chm_languages{$LANG}; - } - my $title = to_utf8($Texi2HTML::THISDOC{'title_texi'}); - - print HHPFILE <<EOT; -[OPTIONS] -Compatibility=1.1 or later -Compiled file=$Texi2HTML::THISDOC{'file_base_name'}.chm -Contents file=$Texi2HTML::THISDOC{'file_base_name'}.hhc -Default Window=Default -Default topic=$TOP_FILE -Display compile progress=No -Full-text search=Yes -Index file=$Texi2HTML::THISDOC{'file_base_name'}.hhk -Language=$language -Title=$title - -[WINDOWS] -Default=,"$Texi2HTML::THISDOC{'file_base_name'}.hhc","$Texi2HTML::THISDOC{'file_base_name'}.hhk","$TOP_FILE","$TOP_FILE",,,,,0x22520,,0x384e,,,,,,,,0 - -[FILES] -EOT - return $encoding; -} -sub chm_print_page_foot($) -{ - my $fh = shift; - print $fh <<EOT; -<p> -$PRE_BODY_CLOSE -</p> -</body> -</html> -EOT -} - -# Convert texi to string with utf8 -sub to_utf8($) -{ - my $text = shift; - $main::simple_map_texi_ref = \%chm_simple_map_texi; - $main::style_map_texi_ref = \%chm_style_map_texi; - $main::texi_map_ref = \%chm_texi_map; - my $normal_text_kept = $normal_text; - $Texi2HTML::Config::normal_text = \&t2h_utf8_normal_text; - - $text = main::remove_texi($text); - - $normal_text = $normal_text_kept; - $main::simple_map_texi_ref = \%simple_map_texi; - $style_map_texi_ref = \%style_map_texi; - $main::texi_map_ref = \%texi_map; - return $text; -} - - -my @hhc_lines; -my %chm_files; - -sub chm_toc_body($) -{ - my $elements_ref = shift; - &$default_toc_body($elements_ref); - my $level = 0; - foreach my $element (@$elements_ref) - { - while ($level != $element->{'toc_level'}) - { - if ($level < $element->{'toc_level'}) - { - push (@hhc_lines, "<UL>\n"); - $level++; - } - elsif ($level > $element->{'toc_level'}) - { - push (@hhc_lines, "</UL>\n"); - $level--; - } - } - my $text = ''; - if ($NUMBER_SECTIONS) - { - $text .= $element->{'number'} . " "; - - } - $text .= to_utf8($element->{'texi'}); - $text =~ s/^\s*//; - push (@hhc_lines, "<LI> <OBJECT type=\"text/sitemap\">\n<param name=\"Name\" value=\"$text\">\n<param name=\"Local\" value=\"$element->{'file'}#$element->{'id'}\">\n</OBJECT> </LI>\n"); - if (!$chm_files{$element->{'file'}}) - { - $hhp_lines .= "$element->{'file'}\n"; - $chm_files{$element->{'file'}} = 1; - } - } - while ($level > 0) - { - push (@hhc_lines, "</UL>\n"); - $level--; - } -} - -# key: -# origin_href: -# entry: -# texi entry: -# element_href: -# element_text: -sub chm_index_summary_file_entry ($$$$$$$$) -{ - my $name = shift; - my $key = shift; - my $origin_href = shift; - my $entry = shift; - my $text = ''; - #$entry = &$protect_text($key); - my $texi_entry = shift; - my $element_href = shift; - my $element_text = shift; - my $is_printed = shift; - $entry = to_utf8($texi_entry); - print IDXFILE "<LI> <OBJECT type=\"text/sitemap\">\n<param name=\"Name\" value=\"$entry\">\n<param name=\"Local\" value=\"$origin_href\">\n</OBJECT> </LI>\n"; -} - -sub chm_index_summary_file_begin($$) -{ - my $name = shift; - my $is_printed = shift; -} - -# file is not closed here but in finish_out. -sub chm_index_summary_file_end($$) -{ - my $name = shift; - my $is_printed = shift; -} - -sub chm_finish_out() -{ - print IDXFILE "</BODY>\n</HTML>\n"; - close (IDXFILE); - my $hhc_file = "$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}.hhc"; - open (HHCFILE, ">:encoding(utf8)", $hhc_file) or - die "Can't open $hhc_file for writing: $!\n"; - - print HHCFILE "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n<HTML>\n"; - print HHCFILE "<HEAD>\n<meta name=\"GENERATOR\" content=\"$Texi2HTML::THISDOC{program}\">\n"; - print HHCFILE "<!-- Sitemap 1.0 -->\n</HEAD>\n<BODY>\n"; - print HHCFILE "<OBJECT type=\"text/site properties\">\n"; - foreach my $property (keys(%hhc_global_property)) - { - print HHCFILE "<param name=\"$property\" value=\"$hhc_global_property{$property}\">\n"; - - } - print HHCFILE "</OBJECT>\n"; - main::print_lines(\*HHCFILE, \@hhc_lines); - print HHCFILE "</HTML>\n</BODY>\n"; - print HHPFILE $hhp_lines; - close (HHPFILE); -} - -1; diff --git a/Build/source/utils/texi2html/examples/html32.init b/Build/source/utils/texi2html/examples/html32.init deleted file mode 100644 index 4e69eafd7d8..00000000000 --- a/Build/source/utils/texi2html/examples/html32.init +++ /dev/null @@ -1,205 +0,0 @@ -# -*-perl-*- -# APA: Add SystemLiteral to identify the canonical DTD. -# [Definition:] The SystemLiteral is called the entity's system -# identifier. It is a URI, which may be used to retrieve the entity. -# See http://www.xml.com/axml/target.html#NT-ExternalID -$DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN" "http://www.w3.org/TR/html32/loose.dtd">'; - -$FRAMESET_DOCTYPE = $DOCTYPE; - -$BODYTEXT = 'bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"'; -# this controls the pre style for menus -$MENU_PRE_STYLE = ''; - -$TOC_LIST_STYLE =''; - -$USE_ISO = 0; -$MENU_SYMBOL = '*'; - -# This lines are inserted before and after the shortcontents -$BEFORE_OVERVIEW = ""; -$AFTER_OVERVIEW = ''; - -# This lines are inserted before and after the contents -$BEFORE_TOC_LINES = ""; -$AFTER_TOC_LINES = ''; - -# html version for latex2html -$L2H_HTML_VERSION = "3.2"; - -# no css -$CSS_LINES = ""; -%css_map = (); - -$things_map{'oe'} = 'œ'; -$things_map{'OE'} = 'Œ'; -$things_map{'dots'} = '<small>...</small>'; -$things_map{'enddots'} = '<small>....</small>'; -$things_map{'euro'} = 'Euro'; -$style_map{'sansserif'} = {}; - -# formatting functions - -$summary_letter = \&t2h_html32_summary_letter; -$protect_text = \&t2h_html32_protect_text; -$heading = \&t2h_html32_heading; -$preformatted = \&t2h_html32_preformatted; -$raw = \&t2h_html32_raw; -$menu = \&t2h_html32_menu; -$foot_section = \&t2h_html32_foot_section; -$cartouche = \&t2h_html32_cartouche; -$listoffloats = \&t2h_html32_listoffloats; -$float = \&t2h_html32_float; - -# " is not in html 3.2 -sub t2h_html32_protect_text($) -{ - my $text = shift; - $text =~ s/&/&/g; - $text =~ s/</</g; - $text =~ s/>/>/g; - #$text =~ s/\"/"/g; - return $text; -} - -# a preformatted section -sub t2h_html32_preformatted($$$) -{ - my $text = shift; - my $pre_style = shift; - my $class = shift; - - return '' if ($text eq ''); - return "<pre>$text</pre>"; -} - -# a heading for an element -sub t2h_html32_heading($) -{ - my $element = shift; - my $level = 3; - if (!$element->{'node'}) - { - $level = $element->{'level'}; - } - $level = 1 if ($level == 0); - my $text = $element->{'text'}; - if (!$element->{'node'} and (!$NUMBER_SECTIONS)) - { - $text = $element->{'name'}; - } - return '' if ($text !~ /\S/); - if (defined($element->{'tocid'}) and $TOC_LINKS) - { - $text = &$anchor ('', "$Texi2HTML::THISDOC{'toc_file'}#$element->{'tocid'}", $text); - } - return "<h$level> $text </h$level>\n"; -} - -# formatting of raw regions -# ih L2H is true another mechanism is used for tex -sub t2h_html32_raw($$) -{ - my $style = shift; - my $text = shift; - if ($style eq 'verbatim' or $style eq 'tex') - { - return "<pre>" . &$protect_text($text) . '</pre>'; - } - elsif ($style eq 'html') - { - return $text; - } - else - { - warn "$WARN (bug) unknown style $style\n"; - return &$protect_text($text); - } -} - -# a whole menu -sub t2h_html32_menu($) -{ - my $text = shift; - if ($text =~ /\S/) - { - return "<table border=\"0\" cellspacing=\"0\">\n" - . $text . "</table>\n"; - } -} - -# a simple menu entry ref in case we aren't in a standard menu context -sub t2h_html32_foot_section($) -{ - my $lines = shift; - unshift (@$lines, "<hr>\n", "<h3>Footnotes</h3>\n"); - return $lines; -} - -# a cartouche -sub t2h_html32_cartouche($) -{ - my $text = shift; - - if ($text =~ /\S/) - { - return "<table border=\"1\"><tr><td>\n" . $text . "</td></tr></table>\n"; - } - return ''; -} - - -# no style -sub t2h_html32_summary_letter($$$) -{ - my $letter = shift; - my $file = shift; - my $identifier = shift; - return &$anchor('', $file . '#' . $identifier, '<b>' . &$protect_text($letter) . '</b>'); -} - -sub t2h_html32_float($$$$$) -{ - my $text = shift; - my $float = shift; - my $caption = shift; - my $shortcaption = shift; - - my $label = ''; - if (exists($float->{'id'})) - { - $label = &$anchor($float->{'id'}); - } - my $caption_text = ''; - - if (defined($float->{'caption_texi'})) - { - $caption_text = $caption; - } - elsif (defined($float->{'shortcaption_texi'})) - { - $caption_text = $shortcaption; - } - elsif (defined($caption)) - { - $caption_text = $caption; - } - - return "$label\n" . $text . $caption_text; -} - -sub t2h_html32_listoffloats($$$) -{ - my $style_texi = shift; - my $style = shift; - my $float_entries = shift; - - my $result = "<dl>\n" ; - foreach my $float_entry (@$float_entries) - { - $result .= $float_entry; - } - return $result . "</dl>\n"; -} - - diff --git a/Build/source/utils/texi2html/examples/inlinestyle.init b/Build/source/utils/texi2html/examples/inlinestyle.init deleted file mode 100644 index ecd8c63e4fb..00000000000 --- a/Build/source/utils/texi2html/examples/inlinestyle.init +++ /dev/null @@ -1,39 +0,0 @@ - -$TOC_LIST_ATTRIBUTE = $TOC_LIST_ATTRIBUTE . " style=\"$TOC_LIST_STYLE\""; - -# we empty CSS_LINES as all styles are inlined -$CSS_LINES = ""; - -$style_map{'sansserif'} = - { 'attribute' => "span style=\"$css_map{'sansserif'}\""}; - -# formatting functions - -$preformatted = \&t2h_inlinestyle_preformatted; -$summary_letter = \&t2h_inline_summary_letter; - -sub t2h_inlinestyle_preformatted($$$) -{ - my $text = shift; - my $pre_style = shift; - my $class = shift; - - return '' if ($text eq ''); - my $open = '<pre'; - if ($pre_style) - { - $open .= " style=\"$pre_style\""; - } - return $open .= " class=\"$class\">$text</pre>"; -} - -sub t2h_inline_summary_letter($$$) -{ - my $letter = shift; - my $file = shift; - my $identifier = shift; - return &$anchor('', $file . '#' . $identifier, '<b>' . &$protect_html($letter) . '</b>', 'class="summary-letter" style="text-decoration: none"'); - -} - -1; diff --git a/Build/source/utils/texi2html/examples/makeinfo.init b/Build/source/utils/texi2html/examples/makeinfo.init deleted file mode 100644 index ec3cb92264f..00000000000 --- a/Build/source/utils/texi2html/examples/makeinfo.init +++ /dev/null @@ -1,147 +0,0 @@ -# -*-perl-*- -$TOP_FILE = 'index.html'; - -$SHOW_MENU = 1; - -$USE_NODES = 1; - -$SPLIT = 'node'; - -$SECTION_NAVIGATION = 1; - -$SHORT_REF = 1; - -$NODE_NAME_IN_MENU = 1; - -$AVOID_MENU_REDUNDANCY = 0; - -$SPLIT_INDEX = 0; - -$MENU_SYMBOL = '*'; - -$WORDS_IN_PAGE = 200; - -$SEPARATED_FOOTNOTES = 0; - -@SECTION_BUTTONS = - ( - \"node: ", \$Texi2HTML::NODE{This}, [ 'NodeNext', \$Texi2HTML::NODE{Next} ] , \",", [ 'NodePrev', \$Texi2HTML::NODE{Prev} ], \",", [ 'NodeUp', \$Texi2HTML::NODE{NodeUp} ], 'Following' - ); - -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; -} - - -@MISC_BUTTONS = @SECTION_BUTTONS; - -$foot_line_and_ref = \&makeinfo_like_foot_line_and_ref; -$foot_lines = \&makeinfo_like_foot_lines; -$index_summary = \&makeinfo_like_index_summary; -$summary_letter = \&makeinfo_like_summary_letter; -$index_entry = \&makeinfo_like_index_entry; -$index_letter = \&makeinfo_like_index_letter; -$print_index = \&makeinfo_like_print_index; -$listoffloats = \&makeinfo_like_listoffloats; -$listoffloats_entry = \&makeinfo_like_listoffloats_entry; - -sub makeinfo_like_foot_line_and_ref($$$$$$$$) -{ - my $foot_num = shift; - my $relative_num = shift; - my $footid = shift; - my $docid = shift; - my $from_file = shift; - my $footnote_file = shift; - my $lines = shift; - my $state = shift; - - my $foot_anchor = "<sup>" . &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>"; - $foot_anchor = &$anchor($docid, "$footnote_file#$footid", "($relative_num)") if ($state->{'preformatted'}); - unshift @$lines, "<li>"; - push @$lines, "</li>\n"; - return ($lines, $foot_anchor); -} - -sub makeinfo_like_foot_lines($) -{ - my $lines = shift; - unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n<ol type=\"1\">\n"; - push @$lines, "</ol>"; - return $lines; -} - - -sub makeinfo_like_index_summary -{ - return ''; -} - -sub makeinfo_like_summary_letter -{ - return ''; -} - -sub makeinfo_like_index_entry($$$$) -{ - my $text_href = shift; - my $entry = shift; - my $element_href = shift; - my $element_text = shift; - - return '<li>' . $entry . ': ' . &$anchor('', $element_href, $element_text) - . "</li>\n"; -} - -sub makeinfo_like_index_letter($$$) -{ - my $letter = shift; - my $id = shift; - my $text = shift; - return $text; -} - -sub makeinfo_like_print_index($$) -{ - my $text = shift; - my $name = shift; - return "<ul class=\"index-$name\" compact>\n" . $text . "</ul>\n"; -} - -sub makeinfo_like_listoffloats_entry($$$$) -{ - my $style_texi = shift; - my $float = shift; - my $float_style = shift; - my $caption = shift; - my $href = shift; - - if ($caption ne '') - { - return '<li>' . &$I('%{href}: %{caption}', { 'href' => &$anchor('', $href, $float_style), 'caption' => $caption }) . "</li>\n"; - } - else - { - return '<li>' . &$anchor('', $href, $float_style) . "</li>\n"; - } -} - -sub makeinfo_like_listoffloats($$$) -{ - my $style_texi = shift; - my $style = shift; - my $float_entries = shift; - - my $result = "<ul class=\"listoffloats\">\n" ; - foreach my $float_entry (@$float_entries) - { - $result .= $float_entry; - } - return $result . "</ul>\n"; -} diff --git a/Build/source/utils/texi2html/examples/noheaders.init b/Build/source/utils/texi2html/examples/noheaders.init deleted file mode 100644 index 1daf77a8459..00000000000 --- a/Build/source/utils/texi2html/examples/noheaders.init +++ /dev/null @@ -1,137 +0,0 @@ -# -*-perl-*- - -$SPLIT = 'none'; - -$print_section = \&T2H_NOHEAD_print_section; -$end_section = \&T2H_NOHEAD_end_section; -$one_section = \&T2H_NOHEAD_one_section; -#$print_Top_header = \&T2H_NOHEAD_print_Top_header; -$print_Top_footer = \&T2H_NOHEAD_print_Top_footer; -$print_Top = \&T2H_NOHEAD_print_Top; -$print_misc_header = \&T2H_NOHEAD_print_misc_header; -$print_misc_footer = \&T2H_NOHEAD_print_misc_footer; -$print_misc = \&T2H_NOHEAD_print_misc; -$print_head_navigation = \&T2H_NOHEAD_print_head_navigation; -$about_body = \&T2H_NOHEAD_about_body; -#$toc_body = \&T2H_NOHEAD_toc_body; - -######################################################################## -# Layout for html for every sections -# -sub T2H_NOHEAD_print_section -{ - my $fh = shift; - my $first_in_page = shift; - my $previous_is_top = shift; - - if ($first_in_page) - { - &$print_head_navigation($fh); - } - else - { # got to do this here, as it isn't done in print_head_navigation - main::print_lines($fh, $Texi2HTML::THIS_HEADER); - } - my $nw = main::print_lines($fh); -} - -sub T2H_NOHEAD_one_section($) -{ - my $fh = shift; - main::print_lines($fh); - print $fh "$SMALL_RULE\n"; - &$print_page_foot($fh); -} - -################################################################### -# Layout of top-page I recommend that you use @ifnothtml, @ifhtml, -# @html within the Top texinfo node to specify content of top-level -# page. -# -# If you enclose everything in @ifnothtml, then title, subtitle, -# author and overview is printed -# Texi2HTML::HREF of Next, Prev, Up, Forward, Back are not defined -# if $T2H_SPLIT then Top page is in its own html file -sub T2H_NOHEAD_print_Top_footer($$) -{ - my $fh = shift; - print $fh "$SMALL_RULE\n"; -} -sub T2H_NOHEAD_print_Top -{ - my $fh = shift; - my $has_top_heading = shift; - - &$print_head_navigation($fh,[]); - if ($Texi2HTML::THIS_SECTION) - { - # if top-level node has content, then print it with extra header - #print $fh "<h1>$Texi2HTML::NAME{Top}</h1>\n" - print $fh "<h1 class=\"settitle\">$Texi2HTML::NAME{Top}</h1>\n" - unless ($has_top_heading); - main::print_lines($fh, $Texi2HTML::THIS_SECTION); - } - else - { - # top-level node is fully enclosed in @ifnothtml - # print fulltitle, subtitle, author, Overview - print $fh $Texi2HTML::TITLEPAGE; - if (@{$Texi2HTML::OVERVIEW}) - { - print $fh '<h2> ' . &$I('Overview:') . "</h2>\n" . "<blockquote>\n"; - my $nw = main::print_lines($fh, $Texi2HTML::OVERVIEW); - print $fh "</blockquote>\n"; - } - } -} - -################################################################### -# Layout of Toc, Overview, and Footnotes pages -# By default, we use "normal" layout -# Texi2HTML::HREF of Next, Prev, Up, Forward, Back, etc are not defined -# use: my $buttons = [...] to redefine navigation buttons -sub T2H_NOHEAD_print_misc_header -{ - my $fh = shift; - &$print_page_head($fh) if $SPLIT; - &$print_head_navigation($fh); -} -sub T2H_NOHEAD_print_misc_footer -{ - my $fh = shift; - print $fh "$SMALL_RULE\n"; - if ($SPLIT) - { - &$print_navigation($fh, $buttons); - &$print_page_foot($fh); - } - -} -sub T2H_NOHEAD_print_misc -{ - my $fh = shift; - &$print_misc_header($fh); - print $fh "<h1>$Texi2HTML::NAME{This}</h1>\n"; - main::print_lines($fh); - &$print_misc_footer($fh); -} - -sub T2H_NOHEAD_end_section($) -{ - my $fh = shift; - print $fh "$MIDDLE_RULE\n"; -} - -################################################################### -# Layout of navigation panel - -sub T2H_NOHEAD_print_head_navigation -{ - my $fh = shift; - main::print_lines($fh, $Texi2HTML::THIS_HEADER); -} - -sub T2H_NOHEAD_about_body -{ -} - diff --git a/Build/source/utils/texi2html/examples/roff.init b/Build/source/utils/texi2html/examples/roff.init deleted file mode 100644 index 221cb214cbf..00000000000 --- a/Build/source/utils/texi2html/examples/roff.init +++ /dev/null @@ -1,1165 +0,0 @@ -# -*-perl-*- - -main::load_init_file('', 'noheaders.init'); - -$SPLIT = 'none'; -@EXPAND = ('info'); -$USE_ISO = 0; -#$SHOW_MENU = 0; -$SMALL_RULE = ''; -$DEFAULT_RULE = ''; -$MIDDLE_RULE = ''; -$BIG_RULE = ''; -$NODE_FILE_EXTENSION = "roff"; -$EXTENSION = "roff"; -$MENU_SYMBOL = '*'; -$AVOID_MENU_REDUNDANCY = 0; - -$print_Top = \&T2H_ROFF_print_Top; -$print_misc = \&T2H_ROFF_print_misc; -$print_page_head = \&T2H_ROFF_print_page_head; -$print_page_foot = \&T2H_ROFF_print_page_foot; -$toc_body = \&T2H_ROFF_toc_body; -$titlepage = \&T2H_ROFF_titlepage; - -sub T2H_ROFF_print_page_head -{ - my $fh = shift; - print $fh <<EOT; -.nr _- 0 -.tr \\(is' -.tr \\(if` -.tr \\(pd" - -$AFTER_BODY_OPEN - -EOT - print $fh $Texi2HTML::THISDOC{'copying'} . "\n"; - print $fh "" . &$comment("Created on $Texi2HTML::THISDOC{today} by $Texi2HTML::THISDOC{program}\n"); - print $fh "" . &$comment($Texi2HTML::THISDOC{program_authors}); - print $fh ".ds St " . protect_spaces($Texi2HTML::THISDOC{'title'}) . "\n"; - print $fh '.oh \'\\\\*(St\'\'%\'' ."\n".'.eh \'%\'\'\\\\*(St\'' . "\n"; -} - -sub T2H_ROFF_print_page_foot -{ - my $fh = shift; - my $program_string = program_string(); - print $fh <<EOT; -.br -.pp -$program_string -EOT -} - -sub T2H_ROFF_print_Top($$) -{ - my $fh = shift; - my $has_top_heading = shift; - - my $buttons = \@MISC_BUTTONS; - &$print_head_navigation($fh, $buttons); - print $fh $Texi2HTML::TITLEPAGE; - main::print_lines($fh, $Texi2HTML::THIS_SECTION); -} - -sub T2H_ROFF_print_misc -{ - my $fh = shift; - &$print_misc_header($fh); - main::print_lines($fh); - &$print_misc_footer($fh); -} - -sub T2H_ROFF_titlepage () -{ - my $result = ''; - if (@{$Texi2HTML::THISDOC{'titles'}} - or @{$Texi2HTML::THISDOC{'subtitles'}} - or @{$Texi2HTML::THISDOC{'authors'}}) - { - foreach my $title (@{$Texi2HTML::THISDOC{'titles'}}) - { - $result .= ".sz +10\n.ce\n" . protect_spaces($title) . "\n.sz -10\n"; - } - foreach my $subtitle (@{$Texi2HTML::THISDOC{'subtitles'}}) - { - $result .= ".sz +4\n.ce\n" . protect_spaces($subtitle) . "\n.sz -4\n"; - } - $result .= ".sp 4\n" if ($result ne ''); - foreach my $author (@{$Texi2HTML::THISDOC{'authors'}}) - { - $result .= protect_spaces($author) . "\n.br\n"; - } - $result .= ".sp 2\n" if (@{$Texi2HTML::THISDOC{'authors'}}); - } - if (($result ne '') or ($Texi2HTML::TITLEPAGE ne '')) - { - $Texi2HTML::TITLEPAGE = ".tp\n" . $result . $Texi2HTML::TITLEPAGE . ".++ C\n"; - } -} - -######################################################################## -# Control of formatting: -# 1.) For some changes, it is often enough to change the value of -# some global map. It might necessitate building a little -# function along with the change in hash, if the change is the use -# of another function (in style_map). -# 2.) For other changes, reimplement one of the t2h_default_<fnc>* routines, -# give them another name, and assign them to the respective -# $<fnc> variable (below). - - -# -# This hash should have keys corresponding with the nonletter command accent -# whose following character is considered to be the argument -# This hash associates an accent macro to the ISO name for the accent if any. -# The customary use of this map is to find the ISO name appearing in html -# entity (like é) associated with a texinfo accent macro. -# -# The keys of the hash are -# ": umlaut -# ~: tilda accent -# ^: circumflex accent -# `: grave accent -# ': acute accent -# =: macron accent -%accent_map = ( - '"', ':', - '~', '~', - '^', '^', - '`', '`', - "'", "'", - '=', '', - ); - -# -# texinfo "simple things" (@foo) to HTML ones -# -%simple_map = ( -# "*", "\n.br\n", - ' ', '\ ', - "\t", "\\\t", - "\n", "\\\n", - # "­" or "­" could also be possible for @-, but it seems - # that some browser will consider this as an always visible hyphen mark - # which is not what we want (see http://www.cs.tut.fi/~jkorpela/shy.html) - '-', '', # hyphenation hint - '|', '', # used in formatting commands @evenfooting and friends - '/', '', - # spacing commands - ':', '', - '!', '!', - '?', '?', - '.', '\&.', - '@', '@', - '}', '}', - '{', '{', - ); - -# this map is used in preformatted text -%simple_map_pre = %simple_map; - -# -# texinfo "things" (@foo{}) to HTML ones -# -%things_map = ( - 'TeX' => 'TeX', - 'LaTeX' => 'LaTeX', - 'bullet' => '\(bu', - 'copyright' => '\(co', - 'registeredsymbol' => '\(rg', - 'dots' => '\&...', - 'enddots' => '\&....', - 'equiv' => '\(==', -# i18n - 'error' => 'error->', - 'expansion' => '\(->', - 'minus' => '\-', - 'point' => '*', - 'print' => '-|', - 'result' => '\(rh', - # set in code using the language - # 'today', &pretty_date, - 'aa' => '\(oa', - 'AA' => '\(oA', - 'ae' => '\(ae', - 'oe' => '\(oe', - 'AE' => '\(AE', - 'OE' => '\(OE', - 'o' => '\(/o', - 'O' => '\(/O', - 'ss' => '\(ss', - 'l' => '\(/l', - 'L' => '\(/L', - 'exclamdown' => '\(r!', - 'questiondown' => '\(r?', - 'pounds' => '\(Po', - 'ordm' => '\(Om', - 'ordf' => '\(Of', - 'euro' => '\(eu', - ); - -# This map is used in preformatted environments -%pre_map = %things_map; - -#%style_map = ( -# 'acronym', '', -# 'asis', '', -# 'b', ['\fB', '\fR'], -# 'cite', ['\fI', '\fR'], -# 'code', ['\fR\&\f(CW', '\fR'], -# 'command', ['\fR\&\f(CW', '\fR'], -# 'ctrl', ['\fR\&\f(CW', '\fR'], -# 'dfn', ['\fI', '\fR'], -# 'dmn', '', -# 'email', ['\fB', '\fR'], -# 'emph', ['\fI', '\fR'], -# 'env', ['\fR\&\f(CW', '\fR'], -# 'file', ['\fR\&\f(CW', '\fR', '"'], -# 'i', ['\fI', '\fR'], -# 'kbd', ['\fR\&\f(CW', '\fR'], -# 'key', ['\fR\&\f(CW', '\fR'], -# 'math', ['\fR\&\f(CW', '\fR'], -# 'option', ['\fR\&\f(CW', '\fR', '"'], -# 'r', ['\fR', ''], -# 'samp', ['\fR\&\f(CW', '\fR', '"'], -# 'sc', '&roff_sc', -# 'strong', ['\fB', '\fR'], -# 't', ['\fR\&\f(CW', '\fR'], -# 'uref', '&default_uref', -# 'url', '&default_url', -# 'var', ['\fI', '\fR'], -# 'verb', ['\fR\&\f(CW', '\fR'], -# 'titlefont', ["\n.sz +10\n.ce\n", "\n.sz -10\n"], -# 'w', '', -# 'H', '&roff_accent', -# 'dotaccent', '&roff_accent', -# 'ringaccent', '&roff_accent', -# 'tieaccent', '&roff_accent', -# 'u', '&roff_accent', -# 'ubaraccent', '&roff_accent', -# 'udotaccent', '&roff_accent', -# 'v', '&roff_accent', -# ',', '&roff_accent', -# 'dotless', '' -# ); - -my @bold_commands = ('strong', 'b', 'email'); -my @italic_commands = ('cite', 'dfn', 'emph', 'i', 'var', 'slanted'); -my @fixed_command = ('code', 'command', 'ctrl', 'env', 'file', 'kbd', 'key', - 'math', 'option', 'samp', 't', 'verb'); - -foreach my $accent_command ('tieaccent', 'dotless', keys(%unicode_accents), keys(%accent_map)) -{ - #$style_map{$accent_command} = { 'function' => \&t2h_roff_accent }; - $style_map{$accent_command} = '&roff_accent'; -} -#foreach my $accent (keys(%accent_map)) -#{ -# $style_map{$accent} = '&roff_accent'; -#} - -foreach my $command (keys(%style_map)) -{ - delete $style_map{$command}->{'attribute'} if (exists($style_map{$command}->{'attribute'})); - if (grep {$_ eq $command} @bold_commands) - { - delete $style_map{$command}->{'function'} if (exists($style_map{$command}->{'function'})); - $style_map{$command}->{'begin'} = '\fB'; - $style_map{$command}->{'end'} = '\fR'; - next; - } - elsif (grep {$_ eq $command} @italic_commands) - { - delete $style_map{$command}->{'function'} if (exists($style_map{$command}->{'function'})); - $style_map{$command}->{'begin'} = '\fI'; - $style_map{$command}->{'end'} = '\fR'; - next; - } - elsif (grep {$_ eq $command} @fixed_commands) - { - delete $style_map{$command}->{'function'} if (exists($style_map{$command}->{'function'})); - $style_map{$command}->{'begin'} = '\fR\&\f(CW'; - $style_map{$command}->{'end'} = '\fR'; - next; - } -} - -delete $style_map{'titlefont'}->{'function'} if (exists($style_map{'titlefont'}->{'function'})); -$style_map{'titlefont'}->{'begin'} = "\n.sz +10\n.ce\n"; -$style_map{'titlefont'}->{'end'} = "\n.sz -10\n"; - -delete $style_map{'r'}->{'function'} if (exists($style_map{'r'}->{'function'})); -$style_map{'r'}->{'begin'} = '\r'; -#$style_map{'r'}->{'end'} = ''; - -$style_map{'sc'} = '&roff_sc'; - -$style_map{'indicateurl'}->{'begin'} = '<'; -$style_map{'indicateurl'}->{'end'} = '>'; - -foreach my $command (keys(%style_map)) -{ - if (ref($style_map{$command}) ne 'HASH') - { - $style_map_pre{$command} = $style_map{$command}; - next; - } - $style_map_pre{$command} = {}; - foreach my $key (keys(%{$style_map{$command}})) - { - $style_map_pre{$command}->{$key} = $style_map{$command}->{$key}; - } -} - -%special_accents = ( - 'ringaccent' => 'aA', - "'" => 'aeiouyAEIOUY', - ',' => 'cC', - '^' => 'aeiouAEIOU', - '`' => 'aeiouAEIOU', - '~' => 'nNaoAO', - '"' => 'aeiouyAEIOUY', - 'v' => 'sSzZ', -); - -sub roff_accent($$) -{ - my $text = shift; - my $accent = shift; - return $text if ($accent eq 'dotless'); - return "\\($accent_map{$accent}${text}" if (defined($accent_map{$accent}) and defined($special_accents{$accent}) and ($text =~ /^[$special_accents{$accent}]$/)); - return "\\(o${text}" if (($accent eq 'ringaccent') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return "\\(v${text}" if (($accent eq 'v') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return "\\(,${text}" if (($accent eq ',') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); -#FIXME maybe we should protect the symbols such that they look like strings and -# not ponctuation marks ? Like it is done in texi2roff ? -# otherwise we should use -# return ascii_accents($text, $accent); - return $text . $accent if (defined($accent_map{$accent})); - return $text . "''" if ($accent eq 'H'); - return $text . '\\&.' if ($accent eq 'dotaccent'); - return $text . '*' if ($accent eq 'ringaccent'); - return $text . '[' if ($accent eq 'tieaccent'); - return $text . '(' if ($accent eq 'u'); - return $text . '_' if ($accent eq 'ubaraccent'); - return '\\&.' . $text if ($accent eq 'udotaccent'); - return $text . '<' if ($accent eq 'v'); - return $text . ',' if ($accent eq ','); -} - -sub roff_sc($$) -{ - return "\n.sz -6\n" . uc($_[0]) . "\n.sz +6\n" ; -} - -sub roff_ctrl($$) -{ - return "\\*^$_[0]"; -} - -$format = \&T2H_ROFF_format; - -sub T2H_ROFF_format($$$) -{ - my $tag = shift; - my $element = shift; - my $text = shift; - return '' if (!defined($element) or ($text !~ /\S/)); - return $element->[0] . $text . $element->[1]; -} - -%format_map = ( - 'quotation' => [ ".(q\n", ".)q\n" ], - # lists - 'itemize' => [ ".(l L F\n.ba +5\n", ".ba -5\n.)l\n" ], - 'enumerate' => [ ".(l L F\n.ba +5\n", ".ba -5\n.)l\n" ], - 'multitable' => [ ".(l M\n.nh\n", ".hy\n.)l\n" ], - 'table' => [ ".(l L F\n.ba +5\n", ".ba -5\n.)l\n" ], - 'vtable' => [ ".(l L F\n.ba +5\n", ".ba -5\n.)l\n" ], - 'ftable' => [ ".(l L F\n.ba +5\n", ".ba -5\n.)l\n" ], - ); - -%special_list_commands = ( - 'table' => {}, - 'vtable' => {}, - 'ftable' => {}, - 'itemize' => {} - ); - -# an eval of these $complex_format_map->{what}->{'begin'} yields beginning -# an eval of these $complex_format_map->{what}->{'end'} yields end -# $EXAMPLE_INDENT_CELL and SMALL_EXAMPLE_INDENT_CELL can be usefull here -$complex_format_map = -{ - 'example' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => ".(l I\n\\&\\fR\\f(CW", - 'end_region' => "\\&\\fR\n.)l\n" - }, - 'smallexample' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => ".(l I\n.size -2\n\\&\\fR\\f(CW", - 'end_region' => "\\&\\fR\n.size +2\n.)l\n" - }, - 'display' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => ".(l I\n\\&\\fR\\f(CW", - 'end_region' => "\\&\\fR\n.)l\n" - }, - 'smalldisplay' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => ".(l I\n.size -2\n\\&\\fR\\f(CW", - 'end_region' => "\\&\\fR\n.size +2\n.)l\n" - }, - 'menu-comment' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => "", - 'end_region' => "\n" - }, - 'menu-preformatted' => - { - 'begin' => q{""}, - 'end' => q{""}, - 'begin_region' => "", - 'end_region' => "\n" - } -}; - -# format shouldn't narrow the margins - -$complex_format_map->{'lisp'} = $complex_format_map->{'example'}; -$complex_format_map->{'smalllisp'} = $complex_format_map->{'smallexample'}; -$complex_format_map->{'format'} = $complex_format_map->{'display'}; -$complex_format_map->{'smallformat'} = $complex_format_map->{'smalldisplay'}; - -sub protect_spaces($) -{ - my $text = shift; - my $result = ''; - while($text) - { - if ($text =~ s/^([^\\]*)\\//o) - { - my $leading = $1; - if (defined($leading)) - { - $leading =~ s/([\t ])/\\$1/go; - $result .= $leading . '\\'; - } - if (($text =~ s/^(\s)//o) or ($text =~ s/^(.)//o)) - { - $result .= $1; - } - } - else - { - $text =~ s/([\t ])/\\$1/go; - $result .= $text; - $text = ''; - } - } - return $result; -} - -# formatting functions - -$anchor = \&t2h_roff_anchor; -$def_item = \&t2h_roff_def_item; -$def = \&t2h_roff_def; -$menu = \&t2h_roff_menu; -$menu_link = \&t2h_roff_menu_link; -$menu_comment = \&t2h_roff_menu_comment; -$menu_description = \&t2h_roff_menu_description; -$simple_menu_link = \&t2h_roff_simple_menu_link; -$table_item = \&t2h_roff_table_item; -$table_line = \&t2h_roff_table_line; -$row = \&t2h_roff_row; -$cell = \&t2h_roff_cell; -$list_item = \&t2h_roff_list_item; -$comment = \&t2h_roff_comment; -$def_line = \&t2h_roff_def_line; -$raw = \&t2h_roff_raw; -$heading = \&t2h_roff_heading; -$paragraph = \&t2h_roff_paragraph; -$preformatted = \&t2h_roff_preformatted; -$foot_line_and_ref = \&t2h_roff_foot_line_and_ref; -$foot_section = \&t2h_roff_foot_section; -$image = \&t2h_roff_image; -$index_entry_label = \&t2h_roff_index_entry_label; -$index_summary = \&t2h_roff_index_summary; -$print_index = \&t2h_roff_print_index; -$protect_text = \&t2h_roff_protect_text; -$cartouche = \&t2h_roff_cartouche; -$sp = \&t2h_roff_sp; -$normal_text = \&t2h_roff_normal_text; -$empty_line = \&t2h_roff_empty_line; -$unknown = \&t2h_roff_unknown; -$float = \&t2h_roff_float; -$listoffloats = \&t2h_roff_listoffloats; -$listoffloats_entry = \&t2h_roff_listoffloats_entry; - -# This function is used to protect characters which are special in html -# in inline text: &, ", <, and >. -# -# argument: -# text to be protected -sub t2h_roff_protect_text($) -{ - my $text = shift; - $text =~ s/\\/\\e/g; - $text =~ s/$;---$;/\\(em/g; - $text =~ s/$;--$;/-/g; - $text =~ s/$;-$;/\\-/g; - $text =~ s/^\./\\&./; - $text =~ s/([\s])\./$1\\&./g; - return $text; -} - -sub t2h_roff_normal_text($) -{ - my $text = shift; - #$text =~ s/---/\\(em/g; - $text =~ s/(--?-?)/$;$1$;/go; - return $text; -} - -sub t2h_roff_unknown($$) -{ - my $macro = shift; - my $line = shift; - - if ($macro eq '*') - { - $line = '' if ($line =~ /^\s*$/); - return ($line, 1, "\n.br\n", undef); - } - return ($line, 0, undef, undef); -} - - -# This function produces an anchor -# -# arguments: -# $name : anchor name -# $href : anchor href -# text : text displayed -# extra_attribs : added to anchor attributes list -sub t2h_roff_anchor($;$$$) -{ - my $name = shift; - my $href = shift; - my $text = shift; - my $attributes = shift; - $href = '' if (!defined($href) or ($href !~ /\S/)); - $text = '' if (!defined($text)); - return $text if ($text ne ''); - return "[$href]" if ($href ne ''); - return ''; -} - -# This function is used to format the text associated with a @deff/@end deff -# -# argument: -# text -sub t2h_roff_def_item($) -{ - my $text = shift; - if ($text =~ /\S/) - { - { - #return ".ba +5\n.(l L F\n" . $text . ".)l\n.ba -5\n"; - return ".(l L F\n.ba +5\n" . $text . ".ba -5\n.)l\n"; - } - } - return ''; -} - -# format the container for the @deffn line and text -# -# argument -# text of the whole @def, line and associated text. -sub t2h_roff_def($) -{ - my $text = shift; - return $text; -} - -# a whole menu -# -# argument: -# the whole menu text (entries and menu comments) -# -# argument: -# whole menu text. -sub t2h_roff_menu($) -{ - my $text = shift; - chomp $text; - return ".(l M\n\\&\\s8" . &$I('Menu:') . "\n" . $text . "\\&\\s0\n.)l\n"; -} - -# a simple menu entry ref in case we aren't in a standard menu context -sub t2h_roff_simple_menu_link($$$$$) -{ - my $text = shift; - my $href = shift; - my $node = shift; - my $name = shift; - my $ending = shift; - $name .= ':' if ($name ne ''); - return "$MENU_SYMBOL$name$node$ending"; -} - -# formats a menu entry link pointing to a node or section -# -# arguments: -# the entry text -# the state, a hash reference holding informations about the context, with a -# usefull entry, 'preformatted', true if we are in a preformatted format -# (a format keeping space between words). In that case a function -# of the main program, main::do_preformatted($text, $state) might -# be used to format the text with the current format style. -# href is optionnal. It is the reference to the section or the node anchor -# which should be used to make the link (typically it is the argument -# of a href= attribute in a <a> element). -sub t2h_roff_menu_link($$$$$$) -{ - my $text = shift; - my $state = shift; - my $href = shift; - my $node = shift; - my $name = shift; - my $ending = shift; - $name .= ':' if ($name ne ''); - return "$MENU_SYMBOL$name$node$ending"; -} - -# formats a menu entry description, ie the text appearing after the node -# specification in a menu entry an spanning until there is another -# menu entry, an empty line or some text at the very beginning of the line -# (we consider that text at the beginning of the line begins a menu comment) -# -# arguments: -# the description text -# the state. See menu_entry. -sub t2h_roff_menu_description($$) -{ - my $text = shift; - my $state = shift; - return $text; -} - -# a menu comment (between menu lines) -# formats the container of a menu comment. A menu comment is any text -# appearing between menu lines, either separated by an empty line from -# the preceding menu entry, or a text beginning at the first character -# of the line (text not at the very beginning of the line is considered to -# be the continuation of a menu entry description text). -# -# The text itself is considered to be in a preformatted environment -# with name 'menu-commment' and with style $MENU_PRE_STYLE. -# -# argument -# text contained in the menu comment. -sub t2h_roff_menu_comment($) -{ - my $text = shift; - return $text; -} - -# text after @item in table, vtable and ftable -sub t2h_roff_table_item($$$$$) -{ - my $text = shift; - my $index_label = shift; - my $format = shift; - my $command = shift; - my $formatted_command = shift; - $formatted_command = '' if (!defined($formatted_command) or - exists($special_list_commands{$format}->{$command})); - $text = '.ip ' . $formatted_command . protect_spaces($text) . "\n"; - $text .= $index_label if (defined($index_label)); - return $text; -} - -# format text on the line following @item (in table, vtable and ftable) -sub t2h_roff_table_line($) -{ - my $text = shift; - return $text; -} - -# row in multitable -sub t2h_roff_row($) -{ - my $text = shift; - - if ($text =~ /\S/) - { - return $text ."\n" ; - } - return ''; -} - -# cell in multitable -sub t2h_roff_cell($) -{ - my $text = shift; - chomp $text; - return protect_spaces($text) . "\\\t"; -} - -# format an item in a list -# -# argument: -# text of the item -sub t2h_roff_list_item($$$$$$$) -{ - my $text = shift; - my $format = shift; - my $command = shift; - my $formatted_command = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - $formatted_command = '' if (!defined($formatted_command) or - exists($special_list_commands{$format}->{$command})); - if ($text =~ /\S/) - { - #return $formatted_command . $text; - return $text . "\n"; - } - return ''; -} - -# an comment -sub t2h_roff_comment($) -{ - my $text = shift; - my $result = ''; - while ($text) - { - $text =~ s/$;---$;/--/g; - $text =~ s/$;--$;/-/g; - $text =~ s/$;-$;/-/g; - $text =~ s/^(.*)//; - $result .= ".\\\"$1"; - $result .= "\n" if ($text =~ s/^\n//); - } - return $result; -} - -# a paragraph -sub t2h_roff_paragraph($$$$$$$$$) -{ - my $text = shift; - my $align = shift; - my $paragraph_command = shift; - my $paragraph_command_formatted = shift; - my $paragraph_number = shift; - my $format = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - return '' if ($text =~ /^\s*$/); - if (defined($paragraph_number) and defined($$paragraph_number)) - { - $$paragraph_number++; - $paragraph_command_formatted = undef if ($$paragraph_number > 1); - } - $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or - exists($special_list_commands{$format}->{$paragraph_command})); - #return $text if (defined($format) and $format eq 'multitable'); - return $text if (defined($format) and (($format eq 'multitable') or ($format eq 'quotation'))); - my $open = ".pp\n"; - if (defined($format) and (($format eq 'itemize') or ($format eq 'enumerate')) and - defined($paragraph_number) and defined($$paragraph_number) and ($$paragraph_number == 1)) - { - $open = ".lp\n"; - } - my $close = ''; - if ($align) - { - if ($align eq 'flushleft') - { - $open .= ".ad l\n"; - $close .= ".ad b\n"; - } - elsif ($align eq 'flushright') - { - $open .= ".ad r\n"; - $close .= ".ad b\n"; - } - elsif ($align eq 'center') - { - $open .= ".ce\n"; - } - } - if (defined($format) and ($format eq 'enumerate') and - defined($paragraph_number) and defined($$paragraph_number) and ($$paragraph_number == 1) and defined($number) and ($number ne '')) - { - $open .= "$number."; - } - chomp ($text); - return $open. $paragraph_command_formatted . $text . "\n" . $close; -} - -# a preformatted region -sub t2h_roff_preformatted($$$$$$$$$$) -{ - my $text = shift; - my $pre_style = shift; - my $class = shift; - my $leading_command = shift; - my $leading_command_formatted = shift; - my $preformatted_number = shift; - my $format = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - $leading_command_formatted = '' if (!defined($leading_command_formatted) or - exists($special_list_commands{$format}->{$leading_command})); - - if (defined($format) and $format eq 'multitable') - { - my $chomped = chomp($text); - my $result = '\&\fR\f(CW' . $text . '\&\fR'; - $result .= "\n" if ($chomped); - return $result; - } - return '' if ($text eq ''); - if (defined($preformatted_number) and defined($$preformatted_number)) - { - $$preformatted_number++; - $leading_command_formatted = undef if ($$preformatted_number > 1); - } - $leading_command_formatted = '' if (!defined($leading_command_formatted)); - chomp $text; - my $open = ''; - if (defined($format) and ($format eq 'enumerate') and - defined($paragraph_number) and defined($$paragraph_number) and ($$paragraph_number == 1) and defined($number) and ($number ne '')) - { - $open = "$number. "; - } - return $complex_format_map->{$class}->{'begin_region'} . $leading_command_formatted . $open . $text . $complex_format_map->{$class}->{'end_region'}; -} - -# This function formats a heading for an element -# -# argument: -# an element. It is a hash reference for a node or a sectionning command. -# The interesting keys are: -# 'text': the heading text -# 'name': the heading text without section number -# 'node': true if it is a node -# 'level': level of the element. 0 for @top, 1 for chapter, heading, -# appendix..., 2 for section and so on... -# 'tag_level': the sectionning element name, raisesections and lowersections -# taken into account -# -# relevant configuration variable: -# $NUMBER_SECTIONS -sub t2h_roff_heading($) -{ - my $element = shift; - my $name = $element->{'text'}; - if (!$element->{'node'}) - { - $name = $element->{'name'}; - } - return '' if ($element->{'name'} !~ /\S/); - my $class = $element->{'tag_level'}; - $class = 'unnumbered' if ($class eq 'top'); - $level = $element->{'level'}; - $level = 3 if (!defined($level)); - $level = 1 if ($level == 0); - my $heading = ''; - $heading = ".bp\n" if ($level == 1); - $heading .= '.if !\n(_- \{\\' . "\n.nr _- 1\n.nr \$1 0 1\n" . '.af $1 A\}' . "\n" - if ($class =~ /^appendix/); - $name = protect_spaces($name); - my $toc_entry = '\&'; - if ($class =~ /^unnumbered/ or ($class eq 'node')) - { - $heading .= ".uh $name\n"; - $toc_entry .= ' '; - } - elsif (($class =~ /section$/) or ($class eq 'chapter') or ($class =~ /^appendix/)) - { - $heading .= ".sh $level $name\n"; - my $number = 1; - while ($number < $level) - { - $toc_entry .= "\\n(\$$number."; - $number++; - } - $toc_entry .= "\\n(\$$number "; - } - $toc_entry .= $name; - return $heading . "\n" if ($class eq 'node'); - return $heading . ".(x\n" . $toc_entry . "\n.)x\n\\&\\fR\n"; -} - -sub T2H_ROFF_toc_body($$$) -{ - my $elements_list = shift; - my $do_contents = shift; - my $do_scontents = shift; - if ($do_contents or $do_scontents) - { - my $lines = ".pp\n.nr % 0 1\n.af % i\n.bp \\n%+1\n.ce\n\\&\\fB" . &$I('Table of Contents') . "\\fR\n.sp 2\n.xp\n"; - if (!$do_contents) - { - push @{$Texi2HTML::OVERVIEW}, $lines; - } - else - { - push @{$Texi2HTML::TOC_LINES}, $lines; - } - } -} - -# formatting of raw regions -# ih L2H is true another mechanism is used for tex -sub t2h_roff_raw($$) -{ - my $style = shift; - my $text = shift; - if ($style eq 'verbatim' or $style eq 'tex' or $style eq 'html') - { - chomp ($text); - return ".(l M\n\\fR\\&\\f(CW" . &$protect_text($text) . "\\fR\n.)l\n" ; - } - else - { - warn "$WARN (bug) unknown style $style\n"; - return &$protect_text($text); - } -} - -# This function formats a footnote reference and the footnote text associated -# with a given footnote. -# The footnote reference is the text appearing in the main document pointing -# to the footnote text. -# -# arguments: -# absolute number of the footnote (in the document) -# relative number of the footnote (in the page) -# identifier for the footnote -# identifier for the footnote reference in the main document -# main document file -# footnote text file -# array with the footnote text lines -# the state. See menu entry. -# -# returns: -# reference on an array containing the footnote text lines which should -# have been updated -# the text for the reference pointing on the footnote text -sub t2h_roff_foot_line_and_ref($$$$$$$) -{ - my $number_in_doc = shift; - my $number_in_page = shift; - my $footnote_id = shift; - my $place_id = shift; - my $document_file = shift; - my $footnote_file = shift; - my $lines = shift; - my $state = shift; - - my $text = ''; - my $line; - while (@$lines) - { - $line = shift @$lines; - $text .= $line; - } - chomp $text; - return ([], "\n.(f\n" . $text . "\n.)f\n" ); -} - -# formats a group of footnotes. -# -# argument: -# array reference on the footnotes texts lines -# -# returns an array reference on the group of footnotes lines -sub t2h_roff_foot_section($) -{ - my $lines = shift; - @$lines = (); -} - -# format an image -# -# arguments: -# image file name -# image basename -# a boolean true if we are in a preformatted format -sub t2h_roff_image($$$$) -{ - my $file = shift; - my $base = shift; - my $preformatted = shift; - my $file_name = shift; - return "[$base src=$file_name]" if ($base ne $file_name); - return "[$base]"; -} - -# format a target in the main document for an index entry. -# -# arguments: -# target identifier -# boolean true if in preformatted format -sub t2h_roff_index_entry_label($$$$) -{ - my $identifier = shift; - my $preformatted = shift; - my $label = shift; - my $index_name = shift; - return ".(x $index_name\n" . protect_spaces($label) . "\n.)x\n"; -} - -# process definition commands line @deffn for example -sub t2h_roff_def_line($$$$$) -{ - my $category = shift; - my $name = shift; - my $type = shift; - my $arguments = shift; - my $index_label = shift; - $index_label = '' if (!defined($index_label)); - $name = '' if (!defined($name) or ($name =~ /^\s*$/)); - $type = '' if (!defined($type) or $type =~ /^\s*$/); - if (!defined($arguments) or $arguments =~ /^\s*$/) - { - $arguments = ''; - } - else - { - $arguments = '\fI' . protect_spaces($arguments) . '\fR'; - } - my $type_name = ' '; - $type_name = " $type" if ($type ne ''); - - $type_name .= '\fB' . protect_spaces($name) . '\fR' if ($name ne ''); - $type_name .= $arguments . "\n"; - return '\fI' . protect_spaces($category) . ':\fR' . $type_name . $index_label; -} - -# a cartouche -sub t2h_roff_cartouche($$) -{ - my $text = shift; - return $text; -} - -sub t2h_roff_sp($$) -{ - my $number = shift; - my $preformatted = shift; - return "\n.sp $number\n"; -} - -# format a whole index -# -# argument: -# index text -# index name -sub t2h_roff_print_index($$) -{ - my $text = shift; - my $name = shift; - return ".xp $name\n"; -} - -# format an index summary. This is a list of letters linking to the letter -# entries. -# -# arguments: -# array reference containing the formatted alphabetical letters -# array reference containing the formatted non lphabetical letters -sub t2h_roff_index_summary($$) -{ - my $alpha = shift; - my $nonalpha = shift; - my $join = ''; - my $nonalpha_text = ''; - my $alpha_text = ''; - return ''; -} - -# FIXME the following construct leads to something wrong ? -# something @c a comment -# -# other thing -sub t2h_roff_empty_line($) -{ - my $text = shift; - return ''; -} - -sub t2h_roff_listoffloats_entry($$$$) -{ - my $style_texi = shift; - my $float = shift; - my $float_style = shift; - my $caption = shift; - my $href = shift; - chomp ($caption); - - return '.ip ' . protect_spaces($float_style) . "\n" . $caption . "\n"; -} - -sub t2h_roff_listoffloats($$$) -{ - my $style_texi = shift; - my $style = shift; - my $float_entries = shift; - - my $result = ".(l L F\n.ba +5\n"; - foreach my $float_entry (@$float_entries) - { - $result .= $float_entry; - } - return $result . ".ba -5\n.)l\n"; -} - -sub t2h_roff_float($$$$$) -{ - my $text = shift; - my $float = shift; - my $caption = shift; - my $shortcaption = shift; - - my $caption_text = ''; - - if (defined($float->{'caption_texi'})) - { - $caption_text = $caption; - } - elsif (defined($float->{'shortcaption_texi'})) - { - $caption_text = $shortcaption; - } - elsif (defined($caption)) - { - $caption_text = $caption; - } - chomp ($caption_text); - return ".(b L F\n" . $text . $caption_text . "\n.b)\n"; -} - -1; diff --git a/Build/source/utils/texi2html/examples/utf8.init b/Build/source/utils/texi2html/examples/utf8.init deleted file mode 100644 index 2d231e30a8f..00000000000 --- a/Build/source/utils/texi2html/examples/utf8.init +++ /dev/null @@ -1,27 +0,0 @@ -# -*-perl-*- -$USE_ISO = 0; -$ENCODING = 'utf-8'; - -# if the encoding isn't utf-8, we should convert to utf-8 characters. - -use Encode; -use Unicode::Normalize; - -foreach my $key (keys(%unicode_accents)) -{ - $style_map{$key}->{'function'} = \&t2h_utf8_accent; - $style_map_texi{$key}->{'function'} = \&t2h_utf8_accent; -} - -foreach my $key (%things_map) -{ - if (exists($unicode_map{$key}) and ($unicode_map{$key} ne '')) - { - $things_map{$key} = chr(hex($unicode_map{$key})); - $texi_map{$key} = chr(hex($unicode_map{$key})); - } -} - -$normal_text = \&t2h_utf8_normal_text; - -1; diff --git a/Build/source/utils/texi2html/examples/xhtml.init b/Build/source/utils/texi2html/examples/xhtml.init deleted file mode 100644 index 3343a95c935..00000000000 --- a/Build/source/utils/texi2html/examples/xhtml.init +++ /dev/null @@ -1,188 +0,0 @@ -# -*-perl-*- - -# APA: Add SystemLiteral to identify the canonical DTD. -# [Definition:] The SystemLiteral is called the entity's system -# identifier. It is a URI, which may be used to retrieve the entity. -# See http://www.xml.com/axml/target.html#NT-ExternalID -$DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/xhtml1-transitional.dtd">'; - -$FRAMESET_DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/xhtml1-frameset.dtd">'; - -# -iso -# if set, ISO8859 characters are used for special symbols (like copyright, etc) -$USE_ISO = 1; - -# horizontal rules -$SMALL_RULE = '<hr size="1"/>'; -$DEFAULT_RULE = '<hr/>'; -$MIDDLE_RULE = '<hr size="2"/>'; -$BIG_RULE = '<hr size="6"/>'; - -# this is added inside <head></head> after <title> and some <meta name> -# stuff, it can be used for eg. <style>, <script>, <meta> etc. tags. -$EXTRA_HEAD = ''; - -$print_page_head = \&T2H_XHTML_print_page_head; -$print_page_foot = \&T2H_XHTML_print_page_foot; -$print_frame = \&T2H_XHTML_print_frame; -$button_icon_img = \&T2H_XHTML_button_icon_img; - -#FIXME update once it is more stabilized in texi2html.init -sub T2H_XHTML_print_page_head -{ - my $fh = shift; - my $longtitle = "$Texi2HTML::THISDOC{'title_no_texi'}"; - $longtitle .= ": $Texi2HTML::NO_TEXI{'This'}" if exists $T2H_NO_TEXI{'This'}; - print $fh <<EOT; -<?xml version="1.0" encoding="iso-8859-1"?> -$T2H_DOCTYPE -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="$T2H_LANG" lang="$T2H_LANG"> -$T2H_THISDOC{'copying'}<!-- Created on $Texi2HTML::THISDOC{today} by $Texi2HTML::THISDOC{program} --> -<!-- -$Texi2HTML::THISDOC{program_authors} ---> -<head> -<title>$longtitle</title> - -<meta name="description" content="$longtitle"/> -<meta name="keywords" content="$longtitle"/> -<meta name="resource-type" content="document"/> -<meta name="distribution" content="global"/> -<meta name="Generator" content="$T2H_THISDOC{program}"/> -$EXTRA_HEAD -</head> - -<body $T2H_BODYTEXT> -$AFTER_BODY_OPEN -EOT -} - -# <span> instead of <font> -sub T2H_XHTML_print_page_foot -{ - my $fh = shift; - print $fh <<EOT; -<p> - <span style="font-size: smaller"> - This document was generated $ADDRESS - using <a href="$T2H_THISDOC{program_homepage}"><i>$Texi2HTML::THISDOC{program}</i></a>. - </span> - <br/> -$PRE_BODY_CLOSE -</p> -</body> -</html> -EOT -} - -sub T2H_XHTML_print_frame -{ - my $fh = shift; - my $toc_file = shift; - my $main_file = shift; - print $fh <<EOT; -$FRAMESET_DOCTYPE -<html> -<head><title>$Texi2HTML::THISDOC{title}</title></head> -<frameset cols="140,*"> - <frame name="toc" src="$toc_file"/> - <frame name="main" src="$main_file"/> -</frameset> -</html> -EOT -} - -# / in <img> -sub T2H_XHTML_button_icon_img -{ - my $button = shift; - my $icon = shift; - my $name = shift; - return '' if (!defined($icon)); - if (defined($name) && $name) - { - $name = ": $name"; - } - else - { - $name = ''; - } - $button = "" if (!defined ($button)); - return qq{<img src="$icon" border="0" alt="$button$name" align="middle"/>}; -} - -$simple_map{'*'} = '<br/>'; - -# formatting functions - -$def_line = \&t2h_xhtml_def_line; -$index_summary = \&t2h_xhtml_index_summary; -$image = \&t2h_xhtml_image; - -# need / in <img> -sub t2h_xhtml_image($$$) -{ - my $file = shift; - my $base = shift; - my $preformatted = shift; - return "[ $base ]" if ($preformatted); - return "<img src=\"$file\" alt=\"$base\"/>"; -} - -# process definition commands line @deffn for example -# <u> replaced by <span> -sub t2h_xhtml_def_line($$$$$) -{ - my $category = shift; - my $name = shift; - my $type = shift; - my $arguments = shift; - my $index_label = shift; - $index_label = '' if (!defined($index_label)); - $name = '' if (!defined($name) or ($name =~ /^\s*$/)); - $type = '' if (!defined($type) or $type =~ /^\s*$/); - if (!defined($arguments) or $arguments =~ /^\s*$/) - { - $arguments = ''; - } - else - { - $arguments = '<i>' . $arguments . '</i>'; - } - my $type_name = ''; - $type_name = " $type" if ($type ne ''); - $type_name .= ' <b>' . $name . '</b>' if ($name ne ''); - $type_name .= $arguments . "\n"; - if (! $DEF_TABLE) - { - return '<dt>'. '<span style="text-decoration: underline">' . $category . ':</span>' . $type_name . $index_label . "</dt>\n"; - } - else - { - - return "<tr>\n<td align=\"left\">" . $type_name . - "</td>\n<td align=\"right\">" . $category . $index_label . "</td>\n" . "</tr>\n"; - } -} - -# There is a br which needs / -sub t2h_xhtml_index_summary($$) -{ - my $alpha = shift; - my $nonalpha = shift; - my $join = ''; - my $nonalpha_text = ''; - my $alpha_text = ''; - $join = " \n<br/>\n" if (@$nonalpha and @$alpha); - if (@$nonalpha) - { - $nonalpha_text = join("\n \n", @$nonalpha) . "\n"; - } - if (@$alpha) - { - $alpha_text = join("\n \n", @$alpha) . "\n \n"; - } - #I18n - return "<table><tr><th valign=\"top\">Jump to: </th><td>" . - $nonalpha_text . $join . $alpha_text . '</td></tr></table>'; -} diff --git a/Build/source/utils/texi2html/i18n/de b/Build/source/utils/texi2html/i18n/de deleted file mode 100644 index fae7f1b8af8..00000000000 --- a/Build/source/utils/texi2html/i18n/de +++ /dev/null @@ -1,114 +0,0 @@ -$LANGUAGES->{'de'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '@"Uber dieses Dokument', - 'April' => 'April', - 'August' => 'August', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'Dezember', - 'February' => 'Februar', - 'Footnotes' => 'Fu@ss{}noten', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'Januar', - 'July' => 'Juli', - 'Jump to' => '', - 'June' => 'Juni', - 'March' => 'M@"arz', - 'May' => 'Mai', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'November', - 'October' => 'Oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'September', - 'Short Table of Contents' => 'Kurzes Inhaltsverzeichniss', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Inhaltsverzeichniss', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'de'} = { - 'See' => 'Siehe', - 'section' => 'Abschnitt', - 'see' => 'siehe' - }; - - diff --git a/Build/source/utils/texi2html/i18n/en b/Build/source/utils/texi2html/i18n/en deleted file mode 100644 index 4f4939fdade..00000000000 --- a/Build/source/utils/texi2html/i18n/en +++ /dev/null @@ -1,110 +0,0 @@ -$LANGUAGES->{'en'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => '', - 'August' => '', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => '', - 'February' => '', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => '', - 'Index Entry' => '', - 'January' => '', - 'July' => '', - 'Jump to' => '', - 'June' => '', - 'March' => '', - 'May' => '', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => '', - 'October' => '', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => '', - 'Short Table of Contents' => '', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '%s, %d %d', - 'Table of Contents' => '', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'en'} = {}; - - diff --git a/Build/source/utils/texi2html/i18n/es b/Build/source/utils/texi2html/i18n/es deleted file mode 100644 index 88d75f42777..00000000000 --- a/Build/source/utils/texi2html/i18n/es +++ /dev/null @@ -1,114 +0,0 @@ -$LANGUAGES->{'es'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => 'abril', - 'August' => 'agosto', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'diciembre', - 'February' => 'febrero', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'enero', - 'July' => 'julio', - 'Jump to' => '', - 'June' => 'junio', - 'March' => 'marzo', - 'May' => 'mayo', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'noviembre', - 'October' => 'octubre', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'septiembre', - 'Short Table of Contents' => 'Resumen del Contenido', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => '@\'{@dotless{I}}ndice General', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'es'} = { - 'See' => 'V@\'ease', - 'section' => 'secci@\'on', - 'see' => 'v@\'ase' - }; - - diff --git a/Build/source/utils/texi2html/i18n/fr b/Build/source/utils/texi2html/i18n/fr deleted file mode 100644 index 8ab8a3164b2..00000000000 --- a/Build/source/utils/texi2html/i18n/fr +++ /dev/null @@ -1,139 +0,0 @@ -$LANGUAGES->{'fr'} = { - ' The buttons in the navigation panels have the following meaning:' => ' Les boutons de navigation ont la signification suivante :', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => ' Dans cet exemple on est @`a @strong{ Sous section un-deux-trois } dans un document dont la structure est :', - ' Up ' => 'Plus haut', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => 'le %{day} %{month} %{year}', - '%{name} of %{class}' => '%{name} de %{class}', - '%{name} on %{class}' => '%{name} de %{class}', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '%{node_file_href} section `%{section}\' dans @cite{%{book}}', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'A propos de ce document', - 'April' => 'Avril', - 'August' => 'Ao@^ut', - 'Button' => 'Bouton', - 'Contents' => 'Table des mati@`eres', - 'Current Position' => 'Position', - 'December' => 'D@\'ecembre', - 'February' => 'F@\'evrier', - 'Footnotes' => 'Notes de bas de page', - 'From 1.2.3 go to' => 'Depuis 1.2.3 aller @`a', - 'Go to' => 'Aller @`a', - 'Index' => 'Index', - 'Index Entry' => 'Entr@\'ee d\'index', - 'January' => 'Janvier', - 'July' => 'Juillet', - 'Jump to' => 'Aller @`a', - 'June' => 'Juin', - 'March' => 'Mars', - 'May' => 'Mai', - 'Menu:' => 'Menu@ :', - 'Name' => 'Nom', - 'Next' => 'Suivant', - 'November' => 'Novembre', - 'October' => 'Octobre', - 'Overview' => 'Vue d\'ensemble', - 'Overview:' => 'Vue d\'ensemble@ :', - 'Prev' => 'Pr@\'ec@\'edent', - 'Section' => '', - 'Section One' => 'Section un', - 'See %{node_file_href}' => 'Voir %{node_file_href}', - 'See %{node_file_href} @cite{%{book}}' => 'Voir %{node_file_href} @cite{%{book}}', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => 'Voir %{node_file_href} section `%{section}\' dans @cite{%{book}}', - 'See %{reference_name}' => 'Voir %{reference_name}', - 'See @cite{%{book}}' => 'Voir @cite{%{book}}', - 'See section %{reference_name}' => 'Voir la section %{reference_name}', - 'See section `%{section}\' in @cite{%{book}}' => 'Voir la section `%{section}\' dans @cite{%{book}}', - 'September' => 'Septembre', - 'Short Table of Contents' => 'R@\'esum@\'e du contenu', - 'Subsection One-Four' => 'Sous section un-quatre', - 'Subsection One-One' => 'Sous section un-un', - 'Subsection One-Three' => 'Sous section un-trois', - 'Subsection One-Two' => 'Sous section un-deux', - 'Subsubsection One-Two-Four' => 'Sous sous section un-deux-quatre', - 'Subsubsection One-Two-One' => 'Sous sous section un-deux-un', - 'Subsubsection One-Two-Three' => 'Sous sous section un-deux-trois', - 'Subsubsection One-Two-Two' => 'Sous sous section un-deux-deux', - 'T2H_today' => 'le %2$d %1$s %3$d', - 'Table of Contents' => 'Table des mati@`eres', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} @emph{%{date}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'Top' => '', - 'Untitled Document' => 'Document sans titre', - 'about (help)' => '@`a propos (page d\'aide)', - 'beginning of this chapter or previous chapter' => 'd@\'ebut de ce chapitre ou chapitre pr@\'ec@\'edent', - 'by @emph{%{user}}' => 'par @emph{%{user}}', - 'by @emph{%{user}} on @emph{%{date}}' => 'par @emph{%{user}} @emph{%{date}}', - 'cover (top) of document' => 'couverture (top) du document', - 'current' => 'courante', - 'current section' => 'section actuelle', - 'first section in reading order' => 'premi@`e section dans l\'ordre de lecture', - 'following node' => 'node suivant', - 'index' => 'index', - 'last section in reading order' => 'derni@`ere section dans l\'ordre de lecture', - 'next chapter' => 'chapitre suivant', - 'next node' => 'node suivant', - 'next section in reading order' => 'section suivante dans l\'ordre de lecture', - 'next section on same level' => 'section suivante au m@^eme niveau', - 'node following in node reading order' => 'node suivant dans l\'ordre des nodes', - 'node up' => 'node au dessus', - 'on @emph{%{date}}' => '@emph{%{date}}', - 'previous node' => 'node pr@\'ec@\'edent', - 'previous section in reading order' => 'section pr@\'ec@\'edente dans l\'ordre de lecture', - 'previous section on same level' => 'section pr@\'ec@\'edente au m@^eme niveau', - 'section `%{section}\' in @cite{%{book}}' => 'section `%{section}\' dans @cite{%{book}}', - 'see %{node_file_href}' => 'voir %{node_file_href}', - 'see %{node_file_href} @cite{%{book}}' => 'voir %{node_file_href} @cite{%{book}}', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => 'voir %{node_file_href} section `%{section}\' dans @cite{%{book}}', - 'see %{reference_name}' => 'voir %{reference_name}', - 'see @cite{%{book}}' => 'voir @cite{%{book}}', - 'see section %{reference_name}' => 'voir la section %{reference_name}', - 'see section `%{section}\' in @cite{%{book}}' => 'voir la section `%{section}\' dans @cite{{book}}', - 'short table of contents' => 'table des mati@`eres r@\'esum@\'ee', - 'table of contents' => 'table des mati@`eres', - 'unknown' => 'inconnu', - 'up node' => 'node au dessus', - 'up section' => 'section sup@\'erieure' - }; - -$T2H_OBSOLETE_STRINGS->{'fr'} = { - ' This document was generated %{who_and_when_generated} using %{program_homepage_href}.' => ' Ce document a été généré %{who_and_when_generated} en utilisant %{program_homepage_href}.', - ' 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:' => ' Dans cet exemple on est à <strong> Sous section un-deux-trois </strong> dans un document dont la structure est :', - '%{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => '%{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'See' => 'Voir', - 'See %{node_file_href} <cite>%{book}</cite>' => 'Voir %{node_file_href} <cite>%{book}</cite>', - 'See %{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => 'Voir %{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'See <cite>%{book}</cite>' => 'Voir <cite>%{book}</cite>', - 'See section `%{section}\' in <cite>%{book}</cite>' => 'Voir la section `%{section}\' dans <cite>%{book}</cite>', - 'This document was generated by <i>%{user}</i> on <i>%{date}</i> using %{program_homepage_href}.' => 'Ce document a été généré par <i>%{user}</i> <i>%{date}</i> en utilisant %{program_homepage_href}.', - 'This document was generated by <i>%{user}</i> using %{program_homepage_href}.' => 'Ce document a été généré par <i>%{user}</i> en utilisant %{program_homepage_href}.', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} @emph{%{date}} en utilisant %{program_homepage_href}.', - 'This document was generated by @emph{%{user}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} en utilisant %{program_homepage_href}.', - 'This document was generated on <i>%{date}</i> using %{program_homepage_href}.' => 'Ce document a été généré <i>%{date}</i> en utilisant %{program_homepage_href}.', - 'This document was generated on @emph{%{date}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e @emph{%{date}} en utilisant %{program_homepage_href}.', - 'This document was generated on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e @emph{%{date}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e en utilisant %{program_homepage_href}.', - 'about (this page)' => 'a propos (cette page)', - 'by <i>%{user}</i>' => 'par <i>%{user}</i>', - 'by <i>%{user}</i> on <i>%{date}</i>' => 'par <i>%{user}</i> <i>%{date}</i>', - 'concept index' => 'index', - 'on <i>%{date}</i>' => '<i>%{date}</i>', - 'section' => 'section', - 'section `%{section}\' in <cite>%{book}</cite>' => 'section `%{section}\' dans <cite>%{book}</cite>', - 'see' => 'voir', - 'see %{node_file_href} <cite>%{book}</cite>' => 'voir %{node_file_href} <cite>%{book}</cite>', - 'see %{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => 'voir %{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'see <cite>%{book}</cite>' => 'voir <cite>%{book}</cite>', - 'see section `%{section}\' in <cite>%{book}</cite>' => 'voir la section `%{section}\' dans <cite>%{book}</cite>' - }; - - diff --git a/Build/source/utils/texi2html/i18n/nl b/Build/source/utils/texi2html/i18n/nl deleted file mode 100644 index b9e9d7b30a1..00000000000 --- a/Build/source/utils/texi2html/i18n/nl +++ /dev/null @@ -1,114 +0,0 @@ -$LANGUAGES->{'nl'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'No translation available!', - 'April' => 'April', - 'August' => 'Augustus', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'December', - 'February' => 'Februari', - 'Footnotes' => 'No translation available!', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'Januari', - 'July' => 'Juli', - 'Jump to' => '', - 'June' => 'Juni', - 'March' => 'Maart', - 'May' => 'Mei', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'November', - 'October' => 'Oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'September', - 'Short Table of Contents' => 'Korte inhoudsopgave', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Inhoudsopgave', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'nl'} = { - 'See' => 'Zie', - 'section' => 'sectie', - 'see' => 'zie' - }; - - diff --git a/Build/source/utils/texi2html/i18n/no b/Build/source/utils/texi2html/i18n/no deleted file mode 100644 index 62b6632d6ed..00000000000 --- a/Build/source/utils/texi2html/i18n/no +++ /dev/null @@ -1,114 +0,0 @@ -$LANGUAGES->{'no'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'No translation available!', - 'April' => 'april', - 'August' => 'august', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'desember', - 'February' => 'februar', - 'Footnotes' => 'No translation available!', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Indeks', - 'Index Entry' => '', - 'January' => 'januar', - 'July' => 'juli', - 'Jump to' => '', - 'June' => 'juni', - 'March' => 'mars', - 'May' => 'mai', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'november', - 'October' => 'oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'september', - 'Short Table of Contents' => 'Kort innholdsfortegnelse', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Innholdsfortegnelse', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'no'} = { - 'See' => 'Se', - 'section' => 'avsnitt', - 'see' => 'se' - }; - - diff --git a/Build/source/utils/texi2html/i18n/pt b/Build/source/utils/texi2html/i18n/pt deleted file mode 100644 index 79cb65afda7..00000000000 --- a/Build/source/utils/texi2html/i18n/pt +++ /dev/null @@ -1,114 +0,0 @@ -$LANGUAGES->{'pt'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => 'Abril', - 'August' => 'Agosto', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'Dezembro', - 'February' => 'Fevereiro', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => '@\'Indice', - 'Index Entry' => '', - 'January' => 'Janeiro', - 'July' => 'Julho', - 'Jump to' => '', - 'June' => 'Junho', - 'March' => 'Mar@,{c}o', - 'May' => 'Maio', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'Novembro', - 'October' => 'Outubro', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'Setembro', - 'Short Table of Contents' => 'Breve Sum@\'ario', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Sum@\'ario', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'pt'} = { - 'See' => 'Veja', - 'section' => 'Se@,{c}@~ao', - 'see' => 'veja' - }; - - diff --git a/Build/source/utils/texi2html/images/COPYING b/Build/source/utils/texi2html/images/COPYING deleted file mode 100644 index dd6b4c19032..00000000000 --- a/Build/source/utils/texi2html/images/COPYING +++ /dev/null @@ -1,6 +0,0 @@ -Copyright (C) 2003 Free Software Foundation, Inc. -These images are licensed under the Creative Commons Attribution-ShareAlike -License. To view a copy of this license, visit -http://creativecommons.org/licenses/by-sa/1.0/ -or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, -California 94305, USA. diff --git a/Build/source/utils/texi2html/images/Mybg.gif b/Build/source/utils/texi2html/images/Mybg.gif Binary files differdeleted file mode 100644 index 2d95e205845..00000000000 --- a/Build/source/utils/texi2html/images/Mybg.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_begin.gif b/Build/source/utils/texi2html/images/a_begin.gif Binary files differdeleted file mode 100644 index 63c80099ff4..00000000000 --- a/Build/source/utils/texi2html/images/a_begin.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_begin_na.gif b/Build/source/utils/texi2html/images/a_begin_na.gif Binary files differdeleted file mode 100644 index cff097f9e18..00000000000 --- a/Build/source/utils/texi2html/images/a_begin_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_document.gif b/Build/source/utils/texi2html/images/a_document.gif Binary files differdeleted file mode 100644 index 7f5576bd322..00000000000 --- a/Build/source/utils/texi2html/images/a_document.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_document_na.gif b/Build/source/utils/texi2html/images/a_document_na.gif Binary files differdeleted file mode 100644 index faf92d8c45e..00000000000 --- a/Build/source/utils/texi2html/images/a_document_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_empty.gif b/Build/source/utils/texi2html/images/a_empty.gif Binary files differdeleted file mode 100644 index 5843e432264..00000000000 --- a/Build/source/utils/texi2html/images/a_empty.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_end.gif b/Build/source/utils/texi2html/images/a_end.gif Binary files differdeleted file mode 100644 index 6900869902a..00000000000 --- a/Build/source/utils/texi2html/images/a_end.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_end_na.gif b/Build/source/utils/texi2html/images/a_end_na.gif Binary files differdeleted file mode 100644 index 818fe6c9a5e..00000000000 --- a/Build/source/utils/texi2html/images/a_end_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_help.gif b/Build/source/utils/texi2html/images/a_help.gif Binary files differdeleted file mode 100644 index dcb99fa904c..00000000000 --- a/Build/source/utils/texi2html/images/a_help.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_help_na.gif b/Build/source/utils/texi2html/images/a_help_na.gif Binary files differdeleted file mode 100644 index 2dd565df0a0..00000000000 --- a/Build/source/utils/texi2html/images/a_help_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_index.gif b/Build/source/utils/texi2html/images/a_index.gif Binary files differdeleted file mode 100644 index b1306b1c3cb..00000000000 --- a/Build/source/utils/texi2html/images/a_index.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_index_na.gif b/Build/source/utils/texi2html/images/a_index_na.gif Binary files differdeleted file mode 100644 index c3f663ca1cd..00000000000 --- a/Build/source/utils/texi2html/images/a_index_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_left.gif b/Build/source/utils/texi2html/images/a_left.gif Binary files differdeleted file mode 100644 index 0a28d9671cf..00000000000 --- a/Build/source/utils/texi2html/images/a_left.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_left_na.gif b/Build/source/utils/texi2html/images/a_left_na.gif Binary files differdeleted file mode 100644 index 00ef49ff78a..00000000000 --- a/Build/source/utils/texi2html/images/a_left_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_leftdouble.gif b/Build/source/utils/texi2html/images/a_leftdouble.gif Binary files differdeleted file mode 100644 index 6221b203c59..00000000000 --- a/Build/source/utils/texi2html/images/a_leftdouble.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_leftdouble_na.gif b/Build/source/utils/texi2html/images/a_leftdouble_na.gif Binary files differdeleted file mode 100644 index ffb2857df8f..00000000000 --- a/Build/source/utils/texi2html/images/a_leftdouble_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_page.gif b/Build/source/utils/texi2html/images/a_page.gif Binary files differdeleted file mode 100644 index 7d744f9129a..00000000000 --- a/Build/source/utils/texi2html/images/a_page.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_page_na.gif b/Build/source/utils/texi2html/images/a_page_na.gif Binary files differdeleted file mode 100644 index 8e97093765f..00000000000 --- a/Build/source/utils/texi2html/images/a_page_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_right.gif b/Build/source/utils/texi2html/images/a_right.gif Binary files differdeleted file mode 100644 index 80596f8f042..00000000000 --- a/Build/source/utils/texi2html/images/a_right.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_right_na.gif b/Build/source/utils/texi2html/images/a_right_na.gif Binary files differdeleted file mode 100644 index b4a217b89a2..00000000000 --- a/Build/source/utils/texi2html/images/a_right_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_rightdouble.gif b/Build/source/utils/texi2html/images/a_rightdouble.gif Binary files differdeleted file mode 100644 index a539dd712ce..00000000000 --- a/Build/source/utils/texi2html/images/a_rightdouble.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_rightdouble_na.gif b/Build/source/utils/texi2html/images/a_rightdouble_na.gif Binary files differdeleted file mode 100644 index 0f4f4e9284a..00000000000 --- a/Build/source/utils/texi2html/images/a_rightdouble_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_search.gif b/Build/source/utils/texi2html/images/a_search.gif Binary files differdeleted file mode 100644 index 4ba1c159b8d..00000000000 --- a/Build/source/utils/texi2html/images/a_search.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_search_na.gif b/Build/source/utils/texi2html/images/a_search_na.gif Binary files differdeleted file mode 100644 index 7339e8df3e0..00000000000 --- a/Build/source/utils/texi2html/images/a_search_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_searchdoc.gif b/Build/source/utils/texi2html/images/a_searchdoc.gif Binary files differdeleted file mode 100644 index c378f8467dc..00000000000 --- a/Build/source/utils/texi2html/images/a_searchdoc.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_searchdoc_na.gif b/Build/source/utils/texi2html/images/a_searchdoc_na.gif Binary files differdeleted file mode 100644 index fb761ed471d..00000000000 --- a/Build/source/utils/texi2html/images/a_searchdoc_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_tableofcon.gif b/Build/source/utils/texi2html/images/a_tableofcon.gif Binary files differdeleted file mode 100644 index 3ea3b2e8ee8..00000000000 --- a/Build/source/utils/texi2html/images/a_tableofcon.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_tableofcon_na.gif b/Build/source/utils/texi2html/images/a_tableofcon_na.gif Binary files differdeleted file mode 100644 index dba67d35eb4..00000000000 --- a/Build/source/utils/texi2html/images/a_tableofcon_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_top.gif b/Build/source/utils/texi2html/images/a_top.gif Binary files differdeleted file mode 100644 index 467b36e6837..00000000000 --- a/Build/source/utils/texi2html/images/a_top.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_top_na.gif b/Build/source/utils/texi2html/images/a_top_na.gif Binary files differdeleted file mode 100644 index 51fe09a5ee1..00000000000 --- a/Build/source/utils/texi2html/images/a_top_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_up.gif b/Build/source/utils/texi2html/images/a_up.gif Binary files differdeleted file mode 100644 index 44bc961ba74..00000000000 --- a/Build/source/utils/texi2html/images/a_up.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/a_up_na.gif b/Build/source/utils/texi2html/images/a_up_na.gif Binary files differdeleted file mode 100644 index 2744a57818d..00000000000 --- a/Build/source/utils/texi2html/images/a_up_na.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/bg.jpg b/Build/source/utils/texi2html/images/bg.jpg Binary files differdeleted file mode 100644 index 409df67444a..00000000000 --- a/Build/source/utils/texi2html/images/bg.jpg +++ /dev/null diff --git a/Build/source/utils/texi2html/images/bg_left.gif b/Build/source/utils/texi2html/images/bg_left.gif Binary files differdeleted file mode 100644 index 3a03de5c986..00000000000 --- a/Build/source/utils/texi2html/images/bg_left.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/bg_right.gif b/Build/source/utils/texi2html/images/bg_right.gif Binary files differdeleted file mode 100644 index 89e5e4f5da8..00000000000 --- a/Build/source/utils/texi2html/images/bg_right.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_dir.gif b/Build/source/utils/texi2html/images/blue_dir.gif Binary files differdeleted file mode 100644 index 6b687bd946c..00000000000 --- a/Build/source/utils/texi2html/images/blue_dir.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_down.gif b/Build/source/utils/texi2html/images/blue_down.gif Binary files differdeleted file mode 100644 index 384430222ba..00000000000 --- a/Build/source/utils/texi2html/images/blue_down.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_grab.gif b/Build/source/utils/texi2html/images/blue_grab.gif Binary files differdeleted file mode 100644 index 8a4f23875dc..00000000000 --- a/Build/source/utils/texi2html/images/blue_grab.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_help.gif b/Build/source/utils/texi2html/images/blue_help.gif Binary files differdeleted file mode 100644 index fb08df470b4..00000000000 --- a/Build/source/utils/texi2html/images/blue_help.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_next.gif b/Build/source/utils/texi2html/images/blue_next.gif Binary files differdeleted file mode 100644 index 1c8c97edbb1..00000000000 --- a/Build/source/utils/texi2html/images/blue_next.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_nnext.gif b/Build/source/utils/texi2html/images/blue_nnext.gif Binary files differdeleted file mode 100644 index 12cf4aab438..00000000000 --- a/Build/source/utils/texi2html/images/blue_nnext.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_pprev.gif b/Build/source/utils/texi2html/images/blue_pprev.gif Binary files differdeleted file mode 100644 index 0a80d24a5d7..00000000000 --- a/Build/source/utils/texi2html/images/blue_pprev.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_prev.gif b/Build/source/utils/texi2html/images/blue_prev.gif Binary files differdeleted file mode 100644 index 07e88e65375..00000000000 --- a/Build/source/utils/texi2html/images/blue_prev.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_readme.gif b/Build/source/utils/texi2html/images/blue_readme.gif Binary files differdeleted file mode 100644 index 787758a0472..00000000000 --- a/Build/source/utils/texi2html/images/blue_readme.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_top.gif b/Build/source/utils/texi2html/images/blue_top.gif Binary files differdeleted file mode 100644 index e222a4eb07f..00000000000 --- a/Build/source/utils/texi2html/images/blue_top.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_up.gif b/Build/source/utils/texi2html/images/blue_up.gif Binary files differdeleted file mode 100644 index 4867dd3c079..00000000000 --- a/Build/source/utils/texi2html/images/blue_up.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/blue_uup.gif b/Build/source/utils/texi2html/images/blue_uup.gif Binary files differdeleted file mode 100644 index 2cbce64ee0e..00000000000 --- a/Build/source/utils/texi2html/images/blue_uup.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/contents_motif.gif b/Build/source/utils/texi2html/images/contents_motif.gif Binary files differdeleted file mode 100644 index 7b3c904b289..00000000000 --- a/Build/source/utils/texi2html/images/contents_motif.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/index_motif.gif b/Build/source/utils/texi2html/images/index_motif.gif Binary files differdeleted file mode 100644 index b9b3108aa82..00000000000 --- a/Build/source/utils/texi2html/images/index_motif.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/next_motif.gif b/Build/source/utils/texi2html/images/next_motif.gif Binary files differdeleted file mode 100644 index 7a2dbe955e0..00000000000 --- a/Build/source/utils/texi2html/images/next_motif.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/next_motif_gr.gif b/Build/source/utils/texi2html/images/next_motif_gr.gif Binary files differdeleted file mode 100644 index 1416b1c10d9..00000000000 --- a/Build/source/utils/texi2html/images/next_motif_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/previous_motif.gif b/Build/source/utils/texi2html/images/previous_motif.gif Binary files differdeleted file mode 100644 index aef90f1fc49..00000000000 --- a/Build/source/utils/texi2html/images/previous_motif.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/previous_motif_gr.gif b/Build/source/utils/texi2html/images/previous_motif_gr.gif Binary files differdeleted file mode 100644 index c6acaabc97d..00000000000 --- a/Build/source/utils/texi2html/images/previous_motif_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/spacer3.gif b/Build/source/utils/texi2html/images/spacer3.gif Binary files differdeleted file mode 100644 index 0f7d451a9f9..00000000000 --- a/Build/source/utils/texi2html/images/spacer3.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_contents.gif b/Build/source/utils/texi2html/images/xy_contents.gif Binary files differdeleted file mode 100644 index 2864102d4af..00000000000 --- a/Build/source/utils/texi2html/images/xy_contents.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_foot.gif b/Build/source/utils/texi2html/images/xy_foot.gif Binary files differdeleted file mode 100644 index 04a365bf56a..00000000000 --- a/Build/source/utils/texi2html/images/xy_foot.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_next.gif b/Build/source/utils/texi2html/images/xy_next.gif Binary files differdeleted file mode 100644 index 945aaf05e70..00000000000 --- a/Build/source/utils/texi2html/images/xy_next.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_next_gr.gif b/Build/source/utils/texi2html/images/xy_next_gr.gif Binary files differdeleted file mode 100644 index 8289ed154cb..00000000000 --- a/Build/source/utils/texi2html/images/xy_next_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_nextsection.gif b/Build/source/utils/texi2html/images/xy_nextsection.gif Binary files differdeleted file mode 100644 index 8a7bb0a3681..00000000000 --- a/Build/source/utils/texi2html/images/xy_nextsection.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_nextsection_gr.gif b/Build/source/utils/texi2html/images/xy_nextsection_gr.gif Binary files differdeleted file mode 100644 index adb336b45fe..00000000000 --- a/Build/source/utils/texi2html/images/xy_nextsection_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_previous.gif b/Build/source/utils/texi2html/images/xy_previous.gif Binary files differdeleted file mode 100644 index 43a8db284a1..00000000000 --- a/Build/source/utils/texi2html/images/xy_previous.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_previous_gr.gif b/Build/source/utils/texi2html/images/xy_previous_gr.gif Binary files differdeleted file mode 100644 index 979831742d0..00000000000 --- a/Build/source/utils/texi2html/images/xy_previous_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_previoussection.gif b/Build/source/utils/texi2html/images/xy_previoussection.gif Binary files differdeleted file mode 100644 index 736fffec195..00000000000 --- a/Build/source/utils/texi2html/images/xy_previoussection.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_previoussection_gr.gif b/Build/source/utils/texi2html/images/xy_previoussection_gr.gif Binary files differdeleted file mode 100644 index c0de3e3495a..00000000000 --- a/Build/source/utils/texi2html/images/xy_previoussection_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_up.gif b/Build/source/utils/texi2html/images/xy_up.gif Binary files differdeleted file mode 100644 index 56c8bae0fe6..00000000000 --- a/Build/source/utils/texi2html/images/xy_up.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/images/xy_up_gr.gif b/Build/source/utils/texi2html/images/xy_up_gr.gif Binary files differdeleted file mode 100644 index 6da635ac7b5..00000000000 --- a/Build/source/utils/texi2html/images/xy_up_gr.gif +++ /dev/null diff --git a/Build/source/utils/texi2html/install-sh b/Build/source/utils/texi2html/install-sh deleted file mode 100755 index e9de23842dc..00000000000 --- a/Build/source/utils/texi2html/install-sh +++ /dev/null @@ -1,251 +0,0 @@ -#!/bin/sh -# -# install - install a program, script, or datafile -# This comes from X11R5 (mit/util/scripts/install.sh). -# -# Copyright 1991 by the Massachusetts Institute of Technology -# -# Permission to use, copy, modify, distribute, and sell this software and its -# documentation for any purpose is hereby granted without fee, provided that -# the above copyright notice appear in all copies and that both that -# copyright notice and this permission notice appear in supporting -# documentation, and that the name of M.I.T. not be used in advertising or -# publicity pertaining to distribution of the software without specific, -# written prior permission. M.I.T. makes no representations about the -# suitability of this software for any purpose. It is provided "as is" -# without express or implied warranty. -# -# Calling this script install-sh is preferred over install.sh, to prevent -# `make' implicit rules from creating a file called install from it -# when there is no Makefile. -# -# This script is compatible with the BSD install script, but was written -# from scratch. It can only install one file at a time, a restriction -# shared with many OS's install programs. - - -# set DOITPROG to echo to test this script - -# Don't use :- since 4.3BSD and earlier shells don't like it. -doit="${DOITPROG-}" - - -# put in absolute paths if you don't have them in your path; or use env. vars. - -mvprog="${MVPROG-mv}" -cpprog="${CPPROG-cp}" -chmodprog="${CHMODPROG-chmod}" -chownprog="${CHOWNPROG-chown}" -chgrpprog="${CHGRPPROG-chgrp}" -stripprog="${STRIPPROG-strip}" -rmprog="${RMPROG-rm}" -mkdirprog="${MKDIRPROG-mkdir}" - -transformbasename="" -transform_arg="" -instcmd="$mvprog" -chmodcmd="$chmodprog 0755" -chowncmd="" -chgrpcmd="" -stripcmd="" -rmcmd="$rmprog -f" -mvcmd="$mvprog" -src="" -dst="" -dir_arg="" - -while [ x"$1" != x ]; do - case $1 in - -c) instcmd="$cpprog" - shift - continue;; - - -d) dir_arg=true - shift - continue;; - - -m) chmodcmd="$chmodprog $2" - shift - shift - continue;; - - -o) chowncmd="$chownprog $2" - shift - shift - continue;; - - -g) chgrpcmd="$chgrpprog $2" - shift - shift - continue;; - - -s) stripcmd="$stripprog" - shift - continue;; - - -t=*) transformarg=`echo $1 | sed 's/-t=//'` - shift - continue;; - - -b=*) transformbasename=`echo $1 | sed 's/-b=//'` - shift - continue;; - - *) if [ x"$src" = x ] - then - src=$1 - else - # this colon is to work around a 386BSD /bin/sh bug - : - dst=$1 - fi - shift - continue;; - esac -done - -if [ x"$src" = x ] -then - echo "install: no input file specified" - exit 1 -else - true -fi - -if [ x"$dir_arg" != x ]; then - dst=$src - src="" - - if [ -d $dst ]; then - instcmd=: - chmodcmd="" - else - instcmd=mkdir - fi -else - -# Waiting for this to be detected by the "$instcmd $src $dsttmp" command -# might cause directories to be created, which would be especially bad -# if $src (and thus $dsttmp) contains '*'. - - if [ -f $src -o -d $src ] - then - true - else - echo "install: $src does not exist" - exit 1 - fi - - if [ x"$dst" = x ] - then - echo "install: no destination specified" - exit 1 - else - true - fi - -# If destination is a directory, append the input filename; if your system -# does not like double slashes in filenames, you may need to add some logic - - if [ -d $dst ] - then - dst="$dst"/`basename $src` - else - true - fi -fi - -## this sed command emulates the dirname command -dstdir=`echo $dst | sed -e 's,[^/]*$,,;s,/$,,;s,^$,.,'` - -# Make sure that the destination directory exists. -# this part is taken from Noah Friedman's mkinstalldirs script - -# Skip lots of stat calls in the usual case. -if [ ! -d "$dstdir" ]; then -defaultIFS=' -' -IFS="${IFS-${defaultIFS}}" - -oIFS="${IFS}" -# Some sh's can't handle IFS=/ for some reason. -IFS='%' -set - `echo ${dstdir} | sed -e 's@/@%@g' -e 's@^%@/@'` -IFS="${oIFS}" - -pathcomp='' - -while [ $# -ne 0 ] ; do - pathcomp="${pathcomp}${1}" - shift - - if [ ! -d "${pathcomp}" ] ; - then - $mkdirprog "${pathcomp}" - else - true - fi - - pathcomp="${pathcomp}/" -done -fi - -if [ x"$dir_arg" != x ] -then - $doit $instcmd $dst && - - if [ x"$chowncmd" != x ]; then $doit $chowncmd $dst; else true ; fi && - if [ x"$chgrpcmd" != x ]; then $doit $chgrpcmd $dst; else true ; fi && - if [ x"$stripcmd" != x ]; then $doit $stripcmd $dst; else true ; fi && - if [ x"$chmodcmd" != x ]; then $doit $chmodcmd $dst; else true ; fi -else - -# If we're going to rename the final executable, determine the name now. - - if [ x"$transformarg" = x ] - then - dstfile=`basename $dst` - else - dstfile=`basename $dst $transformbasename | - sed $transformarg`$transformbasename - fi - -# don't allow the sed command to completely eliminate the filename - - if [ x"$dstfile" = x ] - then - dstfile=`basename $dst` - else - true - fi - -# Make a temp file name in the proper directory. - - dsttmp=$dstdir/#inst.$$# - -# Move or copy the file name to the temp name - - $doit $instcmd $src $dsttmp && - - trap "rm -f ${dsttmp}" 0 && - -# and set any options; do chmod last to preserve setuid bits - -# If any of these fail, we abort the whole thing. If we want to -# ignore errors from any of these, just make sure not to ignore -# errors from the above "$doit $instcmd $src $dsttmp" command. - - if [ x"$chowncmd" != x ]; then $doit $chowncmd $dsttmp; else true;fi && - if [ x"$chgrpcmd" != x ]; then $doit $chgrpcmd $dsttmp; else true;fi && - if [ x"$stripcmd" != x ]; then $doit $stripcmd $dsttmp; else true;fi && - if [ x"$chmodcmd" != x ]; then $doit $chmodcmd $dsttmp; else true;fi && - -# Now rename the file to the real destination. - - $doit $rmcmd -f $dstdir/$dstfile && - $doit $mvcmd $dsttmp $dstdir/$dstfile - -fi && - - -exit 0 diff --git a/Build/source/utils/texi2html/l2h.init b/Build/source/utils/texi2html/l2h.init deleted file mode 100644 index 6ee3c32387d..00000000000 --- a/Build/source/utils/texi2html/l2h.init +++ /dev/null @@ -1,168 +0,0 @@ - -###################################################################### -# from here on, its l2h init stuff -# - -## initialization for latex2html as for Singular manual generation -## obachman 3/99 - -# -# Options controlling Titles, File-Names, Tracing and Sectioning -# -$TITLE = ''; - -$SHORTEXTN = 0; - -$LONG_TITLES = 0; - -$DESTDIR = ''; - -$NO_SUBDIR = 1; - -$PREFIX = ''; - -$AUTO_PREFIX = 0; - -$AUTO_LINK = 0; - -$SPLIT = 0; - -$MAX_LINK_DEPTH = 0; - -$TMP = ''; - -$DEBUG = 0; - -$VERBOSE = 1; - -# -# Options controlling Extensions and Special Features -# -#$HTML_VERSION = "3.2"; # set by command line - -$TEXDEFS = 1; # we absolutely need that - -$EXTERNAL_FILE = ''; - -$SCALABLE_FONTS = 1; - -$NO_SIMPLE_MATH = 1; - -$LOCAL_ICONS = 1; - -$SHORT_INDEX = 0; - -$NO_FOOTNODE = 1; - -$ADDRESS = ''; - -$INFO = ''; - -# -# Switches controlling Image Generation -# -$ASCII_MODE = 0; - -$NOLATEX = 0; - -$EXTERNAL_IMAGES = 0; - -$PS_IMAGES = 0; - -$NO_IMAGES = 0; - -$IMAGES_ONLY = 0; - -$REUSE = 2; - -$ANTI_ALIAS = 1; - -$ANTI_ALIAS_TEXT = 1; - -# -#Switches controlling Navigation Panels -# -$NO_NAVIGATION = 1; -$ADDRESS = ''; -$INFO = 0; # 0 = do not make a "About this document..." section - -# -#Switches for Linking to other documents -# -# currently -- we don't care - -$MAX_SPLIT_DEPTH = 0; # Stop making separate files at this depth - -$MAX_LINK_DEPTH = 0; # Stop showing child nodes at this depth - -$NOLATEX = 0; # 1 = do not pass unknown environments to Latex - -$EXTERNAL_IMAGES = 0; # 1 = leave the images outside the document - -$ASCII_MODE = 0; # 1 = do not use any icons or internal images - -# 1 = use links to external postscript images rather than inlined bitmap -# images. -$PS_IMAGES = 0; -$SHOW_SECTION_NUMBERS = 0; - -### Other global variables ############################################### -$CHILDLINE = ""; - -# This is the line width measured in pixels and it is used to right justify -# equations and equation arrays; -$LINE_WIDTH = 500; - -# Used in conjunction with AUTO_NAVIGATION -$WORDS_IN_PAGE = 300; - -# The value of this variable determines how many words to use in each -# title that is added to the navigation panel (see below) -# -$WORDS_IN_NAVIGATION_PANEL_TITLES = 0; - -# This number will determine the size of the equations, special characters, -# and anything which will be converted into an inlined image -# *except* "image generating environments" such as "figure", "table" -# or "minipage". -# Effective values are those greater than 0. -# Sensible values are between 0.1 - 4. -$MATH_SCALE_FACTOR = 1.5; - -# This number will determine the size of -# image generating environments such as "figure", "table" or "minipage". -# Effective values are those greater than 0. -# Sensible values are between 0.1 - 4. -$FIGURE_SCALE_FACTOR = 1.6; - - -# If both of the following two variables are set then the "Up" button -# of the navigation panel in the first node/page of a converted document -# will point to $EXTERNAL_UP_LINK. $EXTERNAL_UP_TITLE should be set -# to some text which describes this external link. -$EXTERNAL_UP_LINK = ""; -$EXTERNAL_UP_TITLE = ""; - -# If this is set then the resulting HTML will look marginally better if viewed -# with Netscape. -$NETSCAPE_HTML = 1; - -# Valid paper sizes are "letter", "legal", "a4","a3","a2" and "a0" -# Paper sizes has no effect other than in the time it takes to create inlined -# images and in whether large images can be created at all ie -# - larger paper sizes *MAY* help with large image problems -# - smaller paper sizes are quicker to handle -$PAPERSIZE = "a4"; - -# Replace "english" with another language in order to tell LaTeX2HTML that you -# want some generated section titles (eg "Table of Contents" or "References") -# to appear in a different language. Currently only "english" and "french" -# is supported but it is very easy to add your own. See the example in the -# file "latex2html.config" -$TITLES_LANGUAGE = "english"; - -1; # This must be the last non-comment line - -# End File l2h.init -###################################################################### - diff --git a/Build/source/utils/texi2html/manage_i18n.pl b/Build/source/utils/texi2html/manage_i18n.pl deleted file mode 100755 index 8b9621d6af6..00000000000 --- a/Build/source/utils/texi2html/manage_i18n.pl +++ /dev/null @@ -1,397 +0,0 @@ -#! /usr/bin/perl -w -#+############################################################################## -# -# manage_i18n.pl: manage translation files -# -# Copyright (C) 2003 Free Software Foundation, Inc. -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, 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 -# -#-############################################################################## - -# This requires perl version 5 or higher -require 5.0; - -use strict; -#use vars qw( -# $T2H_LANGUAGES -#); - -use File::Copy; -use Data::Dumper; - -select(STDERR); -$| = 1; -select(STDOUT); -$| = 1; - -my $language; -my $i18n_dir = 'i18n'; # name of the directory containing the per language files -my $translation_file = 'translations.pl'; # file containing all the translations -my @known_languages = ('en', 'de', 'nl', 'es', 'no', 'pt', 'fr'); # The supported - # languages -#my $template = 'template'; -my $template = 'en'; -my $template_file = "$i18n_dir/$template"; -my @source_files = ('texi2html.pl', 'texi2html.init', 'T2h_i18n.pm', - 'examples/roff.init', 'examples/noheaders.init'); - -use vars qw( -$LANGUAGES -$T2H_OBSOLETE_STRINGS -); - -# Strings not in code -my $template_strings = -{ - 'January' => '', - 'February' => '', - 'March' => '', - 'April' => '', - 'May' => '', - 'June' => '', - 'July' => '', - 'August' => '', - 'September' => '', - 'October' => '', - 'November' => '', - 'December' => '', - 'T2H_today' => '%s, %d %d', -}; - -# Handle per language files -$Data::Dumper::Sortkeys = 1; - -if (@ARGV < 1) -{ - die "Need at least one arg\n"; -} - -my $command = shift @ARGV; - -sub update_language_file($); - -die "No suitable $i18n_dir directory\n" unless (-d $i18n_dir and -r $i18n_dir); - -sub get_languages -{ - unless (opendir DIR, $i18n_dir) - { - die "Cannot open dir $i18n_dir: $!\n"; - } - my @languages = grep { - ! /^\./ && - ! /\.(bak|orig|old|dpkg-old|rpmnew|rpmsave)$/ && - ! /~$/ && - ! /^#.*#$/ && - -f $i18n_dir . '/' . $_ - } readdir DIR; - closedir DIR; - my @known = @known_languages; - foreach my $lang (@languages) - { - if (grep {$_ eq $lang} @known) - { - @known = grep {$_ ne $lang} @known; - } - else - { - warn "Remark: you could update the known languages array for `$lang'\n"; - } - } - warn "Remark: the following known languages have no corresponding file: @known\n" if (@known); - return @languages; -} - -sub manage_i18n_files($) -{ - my $command = shift; - if ($command eq 'update') - { - update_i18n_files(); - } - elsif ($command eq 'merge') - { - merge_i18n_files(); - } - elsif ($command eq 'template') - { - update_template(@source_files); - } - elsif ($command eq 'all') - { - update_template(@source_files); - update_i18n_files(); - merge_i18n_files(); - } - else - { - warn "Unknown i18n command: $command\n"; - } - exit 0; -} - -sub merge_i18n_files -{ - my @languages = get_languages(); - die "No languages found\n" unless (@languages); - if (-f $translation_file) - { - unless (File::Copy::copy ($translation_file, "$translation_file.old")) - { - die "Error copying $translation_file to $translation_file.old\n"; - } - } - #foreach my $lang ($template, @known_languages) - die "open $translation_file failed" unless (open (TRANSLATIONS, ">$translation_file")); - foreach my $lang (@languages) - { - my $file = "$i18n_dir/$lang"; - next unless (-r $file); - unless (open (FILE, $file)) - { - warn "open $file failed: $!\n"; - return; - } - while (<FILE>) - { - print TRANSLATIONS; - } - close FILE; - } -} - -sub update_language_hash($$$) -{ - my $file = shift; - my $lang = shift; - my $reference = shift; - if (-f $file) - { - eval { require($file) ;}; - if ($@) - { - warn "require $file failed: $@\n"; - return; - } - unless (File::Copy::copy ($file, "$file.old")) - { - warn "Error copying $file to $file.old\n"; - return; - } - if (!defined($LANGUAGES->{$lang})) - { - warn "LANGUAGES->{$lang} not defined in $file\n"; - return; - } - } - if (!defined($T2H_OBSOLETE_STRINGS->{$lang})) - { - $T2H_OBSOLETE_STRINGS->{$lang} = {}; - } - if (!defined($LANGUAGES->{$lang})) - { - $LANGUAGES->{$lang} = {}; - } - - foreach my $string (keys %{$LANGUAGES->{$lang}}) - { - $T2H_OBSOLETE_STRINGS->{$lang}->{$string} = $LANGUAGES->{$lang}->{$string} - if (defined($LANGUAGES->{$lang}->{$string}) and ($LANGUAGES->{$lang}->{$string} ne '')); - } - - $LANGUAGES->{$lang} = {}; - - foreach my $string (keys (%{$reference})) - { - if (exists($T2H_OBSOLETE_STRINGS->{$lang}->{$string}) and - defined($T2H_OBSOLETE_STRINGS->{$lang}->{$string}) and - ($T2H_OBSOLETE_STRINGS->{$lang}->{$string} ne '')) - { - $LANGUAGES->{$lang}->{$string} = $T2H_OBSOLETE_STRINGS->{$lang}->{$string}; - delete $T2H_OBSOLETE_STRINGS->{$lang}->{$string}; - } - else - { - $LANGUAGES->{$lang}->{$string} = ''; - } - } - return 1; -} - -sub update_i18n_files -{ - die "No suitable $i18n_dir directory\n" unless (-d $i18n_dir and -w $i18n_dir); - #my @languages = @known_languages; - my @languages = get_languages(); - if (@ARGV) - { - @languages = (); - foreach my $lang (@ARGV) - { - unless (grep {$lang eq $_} @known_languages) - { - #warn "Unsupported language `$lang'\n"; - #next; - warn "Remark: you could update the known languages array for `$lang'\n"; - } - push (@languages, $lang) unless (grep {$lang eq $_} @languages); - } - } - unless (@languages) - { - warn "No languages to update\n" ; - return; - } - die "$template_file not readable\n" unless (-r $template_file); - eval { require($template_file) ;}; - if ($@) - { - die "require $template_file failed: $@\n"; - } - die "LANGUAGE->{'en'} undef after require $template_file\n" unless - (defined($LANGUAGES) and defined($LANGUAGES->{'en'})); - foreach my $string (keys(%$template_strings)) - { - die "template string $string undef" unless (defined($LANGUAGES->{'en'}->{$string})); - } - foreach my $lang (@languages) - { - update_language_file($lang); - } - return 1; -} - -sub update_language_file($) -{ - my $lang = shift; - #unless (grep {$lang eq $_} @known_languages) - #{ - # print STDERR "Unsupported language `$lang'\n"; - # return; - #} - my $file = "$i18n_dir/$lang"; - - return unless (update_language_hash($file, $lang, $LANGUAGES->{'en'})); - - unless (open (FILE, ">$file")) - { - warn "open $file failed: $!\n"; - return; - } - - - print FILE "" . Data::Dumper->Dump([$LANGUAGES->{$lang}], [ "LANGUAGES->{'$lang'}" ]); - print FILE "\n"; - print FILE Data::Dumper->Dump([$T2H_OBSOLETE_STRINGS->{$lang}], [ "T2H_OBSOLETE_STRINGS->{'$lang'}"]); - print FILE "\n"; - print FILE "\n"; - close FILE; -} - -sub update_template (@) -{ - my $source_strings = {}; - foreach my $source_file (@_) - { - unless (-r $source_file) - { - warn "$source_file not readable\n"; - next; - } - unless (open (FILE, "$source_file")) - { - warn "open $source_file failed: $!\n"; - next; - } - my $line_nr = 0; - while (<FILE>) - { - $line_nr++; - my $string; - next if /^\s*#/; - while ($_) - { - if (defined($string)) - { - if (s/^([^\\']*)(\\|')//) - { - $string .= $1 if (defined($1)); - if ($2 eq "'") - { - $source_strings->{$string} = '' ; - $string = undef; - } - else - { - if (s/^(.)//) - { - #$string .= '\\' . $1; - $string .= $1; - } - else - { - warn "\\ at end of line, file $source_file, line nr $line_nr\n"; - $source_strings->{$string} = '' ; - $string = undef; - } - } - } - else - { - warn "string not closed file $source_file, line nr $line_nr\n"; - $source_strings->{$string} = '' ; - $string = undef; - } - } - elsif (s/^.*?&\$I\s*\('//) - { - $string = ''; - } - else - { - last; - } - } - } - close FILE; - } - foreach my $string (keys (%$template_strings)) - { - $source_strings->{$string} = $template_strings->{$string}; - } - die unless(update_language_hash($template_file, 'en', $source_strings)); - foreach my $string (keys(%$template_strings)) - { # use values in template_srings if it exists - $LANGUAGES->{'en'}->{$string} = $template_strings->{$string} if ($LANGUAGES->{'en'}->{$string} eq ''); - } - unless (open (TEMPLATE, ">$template_file")) - { - die "open $template_file failed: $!\n"; - } - print TEMPLATE "" . Data::Dumper->Dump([$LANGUAGES->{'en'}], [ "LANGUAGES->{'en'}" ]); - print TEMPLATE "\n"; - if (keys(%{$T2H_OBSOLETE_STRINGS->{'en'}})) - { - print TEMPLATE Data::Dumper->Dump([$T2H_OBSOLETE_STRINGS->{'en'}], [ "T2H_OBSOLETE_STRINGS->{'en'}"]); - print TEMPLATE "\n"; - print TEMPLATE "\n"; - } - close TEMPLATE; -} - -manage_i18n_files($command); - -1; diff --git a/Build/source/utils/texi2html/mdate-sh b/Build/source/utils/texi2html/mdate-sh deleted file mode 100755 index 0c88e758b8c..00000000000 --- a/Build/source/utils/texi2html/mdate-sh +++ /dev/null @@ -1,92 +0,0 @@ -#!/bin/sh -# Get modification time of a file or directory and pretty-print it. -# Copyright 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/missing b/Build/source/utils/texi2html/missing deleted file mode 100755 index 5f9da90636f..00000000000 --- a/Build/source/utils/texi2html/missing +++ /dev/null @@ -1,265 +0,0 @@ -#! /bin/sh -# Common stub for a few missing GNU programs while installing. -# Copyright 1996, 1997, 1999, 2000 Free Software Foundation, Inc. -# Originally by Fran,cois Pinard <pinard@iro.umontreal.ca>, 1996. - -# 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. - -if test $# -eq 0; then - echo 1>&2 "Try \`$0 --help' for more information" - exit 1 -fi - -run=: - -case "$1" in ---run) - # Try to run requested program, and just exit if it succeeds. - run= - shift - "$@" && exit 0 - ;; -esac - -# If it does not exist, or fails to run (possibly an outdated version), -# try to emulate it. -case "$1" in - - -h|--h|--he|--hel|--help) - echo "\ -$0 [OPTION]... PROGRAM [ARGUMENT]... - -Handle \`PROGRAM [ARGUMENT]...' for when PROGRAM is missing, or return an -error status if there is no known handling for PROGRAM. - -Options: - -h, --help display this help and exit - -v, --version output version information and exit - --run try to run the given command, and emulate it if it fails - -Supported PROGRAM values: - aclocal touch file \`aclocal.m4' - autoconf touch file \`configure' - autoheader touch file \`config.h.in' - automake touch all \`Makefile.in' files - bison create \`y.tab.[ch]', if possible, from existing .[ch] - flex create \`lex.yy.c', if possible, from existing .c - help2man touch the output file - lex create \`lex.yy.c', if possible, from existing .c - makeinfo touch the output file - tar try tar, gnutar, gtar, then tar without non-portable flags - yacc create \`y.tab.[ch]', if possible, from existing .[ch]" - ;; - - -v|--v|--ve|--ver|--vers|--versi|--versio|--version) - echo "missing 0.3 - GNU automake" - ;; - - -*) - echo 1>&2 "$0: Unknown \`$1' option" - echo 1>&2 "Try \`$0 --help' for more information" - exit 1 - ;; - - aclocal) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified \`acinclude.m4' or \`configure.in'. You might want - to install the \`Automake' and \`Perl' packages. Grab them from - any GNU archive site." - touch aclocal.m4 - ;; - - autoconf) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified \`configure.in'. You might want to install the - \`Autoconf' and \`GNU m4' packages. Grab them from any GNU - archive site." - touch configure - ;; - - autoheader) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified \`acconfig.h' or \`configure.in'. You might want - to install the \`Autoconf' and \`GNU m4' packages. Grab them - from any GNU archive site." - files=`sed -n 's/^[ ]*A[CM]_CONFIG_HEADER(\([^)]*\)).*/\1/p' configure.in` - test -z "$files" && files="config.h" - touch_files= - for f in $files; do - case "$f" in - *:*) touch_files="$touch_files "`echo "$f" | - sed -e 's/^[^:]*://' -e 's/:.*//'`;; - *) touch_files="$touch_files $f.in";; - esac - done - touch $touch_files - ;; - - automake) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified \`Makefile.am', \`acinclude.m4' or \`configure.in'. - You might want to install the \`Automake' and \`Perl' packages. - Grab them from any GNU archive site." - find . -type f -name Makefile.am -print | - sed 's/\.am$/.in/' | - while read f; do touch "$f"; done - ;; - - bison|yacc) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified a \`.y' file. You may need the \`Bison' package - in order for those modifications to take effect. You can get - \`Bison' from any GNU archive site." - rm -f y.tab.c y.tab.h - if [ $# -ne 1 ]; then - eval LASTARG="\${$#}" - case "$LASTARG" in - *.y) - SRCFILE=`echo "$LASTARG" | sed 's/y$/c/'` - if [ -f "$SRCFILE" ]; then - cp "$SRCFILE" y.tab.c - fi - SRCFILE=`echo "$LASTARG" | sed 's/y$/h/'` - if [ -f "$SRCFILE" ]; then - cp "$SRCFILE" y.tab.h - fi - ;; - esac - fi - if [ ! -f y.tab.h ]; then - echo >y.tab.h - fi - if [ ! -f y.tab.c ]; then - echo 'main() { return 0; }' >y.tab.c - fi - ;; - - lex|flex) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified a \`.l' file. You may need the \`Flex' package - in order for those modifications to take effect. You can get - \`Flex' from any GNU archive site." - rm -f lex.yy.c - if [ $# -ne 1 ]; then - eval LASTARG="\${$#}" - case "$LASTARG" in - *.l) - SRCFILE=`echo "$LASTARG" | sed 's/l$/c/'` - if [ -f "$SRCFILE" ]; then - cp "$SRCFILE" lex.yy.c - fi - ;; - esac - fi - if [ ! -f lex.yy.c ]; then - echo 'main() { return 0; }' >lex.yy.c - fi - ;; - - help2man) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified a dependency of a manual page. You may need the - \`Help2man' package in order for those modifications to take - effect. You can get \`Help2man' from any GNU archive site." - - file=`echo "$*" | sed -n 's/.*-o \([^ ]*\).*/\1/p'` - if test -z "$file"; then - file=`echo "$*" | sed -n 's/.*--output=\([^ ]*\).*/\1/p'` - fi - if [ -f "$file" ]; then - touch $file - else - test -z "$file" || exec >$file - echo ".ab help2man is required to generate this page" - exit 1 - fi - ;; - - makeinfo) - echo 1>&2 "\ -WARNING: \`$1' is missing on your system. You should only need it if - you modified a \`.texi' or \`.texinfo' file, or any other file - indirectly affecting the aspect of the manual. The spurious - call might also be the consequence of using a buggy \`make' (AIX, - DU, IRIX). You might want to install the \`Texinfo' package or - the \`GNU make' package. Grab either from any GNU archive site." - file=`echo "$*" | sed -n 's/.*-o \([^ ]*\).*/\1/p'` - if test -z "$file"; then - file=`echo "$*" | sed 's/.* \([^ ]*\) *$/\1/'` - file=`sed -n '/^@setfilename/ { s/.* \([^ ]*\) *$/\1/; p; q; }' $file` - fi - touch $file - ;; - - tar) - shift - if test -n "$run"; then - echo 1>&2 "ERROR: \`tar' requires --run" - exit 1 - fi - - # We have already tried tar in the generic part. - # Look for gnutar/gtar before invocation to avoid ugly error - # messages. - if (gnutar --version > /dev/null 2>&1); then - gnutar ${1+"$@"} && exit 0 - fi - if (gtar --version > /dev/null 2>&1); then - gtar ${1+"$@"} && exit 0 - fi - firstarg="$1" - if shift; then - case "$firstarg" in - *o*) - firstarg=`echo "$firstarg" | sed s/o//` - tar "$firstarg" ${1+"$@"} && exit 0 - ;; - esac - case "$firstarg" in - *h*) - firstarg=`echo "$firstarg" | sed s/h//` - tar "$firstarg" ${1+"$@"} && exit 0 - ;; - esac - fi - - echo 1>&2 "\ -WARNING: I can't seem to be able to run \`tar' with the given arguments. - You may want to install GNU tar or Free paxutils, or check the - command line arguments." - exit 1 - ;; - - *) - echo 1>&2 "\ -WARNING: \`$1' is needed, and you do not seem to have it handy on your - system. You might have modified some files without having the - proper tools for further handling them. Check the \`README' file, - it often tells you about the needed prerequirements for installing - this package. You may also peek at any GNU archive site, in case - some other package would contain this missing \`$1' program." - exit 1 - ;; -esac - -exit 0 diff --git a/Build/source/utils/texi2html/missing-texi2html b/Build/source/utils/texi2html/missing-texi2html deleted file mode 100755 index f212eebf73d..00000000000 --- a/Build/source/utils/texi2html/missing-texi2html +++ /dev/null @@ -1,96 +0,0 @@ -#! /bin/sh -# Common stub for a few missing GNU programs while installing. -# Copyright 1996, 1997, 1999, 2000 Free Software Foundation, Inc. -# Originally by Fran,cois Pinard <pinard@iro.umontreal.ca>, 1996. - -# 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. - -if test $# -eq 0; then - echo 1>&2 "Try \`$0 --help' for more information" - exit 1 -fi - -run=: - -case "$1" in ---run) - # Try to run requested program, and just exit if it succeeds. - run= - shift - "$@" && exit 0 - ;; -esac - -# If it does not exist, or fails to run (possibly an outdated version), -# try to emulate it. -case "$1" in - - -h|--h|--he|--hel|--help) - echo "\ -$0 [OPTION]... PROGRAM [ARGUMENT]... - -Handle \`PROGRAM [ARGUMENT]...' for when PROGRAM is missing, or return an -error status if there is no known handling for PROGRAM. - -Options: - -h, --help display this help and exit - -v, --version output version information and exit - --run try to run the given command, and emulate it if it fails - -Supported PROGRAM values: - texi2html touch output file" - ;; - - -v|--v|--ve|--ver|--vers|--versi|--versio|--version) - echo "missing 0.3 - GNU automake (modified in texi2html)" - ;; - - -*) - echo 1>&2 "$0: Unknown \`$1' option" - echo 1>&2 "Try \`$0 --help' for more information" - exit 1 - ;; - - */texi2html) - echo 1>&2 "\ -WARNING: \`$1' is missing or broken on your system. You should only - need it if you modified \`texi2html.info'. You might want to install - the \`Perl' package. Grab it from any GNU archive site." - if test -z "$2"; then - echo 1>&2 "ERROR: No output file specified!" - exit 1 - fi - while test -n "$3"; do - shift - done - file=`echo "$2" |sed 's/\.texi$/.html/'` - file=`echo "$file" |sed 's/\.texinfo$/.html/'` - touch "$file" - ;; - - *) - echo 1>&2 "\ -WARNING: \`$1' is needed, and you do not seem to have it handy on your - system. You might have modified some files without having the - proper tools for further handling them. Check the \`README' file, - it often tells you about the needed prerequirements for installing - this package. You may also peek at any GNU archive site, in case - some other package would contain this missing \`$1' program." - exit 1 - ;; -esac - -exit 0 diff --git a/Build/source/utils/texi2html/mkinstalldirs b/Build/source/utils/texi2html/mkinstalldirs deleted file mode 100755 index 8fa2502116c..00000000000 --- a/Build/source/utils/texi2html/mkinstalldirs +++ /dev/null @@ -1,40 +0,0 @@ -#! /bin/sh -# mkinstalldirs --- make directory hierarchy -# Author: Noah Friedman <friedman@prep.ai.mit.edu> -# Created: 1993-05-16 -# Public domain - -# $Id: mkinstalldirs,v 1.2 2001/05/01 21:33:44 dprice Exp $ - -errstatus=0 - -for file -do - set fnord `echo ":$file" | sed -ne 's/^:\//#/;s/^://;s/\// /g;s/^#/\//;p'` - shift - - pathcomp= - for d - do - pathcomp="$pathcomp$d" - case "$pathcomp" in - -* ) pathcomp=./$pathcomp ;; - esac - - if test ! -d "$pathcomp"; then - echo "mkdir $pathcomp" - - mkdir "$pathcomp" || lasterr=$? - - if test ! -d "$pathcomp"; then - errstatus=$lasterr - fi - fi - - pathcomp="$pathcomp/" - done -done - -exit $errstatus - -# mkinstalldirs ends here diff --git a/Build/source/utils/texi2html/texi2html.1.in b/Build/source/utils/texi2html/texi2html.1.in deleted file mode 100644 index 8f270f6adee..00000000000 --- a/Build/source/utils/texi2html/texi2html.1.in +++ /dev/null @@ -1,164 +0,0 @@ -.TH TEXI2HTML 1 "@PACKAGE_DATE@" -.AT 3 -.SH NAME -texi2html \- a Texinfo to HTML converter -.SH SYNOPSIS -.B texi2html [options] file -.SH DESCRIPTION -.I Texi2html -converts the given Texinfo file to a set of HTML files. It tries to handle -most of the Texinfo commands. It creates hypertext links for cross-references, -footnotes... -.PP -.I Texi2html -may furthermore use latex2html to generate HTML (code and/or images) for @math -and @iftex tags (see the -.B \-\-l2h -option). -.PP -.I Texi2html -creates several files depending on the contents of the Texinfo file and on -the chosen options (see FILES). -.PP -The HTML files created by -.I texi2html -are closer to TeX than to Info. -.SH OPTIONS -Options may be abbreviated to th shortests unique prefix. The -following is only an incomplete list of the available options: -.TP 12 -.B \-\-help [1|2] -Print usage instructions and list the most important, all relevant, -or all recognised (including obsolete) command-line options, and exit. -.TP -.B \-\-ifinfo \-\-iftex \-\-ifxml \-\-ifplaintext \-\-ifhtml -Expand @ifinfo, @iftex and @tex, @ifxml and @xml, @ifplaintext, -@ifhtml and @html regions, and don't expand @ifnot -corresponding regions (default: ifhtml). -.TP -.B \-\-no\-ifinfo \-\-no\-iftex \-\-no\-ifxml \-\-no\-ifplaintext \-\-no\-html -Don't expand @ifinfo, @iftex, @ifxml, @ifplaintext regions and expand -@ifnot corresponding regions. -.TP -.B \-I \fIdir\fP -Append \fIdir\fP to the directory list searched for included files. -.TP -.B \-P \fIdir\fP -Prepend \fIdir\fP to the directory list searched for included files. -.TP -.B \-\-no\-menu -Don't show the Texinfo menus; by default they are shown. -.TP -.B \-\-no\-number -Don't number the sections. -.TP -.B \-\-split chapter|section|node -Split the output into several HTML files (one per main chapter/section or node). -.TP -.B \-\-l2h -Use latex2html for content of @math and @tex tags. Content must be such that -both, latex and tex, can translate it correctly. I.e., no tex-only constructs -must be used. -.TP -.B \-\-l2h\-l2h \fIprog\fP -Use \fIprog\fP as latex2html program (default \fIlatex2html\fP). -Program must be executable. -.TP -.B \-\-l2h\-init \fIfile\fP -Use \fIfile\fP as latex2html init file. \fIfile\fP should be used to specify in which way latex2html handles mathematical expressions and formulas. - -Note that latex2html locates -(and uses) init-files in the following order (provided they exist): -(1) global init file (usually in latex2html source dir) -(2) $HOME/.latex2html_init -(3) ./.latex2html_init -(4) init file given on command line. -.TP -.B \-\-l2h\-tmp \fIdir\fP -Use \fIdir\fP as tmp dir for latex2html. This directory (resp. its path) -must not contain a dot (i.e., a "."). -.TP -.B \-\-l2h\-clean -remove all intermediate files generated by latex2html (prevents caching!) -.TP -.B \-\-l2h\-skip -Do not really run latex2html. Use (kept) files of previous runs, instead. -.TP -.B \-\-Verbose -Give a verbose output. -.TP -.B \-\-version -Print version and exit. -.PP -.SH FILES -Initialisation options are read first from @sysconfdir@/texi2html/Config -(the exact location being changeable with the -.RI --sysconfdir= dir -option to the configure script), then from $HOME/.texi2html/Config, -then any command-line options including \-\-init\-file options; -with later settings overriding earlier ones. -.P -By default -.I texi2html -my creates the following files (foo being the name of the Texinfo file): -.TP 16 -.B foo_toc.html -The table of contents (if @contents is present). -.TP -.B foo.html -The document's contents or the Top element. -.TP -.B foo_fot.html -The footnotes (if any). -.TP -.B foo_abt.html -An help section. -.TP -.B foo_l2h_img* -Images generated by latex2html (if any). -.PP -When used with the -.B \-\-split -option, it creates several files (one per chapter or node), named -.B foo_n.html -(n being the index of the chapter or node), and the -.B foo.html -file contains the Top element. -.PP -Otherwise it creates only one file: -.B foo.html -.SH VERSION -This is \fItexi2html\fP version @PACKAGE_VERSION@, @PACKAGE_DATE@. -.SH AUTHOR -Texi2html was originally written by is Lionel Cons, CERN IT/DIS/OSE, -Lionel.Cons@cern.ch. Over time, many other people around the net -contributed to this program. Its current maintainer is Olaf Bachmann, -obachman@mathematik.uni-kl.de. -.SH AVAILABILITY -The latest version of this program, as well as support in the form of mailing -lists with archives, bug tracking, documentation, and other tools can be found -at: - http://texi2html.cvshome.org/ -.SH COPYRIGHT -Copyright \(co 1999, 2000, 2003 Free Software Foundation, Inc. -There is NO warranty. You may redistribute this software -under the terms of the GNU General Public License. -For more information about these matters, see the file named COPYING. -.SH "SEE ALSO" -GNU Texinfo Documentation Format -.br -http://texinfo.org/ -.br -World Wide Web (WWW), -HyperText Markup Language (HTML) -.br -http://www.w3.org -.br -LaTeX2HTML -.br -http://www-dsed.llnl.gov/files/programs/unix/latex2html -.SH BUGS -This man-page is not up-to-date and there exists no up-to-date documentation, yet. -Until it exists, see the beginning of the texi2html.init file for remarks about -command-line options and configurations. -.ex diff --git a/Build/source/utils/texi2html/texi2html.init b/Build/source/utils/texi2html/texi2html.init deleted file mode 100644 index 7894da96c15..00000000000 --- a/Build/source/utils/texi2html/texi2html.init +++ /dev/null @@ -1,4254 +0,0 @@ -# -*-perl-*- -###################################################################### -# File: texi2html.init -# -# Default values for command-line arguments and for various customizable -# procedures are set in this file. -# -# A copy of this file is pasted into the beginning of texi2html by -# running './configure'. -# -# Copy this file, rename it and make changes to it, if you like. -# Afterwards, load the file with command-line -# option -init-file <your_init_file> -# -# $Id: texi2html.init,v 1.81 2005/02/01 21:20:28 pertusus Exp $ - -###################################################################### -# The following variables can also be set by command-line options -# -# -# The default values are set in this file, texi2html.init and the content -# of this file is included at the beginning of the texi2html script file. -# Those values may be overrided by values set in $sysconfdir/texi2htmlrc -# and then by values set in $HOME/texi2htmlrc. -# -# command line switches may override these values, and values set in files -# specified by -init-file are also taken into account. -# values set in these files overwrite values set by the command-line -# options appearing before -init-file and might still be overwritten by -# command-line arguments following the -init-file option. - -# -debug -# The integer value specifies what kind of debugging output is generated. -$DEBUG = 0; - -# -doctype -# The value is the 'SystemLiteral' which identifies the canonical DTD -# for the document. -# Definition: The SystemLiteral is called the entity's system -# identifier. It is a URI, which may be used to retrieve the entity. -# See http://www.xml.com/axml/target.html#NT-ExternalID -$DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">'; - -# -frameset-doctype -# When frames are used, this SystemLiteral identifies the DTD used for -# the file containing the frame description. -$FRAMESET_DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd">'; - -# -test -# If this value is true, some variables which should be dynamically generated -# (the date, the user running texi2html, the version of texi2html) are set to -# fix and given values. This is usefull in case the resulting manual is -# compared with a reference. For example this is used in the tests of test.sh. -$TEST = 0; - -# -dump-texi -# This value is usefull for debugging purposes. The result of the first pass is -# put in <document name>.passtexi, the result of the second pass is put in -# <document name>.passfirst. -$DUMP_TEXI = 0; - -# -expand -# the @EXPAND array contains the expanded section names. -@EXPAND = ('html'); - -# -invisible -# This seems obsolete and is not used anywhere. -# This was a workaround for a known bug of many WWW browsers, including -# netscape. This was used to create invisible destination in anchors. -$INVISIBLE_MARK = ''; -# $INVISIBLE_MARK = ' '; - -# -iso -# if this value is true, ISO8859 characters are used for special symbols -# (like copyright, etc). -$USE_ISO = 1; - -# -I -# add a directory to the list of directories where @include files are -# searched for (besides the directory of the file). additional '-I' -# args are appended to this list. -# (APA: Don't implicitely search ., to conform with the docs!) -# my @INCLUDE_DIRS = ("."); -@INCLUDE_DIRS = (); - -# -P -# prepend a directory to the list of directories where @include files are -# searched for before the directory of the file. additional '-P' -# args are prepended to this list. -@PREPEND_DIRS = (); - -# -top-file -# This file name is used for the top-level file. -# The extension is set appropriately, if necessary. -# If empty, <basename of document>.html is used. -# Typically, you would set this to "index.html". -$TOP_FILE = ''; - -# -toc-file -# This file name is used for the table of contents. The -# extension is set appropriately, if necessary. -# If empty, <basename of document>_toc.html is used. -$TOC_FILE = ''; - -# -frames -# if the value is true, HTML 4.0 "frames" are used. -# A file describing the frame layout is generated, together with a file -# with the short table of contents. -$FRAMES = 0; - -# -menu | -nomenu -# if the value is true the Texinfo menus are shown. -$SHOW_MENU = 1; - -# -number | -nonumber -# if this is set the sections are numbered, and section names and numbers -# are used in references and menus (instead of node names). -$NUMBER_SECTIONS = 1; - -# -use-nodes -# if this is set the nodes are used as sectionning elements. -# Otherwise the nodes are incorporated in sections. -$USE_NODES = 0; - -# -node-files -# if this is set one file per node is generated, which can be a target for -# cross manual references. -$NODE_FILES = 0; - -# -split section|chapter|node|none -# if $SPLIT is set to 'section' (resp. 'chapter') one html file per section -# (resp. chapter) is generated. If $SPLIT is set to 'node' one html file per -# node or sectionning element is generated. In all these cases separate pages -# for Top, Table of content (Toc), Overview and About are generated. -# Otherwise a monolithic html file that contains the whole document is -# created. -#$SPLIT = 'section'; -$SPLIT = ''; - -# -sec-nav|-nosec-nav -# if this is set then navigation panels are printed at the beginning of each -# section. -# If the document is split at nodes then navigation panels are -# printed at the end if there were more than $WORDS_IN_PAGE words on page. -# -# If the document is split at sections this is ignored. -# -# This is most useful if you do not want to have section navigation -# with -split chapter. There will be chapter navigation panel at the -# beginning and at the end of chapters anyway. -$SECTION_NAVIGATION = 1; - -# -separated-footnotes -# if this is set footnotes are on a separated page. Otherwise they are at -# the end of each file (if the document is split). -$SEPARATED_FOOTNOTES = 1; - -# -toc-links -# if this is set, links from headings to toc entries are created. -$TOC_LINKS = 0; - -# -subdir -# If this is set, then put result files into the specified directory. -# If not set, then result files are put into the current directory. -#$SUBDIR = 'html'; -$SUBDIR = ''; - -# -short-extn -# If this is set, then all HTML files will have extension ".htm" instead of -# ".html". This is helpful when shipping the document to DOS-based systems. -$SHORTEXTN = 0; - -# -prefix -# This set the output file prefix, prepended to all .html, .gif and .pl files. -# By default, this is the basename of the document. -$PREFIX = ''; - -# -o filename -# If this is set a monolithic document is outputted into $filename. -$OUT = ''; - -# -no-validate -# suppress node cross-reference validation -$NOVALIDATE = 0; - -# -short-ref -# if this is set cross-references are given without section numbers. -$SHORT_REF = ''; - -# -idx-sum -# if value is set, then for each @printindex <index name> -# <document name>_<index name>.idx is created which contains lines of the form -# key ref sorted alphabetically (case matters). -$IDX_SUMMARY = 0; - -# -def-table -# If this is set a table construction for @def.... instead of definition -# lists. -# (New Option: 27.07.2000 Karl Heinz Marbaise) -$DEF_TABLE = 0; - -# -verbose -# if this is set chatter about what we are doing. -$VERBOSE = ''; - -# -lang -# FIXME this has changed -# For page titles use $Texi2HTML::I18n::WORDS->{$T2H_LANG}->{...} as title. -# To add a new language, supply list of titles (see $Texi2HTML::I18n::WORDS). -# and use ISO 639 language codes (see e.g. perl module Locale-Codes-1.02 -# for definitions). -# Default's to 'en' if not set or no @documentlanguage is specified. -$LANG = 'en'; - -# -ignore-preamble-text -# If this is set the text before @node and sectionning commands is ignored. -$IGNORE_PREAMBLE_TEXT = 0; - -# -html-xref-prefix -# base directory for external manuals. -#$EXTERNAL_DIR = '../'; -$EXTERNAL_DIR = undef; - -# -l2h -# if this is set, latex2html is used for generation of math content. -$L2H = ''; - -# -css-include -# All the specified css files are used. More precisely the @import sections -# are added to the beginning of the CSS_LINES the remaining is added at -# the end of the CSS_LINES (after the css rules generated by texi2html). -# cf texinfo manual for more info. -# - means STDIN -@CSS_FILES = (); - -###################### -# The following options are only relevant if $L2H is set -# -# -l2h-l2h -# name/location of latex2html program -$L2H_L2H = "latex2html"; - -# -l2h-skip -# If this is set the actual call to latex2html is skipped. The previously -# generated content is reused, instead. -$L2H_SKIP = ''; - -# -l2h-tmp -# If this is set l2h uses the specified directory for temporary files. The path -# leading to this directory may not contain a dot (i.e., a "."); -# otherwise, l2h will fail. -$L2H_TMP = ''; - -# -l2h-file -# If set, l2h uses the file as latex2html init file -$L2H_FILE = 'l2h.init'; - -# -l2h-clean -# if this is set the intermediate files generated by texi2html in relation with -# latex2html are cleaned (they all have the prefix <document name>_l2h_). -$L2H_CLEAN = 1; - -############################################################################## -# -# The following can only be set in the init file -# -############################################################################## - -# If true do table of contents even if there is no @content -$DO_CONTENTS = 0; -# If true do short table of contents even if there is no @shortcontent -$DO_SCONTENTS = 0; - -# if set, then use node names in menu entries, instead of section names -$NODE_NAME_IN_MENU = 0; - -# new style for crossrefs -$NEW_CROSSREF_STYLE = 1; - -# if set and menu entry equals menu description, then do not print -# menu description. -# Likewise, if node name equals entry name, do not print entry name. -$AVOID_MENU_REDUNDANCY = 1; - -# if set, center @image by default -# otherwise, do not center by default -$CENTER_IMAGE = 1; - -# used as identation for block enclosing command @example, etc -# If not empty, must be enclosed in <td></td> -$EXAMPLE_INDENT_CELL = '<td> </td>'; - -# same as above, only for @small -$SMALL_EXAMPLE_INDENT_CELL = '<td> </td>'; - -# font size for @small -$SMALL_FONT_SIZE = '-1'; - -# horizontal rules -$SMALL_RULE = '<hr size="1">'; -$DEFAULT_RULE = '<hr>'; -$MIDDLE_RULE = '<hr size="2">'; -$BIG_RULE = '<hr size="6">'; - -# if non-empty, and no @..heading appeared in Top node, then -# use this as header for top node/section, otherwise use value of -# @settitle or @shorttitle (in that order) -$TOP_HEADING = ''; - -# if set, use this chapter for 'Index' button, else -# use first chapter with @printindex -$INDEX_CHAPTER = ''; - -# if set and $SPLIT is set, then split index pages at the next letter -# after they have more than that many entries -$SPLIT_INDEX = 100; - -# symbol put at the beginning of nodes entry in menu (and optionnaly of -# unnumbered in menus, see next variable) -$MENU_SYMBOL = '•'; -#$MENU_SYMBOL = '*'; - -$OPEN_QUOTE_SYMBOL = "\`"; -$CLOSE_QUOTE_SYMBOL = "'"; - -# if true put a $MENU_SYMBOL before unnumbered in menus -$UNNUMBERED_SYMBOL_IN_MENU = 0; - -# extension for nodes files when NODE_FILES is true -$NODE_FILE_EXTENSION = "html"; - -# extension -$EXTENSION = "html"; - -# file name used for Top node when NODE_FILES is true -$TOP_NODE_FILE = "index"; - -# this controls the pre style for menus -$MENU_PRE_STYLE = 'font-family: serif'; - -# This controls the ul style for toc -$TOC_LIST_STYLE = 'list-style: none'; -$TOC_LIST_ATTRIBUTE = ' class="toc"'; - -# These lines are inserted before and after the shortcontents -$BEFORE_OVERVIEW = "<div class=\"shortcontents\">\n"; -$AFTER_OVERVIEW = "</div>\n"; - -# These lines are inserted before and after the contents -$BEFORE_TOC_LINES = "<div class=\"contents\">\n"; -$AFTER_TOC_LINES = "</div>\n"; - -# if set (e.g., to index.html) replace hrefs to this file -# (i.e., to index.html) by ./ -$HREF_DIR_INSTEAD_FILE = ''; - -# text inserted after <body ...> -$AFTER_BODY_OPEN = ''; - -# text inserted before </body>, this will be automatically inside <p></p> -$PRE_BODY_CLOSE = ''; - -# this is added inside <head></head> after <title> and some <meta name> -# stuff, it can be used for eg. <style>, <script>, <meta> etc. tags. -$EXTRA_HEAD = ''; - -# Specifies the minimum page length required before a navigation panel -# is placed at the bottom of a page -# FIXME this is not true: -# THIS_WORDS_IN_PAGE holds number of words of current page -$WORDS_IN_PAGE = 300; - -# if this is set a vertical navigation panel is used. -$VERTICAL_HEAD_NAVIGATION = 0; - -# html version for latex2html -$L2H_HTML_VERSION = "4.0"; - -# specify in this array which "buttons" should appear in which order -# in the navigation panel for sections; use ' ' for empty buttons (space) -@SECTION_BUTTONS = - ( - 'Back', 'Forward', ' ', 'FastBack', 'Up', 'FastForward', - ' ', ' ', ' ', ' ', - 'Top', 'Contents', 'Index', 'About', - ); - -# buttons for misc stuff -@MISC_BUTTONS = ('Top', 'Contents', 'Index', 'About'); - -# buttons for chapter file footers -# (and headers but only if SECTION_NAVIGATION is false) -@CHAPTER_BUTTONS = - ( - 'FastBack', 'FastForward', ' ', - ' ', ' ', ' ', ' ', - 'Top', 'Contents', 'Index', 'About', - ); - -# buttons for section file footers -@SECTION_FOOTER_BUTTONS = - ( - 'Back', 'Forward', ' ', 'FastBack', 'Up', 'FastForward' - ); - -@NODE_FOOTER_BUTTONS = - ( - 'Back', 'Forward', ' ', 'FastBack', 'Up', 'FastForward', - ' ', ' ', ' ', ' ', - 'Top', 'Contents', 'Index', 'About', -# 'Back', 'Forward', ' ', 'FastBack', 'Up', 'FastForward' - ); - -$ICONS = 0; - -# insert here name of icon images for buttons -# Icons are used, if $ICONS and resp. value are set -%ACTIVE_ICONS = - ( - 'Top', '', - 'Contents', '', - 'Overview', '', - 'Index', '', - 'This', '', - 'Back', '', - 'FastBack', '', - 'Prev', '', - 'Up', '', - 'Next', '', - 'NodeUp', '', - 'NodeNext', '', - 'NodePrev', '', - 'Following', '', - 'Forward', '', - 'FastForward', '', - 'About' , '', - 'First', '', - 'Last', '', - ' ', '' - ); - -# insert here name of icon images for these, if button is inactive -%PASSIVE_ICONS = - ( - 'Top', '', - 'Contents', '', - 'Overview', '', - 'Index', '', - 'This', '', - 'Back', '', - 'FastBack', '', - 'Prev', '', - 'Up', '', - 'Next', '', - 'NodeUp', '', - 'NodeNext', '', - 'NodePrev', '', - 'Following', '', - 'Forward', '', - 'FastForward', '', - 'About', '', - 'First', '', - 'Last', '', - ); - - -$init_out = \&t2h_default_init_out; -$finish_out = \&t2h_default_finish_out; - -# We have to do this dynamically because of internationalization and because -# in body $LANG could be used. -sub t2h_default_init_out() -{ -# Names of text as alternative for icons - %NAVIGATION_TEXT = - ( - 'Top', &$I('Top'), - 'Contents', &$I('Contents'), - 'Overview', &$I('Overview'), - 'Index', &$I('Index'), - ' ', ' ', - 'This', &$I('current'), - 'Back', ' < ', - 'FastBack', ' << ', - 'Prev', &$I('Prev'), - 'Up', &$I(' Up '), - 'Next', &$I('Next'), - 'NodeUp', &$I('node up'), - 'NodeNext', &$I('next node'), - 'NodePrev', &$I('previous node'), - 'Following', &$I('following node'), - 'Forward', ' > ', - 'FastForward', ' >> ', - 'About', ' ? ', - 'First', ' |< ', - 'Last', ' >| ' - ); - - %BUTTONS_GOTO = - ( - 'Top', &$I('cover (top) of document'), - 'Contents', &$I('table of contents'), - 'Overview', &$I('short table of contents'), - 'Index', &$I('index'), - 'This', &$I('current section'), - 'Back', &$I('previous section in reading order'), - 'FastBack', &$I('beginning of this chapter or previous chapter'), - 'Prev', &$I('previous section on same level'), - 'Up', &$I('up section'), - 'Next', &$I('next section on same level'), - 'NodeUp', &$I('up node'), - 'NodeNext', &$I('next node'), - 'NodePrev', &$I('previous node'), - 'Following', &$I('node following in node reading order'), - 'Forward', &$I('next section in reading order'), - 'FastForward', &$I('next chapter'), - 'About' , &$I('about (help)'), - 'First', &$I('first section in reading order'), - 'Last', &$I('last section in reading order'), - ); - # Set the default body text, inserted between <body ... > - $BODYTEXT = 'lang="' . $LANG . '" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"' unless (defined($BODYTEXT)); - if (!defined($EXTERNAL_CROSSREF_SPLIT)) - { - if ($SPLIT) - { - $EXTERNAL_CROSSREF_SPLIT = 1; - } - else - { - $EXTERNAL_CROSSREF_SPLIT = 0; - } - } - $ENCODING = $DOCUMENT_ENCODING if (!defined($ENCODING)); - my $to_encoding; - if (defined($ENCODING)) - { - $to_encoding = main::set_encoding ($ENCODING); - - if (defined($to_encoding) and defined($perl_charset_to_html{$to_encoding})) - {# FIXME is this really right ? - $ENCODING = $perl_charset_to_html{$to_encoding}; - } - elsif (defined($to_encoding)) - {# FIXME is this really right ? - $ENCODING = $to_encoding; - } - } - else - { - #$ENCODING = 'iso-8859-1'; - $ENCODING = 'us-ascii'; - } - # FIXME default might be utf8 ? - $DOCUMENT_ENCODING = 'us-ascii' if (!defined($DOCUMENT_ENCODING)); - - return $to_encoding; -}; - -sub t2h_default_finish_out() -{ -} - -####################################################################### -# -# Values guessed if not set here, set in init_out -# -####################################################################### - -$BODYTEXT = undef; - -# Formatted document encoding. If undef set to @documentencoding. If undef and -# there is no @documentencoding, set in init_out -$ENCODING = undef; - -# if undef set to @documentdescription. If there is no @documentdescription, -# set in page_head -$DOCUMENT_DESCRIPTION = undef; - -# if undef set 1 if SPLIT, to 0 otherwise -$EXTERNAL_CROSSREF_SPLIT = undef; - -######################################################################## -# Control of Page layout: -# You can make changes of the Page layout at two levels: -# 1.) For small changes, it is often enough to change the value of -# some global string/hash/array variables -# 2.) For larger changes, reimplement one of the T2H_DEFAULT_<fnc>* routines, -# give them another name, and assign them to the respective -# $<fnc> variable. - -# As a general interface, the hashes Texi2HTML::HREF, Texi2HTML::NAME, Texi2HTML::NODE, Texi2HTML::NO_TEXI, hold -# href, html-name, node-name, name after removal of texi commands of -# This -- current section (resp. html page) -# Top -- top page FIXME: ($T2H_TOP_FILE) -# Contents -- Table of contents -# Overview -- Short table of contents -# Index -- Index page -# About -- page which explain "navigation buttons" -# First -- first node -# Last -- last node -# -# Whether or not the following hash values are set, depends on the context -# (all values are w.r.t. 'This' section) -# Next -- next node of texinfo -# Prev -- previous node of texinfo -# NodeUp -- up node of texinfo -# Following -- following node in node reading order, taking menu into account -# Forward -- next node in reading order -# Back -- previous node in reading order -# Up -- parent given by sectionning commands -# FastForward -- if leave node, up and next, else next node -# FastBackward-- if leave node, up and prev, else prev node -# -# Furthermore, the following global variabels are set: -# $Texi2HTML::THISDOC{title} -- title as set by @setttile -# $Texi2HTML::THISDOC{title_no_texi} -- title without texi (without html elements) -# $Texi2HTML::THISDOC{title_texi} -- title with texinfo @-commands -# $Texi2HTML::THISDOC{fulltitle} -- full title as set by @title... -# $Texi2HTML::THISDOC{subtitle} -- subtitle as set by @subtitle -# $Texi2HTML::THISDOC{author} -- author as set by @author -# $Texi2HTML::THISDOC{copying} -- text of @copying and @end copying in comment -# -# $Texi2HTML::THISDOC{program} -- name and version of texi2html -# $Texi2HTML::THISDOC{program_homepage} -- homepage for texi2html -# $Texi2HTML::THISDOC{program_authors} -- authors of texi2html -# $Texi2HTML::THISDOC{today} -- date formatted with pretty_date -# $Texi2HTML::THISDOC{toc_file} -- table of contents file -# $Texi2HTML::THISDOC{file_base_name} -- base name of the texinfo manual file -# $Texi2HTML::THISDOC{destination_directory} - # -- directory for the resulting files -# $Texi2HTML::THISDOC{user} -- user running the script -# other $Texi2HTML::THISDOC keys corresponds with texinfo commands, the value -# being the command arg, for the following commands: -# kbdinputstyle, paragraphindent, setchapternewpage, headings, footnotestyle, -# exampleindent, firstparagraphindent, everyheading, everyfooting, -# evenheading, evenfooting, oddheading, oddfooting -# -# and pointer to arrays of lines which need to be printed by main::print_lines -# $Texi2HTML::THIS_SECTION -- lines of 'This' section -# $Texi2HTML::THIS_HEADER -- lines preceding navigation panel of 'This' section -# $Texi2HTML::OVERVIEW -- lines of short table of contents -# $Texi2HTML::TOC_LINES -- lines of table of contents -# $Texi2HTML::TITLEPAGE -- lines of title page -# -# $Texi2HTML::THIS_ELEMENT holds the element reference. -## FIXME: $T2H_TOP -- lines of Top texinfo node - -# -# There are the following subs which control the layout: -# -$print_section = \&T2H_DEFAULT_print_section; -$end_section = \&T2H_DEFAULT_end_section; -$one_section = \&T2H_DEFAULT_one_section; -$print_Top_header = \&T2H_DEFAULT_print_Top_header; -$print_Top_footer = \&T2H_DEFAULT_print_Top_footer; -$print_Top = \&T2H_DEFAULT_print_Top; -$print_Toc = \&T2H_DEFAULT_print_Toc; -$print_Overview = \&T2H_DEFAULT_print_Overview; -$print_Footnotes = \&T2H_DEFAULT_print_Footnotes; -$print_About = \&T2H_DEFAULT_print_About; -$print_misc_header = \&T2H_DEFAULT_print_misc_header; -$print_misc_footer = \&T2H_DEFAULT_print_misc_footer; -$print_misc = \&T2H_DEFAULT_print_misc; -$print_section_footer = \&T2H_DEFAULT_print_section_footer; -$print_chapter_header = \&T2H_DEFAULT_print_chapter_header; -$print_section_header = \&T2H_DEFAULT_print_section_header; -$print_chapter_footer = \&T2H_DEFAULT_print_chapter_footer; -$print_page_head = \&T2H_DEFAULT_print_page_head; -$print_page_foot = \&T2H_DEFAULT_print_page_foot; -$print_head_navigation = \&T2H_DEFAULT_print_head_navigation; -$print_foot_navigation = \&T2H_DEFAULT_print_foot_navigation; -$button_icon_img = \&T2H_DEFAULT_button_icon_img; -$print_navigation = \&T2H_DEFAULT_print_navigation; -$about_body = \&T2H_DEFAULT_about_body; -$print_frame = \&T2H_DEFAULT_print_frame; -$print_toc_frame = \&T2H_DEFAULT_print_toc_frame; -#$toc_body = \&T2H_DEFAULT_toc_body; -$titlepage = \&T2H_DEFAULT_titlepage; -$css_lines = \&T2H_DEFAULT_css_lines; -$print_redirection_page = \&T2H_DEFAULT_print_redirection_page; -$node_file_name = \&T2H_DEFAULT_node_file_name; - -######################################################################## -# Layout for html for every sections -# -sub T2H_DEFAULT_print_section -{ - my $fh = shift; - my $first_in_page = shift; - my $previous_is_top = shift; - my $buttons = \@SECTION_BUTTONS; - - if ($first_in_page and $SECTION_NAVIGATION) - { - &$print_head_navigation($fh, $buttons); - } - else - { # got to do this here, as it isn't done in print_head_navigation - main::print_lines($fh, $Texi2HTML::THIS_HEADER); - &$print_navigation($fh, $buttons) if ($SECTION_NAVIGATION); - } - my $nw = main::print_lines($fh); - if (defined $SPLIT - and (($SPLIT eq 'node') && $SECTION_NAVIGATION)) - { - &$print_foot_navigation($fh); - print $fh "$SMALL_RULE\n"; - &$print_navigation($fh, \@NODE_FOOTER_BUTTONS) if (!defined($WORDS_IN_PAGE) or (defined ($nw) - and $nw >= $WORDS_IN_PAGE)); - } -} - -sub T2H_DEFAULT_one_section($) -{ - my $fh = shift; - main::print_lines($fh, $Texi2HTML::THIS_HEADER); - main::print_lines($fh); - print $fh "$SMALL_RULE\n"; - &$print_foot_navigation($fh); - &$print_page_foot($fh); -} - -################################################################### -# Layout of top-page I recommend that you use @ifnothtml, @ifhtml, -# @html within the Top texinfo node to specify content of top-level -# page. -# -# If you enclose everything in @ifnothtml, then title, subtitle, -# author and overview is printed -# Texi2HTML::HREF of Next, Prev, Up, Forward, Back are not defined -# if $T2H_SPLIT then Top page is in its own html file -sub T2H_DEFAULT_print_Top_header($$) -{ - my $fh = shift; - my $do_page_head = shift; - &$print_page_head($fh) if ($do_page_head); -} -sub T2H_DEFAULT_print_Top_footer($$) -{ - my $fh = shift; - my $end_page = shift; - my $buttons = \@MISC_BUTTONS; - &$print_foot_navigation($fh); - print $fh "$SMALL_RULE\n"; - if ($end_page) - { - &$print_navigation($fh, $buttons); - &$print_page_foot($fh); - } -} -sub T2H_DEFAULT_print_Top -{ - my $fh = shift; - my $has_top_heading = shift; - - # for redefining navigation buttons use: - # my $buttons = [...]; - # as it is, 'Top', 'Contents', 'Index', 'About' are printed - my $buttons = \@MISC_BUTTONS; - &$print_head_navigation($fh, $buttons); - my $nw; - if ($Texi2HTML::THIS_SECTION) - { - # if top-level node has content, then print it with extra header - #print $fh "<h1>$Texi2HTML::NAME{Top}</h1>\n" - print $fh "<h1 class=\"settitle\">$Texi2HTML::NAME{Top}</h1>\n" - unless ($has_top_heading); - $nw = main::print_lines($fh, $Texi2HTML::THIS_SECTION); - } - else - { - # top-level node is fully enclosed in @ifnothtml - # print fulltitle, subtitle, author, Overview - print $fh $Texi2HTML::TITLEPAGE; - if (@{$Texi2HTML::OVERVIEW}) - { - print $fh '<h2> ' . &$I('Overview:') . "</h2>\n" . "<blockquote>\n"; - my $nw = main::print_lines($fh, $Texi2HTML::OVERVIEW); - print $fh "</blockquote>\n"; - } - } -} - -################################################################### -# Layout of Toc, Overview, and Footnotes pages -# By default, we use "normal" layout -# Texi2HTML::HREF of Next, Prev, Up, Forward, Back, etc are not defined -# use: my $buttons = [...] to redefine navigation buttons -sub T2H_DEFAULT_print_Toc -{ - return &$print_misc(@_); -} -sub T2H_DEFAULT_print_Overview -{ - return &$print_misc(@_); -} -sub T2H_DEFAULT_print_Footnotes -{ - return &$print_misc(@_); -} -sub T2H_DEFAULT_print_About -{ - return &$print_misc(@_); -} - -sub T2H_DEFAULT_print_misc_header -{ - my $fh = shift; - my $buttons = shift; - &$print_page_head($fh) if $SPLIT; - &$print_head_navigation($fh, $buttons); -} - -sub T2H_DEFAULT_print_misc_footer -{ - my $fh = shift; - my $buttons = shift; - my $nwords = shift; - &$print_foot_navigation($fh, $buttons); - print $fh "$SMALL_RULE\n"; - if ($SPLIT) - { - &$print_navigation($fh, $buttons);# if ($SPLIT ne 'node'); - &$print_page_foot($fh); - } -} - -sub T2H_DEFAULT_print_misc -{ - my $fh = shift; - my $buttons = \@MISC_BUTTONS; - &$print_misc_header($fh, $buttons); - print $fh "<h1>$Texi2HTML::NAME{This}</h1>\n"; - main::print_lines($fh); - &$print_misc_footer($fh, $buttons); -} -################################################################## -# section_footer is only called if SPLIT eq 'section' -# section_footer: after print_section of last section, before print_page_foot -# - -sub T2H_DEFAULT_print_section_footer -{ - my $fh = shift; - my $buttons = \@SECTION_FOOTER_BUTTONS; - &$end_section ($fh, 1); - &$print_navigation($fh, $buttons); -} - -################################################################### -# chapter_header and chapter_footer are only called if -# SPLIT eq 'chapter' -# chapter_header: after print_page_head, before print_section -# chapter_footer: after print_section of last section, before print_page_foot -# -# If you want to get rid of navigation stuff after each section, -# redefine print_section such that it does not call print_navigation, -# and put print_navigation into print_chapter_header -sub T2H_DEFAULT_print_chapter_header -{ - # nothing to do there, by default, the navigation panel - # is the section navigation panel - if (! $SECTION_NAVIGATION) - { # in this case print_navigation is called here. - my $fh = shift; - my $buttons = \@CHAPTER_BUTTONS; - &$print_head_navigation($fh, $buttons); #do that instead ? - #&$print_head_navigation($fh, $buttons); # FIXME VERTICAL_HEAD_NAVIGATION ? - print $fh "\n$MIDDLE_RULE\n"; - } -} - -sub T2H_DEFAULT_print_chapter_footer -{ - my $fh = shift; - my $buttons = \@CHAPTER_BUTTONS; - &$print_foot_navigation($fh); - print $fh "$BIG_RULE\n"; - &$print_navigation($fh, $buttons); -} - -sub T2H_DEFAULT_print_section_header -{ - # nothing to do there, by default - if (! $SECTION_NAVIGATION) - { # in this case print_navigation is called here. - my $fh = shift; - my $buttons = \@SECTION_BUTTONS; - &$print_head_navigation($fh, $buttons); - } -} - -################################################################### -# Layout of standard header and footer -# - -sub T2H_DEFAULT_print_page_head($) -{ - my $fh = shift; - my $longtitle = "$Texi2HTML::THISDOC{'title_unformatted'}"; - $longtitle .= ": $Texi2HTML::UNFORMATTED{'This'}" if exists $Texi2HTML::UNFORMATTED{'This'}; - #my $longtitle = "$Texi2HTML::THISDOC{'title_no_texi'}"; - #$longtitle .= ": $Texi2HTML::NO_TEXI{'This'}" if exists $Texi2HTML::NO_TEXI{'This'}; - my $description = $DOCUMENT_DESCRIPTION; - $description = $longtitle if (!defined($description)); - $description = "<meta name=\"description\" content=\"$description\">" if - ($description ne ''); - $description = $Texi2HTML::THISDOC{'documentdescription'} if (defined($Texi2HTML::THISDOC{'documentdescription'})); - my $encoding = ''; - $encoding = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=$ENCODING\">" if (defined($ENCODING) and ($ENCODING ne '')); - print $fh <<EOT; -$DOCTYPE -<html> -$Texi2HTML::THISDOC{'copying'}<!-- Created on $Texi2HTML::THISDOC{today} by $Texi2HTML::THISDOC{program} --> -<!-- -$Texi2HTML::THISDOC{program_authors} ---> -<head> -<title>$longtitle</title> - -$description -<meta name="keywords" content="$longtitle"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="$Texi2HTML::THISDOC{program}"> -$encoding -$CSS_LINES -$EXTRA_HEAD -</head> - -<body $BODYTEXT> -$AFTER_BODY_OPEN -EOT -} - -sub program_string() -{ - my $user = $Texi2HTML::THISDOC{'user'}; - my $date = $Texi2HTML::THISDOC{'today'}; - $user = '' if (!defined($user)); - $date = '' if (!defined($date)); - if (($user ne '') and ($date ne '')) - { - return &$I('This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.', { - 'user' => $user, 'date' => $date, 'program_homepage' => $Texi2HTML::THISDOC{'program_homepage'}, 'program' => $Texi2HTML::THISDOC{'program'} }); - } - elsif ($user ne '') - { - return &$I('This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.', { - 'user' => $user, 'program_homepage' => $Texi2HTML::THISDOC{'program_homepage'}, 'program' => $Texi2HTML::THISDOC{'program'} }); - } - elsif ($date ne '') - { - return &$I('This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.', { - 'date' => $date, 'program_homepage' => $Texi2HTML::THISDOC{'program_homepage'}, 'program' => $Texi2HTML::THISDOC{'program'} }); - } - return &$I('This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.', { - 'program_homepage' => $Texi2HTML::THISDOC{'program_homepage'}, 'program' -=> $Texi2HTML::THISDOC{'program'} }); -} - -sub T2H_DEFAULT_end_section($$) -{ - my $fh = shift; - my $end_foot_navigation = shift; - &$print_foot_navigation($fh) if ($end_foot_navigation); - print $fh "$BIG_RULE\n"; -} - -sub T2H_DEFAULT_print_page_foot($) -{ - my $fh = shift; - my $program_string = program_string(); - print $fh <<EOT; -<p> - <font size="-1"> - $program_string - </font> - <br> -$PRE_BODY_CLOSE -</p> -</body> -</html> -EOT -} - -################################################################### -# Layout of navigation panel - -sub T2H_DEFAULT_print_head_navigation($$) -{ - my $fh = shift; - my $buttons = shift; - if ($VERTICAL_HEAD_NAVIGATION) - { - print $fh <<EOT; -<table border="0" cellpadding="0" cellspacing="0"> -<tr valign="top"> -<td align="left"> -EOT - } - main::print_lines($fh, $Texi2HTML::THIS_HEADER); - &$print_navigation($fh, $buttons, $VERTICAL_HEAD_NAVIGATION); - if ($VERTICAL_HEAD_NAVIGATION) - { - print $fh <<EOT; -</td> -<td align="left"> -EOT - } - elsif (defined $SPLIT - and ($SPLIT eq 'node')) - { - print $fh "$SMALL_RULE\n"; - } -} - -sub T2H_DEFAULT_print_foot_navigation -{ - my $fh = shift; - if ($VERTICAL_HEAD_NAVIGATION) - { - print $fh <<EOT; -</td> -</tr> -</table> -EOT - } -} - -###################################################################### -# navigation panel -# -# how to create IMG tag -sub T2H_DEFAULT_button_icon_img -{ - my $button = shift; - my $icon = shift; - my $name = shift; - return '' if (!defined($icon)); - if (defined($name) && $name) - { - $name = ": $name"; - } - else - { - $name = ''; - } - $button = "" if (!defined ($button)); - return qq{<img src="$icon" border="0" alt="$button$name" align="middle">}; -} - -sub T2H_DEFAULT_print_navigation -{ - my $fh = shift; - my $buttons = shift; - my $vertical = shift; - my $spacing = 1; - print $fh '<table cellpadding="', $spacing, '" cellspacing="', $spacing, - "\" border=\"0\">\n"; - - print $fh "<tr>" unless $vertical; - for my $button (@$buttons) - { - print $fh qq{<tr valign="top" align="left">\n} if $vertical; - print $fh qq{<td valign="middle" align="left">}; - - if (ref($button) eq 'CODE') - { - &$button($fh, $vertical); - } - elsif (ref($button) eq 'SCALAR') - { - print $fh "$$button" if defined($$button); - } - elsif (ref($button) eq 'ARRAY') - { - my $text = $button->[1]; - my $button_href = $button->[0]; - if (defined($button_href) and !ref($button_href) - and defined($text) and (ref($text) eq 'SCALAR') and defined($$text)) - { # use given text - if ($Texi2HTML::HREF{$button_href}) - { - print $fh "" . - &$anchor('', - $Texi2HTML::HREF{$button_href}, - $$text - ) - ; - } - else - { - print $fh $$text; - } - } - } - elsif ($button eq ' ') - { # handle space button - print $fh - $ICONS && $ACTIVE_ICONS{' '} ? - &$button_icon_img($button, $ACTIVE_ICONS{' '}) : - $NAVIGATION_TEXT{' '}; - #next; - } - elsif ($Texi2HTML::HREF{$button}) - { # button is active - my $btitle = $BUTTONS_GOTO{$button} ? - 'title="' . ucfirst($BUTTONS_GOTO{$button}) . '"' : ''; - if ($ICONS && $ACTIVE_ICONS{$button}) - { # use icon - print $fh '' . - &$anchor('', - $Texi2HTML::HREF{$button}, - &$button_icon_img($button, - $ACTIVE_ICONS{$button}, - #$Texi2HTML::NAME{$button}), - $Texi2HTML::NO_TEXI{$button}), - $btitle - ); - } - else - { # use text - print $fh - '[' . - &$anchor('', - $Texi2HTML::HREF{$button}, - $NAVIGATION_TEXT{$button}, - $btitle - ) . - ']'; - } - } - else - { # button is passive - print $fh - $ICONS && $PASSIVE_ICONS{$button} ? - &$button_icon_img($button, - $PASSIVE_ICONS{$button}, - #$Texi2HTML::NAME{$button}) : - $Texi2HTML::NO_TEXI{$button}) : - - "[" . $NAVIGATION_TEXT{$button} . "]"; - } - print $fh "</td>\n"; - print $fh "</tr>\n" if $vertical; - } - print $fh "</tr>" unless $vertical; - print $fh "</table>\n"; -} - -###################################################################### -# Frames: this is from "Richard Y. Kim" <ryk@coho.net> -# Should be improved to be more conforming to other _print* functions -# FIXME pass toc_file and main_file as args or in $Texi2HTML::THISDOC ? - -sub T2H_DEFAULT_print_frame -{ - my $fh = shift; - my $toc_file = shift; - my $main_file = shift; - print $fh <<EOT; -$FRAMESET_DOCTYPE -<html> -<head><title>$Texi2HTML::THISDOC{title}</title></head> -<frameset cols="140,*"> - <frame name="toc" src="$toc_file"> - <frame name="main" src="$main_file"> -</frameset> -</html> -EOT -} - -sub T2H_DEFAULT_print_toc_frame -{ - my $fh = shift; - my $stoc_lines = shift; - &$print_page_head($fh); - print $fh <<EOT; -<h2>Content</h2> -EOT - print $fh map {s/\bhref=/target="main" href=/; $_;} @$stoc_lines; - print $fh "</body></html>\n"; -} - -# This subroutine is intended to fill @Texi2HTML::TOC_LINES and -# @Texi2HTML::OVERVIEW with the table of contents and short table of -# contents. -# -# arguments: -# ref on an array containing all the elements - -# each element is a reference on a hash. The following keys might be of -# use: -# 'top': true if this 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 - -# Relevant configuration variables are: -# $NUMBER_SECTIONS -# $TOC_LIST_ATTRIBUTE: usefull in case a list is used -# $FRAMES: @Texi2HTML::OVERVIEW is used in one of the frames. -# $BEFORE_OVERVIEW -# $AFTER_OVERVIEW -# $BEFORE_TOC_LINES -# $AFTER_TOC_LINES -# $DO_CONTENTS -# $DO_SCONTENTS - -sub T2H_DEFAULT_toc_body($) -{ -} - -sub T2H_DEFAULT_css_lines ($$) -{ - my $import_lines = shift; - my $rule_lines = shift; - return if (defined($CSS_LINES) or (!@$rule_lines and !@$import_lines and (! keys(%css_map)))); - $CSS_LINES = "<style type=\"text/css\">\n<!--\n"; - $CSS_LINES .= join('',@$import_lines) . "\n" if (@$import_lines); - foreach my $css_rule (sort(keys(%css_map))) - { - next unless ($css_map{$css_rule}); - $CSS_LINES .= "$css_rule {$css_map{$css_rule}}\n"; - } - $CSS_LINES .= join('',@$rule_lines) . "\n" if (@$rule_lines); - $CSS_LINES .= "-->\n</style>\n"; -} - -###################################################################### -# About page -# - -# PRE_ABOUT can be a function reference or a scalar. -# Note that if it is a scalar, T2H_InitGlobals has not been called, -# and all global variables like $ADDRESS are not available. -$PRE_ABOUT = sub -{ - return ' ' . program_string() . "\n"; -}; - -# If customizing $AFTER_ABOUT, be sure to put the content inside <p></p>. -$AFTER_ABOUT = ''; - -%BUTTONS_EXAMPLE = - ( - 'Top', ' ', - 'Contents', ' ', - 'Overview', ' ', - 'Index', ' ', - 'This', '1.2.3', - 'Back', '1.2.2', - 'FastBack', '1', - 'Prev', '1.2.2', - 'Up', '1.2', - 'Next', '1.2.4', - 'NodeUp', '1.2', - 'NodeNext', '1.2.4', - 'NodePrev', '1.2.2', - 'Following', '1.2.4', - 'Forward', '1.2.4', - 'FastForward', '2', - 'About', ' ', - 'First', '1.', - 'Last', '1.2.4', - ); - -sub T2H_DEFAULT_about_body -{ - my $about = "<p>\n"; - if (ref($PRE_ABOUT) eq 'CODE') - { - $about .= &$PRE_ABOUT(); - } - else - { - $about .= $PRE_ABOUT; - } - $about .= <<EOT; -</p> -<p> -EOT - $about .= &$I(' The buttons in the navigation panels have the following meaning:') . "\n"; - $about .= <<EOT; -</p> -<table border="1"> - <tr> -EOT - $about .= ' <th> ' . &$I('Button') . " </th>\n" . -' <th> ' . &$I('Name') . " </th>\n" . -' <th> ' . &$I('Go to') . " </th>\n" . -' <th> ' . &$I('From 1.2.3 go to') . "</th>\n" . " </tr>\n"; - - for my $button (@SECTION_BUTTONS) - { - next if $button eq ' ' || ref($button) eq 'CODE' || ref($button) eq 'SCALAR' || ref($button) eq 'ARRAY'; - $about .= " <tr>\n <td align=\"center\">"; - $about .= - ($ICONS && $ACTIVE_ICONS{$button} ? - &$button_icon_img($button, $ACTIVE_ICONS{$button}) : - ' [' . $NAVIGATION_TEXT{$button} . '] '); - $about .= "</td>\n"; - $about .= <<EOT; - <td align="center">$button</td> - <td>$BUTTONS_GOTO{$button}</td> - <td>$BUTTONS_EXAMPLE{$button}</td> - </tr> -EOT - } - - $about .= <<EOT; -</table> - -<p> -EOT - $about .= &$I(' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:') . "\n"; - -# 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: - $about .= <<EOT; -</p> - -<ul> -EOT - $about .= ' <li> 1. ' . &$I('Section One') . "\n" . -" <ul>\n" . -' <li>1.1 ' . &$I('Subsection One-One') . "\n"; - $about .= <<EOT; - <ul> - <li>...</li> - </ul> - </li> -EOT - $about .= ' <li>1.2 ' . &$I('Subsection One-Two') . "\n" . -" <ul>\n" . -' <li>1.2.1 ' . &$I('Subsubsection One-Two-One') . "</li>\n" . -' <li>1.2.2 ' . &$I('Subsubsection One-Two-Two') . "</li>\n" . -' <li>1.2.3 ' . &$I('Subsubsection One-Two-Three') . " \n" -. -' <strong><== ' . &$I('Current Position') . " </strong></li>\n" . -' <li>1.2.4 ' . &$I('Subsubsection One-Two-Four') . "</li>\n" . -" </ul>\n" . -" </li>\n" . -' <li>1.3 ' . &$I('Subsection One-Three') . "\n"; - $about .= <<EOT; - <ul> - <li>...</li> - </ul> - </li> -EOT - $about .= ' <li>1.4 ' . &$I('Subsection One-Four') . "</li>\n"; - $about .= <<EOT; - </ul> - </li> -</ul> -$AFTER_ABOUT -EOT - return $about; -} - -sub T2H_DEFAULT_titlepage() -{ - my $result = ''; - if (@{$Texi2HTML::THISDOC{'titles'}} - or @{$Texi2HTML::THISDOC{'subtitles'}} - or @{$Texi2HTML::THISDOC{'authors'}}) - { - $result = "<div align=\"center\">\n"; - foreach my $title (@{$Texi2HTML::THISDOC{'titles'}}) - { - $result .= '<h1>' . $title . "</h1>\n"; - } - foreach my $subtitle (@{$Texi2HTML::THISDOC{'subtitles'}}) - { - $result .= '<h2>' . $subtitle . "</h2>\n"; - } - foreach my $author (@{$Texi2HTML::THISDOC{'authors'}}) - { - $result .= '<strong> ' . $author . " </strong><br>\n"; - } - $result .= "</div>\n$DEFAULT_RULE\n"; - } - - $Texi2HTML::TITLEPAGE = $result . $Texi2HTML::TITLEPAGE; -} - -# i18n -sub T2H_DEFAULT_print_redirection_page($) -{ - my $fh = shift; - my $longtitle = "$Texi2HTML::THISDOC{'title_no_texi'}"; - $longtitle .= ": $Texi2HTML::NO_TEXI{'This'}" if exists $Texi2HTML::NO_TEXI{'This'}; - my $description = $longtitle; - $description = $Texi2HTML::THISDOC{'documentdescription'} if (defined($Texi2HTML::THISDOC{'documentdescription'})); - my $href = &$anchor('', $Texi2HTML::HREF{'This'}, $Texi2HTML::NAME{'This'}); - print $fh <<EOT; -$DOCTYPE -<html> -<!-- Created on $Texi2HTML::THISDOC{'today'} by $Texi2HTML::THISDOC{'program'} --> -<!-- -$Texi2HTML::THISDOC{'program_authors'} ---> -<head> -<title>$longtitle</title> - -<meta name="description" content="$description"> -<meta name="keywords" content="$longtitle"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="$Texi2HTML::THISDOC{program}"> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> -<meta http-equiv="Refresh" content="0; url=$Texi2HTML::HREF{'This'}"> -$EXTRA_HEAD -</head> - -<body $BODYTEXT> -$AFTER_BODY_OPEN -<p>The node you are looking for is at $href.</p> -</body> -EOT -} - -sub T2H_DEFAULT_node_file_name($) -{ - my $node = shift; - return (undef, undef) if ($node->{'external_node'} or $node->{'index_page'}); - my $file; - my $node_file; - - if ($NEW_CROSSREF_STYLE) - { - if (defined($node->{'file'})) - { - $file = $node->{'file'}; - $node_file = $node->{'node_file'}; - } - else - { - $node_file = $node->{'cross_manual_target'} . ".$NODE_FILE_EXTENSION"; - $file = $node_file if (($SPLIT eq 'node') and ($USE_NODES or $node->{'with_section'})); - } - } - else - { - return (undef, undef) if (defined($node->{'file'})); - my $name = main::remove_texi($node->{'texi'}); - $name =~ s/[^\w\.\-]/-/g; - $name = "${name}.$NODE_FILE_EXTENSION"; - $file = $name if (($SPLIT eq 'node') and ($USE_NODES or $node->{'with_section'})); - $node_file = $name; - } - return ($file, $node_file); -} - -######################################################################## -# Control of formatting: -# 1.) For some changes, it is often enough to change the value of -# some global map. It might necessitate building a little -# function along with the change in hash, if the change is the use -# of another function (in style_map). -# 2.) For other changes, reimplement one of the t2h_default_<fnc>* routines, -# give them another name, and assign them to the respective -# $<fnc> variable (below). - - -# -# This hash should have keys corresponding with the nonletter command accent -# whose following character is considered to be the argument -# This hash associates an accent macro to the ISO name for the accent if any. -# The customary use of this map is to find the ISO name appearing in html -# entity (like é) associated with a texinfo accent macro. -# -# The keys of the hash are -# ": umlaut -# ~: tilda accent -# ^: circumflex accent -# `: grave accent -# ': acute accent -# =: macron accent -%accent_map = ( - '"', 'uml', - '~', 'tilde', - '^', 'circ', - '`', 'grave', - "'", 'acute', - '=', '', - ); - -# -# texinfo "simple things" (@foo) to HTML ones -# -%simple_map = ( - "*", "<br>", # HTML+ - ' ', ' ', - "\t", ' ', - "\n", ' ', - # "­" or "­" could also be possible for @-, but it seems - # that some browser will consider this as an always visible hyphen mark - # which is not what we want (see http://www.cs.tut.fi/~jkorpela/shy.html) - '-', '', # hyphenation hint - '|', '', # used in formatting commands @evenfooting and friends - '/', '', - # spacing commands - ':', '', - '!', '!', - '?', '?', - '.', '.', - '@', '@', - '}', '}', - '{', '{', - ); - -# this map is used in preformatted text -%simple_map_pre = %simple_map; -$simple_map_pre{'*'} = "\n"; - -# -# texinfo "things" (@foo{}) to HTML ones -# -%things_map = ( - 'TeX' => 'TeX', - 'LaTeX' => 'LaTeX', -# pertusus: unknown by makeinfo, not in texinfo manual (@* is the right thing) -# 'br', '<br>', # paragraph break - 'bullet' => '*', -# #'copyright' => '(C)', - 'copyright' => '©', - 'registeredsymbol' => '®', - 'dots' => '<small class="dots">...</small>', - 'enddots' => '<small class="enddots">....</small>', - 'equiv' => '==', -# i18n - 'error' => 'error-->', - 'expansion' => '==>', - 'minus' => '-', - 'point' => '-!-', - 'print' => '-|', - 'result' => '=>', - # set in code using the language - # 'today', &pretty_date, - 'today' => '', - 'aa' => 'å', - 'AA' => 'Å', - 'ae' => 'æ', - 'oe' => 'œ', #pertusus: also œ. œ not in html 3.2 - 'AE' => 'Æ', - 'OE' => 'Œ', #pertusus: also Œ. Œ not in html 3.2 - 'o' => 'ø', - 'O' => 'Ø', - 'ss' => 'ß', - 'l' => '/l', - 'L' => '/L', - 'exclamdown' => '¡', - 'questiondown' => '¿', - 'pounds' => '£', - 'ordf' => 'ª', - 'ordm' => 'º', - 'comma' => ',', - 'euro' => '€', - ); - -# This map is used in preformatted environments -%pre_map = %things_map; -$pre_map{'dots'} = '...'; -$pre_map{'enddots'} = '....'; -#$pre_map{'br'} = "\n"; - -# ascii representation of @-commands -%ascii_simple_map = ( - "*", "\n", # HTML+ - ' ', ' ', - "\t", "\t", - "\n", "\n", - '-', '', # hyphenation hint - '|', '', # used in formatting commands @evenfooting and friends - '/', '', - ':', '', - '!', '!', - '?', '?', - '.', '.', - '@', '@', - '}', '}', - '{', '{', -); - -%ascii_things_map = ( - 'TeX' => 'TeX', - 'LaTeX' => 'LaTeX', - 'bullet' => '*', - 'copyright' => '(C)', - 'registeredsymbol' => '(R)', - 'dots' => '...', - 'enddots' => '....', - 'equiv' => '==', -# i18n - 'error' => 'error-->', - 'expansion' => '==>', - 'minus' => '-', - 'point' => '-!-', - 'print' => '-|', - 'result' => '=>', - 'today' => '', - 'aa' => 'aa', - 'AA' => 'AA', - 'ae' => 'ae', - 'oe' => 'oe', - 'AE' => 'AE', - 'OE' => 'OE', - 'o' => '/o', - 'O' => '/O', - 'ss' => 'ss', - 'l' => '/l', - 'L' => '/L', - 'exclamdown' => '?', - 'questiondown' => '!', - 'pounds' => '#', - 'ordf' => 'a', - 'ordm' => 'o', - 'comma' => ',', - 'euro' => 'Euro', -); - -# -# This map is used when texi elements are removed and replaced -# by simple text -# -%simple_map_texi = ( - "*", "", - " ", " ", - "\t", " ", - "-", "-", # soft hyphen - "\n", "\n", - "|", "", - # spacing commands - ":", "", - "!", "!", - "?", "?", - ".", ".", - "-", "", - '@', '@', - '}', '}', - '{', '{', - ); - -# text replacing macros when texi commands are removed and plain text is -# produced -%texi_map = ( - 'TeX', 'TeX', - 'LaTeX', 'LaTeX', - 'bullet', '*', - 'copyright', 'C', - 'registeredsymbol', 'R', - 'dots', '...', - 'enddots', '....', - 'equiv', '==', - 'error', 'error-->', - 'expansion', '==>', - 'minus', '-', - 'point', '-!-', - 'print', '-|', - 'result', '=>', - 'today' => '', - 'aa', 'aa', - 'AA', 'AA', - 'ae', 'ae', - 'oe', 'oe', - 'AE', 'AE', - 'OE', 'OE', - 'o', 'o', - 'O', 'O', - 'ss', 'ss', - 'l', 'l', - 'L', 'L', - 'exclamdown', '! upside-down', - #'exclamdown', '¡', - 'questiondown', '? upside-down', - #'questiondown', '¿', - 'pounds', 'pound sterling', - #'pounds', '£' - 'ordf' => 'a', - 'ordm' => 'o', - 'comma' => ',', - 'euro' => 'Euro', - ); - -# taken from -#Latin extended additionnal -#http://www.alanwood.net/unicode/latin_extended_additional.html -#C1 Controls and Latin-1 Supplement -#http://www.alanwood.net/unicode/latin_1_supplement.html -#Latin Extended-A -#http://www.alanwood.net/unicode/latin_extended_a.html -#Latin Extended-B -#http://www.alanwood.net/unicode/latin_extended_b.html -#dotless i: 0131 -%unicode_map = ( - 'bullet' => '2022', - 'copyright' => '00A9', - 'registeredsymbol' => '00AE', - 'dots' => '2026', - 'enddots' => '', - 'equiv' => '2261', - 'error' => '', - 'expansion' => '2192', - 'minus' => '2212', # in mathematical operators -# 'minus' => '002D', # in latin1 - 'point' => '2217', - 'print' => '', - 'result' => '21D2', - 'today' => '', - 'aa' => '00E5', - 'AA' => '00C5', - 'ae' => '00E6', - 'oe' => '0153', - 'AE' => '00C6', - 'OE' => '0152', - 'o' => '00F8', - 'O' => '00D8', - 'ss' => '00DF', - 'l' => '0142', - 'L' => '0141', - 'exclamdown' => '00A1', - 'questiondown' => '00BF', - 'pounds' => '00A3', - 'ordf' => '00AA', - 'ordm' => '00BA', - 'comma' => '002C', - 'euro' => '20AC', - ); - -%ascii_character_map = ( - ' ' => '0020', - '!' => '0021', - '"' => '0022', - '#' => '0023', - '$' => '0024', - '%' => '0025', - '&' => '0026', - "'" => '0027', - '(' => '0028', - ')' => '0029', - '*' => '002A', - '+' => '002B', - ',' => '002C', - '-' => '002D', - '.' => '002E', - '/' => '002F', - ':' => '003A', - ';' => '003B', - '<' => '003C', - '=' => '003D', - '>' => '003E', - '?' => '003F', - '@' => '0040', - '[' => '005B', - '\\' => '005C', - ']' => '005D', - '^' => '005E', - '_' => '005F', - '`' => '0060', - '{' => '007B', - '|' => '007C', - '}' => '007D', - '~' => '007E', -); - -%perl_charset_to_html = ( - 'utf8' => 'utf-8', - 'ascii' => 'us-ascii', -); - -# symbols used for the commands if $USE-ISO is true. -%iso_symbols = ( - 'equiv' => '≡', - 'dots' => '…', - 'bullet' => '•', - 'result' => '⇒', - 'expansion' => '→', - 'point' => '∗', - ); - -# When the value begins with & the function with that name is used to do the -# html. The first argument is the text enclosed within {}, the second is the -# style name (which is also the key of the hash) -# -# Otherwithe the value is the html element used to enclose the text, and if -# there is a " the resulting text is also enclosed within `' -my %old_style_map = ( - 'acronym', '', - 'asis', '', - 'b', 'b', - 'cite', 'cite', - 'code', 'code', - 'command', 'code', - 'ctrl', '&default_ctrl', - 'dfn', 'em', - 'dmn', '', - 'email', '&default_email', - 'emph', 'em', - 'env', 'code', - 'file', '"tt', - 'i', 'i', - 'kbd', 'kbd', - 'key', 'kbd', - 'math', 'em', - 'option', '"samp', - 'r', '', - 'samp', '"samp', - 'sc', '&default_sc', - 'strong', 'strong', - 't', 'tt', - 'uref', '&default_uref', - 'url', '&default_url', - 'var', 'var', - 'verb', 'tt', - 'titlefont', '&default_titlefont', - 'w', '', - ); - -# default is {'args' => ['normal'], 'attribute' => ''}, -%style_map = ( - 'asis', {}, - 'b', {'attribute' => 'b'}, - 'cite', {'attribute' => 'cite'}, - 'code', {'args' => ['code'], 'attribute' => 'code'}, - 'command', {'args' => ['code'], 'attribute' => 'code'}, - 'ctrl', {'function' => \&t2h_default_ctrl}, - 'dfn', {'attribute' => 'em'}, - 'dmn', {}, - 'email', {'args' => ['code', 'normal'], - 'function' => \&t2h_default_email}, - #'email', {'args' => ['normal', 'normal'], - # 'function' => \&t2h_default_email}, - 'emph', {'attribute' => 'em'}, - 'env', {'args' => ['code'], 'attribute' => 'code'}, - 'file', {'args' => ['code'], 'attribute' => 'tt', 'quote' => '"'}, - 'i', {'attribute' => 'i'}, - 'slanted', {'attribute' => 'i'}, - 'sansserif', {'attribute' => 'span class="sansserif"'}, - 'kbd', {'args' => ['code'], 'attribute' => 'kbd'}, - 'key', {'attribute' => 'kbd'}, - 'math', {'attribute' => 'em'}, - 'option', {'args' => ['code'], 'attribute' => 'samp', 'quote' => '"'}, - 'r', {}, - 'samp', {'args' => ['code'], 'attribute' => 'samp', 'quote' => '"'}, - 'sc', {'function' => \&t2h_default_sc}, - 'strong', {'attribute' => 'strong'}, - 't', {'attribute' => 'tt'}, - 'uref', {'function' => \&t2h_default_uref, - 'args' => ['code', 'normal', 'normal']}, - #'uref', {'function' => \&t2h_default_uref, - # 'args' => ['normal', 'normal', 'normal']}, - 'url', {'function' => \&t2h_default_uref, - 'args' => ['code', 'normal', 'normal']}, - 'indicateurl', {'args' => ['code'], 'begin' => '<<code>', 'end' => '</code>>'}, - 'var', {'attribute' => 'var'}, - 'verb', {'args' => ['code'], 'attribute' => 'tt'}, - 'titlefont', {'function' => \&t2h_default_titlefont}, - 'w', {}, - ); - -%unicode_diacritical = ( - 'H' => '030B', - 'ringaccent' => '030A', - "'" => '0301', - 'v' => '030C', - ',' => '0327', - '^' => '0302', - 'dotaccent' => '0307', - '`' => '0300', - '=' => '0304', - '~' => '0303', - '"' => '0308', - 'udotaccent' => '0323', - 'ubaraccent' => '0332', - 'u' => '0306' -); - -%unicode_accents = ( - 'dotaccent' => { # dot above - 'A' => '0226', #C moz-1.2 - 'a' => '0227', #c moz-1.2 - 'B' => '1E02', - 'b' => '1E03', - 'C' => '010A', - 'c' => '010B', - 'D' => '1E0A', - 'd' => '1E0B', - 'E' => '0116', - 'e' => '0117', - 'F' => '1E1E', - 'f' => '1E1F', - 'G' => '0120', - 'g' => '0121', - 'H' => '1E22', - 'h' => '1E23', - 'i' => '0069', - 'I' => '0130', - 'N' => '1E44', - 'n' => '1E45', - 'O' => '022E', #Y moz-1.2 - 'o' => '022F', #v moz-1.2 - 'P' => '1E56', - 'p' => '1E57', - 'R' => '1E58', - 'r' => '1E59', - 'S' => '1E60', - 's' => '1E61', - 'T' => '1E6A', - 't' => '1E6B', - 'W' => '1E86', - 'w' => '1E87', - 'X' => '1E8A', - 'x' => '1E8B', - 'Y' => '1E8E', - 'y' => '1E8F', - 'Z' => '017B', - 'z' => '017C', - }, - 'udotaccent' => { # dot below - 'B' => '1E04', - 'b' => '1E05', - 'D' => '1E0C', - 'd' => '1E0D', - 'E' => '1EB8', - 'e' => '1EB9', - 'H' => '1E24', - 'h' => '1E25', - 'I' => '1ECA', - 'i' => '1ECB', - 'K' => '1E32', - 'k' => '1E33', - 'L' => '1E36', - 'l' => '1E37', - 'M' => '1E42', - 'm' => '1E43', - 'N' => '1E46', - 'n' => '1E47', - 'O' => '1ECC', - 'o' => '1ECD', - 'R' => '1E5A', - 'r' => '1E5B', - 'S' => '1E62', - 's' => '1E63', - 'T' => '1E6C', - 't' => '1E6D', - 'U' => '1EE4', - 'u' => '1EE5', - 'V' => '1E7E', - 'v' => '1E7F', - 'W' => '1E88', - 'w' => '1E89', - 'Y' => '1EF4', - 'y' => '1EF5', - 'Z' => '1E92', - 'z' => '1E93', - }, - 'ubaraccent' => { # line below - 'B' => '1E06', - 'b' => '1E07', - 'D' => '1E0E', - 'd' => '1E0F', - 'h' => '1E96', - 'K' => '1E34', - 'k' => '1E35', - 'L' => '1E3A', - 'l' => '1E3B', - 'N' => '1E48', - 'n' => '1E49', - 'R' => '1E5E', - 'r' => '1E5F', - 'T' => '1E6E', - 't' => '1E6F', - 'Z' => '1E94', - 'z' => '1E95', - }, - ',' => { # cedilla - 'C' => '00C7', - 'c' => '00E7', - 'D' => '1E10', - 'd' => '1E11', - 'E' => '0228', #C moz-1.2 - 'e' => '0229', #c moz-1.2 - 'G' => '0122', - 'g' => '0123', - 'H' => '1E28', - 'h' => '1E29', - 'K' => '0136', - 'k' => '0137', - 'L' => '013B', - 'l' => '013C', - 'N' => '0145', - 'n' => '0146', - 'R' => '0156', - 'r' => '0157', - 'S' => '015E', - 's' => '015F', - 'T' => '0162', - 't' => '0163', - }, - '=' => { # macron - 'A' => '0100', - 'a' => '0101', - 'E' => '0112', - 'e' => '0113', - 'I' => '012A', - 'i' => '012B', - 'G' => '1E20', - 'g' => '1E21', - 'O' => '014C', - 'o' => '014D', - 'U' => '016A', - 'u' => '016B', - 'Y' => '0232', #? moz-1.2 - 'y' => '0233', #? moz-1.2 - }, - '"' => { # diaeresis - 'A' => '00C4', - 'a' => '00E4', - 'E' => '00CB', - 'e' => '00EB', - 'H' => '1E26', - 'h' => '1E27', - 'I' => '00CF', - 'i' => '00EF', - 'O' => '00D6', - 'o' => '00F6', - 't' => '1E97', - 'U' => '00DC', - 'u' => '00FC', - 'W' => '1E84', - 'w' => '1E85', - 'X' => '1E8C', - 'x' => '1E8D', - 'y' => '00FF', - 'Y' => '0178', - }, - 'u' => { # breve - 'A' => '0101', - 'a' => '0102', - 'E' => '0114', - 'e' => '0115', - 'G' => '011E', - 'g' => '011F', - 'I' => '012C', - 'i' => '012D', - 'O' => '014E', - 'o' => '014F', - 'U' => '016C', - 'u' => '016D', - }, - "'" => { # acute - 'A' => '00C1', - 'a' => '00E1', - 'C' => '0106', - 'c' => '0107', - 'E' => '00C9', - 'e' => '00E9', - 'G' => '01F4', - 'g' => '01F5', - 'I' => '00CD', - 'i' => '00ED', - 'K' => '1E30', - 'k' => '1E31', - 'L' => '0139', - 'l' => '013A', - 'M' => '1E3E', - 'm' => '1E3F', - 'N' => '0143', - 'n' => '0144', - 'O' => '00D3', - 'o' => '00F3', - 'P' => '1E54', - 'p' => '1E55', - 'R' => '0154', - 'r' => '0155', - 'S' => '015A', - 's' => '015B', - 'U' => '00DA', - 'u' => '00FA', - 'W' => '1E82', - 'w' => '1E83', - 'Y' => '00DD', - 'y' => '00FD', - 'Z' => '0179', - 'z' => '018A', - }, - '~' => { # tilde - 'A' => '00C3', - 'a' => '00E3', - 'E' => '1EBC', - 'e' => '1EBD', - 'I' => '0128', - 'i' => '0129', - 'N' => '00D1', - 'n' => '00F1', - 'O' => '00D5', - 'o' => '00F5', - 'U' => '0168', - 'u' => '0169', - 'V' => '1E7C', - 'v' => '1E7D', - 'Y' => '1EF8', - 'y' => '1EF9', - }, - '`' => { # grave - 'A' => '00C0', - 'a' => '00E0', - 'E' => '00C8', - 'e' => '00E8', - 'I' => '00CC', - 'i' => '00EC', - 'N' => '01F8', - 'n' => '01F9', - 'O' => '00D2', - 'o' => '00F2', - 'U' => '00D9', - 'u' => '00F9', - 'W' => '1E80', - 'w' => '1E81', - 'Y' => '1EF2', - 'y' => '1EF3', - }, - '^' => { # circumflex - 'A' => '00C2', - 'a' => '00E2', - 'C' => '0108', - 'c' => '0109', - 'E' => '00CA', - 'e' => '00EA', - 'G' => '011C', - 'g' => '011D', - 'H' => '0124', - 'h' => '0125', - 'I' => '00CE', - 'i' => '00EE', - 'J' => '0134', - 'j' => '0135', - 'O' => '00D4', - 'o' => '00F4', - 'S' => '015C', - 's' => '015D', - 'U' => '00DB', - 'u' => '00FB', - 'W' => '0174', - 'w' => '0175', - 'Y' => '0176', - 'y' => '0177', - 'Z' => '1E90', - 'z' => '1E91', - }, - 'ringaccent' => { # ring - 'A' => '00C5', - 'a' => '00E5', - 'U' => '016E', - 'u' => '016F', - 'w' => '1E98', - 'y' => '1E99', - }, - 'v' => { # caron - 'A' => '01CD', - 'a' => '01CE', - 'C' => '010C', - 'c' => '010D', - 'D' => '010E', - 'd' => '010F', - 'E' => '011A', - 'e' => '011B', - 'G' => '01E6', - 'g' => '01E7', - 'H' => '021E', #K with moz-1.2 - 'h' => '021F', #k with moz-1.2 - 'I' => '01CF', - 'i' => '01D0', - 'K' => '01E8', - 'k' => '01E9', - 'L' => '013D', #L' with moz-1.2 - 'l' => '013E', #l' with moz-1.2 - 'N' => '0147', - 'n' => '0148', - 'O' => '01D1', - 'o' => '01D2', - 'R' => '0158', - 'r' => '0159', - 'S' => '0160', - 's' => '0161', - 'T' => '0164', - 't' => '0165', - 'U' => '01D3', - 'u' => '01D4', - 'Z' => '017D', - 'z' => '017E', - }, - 'H' => { # double acute - 'O' => '0150', - 'o' => '0151', - 'U' => '0170', - 'u' => '0171', - }, -); - -%special_accents = ( - 'ringaccent' => 'aA', - "'" => 'aeiouyAEIOUY', - ',' => 'cC', - '^' => 'aeiouAEIOU', - '`' => 'aeiouAEIOU', - '~' => 'nNaoAO', - '"' => 'aeiouyAEIOU', -); - -#foreach my $accent_command ('tieaccent', 'dotless', keys(%unicode_accents), keys(%accent_map)) -foreach my $accent_command ('tieaccent', 'dotless', keys(%unicode_accents)) -{ - $style_map{$accent_command} = { 'function' => \&t2h_default_accent }; - $old_style_map{$accent_command} = '&default_accent'; - $style_map_texi{$accent_command} = { 'function' => \&t2h_default_ascii_accent }; -} - -sub default_accent($$) -{ - my $text = shift; - my $accent = shift; - return "&${text}$accent_map{$accent};" if (defined($accent_map{$accent}) and defined($special_accents{$accent}) and ($text =~ /^[$special_accents{$accent}]$/)); - return '&' . $text . 'ring;' if (($accent eq 'ringaccent') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return $text . '<' if ($accent eq 'v'); - return "&${text}cedil;" if (($accent eq ',') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return ascii_accents($text, $accent); -} - -sub t2h_default_accent($$) -{ - my $accent = shift; - my $args = shift; - - my $text = $args->[0]; - - return "&${text}$accent_map{$accent};" if (defined($accent_map{$accent}) and defined($special_accents{$accent}) and ($text =~ /^[$special_accents{$accent}]$/)); - return '&' . $text . 'ring;' if (($accent eq 'ringaccent') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return $text . '<' if ($accent eq 'v'); - return "&${text}cedil;" if (($accent eq ',') and (defined($special_accents{$accent})) and ($text =~ /^[$special_accents{$accent}]$/)); - return ascii_accents($text, $accent); -} - -sub ascii_accents($$) -{ - my $text = shift; - my $accent = shift; - return $text if ($accent eq 'dotless'); - return $text . $accent if (defined($accent_map{$accent})); - return $text . "''" if ($accent eq 'H'); - return $text . '.' if ($accent eq 'dotaccent'); - return $text . '*' if ($accent eq 'ringaccent'); - return $text . '[' if ($accent eq 'tieaccent'); - return $text . '(' if ($accent eq 'u'); - return $text . '_' if ($accent eq 'ubaraccent'); - return '.' . $text if ($accent eq 'udotaccent'); - return $text . '<' if ($accent eq 'v'); - return $text . ',' if ($accent eq ','); -} - -sub default_sc($$) -{ - return '<small>' . uc($_[0]) . '</small>'; -} - -sub t2h_default_sc($$$) -{ - shift; - my $args = shift; - return '<small>' . uc($args->[0]) . '</small>'; -} - -sub default_ctrl($$) -{ - return "^$_[0]"; -} - -sub t2h_default_ctrl($$$) -{ - shift; - my $args = shift; - return "^$args->[0]"; -} - -sub default_sc_pre($$) -{ - return uc($_[0]); -} - -sub t2h_default_sc_pre($$$) -{ - shift; - my $args = shift; - return uc($args->[0]); -} - -sub default_titlefont($$) -{ - return "<h1 class=\"titlefont\">$_[0]</h1>" if ($_[0] =~ /\S/); - return ''; -} - -sub t2h_default_titlefont($$$) -{ - shift; - my $args = shift; - return "<h1 class=\"titlefont\">$args->[0]</h1>" if ($args->[0] =~ /\S/); - return ''; -} - -# According to the texinfo manual this shouldn't lead to a link -# but rather be formatted like text. If we did like makeinfo do -# it would be -#sub url($$) -#{ -# return '<<code>' . $_[0] . '</code>>'; -#} -sub t2h_default_url ($$) -{ - shift; - my $args = shift; - my $url = shift @$args; - #$url =~ s/\s*$//; - #$url =~ s/^\s*//; - $url = main::normalise_space($url); - return '' unless ($url =~ /\S/); - return &$anchor('', $url, $url); -} - -sub default_url ($$) -{ - my $url = shift; - my $command = shift; - $url =~ s/\s*$//; - $url =~ s/^\s*//; - return '' unless ($url =~ /\S/); - return &$anchor('', $url, $url); -} - -sub default_uref($$) -{ - my $arg = shift; - my $command = shift; - my ($url, $text, $replacement); - ($url, $text, $replacement) = split /,\s*/, $arg; - $url =~ s/\s*$//; - $url =~ s/^\s*//; - $text = $replacement if (defined($replacement)); - $text = $url unless ($text); - return $text if ($url eq ''); - return &$anchor('', $url, $text); -} - -sub t2h_default_uref($$) -{ - shift; - my $args = shift; - my $url = shift @$args; - my $text = shift @$args; - my $replacement = shift @$args; - #$url =~ s/\s*$//; - #$url =~ s/^\s*//; - $url = main::normalise_space($url); - $replacement = '' if (!defined($replacement)); - $replacement = main::normalise_space($replacement); - $text = '' if (!defined($text)); - $text = main::normalise_space($text); - $text = $replacement if ($replacement ne ''); - $text = $url unless ($text ne ''); - return $text if ($url eq ''); - return &$anchor('', $url, $text); -} - -sub default_email($$) -{ - my $arg = shift; - my $command = shift; - my ($mail, $text); - ($mail, $text) = split /,\s*/, $arg; - $mail =~ s/\s*$//; - $mail =~ s/^\s*//; - $text = $mail unless ($text); - return $text if ($mail eq ''); - return &$anchor('', "mailto:$mail", $text); -} - -sub t2h_default_email($$) -{ - my $command = shift; - my $args = shift; - my $mail = shift @$args; - my $text = shift @$args; - $mail = main::normalise_space($mail); - #$mail =~ s/\s*$//; - #$mail =~ s/^\s*//; - $text = $mail unless (defined($text) and ($text ne '')); - $text = main::normalise_space($text); - return $text if ($mail eq ''); - return &$anchor('', "mailto:$mail", $text); -} - -sub t2h_default_ascii_accent($$$$) -{ - my $accent = shift; - my $args = shift; - - my $text = $args->[0]; - return ascii_accents($text, $accent); -} - -sub t2h_default_no_texi_email -{ - my $command = shift; - my $args = shift; - my $mail = shift @$args; - my $text = shift @$args; - $mail = main::normalise_space($mail); - #$mail =~ s/\s*$//; - #$mail =~ s/^\s*//; - return $text if (defined($text) and ($text ne '')); - return $mail; -} - -sub t2h_default_no_texi_image($$$$) -{ - my $command = shift; - my $args = shift; - my $text = $args->[0]; - $text = main::normalise_space($text); - my @args = split (/\s*,\s*/, $text); - return $args[0]; -} - -sub t2h_default_no_texi_acronym_like($$) -{ - my $command = shift; - my $args = shift; - my $acronym_texi = $args->[0]; - return (main::remove_texi($acronym_texi)); -} - -sub t2h_remove_command($$$$) -{ - return ''; -} - -# This is used for style in preformatted sections -my %old_style_map_pre = %old_style_map; -$old_style_map_pre{'sc'} = '&default_sc_pre'; -$old_style_map_pre{'titlefont'} = ''; - -foreach my $command (keys(%style_map)) -{ - $style_map_pre{$command} = {}; - $style_map_texi{$command} = {} if (!exists($style_map_texi{$command})); - $style_map_texi{$command}->{'args'} = $style_map{$command}->{'args'} - if (exists($style_map{$command}->{'args'})); - #print STDERR "COMMAND $command"; - - foreach my $key (keys(%{$style_map{$command}})) - { - $style_map_pre{$command}->{$key} = $style_map{$command}->{$key}; - } -} - -$style_map_pre{'sc'}->{'function'} = \&t2h_default_sc_pre; -$style_map_pre{'titlefont'} = {}; - -$style_map_texi{'sc'}->{'function'} = \&t2h_default_sc_pre; -$style_map_texi{'email'}->{'function'} = \&t2h_default_no_texi_email; - -####### special styles. You shouldn't need to change them -my %special_style = ( - #'xref' => ['keep','normal','normal','keep','normal'], - 'xref' => { 'args' => ['keep','keep','keep','keep','keep'], - 'function' => \&main::do_xref }, - 'ref' => { 'args' => ['keep','keep','keep','keep','keep'], - 'function' => \&main::do_xref }, - 'pxref' => { 'args' => ['keep','keep','keep','keep','keep'], - 'function' => \&main::do_xref }, - 'inforef' => { 'args' => ['keep','keep','keep'], - 'function' => \&main::do_xref }, - 'image' => { 'args' => ['keep'], 'function' => \&main::do_image }, - 'anchor' => { 'args' => ['keep'], 'function' => \&main::do_anchor_label }, - 'footnote' => { 'args' => ['keep'], 'function' => \&main::do_footnote }, - 'shortcaption' => { 'args' => ['keep'], 'function' => \&main::do_caption_shortcaption }, - 'caption' => { 'args' => ['keep'], 'function' => \&main::do_caption_shortcaption }, - 'acronym', {'args' => ['keep','keep'], 'function' => \&main::do_acronym_like}, - 'abbr', {'args' => ['keep','keep'], 'function' => \&main::do_acronym_like}, -); - -# FIXME the unless defined(.... are now unusefull because the user can -# overwrite. - -# @image is replaced by the first arg in strings -$style_map_texi{'image'} = { 'args' => ['keep'], - 'function' => \&t2h_default_no_texi_image } - unless (defined($style_map_texi{'image'})); - -$style_map_texi{'acronym'} = { 'args' => ['keep','keep'], - 'function' => \&t2h_default_no_texi_acronym_like }; -$style_map_texi{'abbr'} = { 'args' => ['keep','keep'], - 'function' => \&t2h_default_no_texi_acronym_like }; - -foreach my $special (keys(%special_style)) -{ - $style_map{$special} = $special_style{$special} - unless (defined($style_map{$special})); - $style_map_pre{$special} = $special_style{$special} - unless (defined($style_map_pre{$special})); - $style_map_texi{$special} = { 'args' => ['keep'], - 'function' => \&t2h_remove_command } - unless (defined($style_map_texi{$special})); -} -####### end special styles. - - -#foreach my $command (keys(%style_map)) -#{ -# print STDERR "STYLE_MAP_TEXI $command($style_map_texi{$command}) "; -# print STDERR "ARGS $style_map_texi{$command}->{'args'} " if (defined($style_map_texi{$command}->{'args'})); -# print STDERR "FUN $style_map_texi{$command}->{'function'} " if (defined($style_map_texi{$command}->{'function'})); -# print STDERR "\n"; -#} - -# uncomment to use the old interface -#%style_map = %old_style_map; -#%style_map_pre = %old_style_map_pre; - -#FIXME USE_ISO ? -%unformatted_text_simple_map_texi = %simple_map_pre; -%unformatted_text_texi_map = %pre_map; -%unformatted_text_style_map_texi = (); - -foreach my $command (keys(%style_map_texi)) -{ - #$unformatted_text_style_map_texi{$command} = {}; - foreach my $key (keys (%{$style_map_texi{$command}})) - { - #print STDERR "$command, $key, $style_map_texi{$command}->{$key}\n"; - $unformatted_text_style_map_texi{$command}->{$key} = - $style_map_texi{$command}->{$key}; - } - $unformatted_text_style_map_texi{$command} = {} if (!defined($unformatted_text_style_map_texi{$command})); -} - -foreach my $accent_command ('tieaccent', 'dotless', keys(%unicode_accents)) -{ -# $unformatted_text_style_map_texi{$accent_command}->{'args'} = ['normal']; - $unformatted_text_style_map_texi{$accent_command}->{'function'} = \&t2h_default_accent; -} - -%format_map = ( -# 'quotation' => 'blockquote', - # lists -# 'itemize' => 'ul', - 'enumerate' => 'ol', - 'multitable' => 'table', - 'table' => 'dl compact="compact"', - 'vtable' => 'dl compact="compact"', - 'ftable' => 'dl compact="compact"', - 'group' => '', - ); - -%special_list_commands = ( - 'table' => {}, - 'vtable' => {}, - 'ftable' => {}, - 'itemize' => { 'bullet' => '' } - ); -# -# texinfo format to align attribute of paragraphs -# - -%paragraph_style = ( - 'center' => 'center', - 'flushleft' => 'left', - 'flushright' => 'right', - ); - -# an eval of these $complex_format_map->{what}->{'begin'} yields beginning -# an eval of these $complex_format_map->{what}->{'end'} yields end -# $EXAMPLE_INDENT_CELL and SMALL_EXAMPLE_INDENT_CELL can be usefull here -# FIXME add \n at the end ? -$complex_format_map = -{ - 'example' => - { - 'begin' => q{"<table><tr>$EXAMPLE_INDENT_CELL<td>"}, - 'end' => q{'</td></tr></table>'}, - }, - 'smallexample' => - { - 'begin' => q{"<table><tr>$SMALL_EXAMPLE_INDENT_CELL<td>"}, - 'end' => q{'</td></tr></table>'}, - }, - 'display' => - { - 'begin' => q{"<table><tr>$EXAMPLE_INDENT_CELL<td>"}, - 'end' => q{'</td></tr></table>'}, - }, - 'smalldisplay' => - { - 'begin' => q{"<table><tr>$SMALL_EXAMPLE_INDENT_CELL<td>"}, - 'end' => q{'</td></tr></table>'}, - } -}; - -# format shouldn't narrow the margins - -$complex_format_map->{'lisp'} = $complex_format_map->{'example'}; -$complex_format_map->{'smalllisp'} = $complex_format_map->{'smallexample'}; -$complex_format_map->{'format'} = $complex_format_map->{'display'}; -$complex_format_map->{'smallformat'} = $complex_format_map->{'smalldisplay'}; - -%def_map = ( - # basic commands - 'deffn', [ 'f', 'category', 'name', 'arg' ], - 'defvr', [ 'v', 'category', 'name' ], - 'deftypefn', [ 'f', 'category', 'type', 'name', 'arg' ], - 'deftypeop', [ 'f', 'category', 'class' , 'type', 'name', 'arg' ], - 'deftypevr', [ 'v', 'category', 'type', 'name' ], - 'defcv', [ 'v', 'category', 'class' , 'name' ], - 'deftypecv', [ 'v', 'category', 'class' , 'type', 'name' ], - 'defop', [ 'f', 'category', 'class' , 'name', 'arg' ], - 'deftp', [ 't', 'category', 'name', 'arg' ], - # basic x commands - # shortcuts - # i18n - 'defun', 'deffn Function', - 'defmac', 'deffn Macro', - 'defspec', 'deffn {Special Form}', - 'defvar', 'defvr Variable', - 'defopt', 'defvr {User Option}', - 'deftypefun', 'deftypefn {Function}', - 'deftypevar', 'deftypevr Variable', - 'defivar', 'defcv {Instance Variable}', - 'deftypeivar', 'deftypecv {Instance Variable}', - 'defmethod', 'defop Method', - 'deftypemethod', 'deftypeop Method', - ); - -foreach my $key (keys(%def_map)) -{ - $def_map{$key . 'x'} = $def_map{$key}; -} - -# -# miscalleneous commands -# -# Depending on the value, the command arg or spaces following the command -# are handled differently: -# -# the value is a reference on a hash. -# the hash keys are -# 'arg' if the value is 'line' then the remaining of the line is the arg -# if it is a number it is the number of args (separated by spaces) -# 'skip' if the value is 'line' then the remaining of the line is skipped -# if the value is 'space' space but no newline is skipped -# if the value is 'whitespace' space is skipped -# if the value is 'linewhitespace' space is skipped if there are -# only spaces remaining on the line -# if the value is 'linespace' space but no newline is skipped if -# there are only spaces remaining on the line -# 'texi' if true it is some texinfo code and @value and @macros are expanded -# 'keep' if true the args and the macro are kept, otherwise the macro -# args and skipped stuffs are removed -%misc_command = ( - # not needed for formatting - 'raisesections' => {'skip' => 'line'}, # no arg - 'lowersections' => {'skip' => 'line'}, # no arg - 'contents' => {}, # no arg - 'shortcontents' => {}, # no arg - 'summarycontents'=> {}, # no arg - 'detailmenu' => {'skip' => 'whitespace'}, # no arg - 'end detailmenu' => {'skip' => 'space'}, # no arg - #'end detailmenu', 1, # no arg - 'bye' => {'skip' => 'line'}, # no arg - # comments - 'comment' => {'arg' => 'line'}, - 'c' => {'arg' => 'line'}, - #'c'=> {'arg' => 'line', 'keep' => 1}, - # in preamble - 'novalidate' => {}, # no arg - 'dircategory'=> {'skip' => 'line'}, # line. Position with regard - # with direntry is significant - 'pagesizes' => {'skip' => 'line', 'arg' => 2}, # can have 2 args - 'finalout' => {}, # no arg - 'paragraphindent' => {'skip' => 'line', 'arg' => 1}, # arg none asis - # or a number and forbids anything else on the line - 'firstparagraphindent' => {'skip' => 'line', 'arg' => 1}, # none insert - 'exampleindent' => {'skip' => 'line', 'arg' => 1}, # asis or a number - 'footnotestyle'=> {'skip' => 'line', 'arg' => 1}, # end and separate - # and nothing else on the line - 'afourpaper' => {'skip' => 'line'}, # no arg - 'afourlatex' => {'skip' => 'line'}, # no arg - 'afourwide' => {'skip' => 'line'}, # no arg - 'headings'=> {'skip' => 'line', 'arg' => 1}, - #off on single double singleafter doubleafter - # interacts with setchapternewpage - 'setchapternewpage' => {'skip' => 'line', 'arg' => 1}, # off on odd - 'everyheading' => {'arg' => 'line'}, - 'everyfooting' => {'arg' => 'line'}, - 'evenheading' => {'arg' => 'line'}, - 'evenfooting' => {'arg' => 'line'}, - 'oddheading' => {'arg' => 'line'}, - 'oddfooting' => {'arg' => 'line'}, - 'smallbook' => {'skip' => 'line'}, # no arg - 'setfilename' => {'arg' => 'line'}, - 'shorttitle' => {'arg' => 'line', 'texi' => 1}, - 'shorttitlepage' => {'arg' => 'line', 'texi' => 1}, - 'settitle' => {'arg' => 'line', 'texi' => 1}, - 'author' => {'arg' => 'line', 'texi' => 1}, - 'subtitle' => {'arg' => 'line', 'texi' => 1}, - 'title' => {'arg' => 'line', 'texi' => 1}, - 'syncodeindex' => {'skip' => 'linespace', 'arg' => 2}, - # args are index identifiers - 'synindex' => {'skip' => 'linespace', 'arg' => 2}, - 'defindex' => {'skip' => 'line', 'arg' => 1}, # one identifier arg - 'defcodeindex' => {'skip' => 'line', 'arg' => 1}, # one identifier arg - 'documentlanguage' => {'skip' => 'whitespace', 'arg' => 1}, - # language code arg - 'kbdinputstyle' => {'skip' => 'whitespace', 'arg' => 1}, # code - #example distinct - 'sp' => {'skip' => 'whitespace', 'arg' => 1}, # no arg - # at the end of line or a numerical arg - # formatting - 'page' => {}, # no arg (pagebreak) - 'refill' => {}, # no arg (obsolete, to be ignored) - 'noindent' => {'skip' => 'space'}, # no arg - 'need' => {'skip' => 'line', 'arg' => 1}, # one numerical/real arg - 'exdent' => {'skip' => 'space'}, - # not valid for info (should be in @iftex) - 'vskip' => {'arg' => 'line'}, # arg line in TeX - 'cropmarks' => {}, # no arg - # miscalleneous - 'verbatiminclude'=> {'skip' => 'line'}, - 'noindent' => {'skip' => 'space'}, - 'documentencoding' => {'arg' => 1}, - # ??? - 'filbreak' => {}, - ); -my %misc_command_old = ( - # not needed for formatting - 'raisesections', 'line', # no arg - 'lowersections', 'line', # no arg - 'contents', 1, # no arg - 'shortcontents', 1, # no arg - 'summarycontents', 1, # no arg - 'detailmenu', 'whitespace', # no arg - 'end detailmenu', 'space', # no arg - #'end detailmenu', 1, # no arg - 'novalidate', 1, # no arg - 'bye', 'line', # no arg - # comments - 'comment', 'line', - 'c', 'line', - # in preamble - 'dircategory', 'line', # line. Position with regard with direntry is - # significant - 'pagesizes', 'line arg2', # can have 2 args - 'finalout', 1, # no arg - 'paragraphindent', 'line arg1', # in fact accepts only none asis - # or a number and forbids anything else on the line - 'firstparagraphindent', 'line arg1', # in fact accepts only none insert - 'exampleindent', 'line arg1', # in fact accepts only asis or a number - 'footnotestyle', 'line arg1', # in fact accepts only end and separate - # and nothing else on the line - 'afourpaper', 'line', # no arg - 'afourlatex', 'line', # no arg - 'afourwide', 'line', # no arg - 'headings', 'line', # one arg, possibilities are - #off on single double singleafter doubleafter - # interacts with setchapternewpage - 'setchapternewpage', 'line', # no arg - 'everyheading', 'line', - 'everyfooting', 'line', - 'evenheading', 'line', - 'evenfooting', 'line', - 'oddheading', 'line', - 'oddfooting', 'line', - 'smallbook', 'line', # no arg - 'setfilename', 'line', - 'shorttitle', 'linetexi', - 'shorttitlepage', 'linetexi', - 'settitle', 'linetexi', - 'author', 'linetexi', - 'subtitle', 'linetexi', - 'title','linetexi', - 'syncodeindex','linespace arg2', # args are - 'synindex','linespace arg2', - 'defindex', 'line arg1', # one identifier arg - 'defcodeindex', 'line arg1', # one identifier arg - 'documentlanguage', 'whitespace arg1', # one language code arg - 'kbdinputstyle', 'whitespace arg1', # one arg within - #code example distnct - 'sp', 'whitespace arg1', # no arg at the en of line or a numerical arg - # formatting - 'page', 1, # no arg (pagebreak) - 'refill', 1, # no arg (obsolete, to be ignored)) - 'noindent', 'space', # no arg - 'need', 'line arg1', # one numerical/real arg - 'exdent', 'space', - # not valid for info (should be in @iftex) - 'vskip', 'line', # arg line in TeX - 'cropmarks', 1, # no arg - # miscalleneous - 'verbatiminclude', 'line', - 'documentencoding', 'arg1', - # ??? - 'filbreak', 1, - ); - -%format_in_paragraph = ( - 'group' => 1, - 'html' => 1, -); -# map mapping css specification to style - -%css_map = - ( - 'ul.toc' => "$TOC_LIST_STYLE", - 'pre.menu-comment' => "$MENU_PRE_STYLE", - 'pre.menu-preformatted' => "$MENU_PRE_STYLE", - 'a.summary-letter' => 'text-decoration: none', - 'pre.display' => 'font-family: serif', - 'pre.smalldisplay' => 'font-family: serif; font-size: smaller', - 'pre.smallexample' => 'font-size: smaller', - 'span.sansserif' => 'font-family:sans-serif; font-weight:normal;' - ); - -$css_map{'pre.format'} = $css_map{'pre.display'}; -$css_map{'pre.smallformat'} = $css_map{'pre.smalldisplay'}; -$css_map{'pre.smalllisp'} = $css_map{'pre.smallexample'}; - -# formatting functions - -$anchor = \&t2h_default_anchor; -$def_item = \&t2h_default_def_item; -$def = \&t2h_default_def; -$menu = \&t2h_default_menu; -$menu_link = \&t2h_default_menu_link; -$menu_comment = \&t2h_default_menu_comment; -$menu_description = \&t2h_default_menu_description; -$simple_menu_link = \&t2h_default_simple_menu_link; -$external_ref = \&t2h_default_external_ref; -$external_href = \&t2h_default_external_href; -$internal_ref = \&t2h_default_internal_ref; -$table_item = \&t2h_default_table_item; -$table_line = \&t2h_default_table_line; -$table_list = \&t2h_default_table_list; -$row = \&t2h_default_row; -$cell = \&t2h_default_cell; -$list_item = \&t2h_default_list_item; -$comment = \&t2h_default_comment; -$def_line = \&t2h_default_def_line; -$def_line_no_texi = \&t2h_default_def_line_no_texi; -$raw = \&t2h_default_raw; -$heading = \&t2h_default_heading; -$paragraph = \&t2h_default_paragraph; -$preformatted = \&t2h_default_preformatted; -$foot_line_and_ref = \&t2h_default_foot_line_and_ref; -$foot_section = \&t2h_default_foot_section; -$image = \&t2h_default_image; -$address = \&t2h_default_address; -$index_entry_label = \&t2h_default_index_entry_label; -$index_summary = \&t2h_default_index_summary; -$summary_letter = \&t2h_default_summary_letter; -$index_entry = \&t2h_default_index_entry; -$index_letter = \&t2h_default_index_letter; -$print_index = \&t2h_default_print_index; -$protect_text = \&t2h_default_protect_text; -$complex_format = \&t2h_default_complex_format; -$cartouche = \&t2h_default_cartouche; -$sp = \&t2h_default_sp; -$definition_category = \&t2h_default_definition_category; -$copying_comment = \&t2h_default_copying_comment; -$index_summary_file_entry = \&t2h_default_index_summary_file_entry; -$index_summary_file_end = \&t2h_default_index_summary_file_end; -$index_summary_file_begin = \&t2h_default_index_summary_file_begin; -$empty_line = \&t2h_default_empty_line; -$unknown = \&t2h_default_unknown; -$unknown_style = \&t2h_default_unknown_style; -$caption_shortcaption = \&t2h_caption_shortcaption; -$float = \&t2h_default_float; -$listoffloats = \&t2h_default_listoffloats; -$listoffloats_entry = \&t2h_default_listoffloats_entry; -$listoffloats_caption = \&t2h_default_listoffloats_caption; -$listoffloats_float_style = \&t2h_default_listoffloats_float_style; -$listoffloats_style = \&t2h_default_listoffloats_style; -$acronym_like = \&t2h_default_acronym_like; -$quotation = \&t2h_default_quotation; -$quotation_prepend_text = \&t2h_default_quotation_prepend_text; -$paragraph_style_command = \&t2h_default_paragraph_style_command; - -# This function is called whenever a complex format is processed -# -# arguments: -# name of the format -# text appearing inside the format -# -# an eval of $complex_format->{format name}->{'begin'} should lead to the -# beginning of the complex format, an eval of -# $complex_format->{format name}->{'end'} should lead to the end of the -# complex format. -sub t2h_default_complex_format($$) -{ - my $name = shift; - my $text = shift; - return '' if ($text eq ''); - my $beginning = eval "$complex_format_map->{$name}->{'begin'}"; - if ($@ ne '') - { - print STDERR "$ERROR Evaluation of $complex_format_map->{$name}->{'begin'}: $@"; - $beginning = ''; - - } - my $end = eval "$complex_format_map->{$name}->{'end'}"; - if ($@ ne '') - { - print STDERR "$ERROR Evaluation of $complex_format_map->{$name}->{'end'}: $@"; - $end = ''; - - } - return $beginning . $text . $end; -} - -sub t2h_default_empty_line($) -{ - my $text = shift; - return $text; -} - -sub t2h_default_unknown($$) -{ - my $macro = shift; - my $line = shift; - - my ($result_line, $result, $result_text, $message); - return ($line, 0, undef, undef); -} - -sub t2h_default_unknown_style($$) -{ - my $command = shift; - my $text = shift; - - my ($result, $result_text, $message); - return (0, undef, undef); -} - -sub t2h_caption_shortcaption($) -{ - my $float = shift; - my $caption_lines; - my $shortcaption_lines; - my $style = $float->{'style_texi'}; - if (defined($float->{'nr'})) - { - my $nr = $float->{'nr'}; - if ($style ne '') - { - $style = &$I('%{style} %{number}', { 'style' => $style, 'number' => $nr}); - } - else - { - $style = $nr; - } - } - - if (defined($float->{'caption_texi'})) - { - @$caption_lines = @{$float->{'caption_texi'}}; - if (defined($style)) - { - $caption_lines->[0] = '@strong{' . &$I('%{style}: %{caption_first_line}', { 'style' => $style, 'caption_first_line' => $caption_lines->[0] }); - } - else - { - $caption_lines->[0] = '@strong{' . $caption_lines->[0]; - } - push @$caption_lines, "}\n"; - } - elsif (defined($style)) - { - $caption_lines->[0] = '@strong{' . $style . '}' . "\n"; - } - if (defined($float->{'shortcaption_texi'})) - { - @$shortcaption_lines = @{$float->{'shortcaption_texi'}}; - if (defined($style)) - { - $shortcaption_lines->[0] = '@strong{' . &$I('%{style}: %{shortcaption_first_line}', { 'style' => $style, 'shortcaption_first_line' => $shortcaption_lines->[0] }); - } - else - { - $shortcaption_lines->[0] = '@strong{' . $shortcaption_lines->[0]; - } - push @$shortcaption_lines, "}\n"; - } - elsif (defined($style)) - { - $shortcaption_lines->[0] = '@strong{' . $style . '}' . "\n"; - } - return ($caption_lines, $shortcaption_lines); -} - -sub t2h_default_float($$$$$) -{ - my $text = shift; - my $float = shift; - my $caption = shift; - my $shortcaption = shift; - - my $label = ''; - if (exists($float->{'id'})) - { - $label = &$anchor($float->{'id'}); - } - my $caption_text = ''; - - if (defined($float->{'caption_texi'})) - { - $caption_text = $caption; - } - elsif (defined($float->{'shortcaption_texi'})) - { - $caption_text = $shortcaption; - } - elsif (defined($caption)) - { - $caption_text = $caption; - } - - return '<div class="float">' . "$label\n" . $text . '</div>' . $caption_text; -} - -sub t2h_default_listoffloats_style($) -{ - my $style_texi = shift; - return ($style_texi); -} - -sub t2h_default_listoffloats_float_style($$) -{ - my $style_texi = shift; - my $float = shift; - - my $style = $float->{'style_texi'}; - if (defined($float->{'nr'})) - { - my $nr = $float->{'nr'}; - if ($style ne '') - { - $style = &$I('%{style} %{number}', { 'style' => $style, 'number' => $nr}); - } - else - { - $style = $nr; - } - } - return $style; -} - -sub t2h_default_listoffloats_caption($) -{ - my $float = shift; - if (defined($float->{'shortcaption_texi'})) - { - return [ @{$float->{'shortcaption_texi'}} ]; - } - elsif (defined($float->{'caption_texi'})) - { - return [ @{$float->{'caption_texi'}} ]; - } - return [ ]; -} - -sub t2h_default_listoffloats_entry($$$$) -{ - my $style_texi = shift; - my $float = shift; - my $float_style = shift; - my $caption = shift; - my $href = shift; - - return '<dt>' . &$anchor('', $href, $float_style) . '</dt><dd>' . $caption -. '</dd>' . "\n"; -} - -sub t2h_default_listoffloats($$$) -{ - my $style_texi = shift; - my $style = shift; - my $float_entries = shift; - - my $result = "<dl class=\"listoffloats\">\n" ; - foreach my $float_entry (@$float_entries) - { - $result .= $float_entry; - } - return $result . "</dl>\n"; -} - -# This function is used to protect characters which are special in html -# in inline text: &, ", <, and >. -# -# argument: -# text to be protected -sub t2h_default_protect_text($) -{ - my $text = shift; - $text =~ s/&/&/g; - $text =~ s/</</g; - $text =~ s/>/>/g; - $text =~ s/\"/"/g; - return $text; -} - -# This function produces an anchor -# -# arguments: -# $name : anchor name -# $href : anchor href -# text : text displayed -# extra_attribs : added to anchor attributes list -sub t2h_default_anchor($;$$$) -{ - my $name = shift; - my $href = shift; - my $text = shift; - my $attributes = shift; -#print STDERR "!$name!$href!$text!$attributes!\n"; - if (!defined($attributes) or ($attributes !~ /\S/)) - { - $attributes = ''; - } - else - { - $attributes = ' ' . $attributes; - } - $name = '' if (!defined($name) or ($name !~ /\S/)); - $href = '' if (!defined($href) or ($href !~ /\S/)); - $text = '' if (!defined($text)); - return $text if (($name eq '') and ($href eq '')); - $name = "name=\"$name\"" if ($name ne ''); - $href = "href=\"$href\"" if ($href ne ''); - $href = ' ' . $href if (($name ne '') and ($href ne '')); -#print STDERR "!!!$name!$href!$text!$attributes!\n"; - return "<a ${name}${href}${attributes}>$text</a>"; -} - -# This function is used to format the text associated with a @deff/@end deff -# -# argument: -# text -# -# $DEF_TABLE should be used to distinguish between @def formatted as table -# and as definition lists. -sub t2h_default_def_item($) -{ - my $text = shift; - if ($text =~ /\S/) - { - if (! $DEF_TABLE) - { - return '<dd>' . $text . '</dd>'; - } - else - { - return '<tr><td colspan="2">' . $text . '</td></tr>'; - } - } - return ''; -} - -sub t2h_default_definition_category($$$) -{ - my $name = shift; - my $class = shift; - my $style = shift; -# print STDERR "definition_category $name, class $class, style $style\n"; - return undef if (!defined($name) or $name =~ /^\s*$/); - return ($name) if (!defined($class) or $class =~ /^\s*$/); - if ($style eq 'f') - { - return &$I('%{name} on %{class}', { 'name' => $name, 'class' => $class }); - } - elsif ($style eq 'v') - { - return &$I('%{name} of %{class}', { 'name' => $name, 'class' => $class }); - } - else - { - return $name; - } -} - -# format the container for the @deffn line and text -# -# argument -# text of the whole @def, line and associated text. -# -# $DEF_TABLE should be used. -sub t2h_default_def($) -{ - my $text = shift; - if ($text =~ /\S/) - { - if (! $DEF_TABLE) - { - return "<dl>\n" . $text . "</dl>\n"; - } - else - { - return "<table width=\"100%\">\n" . $text . "</table>\n"; - } - } - return ''; - -} - -# a whole menu -# -# argument: -# the whole menu text (entries and menu comments) -# -# argument: -# whole menu text. -sub t2h_default_menu($) -{ - my $text = shift; - if ($text =~ /\S/) - { - return "<table class=\"menu\" border=\"0\" cellspacing=\"0\">\n" - . $text . "</table>\n"; - } -} - -# a simple menu entry ref in case we aren't in a standard menu context -sub t2h_default_simple_menu_link($$$$$$) -{ - my $entry = shift; - my $preformatted = shift; - my $href = shift; - my $node = shift; - my $name = shift; - my $ending = shift; - $ending = '' if (!defined($ending)); - if (($entry eq '') or $NODE_NAME_IN_MENU or $preformatted) - { - $name .= ':' if ($name ne ''); - $entry = "$MENU_SYMBOL$name$node"; - } - $entry = &$anchor('', $href, $entry) if ($href); - $entry .= $ending if ($preformatted); - return $entry . ' '; -} - -# formats a menu entry link pointing to a node or section -# -# arguments: -# the entry text -# the state, a hash reference holding informations about the context, with a -# usefull entry, 'preformatted', true if we are in a preformatted format -# (a format keeping space between words). In that case a function -# of the main program, main::do_preformatted($text, $state) might -# be used to format the text with the current format style. -# href is optionnal. It is the reference to the section or the node anchor -# which should be used to make the link (typically it is the argument -# of a href= attribute in a <a> element). -sub t2h_default_menu_link($$$$$$) -{ - my $entry = shift; - my $state = shift; - my $href = shift; - my $node = shift; - my $name = shift; - my $ending = shift; - if (($entry eq '') or $NODE_NAME_IN_MENU or $state->{'preformatted'}) - { - $name .= ':' if ($name ne ''); - $entry = "$MENU_SYMBOL$name$node"; - } - $entry = &$anchor ('', $href, $entry) if (defined($href)); - if ($state->{'preformatted'}) - { - return '<tr><td>' . main::do_preformatted($entry . $ending, $state); - } - return "<tr><td align=\"left\" valign=\"top\">$entry</td><td> </td>"; -} - -# formats a menu entry description, ie the text appearing after the node -# specification in a menu entry an spanning until there is another -# menu entry, an empty line or some text at the very beginning of the line -# (we consider that text at the beginning of the line begins a menu comment) -# -# arguments: -# the description text -# the state. See menu_entry. -sub t2h_default_menu_description($$) -{ - my $text = shift; - my $state = shift; - if ($state->{'preformatted'}) - { - return main::do_preformatted($text, $state) . '</td></tr>'; - } - return "<td align=\"left\" valign=\"top\">$text</td></tr>\n"; -} - -# a menu comment (between menu lines) -# formats the container of a menu comment. A menu comment is any text -# appearing between menu lines, either separated by an empty line from -# the preceding menu entry, or a text beginning at the first character -# of the line (text not at the very beginning of the line is considered to -# be the continuation of a menu entry description text). -# -# The text itself is considered to be in a preformatted environment -# with name 'menu-commment' and with style $MENU_PRE_STYLE. -# -# argument -# text contained in the menu comment. -sub t2h_default_menu_comment($) -{ - my $text = shift; - if ($text =~ /\S/) - { - return "<tr><th colspan=\"3\" align=\"left\" valign=\"top\">$text</th></tr>"; - } - return ''; -} - -# Construct a href to an external source of information. -# node is the node with texinfo @-commands -# node_id is the node transformed such that it is unique and can be used to -# make an html cross ref as explained in the texinfo manual -# file is the file in '(file)node' -sub t2h_default_external_href($$$) -{ - my $node = shift; - my $node_id = shift; - my $node_xhtml_id = shift; - my $file = shift; - $file = '' if (!defined($file)); - my $target_split = $EXTERNAL_CROSSREF_SPLIT; - if ($file ne '') - { - if ($NEW_CROSSREF_STYLE) - { - $file =~ s/\.[^\.]*$//; - $file =~ s/^.*\///; - my $href; - if (exists($Texi2HTML::THISDOC{'htmlxref'}->{$file})) - { - $target_split = $Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'split'}; - $href = $Texi2HTML::THISDOC{'htmlxref'}->{$file}->{'href'}; - } - if ($target_split) - { - if (defined($href)) - { - $file = "$href"; - } - elsif (defined($EXTERNAL_DIR)) - { - $file = "$EXTERNAL_DIR/$file"; - } - elsif ($SPLIT) - { - $file = "../$file"; - } - $file .= "/"; - } - else - {# target not split - if (defined($href)) - { - $file = "$href"; - } - else - { - if (defined($EXTERNAL_DIR)) - { - $file = "$EXTERNAL_DIR/$file"; - } - elsif ($SPLIT) - { - $file = "../$file"; - } - $file .= "." . $NODE_FILE_EXTENSION; - } - } - } - else - { - $file .= "/"; - if (defined($EXTERNAL_DIR)) - { - $file = $EXTERNAL_DIR . $file; - } - else - { - $file = '../' . $file; - } - } - } - else - { # here we necessarily have a ref to a node in the document, but the - # node is invalid - if ($NEW_CROSSREF_STYLE) - { - if (!$SPLIT) - { - $file = $TOP_FILE; - } - } - } - if ($node eq '') - { - if ($NEW_CROSSREF_STYLE) - { - if ($SPLIT) - { - return $file . $TOP_NODE_FILE . '.' . $NODE_FILE_EXTENSION . '#Top'; - # or ? - #return $file . '#Top'; - } - else - { - return $file . '#Top'; - } - } - else - { - return $file; - } - } - my $target; - if ($NEW_CROSSREF_STYLE) - { - $node = $node_id; - $target = $node_xhtml_id; - } - else - { - $node = main::remove_texi($node); - $node =~ s/[^\w\.\-]/-/g; - } - my $file_basename = $node; - $file_basename = $TOP_NODE_FILE if ($node =~ /^top$/i); - if ($NEW_CROSSREF_STYLE) - { - if ($SPLIT) - { - return $file . $file_basename . ".$NODE_FILE_EXTENSION" . '#' . $target; - } - else - { - return $file . '#' . $target; - } - } - else - { - return $file . $file_basename . ".$NODE_FILE_EXTENSION"; - } -} -# format a reference external to the generated manual. This produces a full -# reference with introductive words and the reference itself. -# -# arguments: -# type of the reference: xref (reference at the beginning of a sentence), -# pxref (reference in a parenthesis), -# section in the book. This might be undef. -# book name. -# node and file name formatted according to the convention used in info -# '(file)node' and no node means the Top node. -# href linking to the html page containing the referenced node. A typical -# use for this href is a href attribute in an <a> element -# an optionnal cross reference name -sub t2h_default_external_ref($$$$$$) -{ - my $type = shift; - my $section = shift; - my $book = shift; - my $file_node = shift; - my $href = shift; - my $cross_ref = shift; - - $file_node = "$cross_ref: $file_node" if (($file_node ne '') and ($cross_ref ne '')); - $file_node = &$anchor('', $href, $file_node) if ($file_node ne ''); - - # Yes, this is ugly, but this helps internationalization - if ($type eq 'pxref') - { - if (($book ne '') and ($file_node ne '')) - { - return &$I('see %{node_file_href} section `%{section}\' in @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('see %{node_file_href} @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book }); - } - elsif ($book ne '') - { - return &$I('see section `%{section}\' in @cite{%{book}}', { 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('see @cite{%{book}}', { 'book' => $book }); - } - elsif ($file_node ne '') - { - return &$I('see %{node_file_href}', { 'node_file_href' => $file_node }); - } - } - if ($type eq 'xref') - { - if (($book ne '') and ($file_node ne '')) - { - return &$I('See %{node_file_href} section `%{section}\' in @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('See %{node_file_href} @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book }); - } - elsif ($book ne '') - { - return &$I('See section `%{section}\' in @cite{%{book}}', { 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('See @cite{%{book}}', { 'book' => $book }); - } - elsif ($file_node ne '') - { - return &$I('See %{node_file_href}', { 'node_file_href' => $file_node }); - } - } - if ($type eq 'ref') - { - if (($book ne '') and ($file_node ne '')) - { - return &$I('%{node_file_href} section `%{section}\' in @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('%{node_file_href} @cite{%{book}}', { 'node_file_href' => $file_node, 'book' => $book }); - } - elsif ($book ne '') - { - return &$I('section `%{section}\' in @cite{%{book}}', { 'book' => $book, 'section' => $section }) if ($section ne ''); - return &$I('@cite{%{book}}', { 'book' => $book }); - } - elsif ($file_node ne '') - { - return &$I('%{node_file_href}', { 'node_file_href' => $file_node }); - } - } - return ''; -} - -# format a reference to a node or a section in the generated manual. This -# produces a full reference with introductive words and the reference itself. -# -# arguments: -# type of the reference: xref (reference at the beginning of a sentence), -# pxref (reference in a parenthesis), -# href linking to the html page containing the node or the section. A typical -# use for this href is a href attribute in an <a> element -# short name for this reference -# name for this reference -# boolean true if the reference is a reference to a section -# -# $SHORT_REF should be used. -sub t2h_default_internal_ref($$$$$) -{ - my $type = shift; - my $href = shift; - my $short_name = shift; - my $name = shift; - my $is_section = shift; - - if (! $SHORT_REF) - { - $name = &$anchor('', $href, $name); - if ($type eq 'pxref') - { - return &$I('see section %{reference_name}', { 'reference_name' => $name }) if ($is_section); - return &$I('see %{reference_name}', { 'reference_name' => $name }); - } - elsif ($type eq 'xref') - { - return &$I('See section %{reference_name}', { 'reference_name' => $name }) if ($is_section); - return &$I('See %{reference_name}', { 'reference_name' => $name }); - } - elsif ($type eq 'ref') - { - return &$I('%{reference_name}', { 'reference_name' => $name }); - } - } - else - { - $name = &$anchor('', $href, $short_name); - if ($type eq 'pxref') - { - return &$I('see %{reference_name}', { 'reference_name' => $name }); - } - elsif ($type eq 'xref') - { - return &$I('See %{reference_name}', { 'reference_name' => $name }); - } - elsif ($type eq 'ref') - { - return &$I('%{reference_name}', { 'reference_name' => $name }); - } - } - return ''; -} - -# text after @item in table, vtable and ftable -sub t2h_default_table_item($$$$$) -{ - my $text = shift; - my $index_label = shift; - my $format = shift; - my $command = shift; - my $formatted_command = shift; - $formatted_command = '' if (!defined($formatted_command) or - exists($special_list_commands{$format}->{$command})); - $text .= "\n" . $index_label if (defined($index_label)); - return '<dt>' . $formatted_command . $text . '</dt>' . "\n"; -} - -# format text on the line following @item (in table, vtable and ftable) -sub t2h_default_table_line($) -{ - my $text = shift; - - if ($text =~ /\S/) - { - return '<dd>' . $text . '</dd>' . "\n"; - } - return ''; -} - -# row in multitable -sub t2h_default_row($$) -{ - my $text = shift; - my $macro = shift; - - if ($text =~ /\S/) - { - if ($macro eq 'headitem') - { - return '<thead><tr>' . $text . '</tr></thead>' . "\n"; - } - return '<tr>' . $text . '</tr>' . "\n"; - } - return ''; -} - -# cell in multitable -sub t2h_default_cell($$) -{ - my $text = shift; - my $row_macro = shift; - - if ($row_macro eq 'headitem') - { - return '<th>' . $text . '</th>'; - } - return '<td>' . $text . '</td>'; -} - -# format an item in a list -# -# argument: -# text of the item -# format of the list (itemize or enumerate) -# command passed as argument to the format -# formatted_command leading command formatted, if it is a thing command -sub t2h_default_list_item($$$$$$$) -{ - my $text = shift; - my $format = shift; - my $command = shift; - my $formatted_command = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - - $formatted_command = '' if (!defined($formatted_command) or - exists($special_list_commands{$format}->{$command})); - if ($text =~ /\S/) - { - return '<li>' . $formatted_command . $text . '</li>'; - } - return ''; -} - -sub t2h_default_table_list($$$$$$) -{ - my $format = shift; - my $text = shift; - my $command = shift; - my $formatted_command = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - $formatted_command = '' if (!defined($formatted_command) or - exists($special_list_commands{$format}->{$command})); - if ($format eq 'itemize') - { - return "<ul>\n" . $text . "</ul>\n" if ($command eq 'bullet'); - return "<ul$TOC_LIST_ATTRIBUTE>\n" . $text . "</ul>\n"; - } -} - -# an html comment -sub t2h_default_comment($) -{ - my $text = shift; - while ($text =~ /-->/) # --> ends an html comment ! - { - $text =~ s/-->/->/go; - } - return '<!--' . $text . '-->' . "\n"; -} - -# a paragraph -# arguments: -# $text of the paragraph -# $align for the alignement -# The following is usefull if the paragraph is in an itemize. -# $paragraph_command is the leading formatting command (like @minus) -# $paragraph_command_formatted is the leading formatting command formatted -# $paragraph_number is a reference on the number of paragraphs appearing -# in the format. The value should be increased if a paragraph is done -# $format is the format name (@itemize) -sub t2h_default_paragraph($$$$$$$$$) -{ - my $text = shift; - my $align = shift; - my $paragraph_command = shift; - my $paragraph_command_formatted = shift; - my $paragraph_number = shift; - my $format = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; -#print STDERR "format: $format\n" if (defined($format)); - $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or - exists($special_list_commands{$format}->{$paragraph_command})); - #my $in_term = shift; - return '' if ($text =~ /^\s*$/); - if (defined($paragraph_number) and defined($$paragraph_number)) - { - $$paragraph_number++; - #return $text . "\n" if (($format eq 'itemize' or $format eq 'enumerate') and - return $text if (($format eq 'itemize' or $format eq 'enumerate') and - ($$paragraph_number == 1)); - } - my $open = '<p>'; - if ($align) - { - $open = "<p align=\"$paragraph_style{$align}\">"; - } - return $open. "$text</p>"; -} - -# a preformatted region -# arguments: -# $text of the preformatted region -# $pre_style css style -# $class identifier for the preformatted region (example, menu-comment) -# The following is usefull if the preformatted is in an itemize. -# $leading_command is the leading formatting command (like @minus) -# $leading_command_formatted is the leading formatting command formatted -# $preformatted_number is a reference on the number of preformatteds appearing -# in the format. The value should be increased if a preformatted is done -sub t2h_default_preformatted($$$$$$$$$$) -{ - my $text = shift; - my $pre_style = shift; - my $class = shift; - my $leading_command = shift; - my $leading_command_formatted = shift; - my $preformatted_number = shift; - my $format = shift; - my $item_nr = shift; - my $enumerate_style = shift; - my $number = shift; - - return '' if ($text eq ''); - $leading_command_formatted = '' if (!defined($leading_command_formatted) or - exists($special_list_commands{$format}->{$leading_command})); - if (defined($preformatted_number) and defined($$preformatted_number)) - { - $$preformatted_number++; - } - return "<pre class=\"$class\">$text</pre>"; -} - -# This function formats a heading for an element -# -# argument: -# an element. It is a hash reference for a node or a sectionning command. -# The interesting keys are: -# 'text': the heading text -# 'name': the heading text without section number -# 'node': true if it is a node -# 'level': level of the element. 0 for @top, 1 for chapter, heading, -# appendix..., 2 for section and so on... -# 'tag_level': the sectionning element name, raisesections and lowersections -# taken into account -# -# relevant configuration variable: -# $NUMBER_SECTIONS -sub t2h_default_heading($) -{ - my $element = shift; - my $level = 3; - if (!$element->{'node'}) - { - $level = $element->{'level'}; - } - $level = 1 if ($level == 0); - my $text = $element->{'text'}; - if (!$element->{'node'} and (!$NUMBER_SECTIONS)) - { - $text = $element->{'name'}; - } - return '' if ($text !~ /\S/); - my $class = $element->{'tag_level'}; - $class = 'unnumbered' if ($class eq 'top'); - if (defined($element->{'tocid'}) and $TOC_LINKS) - { - $text = &$anchor ('', "$Texi2HTML::THISDOC{'toc_file'}#$element->{'tocid'}", $text); - } - return "<h$level class=\"$class\"> $text </h$level>\n"; -} - -# formatting of raw regions -# ih L2H is true another mechanism is used for tex -sub t2h_default_raw($$) -{ - my $style = shift; - my $text = shift; - if ($style eq 'verbatim' or $style eq 'tex') - { - return "<pre class=\"$style\">" . &$protect_text($text) . '</pre>'; - } - elsif ($style eq 'html') - { - return $text; - } - else - { - warn "$WARN (bug) unknown style $style\n"; - return &$protect_text($text); - } -} - -# This function formats a footnote reference and the footnote text associated -# with a given footnote. -# The footnote reference is the text appearing in the main document pointing -# to the footnote text. -# -# arguments: -# absolute number of the footnote (in the document) -# relative number of the footnote (in the page) -# identifier for the footnote -# identifier for the footnote reference in the main document -# main document file -# footnote text file -# array with the footnote text lines -# the state. See menu entry. -# -# returns: -# reference on an array containing the footnote text lines which should -# have been updated -# the text for the reference pointing on the footnote text -sub t2h_default_foot_line_and_ref($$$$$$$) -{ - my $number_in_doc = shift; - my $number_in_page = shift; - my $footnote_id = shift; - my $place_id = shift; - my $document_file = shift; - my $footnote_file = shift; - my $lines = shift; - my $state = shift; - - unshift (@$lines, '<h3>' . - &$anchor($footnote_id, $document_file . "#$place_id", - "($number_in_doc)") - . "</h3>\n"); - return ($lines, &$anchor($place_id, $footnote_file . "#$footnote_id", - "($number_in_doc)")); -} - -# formats a group of footnotes. -# -# argument: -# array reference on the footnotes texts lines -# -# returns an array reference on the group of footnotes lines -sub t2h_default_foot_section($) -{ - my $lines = shift; - unshift (@$lines, "<div class=\"footnote\">\n" ,"$DEFAULT_RULE\n", "<h3>" . &$I('Footnotes') . "</h3>\n"); - push (@$lines, "</div>\n"); - return $lines; -} - -# format an image -# -# arguments: -# image file name with path -# image basename or alt text -# a boolean true if we are in a preformatted format -# image file name without path -sub t2h_default_image($$$$) -{ - my $file = shift; - my $base = shift; - my $preformatted = shift; - my $file_name = shift; - return "[ $base ]" if ($preformatted); - return "<img src=\"$file\" alt=\"$base\">"; -} - -# address put in footer describing when was generated and who did the manual -sub t2h_default_address($$) -{ - my $user = shift; - my $date = shift; - $user = '' if (!defined($user)); - $date = '' if (!defined($date)); - if (($user ne '') and ($date ne '')) - { - return &$I('by @emph{%{user}} on @emph{%{date}}', { 'user' => $user, - 'date' => $date }); - } - elsif ($user ne '') - { - return &$I('by @emph{%{user}}', { 'user' => $user }); - } - elsif ($date ne '') - { - return &$I('on @emph{%{date}}', { 'date' => $date }); - } - return ''; -} - -# format a target in the main document for an index entry. -# -# arguments: -# target identifier -# boolean true if in preformatted format -sub t2h_default_index_entry_label($$) -{ - my $identifier = shift; - my $preformatted = shift; - - return '' if (!defined($identifier) or ($identifier !~ /\S/)); - my $label = &$anchor($identifier); - return $label . "\n" if (!$preformatted); - return $label; -} - -# process definition commands line @deffn for example -sub t2h_default_def_line($$$$$) -{ - my $category = shift; - my $name = shift; - my $type = shift; - my $arguments = shift; - my $index_label = shift; - $index_label = '' if (!defined($index_label)); - $name = '' if (!defined($name) or ($name =~ /^\s*$/)); - $type = '' if (!defined($type) or $type =~ /^\s*$/); - if (!defined($arguments) or $arguments =~ /^\s*$/) - { - $arguments = ''; - } - else - { - $arguments = '<i>' . $arguments . '</i>'; - } - my $type_name = ''; - $type_name = " $type" if ($type ne ''); - $type_name .= ' <b>' . $name . '</b>' if ($name ne ''); - $type_name .= $arguments . "\n"; - if (! $DEF_TABLE) - { - return '<dt>'. '<u>' . $category . ':</u>' . $type_name . $index_label . "</dt>\n"; - } - else - { - - return "<tr>\n<td align=\"left\">" . $type_name . - "</td>\n<td align=\"right\">" . $category . $index_label . "</td>\n" . "</tr>\n"; - } -} - -# process definition commands line @deffn for example while removing texi -# commands -sub t2h_default_def_line_no_texi($$$$$) -{ - my $category = shift; - my $name = shift; - my $type = shift; - my $arguments = shift; - $name = '' if (!defined($name) or ($name =~ /^\s*$/)); - $type = '' if (!defined($type) or $type =~ /^\s*$/); - if (!defined($arguments) or $arguments =~ /^\s*$/) - { - $arguments = ''; - } - my $type_name = ''; - $type_name = " $type" if ($type ne ''); - $type_name .= ' ' . $name if ($name ne ''); - $type_name .= $arguments; - if (! $DEF_TABLE) - { - return $category . ':' . $type_name . "\n"; - } - else - { - - return $type_name . " " . $category . "\n"; - } -} - -# a cartouche -sub t2h_default_cartouche($$) -{ - my $text = shift; - - if ($text =~ /\S/) - { - return "<table class=\"cartouche\" border=\"1\"><tr><td>\n" . $text . "</td></tr></table>\n"; - } - return ''; -} - -# key: -# origin_href: -# entry: -# texi entry: -# element_href: -# element_text: -sub t2h_default_index_summary_file_entry ($$$$$$$$) -{ - my $index_name = shift; - my $key = shift; - my $origin_href = shift; - my $entry = shift; - my $texi_entry = shift; - my $element_href = shift; - my $element_text = shift; - my $is_printed = shift; - print IDXFILE "key: $key\n origin_href: $origin_href\n entry: $entry\n" - . " texi_entry: $texi_entry\n" - . " element_href: $element_href\n element_text: $element_text\n"; -} - -sub t2h_default_index_summary_file_begin($$) -{ - my $name = shift; - my $is_printed = shift; - open(IDXFILE, ">$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}" . "_$name.idx") - || die "Can't open >$Texi2HTML::THISDOC{'destination_directory'}$Texi2HTML::THISDOC{'file_base_name'}" . "_$name.idx for writing: $!\n"; -} - -sub t2h_default_index_summary_file_end($$) -{ - my $name = shift; - my $is_printed = shift; - close (IDXFILE); -} - -sub t2h_default_sp($$) -{ - my $number = shift; - my $preformatted = shift; - return "<br>\n" x $number if (!$preformatted); - return "\n" x $number; -} - -sub t2h_default_acronym_like($$$$$$) -{ - my $command = shift; - my $acronym_texi = shift; - my $acronym_text = shift; - my $with_explanation = shift; - my $explanation_lines = shift; - my $explanation_text = shift; - my $explanation_unformatted = shift; - - my $attribute = $command; - my $opening = "<$attribute>"; - if (defined($explanation_unformatted)) - { - $opening = "<$attribute title=\"$explanation_unformatted\">"; - } - if ($with_explanation) - { - return &$I('%{acronym_like} (%{explanation})', {'acronym_like' => $opening . $acronym_text . "</$attribute>", 'explanation' => $explanation_text}) - } - else - { - return $opening . $acronym_text . "</$attribute>"; - } -} - -sub t2h_default_quotation_prepend_text($$) -{ - my $style = shift; - my $text = shift; - return &$I('@b{%{quotation_arg}:} ', {'quotation_arg' => $text}, {'keep_texi' => 1}) if (defined($text)); - return undef; -} - -sub t2h_default_quotation($$$$) -{ - my $text = shift; - my $argument_text = shift; - my $argument_style_texi = shift; - my $argument_style_id = shift; -# if (defined($argument_text)) -# { -# return '<blockquote>' . &$I('%{style}:%{quotation}', -# {'style' => $argument_text, 'quotation' => $text}) . '</blockquote>' ; -# } - return '<blockquote>' . $text . "</blockquote>\n"; -} - -# format the text within a paragraph style format, -# -# argument: -# format name -# text within the format -sub t2h_default_paragraph_style_command($$) -{ - my $format = shift; - my $text = shift; - return $text; -} - -# format a whole index -# -# argument: -# index text -# index name -sub t2h_default_print_index($$) -{ - my $text = shift; - my $name = shift; - return "<table border=\"0\" class=\"index-$name\">\n" . - "<tr><td></td><th align=\"left\">" . &$I('Index Entry') . "</th><th align=\"left\"> " . &$I('Section') . "</th></tr>\n" - . "<tr><td colspan=\"3\"> $DEFAULT_RULE</td></tr>\n" . $text . - "</table>\n"; -} - -# format a letter entry in an index page. The letter entry contains -# the index entries for the words beginning with that letter. It is -# a target for links pointing from the summary of the index. -# -# arguments: -# the letter -# identifier for the letter entry. This should be used to make the target -# identifier -# text of the index entries -sub t2h_default_index_letter($$$) -{ - my $letter = shift; - my $id = shift; - my $text = shift; - return '<tr><th>' . &$anchor($id,'',&$protect_text($letter)) . - "</th><td></td><td></td></tr>\n" . $text . - "<tr><td colspan=\"3\"> $DEFAULT_RULE</td></tr>\n"; -} - -# format an index entry (in a letter entry). -# -# arguments: -# href to the main text, linking to the place where the index entry appears -# entry text -# href to the main text, linking to the section or node where the index -# entry appears -# section or node heading -sub t2h_default_index_entry($$$$) -{ - my $text_href = shift; - my $entry = shift; - my $element_href = shift; - my $element_text = shift; - - return '<tr><td></td><td valign="top">' . &$anchor('', $text_href, $entry) - . '</td><td valign="top">' . &$anchor('', $element_href, $element_text) - . "</td></tr>\n"; -} - - -sub t2h_default_copying_comment($) -{ - my $copying_lines = shift; - my $text = &$comment(main::remove_texi(@$copying_lines)); - return $text; -} -# format a letter appearing in a summary for an index. The letter links to -# the place where the index elements beginning with this letter are (called -# a letter entry). -# -# arguments: -# letter -# file where the target letter entry is -# identifier for the target letter entry -sub t2h_default_summary_letter($$$) -{ - my $letter = shift; - my $file = shift; - my $identifier = shift; - return &$anchor('', $file . '#' . $identifier, '<b>' . &$protect_text($letter) . '</b>', 'class="summary-letter"'); -} - -# format an index summary. This is a list of letters linking to the letter -# entries. -# -# arguments: -# array reference containing the formatted alphabetical letters -# array reference containing the formatted non lphabetical letters -sub t2h_default_index_summary($$) -{ - my $alpha = shift; - my $nonalpha = shift; - my $join = ''; - my $nonalpha_text = ''; - my $alpha_text = ''; - $join = " \n<br>\n" if (@$nonalpha and @$alpha); - if (@$nonalpha) - { - $nonalpha_text = join("\n \n", @$nonalpha) . "\n"; - } - if (@$alpha) - { - $alpha_text = join("\n \n", @$alpha) . "\n \n"; - } - return "<table><tr><th valign=\"top\">" . &$I('Jump to') .": </th><td>" . - $nonalpha_text . $join . $alpha_text . "</td></tr></table>\n"; -} - -1; diff --git a/Build/source/utils/texi2html/texi2html.pl b/Build/source/utils/texi2html/texi2html.pl deleted file mode 100755 index cd7f445b738..00000000000 --- a/Build/source/utils/texi2html/texi2html.pl +++ /dev/null @@ -1,11827 +0,0 @@ -#! /usr/bin/env perl -'di '; -'ig 00 '; -#+############################################################################## -# -# texi2html: Program to transform Texinfo documents to HTML -# -# Copyright (C) 1999, 2000 Free Software Foundation, Inc. -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, 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 -# -#-############################################################################## - -# This requires perl version 5 or higher -#require 5.0; - -# for POSIX::setlocale and File::Spec -require 5.00405; -# Perl pragma to restrict unsafe constructs -use strict; -# used in case of tests, to revert to "C" locale. -use POSIX qw(setlocale LC_ALL LC_CTYPE); -# used to find a relative path back to the current working directory -use File::Spec; -# -# According to -# larry.jones@sdrc.com (Larry Jones) -# this pragma is not present in perl5.004_02: -# -# Perl pragma to control optional warnings -# use warnings; - -# Declarations. Empty lines separate the different classes of variables: - - -#++############################################################################## -# -# NOTE FOR DEBUGGING THIS SCRIPT: -# You can run 'perl texi2html.pl' directly, provided you have -# the environment variable T2H_HOME set to the directory containing -# the texi2html.init file -# -#--############################################################################## - -# CVS version: -# $Id: texi2html.pl,v 1.126 2005/02/04 00:14:39 pertusus Exp $ - -# Homepage: -my $T2H_HOMEPAGE = "http://texi2html.cvshome.org/"; - -# Authors (appears in comments): -my $T2H_AUTHORS = <<EOT; -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> -EOT - -# Version: set in configure.in -my $THISVERSION = '@PACKAGE_VERSION@'; -my $THISPROG = "texi2html $THISVERSION"; # program name and version - -# set by configure, prefix for the sysconfdir and so on -my $prefix = '@prefix@'; -my $sysconfdir; -my $pkgdatadir; -my $datadir; - -# We need to eval as $prefix has to be expanded. However when we haven't -# run configure @sysconfdir will be expanded as an array, thus we verify -# whether configure was run or not -if ('@sysconfdir@' ne '@' . 'sysconfdir@') -{ - $sysconfdir = eval '"@sysconfdir@"'; -} -else -{ - $sysconfdir = "/usr/local/etc"; -} - -if ('@datadir@' ne '@' . 'datadir@') -{ - $pkgdatadir = eval '"@datadir@/@PACKAGE@"'; - $datadir = eval '"@datadir@"'; -} -else -{ - $pkgdatadir = "/usr/local/share/texi2html"; - $datadir = "/usr/local/share"; -} -# The man page for this program is included at the end of this file and can be -# viewed using the command 'nroff -man texi2html'. - -#+++############################################################################ -# # -# Constants # -# # -#---############################################################################ - -my $DEBUG_MENU = 1; -my $DEBUG_INDEX = 2; -my $DEBUG_TEXI = 4; -my $DEBUG_MACROS = 8; -my $DEBUG_FORMATS = 16; -my $DEBUG_ELEMENTS = 32; -my $DEBUG_USER = 64; -my $DEBUG_L2H = 128; - -my $ERROR = "***"; # prefix for errors -my $WARN = "**"; # prefix for warnings - -my $VARRE = '[\w\-]+'; # RE for a variable name -my $NODERE = '[^:]+'; # RE for node names - -my $MAX_LEVEL = 4; -my $MIN_LEVEL = 1; - -my $i18n_dir = 'i18n'; # name of the directory containing the per language files -my $conf_file_name = 'Config' ; -my $texinfo_htmlxref = 'htmlxref.cnf'; - -# directories for texi2html init files -my @texi2html_config_dirs = ('./'); -push @texi2html_config_dirs, "$ENV{'HOME'}/.texi2html/" if (defined($ENV{'HOME'})); -push @texi2html_config_dirs, "$sysconfdir/texi2html/" if (defined($sysconfdir)); -push @texi2html_config_dirs, "$pkgdatadir" if (defined($pkgdatadir)); - -# directories for texinfo configuration files -my @texinfo_config_dirs = ('./.texinfo/'); -push @texinfo_config_dirs, "$ENV{'HOME'}/.texinfo/" if (defined($ENV{'HOME'})); -push @texinfo_config_dirs, "$sysconfdir/texinfo/" if (defined($sysconfdir)); -push @texinfo_config_dirs, "$datadir/texinfo/" if (defined($datadir)); - -#+++############################################################################ -# # -# Initialization # -# Pasted content of File $(srcdir)/texi2html.init: Default initializations # -# # -#---############################################################################ - -# leave this within comments, and keep the require statement -# This way, you can directly run texi2html.pl, if $ENV{T2H_HOME}/texi2html.init -# exists. - -{ -package Texi2HTML::Config; - - -sub load($) -{ - my $file = shift; - eval { require($file) ;}; - if ($@ ne '') - { - print STDERR "error loading $file: $@\n"; - return 0; - } - return 1; -} - -# customization options variables - -use vars qw( -$DEBUG -$PREFIX -$VERBOSE -$SUBDIR -$IDX_SUMMARY -$SPLIT -$SHORT_REF -@EXPAND -$EXPAND -$TOP -$DOCTYPE -$FRAMESET_DOCTYPE -$CHECK -$TEST -$DUMP_TEXI -$MACRO_EXPAND -$USE_GLOSSARY -$INVISIBLE_MARK -$USE_ISO -$TOP_FILE -$TOC_FILE -$FRAMES -$SHOW_MENU -$NUMBER_SECTIONS -$USE_NODES -$USE_UNICODE -$NODE_FILES -$NODE_NAME_IN_MENU -$AVOID_MENU_REDUNDANCY -$SECTION_NAVIGATION -$SHORTEXTN -$EXTENSION -$OUT -$NOVALIDATE -$DEF_TABLE -$LANG -$DO_CONTENTS -$DO_SCONTENTS -$SEPARATED_FOOTNOTES -$TOC_LINKS -$L2H -$L2H_L2H -$L2H_SKIP -$L2H_TMP -$L2H_CLEAN -$L2H_FILE -$L2H_HTML_VERSION -$EXTERNAL_DIR -@INCLUDE_DIRS -@PREPEND_DIRS -$IGNORE_PREAMBLE_TEXT -@CSS_FILES -); - -# customization variables -use vars qw( -$ENCODING -$DOCUMENT_ENCODING -$MENU_PRE_STYLE -$CENTER_IMAGE -$EXAMPLE_INDENT_CELL -$SMALL_EXAMPLE_INDENT_CELL -$SMALL_FONT_SIZE -$SMALL_RULE -$DEFAULT_RULE -$MIDDLE_RULE -$BIG_RULE -$TOP_HEADING -$INDEX_CHAPTER -$SPLIT_INDEX -$HREF_DIR_INSTEAD_FILE -$AFTER_BODY_OPEN -$PRE_BODY_CLOSE -$EXTRA_HEAD -$VERTICAL_HEAD_NAVIGATION -$WORDS_IN_PAGE -$ICONS -$UNNUMBERED_SYMBOL_IN_MENU -$MENU_SYMBOL -$OPEN_QUOTE_SYMBOL -$CLOSE_QUOTE_SYMBOL -$TOC_LIST_STYLE -$TOC_LIST_ATTRIBUTE -$TOP_NODE_FILE -$NODE_FILE_EXTENSION -$BEFORE_OVERVIEW -$AFTER_OVERVIEW -$BEFORE_TOC_LINES -$AFTER_TOC_LINES -$NEW_CROSSREF_STYLE -%ACTIVE_ICONS -%NAVIGATION_TEXT -%PASSIVE_ICONS -%BUTTONS_GOTO -%BUTTONS_EXAMPLE -@CHAPTER_BUTTONS -@MISC_BUTTONS -@SECTION_BUTTONS -@SECTION_FOOTER_BUTTONS -@NODE_FOOTER_BUTTONS -); - -# customization variables which may be guessed in the script -#our $ADDRESS; -use vars qw( -$BODYTEXT -$CSS_LINES -$DOCUMENT_DESCRIPTION -$EXTERNAL_CROSSREF_SPLIT -); - -# I18n -use vars qw( -$I -$LANGUAGES -); - -# customizable subroutines references -use vars qw( -$print_section -$one_section -$end_section -$print_Top_header -$print_Top_footer -$print_Top -$print_Toc -$print_Overview -$print_Footnotes -$print_About -$print_misc_header -$print_misc_footer -$print_misc -$print_section_header -$print_section_footer -$print_chapter_header -$print_chapter_footer -$print_page_head -$print_page_foot -$print_head_navigation -$print_foot_navigation -$button_icon_img -$print_navigation -$about_body -$print_frame -$print_toc_frame -$toc_body -$titlepage -$css_lines -$print_redirection_page -$init_out -$finish_out -$node_file_name -$element_file_name - -$protect_text -$anchor -$def_item -$def -$menu -$menu_link -$menu_description -$menu_comment -$simple_menu_link -$ref_beginning -$info_ref -$book_ref -$external_href -$external_ref -$internal_ref -$table_item -$table_line -$row -$cell -$list_item -$comment -$def_line -$def_line_no_texi -$raw -$heading -$paragraph -$preformatted -$foot_line_and_ref -$foot_section -$address -$image -$index_entry_label -$index_entry -$index_letter -$print_index -$index_summary -$summary_letter -$complex_format -$cartouche -$sp -$definition_category -$table_list -$copying_comment -$index_summary_file_entry -$index_summary_file_end -$index_summary_file_begin -$style -$format -$normal_text -$empty_line -$unknown -$unknown_style -$float -$caption_shortcaption -$listoffloats -$listoffloats_entry -$listoffloats_caption -$listoffloats_float_style -$listoffloats_style -$acronym_like -$quotation -$quotation_prepend_text -$paragraph_style_command - -$PRE_ABOUT -$AFTER_ABOUT -); - -# hash which entries might be redefined by the user -use vars qw( -$complex_format_map -%accent_map -%def_map -%format_map -%simple_map -%simple_map_pre -%simple_map_texi -%style_map -%style_map_pre -%style_map_texi -%unformatted_text_simple_map_texi -%unformatted_text_style_map_texi -%unformatted_text_texi_map -%paragraph_style -%things_map -%pre_map -%texi_map -%unicode_map -%unicode_diacritical -%ascii_character_map -%ascii_simple_map -%ascii_things_map -%perl_charset_to_html -%iso_symbols -%misc_command -%css_map -%format_in_paragraph -%special_list_commands -%accent_letters -%unicode_accents -%special_accents -); - -$I = \&Texi2HTML::I18n::get_string; - -$toc_body = \&T2H_GPL_toc_body; -$style = \&T2H_GPL_style; -$format = \&T2H_GPL_format; -$normal_text = \&t2h_gpl_normal_text; - -sub T2H_GPL_toc_body($) -{ - my $elements_list = shift; -# my $do_contents = shift; -# my $do_scontents = shift; - #return unless ($do_contents or $do_scontents or $FRAMES); - return unless ($DO_CONTENTS or $DO_SCONTENTS or $FRAMES); - my $current_level = 0; - my $ul_style = $NUMBER_SECTIONS ? $TOC_LIST_ATTRIBUTE : ''; - foreach my $element (@$elements_list) - { - next if ($element->{'top'} or $element->{'index_page'}); - my $ind = ' ' x $current_level; - my $level = $element->{'toc_level'}; - print STDERR "Bug no toc_level for ($element) $element->{'texi'}\n" if (!defined ($level)); - if ($level > $current_level) - { - while ($level > $current_level) - { - $current_level++; - my $ln = "\n$ind<ul${ul_style}>\n"; - $ind = ' ' x $current_level; - push(@{$Texi2HTML::TOC_LINES}, $ln); - } - } - elsif ($level < $current_level) - { - while ($level < $current_level) - { - $current_level--; - $ind = ' ' x $current_level; - my $line = "</li>\n$ind</ul>"; - $line .= "</li>" if ($level == $current_level); - push(@{$Texi2HTML::TOC_LINES}, "$line\n"); - - } - } - else - { - push(@{$Texi2HTML::TOC_LINES}, "</li>\n"); - } - my $file = ''; - $file = $element->{'file'} if ($SPLIT); - my $text = $element->{'text'}; - $text = $element->{'name'} unless ($NUMBER_SECTIONS); - my $entry = "<li>" . &$anchor ($element->{'tocid'}, "$file#$element->{'id'}",$text); - push (@{$Texi2HTML::TOC_LINES}, $ind . $entry); - push(@{$Texi2HTML::OVERVIEW}, $entry. "</li>\n") if ($level == 1); - } - while (0 < $current_level) - { - $current_level--; - my $ind = ' ' x $current_level; - push(@{$Texi2HTML::TOC_LINES}, "</li>\n$ind</ul>\n"); - } - #@{$Texi2HTML::TOC_LINES} = () unless ($do_contents); - @{$Texi2HTML::TOC_LINES} = () unless ($DO_CONTENTS); - if (@{$Texi2HTML::TOC_LINES}) - { - unshift @{$Texi2HTML::TOC_LINES}, $BEFORE_TOC_LINES; - push @{$Texi2HTML::TOC_LINES}, $AFTER_TOC_LINES; - } - #@{$Texi2HTML::OVERVIEW} = () unless ($do_scontents or $FRAMES); - @{$Texi2HTML::OVERVIEW} = () unless ($DO_SCONTENTS or $FRAMES); - if (@{$Texi2HTML::OVERVIEW}) - { - unshift @{$Texi2HTML::OVERVIEW}, "<ul${ul_style}>\n"; - push @{$Texi2HTML::OVERVIEW}, "</ul>\n"; - unshift @{$Texi2HTML::OVERVIEW}, $BEFORE_OVERVIEW; - push @{$Texi2HTML::OVERVIEW}, $AFTER_OVERVIEW; - } -} - -sub T2H_GPL_style($$$$$$$$$) -{ # known style - my $style = shift; - my $command = shift; - my $text = shift; - my $args = shift; - my $no_close = shift; - my $no_open = shift; - my $line_nr = shift; - my $state = shift; - my $style_stack = shift; - - my $do_quotes = 0; - my $use_attribute = 0; - my $use_begin_end = 0; - if (ref($style) eq 'HASH') - { - #print STDERR "GPL_STYLE $command\n"; - #print STDERR " @$args\n"; - $do_quotes = $style->{'quote'}; - if ((@{$style->{'args'}} == 1) and defined($style->{'attribute'})) - { - $style = $style->{'attribute'}; - $use_attribute = 1; - $text = $args->[0]; - } - elsif (defined($style->{'function'})) - { - $text = &{$style->{'function'}}($command, $args, $style_stack, $state, $line_nr); - } - } - else - { - if ($style =~ s/^\"//) - { # add quotes - $do_quotes = 1; - } - if ($style =~ s/^\&//) - { # custom - $style = 'Texi2HTML::Config::' . $style; - eval "\$text = &$style(\$text, \$command, \$style_stack)"; - } - elsif ($style ne '') - { - $use_attribute = 1; - } - else - { # no style - } - } - if ($use_attribute) - { # good style - my $attribute_text = ''; - if ($style =~ /^(\w+)(\s+.*)/) - { - $style = $1; - $attribute_text = $2; - } - if ($do_quotes) - { - $text = $OPEN_QUOTE_SYMBOL . "$text" if (!$no_open); - $text .= $CLOSE_QUOTE_SYMBOL if (!$no_close); - } - $text = "<${style}$attribute_text>$text</$style>" ; - } - if (ref($style) eq 'HASH') - { - if (defined($style->{'begin'}) and !$no_open) - { - $text = $style->{'begin'} . $text; - } - if (defined($style->{'end'}) and !$no_close) - { - $text = $text . $style->{'end'}; - } - } - if ($do_quotes and !$use_attribute) - { - $text = $OPEN_QUOTE_SYMBOL . "$text" if (!$no_open); - $text .= $CLOSE_QUOTE_SYMBOL if (!$no_close); - } - return $text; -} - -sub T2H_GPL_format($$$) -{ - my $tag = shift; - my $element = shift; - my $text = shift; - return '' if (!defined($element) or ($text !~ /\S/)); - return $text if ($element eq ''); - my $attribute_text = ''; - if ($element =~ /^(\w+)(\s+.*)/) - { - $element = $1; - $attribute_text = $2; - } - return "<${element}$attribute_text>\n" . $text. "</$element>\n"; -} - -sub t2h_gpl_normal_text($) -{ - my $text = shift; - $text =~ s/``/"/go; - $text =~ s/''/"/go; - $text =~ s/-(--?)/$1/go; - return $text; -} -# @INIT@ - -require "$ENV{T2H_HOME}/texi2html.init" - if ($0 =~ /\.pl$/ && - -e "$ENV{T2H_HOME}/texi2html.init" && -r "$ENV{T2H_HOME}/texi2html.init"); - -my $translation_file = 'translations.pl'; # file containing all the translations -my $T2H_OBSOLETE_STRINGS; -require "$ENV{T2H_HOME}/$translation_file" - if ($0 =~ /\.pl$/ && - -e "$ENV{T2H_HOME}/$translation_file" && -r "$ENV{T2H_HOME}/$translation_file"); - -# @T2H_TRANSLATIONS_FILE@ -my $index_name = -1; -my @index_to_hash = ('style_map', 'style_map_pre', 'style_map_texi'); -foreach my $hash (\%style_map, \%style_map_pre, \%style_map_texi, \%unformatted_text_style_map_texi) -{ - $index_name++; - my $name = $index_to_hash[$index_name]; - foreach my $style (keys(%{$hash})) - { - next unless (ref($hash->{$style}) eq 'HASH'); - $hash->{$style}->{'args'} = ['normal'] if (!exists($hash->{$style}->{'args'})); - die "Bug: args not defined for $style in $name" if (!defined($hash->{$style}->{'args'})); -#print STDERR "DEFAULT($name, $hash) add normal as arg for $style ($hash->{$style}), $hash->{$style}->{'args'}\n"; - } -} - -sub t2h_utf8_accent($$) -{ - my $accent = shift; - my $args = shift; - my $style_stack = shift; - - my $text = $args->[0]; - - if ($accent eq 'dotless') - { # \x{0131}\x{0308} for @dotless{i} @" doesn't lead to NFC 00ef. - if (($text eq 'i') and (!defined($style_stack->[-2]) or (!defined($unicode_accents{$style_stack->[-2]})) or ($style_stack->[-2] eq 'tieaccent'))) - { - return "\x{0131}"; - } - #return "\x{}" if ($text eq 'j'); # not found ! - return $text; - } - - return Unicode::Normalize::NFC($text . chr(hex($unicode_diacritical{$accent}))) - if (defined($unicode_diacritical{$accent})); - return ascii_accents($text, $accent); -} - -sub t2h_utf8_normal_text($) -{ - my $text = shift; - $text =~ s/---/\x{2014}/g; - $text =~ s/--/\x{2013}/g; - $text =~ s/``/\x{201C}/g; - $text =~ s/''/\x{201D}/g; - return $text; -} - -sub t2h_cross_manual_normal_text($) -{ - my $text = shift; - $text = main::normalise_space($text); - my $result = ''; - while ($text ne '') - { - if ($text =~ s/^([A-Za-z0-9]+)//o) - { - $result .= $1; - } - elsif ($text =~ s/^ //o) - { - $result .= '-'; - } - elsif ($text =~ s/^(.)//o) - { - if (exists($ascii_character_map{$1})) - { - $result .= '_' . lc($ascii_character_map{$1}); - } - elsif ($USE_UNICODE) - { - $result .= $1; - } - else - { - $result .= '_' . '00' . lc(sprintf("%02x",ord($1))); - } - } - else - { - print STDERR "Bug: unknown character in node (likely in infinite loop)\n"; - sleep 1; - } - } - - return $result; -} - -sub t2h_nounicode_cross_manual_accent($$) -{ - my $accent = shift; - my $args = shift; - - my $text = $args->[0]; - - return '_' . lc($unicode_accents{$accent}->{$text}) - if (defined($unicode_accents{$accent}->{$text})); - return ($text . '_' . lc($unicode_diacritical{$accent})) - if (defined($unicode_diacritical{$accent})); - return ascii_accents($text, $accent); -} - -$USE_UNICODE = '@USE_UNICODE@'; -if ($USE_UNICODE eq '@USE_UNICODE@') -{ - $USE_UNICODE = 1; - eval { - require Encode; - require Unicode::Normalize; - Encode->import('encode'); - }; - $USE_UNICODE = 0 if ($@); -} - -} - -use vars qw( -%value -); - -# This is deprecated -#our %user_sub; - -# variables which might be redefined by the user but aren't likely to be -# they seem to be in the main namespace -use vars qw( -$index_properties -%predefined_index -%valid_index -%sec2level -%code_style_map -%region_lines -); - -# Some global variables are set in the script, and used in the subroutines -# they are in the Texi2HTML namespace, thus prefixed with Texi2HTML::. -# see texi2html.init for details. - -#+++############################################################################ -# # -# Initialization # -# Pasted content of File $(srcdir)/MySimple.pm: Command-line processing # -# # -#---############################################################################ - -# leave this within comments, and keep the require statement -# This way, you can directly run texi2html.pl, if $ENV{T2H_HOME}/texi2html.init -# exists. - -# @MYSIMPLE@ - -require "$ENV{T2H_HOME}/MySimple.pm" - if ($0 =~ /\.pl$/ && - -e "$ENV{T2H_HOME}/MySimple.pm" && -r "$ENV{T2H_HOME}/MySimple.pm"); - -#+++############################################################################ -# # -# Initialization # -# Pasted content of File $(srcdir)/T2h_i18n.pm: Internationalisation # -# # -#---############################################################################ - -# leave this within comments, and keep the require statement -# This way, you can directly run texi2html.pl, if $ENV{T2H_HOME}/T2h_i18n.pm -# exists. - -# @T2H_I18N@ -require "$ENV{T2H_HOME}/T2h_i18n.pm" - if ($0 =~ /\.pl$/ && - -e "$ENV{T2H_HOME}/T2h_i18n.pm" && -r "$ENV{T2H_HOME}/T2h_i18n.pm"); - - -{ -package Texi2HTML::LaTeX2HTML::Config; - -# latex2html variables -# These variables are not used. They are here for information only, and -# an example of config file for latex2html file is included. -my $ADDRESS; -my $ANTI_ALIAS; -my $ANTI_ALIAS_TEXT; -my $ASCII_MODE; -my $AUTO_LINK; -my $AUTO_PREFIX; -my $CHILDLINE; -my $DEBUG; -my $DESTDIR; -my $ERROR; -my $EXTERNAL_FILE; -my $EXTERNAL_IMAGES; -my $EXTERNAL_UP_LINK; -my $EXTERNAL_UP_TITLE; -my $FIGURE_SCALE_FACTOR; -my $HTML_VERSION; -my $IMAGES_ONLY; -my $INFO; -my $LINE_WIDTH; -my $LOCAL_ICONS; -my $LONG_TITLES; -my $MATH_SCALE_FACTOR; -my $MAX_LINK_DEPTH; -my $MAX_SPLIT_DEPTH; -my $NETSCAPE_HTML; -my $NOLATEX; -my $NO_FOOTNODE; -my $NO_IMAGES; -my $NO_NAVIGATION; -my $NO_SIMPLE_MATH; -my $NO_SUBDIR; -my $PAPERSIZE; -my $PREFIX; -my $PS_IMAGES; -my $REUSE; -my $SCALABLE_FONTS; -my $SHORTEXTN; -my $SHORT_INDEX; -my $SHOW_SECTION_NUMBERS; -my $SPLIT; -my $TEXDEFS; -my $TITLE; -my $TITLES_LANGUAGE; -my $TMP; -my $VERBOSE; -my $WORDS_IN_NAVIGATION_PANEL_TITLES; -my $WORDS_IN_PAGE; - -# @T2H_L2H_INIT@ -} - -package main; - -# -# pre-defined indices -# -$index_properties = -{ - 'c' => { name => 'cp'}, - 'f' => { name => 'fn', code => 1}, - 'v' => { name => 'vr', code => 1}, - 'k' => { name => 'ky', code => 1}, - 'p' => { name => 'pg', code => 1}, - 't' => { name => 'tp', code => 1} -}; - - -%predefined_index = ( - 'cp', 'c', - 'fn', 'f', - 'vr', 'v', - 'ky', 'k', - 'pg', 'p', - 'tp', 't', - ); - -# -# valid indices -# -%valid_index = ( - 'c', 1, - 'f', 1, - 'v', 1, - 'k', 1, - 'p', 1, - 't', 1, - ); - -# -# commands with ---, -- '' and `` preserved -# usefull with the old interface - -%code_style_map = ( - 'code' => 1, - 'command' => 1, - 'env' => 1, - 'file' => 1, - 'kbd' => 1, - 'option' => 1, - 'samp' => 1, - 'verb' => 1, -); - -my $simple_map_ref = \%Texi2HTML::Config::simple_map; -my $simple_map_pre_ref = \%Texi2HTML::Config::simple_map_pre; -my $simple_map_texi_ref = \%Texi2HTML::Config::simple_map_texi; -my $style_map_ref = \%Texi2HTML::Config::style_map; -my $style_map_pre_ref = \%Texi2HTML::Config::style_map_pre; -my $style_map_texi_ref = \%Texi2HTML::Config::style_map_texi; -my $things_map_ref = \%Texi2HTML::Config::things_map; -my $pre_map_ref = \%Texi2HTML::Config::pre_map; -my $texi_map_ref = \%Texi2HTML::Config::texi_map; - -# delete from hash if we are using te new interface -foreach my $code (keys(%code_style_map)) -{ - delete ($code_style_map{$code}) - if (ref($style_map_ref->{$code}) eq 'HASH'); -} - -# no paragraph in these commands -my %no_paragraph_macro = ( - 'xref' => 1, - 'ref' => 1, - 'pxref' => 1, - 'inforef' => 1, - 'anchor' => 1, -); - - -#foreach my $command (keys(%Texi2HTML::Config::style_map)) -#{ -# next unless (ref($style_map_ref->{$command}) eq 'HASH'); -# print STDERR "CMD: $command\n"; -# die "Bug: no args for $command in style_map\n" unless defined($style_map_ref->{$command}->{'args'}); -# die "Bug: no args for $command in style_map_pre\n" unless defined($style_map_pre_ref->{$command}->{'args'}); -# die "Bug: non existence of args for $command in style_map_texi\n" unless (exists($style_map_texi_ref->{$command}->{'args'})); -# die "Bug: no args for $command in style_map_texi\n" unless defined($style_map_texi_ref->{$command}->{'args'}); -#} - -# -# texinfo section names to level -# -%sec2level = ( - 'top', 0, - 'chapter', 1, - 'unnumbered', 1, - 'chapheading', 1, - 'appendix', 1, - 'section', 2, - 'unnumberedsec', 2, - 'heading', 2, - 'appendixsec', 2, - 'subsection', 3, - 'unnumberedsubsec', 3, - 'subheading', 3, - 'appendixsubsec', 3, - 'subsubsection', 4, - 'unnumberedsubsubsec', 4, - 'subsubheading', 4, - 'appendixsubsubsec', 4, - ); - -# the reverse mapping. There is an entry for each sectionning command. -# The value is a ref on an array containing at each index the corresponding -# sectionning command name. -my %level2sec; -{ - my $sections = [ ]; - my $appendices = [ ]; - my $unnumbered = [ ]; - my $headings = [ ]; - foreach my $command (keys (%sec2level)) - { - if ($command =~ /^appendix/) - { - $level2sec{$command} = $appendices; - } - elsif ($command =~ /^unnumbered/ or $command eq 'top') - { - $level2sec{$command} = $unnumbered; - } - elsif ($command =~ /section$/ or $command eq 'chapter') - { - $level2sec{$command} = $sections; - } - else - { - $level2sec{$command} = $headings; - } - $level2sec{$command}->[$sec2level{$command}] = $command; - } -} - -# this are synonyms -$sec2level{'appendixsection'} = 2; -# sec2level{'majorheading'} is also 1 and not 0 -$sec2level{'majorheading'} = 1; -$sec2level{'chapheading'} = 1; -# FIXME this one could be centered... -$sec2level{'centerchap'} = 1; - -# regions treated especially. The text for these regions is collected in the -# corresponding array -%region_lines = ( - 'titlepage' => [ ], - 'documentdescription' => [ ], - 'copying' => [ ], -); - -# those macros aren't considered as beginning a paragraph -my %no_line_macros = ( - 'macro' => 1, - 'unmacro' => 1, - 'rmacro' => 1, - 'set' => 1, - 'clear' => 1, - 'titlefont' => 1, - 'include' => 1, - 'copying' => 1, - 'end copying' => 1, - 'tab' => 1, - 'item' => 1, - 'itemx' => 1, - '*' => 1, - 'float' => 1, - 'end float' => 1, - 'caption' => 1, - 'shortcaption' => 1, -); - -foreach my $key (keys(%Texi2HTML::Config::misc_command)) -{ - $no_line_macros{$key} = 1; -} - -# a hash associating a format @thing / @end thing with the type of the format -# 'complex' 'simple' 'deff' 'list' 'menu' 'paragraph_style' -my %format_type = (); - -foreach my $simple_format (keys(%Texi2HTML::Config::format_map)) -{ - $format_type{$simple_format} = 'simple'; - $no_line_macros{$simple_format} = 1; - $no_line_macros{"end $simple_format"} = 1; -} -foreach my $paragraph_style (keys(%Texi2HTML::Config::paragraph_style)) -{ - $format_type{$paragraph_style} = 'paragraph_style'; - $no_line_macros{$paragraph_style} = 1; - $no_line_macros{"end $paragraph_style"} = 1; -} -foreach my $complex_format (keys(%$Texi2HTML::Config::complex_format_map)) -{ - $format_type{$complex_format} = 'complex'; - $no_line_macros{$complex_format} = 1; - $no_line_macros{"end $complex_format"} = 1; -} -foreach my $table (('table', 'ftable', 'vtable', 'multitable')) -{ - $format_type{$table} = 'table'; - $no_line_macros{$table} = 1; - $no_line_macros{"end $table"} = 1; -} -foreach my $def_format (keys(%Texi2HTML::Config::def_map)) -{ - $format_type{$def_format} = 'deff'; - $no_line_macros{$def_format} = 1; - $no_line_macros{"end $def_format"} = 1; -} -$format_type{'itemize'} = 'list'; -$format_type{'enumerate'} = 'list'; - -$format_type{'menu'} = 'menu'; - -$format_type{'cartouche'} = 'cartouche'; - -$format_type{'float'} = 'float'; - -$format_type{'quotation'} = 'quotation'; - -$format_type{'group'} = 'group'; - -foreach my $macro (('itemize', 'enumerate', 'menu', 'cartouche', 'float', 'quotation')) -{ - $no_line_macros{$macro} = 1; - $no_line_macros{"end $macro"} = 1; -} - -foreach my $macro (keys(%Texi2HTML::Config::format_in_paragraph)) -{ - $no_line_macros{$macro} = 1; - $no_line_macros{"end $macro"} = 1; -} - -# fake format at the bottom of the stack -$format_type{'noformat'} = ''; - -# fake formats are formats used internally within other formats -# we associate them with a real format, for the error messages -my %fake_format = ( - 'line' => 'table', - 'term' => 'table', - 'item' => 'list or table', - 'row' => 'multitable row', - 'cell' => 'multitable cell', - 'deff_item' => 'definition command', - 'menu_comment' => 'menu', - 'menu_description' => 'menu', - 'menu_preformatted' => 'menu', - ); - -foreach my $key (keys(%fake_format)) -{ - $format_type{$key} = 'fake'; -} - -# A hash associating style @-comand with the type, 'accent', real 'style', -# 'simple' style, or 'special'. -my %style_type = (); -foreach my $style (keys(%Texi2HTML::Config::style_map)) -{ - $style_type{$style} = 'style'; -} -foreach my $accent (keys(%Texi2HTML::Config::unicode_accents), 'tieaccent', 'dotless') -{ - $style_type{$accent} = 'accent'; -} -foreach my $simple ('ctrl', 'w', 'url') -{ - $style_type{$simple} = 'simple'; -} -foreach my $special ('footnote', 'ref', 'xref', 'pxref', 'inforef', 'anchor', 'image') -{ - $style_type{$special} = 'special'; -} - -# raw formats which are expanded especially -my @raw_regions = ('html', 'verbatim', 'tex', 'xml', 'docbook'); - -# special raw formats which are expanded between first and second pass -# and are replaced by specific commands. Currently used for tex. It takes -# precedence over raw_regions. -my @special_regions = (); - -# regions expanded or not depending on the value of this hash -my %text_macros = ( - 'iftex' => 0, - 'ignore' => 0, - 'menu' => 0, - 'ifplaintext' => 0, - 'ifinfo' => 0, - 'ifxml' => 0, - 'ifhtml' => 0, - 'ifdocbook' => 0, - 'html' => 0, - 'tex' => 0, - 'xml' => 0, - 'titlepage' => 1, - 'documentdescription' => 1, - 'copying' => 1, - 'ifnothtml' => 1, - 'ifnottex' => 1, - 'ifnotplaintext' => 1, - 'ifnotinfo' => 1, - 'ifnotxml' => 1, - 'ifnotdocbook' => 1, - 'direntry' => 0, - 'verbatim' => 'raw', - 'ifclear' => 'value', - 'ifset' => 'value' - ); - - - -foreach my $key (keys(%text_macros)) -{ - unless ($text_macros{$key} eq 'raw') - { - $no_line_macros{$key} = 1; - $no_line_macros{"end $key"} = 1; - } -} - -# The css formats are associated with complex format commands, and associated -# with the 'pre_style' key -foreach my $complex_format (keys(%$Texi2HTML::Config::complex_format_map)) -{ - next if (defined($Texi2HTML::Config::complex_format_map->{$complex_format}->{'pre_style'})); - $Texi2HTML::Config::complex_format_map->{$complex_format}->{'pre_style'} = ''; - $Texi2HTML::Config::complex_format_map->{$complex_format}->{'pre_style'} = $Texi2HTML::Config::css_map{"pre.$complex_format"} if (exists($Texi2HTML::Config::css_map{"pre.$complex_format"})); -} - -#+++############################################################################ -# # -# Argument parsing, initialisation # -# # -#---############################################################################ - -# -# flush stdout and stderr after every write -# -select(STDERR); -$| = 1; -select(STDOUT); -$| = 1; - -#FIXME my or our ? -my $I = \&Texi2HTML::I18n::get_string; - -my $T2H_USER; # user running the script -my $documentdescription; # text in @documentdescription - -# shorthand for Texi2HTML::Config::VERBOSE -my $T2H_VERBOSE; - -sub echo_warn($;$); -#print STDERR "" . &$I('test i18n: \' , \a \\ %% %{unknown}a %known % %{known} \\', { 'known' => 'a known string', 'no' => 'nope'}); exit 0; - -# file: file name to locate. It can be a file path. -# all_files: if true collect all the files with that name, otherwise stop -# at first match. -# directories: a reference on a array containing a list of directories to -# search the file in. default is \@texi2html_config_dirs. -sub locate_init_file($;$$) -{ - my $file = shift; - my $all_files = shift; - my $directories = shift; - - $directories = \@texi2html_config_dirs if !defined($directories); - - if ($file =~ /^\//) - { - return $file if (-e $file and -r $file); - } - else - { - my @files; - foreach my $dir (@$directories) - { - next unless (-d "$dir"); - if ($all_files) - { - push (@files, "$dir/$file") if (-e "$dir/$file" and -r "$dir/$file"); - } - else - { - return "$dir/$file" if (-e "$dir/$file" and -r "$dir/$file"); - } - } - return @files if ($all_files); - } - return undef; -} - -# called on -init-file -sub load_init_file -{ - # First argument is option - shift; - # second argument is value of options - my $init_file = shift; - my $file; - if ($file = locate_init_file($init_file)) - { - print STDERR "# reading initialization file from $file\n" - if ($T2H_VERBOSE); - return (Texi2HTML::Config::load($file)); - } - else - { - print STDERR "$ERROR Error: can't read init file $init_file\n"; - return 0; - } -} - -my $cmd_line_lang = 0; # 1 if lang was succesfully set by the command line - # in that case @documentlanguage is ignored. -my $lang_set = 0; # 1 if lang was set - -# -# called on -lang -sub set_document_language ($;$$) -{ - my $lang = shift; - my $from_command_line = shift; - my $line_nr = shift; - my @files = locate_init_file("$i18n_dir/$lang", 1); - foreach my $file (@files) - { - Texi2HTML::Config::load($file); - } - if (Texi2HTML::I18n::set_language($lang)) - { - print STDERR "# using '$lang' as document language\n" if ($T2H_VERBOSE); - $Texi2HTML::Config::LANG = $lang; - $lang_set = 1; - $cmd_line_lang = 1 if ($from_command_line); - if (!$Texi2HTML::Config::TEST) - { - $Texi2HTML::THISDOC{'today'} = Texi2HTML::I18n::pretty_date($Texi2HTML::Config::LANG); # like "20 September 1993"; - } - else - { - $Texi2HTML::THISDOC{'today'} = 'a sunny day'; - } - $things_map_ref->{'today'} = $Texi2HTML::THISDOC{'today'}; - $pre_map_ref->{'today'} = $Texi2HTML::THISDOC{'today'}; - $texi_map_ref->{'today'} = $Texi2HTML::THISDOC{'today'}; - } - else - { - echo_error ("Language specs for '$lang' do not exists. Reverting to '$Texi2HTML::Config::LANG'", $line_nr); - } -} - -sub set_expansion($$) -{ - my $region = shift; - my $set = shift; - $set = 1 if (!defined($set)); - if ($set) - { - push (@Texi2HTML::Config::EXPAND, $region) unless (grep {$_ eq $region} @Texi2HTML::Config::EXPAND); - } - else - { - @Texi2HTML::Config::EXPAND = grep {$_ ne $region} @Texi2HTML::Config::EXPAND; - } -} - -sub set_encoding($) -{ - my $encoding = shift; - if ($Texi2HTML::Config::USE_UNICODE) - { - if (! Encode::resolve_alias($encoding)) - { - echo_warn("Encoding $Texi2HTML::Config::DOCUMENT_ENCODING unknown"); - return undef; - } - print STDERR "# Using encoding " . Encode::resolve_alias($encoding) . "\n" - if ($T2H_VERBOSE); - return Encode::resolve_alias($encoding); - } - else - { - echo_warn("Nothing specific done for encodings (due to the perl version)"); - return undef; - } -} - -my %cross_ref_texi_map = %Texi2HTML::Config::texi_map; -my %cross_ref_simple_map_texi = %Texi2HTML::Config::simple_map_texi; -my %cross_ref_style_map_texi = (); - -foreach my $command (keys(%Texi2HTML::Config::style_map_texi)) -{ - $cross_ref_style_map_texi{$command} = {}; - foreach my $key (keys (%{$Texi2HTML::Config::style_map_texi{$command}})) - { -#print STDERR "$command, $key, $style_map_texi{$command}->{$key}\n"; - $cross_ref_style_map_texi{$command}->{$key} = - $Texi2HTML::Config::style_map_texi{$command}->{$key}; - } -} - -$cross_ref_simple_map_texi{"\n"} = ' '; - - -# This function is used to construct a link name from a node name as -# described in the proposal I posted on texinfo-pretest. -sub cross_manual_links($$) -{ - my $nodes_hash = shift; - my $cross_reference_hash = shift; - - $simple_map_texi_ref = \%cross_ref_simple_map_texi; - $style_map_texi_ref = \%cross_ref_style_map_texi; - $texi_map_ref = \%cross_ref_texi_map; - my $normal_text_kept = $Texi2HTML::Config::normal_text; - $Texi2HTML::Config::normal_text = \&Texi2HTML::Config::t2h_cross_manual_normal_text; - - foreach my $key (keys(%$nodes_hash)) - { - my $node = $nodes_hash->{$key}; - next if ($node->{'index_page'}); - if (!defined($node->{'texi'})) - { - # begin debug section - foreach my $key (keys(%$node)) - { - #print STDERR "$key:$node->{$key}!!!\n"; - } - # end debug section - } - else - { - if ($Texi2HTML::Config::USE_UNICODE) - { - my $text = $node->{'texi'}; -#print STDERR "CROSS_MANUAL $node->{'texi'}\n"; - if (defined($Texi2HTML::Config::DOCUMENT_ENCODING) and - Encode::resolve_alias($Texi2HTML::Config::DOCUMENT_ENCODING) and - (Encode::resolve_alias($Texi2HTML::Config::DOCUMENT_ENCODING) ne 'utf8')) - { - $text = Encode::decode($Texi2HTML::Config::DOCUMENT_ENCODING, $text); - } - $node->{'cross_manual_target'} = unicode_to_protected(Unicode::Normalize::NFC(remove_texi($text))); - } - else - { - $node->{'cross_manual_target'} = remove_texi($node->{'texi'}); - } -#print STDERR "CROSS_MANUAL_TARGET $node->{'cross_manual_target'}\n"; - unless ($node->{'external_node'}) - { - if (defined($cross_reference_hash->{$node->{'cross_manual_target'}})) - { - echo_error("Node equivalent with `$node->{'texi'}' allready used `$cross_reference_hash->{$node->{'cross_manual_target'}}'"); - } - else - { - $cross_reference_hash->{$node->{'cross_manual_target'}} = $node->{'texi'}; - } - } - #print STDERR "$node->{'texi'}: $node->{'cross_manual_target'}\n"; - } - } - - $Texi2HTML::Config::normal_text = $normal_text_kept; - $simple_map_texi_ref = \%Texi2HTML::Config::simple_map_texi; - $style_map_texi_ref = \%Texi2HTML::Config::style_map_texi; - $texi_map_ref = \%Texi2HTML::Config::texi_map; -} - -sub unicode_to_protected($) -{ - my $text = shift; - my $result = ''; - while ($text ne '') - { - if ($text =~ s/^([A-Za-z0-9_\-]+)//o) - { - $result .= $1; - } - elsif ($text =~ s/^(.)//o) - { - $result .= '_' . lc(sprintf("%04x",ord($1))); - } - else - { - print STDERR "Bug: unknown character in node (likely in infinite loop)\n"; - sleep 1; - } - } - - return $result; -} - -sub cross_manual_line($) -{ - my $text = shift; -#print STDERR "cross_manual_line $text\n"; - $simple_map_texi_ref = \%cross_ref_simple_map_texi; - $style_map_texi_ref = \%cross_ref_style_map_texi; - $texi_map_ref = \%cross_ref_texi_map; - my $normal_text_kept = $Texi2HTML::Config::normal_text; - $Texi2HTML::Config::normal_text = \&Texi2HTML::Config::t2h_cross_manual_normal_text; - - my $cross_ref; - if ($Texi2HTML::Config::USE_UNICODE) - { - $cross_ref = unicode_to_protected(Unicode::Normalize::NFC(remove_texi($text))); - } - else - { - $cross_ref = remove_texi($text); - } - - $Texi2HTML::Config::normal_text = $normal_text_kept; - $simple_map_texi_ref = \%Texi2HTML::Config::simple_map_texi; - $style_map_texi_ref = \%Texi2HTML::Config::style_map_texi; - $texi_map_ref = \%Texi2HTML::Config::texi_map; -#print STDERR "cross_ref $cross_ref\n"; - return $cross_ref; -} - -# T2H_OPTIONS is a hash whose keys are the (long) names of valid -# command-line options and whose values are a hash with the following keys: -# type ==> one of !|=i|:i|=s|:s (see GetOpt::Long for more info) -# linkage ==> ref to scalar, array, or subroutine (see GetOpt::Long for more info) -# verbose ==> short description of option (displayed by -h) -# noHelp ==> if 1 -> for "not so important options": only print description on -h 1 -# 2 -> for obsolete options: only print description on -h 2 -my $T2H_OPTIONS; -$T2H_OPTIONS -> {'debug'} = -{ - type => '=i', - linkage => \$Texi2HTML::Config::DEBUG, - verbose => 'output HTML with debuging information', -}; - -$T2H_OPTIONS -> {'doctype'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::DOCTYPE, - verbose => 'document type which is output in header of HTML files', - noHelp => 1 -}; - -$T2H_OPTIONS -> {'frameset-doctype'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::FRAMESET_DOCTYPE, - verbose => 'document type for HTML frameset documents', - noHelp => 1 -}; - -$T2H_OPTIONS -> {'test'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::TEST, - verbose => 'use predefined information to avoid differences with reference files', - noHelp => 1 -}; - -$T2H_OPTIONS -> {'dump-texi'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::DUMP_TEXI, - verbose => 'dump the output of first pass into a file with extension passfirst and exit', - noHelp => 1 -}; - -$T2H_OPTIONS -> {'macro-expand'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::MACRO_EXPAND, - verbose => 'output macro expanded source in <file>', -}; - -$T2H_OPTIONS -> {'expand'} = -{ - type => '=s', - linkage => sub {set_expansion($_[1], 1);}, - verbose => 'Expand info|tex|none section of texinfo source', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'no-expand'} = -{ - type => '=s', - linkage => sub {set_expansion ($_[1], 0);}, - verbose => 'Don\'t expand the given section of texinfo source', -}; - -$T2H_OPTIONS -> {'noexpand'} = -{ - type => '=s', - linkage => $T2H_OPTIONS->{'no-expand'}->{'linkage'}, - verbose => $T2H_OPTIONS->{'no-expand'}->{'verbose'}, - noHelp => 1, -}; - -$T2H_OPTIONS -> {'ifhtml'} = -{ - type => '!', - linkage => sub { set_expansion('html', $_[1]); }, - verbose => "expand ifhtml and html sections", -}; - -$T2H_OPTIONS -> {'ifinfo'} = -{ - type => '!', - linkage => sub { set_expansion('info', $_[1]); }, - verbose => "expand ifinfo", -}; - -$T2H_OPTIONS -> {'ifxml'} = -{ - type => '!', - linkage => sub { set_expansion('xml', $_[1]); }, - verbose => "expand ifxml and xml sections", -}; - -$T2H_OPTIONS -> {'ifdocbook'} = -{ - type => '!', - linkage => sub { set_expansion('docbook', $_[1]); }, - verbose => "expand ifdocbook and docbook sections", -}; - -$T2H_OPTIONS -> {'iftex'} = -{ - type => '!', - linkage => sub { set_expansion('tex', $_[1]); }, - verbose => "expand iftex and tex sections", -}; - -$T2H_OPTIONS -> {'ifplaintext'} = -{ - type => '!', - linkage => sub { set_expansion('plaintext', $_[1]); }, - verbose => "expand ifplaintext sections", -}; - -#$T2H_OPTIONS -> {'no-ifhtml'} = -#{ -# type => '!', -# linkage => sub { set_expansion('html', (! $_[1])); }, -# verbose => "don't expand ifhtml and html sections", -# noHelp => 1, -#}; - -#$T2H_OPTIONS -> {'no-ifinfo'} = -#{ -# type => '!', -# linkage => sub { set_expansion('info', (! $_[1])); }, -# verbose => "don't expand ifinfo", -# noHelp => 1, -#}; - -#$T2H_OPTIONS -> {'no-ifxml'} = -#{ -# type => '!', -# linkage => sub { set_expansion('xml', (! $_[1])); }, -# verbose => "don't expand ifxml and xml sections", -# noHelp => 1, -#}; - -#$T2H_OPTIONS -> {'no-iftex'} = -#{ -# type => '!', -# linkage => sub { set_expansion('tex', (! $_[1])); }, -# verbose => "don't expand iftex and tex sections", -# noHelp => 1, -#}; - -#$T2H_OPTIONS -> {'no-ifplaintext'} = -#{ -# type => '!', -# linkage => sub { set_expansion('plaintext', (! $_[1])); }, -# verbose => "don't expand ifplaintext sections", -# noHelp => 1, -#}; - -$T2H_OPTIONS -> {'invisible'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::INVISIBLE_MARK, - verbose => 'use text in invisble anchor', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'iso'} = -{ - type => 'iso', - linkage => \$Texi2HTML::Config::USE_ISO, - verbose => 'if set, ISO8859 characters are used for special symbols (like copyright, etc)', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'I'} = -{ - type => '=s', - linkage => \@Texi2HTML::Config::INCLUDE_DIRS, - verbose => 'append $s to the @include search path', -}; - -$T2H_OPTIONS -> {'P'} = -{ - type => '=s', - linkage => sub {unshift (@Texi2HTML::Config::PREPEND_DIRS, $_[1]);}, - verbose => 'prepend $s to the @include search path', -}; - -$T2H_OPTIONS -> {'top-file'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::TOP_FILE, - verbose => 'use $s as top file, instead of <docname>.html', -}; - - -$T2H_OPTIONS -> {'toc-file'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::TOC_FILE, - verbose => 'use $s as ToC file, instead of <docname>_toc.html', -}; - -$T2H_OPTIONS -> {'frames'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::FRAMES, - verbose => 'output files which use HTML 4.0 frames (experimental)', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'menu'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SHOW_MENU, - verbose => 'output Texinfo menus', -}; - -#$T2H_OPTIONS -> {'no-menu'} = -#{ -# type => '!', -# linkage => sub { $Texi2HTML::Config::SHOW_MENU = (! $_[1]);}, -# verbose => "don't output Texinfo menus", -# noHelp => 1, -#}; - -$T2H_OPTIONS -> {'number'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::NUMBER_SECTIONS, - verbose => 'use numbered sections', -}; - -#$T2H_OPTIONS -> {'no-number'} = -#{ -# type => '!', -# linkage => sub { $Texi2HTML::Config::NUMBER_SECTIONS = (! $_[1]);}, -# verbose => 'sections not numbered', -# noHelp => 1, -#}; - -$T2H_OPTIONS -> {'use-nodes'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::USE_NODES, - verbose => 'use nodes for sectionning', -}; - -$T2H_OPTIONS -> {'node-files'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::NODE_FILES, - verbose => 'produce one file per node for cross references' -}; - -$T2H_OPTIONS -> {'separated-footnotes'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SEPARATED_FOOTNOTES, - verbose => 'footnotes on a separated page', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'toc-links'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::TOC_LINKS, - verbose => 'create links from headings to toc entries' -}; - -$T2H_OPTIONS -> {'split'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::SPLIT, - verbose => 'split document on section|chapter|node else no splitting', -}; - -$T2H_OPTIONS -> {'sec-nav'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SECTION_NAVIGATION, - verbose => 'output navigation panels for each section', -}; - -$T2H_OPTIONS -> {'subdir'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::SUBDIR, - verbose => 'put files in directory $s, not $cwd', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'short-ext'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SHORTEXTN, - verbose => 'use "htm" extension for output HTML files', -}; - -$T2H_OPTIONS -> {'prefix'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::PREFIX, - verbose => 'use as prefix for output files, instead of <docname>', -}; - -$T2H_OPTIONS -> {'output'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::OUT, - verbose => 'output goes to $s (directory if split)', -}; - -$T2H_OPTIONS -> {'no-validate'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::NOVALIDATE, - verbose => 'suppress node cross-reference validation', -}; - -$T2H_OPTIONS -> {'short-ref'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SHORT_REF, - verbose => 'if set, references are without section numbers', -}; - -$T2H_OPTIONS -> {'idx-sum'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::IDX_SUMMARY, - verbose => 'if set, also output index summary', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'def-table'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::DEF_TABLE, - verbose => 'if set, \@def.. are converted using tables.', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'Verbose'} = -{ - type => '!', - linkage=> \$Texi2HTML::Config::VERBOSE, - verbose => 'print progress info to stdout', -}; - -$T2H_OPTIONS -> {'lang'} = -{ - type => '=s', - linkage => sub {set_document_language($_[1], 1)}, - verbose => 'use $s as document language (ISO 639 encoding)', -}; - -$T2H_OPTIONS -> {'ignore-preamble-text'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::IGNORE_PREAMBLE_TEXT, - verbose => 'if set, ignore the text before @node and sectionning commands', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'html-xref-prefix'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::EXTERNAL_DIR, - verbose => '$s is the base dir for external manual references', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'l2h'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::L2H, - verbose => 'if set, uses latex2html for @math and @tex', -}; - -$T2H_OPTIONS -> {'l2h-l2h'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::L2H_L2H, - verbose => 'program to use for latex2html translation', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'l2h-skip'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::L2H_SKIP, - verbose => 'if set, tries to reuse previously latex2html output', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'l2h-tmp'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::L2H_TMP, - verbose => 'if set, uses $s as temporary latex2html directory', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'l2h-file'} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::L2H_FILE, - verbose => 'if set, uses $s as latex2html init file', - noHelp => 1, -}; - - -$T2H_OPTIONS -> {'l2h-clean'} = -{ - type => '!', - linkage => \$Texi2HTML::Config::L2H_CLEAN, - verbose => 'if set, do not keep intermediate latex2html files for later reuse', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'D'} = -{ - type => '=s', - linkage => sub {$value{$_[1]} = 1;}, - verbose => 'equivalent to Texinfo "@set $s 1"', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'U'} = -{ - type => '=s', - linkage => sub {delete $value{$_[1]};}, - verbose => 'equivalent to Texinfo "@clear $s"', - noHelp => 1, -}; - -$T2H_OPTIONS -> {'init-file'} = -{ - type => '=s', - linkage => \&load_init_file, - verbose => 'load init file $s' -}; - -$T2H_OPTIONS -> {'css-include'} = -{ - type => '=s', - linkage => \@Texi2HTML::Config::CSS_FILES, - verbose => 'use css file $s' -}; - -## -## obsolete cmd line options -## -my $T2H_OBSOLETE_OPTIONS; - -$T2H_OBSOLETE_OPTIONS -> {'out-file'} = -{ - type => '=s', - linkage => sub {$Texi2HTML::Config::OUT = $_[1]; $Texi2HTML::Config::SPLIT = '';}, - verbose => 'if set, all HTML output goes into file $s, obsoleted by "-output" with different semantics', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {init_file} = -{ - type => '=s', - linkage => \&load_init_file, - verbose => 'obsolete, use "-init-file" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {l2h_clean} = -{ - type => '!', - linkage => \$Texi2HTML::Config::L2H_CLEAN, - verbose => 'obsolete, use "-l2h-clean" instead', - noHelp => 2, -}; - -$T2H_OBSOLETE_OPTIONS -> {l2h_l2h} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::L2H_L2H, - verbose => 'obsolete, use "-l2h-l2h" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {l2h_skip} = -{ - type => '!', - linkage => \$Texi2HTML::Config::L2H_SKIP, - verbose => 'obsolete, use "-l2h-skip" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {l2h_tmp} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::L2H_TMP, - verbose => 'obsolete, use "-l2h-tmp" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {out_file} = -{ - type => '=s', - linkage => sub {$Texi2HTML::Config::OUT = $_[1]; $Texi2HTML::Config::SPLIT = '';}, - verbose => 'obsolete, use "-out-file" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {short_ref} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SHORT_REF, - verbose => 'obsolete, use "-short-ref" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {idx_sum} = -{ - type => '!', - linkage => \$Texi2HTML::Config::IDX_SUMMARY, - verbose => 'obsolete, use "-idx-sum" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {def_table} = -{ - type => '!', - linkage => \$Texi2HTML::Config::DEF_TABLE, - verbose => 'obsolete, use "-def-table" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {short_ext} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SHORTEXTN, - verbose => 'obsolete, use "-short-ext" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {sec_nav} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SECTION_NAVIGATION, - verbose => 'obsolete, use "-sec-nav" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {top_file} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::TOP_FILE, - verbose => 'obsolete, use "-top-file" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {toc_file} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::TOC_FILE, - verbose => 'obsolete, use "-toc-file" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {glossary} = -{ - type => '!', - linkage => \$Texi2HTML::Config::USE_GLOSSARY, -# verbose => "if set, uses section named `Footnotes' for glossary", - verbose => "this does nothing", - noHelp => 2, -}; - -$T2H_OBSOLETE_OPTIONS -> {dump_texi} = -{ - type => '!', - linkage => \$Texi2HTML::Config::DUMP_TEXI, - verbose => 'obsolete, use "-dump-texi" instead', - noHelp => 1 -}; - -$T2H_OBSOLETE_OPTIONS -> {frameset_doctype} = -{ - type => '=s', - linkage => \$Texi2HTML::Config::FRAMESET_DOCTYPE, - verbose => 'obsolete, use "-frameset-doctype" instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {'no-section_navigation'} = -{ - type => '!', - linkage => sub {$Texi2HTML::Config::SECTION_NAVIGATION = 0;}, - verbose => 'obsolete, use -nosec_nav', - noHelp => 2, -}; -my $use_acc; # not used -$T2H_OBSOLETE_OPTIONS -> {use_acc} = -{ - type => '!', - linkage => \$use_acc, - verbose => 'obsolete, set to true unconditionnaly', - noHelp => 2 -}; -$T2H_OBSOLETE_OPTIONS -> {expandinfo} = -{ - type => '!', - linkage => sub {push @Texi2HTML::Config::EXPAND, 'info';}, - verbose => 'obsolete, use "-expand info" instead', - noHelp => 2, -}; -$T2H_OBSOLETE_OPTIONS -> {expandtex} = -{ - type => '!', - linkage => sub {push @Texi2HTML::Config::EXPAND, 'tex';}, - verbose => 'obsolete, use "-expand tex" instead', - noHelp => 2, -}; -$T2H_OBSOLETE_OPTIONS -> {monolithic} = -{ - type => '!', - linkage => sub {$Texi2HTML::Config::SPLIT = '';}, - verbose => 'obsolete, use "-split no" instead', - noHelp => 2 -}; -$T2H_OBSOLETE_OPTIONS -> {split_node} = -{ - type => '!', - linkage => sub{$Texi2HTML::Config::SPLIT = 'section';}, - verbose => 'obsolete, use "-split section" instead', - noHelp => 2, -}; -$T2H_OBSOLETE_OPTIONS -> {split_chapter} = -{ - type => '!', - linkage => sub{$Texi2HTML::Config::SPLIT = 'chapter';}, - verbose => 'obsolete, use "-split chapter" instead', - noHelp => 2, -}; -$T2H_OBSOLETE_OPTIONS -> {no_verbose} = -{ - type => '!', - linkage => sub {$Texi2HTML::Config::VERBOSE = 0;}, - verbose => 'obsolete, use -noverbose instead', - noHelp => 2, -}; -$T2H_OBSOLETE_OPTIONS -> {output_file} = -{ - type => '=s', - linkage => sub {$Texi2HTML::Config::OUT = $_[1]; $Texi2HTML::Config::SPLIT = '';}, - verbose => 'obsolete, use -out_file instead', - noHelp => 2 -}; - -$T2H_OBSOLETE_OPTIONS -> {section_navigation} = -{ - type => '!', - linkage => \$Texi2HTML::Config::SECTION_NAVIGATION, - verbose => 'obsolete, use -sec_nav instead', - noHelp => 2, -}; - -$T2H_OBSOLETE_OPTIONS -> {verbose} = -{ - type => '!', - linkage=> \$Texi2HTML::Config::VERBOSE, - verbose => 'obsolete, use -Verbose instead', - noHelp => 2 -}; - -# read initialzation from $sysconfdir/texi2htmlrc or $HOME/.texi2htmlrc -# obsolete. -my @rc_files = (); -push @rc_files, "$sysconfdir/texi2htmlrc" if defined($sysconfdir); -push @rc_files, "$ENV{'HOME'}/.texi2htmlrc" if (defined($ENV{HOME})); -foreach my $i (@rc_files) -{ - if (-e $i and -r $i) - { - print STDERR "# reading initialization file from $i\n" - if ($T2H_VERBOSE); - print STDERR "Reading config from $i is obsolete, use texi2html/$conf_file_name instead\n"; - Texi2HTML::Config::load($i); - } -} - -# read initialization files -foreach my $file (locate_init_file($conf_file_name, 1)) -{ - print STDERR "# reading initialization file from $file\n" if ($T2H_VERBOSE); - Texi2HTML::Config::load($file); -} - -# -# %value hold texinfo variables, see also -D, -U, @set and @clear. -# we predefine html (the output format) and texi2html (the translator) -%value = - ( - 'html' => 1, - 'texi2html' => $THISVERSION, - ); - -#+++############################################################################ -# # -# parse command-line options -# # -#---############################################################################ - - -my $T2H_USAGE_TEXT = <<EOT; -Usage: texi2html [OPTIONS] TEXINFO-FILE -Translates Texinfo source documentation to HTML. -EOT -my $T2H_FAILURE_TEXT = <<EOT; -Try 'texi2html --help' for usage instructions. -EOT - -my $options = new Getopt::MySimple; - -$T2H_OPTIONS -> {'help'} = -{ - type => ':i', - default => '', - linkage => sub {$options->helpOptions($_[1]); - print "\nSend bugs and suggestions to <users\@texi2html.cvshome.org>\n"; - exit (0);}, - verbose => "print help and exit" -}; - -# some older version of GetOpt::Long don't have -# Getopt::Long::Configure("pass_through") -eval {Getopt::Long::Configure("pass_through");}; -my $Configure_failed = $@ && <<EOT; -**WARNING: Parsing of obsolete command-line options could have failed. - Consider to use only documented command-line options (run - 'texi2html --help 2' for a complete list) or upgrade to perl - version 5.005 or higher. -EOT -# FIXME getOptions is called 2 times, and thus adds 2 times the default -# help and version and after that warns. -if (! $options->getOptions($T2H_OPTIONS, $T2H_USAGE_TEXT, "$THISVERSION\n")) -{ - print STDERR "$Configure_failed" if $Configure_failed; - die $T2H_FAILURE_TEXT; -} -if (@ARGV > 1) -{ - eval {Getopt::Long::Configure("no_pass_through");}; - if (! $options->getOptions($T2H_OBSOLETE_OPTIONS, $T2H_USAGE_TEXT, "$THISVERSION\n")) - { - print STDERR "$Configure_failed" if $Configure_failed; - die $T2H_FAILURE_TEXT; - } -} -# $T2H_DEBUG and $T2H_VERBOSE are shorthands -my $T2H_DEBUG = $Texi2HTML::Config::DEBUG; -$T2H_VERBOSE = $Texi2HTML::Config::VERBOSE; - -#+++############################################################################ -# # -# evaluation of cmd line options -# # -#---############################################################################ - -# retro compatibility for $Texi2HTML::Config::EXPAND -push (@Texi2HTML::Config::EXPAND, $Texi2HTML::Config::EXPAND) if ($Texi2HTML::Config::EXPAND); - -# correct %text_macros and @special_regions based on command line and init -# variables -$text_macros{'menu'} = 1 if ($Texi2HTML::Config::SHOW_MENU); - -push @special_regions, 'tex' if ($Texi2HTML::Config::L2H); - -foreach my $expanded (@Texi2HTML::Config::EXPAND) -{ - $text_macros{"if$expanded"} = 1 if (exists($text_macros{"if$expanded"})); - next unless (exists($text_macros{$expanded})); - if (grep {$_ eq $expanded} @special_regions) - { - $text_macros{$expanded} = 'special'; - } - elsif (grep {$_ eq $expanded} @raw_regions) - { - $text_macros{$expanded} = 'raw'; - } - else - { - $text_macros{$expanded} = 1; - } -} - -# handle ifnot regions -foreach my $region (keys (%text_macros)) -{ - next if ($region =~ /^ifnot/); - if ($text_macros{$region} and $region =~ /^if(\w+)$/) - { - $text_macros{"ifnot$1"} = 0; - } -} - -if ($T2H_VERBOSE) -{ - print STDERR "# Expanded: "; - foreach my $text_macro (keys(%text_macros)) - { - print STDERR "$text_macro " if ($text_macros{$text_macro}); - } - print STDERR "\n"; -} - -# This is kept in that file although it is html formatting as it seems to -# be rather obsolete -$Texi2HTML::Config::INVISIBLE_MARK = '<img src="invisible.xbm" alt="">' if $Texi2HTML::Config::INVISIBLE_MARK eq 'xbm'; - -$T2H_DEBUG |= $DEBUG_TEXI if ($Texi2HTML::Config::DUMP_TEXI); - -# Construct hashes used for cross references generation -# Do it now as the user may have changed $USE_UNICODE - -foreach my $key (keys(%Texi2HTML::Config::unicode_map)) -{ - if ($Texi2HTML::Config::unicode_map{$key} ne '') - { - if ($Texi2HTML::Config::USE_UNICODE) - { - $cross_ref_texi_map{$key} = chr(hex($Texi2HTML::Config::unicode_map{$key})); - } - else - { - $cross_ref_texi_map{$key} = '_' . lc($Texi2HTML::Config::unicode_map{$key}); - } - } -} - -foreach my $key (keys(%cross_ref_style_map_texi)) -{ - if ($style_type{$key} eq 'accent' - and (ref($cross_ref_style_map_texi{$key}) eq 'HASH')) - { - if ($Texi2HTML::Config::USE_UNICODE) - { - $cross_ref_style_map_texi{$key}->{'function'} = \&Texi2HTML::Config::t2h_utf8_accent; - } - else - { - $cross_ref_style_map_texi{$key}->{'function'} = \&Texi2HTML::Config::t2h_nounicode_cross_manual_accent; - } - } -} - -# -# file name buisness -# - -# this is directly pasted over from latex2html -sub getcwd -{ - local($_) = `pwd`; - - die "'pwd' failed (out of memory?)\n" - unless length; - chop; - $_; -} - - -my $docu_dir; # directory of the document -my $docu_name; # basename of the document -my $docu_rdir; # directory for the output -#my $docu_ext = "html"; # extension -my $docu_ext = $Texi2HTML::Config::EXTENSION; # extension -my $docu_toc; # document's table of contents -my $docu_stoc; # document's short toc -my $docu_foot; # document's footnotes -my $docu_about; # about this document -my $docu_top; # document top -my $docu_doc; # document (or document top of split) - -die "Need exactly one file to translate\n$T2H_FAILURE_TEXT" unless @ARGV == 1; -my $docu = shift(@ARGV); -if ($docu =~ /(.*\/)/) -{ - chop($docu_dir = $1); - $docu_name = $docu; - $docu_name =~ s/.*\///; -} -else -{ - $docu_dir = '.'; - $docu_name = $docu; -} -unshift(@Texi2HTML::Config::INCLUDE_DIRS, $docu_dir); -unshift(@Texi2HTML::Config::INCLUDE_DIRS, @Texi2HTML::Config::PREPEND_DIRS); -$docu_name =~ s/\.te?x(i|info)?$//; -$docu_name = $Texi2HTML::Config::PREFIX if ($Texi2HTML::Config::PREFIX); - -# resulting files splitting -if ($Texi2HTML::Config::SPLIT =~ /section/i) -{ - $Texi2HTML::Config::SPLIT = 'section'; -} -elsif ($Texi2HTML::Config::SPLIT =~ /node/i) -{ - $Texi2HTML::Config::SPLIT = 'node'; -} -elsif ($Texi2HTML::Config::SPLIT =~ /chapter/i) -{ - $Texi2HTML::Config::SPLIT = 'chapter'; -} -else -{ - $Texi2HTML::Config::SPLIT = ''; -} - -# Something like backward compatibility -if ($Texi2HTML::Config::SPLIT and $Texi2HTML::Config::SUBDIR) -{ - $Texi2HTML::Config::OUT = $Texi2HTML::Config::SUBDIR; -} - -# subdir - -die "output to STDOUT and split or frames incompatible\n" - if (($Texi2HTML::Config::SPLIT or $Texi2HTML::Config::FRAMES) and ($Texi2HTML::Config::OUT eq '-')); - -if ($Texi2HTML::Config::SPLIT and ($Texi2HTML::Config::OUT eq '')) -{ - $Texi2HTML::Config::OUT = $docu_name; -} - -if ($Texi2HTML::Config::SPLIT and ($Texi2HTML::Config::OUT eq '.')) -{# This is to avoid trouble with latex2html - $Texi2HTML::Config::OUT = ''; -} - -$docu_rdir = ''; - -if ($Texi2HTML::Config::SPLIT and ($Texi2HTML::Config::OUT ne '')) -{ - $Texi2HTML::Config::OUT =~ s|/*$||; - $docu_rdir = "$Texi2HTML::Config::OUT/"; - unless (-d $Texi2HTML::Config::OUT) - { - if ( mkdir($Texi2HTML::Config::OUT, oct(755))) - { - print STDERR "# created directory $Texi2HTML::Config::OUT\n" if ($T2H_VERBOSE); - } - else - { - die "$ERROR can't create directory $Texi2HTML::Config::OUT\n"; - } - } - print STDERR "# putting result files into directory $docu_rdir\n" if ($T2H_VERBOSE); -} -elsif (! $Texi2HTML::Config::SPLIT and ($Texi2HTML::Config::OUT ne '')) -{ - if ($Texi2HTML::Config::OUT =~ m|(.*)/|) - {# there is a leading directories - $docu_rdir = "$1/"; - unless (-d $docu_rdir) - { - if ( mkdir($docu_rdir, oct(755))) - { - print STDERR "# created directory $docu_rdir\n" if ($T2H_VERBOSE); - } - else - { - die "$ERROR can't create directory $docu_rdir\n"; - } - } - print STDERR "# putting result files into directory $docu_rdir\n" if ($T2H_VERBOSE); - } - else - { - print STDERR "# putting result files into current directory \n" if ($T2H_VERBOSE); - $docu_rdir = ''; - } -} - -# We don't use "./" as $docu_rdir when $docu_rdir is the current directory -# because it is problematic for latex2html. To test writability with -w, -# however we need a real directory. -my $result_rdir = $docu_rdir; -$result_rdir = "." if ($docu_rdir eq ''); -unless (-w $result_rdir) -{ - $docu_rdir = 'current directory' if ($docu_rdir eq ''); - die "$ERROR $docu_rdir not writable\n"; -} - -# relative path leading to the working directory from the document directory -my $path_to_working_dir = $docu_rdir; -if ($docu_rdir ne '') -{ - my $cwd = getcwd; - my $docu_path = $docu_rdir; - $docu_path = $cwd . '/' . $docu_path unless ($docu_path =~ /^\//); - my @result = (); - foreach my $element (split /\//, File::Spec->canonpath($docu_path)) - { - if ($element eq '') - { - push @result, ''; - } - elsif ($element eq '..') - { - if (@result and ($result[-1] eq '')) - { - print STDERR "Too much .. in absolute file name\n"; - } - elsif (@result and ($result[-1] ne '..')) - { - pop @result; - } - else - { - push @result, $element; - } - } - else - { - push @result, $element; - } - } - $path_to_working_dir = File::Spec->abs2rel($cwd, join ('/', @result)); - $path_to_working_dir =~ s|.*/||; - $path_to_working_dir .= '/' unless($path_to_working_dir eq ''); -} - -# extension -if ($Texi2HTML::Config::SHORTEXTN) -{ - $docu_ext = "htm"; -} -if ($Texi2HTML::Config::TOP_FILE =~ s/\..*$//) -{ - $Texi2HTML::Config::TOP_FILE .= ".$docu_ext"; -} - -$docu_doc = "$docu_name.$docu_ext"; # document's contents -if ($Texi2HTML::Config::SPLIT) -{ - # if Texi2HTML::Config::NODE_FILES is true and a node is called ${docu_name}_toc - # ${docu_name}_ovr... there may be trouble with the old naming scheme in - # very rare circumstances. This won't be fixed, the new scheme will be used - # soon. - $docu_toc = $Texi2HTML::Config::TOC_FILE || "${docu_name}_toc.$docu_ext"; - $docu_stoc = "${docu_name}_ovr.$docu_ext"; - $docu_foot = "${docu_name}_fot.$docu_ext"; - $docu_about = "${docu_name}_abt.$docu_ext"; - $docu_top = $Texi2HTML::Config::TOP_FILE || $docu_doc; -} -else -{ - if ($Texi2HTML::Config::OUT) - { - $docu_doc = $Texi2HTML::Config::OUT; - $docu_doc =~ s|.*/||; - } - $docu_toc = $docu_foot = $docu_stoc = $docu_about = $docu_top = $docu_doc; -} - -# For use in init files -$Texi2HTML::Config::TOP_FILE = $docu_top; -$Texi2HTML::Config::TOC_FILE = $docu_toc; - -my $docu_doc_file = "$docu_rdir$docu_doc"; -my $docu_toc_file = "$docu_rdir$docu_toc"; -my $docu_stoc_file = "$docu_rdir$docu_stoc"; -my $docu_foot_file = "$docu_rdir$docu_foot"; -my $docu_about_file = "$docu_rdir$docu_about"; -my $docu_top_file = "$docu_rdir$docu_top"; - -my $docu_frame_file = "$docu_rdir${docu_name}_frame.$docu_ext"; -my $docu_toc_frame_file = "$docu_rdir${docu_name}_toc_frame.$docu_ext"; - -# -# _foo: internal variables to track @foo -# -foreach my $key ('_author', '_title', '_subtitle', '_shorttitlepage', - '_settitle', '_setfilename', '_shorttitle', '_titlefont') -{ - $value{$key} = ''; # prevent -w warnings -} -my $index; # ref on a hash for the index entries -my %indices = (); # hash of indices names containing - #[ $Pages, $Entries ] (page indices and - # raw index entries) -my @index_labels = (); # array corresponding with @?index commands - # constructed during pass_texi, used to - # put labels in pass_text -# -# initial counters -# -my $foot_num = 0; -my $relative_foot_num = 0; -my $idx_num = 0; -my $sec_num = 0; -my $anchor_num = 0; - -# -# can I use ISO8859 characters? (HTML+) -# -if ($Texi2HTML::Config::USE_ISO) -{ - foreach my $thing (keys(%Texi2HTML::Config::iso_symbols)) - { - $things_map_ref->{$thing} = $Texi2HTML::Config::iso_symbols{$thing}; - $pre_map_ref->{$thing} = $Texi2HTML::Config::iso_symbols{$thing}; - } -} - -# process a css file -sub process_css_file ($$) -{ - my $fh =shift; - my $file = shift; - my $in_rules = 0; - my $in_comment = 0; - my $in_import = 0; - my $in_string = 0; - my $rules = []; - my $imports = []; - while (<$fh>) - { - #print STDERR "Line: $_"; - if ($in_rules) - { - push @$rules, $_; - next; - } - my $text = ''; - while (1) - { - #sleep 1; - #print STDERR "${text}!in_comment $in_comment in_rules $in_rules in_import $in_import in_string $in_string: $_"; - if ($in_comment) - { - if (s/^(.*?\*\/)//) - { - $text .= $1; - $in_comment = 0; - } - else - { - push @$imports, $text . $_; - last; - } - } - elsif (!$in_string and s/^\///) - { # what do '\' do here ? - if (s/^\*//) - { - $text .= '/*'; - $in_comment = 1; - } - else - { - push (@$imports, $text. "\n") if ($text ne ''); - push (@$rules, '/' . $_); - $in_rules = 1; - last; - } - } - elsif (!$in_string and $in_import and s/^([\"\'])//) - { # strings outside of import start rules - $text .= "$1"; - $in_string = quotemeta("$1"); - } - elsif ($in_string and s/^(\\$in_string)//) - { - $text .= $1; - } - elsif ($in_string and s/^($in_string)//) - { - $text .= $1; - $in_string = 0; - } - elsif ((! $in_string and !$in_import) and (s/^([\\]?\@import)$// or s/^([\\]?\@import\s+)//)) - { - $text .= $1; - $in_import = 1; - } - elsif (!$in_string and $in_import and s/^\;//) - { - $text .= ';'; - $in_import = 0; - } - elsif (($in_import or $in_string) and s/^(.)//) - { - $text .= $1; - } - elsif (!$in_import and s/^([^\s])//) - { - push (@$imports, $text. "\n") if ($text ne ''); - push (@$rules, $1 . $_); - $in_rules = 1; - last; - } - elsif (s/^(\s)//) - { - $text .= $1; - } - elsif ($_ eq '') - { - push (@$imports, $text); - last; - } - } - } - warn "$WARN string not closed in css file $file\n" if ($in_string); - warn "$WARN comment not closed in css file $file\n" if ($in_comment); - warn "$WARN \@import not finished in css file $file\n" if ($in_import and !$in_comment and !$in_string); - return ($imports, $rules); -} - -my @css_import_lines; -my @css_rule_lines; - -# process css files -foreach my $file (@Texi2HTML::Config::CSS_FILES) -{ - my $css_file_fh; - my $css_file; - if ($file eq '-') - { - $css_file_fh = \*STDIN; - $css_file = '-'; - } - else - { - $css_file = locate_init_file ($file); - unless (defined($css_file)) - { - warn "css file $file not found\n"; - next; - } - unless (open (CSSFILE, "$css_file")) - { - warn "Cannot open ${css_file}: $!"; - next; - } - $css_file_fh = \*CSSFILE; - } - my ($import_lines, $rules_lines); - ($import_lines, $rules_lines) = process_css_file ($css_file_fh, $css_file); - push @css_import_lines, @$import_lines; - push @css_rule_lines, @$rules_lines; -} - -if ($T2H_DEBUG & $DEBUG_USER) -{ - if (@css_import_lines) - { - print STDERR "# css import lines\n"; - foreach my $line (@css_import_lines) - { - print STDERR "$line"; - } - } - if (@css_rule_lines) - { - print STDERR "# css rule lines\n"; - foreach my $line (@css_rule_lines) - { - print STDERR "$line"; - } - } -} - -# -# read texi2html extensions (if any) -# FIXME isn't that obsolete ? (obsoleted by -init-file) -my $extensions = 'texi2html.ext'; # extensions in working directory -if (-f $extensions) -{ - print STDERR "# reading extensions from $extensions\n" if $T2H_VERBOSE; - require($extensions); -} -my $progdir; -($progdir = $0) =~ s/[^\/]+$//; -if ($progdir && ($progdir ne './')) -{ - $extensions = "${progdir}texi2html.ext"; # extensions in texi2html directory - if (-f $extensions) - { - print STDERR "# reading extensions from $extensions\n" if $T2H_VERBOSE; - require($extensions); - } -} - -# parse texinfo cnf file for external manual specifications. -my @texinfo_htmlxref_files = locate_init_file ($texinfo_htmlxref, 1, \@texinfo_config_dirs); -foreach my $file (@texinfo_htmlxref_files) -{ - open (HTMLXREF, $file); - while (<HTMLXREF>) - { - my $line = $_; - s/[#]\s.*//; - s/^\s*//; - next if /^\s*$/; - my @htmlxref = split /\s+/; - my $manual = shift @htmlxref; - next if (exists($Texi2HTML::THISDOC{'htmlxref'}->{$manual})); - my $split_or_mono = shift @htmlxref; - if (!defined($split_or_mono) or ($split_or_mono ne 'split' and $split_or_mono ne 'mono')) - { - echo_warn("Bad line in $file: $line"); - next; - } - my $href = shift @htmlxref; - if ($split_or_mono eq 'split') - { - $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'split'} = 1; - $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'mono'} = 0; - } - else - { - $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'split'} = 0; - $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'mono'} = 1; - } - if (defined($href)) - { - if ($Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'split'}) - { - $href =~ s/\/*$//; - } - $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'href'} = $href; - } - } - close (HTMLXREF); -} - -if ($T2H_DEBUG) -{ - foreach my $manual (keys(%{$Texi2HTML::THISDOC{'htmlxref'}})) - { - my $href = 'NO'; - $href = $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'href'} if - defined($Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'href'}); - print STDERR "$manual: split $Texi2HTML::THISDOC{'htmlxref'}->{$manual}->{'split'}, href: $href\n"; - } -} - -print STDERR "# reading from $docu\n" if $T2H_VERBOSE; - -{ - -package Texi2HTML::LaTeX2HTML; - -######################################################################### -# -# latex2html stuff -# -# latex2html conversions consist of three stages: -# 1) ToLatex: Put "latex" code into a latex file -# 2) ToHtml: Use latex2html to generate corresponding html code and images -# 3) FromHtml: Extract generated code and images from latex2html run -# - -# init l2h defaults for files and names - -# variable which shouldn't be global FIXME -use vars qw( - %l2h_img - ); -my ($l2h_name, $l2h_latex_file, $l2h_cache_file, $l2h_html_file, $l2h_prefix); - -# holds the status of latex2html operations. If 0 it means that there was -# an error -my $status = 0; -my $debug; -my $docu_rdir; - -#if ($Texi2HTML::Config::L2H) -sub init($$$) -{ - my $docu_name = shift; - $docu_rdir = shift; - $debug = shift; - $l2h_name = "${docu_name}_l2h"; - $l2h_latex_file = "$docu_rdir${l2h_name}.tex"; - $l2h_cache_file = "${docu_rdir}l2h_cache.pm"; - # destination dir -- generated images are put there, should be the same - # as dir of enclosing html document -- - $l2h_html_file = "$docu_rdir${l2h_name}.html"; - $l2h_prefix = "${l2h_name}_"; - $status = init_to_latex(); -} - -########################## -# -# First stage: Generation of Latex file -# Initialize with: l2h_InitToLatex -# Add content with: l2h_ToLatex($text) --> HTML placeholder comment -# Finish with: l2h_FinishToLatex -# - -my $l2h_latex_preamble = <<EOT; -% This document was automatically generated by the l2h extenstion of texi2html -% DO NOT EDIT !!! -\\documentclass{article} -\\usepackage{html} -\\begin{document} -EOT - -my $l2h_latex_closing = <<EOT; -\\end{document} -EOT - -my %l2h_to_latex = (); -my @l2h_to_latex = (); -my $l2h_latex_count = 0; # number of latex texts really stored -my $l2h_to_latex_count = 0; # total number of latex texts processed -my $l2h_cached_count = 0; # number of cached latex text -my %l2h_cache = (); -#$Texi2HTML::Config::L2H = l2h_InitToLatex() if ($Texi2HTML::Config::L2H); - -# return used latex 1, if l2h could be initalized properly, 0 otherwise -#sub l2h_InitToLatex -sub init_to_latex() -{ - unless ($Texi2HTML::Config::L2H_SKIP) - { - unless (open(L2H_LATEX, ">$l2h_latex_file")) - { - warn "$ERROR Error l2h: Can't open latex file '$l2h_latex_file' for writing\n"; - return 0; - } - print STDERR "# l2h: use ${l2h_latex_file} as latex file\n" if ($T2H_VERBOSE); - print L2H_LATEX $l2h_latex_preamble; - } - # open database for caching - #l2h_InitCache(); - init_cache(); - return 1; -} - - -# print text (1st arg) into latex file (if not already there), return -# @tex_$number which can be later on replaced by the latex2html -# generated text -#sub l2h_ToLatex -sub to_latex -{ - my($text) = @_; - my($count); - $l2h_to_latex_count++; - $text =~ s/(\s*)$//; - # try whether we can cache it - #my $cached_text = l2h_FromCache($text); - my $cached_text = from_cache($text); - if ($cached_text) - { - $l2h_cached_count++; - return $cached_text; - } - # try whether we have text already on things to do - unless ($count = $l2h_to_latex{$text}) - { - $count = $l2h_latex_count; - $l2h_latex_count++; - $l2h_to_latex{$text} = $count; - $l2h_to_latex[$count] = $text; - unless ($Texi2HTML::Config::L2H_SKIP) - { - print L2H_LATEX "\\begin{rawhtml}\n"; - print L2H_LATEX "<!-- l2h_begin ${l2h_name} ${count} -->\n"; - print L2H_LATEX "\\end{rawhtml}\n"; - - print L2H_LATEX "$text\n"; - - print L2H_LATEX "\\begin{rawhtml}\n"; - print L2H_LATEX "<!-- l2h_end ${l2h_name} ${count} -->\n"; - print L2H_LATEX "\\end{rawhtml}\n"; - } - } - return "\@tex_${count} "; -} - -# print closing into latex file and close it -#sub l2h_FinishToLatex -sub finish_to_latex() -{ - my ($reused); - $reused = $l2h_to_latex_count - $l2h_latex_count - $l2h_cached_count; - unless ($Texi2HTML::Config::L2H_SKIP) - { - print L2H_LATEX $l2h_latex_closing; - close(L2H_LATEX); - } - print STDERR "# l2h: finished to latex ($l2h_cached_count cached, $reused reused, $l2h_latex_count contents)\n" if ($T2H_VERBOSE); - unless ($l2h_latex_count) - { - #l2h_Finish(); - finish(); - return 0; - } - return 1; -} - -################################### -# Second stage: Use latex2html to generate corresponding html code and images -# -# l2h_ToHtml([$l2h_latex_file, [$l2h_html_dir]]): -# Call latex2html on $l2h_latex_file -# Put images (prefixed with $l2h_name."_") and html file(s) in $l2h_html_dir -# Return 1, on success -# 0, otherwise -# -#sub l2h_ToHtml -sub to_html() -{ - my ($call, $dotbug); - if ($Texi2HTML::Config::L2H_SKIP) - { - print STDERR "# l2h: skipping latex2html run\n" if ($T2H_VERBOSE); - return 1; - } - # Check for dot in directory where dvips will work - if ($Texi2HTML::Config::L2H_TMP) - { - if ($Texi2HTML::Config::L2H_TMP =~ /\./) - { - warn "$ERROR Warning l2h: l2h_tmp dir contains a dot. Use /tmp, instead\n"; - $dotbug = 1; - } - } - else - { - if (main::getcwd() =~ /\./) - { - warn "$ERROR Warning l2h: current dir contains a dot. Use /tmp as l2h_tmp dir \n"; - $dotbug = 1; - } - } - # fix it, if necessary and hope that it works - $Texi2HTML::Config::L2H_TMP = "/tmp" if ($dotbug); - - $call = $Texi2HTML::Config::L2H_L2H; - # use init file, if specified - my $init_file = main::locate_init_file($Texi2HTML::Config::L2H_FILE); - $call = $call . " -init_file " . $init_file if ($init_file); - # set output dir - $call .= ($docu_rdir ? " -dir $docu_rdir" : " -no_subdir"); - # use l2h_tmp, if specified - $call = $call . " -tmp $Texi2HTML::Config::L2H_TMP" if ($Texi2HTML::Config::L2H_TMP); - # use a given html version if specified - $call = $call . " -html_version $Texi2HTML::Config::L2H_HTML_VERSION" if ($Texi2HTML::Config::L2H_HTML_VERSION); - # options we want to be sure of - $call = $call ." -address 0 -info 0 -split 0 -no_navigation -no_auto_link"; - $call = $call ." -prefix ${l2h_prefix} $l2h_latex_file"; - - print STDERR "# l2h: executing '$call'\n" if ($Texi2HTML::Config::VERBOSE); - if (system($call)) - { - warn "l2h ***Error: '${call}' did not succeed\n"; - return 0; - } - else - { - print STDERR "# l2h: latex2html finished successfully\n" if ($Texi2HTML::Config::VERBOSE); - return 1; - } -} - -########################## -# Third stage: Extract generated contents from latex2html run -# Initialize with: l2h_InitFromHtml -# open $l2h_html_file for reading -# reads in contents into array indexed by numbers -# return 1, on success -- 0, otherwise -# Extract Html code with: l2h_FromHtml($text) -# replaces in $text all previosuly inserted comments by generated html code -# returns (possibly changed) $text -# Finish with: l2h_FinishFromHtml -# closes $l2h_html_dir/$l2h_name.".$docu_ext" - -my $l2h_extract_error = 0; -my $l2h_range_error = 0; -my @l2h_from_html; - -#sub l2h_InitFromHtml() -sub init_from_html() -{ - local(%l2h_img); - my ($count, $h_line); - - if (! open(L2H_HTML, "<${l2h_html_file}")) - { - print STDERR "$ERROR Error l2h: Can't open ${l2h_html_file} for reading\n"; - return 0; - } - print STDERR "# l2h: use ${l2h_html_file} as html file\n" if ($T2H_VERBOSE); - - my $l2h_html_count = 0; - while ($h_line = <L2H_HTML>) - { - if ($h_line =~ /^<!-- l2h_begin $l2h_name ([0-9]+) -->/) - { - $count = $1; - my $h_content = ""; - while ($h_line = <L2H_HTML>) - { - if ($h_line =~ /^<!-- l2h_end $l2h_name $count -->/) - { - chomp $h_content; - chomp $h_content; - $l2h_html_count++; - #$h_content = l2h_ToCache($count, $h_content); - $h_content = to_cache($count, $h_content); - $l2h_from_html[$count] = $h_content; - $h_content = ''; - last; - } - $h_content = $h_content.$h_line; - } - if ($h_content) - { - print STDERR "$ERROR Warning l2h: l2h_end $l2h_name $count not found\n" - if ($Texi2HTML::Config::VERBOSE); - close(L2H_HTML); - return 0; - } - } - } - print STDERR "# l2h: Got $l2h_html_count of $l2h_latex_count html contents\n" - if ($Texi2HTML::Config::VERBOSE); - - close(L2H_HTML); - return 1; -} - -sub latex2html() -{ - return unless($status); - return unless ($status = finish_to_latex()); - return unless ($status = to_html()); - return unless ($status = init_from_html()); -} - -# FIXME used ?? -#sub l2h_FromHtml($) -sub from_html($) -{ - my($text) = @_; - my($done, $to_do, $count); - $to_do = $text; - $done = ''; - while ($to_do =~ /([^\000]*)<!-- l2h_replace $l2h_name ([0-9]+) -->([^\000]*)/) - { - $to_do = $1; - $count = $2; - $done = $3.$done; - $done = "<!-- l2h_end $l2h_name $count -->".$done - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - - #$done = l2h_ExtractFromHtml($count) . $done; - $done = extract_from_html($count) . $done; - - $done = "<!-- l2h_begin $l2h_name $count -->".$done - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - } - return $to_do.$done; -} - -sub do_tex($) -{ - my $count = shift; - my $result = ''; - $result = "<!-- l2h_begin $l2h_name $count -->" - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - $result .= extract_from_html($count); - $result .= "<!-- l2h_end $l2h_name $count -->" - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - return $result; -} - -#sub l2h_ExtractFromHtml($) -sub extract_from_html($) -{ - my $count = shift; - return $l2h_from_html[$count] if ($l2h_from_html[$count]); - if ($count >= 0 && $count < $l2h_latex_count) - { - # now we are in trouble - my $line; - $l2h_extract_error++; - print STDERR "$ERROR l2h: can't extract content $count from html\n" - if ($T2H_VERBOSE); - # try simple (ordinary) substition (without l2h) - #my $l_l2h = $Texi2HTML::Config::L2H; - $Texi2HTML::Config::L2H = 0; - my $l_l2h = $status; - $status = 0; - $line = $l2h_to_latex{$count}; - $line = main::substitute_text({}, $line); - $line = "<!-- l2h: ". __LINE__ . " use texi2html -->" . $line - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - #$Texi2HTML::Config::L2H = $l_l2h; - $status = $l_l2h; - return $line; - } - else - { - # now we have been incorrectly called - $l2h_range_error++; - print STDERR "$ERROR l2h: Request of $count content which is out of valide range [0,$l2h_latex_count)\n"; - return "<!-- l2h: ". __LINE__ . " out of range count $count -->" - #if ($T2H_DEBUG & $DEBUG_L2H); - if ($debug); - return "<!-- l2h: out of range count $count -->"; - } -} - -#sub l2h_FinishFromHtml() -sub finish_from_html() -{ - if ($Texi2HTML::Config::VERBOSE) - { - if ($l2h_extract_error + $l2h_range_error) - { - print STDERR "# l2h: finished from html ($l2h_extract_error extract and $l2h_range_error errors)\n"; - } - else - { - print STDERR "# l2h: finished from html (no errors)\n"; - } - } -} - -#sub l2h_Finish() -sub finish() -{ - return unless($status); - finish_from_html(); - #l2h_StoreCache(); - store_cache(); - if ($Texi2HTML::Config::L2H_CLEAN) - { - local ($_); - print STDERR "# l2h: removing temporary files generated by l2h extension\n" - if $Texi2HTML::Config::VERBOSE; - while (<"$docu_rdir$l2h_name"*>) - { - unlink $_; - } - } - print STDERR "# l2h: Finished\n" if $Texi2HTML::Config::VERBOSE; - return 1; -} - -############################## -# stuff for l2h caching -# - -# I tried doing this with a dbm data base, but it did not store all -# keys/values. Hence, I did as latex2html does it -#sub l2h_InitCache -sub init_cache -{ - if (-r "$l2h_cache_file") - { - my $rdo = do "$l2h_cache_file"; - warn("$ERROR l2h Error: could not load $docu_rdir$l2h_cache_file: $@\n") - unless ($rdo); - } -} - -#sub l2h_StoreCache -sub store_cache -{ - return unless $l2h_latex_count; - my ($key, $value); - open(FH, ">$l2h_cache_file") || return warn"$ERROR l2h Error: could not open $docu_rdir$l2h_cache_file for writing: $!\n"; - while (($key, $value) = each %l2h_cache) - { - # escape stuff - $key =~ s|/|\\/|g; - $key =~ s|\\\\/|\\/|g; - # weird, a \ at the end of the key results in an error - # maybe this also broke the dbm database stuff - $key =~ s|\\$|\\\\|; - $value =~ s/\|/\\\|/go; - $value =~ s/\\\\\|/\\\|/go; - $value =~ s|\\\\|\\\\\\\\|g; - print FH "\n\$l2h_cache_key = q/$key/;\n"; - print FH "\$l2h_cache{\$l2h_cache_key} = q|$value|;\n"; - } - print FH "1;"; - close(FH); -} - -# return cached html, if it exists for text, and if all pictures -# are there, as well -#sub l2h_FromCache -sub from_cache -{ - my $text = shift; - my $cached = $l2h_cache{$text}; - if ($cached) - { - while ($cached =~ m/SRC="(.*?)"/g) - { - unless (-e "$docu_rdir$1") - { - return undef; - } - } - return $cached; - } - return undef; -} - -# insert generated html into cache, move away images, -# return transformed html -my $maximage = 1; -#sub l2h_ToCache($$) -sub to_cache($$) -{ - my $count = shift; - my $content = shift; - my @images = ($content =~ /SRC="(.*?)"/g); - my ($src, $dest); - - for $src (@images) - { - $dest = $l2h_img{$src}; - unless ($dest) - { - my $ext; - if ($src =~ /.*\.(.*)$/ && $1 ne $docu_ext) - { - $ext = $1; - } - else - { - warn "$ERROR: L2h image $src has invalid extension\n"; - next; - } - while (-e "$docu_rdir${docu_name}_$maximage.$ext") - { - $maximage++; - } - $dest = "${docu_name}_$maximage.$ext"; - system("cp -f $docu_rdir$src $docu_rdir$dest"); - $l2h_img{$src} = $dest; - #unlink "$docu_rdir$src" unless ($T2H_DEBUG & $DEBUG_L2H); - unlink "$docu_rdir$src" unless ($debug); - } - $content =~ s/$src/$dest/g; - } - $l2h_cache{$l2h_to_latex[$count]} = $content; - return $content; -} - -} - -#+++########################################################################### -# # -# Pass texi: read source, handle variable, ignored text, # -# # -#---########################################################################### - -my @fhs = (); # hold the file handles to read -my $input_spool; # spooled lines to read -my @lines = (); # whole document -my @lines_numbers = (); # line number, originating file associated with - # whole document -my $macros; # macros. reference on a hash -my %info_enclose; # macros defined with definfoenclose -my $texi_line_number = { 'file_name' => '', 'line_nr' => 0, 'macro' => '' }; -my @floats = (); # floats list -my %floats = (); # floats by style - -sub initialise_state_texi($) -{ - my $state = shift; - $state->{'texi'} = 1; # for substitute_text and close_stack: - # 1 if pass_texi/scan_texi is to be used -} - -my @first_lines = (); - -sub pass_texi() -{ - my $first_lines = 1; # is it the first lines - my $state = {}; - # holds the informations about the context - # to pass it down to the functions - initialise_state_texi($state); - my @stack; - my $text; - INPUT_LINE: while (defined($_ = next_line($texi_line_number))) - { - # - # remove the lines preceding \input or an @-command - # - if ($first_lines) - { - if (/^\\input/) - { - push @first_lines, $_; - $first_lines = 0; - next; - } - if (/^\s*\@/) - { - $first_lines = 0; - } - else - { - push @first_lines, $_; - next; - } - } - #print STDERR "line_nr $texi_line_number->{'line_nr'} :$_"; - my $chomped_line = $_; - if (scan_texi ($_, \$text, \@stack, $state, $texi_line_number) and chomp($chomped_line)) - { - #print STDERR "scan_texi line_nr $texi_line_number->{'line_nr'}\n"; - push (@lines_numbers, { 'file_name' => $texi_line_number->{'file_name'}, - 'line_nr' => $texi_line_number->{'line_nr'}, - 'macro' => $texi_line_number->{'macro'} }); - } - - #dump_stack (\$text, \@stack, $state); - if ($state->{'bye'}) - { - #dump_stack(\$text, \@stack, $state); - # close stack after bye - close_stack_texi_structure(\$text, \@stack, $state, $texi_line_number); - } - next if (@stack); - $_ = $text; - $text = ''; - next if !defined($_); - push @lines, split_lines ($_); - last if ($state->{'bye'}); - } - # close stack at the end of pass texi - close_stack_texi_structure(\$text, \@stack, $state, $texi_line_number); - push @lines, split_lines ($text); - print STDERR "# end of pass texi\n" if $T2H_VERBOSE; -} - -# return the line after preserving things according to misc_command map. -sub preserve_command($$) -{ - my $line = shift; - my $macro = shift; - my $text = ''; - my $args = ''; - my $skip_spec = ''; - my $arg_spec = ''; - - $skip_spec = $Texi2HTML::Config::misc_command{$macro}->{'skip'} - if (defined($Texi2HTML::Config::misc_command{$macro}->{'skip'})); - $arg_spec = $Texi2HTML::Config::misc_command{$macro}->{'arg'} - if (defined($Texi2HTML::Config::misc_command{$macro}->{'arg'})); - - if ($arg_spec eq 'line') - { - $text .= $line; - $args .= $line; - $line = ''; - } - elsif ($arg_spec) - { - my $arg_nr = $Texi2HTML::Config::misc_command{$macro}->{'arg'}; - while ($arg_nr) - { - $line =~ s/(\s+\S*)//o; - $text .= $1 if defined($1); - $args .= $1 if defined($1); - $arg_nr--; - } - } - - if ($macro eq 'bye') - { - $line = ''; - $text = "\n"; - } - elsif ($skip_spec eq 'linespace') - { - if ($line =~ /^\s*$/o) - { - $line =~ s/([ \t]*)//o; - $text .= $1; - } - } - elsif ($skip_spec eq 'linewhitespace') - { - if ($line =~ /^\s*$/o) - { - $text .= $line; - $line = ''; - } - } - elsif ($skip_spec eq 'line') - { - $text .= $line; - $line = ''; - } - elsif ($skip_spec eq 'whitespace') - { - $line =~ s/(\s*)//o; - $text .= $1; - } - elsif ($skip_spec eq 'space') - { - $line =~ s/([ \t]*)//o; - $text .= $1; - } - $line = '' if (!defined($line)); - return ($line, "\@$macro" . $text, $args); -} - -#+++########################################################################### -# # -# Pass structure: parse document structure # -# # -#---########################################################################### - -# This is a virtual element for things appearing before @node and -# sectionning commands -my $element_before_anything = -{ - 'before_anything' => 1, - 'place' => [], - 'texi' => 'VIRTUAL ELEMENT BEFORE ANYTHING', -}; - -sub initialise_state_structure($) -{ - my $state = shift; - $state->{'structure'} = 1; # for substitute_text and close_stack: - # 1 if pass_structure/scan_structure is - # to be used - $state->{'menu'} = 0; # number of opened menus - $state->{'detailmenu'} = 0; # number of opened detailed menus - $state->{'level'} = 0; # current sectionning level - $state->{'table_stack'} = [ "no table" ]; # a stack of opened tables/lists - delete ($state->{'region_lines'}) unless (defined($state->{'region_lines'})); -} - -my @doc_lines = (); # whole document -my @doc_numbers = (); # whole document line numbers and file names -my @nodes_list = (); # nodes in document reading order - # each member is a reference on a hash -my @sections_list = (); # sections in reading order - # each member is a reference on a hash -my @elements_list = (); # sectionning elements (nodes and sections) - # in reading order. Each member is a reference - # on a hash which also appears in %nodes, - # @sections_list @nodes_list, @all_elements -my @all_elements; # all the elements in document order -my %nodes = (); # nodes hash. The key is the texi node name -my %cross_reference_nodes = (); # normalized node names -my %sections = (); # sections hash. The key is the section number - # headings are there, although they are not elements -my $element_top; # Top element -my $node_top; # Top node -my $node_first; # First node -my $element_index; # element with first index -my $element_chapter_index; # chapter with first index -my $element_first; # first element -my $element_last; # last element - -# This is a virtual element used to have the right hrefs for index entries -# and anchors in footnotes -my $footnote_element = -{ - 'id' => 'SEC_Foot', - 'file' => $docu_foot, - 'footnote' => 1, - 'element' => 1, - 'place' => [], -}; - -#my $do_contents; # do table of contents if true -#my $do_scontents; # do short table of contents if true -my $novalidate = $Texi2HTML::Config::NOVALIDATE; # @novalidate appeared - -sub pass_structure() -{ - my $state = {}; - # holds the informations about the context - # to pass it down to the functions - initialise_state_structure($state); - $state->{'element'} = $element_before_anything; - $state->{'place'} = $element_before_anything->{'place'}; - my @stack; - my $text; - my $line_nr; - - while (@lines) - { - $_ = shift @lines; - my $chomped_line = $_; - if (!chomp($chomped_line) and @lines) - { - $lines[0] = $_ . $lines[0]; - next; - } - $line_nr = shift (@lines_numbers); - #print STDERR "PASS_STRUCTURE: $_"; - if (!$state->{'raw'} and !$state->{'special'} and !$state->{'verb'}) - { - my $tag = ''; - if (/^\s*\@(\w+)\b/) - { - $tag = $1; - } - - # - # analyze the tag - # - if ($tag and $tag eq 'node' or defined($sec2level{$tag}) or $tag eq 'printindex' or $tag eq 'float') - { - $_ = substitute_texi_line($_); #usefull if there is an anchor ??? - if (@stack and $tag eq 'node' or defined($sec2level{$tag}) or -$tag eq 'float') - {# in pass structure node and float shouldn't appear in formats - close_stack_texi_structure(\$text, \@stack, $state, $line_nr); - if (exists($state->{'region_lines'})) - { - push @{$region_lines{$state->{'region_lines'}->{'format'}}}, split_lines ($text); - } - else - { - push @doc_lines, split_lines ($text); - } - $text = ''; - } - if ($tag eq 'node') - { - my $node_ref; - my $auto_directions; - $auto_directions = 1 unless (/,/o); - my ($node, $node_next, $node_prev, $node_up) = split(/,/, $_); - $node =~ s/^\@node\s+// if ($node); - if ($node) - { - $node = normalise_space($node); - if (exists($nodes{$node}) and defined($nodes{$node}) - and $nodes{$node}->{'seen'}) - { - echo_error ("Duplicate node found: $node", $line_nr); - next; - } - else - { - if (exists($nodes{$node}) and defined($nodes{$node})) - { # node appeared in a menu - $node_ref = $nodes{$node}; - } - else - { - my $first; - $first = 1 if (!defined($node_ref)); - $node_ref = {}; - $node_first = $node_ref if ($first); - $nodes{$node} = $node_ref; - } - $node_ref->{'node'} = 1; - $node_ref->{'tag'} = 'node'; - $node_ref->{'tag_level'} = 'node'; - $node_ref->{'texi'} = $node; - $node_ref->{'seen'} = 1; - $node_ref->{'automatic_directions'} = $auto_directions; - $node_ref->{'place'} = []; - $node_ref->{'current_place'} = []; - merge_element_before_anything($node_ref); - $node_ref->{'index_names'} = []; - $state->{'place'} = $node_ref->{'current_place'}; - $state->{'element'} = $node_ref; - $state->{'after_element'} = 1; - $state->{'node_ref'} = $node_ref; - # makeinfo treats differently case variants of - # top in nodes and anchors and in refs commands and - # refs from nodes. - if ($node =~ /^top$/i) - { - if (!defined($node_top)) - { - $node_top = $node_ref; - $node_top->{'texi'} = 'Top'; - delete $nodes{$node}; - $nodes{$node_top->{'texi'}} = $node_ref; - } - else - { # All the refs are going to point to the first Top - echo_warn ("Top node allready exists", $line_nr); - #warn "$WARN Top node allready exists\n"; - } - } - unless (@nodes_list) - { - $node_ref->{'first'} = 1; - } - push (@nodes_list, $node_ref); - push @elements_list, $node_ref; - } - } - else - { - echo_error ("Node is undefined: $_ (eg. \@node NODE-NAME, NEXT, PREVIOUS, UP)", $line_nr); - next; - } - - if ($node_next) - { - $node_ref->{'node_next'} = normalise_node($node_next); - } - if ($node_prev) - { - $node_ref->{'node_prev'} = normalise_node($node_prev); - } - if ($node_up) - { - $node_ref->{'node_up'} = normalise_node($node_up); - } - } - elsif (defined($sec2level{$tag})) - { - if (/^\@$tag\s*(.*)$/) - { - my $name = normalise_space($1); - $name = '' if (!defined($name)); - my $level = $sec2level{$tag}; - $state->{'after_element'} = 1; - my ($docid, $num); - if($tag ne 'top') - { - $sec_num++; - $num = $sec_num; - $docid = "SEC$sec_num"; - } - else - { - $num = 0; - $docid = "SEC_Top"; - } - if ($tag !~ /heading/) - { - my $section_ref = { 'texi' => $name, - 'level' => $level, - 'tag' => $tag, - 'sec_num' => $num, - 'section' => 1, - 'id' => $docid, - 'seen' => 1, - 'index_names' => [], - 'current_place' => [], - 'place' => [] - }; - - if ($tag eq 'top') - { - $section_ref->{'top'} = 1; - $section_ref->{'number'} = ''; - $sections{0} = $section_ref; - $element_top = $section_ref; - } - $sections{$num} = $section_ref; - merge_element_before_anything($section_ref); - if ($state->{'node_ref'} and !exists($state->{'node_ref'}->{'with_section'})) - { - my $node_ref = $state->{'node_ref'}; - $section_ref->{'node_ref'} = $node_ref; - $section_ref->{'titlefont'} = $node_ref->{'titlefont'}; - $node_ref->{'with_section'} = $section_ref; - $node_ref->{'top'} = 1 if ($tag eq 'top'); - } - if (! $name and $level) - { - echo_warn ("$tag without name", $line_nr); - } - push @sections_list, $section_ref; - push @elements_list, $section_ref; - $state->{'section_ref'} = $section_ref; - $state->{'element'} = $section_ref; - $state->{'place'} = $section_ref->{'current_place'}; - my $node_ref = "NO NODE"; - my $node_texi =''; - if ($state->{'node_ref'}) - { - $node_ref = $state->{'node_ref'}; - $node_texi = $state->{'node_ref'}->{'texi'}; - } - print STDERR "# pass_structure node($node_ref)$node_texi, tag \@$tag($level) ref $section_ref, num,id $num,$docid\n $name\n" - if $T2H_DEBUG & $DEBUG_ELEMENTS; - } - else - { - my $section_ref = { 'texi' => $name, - 'level' => $level, - 'heading' => 1, - 'tag' => $tag, - 'tag_level' => $tag, - 'sec_num' => $sec_num, - 'id' => $docid, - 'number' => '' }; - $state->{'element'} = $section_ref; - push @{$state->{'place'}}, $section_ref; - $sections{$sec_num} = $section_ref; - } - } - } - elsif ($tag eq 'float') - { - my ($style_texi, $label_texi) = split(/,/, $_); - $style_texi =~ s/^\@float\s*//; - $style_texi = normalise_space($style_texi); - $label_texi = undef if (defined($label_texi) and ($label_texi =~ /^\s*$/)); - if (defined($label_texi)) - { - $label_texi = normalise_node($label_texi); - if (exists($nodes{$label_texi}) and defined($nodes{$label_texi}) - and $nodes{$label_texi}->{'seen'}) - { - echo_error ("Duplicate label found: $label_texi", $line_nr); - while ($_ =~ /,/) - { - $_ =~ s/,.*$//; - } - } - else - { - my $float = { }; - if (exists($nodes{$label_texi}) and defined($nodes{$label_texi})) - { # float appeared in a menu - $float = $nodes{$label_texi}; - } - else - { - $nodes{$label_texi} = $float; - } - $float->{'float'} = 1; - $float->{'tag'} = 'float'; - $float->{'texi'} = $label_texi; - $float->{'seen'} = 1; - $float->{'id'} = $label_texi; -#print STDERR "FLOAT: $float $float->{'texi'}, place $state->{'place'}\n"; - push @{$state->{'place'}}, $float; - $float->{'element'} = $state->{'element'}; - $state->{'float'} = $float; - $float->{'style_texi'} = $style_texi; - push @floats, $float; - } - } - } - elsif (/^\@printindex\s+(\w+)/) - { - unless (@elements_list) - { - echo_warn ("Printindex before document beginning: \@printindex $1", $line_nr); - next; - } - $state->{'after_element'} = 0; - # $element_index is the first element with index - $element_index = $elements_list[-1] unless (defined($element_index)); - # associate the index to the element such that the page - # number is right - my $placed_elements = []; - push @{$elements_list[-1]->{'index_names'}}, { 'name' => $1, 'place' => $placed_elements }; - $state->{'place'} = $placed_elements; - } - if (exists($state->{'region_lines'})) - { - push @{$region_lines{$state->{'region_lines'}->{'format'}}}, $_; - } - else - { - push @doc_lines, $_; - push @doc_numbers, $line_nr; - } - next; - } - } - if (scan_structure ($_, \$text, \@stack, $state, $line_nr) and !(exists($state->{'region_lines'}))) - { - push (@doc_numbers, $line_nr); - } - next if (@stack); - $_ = $text; - $text = ''; - next if (!defined($_)); - if ($state->{'region_lines'}) - { - push @{$region_lines{$state->{'region_lines'}->{'format'}}}, split_lines ($_); - } - else - { - push @doc_lines, split_lines ($_); - } - } - if (@stack) - {# close stack at the end of pass structure - close_stack_texi_structure(\$text, \@stack, $state, $line_nr); - push @doc_lines, split_lines ($text) if ($text and (!exists($state->{'region_lines'}))); - } - echo_warn ("At end of document, $state->{'region_lines'}->{'number'} $state->{'region_lines'}->{'format'} not closed") if (exists($state->{'region_lines'})); - print STDERR "# end of pass structure\n" if $T2H_VERBOSE; -} - -# split line at end of line and put each resulting line in an array -sub split_lines($) -{ - my $line = shift; - my @result = (); - my $i = 0; - while ($line) - { - $result[$i] = ''; - $line =~ s/^(.*)//; - $result[$i] .= $1; - $result[$i] .= "\n" if ($line =~ s/^\n//); - #print STDERR "$i: $result[$i]"; - $i++; - } - return @result; -} - -sub misc_command_structure($$$$) -{ - my $line = shift; - my $macro = shift; - my $state = shift; - my $line_nr = shift; - my $text; - my $args; - - if ($macro eq 'lowersections') - { - my ($sec, $level); - while (($sec, $level) = each %sec2level) - { - $sec2level{$sec} = $level + 1; - } - $state->{'level'}--; - } - elsif ($macro eq 'raisesections') - { - my ($sec, $level); - while (($sec, $level) = each %sec2level) - { - $sec2level{$sec} = $level - 1; - } - $state->{'level'}++; - } - elsif ($macro eq 'contents') - { - $Texi2HTML::Config::DO_CONTENTS = 1; - } - elsif ($macro eq 'detailmenu') - { - $state->{'detailmenu'}++; - } - elsif (($macro eq 'summarycontents') or ($macro eq 'shortcontents')) - { - $Texi2HTML::Config::DO_SCONTENTS = 1; - } - elsif ($macro eq 'novalidate') - { - $novalidate = 1; - } - elsif (grep {$_ eq $macro} ('settitle','setfilename','shortitle','shorttitlepage') - and ($line =~ /^\s+(.*)$/)) - { - $value{"_$macro"} = substitute_texi_line($1); - } - elsif (grep {$_ eq $macro} ('author','subtitle','title') - and ($line =~ /^\s+(.*)$/)) - { - $value{"_$macro"} .= substitute_texi_line($1)."\n"; - push @{$Texi2HTML::THISDOC{"${macro}s"}}, substitute_texi_line($1); - } - elsif ($macro eq 'synindex' || $macro eq 'syncodeindex') - { - if ($line =~ /^\s+(\w+)\s+(\w+)/) - { - my $from = $1; - my $to = $2; - my $prefix_from = index_name2prefix($from); - my $prefix_to = index_name2prefix($to); - echo_error ("unknown from index name $from in \@$macro", $line_nr) - unless $prefix_from; - echo_error ("unknown to index name $to in \@$macro", $line_nr) - unless $prefix_to; - if ($prefix_from and $prefix_to) - { - if ($macro eq 'syncodeindex') - { - $index_properties->{$prefix_to}->{'from_code'}->{$prefix_from} = 1; - } - else - { - $index_properties->{$prefix_to}->{'from'}->{$prefix_from} = 1; - } - } - } - else - { - echo_error ("Bad $macro line: $line", $line_nr); - } - } - elsif ($macro eq 'defindex' || $macro eq 'defcodeindex') - { - if ($line =~ /^\s+(\w+)\s*$/) - { - my $name = $1; - $index_properties->{$name}->{'name'} = $name; - $index_properties->{$name}->{'code'} = 1 if $macro eq 'defcodeindex'; - } - else - {# FIXME makeinfo don't warn ? - echo_error ("Bad $macro line: $line", $line_nr); - } - } - elsif ($macro eq 'documentlanguage') - { - if ($line =~ /\s+(\w+)/) - { - my $lang = $1; - set_document_language($lang, 0, $line_nr) if (!$cmd_line_lang && $lang); - } - } - elsif ($macro eq 'kbdinputstyle') - {# FIXME makeinfo ignores that with --html - if ($line =~ /\s+([a-z]+)/) - { - if ($1 eq 'code') - { - $style_map_ref->{'kbd'} = $style_map_ref->{'code'}; - $style_map_pre_ref->{'kbd'} = $style_map_pre_ref->{'code'}; - $Texi2HTML::THISDOC{'kbdinputstyle'} = $1; - } - elsif ($1 eq 'example') - { - $style_map_pre_ref->{'kbd'} = $style_map_pre_ref->{'code'}; - $Texi2HTML::THISDOC{'kbdinputstyle'} = $1; - } - elsif ($1 ne 'distinct') - { - echo_error ("Unknown argument for \@$macro: $1", $line_nr); - } - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'paragraphindent') - { - if ($line =~ /\s+([0-9]+)/) - { - $Texi2HTML::THISDOC{'paragraphindent'} = $1; - } - elsif (($line =~ /\s+(none)[^\w\-]/) or ($line =~ /\s+(asis)[^\w\-]/)) - { - $Texi2HTML::THISDOC{'paragraphindent'} = $1; - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'firstparagraphindent') - { - if (($line =~ /\s+(none)[^\w\-]/) or ($line =~ /\s+(insert)[^\w\-]/)) - { - $Texi2HTML::THISDOC{'firstparagraphindent'} = $1; - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'exampleindent') - { - if ($line =~ /^\s+([0-9]+)/) - { - $Texi2HTML::THISDOC{'exampleindent'} = $1; - } - elsif ($line =~ /^\s+(asis)[^\w\-]/) - { - $Texi2HTML::THISDOC{'exampleindent'} = $1; - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'footnotestyle') - { - if (($line =~ /^\s+(end)[^\w\-]/) or ($line =~ /^\s+(separate)[^\w\-]/)) - { - $Texi2HTML::THISDOC{'footnotestyle'} = $1; - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'headings') - { - my $valid_arg = 0; - foreach my $possible_arg (('off','on','single','double', - 'singleafter','doubleafter')) - { - if ($line =~ /^\s+($possible_arg)[^\w\-]/) - { - $valid_arg = 1; - $Texi2HTML::THISDOC{'headings'} = $possible_arg; - last; - } - } - unless ($valid_arg) - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif ($macro eq 'setchapternewpage') - { - if (($line =~ /^\s+(on)[^\w\-]/) or ($line =~ /^\s+(off)[^\w\-]/) - or ($line =~ /^\s+(odd)[^\w\-]/)) - { - $Texi2HTML::THISDOC{'setchapternewpage'} = $1; - } - else - { - echo_error ("Bad \@$macro", $line_nr); - } - } - elsif (grep {$macro eq $_} ('everyheading', 'everyfooting', - 'evenheading', 'evenfooting', 'oddheading', 'oddfooting')) - { - my $arg = $line; - $arg =~ s/^\s+//; - $Texi2HTML::THISDOC{$macro} = $arg; - } - - ($text, $line, $args) = preserve_command($line, $macro); - return ($text, $line); -} - -# return the line after removing things according to misc_command map. -# if the skipped macro has an effect it is done here -# this is used during pass_text -sub misc_command_text($$$$$$) -{ - my $line = shift; - my $macro = shift; - my $stack = shift; - my $state = shift; - my $text = shift; - my $line_nr = shift; - my ($skipped, $remaining, $args); - my $keep = $Texi2HTML::Config::misc_command{$macro}->{'keep'}; - - if ($macro eq 'detailmenu') - { - $state->{'detailmenu'}++; - } - elsif ($macro eq 'sp') - { - my $sp_number; - if ($line =~ /^\s+(\d+)\s/) - { - $sp_number = $1; - } - elsif ($line =~ /(\s*)$/) - { - $sp_number = ''; - } - else - { - echo_error ("\@$macro needs a numeric arg or no arg", $line_nr); - } - $sp_number = 1 if ($sp_number eq ''); - add_prev($text, $stack, &$Texi2HTML::Config::sp($sp_number, $state->{'preformatted'})); - } - elsif($macro eq 'verbatiminclude' and !$keep) - { - if ($line =~ /\s+(.+)/) - { - my $arg = $1; - my $file = locate_include_file($arg); - if (defined($file)) - { - if (!open(VERBINCLUDE, $file)) - { - echo_warn ("Can't read file $file: $!",$line_nr); - } - else - { - my $verb_text = ''; - while (my $line = <VERBINCLUDE>) - { - $verb_text .= $line; - } - add_prev($text, $stack, &$Texi2HTML::Config::raw('verbatim',$verb_text)); - close VERBINCLUDE; - } - } - else - { - echo_error ("Can't find $arg, skipping", $line_nr); - } - } - else - { - echo_error ("Bad \@$macro line: $_", $line_nr); - } - } - elsif ($macro eq 'need') - { - unless (($line =~ /\s+([0-9]+(\.[0-9]*)?)[^\w\-]/) or - ($line =~ /\s+(\.[0-9]+)[^\w\-]/)) - { - echo_warn ("Bad \@$macro", $line_nr); - } - } - ($remaining, $skipped, $args) = preserve_command($line, $macro); - if ($keep) - { - $remaining = $args . $remaining; - } - return $remaining if ($remaining ne ''); - return undef; -} - -# merge the things appearing before the first @node or sectionning command -# (held by element_before_anything) with the current element if not allready -# done -sub merge_element_before_anything($) -{ - my $element = shift; - if (exists($element_before_anything->{'place'})) - { - $element->{'current_place'} = $element_before_anything->{'place'}; - $element->{'titlefont'} = $element_before_anything->{'titlefont'}; - delete $element_before_anything->{'place'}; - foreach my $placed_thing (@{$element->{'current_place'}}) - { - $placed_thing->{'element'} = $element if (exists($placed_thing->{'element'})); - } - } -} - -# find menu_prev, menu_up... for a node in menu -sub menu_entry_texi($$$) -{ - my $node = shift; - my $state = shift; - my $line_nr = shift; - my $node_menu_ref = {}; - if (exists($nodes{$node})) - { - $node_menu_ref = $nodes{$node}; - } - else - { - $nodes{$node} = $node_menu_ref; - $node_menu_ref->{'texi'} = $node; - $node_menu_ref->{'external_node'} = 1 if ($node =~ /\(.+\)/); -# or $novalidate); - } - #$node_menu_ref->{'menu_node'} = 1; - if ($state->{'node_ref'}) - { - $node_menu_ref->{'menu_up'} = $state->{'node_ref'}; - $node_menu_ref->{'menu_up_hash'}->{$state->{'node_ref'}->{'texi'}} = 1; - } - else - { - echo_warn ("menu entry without previous node: $node", $line_nr) unless ($node =~ /\(.+\)/); - #warn "$WARN menu entry without previous node: $node\n" unless ($node =~ /\(.+\)/); - } - return if ($state->{'detailmenu'}); - if ($state->{'prev_menu_node'}) - { - $node_menu_ref->{'menu_prev'} = $state->{'prev_menu_node'}; - $state->{'prev_menu_node'}->{'menu_next'} = $node_menu_ref; - } - elsif ($state->{'node_ref'}) - { - $state->{'node_ref'}->{'menu_child'} = $node_menu_ref; - } - $state->{'prev_menu_node'} = $node_menu_ref; -} - -my %files = (); # keys are files. This is used to avoid reusing an allready - # used file name -my %empty_indices = (); # value is true for an index name key if the index - # is empty -my %printed_indices = (); # value is true for an index name not empty and - # printed - -# find next, prev, up, back, forward, fastback, fastforward -# find element id and file -# split index pages -# associate placed items (items which have links to them) with the right -# file and id -# associate nodes with sections -sub rearrange_elements() -{ - @all_elements = @elements_list; - - print STDERR "# find sections levels and toplevel\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - - my $toplevel = 4; - # correct level if raisesections or lowersections overflowed - # and find toplevel - foreach my $element (values(%sections)) - { - my $level = $element->{'level'}; - if ($level > $MAX_LEVEL) - { - $element->{'level'} = $MAX_LEVEL; - } - elsif ($level < $MIN_LEVEL and !$element->{'top'}) - { - $element->{'level'} = $MIN_LEVEL; - } - else - { - $element->{'level'} = $level; - } - $element->{'toc_level'} = $element->{'level'}; - # This is for top - $element->{'toc_level'} = $MIN_LEVEL if ($element->{'level'} < $MIN_LEVEL); - # find the new tag corresponding with the level of the section - $element->{'tag_level'} = $level2sec{$element->{'tag'}}->[$element->{'level'}] if ($element->{'tag'} !~ /heading/); - $toplevel = $element->{'level'} if (($element->{'level'} < $toplevel) and ($element->{'level'} > 0 and ($element->{'tag'} !~ /heading/))); - print STDERR "# section level $level: $element->{'texi'}\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - } - - print STDERR "# find sections structure, construct section numbers (toplevel=$toplevel)\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - - my $in_appendix = 0; - # these arrays heve an element per sectionning level. - my @previous_numbers = (); # holds the number of the previous sections - # at the same and upper levels - my @previous_sections = (); # holds the ref of the previous sections - - foreach my $section (@sections_list) - { - next if ($section->{'top'}); - print STDERR "Bug level undef for ($section) $section->{'texi'}\n" if (!defined($section->{'level'})); - $section->{'toplevel'} = 1 if ($section->{'level'} == $toplevel); - # undef things under that section level - for (my $level = $section->{'level'} + 1; $level < $MAX_LEVEL + 1 ; $level++) - { - $previous_numbers[$level] = undef; - $previous_sections[$level] = undef; - } - my $number_set; - # find number at the current level - if ($section->{'tag'} =~ /appendix/ and !$in_appendix) - { - $previous_numbers[$toplevel] = 'A'; - $in_appendix = 1; - $number_set = 1 if ($section->{'level'} == $toplevel); - } - if (!defined($previous_numbers[$section->{'level'}]) and !$number_set) - { - if ($section->{'tag'} =~ /unnumbered/) - { - $previous_numbers[$section->{'level'}] = undef; - } - else - { - $previous_numbers[$section->{'level'}] = 1; - } - } - elsif ($section->{'tag'} !~ /unnumbered/ and !$number_set) - { - $previous_numbers[$section->{'level'}]++; - } - # construct the section number - $section->{'number'} = ''; - - unless ($section->{'tag'} =~ /unnumbered/) - { - my $level = $section->{'level'}; - while ($level > $toplevel) - { - my $number = $previous_numbers[$level]; - $number = 0 if (!defined($number)); - if ($section->{'number'}) - { - $section->{'number'} = "$number.$section->{'number'}"; - } - else - { - $section->{'number'} = $number; - } - $level--; - } - my $toplevel_number = $previous_numbers[$toplevel]; - $toplevel_number = 0 if (!defined($toplevel_number)); - $section->{'number'} = "$toplevel_number.$section->{'number'}"; - } - # find the previous section - if (defined($previous_sections[$section->{'level'}])) - { - my $prev_section = $previous_sections[$section->{'level'}]; - $section->{'section_prev'} = $prev_section; - $prev_section->{'next'} = $section; - $prev_section->{'element_next'} = $section; - } - # find the up section - if ($section->{'level'} == $toplevel) - { - $section->{'up'} = undef; - } - else - { - my $level = $section->{'level'} - 1; - while (!defined($previous_sections[$level]) and ($level >= 0)) - { - $level--; - } - if ($level >= 0) - { - $section->{'up'} = $previous_sections[$level]; - # 'child' is the first child - $section->{'up'}->{'child'} = $section unless ($section->{'section_prev'}); - } - else - { - $section->{'up'} = undef; - } - } - $previous_sections[$section->{'level'}] = $section; - # element_up is used for reparenting in case an index page - # splitted a section. This is used in order to preserve the up which - # points to the up section. See below at index pages generation. - $section->{'element_up'} = $section->{'up'}; - - my $up = "NO_UP"; - $up = $section->{'up'} if (defined($section->{'up'})); - print STDERR "# numbering section ($section->{'level'}): $section->{'number'}: (up: $up) $section->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - } - - my @node_directions = ('node_prev', 'node_next', 'node_up'); - # handle nodes - # the node_prev... are texinfo strings, find the associated node references - print STDERR "# Resolve nodes directions\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - foreach my $node (@nodes_list) - { - foreach my $direction (@node_directions) - { - if ($node->{$direction} and !ref($node->{$direction})) - { - if ($nodes{$node->{$direction}} and $nodes{$node->{$direction}}->{'seen'}) - { - $node->{$direction} = $nodes{$node->{$direction}}; - } - elsif (($node->{$direction} =~ /^\(.*\)/) or $novalidate) - { # ref to an external node - if (exists($nodes{$node->{$direction}})) - { - $node->{$direction} = $nodes{$node->{$direction}}; - } - else - { - # FIXME if {'seen'} this is a node appearing in the - # document and a node like `(file)node'. What to - # do then ? - my $node_ref = { 'texi' => $node->{$direction} }; - $node_ref->{'external_node'} = 1 if ($node->{$direction} =~ /^\(.*\)/); - #my $node_ref = { 'texi' => $node->{$direction}, - # 'external_node' => 1 }; - $nodes{$node->{$direction}} = $node_ref; - $node->{$direction} = $node_ref; - } - } - else - { - echo_warn ("$direction `$node->{$direction}' for `$node->{'texi'}' not found"); - delete $node->{$direction}; - } - } - } - } - - # find section preceding and following top - my $section_before_top; # section preceding the top node - my $section_after_top; # section following the top node - if ($node_top) - { - my $previous_is_top = 0; - foreach my $element (@all_elements) - { - if ($element eq $node_top) - { - $previous_is_top = 1; - next; - } - if ($previous_is_top) - { - if ($element->{'section'}) - { - $section_after_top = $element; - last; - } - next; - } - $section_before_top = $element if ($element->{'section'}); - } - } - print STDERR "# section before Top: $section_before_top->{'texi'}\n" - if ($section_before_top and ($T2H_DEBUG & $DEBUG_ELEMENTS)); - print STDERR "# section after Top: $section_after_top->{'texi'}\n" - if ($section_after_top and ($T2H_DEBUG & $DEBUG_ELEMENTS)); - - print STDERR "# Build the elements list\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - if (!$Texi2HTML::Config::USE_NODES) - { - #the only sectionning elements are sections - @elements_list = @sections_list; - # if there is no section we use nodes... - if (!@elements_list) - { - print STDERR "# no section\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - @elements_list = @all_elements; - } - elsif (!$element_top and $node_top and !$node_top->{'with_section'}) - { # special case for the top node if it isn't associated with - # a section. The top node element is inserted between the - # $section_before_top and the $section_after_top - $node_top->{'as_section'} = 1; - $node_top->{'section_ref'} = $node_top; - my @old_element_lists = @elements_list; - @elements_list = (); - while (@old_element_lists) - { - my $section = shift @old_element_lists; - if ($section_before_top and ($section eq $section_before_top)) - { - push @elements_list, $section; - push @elements_list, $node_top; - last; - } - elsif ($section_after_top and ($section eq $section_after_top)) - { - push @elements_list, $node_top; - push @elements_list, $section; - last; - } - push @elements_list, $section; - } - push @elements_list, @old_element_lists; - } - - foreach my $element (@elements_list) - { - print STDERR "# new section element $element->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - } - } - else - { - # elements are sections if possible, and node if no section associated - my @elements = (); - while (@elements_list) - { - my $element = shift @elements_list; - if ($element->{'node'}) - { - if (!defined($element->{'with_section'})) - { - $element->{'toc_level'} = $MIN_LEVEL if (!defined($element->{'toc_level'})); - print STDERR "# new node element ($element) $element->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - push @elements, $element; - } - } - else - { - print STDERR "# new section element ($element) $element->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - push @elements, $element; - } - } - @elements_list = @elements; - } - foreach my $element (@elements_list) - { - $element->{'element'} = 1; - } - - # nodes are attached to the section preceding them if not allready - # associated with a section - print STDERR "# Find the section associated with each node\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - my $current_section = $sections_list[0]; - $current_section = $node_top if ($node_top and $node_top->{'as_section'} and !$section_before_top); - my $current; - foreach my $element (@all_elements) - { - if ($element->{'node'} and !$element->{'as_section'}) - { - if ($element->{'with_section'}) - { # the node is associated with a section - $element->{'section_ref'} = $element->{'with_section'}; - push @{$element->{'section_ref'}->{'nodes'}}, $element; - } - elsif (defined($current_section)) - { - $current_section = $section_after_top - if ($current_section->{'node'} and $section_after_top); - $element->{'in_top'} = 1 if ($current_section->{'top'}); - $element->{'section_ref'} = $current_section; - # nodes are considered sub elements for the purprose of - # reparenting and their element_next and element_prev - # are next and prev node associated with the same section - $element->{'element_up'} = $current_section; - $element->{'toc_level'} = $current_section->{'toc_level'}; - if (defined($current)) - { - $current->{'element_next'} = $element; - $element->{'element_prev'} = $current; - } - $current = $element; - push @{$element->{'section_ref'}->{'nodes'}}, $element; - } - else - { - $element->{'toc_level'} = $MIN_LEVEL; - } - } - else - { - $current = undef; - $current_section = $element; - if ($element->{'node'}) - { # Top node - $element->{'toc_level'} = $MIN_LEVEL; - push @{$element->{'section_ref'}->{'nodes'}}, $element; - } - } - } - print STDERR "# Complete nodes next prev and up based on menus and sections\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - foreach my $node (@nodes_list) - { - if (!$node->{'first'} and !$node->{'top'} and !$node->{'menu_up'} and ($node->{'texi'} !~ /^top$/i) and $Texi2HTML::Config::SHOW_MENU) - { - warn "$WARN `$node->{'texi'}' doesn't appear in menus\n"; - } - - # use values deduced from menus to complete missing up, next, prev - # or from sectionning commands if automatic sectionning - if ($node->{'node_up'}) - { - $node->{'up'} = $node->{'node_up'}; - } - elsif ($node->{'automatic_directions'} and $node->{'section_ref'} and defined($node->{'section_ref'}->{'up'})) - { - $node->{'up'} = get_node($node->{'section_ref'}->{'up'}); - } - elsif ($node->{'menu_up'}) - { - $node->{'up'} = $node->{'menu_up'}; - } - - if ($node->{'up'} and !$node->{'up'}->{'external_node'}) - { - # We detect when the up node has no menu entry for that node, as - # there may be infinite loops when finding following node (see below) - unless (defined($node->{'menu_up_hash'}) and ($node->{'menu_up_hash'}->{$node->{'up'}->{'texi'}})) - { - print STDERR "$WARN `$node->{'up'}->{'texi'}' is up for `$node->{'texi'}', but has no menu entry for this node\n" if ($Texi2HTML::Config::SHOW_MENU); - push @{$node->{'up_not_in_menu'}}, $node->{'up'}->{'texi'}; - } - } - - # Find next node - if ($node->{'node_next'}) - { - $node->{'next'} = $node->{'node_next'}; - } - elsif ($node->{'texi'} eq 'Top') - { # special case as said in the texinfo manual - $node->{'next'} = $node->{'menu_child'} if ($node->{'menu_child'}); - } - elsif ($node->{'automatic_directions'}) - { - if (defined($node->{'section_ref'})) - { - my $next; - my $section = $node->{'section_ref'}; - if (defined($section->{'next'})) - { - $next = get_node($section->{'next'}) - } - else - { - while (defined($section->{'up'}) and !defined($section->{'next'})) - { - $section = $section->{'up'}; - } - if (defined($section->{'next'})) - { - $next = get_node($section->{'next'}); - } - } - $node->{'next'} = $next; - } - } - if (!defined($node->{'next'}) and $node->{'menu_next'}) - { - $node->{'next'} = $node->{'menu_next'}; - } - # Find prev node - if ($node->{'node_prev'}) - { - $node->{'prev'} = $node->{'node_prev'}; - } - elsif ($node->{'automatic_directions'}) - { - if (defined($node->{'section_ref'})) - { - my $section = $node->{'section_ref'}; - if (defined($section->{'section_prev'})) - { - $node->{'prev'} = get_node($section->{'section_prev'}); - } - elsif (defined($section->{'up'})) - { - $node->{'prev'} = get_node($section->{'up'}); - } - } - } - # next we try menus. makeinfo don't do that - if (!defined($node->{'prev'}) and $node->{'menu_prev'}) - { - $node->{'prev'} = $node->{'menu_prev'}; - } - # the prev node is the parent node - elsif (!defined($node->{'prev'}) and $node->{'menu_up'}) - { - $node->{'prev'} = $node->{'menu_up'}; - } - - # the following node is the node following in node reading order - # it is thus first the child, else the next, else the next following - # the up - if ($node->{'menu_child'}) - { - $node->{'following'} = $node->{'menu_child'}; - } - elsif ($node->{'automatic_directions'} and defined($node->{'section_ref'}) and defined($node->{'section_ref'}->{'child'})) - { - $node->{'following'} = get_node ($node->{'section_ref'}->{'child'}); - } - elsif (defined($node->{'next'})) - { - $node->{'following'} = $node->{'next'}; - } - else - { - my $up = $node->{'up'}; - # in order to avoid infinite recursion in case the up node is the - # node itself we use the up node as following when there isn't - # a correct menu structure, here and also below. - $node->{'following'} = $up if (defined($up) and grep {$_ eq $up->{'texi'}} @{$node->{'up_not_in_menu'}}); - while ((!defined($node->{'following'})) and (defined($up))) - { - if (($node_top) and ($up eq $node_top)) - { # if we are at Top, Top is following - $node->{'following'} = $node_top; - $up = undef; - } - if (defined($up->{'next'})) - { - $node->{'following'} = $up->{'next'}; - } - elsif (defined($up->{'up'})) - { - if (! grep { $_ eq $up->{'up'}->{'texi'} } @{$node->{'up_not_in_menu'}}) - { - $up = $up->{'up'}; - } - else - { # in that case we can go into a infinite loop - $node->{'following'} = $up->{'up'}; - } - } - else - { - $up = undef; - } - } - } - } - - # find first and last elements before we split indices - # FIXME Is it right for the last element ? Or should it be the last - # with indices taken into account ? - $element_first = $elements_list[0]; - print STDERR "# element first: $element_first->{'texi'}\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - print STDERR "# top node: $node_top->{'texi'}\n" if (defined($node_top) and - ($T2H_DEBUG & $DEBUG_ELEMENTS)); - # If there is no @top section no top node the first node is the top element - $element_top = $node_top if (!defined($element_top) and defined($node_top)); - $element_top = $element_first unless (defined($element_top)); - $element_top->{'top'} = 1 if ($element_top->{'node'}); - $element_last = $elements_list[-1]; - print STDERR "# element top: $element_top->{'texi'}\n" if ($element_top and - ($T2H_DEBUG & $DEBUG_ELEMENTS)); - - print STDERR "# find forward and back\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - my $prev; - foreach my $element (@elements_list) - { - # complete the up for toplevel elements - if ($element->{'toplevel'} and !defined($element->{'up'}) and $element ne $element_top) - { - $element->{'up'} = $element_top; - } - # The childs are element which should be reparented in cas a chapter - # is split by an index - push @{$element->{'element_up'}->{'childs'}}, $element if (defined($element->{'element_up'})); - if ($prev) - { - $element->{'back'} = $prev; - $prev->{'forward'} = $element; - $prev = $element; - } - else - { - $prev = $element; - } - # If the element is not a node, then all the node directions are copied - # if there is an associated node - if (defined($element->{'node_ref'})) - { - $element->{'nodenext'} = $element->{'node_ref'}->{'next'}; - $element->{'nodeprev'} = $element->{'node_ref'}->{'prev'}; - $element->{'menu_next'} = $element->{'node_ref'}->{'menu_next'}; - $element->{'menu_prev'} = $element->{'node_ref'}->{'menu_prev'}; - $element->{'menu_child'} = $element->{'node_ref'}->{'menu_child'}; - $element->{'menu_up'} = $element->{'node_ref'}->{'menu_up'}; - $element->{'nodeup'} = $element->{'node_ref'}->{'up'}; - $element->{'following'} = $element->{'node_ref'}->{'following'}; - } - elsif (! $element->{'node'}) - { # the section has no node associated. Find the node directions using - # sections - if (defined($element->{'next'})) - { - $element->{'nodenext'} = get_node($element->{'next'}); - } - if (defined($element->{'section_prev'})) - { - $element->{'nodeprev'} = get_node($element->{'section_prev'}); - } - if (defined($element->{'up'})) - { - $element->{'nodeup'} = get_node($element->{'up'}); - } - if ($element->{'child'}) - { - $element->{'following'} = get_node($element->{'child'}); - } - elsif ($element->{'next'}) - { - $element->{'following'} = get_node($element->{'next'}); - } - elsif ($element->{'up'}) - { - my $up = $element; - while ($up->{'up'} and !$element->{'following'}) - { - $up = $up->{'up'}; - if ($up->{'next_section'}) - { - $element->{'following'} = get_node ($up->{'next_section'}); - } - } - } - } - if ($element->{'node'}) - { - $element->{'nodeup'} = $element->{'up'}; - $element->{'nodeprev'} = $element->{'prev'}; - $element->{'nodenext'} = $element->{'next'}; - } - } - - my @new_elements = (); - print STDERR "# preparing indices\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - - while(@elements_list) - { - my $element = shift @elements_list; - # @checked_elements are the elements included in the $element (including - # itself) and are searched for indices - my @checked_elements = (); - if (!$element->{'node'} or $element->{'as_section'}) - { - if (!$Texi2HTML::Config::USE_NODES) - { - foreach my $node (@{$element->{'nodes'}}) - { - # we update the element index, first element with index - # if it is a node - $element_index = $element if ($element_index and ($node eq $element_index)); - push @checked_elements, $node; - # we push the section itself after the corresponding node - if (defined($element->{'node_ref'}) and ($node eq $element->{'node_ref'})) - { - push @checked_elements, $element; - } - } - if (!defined($element->{'node_ref'}) and !$element->{'node'}) - { - push @checked_elements, $element; - } - $element->{'nodes'} = []; # We reset the element nodes list - # as the nodes may be associated below to another element if - # the element is split accross several other elements/pages - } - else - { - if ($element->{'node_ref'}) - { - push @checked_elements, $element->{'node_ref'}; - $element_index = $element if ($element_index and ($element->{'node_ref'} eq $element_index)); - } - push @checked_elements, $element; - $element->{'nodes'} = []; - } - } - else - { - push @checked_elements, $element; - } - my $checked_nodes = ''; - foreach my $checked (@checked_elements) - { - $checked_nodes .= "$checked->{'texi'}, "; - } - print STDERR "# Elements checked for $element->{'texi'}: $checked_nodes\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - # current_element is the last element holding text - my $current_element = { 'holder' => 1, 'texi' => 'HOLDER', - 'place' => [], 'indices' => [] }; - # back is sed to find back and forward - my $back = $element->{'back'} if defined($element->{'back'}); - # forward is sed to find forward of the last inserted element - my $forward = $element->{'forward'}; - my $element_next = $element->{'element_next'}; - my $index_num = 0; - my @waiting_elements = (); # elements (nodes) not used for sectionning - # waiting to be associated with an element - foreach my $checked_element(@checked_elements) - { - if ($checked_element->{'element'}) - { # this is the element, we must add it - push @new_elements, $checked_element; - if ($current_element->{'holder'}) - { # no previous element added - push @{$checked_element->{'place'}}, @{$current_element->{'place'}}; - foreach my $index(@{$current_element->{'indices'}}) - { - push @{$checked_element->{'indices'}}, [ { 'element' => $checked_element, 'page' => $index->[0]->{'page'}, 'name' => $index->[0]->{'name'} } ] ; - } - } - else - { - if ($checked_element->{'toplevel'}) - # there was an index_page added, this index_page is toplevel. - # it begun a new chapter. The element next for this - # index page (current_element) is the checked_element - { - $current_element->{'element_next'} = $checked_element; - } - $current_element->{'next'} = $checked_element; - $current_element->{'following'} = $checked_element; - $checked_element->{'prev'} = $current_element; - } - $current_element = $checked_element; - $checked_element->{'back'} = $back; - $back->{'forward'} = $checked_element if (defined($back)); - $back = $checked_element; - push @{$checked_element->{'nodes'}}, @waiting_elements; - my $waiting_element; - while (@waiting_elements) - { - $waiting_element = shift @waiting_elements; - $waiting_element->{'section_ref'} = $checked_element; - } - } - elsif ($current_element->{'holder'}) - { - push @waiting_elements, $checked_element; - } - else - { - push @{$current_element->{'nodes'}}, $checked_element; - $checked_element->{'section_ref'} = $current_element; - } - push @{$current_element->{'place'}}, @{$checked_element->{'current_place'}}; - foreach my $index (@{$checked_element->{'index_names'}}) - { - print STDERR "# Index in `$checked_element->{'texi'}': $index->{'name'}. Current is `$current_element->{'texi'}'\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - my ($Pages, $Entries) = get_index($index->{'name'}); - if (defined($Pages)) - { - my @pages = @$Pages; - my $first_page = shift @pages; - # begin debug section - my $back_texi = 'NO_BACK'; - $back_texi = $back->{'texi'} if (defined($back)); - print STDERR "# New index first page (back `$back_texi', current `$current_element->{'texi'}')\n" if ($T2H_DEBUG & $DEBUG_INDEX); - # end debug section - push @{$current_element->{'indices'}}, [ {'element' => $current_element, 'page' => $first_page, 'name' => $index->{'name'} } ]; - if (@pages) - { - if ($current_element->{'holder'}) - { # the current element isn't a real element. - # We add the real element - # we are in a node of a section but the element - # is splitted by the index, thus we must add - # a new element which will contain the text - # between the beginning of the element and the index - push @new_elements, $checked_element; - print STDERR "# Add element `$element->{'texi'}' before index page\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - $checked_element->{'element'} = 1; - $checked_element->{'level'} = $element->{'level'}; - $checked_element->{'toc_level'} = $element->{'toc_level'}; - $checked_element->{'toplevel'} = $element->{'toplevel'}; - $checked_element->{'up'} = $element->{'up'}; - $checked_element->{'element_added'} = 1; - print STDERR "Bug: checked element wasn't seen" if - (!$checked_element->{'seen'}); - delete $checked_element->{'with_section'}; - if ($checked_element->{'toplevel'}) - { - $element->{'element_prev'}->{'element_next'} = $checked_element if (exists($element->{'element_prev'})); - } - push @{$checked_element->{'place'}}, @{$current_element->{'place'}}; - foreach my $index(@{$current_element->{'indices'}}) - { - push @{$checked_element->{'indices'}}, [ { 'element' => $checked_element, 'page' => $index->[0]->{'page'}, 'name' => $index->[0]->{'name'} } ] ; - } - push @{$checked_element->{'nodes'}}, @waiting_elements; - my $waiting_element; - while (@waiting_elements) - { - $waiting_element = shift @waiting_elements; - $waiting_element->{'section_ref'} = $checked_element; - } - $checked_element->{'back'} = $back; - $back->{'forward'} = $checked_element if (defined($back)); - $current_element = $checked_element; - $back = $checked_element; - } - my $index_page; - while(@pages) - { - print STDERR "# New page (back `$back->{'texi'}', current `$current_element->{'texi'}')\n" if ($T2H_DEBUG & $DEBUG_INDEX); - $index_num++; - my $page = shift @pages; - $index_page = { 'index_page' => 1, - 'texi' => "$element->{'texi'} index $index->{'name'} page $index_num", - 'level' => $element->{'level'}, - 'tag' => $element->{'tag'}, - 'tag_level' => $element->{'tag_level'}, - 'toplevel' => $element->{'toplevel'}, - 'up' => $element->{'up'}, - 'element_up' => $element->{'element_up'}, - 'element_next' => $element_next, - 'element_ref' => $element, - 'back' => $back, - 'prev' => $back, - 'next' => $current_element->{'next'}, - 'following' => $current_element->{'following'}, - 'nodeup' => $current_element->{'nodeup'}, - 'nodenext' => $current_element->{'nodenext'}, - 'nodeprev' => $back, - 'place' => [], - 'seen' => 1, - 'page' => $page - }; - $index_page->{'node'} = 1 if ($element->{'node'}); - while ($nodes{$index_page->{'texi'}}) - { - $nodes{$index_page->{'texi'}} .= ' '; - } - $nodes{$index_page->{'texi'}} = $index_page; - push @{$current_element->{'indices'}->[-1]}, {'element' => $index_page, 'page' => $page, 'name' => $index->{'name'} }; - push @new_elements, $index_page; - $back->{'forward'} = $index_page; - $back->{'next'} = $index_page; - $back->{'nodenext'} = $index_page; - $back->{'element_next'} = $index_page unless ($back->{'top'}); - $back->{'following'} = $index_page; - $back = $index_page; - $index_page->{'toplevel'} = 1 if ($element->{'top'}); - } - $current_element = $index_page; - } - } - else - { - print STDERR "# Empty index: $index->{'name'}\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - $empty_indices{$index->{'name'}} = 1; - } - push @{$current_element->{'place'}}, @{$index->{'place'}}; - } - } - if ($forward and ($current_element ne $element)) - { - $current_element->{'forward'} = $forward; - $forward->{'back'} = $current_element; - } - next if ($current_element eq $element or !$current_element->{'toplevel'}); - # reparent the elements below $element, following element - # and following parent of element to the last index page - print STDERR "# Reparent `$element->{'texi'}':\n" if ($T2H_DEBUG & $DEBUG_INDEX); - my @reparented_elements = (); - @reparented_elements = (@{$element->{'childs'}}) if (defined($element->{'childs'})); - push @reparented_elements, $element->{'element_next'} if (defined($element->{'element_next'})); - foreach my $reparented(@reparented_elements) - { - next if ($reparented->{'toplevel'}); - $reparented->{'element_up'} = $current_element; - print STDERR " reparented: $reparented->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - } - } - @elements_list = @new_elements; - - print STDERR "# find fastback and fastforward\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - foreach my $element (@elements_list) - { - my $up = get_top($element); - next unless (defined($up)); - $element_chapter_index = $up if ($element_index and ($element_index eq $element)); - #print STDERR "$element->{'texi'} (top: $element->{'top'}, toplevel: $element->{'toplevel'}, $element->{'element_up'}, $element->{'element_up'}->{'texi'}): up: $up, $up->{'texi'}\n"; - # fastforward is the next element on same level than the upper parent - # element - $element->{'fastforward'} = $up->{'element_next'} if (exists ($up->{'element_next'})); - # if the element isn't at the highest level, fastback is the - # highest parent element - if ($up and ($up ne $element)) - { - $element->{'fastback'} = $up; - } - elsif ($element->{'toplevel'}) - { - # the element is a top level element, we adjust the next - # toplevel element fastback - $element->{'fastforward'}->{'fastback'} = $element if ($element->{'fastforward'}); - } - } - my $index_nr = 0; - # convert directions in direction with first letter in all caps, to be - # consistent with the convention used in the .init file. - # find id for nodes and indices - foreach my $element (@elements_list) - { - $element->{'this'} = $element; - foreach my $direction (('Up', 'Forward', 'Back', 'Next', - 'Prev', 'FastForward', 'FastBack', 'This', 'NodeUp', - 'NodePrev', 'NodeNext', 'Following' )) - { - my $direction_no_caps = $direction; - $direction_no_caps =~ tr/A-Z/a-z/; - $element->{$direction} = $element->{$direction_no_caps}; - } - if ($element->{'index_page'}) - { - $element->{'id'} = "INDEX" . $index_nr; - $index_nr++; - } - } - my $node_nr = 1; - foreach my $node (@nodes_list) - { - $node->{'id'} = 'NOD' . $node_nr; - $node_nr++; - # debug check - print STDERR "Bug: level defined for node `$node->{'texi'}'\n" if (defined($node->{'level'}) and !$node->{'element_added'}); - } - - # Find cross manual links as explained on the texinfo mailing list - cross_manual_links(\%nodes, \%cross_reference_nodes); - - foreach my $float (@floats) - { - $float->{'id'} = cross_manual_line (normalise_node($float->{'texi'})); - $float->{'style_id'} = cross_manual_line (normalise_space($float->{'style_texi'})); - my $float_style = { }; - if (exists($floats{$float->{'style_id'}})) - { - $float_style = $floats{$float->{'style_id'}}; - } - else - { - $floats{$float->{'style_id'}} = $float_style; - } - push @{$float_style->{'floats'}}, $float; - $float->{'absolute_nr'} = scalar(@{$float_style->{'floats'}}); - my $up = get_top($float->{'element'}); - if (!defined($float_style->{'current_chapter'}) or ($up->{'texi'} ne $float_style->{'current_chapter'})) - { - $float_style->{'current_chapter'} = $up->{'texi'}; - $float_style->{'nr_in_chapter'} = 1; - } - else - { - $float_style->{'nr_in_chapter'}++; - } - if ($up->{'number'} ne '') - { - $float->{'chapter_nr'} = $up->{'number'}; - $float->{'nr'} = $float->{'chapter_nr'} . $float_style->{'nr_in_chapter'}; - } - else - { - $float->{'nr'} = $float->{'absolute_nr'}; - } - } - - if ($Texi2HTML::Config::NEW_CROSSREF_STYLE) - { # FIXME allready done for floats? - foreach my $key (keys(%nodes)) - { - my $node = $nodes{$key}; - next if ($node->{'external_node'} or $node->{'index_page'}); - $node->{'id'} = node_to_id($node->{'cross_manual_target'}); - } - } - - # Find node file names - if ($Texi2HTML::Config::NODE_FILES) - { - my $top; - if ($node_top) - { - $top = $node_top; - } - elsif ($element_top->{'node_ref'}) - { - $top = $element_top->{'node_ref'}; - } - else - { - $top = $node_first; - } - if ($top) - { - my $file = "$Texi2HTML::Config::TOP_NODE_FILE.$Texi2HTML::Config::NODE_FILE_EXTENSION"; - $top->{'file'} = $file if ($Texi2HTML::Config::SPLIT eq 'node'); - $top->{'node_file'} = $file; - } - foreach my $key (keys(%nodes)) - { - my $node = $nodes{$key}; - my ($file, $node_file); - ($file, $node_file) = &$Texi2HTML::Config::node_file_name ($node); - $node->{'file'} = $file if (defined($file)); - $node->{'node_file'} = $node_file if (defined($node_file)); -# next if ($node->{'external_node'} or $node->{'index_page'}); -# if (defined($Texi2HTML::Config::node_file_name)) -# { -# ($node->{'file'}, $node->{'node_file'}) = -# &$Texi2HTML::Config::node_file_name ($node); -# } -# else -# { -# next if (defined($node->{'file'})); -# my $name = remove_texi($node->{'texi'}); -# $name =~ s/[^\w\.\-]/-/g; -# my $file = "${name}.$Texi2HTML::Config::NODE_FILE_EXTENSION"; -# $node->{'file'} = $file if (($Texi2HTML::Config::SPLIT eq 'node') and ($Texi2HTML::Config::USE_NODES or $node->{'with_section'})); -# $node->{'node_file'} = $file; -# } - } - } - # find document nr and document file for sections and nodes. - # Split according to Texi2HTML::Config::SPLIT. - # find file and id for placed elements (anchors, index entries, headings) - if ($Texi2HTML::Config::SPLIT) - { - my $cut_section = $toplevel; - my $doc_nr = -1; - if ($Texi2HTML::Config::SPLIT eq 'section') - { - $cut_section = 2 if ($toplevel <= 2); - } - my $top_doc_nr; - my $prev_nr; - foreach my $element (@elements_list) - { - print STDERR "# Splitting ($Texi2HTML::Config::SPLIT) $element->{'texi'}\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - $doc_nr++ if ( - ($Texi2HTML::Config::SPLIT eq 'node') or - ( - (!$element->{'node'} or $element->{'element_added'}) and ($element->{'level'} <= $cut_section) - ) - ); - $doc_nr = 0 if ($doc_nr < 0); # happens if first elements are nodes - $element->{'doc_nr'} = $doc_nr; - if ($Texi2HTML::Config::NODE_FILES and ($Texi2HTML::Config::SPLIT eq 'node')) - { - my $node = get_node($element); - if ($node and $node->{'file'}) - { - $element->{'file'} = $node->{'file'}; - } - unless ($element->{'file'}) - { - $element->{'file'} = "${docu_name}_$doc_nr.$docu_ext"; - $element->{'doc_nr'} = $doc_nr; - } - } - else - { - $element->{'file'} = "${docu_name}_$doc_nr.$docu_ext"; - my $is_top = 0; - if (defined($top_doc_nr)) - { - if ($doc_nr eq $top_doc_nr) - { - $element->{'file'} = "$docu_top"; - if ($element->{'level'} # this is an element below @top. - # It starts a new file. - or ($element->{'node'} and ($element ne $node_top) and (!defined($element->{'section_ref'}) or $element->{'section_ref'} ne $element_top)) - )# this is a node not associated with top - { - $doc_nr++; - $element->{'doc_nr'} = $doc_nr; - $element->{'file'} = "${docu_name}_$doc_nr.$docu_ext"; - } - } - } - elsif ($element eq $element_top or (defined($element->{'section_ref'}) and $element->{'section_ref'} eq $element_top) or (defined($element->{'node_ref'}) and !$element->{'node_ref'}->{'element_added'} and $element->{'node_ref'} eq $element_top)) - { # the top element - $is_top = 1; - $element->{'file'} = "$docu_top"; - # if there is a previous element, we force it to be in - # another file than top - $doc_nr++ if (defined($prev_nr) and $doc_nr == $prev_nr); - $top_doc_nr = $doc_nr; - $element->{'doc_nr'} = $doc_nr; - } - if (defined($Texi2HTML::Config::element_file_name)) - { - $element->{'file'} = - &$Texi2HTML::Config::element_file_name ($element, $is_top, $docu_name); - } - } - add_file($element->{'file'}); - $prev_nr = $doc_nr; - foreach my $place(@{$element->{'place'}}) - { - $place->{'file'} = $element->{'file'}; - $place->{'id'} = $element->{'id'} unless defined($place->{'id'}); - } - if ($element->{'nodes'}) - { - foreach my $node (@{$element->{'nodes'}}) - { - $node->{'doc_nr'} = $element->{'doc_nr'}; - $node->{'file'} = $element->{'file'}; - } - } - elsif ($element->{'node_ref'} and !$element->{'node_ref'}->{'element_added'}) - { - $element->{'node_ref'}->{'doc_nr'} = $element->{'doc_nr'} ; - $element->{'node_ref'}->{'file'} = $element->{'file'}; - } - } - } - else - { - add_file($docu_doc); - foreach my $element(@elements_list) - { - #die "$ERROR monolithic file and a node have the same file name $docu_doc\n" if ($Texi2HTML::Config::NODE_FILES and $files{$docu_doc}); - $element->{'file'} = "$docu_doc"; - $element->{'doc_nr'} = 0; - foreach my $place(@{$element->{'place'}}) - { - $place->{'file'} = "$element->{'file'}"; - $place->{'id'} = $element->{'id'} unless defined($place->{'id'}); - } - } - foreach my $node(@nodes_list) - { - $node->{'file'} = "$docu_doc"; - $node->{'doc_nr'} = 0; - } - } - # correct the id and file for the things placed in footnotes - foreach my $place(@{$footnote_element->{'place'}}) - { - $place->{'file'} = $footnote_element->{'file'}; - $place->{'id'} = $footnote_element->{'id'} unless defined($place->{'id'}); - } - foreach my $file (keys(%files)) - { - last unless ($T2H_DEBUG & $DEBUG_ELEMENTS); - print STDERR "$file: $files{$file}->{'counter'}\n"; - } - foreach my $element ((@elements_list, $footnote_element)) - { - last unless ($T2H_DEBUG & $DEBUG_ELEMENTS); - my $is_toplevel = 'not top'; - $is_toplevel = 'top' if ($element->{'toplevel'}); - print STDERR "$element "; - if ($element->{'index_page'}) - { - print STDERR "index($element->{'id'}, $is_toplevel, doc_nr $element->{'doc_nr'}($element->{'file'})): $element->{'texi'}\n"; - } - elsif ($element->{'node'}) - { - my $added = ''; - $added = 'added, ' if ($element->{'element_added'}); - print STDERR "node($element->{'id'}, toc_level $element->{'toc_level'}, $is_toplevel, ${added}doc_nr $element->{'doc_nr'}($element->{'file'})) $element->{'texi'}:\n"; - print STDERR " section_ref: $element->{'section_ref'}->{'texi'}\n" if (defined($element->{'section_ref'})); - } - elsif ($element->{'footnote'}) - { - print STDERR "footnotes($element->{'id'}, file $element->{'file'})\n"; - } - else - { - my $number = "UNNUMBERED"; - $number = $element->{'number'} if ($element->{'number'}); - print STDERR "$number ($element->{'id'}, $is_toplevel, level $element->{'level'}-$element->{'toc_level'}, doc_nr $element->{'doc_nr'}($element->{'file'})) $element->{'texi'}:\n"; - print STDERR " node_ref: $element->{'node_ref'}->{'texi'}\n" if (defined($element->{'node_ref'})); - } - - if (!$element->{'footnote'}) - { - if (!defined($files{$element->{'file'}})) - { - die "Bug: files{\$element->{'file'}} undef element $element->{'texi'}, file $element->{'file'}."; - } - print STDERR " file: $element->{'file'} $files{$element->{'file'}}, counter $files{$element->{'file'}}->{'counter'}\n"; - } - print STDERR " TOP($toplevel) " if ($element->{'top'}); - print STDERR " u: $element->{'up'}->{'texi'}\n" if (defined($element->{'up'})); - print STDERR " ch: $element->{'child'}->{'texi'}\n" if (defined($element->{'child'})); - print STDERR " fb: $element->{'fastback'}->{'texi'}\n" if (defined($element->{'fastback'})); - print STDERR " b: $element->{'back'}->{'texi'}\n" if (defined($element->{'back'})); - print STDERR " p: $element->{'prev'}->{'texi'}\n" if (defined($element->{'prev'})); - print STDERR " n: $element->{'next'}->{'texi'}\n" if (defined($element->{'next'})); - print STDERR " n_u: $element->{'nodeup'}->{'texi'}\n" if (defined($element->{'nodeup'})); - print STDERR " f: $element->{'forward'}->{'texi'}\n" if (defined($element->{'forward'})); - print STDERR " follow: $element->{'following'}->{'texi'}\n" if (defined($element->{'following'})); - print STDERR " m_p: $element->{'menu_prev'}->{'texi'}\n" if (defined($element->{'menu_prev'})); - print STDERR " m_n: $element->{'menu_next'}->{'texi'}\n" if (defined($element->{'menu_next'})); - print STDERR " m_u: $element->{'menu_up'}->{'texi'}\n" if (defined($element->{'menu_up'})); - print STDERR " m_ch: $element->{'menu_child'}->{'texi'}\n" if (defined($element->{'menu_child'})); - print STDERR " u_e: $element->{'element_up'}->{'texi'}\n" if (defined($element->{'element_up'})); - print STDERR " n_e: $element->{'element_next'}->{'texi'}\n" if (defined($element->{'element_next'})); - print STDERR " ff: $element->{'fastforward'}->{'texi'}\n" if (defined($element->{'fastforward'})); - if (defined($element->{'menu_up_hash'})) - { - print STDERR " parent nodes:\n"; - foreach my $menu_up (keys%{$element->{'menu_up_hash'}}) - { - print STDERR " $menu_up ($element->{'menu_up_hash'}->{$menu_up})\n"; - } - } - if (defined($element->{'nodes'})) - { - print STDERR " nodes: $element->{'nodes'} (@{$element->{'nodes'}})\n"; - foreach my $node (@{$element->{'nodes'}}) - { - my $beginning = " "; - $beginning = " *" if ($node->{'with_section'}); - my $file = $node->{'file'}; - $file = "file undef" if (! defined($node->{'file'})); - print STDERR "${beginning}$node->{'texi'} $file\n"; - } - } - print STDERR " places: $element->{'place'}\n"; - foreach my $place(@{$element->{'place'}}) - { - if (!$place->{'entry'} and !$place->{'float'} and !$place->{'texi'}) - { - print STDERR "BUG: unknown placed stuff ========\n"; - foreach my $key (keys(%$place)) - { - print STDERR "$key: $place->{$key}\n"; - } - print STDERR "==================================\n"; - } - elsif ($place->{'entry'}) - { - print STDERR " index($place): $place->{'entry'}\n"; - } - elsif ($place->{'anchor'}) - { - print STDERR " anchor: $place->{'texi'}\n"; - } - elsif ($place->{'float'}) - { - if (defined($place->{'texi'})) - { - print STDERR " float($place): $place->{'texi'}\n"; - } - else - { - print STDERR " float($place): NO LABEL\n"; - } - } - else - { - print STDERR " heading: $place->{'texi'}\n"; - } - } - if ($element->{'indices'}) - { - print STDERR " indices: $element->{'indices'}\n"; - foreach my $index(@{$element->{'indices'}}) - { - print STDERR " $index: "; - foreach my $page (@$index) - { - print STDERR "'$page->{'element'}->{'texi'}'($page->{'name'}): $page->{'page'} "; - } - print STDERR "\n"; - } - } - } -} - -sub add_file($) -{ - my $file = shift; - if ($files{$file}) - { - $files{$file}->{'counter'}++; - } - else - { - $files{$file} = { - #'type' => 'section', - 'counter' => 1 - }; - } -} - -# find parent element which is a top element, or a node within the top section -sub get_top($) -{ - my $element = shift; - my $up = $element; - while (!$up->{'toplevel'} and !$up->{'top'}) - { - $up = $up->{'element_up'}; - if (!defined($up)) - { - # If there is no section, it is normal not to have toplevel element, - # and it is also the case if there is a low level element before - # a top level element - print STDERR "$WARN no toplevel for $element->{'texi'} (could be normal)\n" if (@sections_list); - return undef; - } - } - return $up; -} - -sub get_node($) -{ - my $element = shift; - return undef if (!defined($element)); - return $element if ($element->{'node'}); - return $element->{'node_ref'} if ($element->{'node_ref'} and !$element->{'node_ref'}->{'element_added'}); - return $element; -} -# get the html names from the texi for all elements -sub do_names() -{ - # for nodes and anchors we haven't any state defined - # This seems right, however, as we don't want @refs or @footnotes - # or @anchors within nodes, section commands or anchors. - foreach my $node (%nodes) - { - next if ($nodes{$node}->{'index_page'}); # some nodes are index pages. - $nodes{$node}->{'text'} = substitute_line ($nodes{$node}->{'texi'}); - $nodes{$node}->{'name'} = $nodes{$node}->{'text'}; - $nodes{$node}->{'no_texi'} = &$Texi2HTML::Config::protect_text(remove_texi($nodes{$node}->{'texi'})); - $nodes{$node}->{'unformatted'} = unformatted_text (undef, $nodes{$node}->{'texi'}); - # FIXME : what to do if $nodes{$node}->{'external_node'} and - # $nodes{$node}->{'seen'} - } - foreach my $number (keys(%sections)) - { - my $section = $sections{$number}; - $section->{'name'} = substitute_line ($section->{'texi'}); - $section->{'text'} = $section->{'number'} . " " . $section->{'name'}; - $section->{'text'} =~ s/^\s*//; - $section->{'no_texi'} = &$Texi2HTML::Config::protect_text($section->{'number'} . " " .remove_texi($section->{'texi'})); - $section->{'no_texi'} =~ s/^\s*//; - $section->{'unformatted'} = &$Texi2HTML::Config::protect_text($section->{'number'}) . " " .unformatted_text(undef,$section->{'texi'}); - $section->{'unformatted'} =~ s/^\s*//; - } - my $tocnr = 1; - foreach my $element (@elements_list) - { - if (!$element->{'top'} and !$element->{'index_page'}) - { - $element->{'tocid'} = 'TOC' . $tocnr; - $tocnr++; - } - next if (defined($element->{'text'})); - if ($element->{'index_page'}) - { - my $page = $element->{'page'}; - my $sec_name = $element->{'element_ref'}->{'text'}; - $element->{'text'} = ($page->{First} ne $page->{Last} ? - "$sec_name: $page->{First} -- $page->{Last}" : - "$sec_name: $page->{First}"); - $sec_name = $element->{'element_ref'}->{'no_texi'}; - $element->{'no_texi'} = &$Texi2HTML::Config::protect_text($page->{First} ne $page->{Last} ? - "$sec_name: $page->{First} -- $page->{Last}" : - "$sec_name: $page->{First}"); - $sec_name = $element->{'element_ref'}->{'unformatted'}; - $element->{'unformatted'} = $page->{First} ne $page->{Last} ? - "$sec_name: " . &$Texi2HTML::Config::protect_text("$page->{First} -- $page->{Last}") : - "$sec_name: " . &$Texi2HTML::Config::protect_text("$page->{First}"); - } - } -} - -@{$Texi2HTML::TOC_LINES} = (); # table of contents -@{$Texi2HTML::OVERVIEW} = (); # short table of contents - - - -#+++############################################################################ -# # -# Stuff related to Index generation # -# # -#---############################################################################ - -# FIXME what to do with index entries appearing in @copying -# @documentdescription and @titlepage -sub enter_index_entry($$$$$$) -{ - my $prefix = shift; - my $line_nr = shift; - my $key = shift; - my $place = shift; - my $element = shift; - my $use_section_id = shift; - unless (exists ($index_properties->{$prefix})) - { - echo_error ("Undefined index command: ${prefix}index", $line_nr); - #warn "$ERROR Undefined index command: ${prefix}index\n"; - return 0; - } - if (!exists($element->{'tag'}) and !$element->{'footnote'}) - { - echo_warn ("Index entry before document: \@${prefix}index $key", $line_nr); - } - $key =~ s/\s+$//; - $key =~ s/^\s*//; - my $entry = $key; - # The $key is mostly usefull for alphabetical sorting - $key = remove_texi($key); - return if ($key =~ /^\s*$/); - while (exists $index->{$prefix}->{$key}) - { - $key .= ' '; - } - my $id = ''; - unless ($use_section_id) - { - $id = 'IDX' . ++$idx_num; - } - $index->{$prefix}->{$key}->{'entry'} = $entry; - $index->{$prefix}->{$key}->{'element'} = $element; - $index->{$prefix}->{$key}->{'label'} = $id; - $index->{$prefix}->{$key}->{'prefix'} = $prefix; - push @$place, $index->{$prefix}->{$key}; - print STDERR "# enter ${prefix}index '$key' with id $id ($index->{$prefix}->{$key})\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - push @index_labels, $index->{$prefix}->{$key}; - return $index->{$prefix}->{$key}; -} - -# returns prefix of @?index command associated with 2 letters prefix name -# for example returns 'c' for 'cp' -sub index_name2prefix -{ - my $name = shift; - my $prefix; - - for $prefix (keys %$index_properties) - { - return $prefix if ($index_properties->{$prefix}->{'name'} eq $name); - } - return undef; -} - -# get all the entries (for all the prefixes) in the $normal and $code -# references, formatted with @code{code } if it is a $code entry. -sub get_index_entries($$) -{ - my $normal = shift; - my $code = shift; - my $entries = {}; - foreach my $prefix (keys %$normal) - { - for my $key (keys %{$index->{$prefix}}) - { - $entries->{$key} = $index->{$prefix}->{$key}; - } - } - - if (defined($code)) - { - foreach my $prefix (keys %$code) - { - unless (exists $normal->{$prefix}) - { - foreach my $key (keys %{$index->{$prefix}}) - { - $entries->{$key} = $index->{$prefix}->{$key}; - # use @code for code style index entry - $entries->{$key}->{'entry'} = "\@code{$entries->{$key}->{entry}}"; - } - } - } - } - return $entries; -} - -# sort according to cmp if both $a and $b are alphabetical or non alphabetical, -# otherwise the alphabetical is ranked first -sub by_alpha -{ - if ($a =~ /^[A-Za-z]/) - { - if ($b =~ /^[A-Za-z]/) - { - return lc($a) cmp lc($b); - } - else - { - return 1; - } - } - elsif ($b =~ /^[A-Za-z]/) - { - return -1; - } - else - { - return lc($a) cmp lc($b); - } -} - -# returns an array of index entries pages splitted by letters -# each page has the following members: -# {First} first letter on that page -# {Last} last letter on that page -# {Letters} ref on an array with all the letters for that page -# {EntriesByLetter} ref on a hash. Each key is a letter, with value -# a ref on arrays of index entries begining with this letter -sub get_index_pages($) -{ - my $entries = shift; - my (@Letters); - my ($EntriesByLetter, $Pages, $page) = ({}, [], {}); - my @keys = sort by_alpha keys %$entries; - - # each index entry is placed according to its first letter in - # EntriesByLetter - for my $key (@keys) - { - push @{$EntriesByLetter->{uc(substr($key,0, 1))}} , $entries->{$key}; - } - @Letters = sort by_alpha keys %$EntriesByLetter; - $Texi2HTML::Config::SPLIT_INDEX = 0 unless $Texi2HTML::Config::SPLIT; - - if ($Texi2HTML::Config::SPLIT_INDEX and $Texi2HTML::Config::SPLIT_INDEX =~ /^\d+$/) - { - my $i = 0; - my ($prev_letter); - for my $letter (@Letters) - { - if ($i > $Texi2HTML::Config::SPLIT_INDEX) - { - $page->{Last} = $prev_letter; - push @$Pages, $page; - $i=0; - } - if ($i == 0) - { - $page = {}; - $page->{Letters} = []; - $page->{EntriesByLetter} = {}; - $page->{First} = $letter; - } - push @{$page->{Letters}}, $letter; - $page->{EntriesByLetter}->{$letter} = [@{$EntriesByLetter->{$letter}}]; - $i += scalar(@{$EntriesByLetter->{$letter}}); - $prev_letter = $letter; - } - $page->{Last} = $Letters[$#Letters]; - push @$Pages, $page; - } - else - { - warn "$WARN Bad Texi2HTML::Config::SPLIT_INDEX: $Texi2HTML::Config::SPLIT_INDEX\n" if ($Texi2HTML::Config::SPLIT_INDEX); - $page->{First} = $Letters[0]; - $page->{Last} = $Letters[$#Letters]; - $page->{Letters} = \@Letters; - $page->{EntriesByLetter} = $EntriesByLetter; - push @$Pages, $page; - return $Pages; - } - return $Pages; -} - -sub get_index($;$) -{ - my $name = shift; - my $line_nr = shift; - return (@{$indices{$name}}) if ($indices{$name}); - my $prefix = index_name2prefix($name); - unless ($prefix) - { - echo_error ("Bad index name: $name", $line_nr); - #warn "$ERROR Bad index name: $name\n"; - return; - } - if ($index_properties->{$prefix}->{code}) - { - $index_properties->{$prefix}->{from_code}->{$prefix} = 1; - } - else - { - $index_properties->{$prefix}->{from}->{$prefix}= 1; - } - - my $Entries = get_index_entries($index_properties->{$prefix}->{from}, - $index_properties->{$prefix}->{from_code}); - return unless %$Entries; - my $Pages = get_index_pages($Entries); - $indices{$name} = [ $Pages, $Entries ]; - return ($Pages, $Entries); -} - -my @foot_lines = (); # footnotes -my $copying_comment = ''; # comment constructed from text between - # @copying and @end copying with licence -my $from_encoding; # texinfo file encoding -my $to_encoding; # out file encoding -my %acronyms_like = (); # acronyms or similar commands associated texts - # the key are the commands, the values are - # hash references associating shorthands to - # texts. - -sub initialise_state($) -{ - my $state = shift; - $state->{'preformatted'} = 0 unless exists($state->{'preformatted'}); - $state->{'code_style'} = 0 unless exists($state->{'code_style'}); - $state->{'keep_texi'} = 0 unless exists($state->{'keep_texi'}); - $state->{'keep_nr'} = 0 unless exists($state->{'keep_nr'}); - $state->{'detailmenu'} = 0 unless exists($state->{'detailmenu'}); # number of opened detailed menus - $state->{'format_stack'} = [ {'format' => "noformat"} ] unless exists($state->{'format_stack'}); - $state->{'paragraph_style'} = [ '' ] unless exists($state->{'paragraph_style'}); - $state->{'preformatted_stack'} = [ '' ] unless exists($state->{'preformatted_stack'}); - $state->{'menu'} = 0 unless exists($state->{'menu'}); - $state->{'style_stack'} = [] unless exists($state->{'style_stack'}); - $state->{'quotation_stack'} = [] unless exists($state->{'quotation_stack'}); - # if there is no $state->{'element'} the first element is used - $state->{'element'} = $elements_list[0] unless (exists($state->{'element'}) and !$state->{'element'}->{'before_anything'}); -} - -sub pass_text() -{ - my %state; - initialise_state (\%state); - my @stack; - my $text; - my $doc_nr; - my $in_doc = 0; - my $element; - my @text =(); - my @section_lines = (); - my @head_lines = (); - my $one_section = 1 if (@elements_list == 1); - - if (@elements_list == 0) - { - warn "$WARN empty document\n"; - exit (0); - } - - # We set titlefont only if the titlefont appeared in the top element - if (defined($element_top->{'titlefont'})) - { - $element_top->{'has_heading'} = 1; - $value{'_titlefont'} = $element_top->{'titlefont'}; - } - - # prepare %Texi2HTML::THISDOC -# $Texi2HTML::THISDOC{'settitle_texi'} = $value{'_settitle'}; - $Texi2HTML::THISDOC{'fulltitle_texi'} = ''; - $Texi2HTML::THISDOC{'title_texi'} = ''; - foreach my $possible_fulltitle (('_title', '_settitle', '_shorttitlepage', '_titlefont')) - { - if ($value{$possible_fulltitle} ne '') - { - $Texi2HTML::THISDOC{'fulltitle_texi'} = $value{$possible_fulltitle}; - last; - } - } - foreach my $possible_title_texi ($value{'_settitle'}, $Texi2HTML::THISDOC{'fulltitle_texi'}) - { - if ($possible_title_texi ne '') - { - $Texi2HTML::THISDOC{'title_texi'} = $possible_title_texi; - last; - } - } -# $Texi2HTML::THISDOC{'fulltitle_texi'} = $value{'_title'} || $value{'_settitle'} || $value{'_shorttitlepage'} || $value{'_titlefont'}; -# $Texi2HTML::THISDOC{'title_texi'} = $value{'_title'} || $value{'_settitle'} || $value{'_shorttitlepage'} || $value{'_titlefont'}; - foreach my $texi_cmd (('shorttitlepage', 'settitle', 'author', - 'titlefont', 'subtitle', 'shorttitle')) - { - $Texi2HTML::THISDOC{$texi_cmd . '_texi'} = $value{'_' . $texi_cmd}; - } - foreach my $doc_thing (('shorttitlepage', 'settitle', 'author', - 'titlefont', 'subtitle', 'shorttitle', 'fulltitle', 'title')) - { - my $thing_texi = $Texi2HTML::THISDOC{$doc_thing . '_texi'}; - $Texi2HTML::THISDOC{$doc_thing} = substitute_line($thing_texi); - $Texi2HTML::THISDOC{$doc_thing . '_no_texi'} = - &$Texi2HTML::Config::protect_text(remove_texi($thing_texi)); - $Texi2HTML::THISDOC{$doc_thing . '_unformatted'} = - unformatted_text(undef, $thing_texi); - } -# $Texi2HTML::THISDOC{'shorttitlepage_texi'} = $value{'_shorttitlepage'}; -# $Texi2HTML::THISDOC{'fulltitle'} = substitute_line($value{'_title'}) || substitute_line($value{'_settitle'}) || substitute_line($value{'_shorttitlepage'}) || substitute_line($value{'_titlefont'}); -# $Texi2HTML::THISDOC{'title'} = substitute_line($value{'_settitle'}) || $Texi2HTML::THISDOC{'fulltitle'}; -# $Texi2HTML::THISDOC{'shorttitle'} = substitute_line($value{'_shorttitle'}); - - # find Top name - my $element_top_text = ''; - my $top_no_texi = ''; - my $top_unformatted = ''; - my $top_name; - if ($element_top and $element_top->{'text'} and (!$node_top or ($element_top ne $node_top))) - { - $element_top_text = $element_top->{'text'}; - $top_no_texi = $element_top->{'no_texi'}; - $top_unformatted = $element_top->{'unformatted'}; - } - foreach my $possible_top_name ($Texi2HTML::Config::TOP_HEADING, - $element_top_text, $Texi2HTML::THISDOC{'title'}, - $Texi2HTML::THISDOC{'shorttitle'}, &$I('Top')) - { - if (defined($possible_top_name) and $possible_top_name ne '') - { - $top_name = $possible_top_name; - last; - } - } - foreach my $possible_top_no_texi ($Texi2HTML::Config::TOP_HEADING, - $top_no_texi, $Texi2HTML::THISDOC{'title_no_texi'}, - $Texi2HTML::THISDOC{'shorttitle_no_texi'}, - &$I('Top',{},{'remove_texi' => 1, 'no_protection' => 1})) - { - if (defined($possible_top_no_texi) and $possible_top_no_texi ne '') - { - $top_no_texi = $possible_top_no_texi; - last; - } - } - - foreach my $possible_top_unformatted ($top_unformatted, - $Texi2HTML::THISDOC{'title_unformatted'}, - $Texi2HTML::THISDOC{'shorttitle_unformatted'}, - &$I('Top',{}, {'unformatted' => 1})) - { - if (defined($possible_top_unformatted) and $possible_top_unformatted ne '') - { - $top_unformatted = $possible_top_unformatted; - last; - } - } - - -# my $top_name = $Texi2HTML::Config::TOP_HEADING || $element_top_text || $Texi2HTML::THISDOC{'title'} || $Texi2HTML::THISDOC{'shorttitle'} || &$I('Top'); - - if ($Texi2HTML::THISDOC{'fulltitle_texi'} eq '') - { - $Texi2HTML::THISDOC{'fulltitle_texi'} = &$I('Untitled Document',{}, - {'keep_texi' => 1}); - } - $Texi2HTML::THISDOC{'title_texi'} = $Texi2HTML::THISDOC{'settitle_texi'}; - $Texi2HTML::THISDOC{'title_texi'} = $Texi2HTML::THISDOC{'fulltitle_texi'} - if ($Texi2HTML::THISDOC{'title_texi'} eq ''); - - foreach my $doc_thing (('fulltitle', 'title')) - { - my $thing_texi = $Texi2HTML::THISDOC{$doc_thing . '_texi'}; - $Texi2HTML::THISDOC{$doc_thing} = substitute_line($thing_texi); - $Texi2HTML::THISDOC{$doc_thing . '_no_texi'} = - &$Texi2HTML::Config::protect_text(remove_texi($thing_texi)); - $Texi2HTML::THISDOC{$doc_thing . '_unformatted'} = - unformatted_text(undef, $thing_texi); - } -# $Texi2HTML::THISDOC{'fulltitle'} = $Texi2HTML::THISDOC{'fulltitle'} || &$I('Untitled Document') ; -# $Texi2HTML::THISDOC{'title'} = $Texi2HTML::THISDOC{'settitle'} || $Texi2HTML::THISDOC{'fulltitle'}; -# $Texi2HTML::THISDOC{'author'} = substitute_line($value{'_author'}); -# $Texi2HTML::THISDOC{'titlefont'} = substitute_line($value{'_titlefont'}); -# $Texi2HTML::THISDOC{'subtitle'} = substitute_line($value{'_subtitle'}); - -# $Texi2HTML::THISDOC{'title_unformatted'} = unformatted_text(undef, $Texi2HTML::THISDOC{'title_texi'}); -# $Texi2HTML::THISDOC{'shorttitle_unformatted'} = unformatted_text(undef, $value{'_shorttitle'}); -# $Texi2HTML::THISDOC{'title_no_texi'} = &$Texi2HTML::Config::protect_text(remove_texi($value{'_title'})) || &$Texi2HTML::Config::protect_text(remove_texi($value{'_settitle'})) || &$Texi2HTML::Config::protect_text(remove_texi($value{'_shorttitlepage'})) || &$Texi2HTML::Config::protect_text(remove_texi($value{'_titlefont'})); -# $Texi2HTML::THISDOC{'shorttitle_no_texi'} = &$Texi2HTML::Config::protect_text(remove_texi($value{'_shorttitle'})); - -# my $top_no_texi = ''; -# my $top_unformatted = ''; -# if ($element_top and $element_top->{'no_texi'} and (!$node_top or ($element_top ne $node_top))) -# { -# $top_no_texi = $element_top->{'no_texi'}; -# $top_unformatted = $element_top->{'unformatted'}; -# } - -# $top_no_texi = $Texi2HTML::Config::TOP_HEADING || $top_no_texi || $Texi2HTML::THISDOC{'title_no_texi'} || $Texi2HTML::THISDOC{'shorttitle_no_texi'} || &$I('Top',{}, {'remove_texi' => 1, 'no_protection' => 1}); -# $top_unformatted = $top_unformatted || $Texi2HTML::THISDOC{'title_unformatted'} || $Texi2HTML::THISDOC{'shorttitle_unformatted'} || &$I('Top',{}, {'unformatted' => 1}); -# $Texi2HTML::THISDOC{'title_unformatted'} = $Texi2HTML::THISDOC{'title_unformatted'} || &$I('Untitled Document',{}, {'unformatted' => 1}); -# $Texi2HTML::THISDOC{'title_no_texi'} = $Texi2HTML::THISDOC{'title_no_texi'} || &$I('Untitled Document',{}, {'remove_texi' => 1, 'no_protection' => 1}); - - for my $key (keys %Texi2HTML::THISDOC) - { - next if (ref($Texi2HTML::THISDOC{$key})); -print STDERR "!!$key\n" if (!defined($Texi2HTML::THISDOC{$key})); - $Texi2HTML::THISDOC{$key} =~ s/\s*$//; - } - $Texi2HTML::THISDOC{'program'} = $THISPROG; - $Texi2HTML::THISDOC{'program_homepage'} = $T2H_HOMEPAGE; - $Texi2HTML::THISDOC{'program_authors'} = $T2H_AUTHORS; - $Texi2HTML::THISDOC{'user'} = $T2H_USER; -# $Texi2HTML::THISDOC{'documentdescription'} = $documentdescription; - $Texi2HTML::THISDOC{'copying'} = $copying_comment; - $Texi2HTML::THISDOC{'toc_file'} = ''; - $Texi2HTML::THISDOC{'toc_file'} = $docu_toc if ($Texi2HTML::Config::SPLIT); - $Texi2HTML::THISDOC{'file_base_name'} = $docu_name; - $Texi2HTML::THISDOC{'destination_directory'} = $docu_rdir; - $Texi2HTML::THISDOC{'authors'} = [] if (!defined($Texi2HTML::THISDOC{'authors'})); - $Texi2HTML::THISDOC{'subtitles'} = [] if (!defined($Texi2HTML::THISDOC{'subtitles'})); - $Texi2HTML::THISDOC{'titles'} = [] if (!defined($Texi2HTML::THISDOC{'titles'})); - foreach my $element (('authors', 'subtitles', 'titles')) - { - my $i; - for ($i = 0; $i < $#{$Texi2HTML::THISDOC{$element}} + 1; $i++) - { - chomp ($Texi2HTML::THISDOC{$element}->[$i]); - $Texi2HTML::THISDOC{$element}->[$i] = substitute_line($Texi2HTML::THISDOC{$element}->[$i]); - #print STDERR "$element:$i: $Texi2HTML::THISDOC{$element}->[$i]\n"; - } - } - # prepare TOC, OVERVIEW - if ($Texi2HTML::Config::SPLIT) - { - $Texi2HTML::HREF{'Contents'} = $docu_toc.'#SEC_Contents' if @{$Texi2HTML::TOC_LINES}; - $Texi2HTML::HREF{'Overview'} = $docu_stoc.'#SEC_Overview' if @{$Texi2HTML::OVERVIEW}; - $Texi2HTML::HREF{'Footnotes'} = $docu_foot. '#SEC_Foot'; - $Texi2HTML::HREF{'About'} = $docu_about . '#SEC_About' unless $one_section; - } - else - { - $Texi2HTML::HREF{'Contents'} = '#SEC_Contents' if @{$Texi2HTML::TOC_LINES}; - $Texi2HTML::HREF{'Overview'} = '#SEC_Overview' if @{$Texi2HTML::OVERVIEW}; - $Texi2HTML::HREF{'Footnotes'} = '#SEC_Foot'; - $Texi2HTML::HREF{'About'} = '#SEC_About' unless $one_section; - } - - %Texi2HTML::NAME = - ( - 'First', $element_first->{'text'}, - 'Last', $element_last->{'text'}, - 'About', &$I('About This Document'), - 'Contents', &$I('Table of Contents'), - 'Overview', &$I('Short Table of Contents'), - 'Top', $top_name, - 'Footnotes', &$I('Footnotes'), - ); - $Texi2HTML::NAME{'Index'} = $element_chapter_index->{'text'} if (defined($element_chapter_index)); - $Texi2HTML::NAME{'Index'} = $Texi2HTML::Config::INDEX_CHAPTER if ($Texi2HTML::Config::INDEX_CHAPTER ne ''); - - %Texi2HTML::NO_TEXI = - ( - 'First', $element_first->{'no_texi'}, - 'Last', $element_last->{'no_texi'}, -#FIXME this is not really NO_TEXI as there may be some formatting expanded -# in &$I, using substitute_line - 'About', &$I('About This Document', {}, {'remove_texi' => 1, 'no_protection' => 1} ), - 'Contents', &$I('Table of Contents', {}, {'remove_texi' => 1, 'no_protection' => 1} ), - 'Overview', &$I('Short Table of Contents', {}, {'remove_texi' => 1, 'no_protection' => 1} ), - 'Top', $top_no_texi, - 'Footnotes', &$I('Footnotes', {}, {'remove_texi' => 1, 'no_protection' => 1} ), - ); - $Texi2HTML::NO_TEXI{'Index'} = $element_chapter_index->{'no_texi'} if (defined($element_chapter_index)); - %Texi2HTML::UNFORMATTED = - ( - 'First', $element_first->{'unformatted'}, - 'Last', $element_last->{'unformatted'}, -#FIXME this is not really UNFORMATTED as there may be some formatting expanded -# in &$I, using substitute_line - 'About', &$I('About This Document', {}, {'unformatted' => 1}), - 'Contents', &$I('Table of Contents',{}, {'unformatted' => 1}), - 'Overview', &$I('Short Table of Contents', {}, {'unformatted' => 1}), - 'Top', $top_unformatted, - 'Footnotes', &$I('Footnotes', {},{'unformatted' => 1}), - ); - $Texi2HTML::UNFORMATTED{'Index'} = $element_chapter_index->{'unformatted'} if (defined($element_chapter_index)); - $Texi2HTML::TITLEPAGE = ''; - $Texi2HTML::TITLEPAGE = substitute_text({}, @{$region_lines{'titlepage'}}) - if (@{$region_lines{'titlepage'}}); - &$Texi2HTML::Config::titlepage(); - - $to_encoding = &$Texi2HTML::Config::init_out(); - - ############################################################################ - # print frame and frame toc file - # - if ( $Texi2HTML::Config::FRAMES ) - { - #open(FILE, "> $docu_frame_file") - # || die "$ERROR: Can't open $docu_frame_file for writing: $!\n"; - my $FH = open_out($docu_frame_file); - print STDERR "# Creating frame in $docu_frame_file ...\n" if $T2H_VERBOSE; - &$Texi2HTML::Config::print_frame($FH, $docu_toc_frame_file, $docu_top_file); - close_out($FH, $docu_frame_file); - - #open(FILE, "> $docu_toc_frame_file") - # || die "$ERROR: Can't open $docu_toc_frame_file for writing: $!\n"; - $FH = open_out($docu_toc_frame_file); - print STDERR "# Creating toc frame in $docu_frame_file ...\n" if $T2H_VERBOSE; - #&$Texi2HTML::Config::print_toc_frame(\*FILE, $Texi2HTML::OVERVIEW); - &$Texi2HTML::Config::print_toc_frame($FH, $Texi2HTML::OVERVIEW); - #close(FILE); - close_out($FH, $docu_toc_frame_file); - } - - ############################################################################ - # - # - - my $FH; - my $index_pages; - my $index_pages_nr; - my $index_nr = 0; - my $line_nr; - my $first_section = 0; # 1 if it is the first section of a page - while (@doc_lines) - { - unless ($index_pages) - { # not in a index split over sections - $_ = shift @doc_lines; - my $chomped_line = $_; - if (!chomp($chomped_line) and @doc_lines) - { # if the line has no end of line it is concatenated with the next - $doc_lines[0] = $_ . $doc_lines[0]; - next; - } - $line_nr = shift (@doc_numbers); - #print STDERR "$line_nr->{'file_name'}($line_nr->{'macro'},$line_nr->{'line_nr'}) $_" if ($line_nr); - } - #print STDERR "PASS_TEXT: $_"; - #dump_stack(\$text, \@stack, \%state); - if (!$state{'raw'} and !$state{'verb'}) - { - my $tag = ''; - $tag = $1 if (/^\@(\w+)/ and !$index_pages); - - if (($tag eq 'node') or defined($sec2level{$tag}) or $index_pages) - { - if (@stack or (defined($text) and $text ne '')) - {# in pass text node and section shouldn't appear in formats - #print STDERR "close_stack before \@$tag\n"; - #print STDERR "text!$text%" if (! @stack); - close_stack(\$text, \@stack, \%state, $line_nr); - push @section_lines, $text; - $text = ''; - } - $sec_num++ if ($sec2level{$tag}); - my $new_element; - my $current_element; - if ($tag =~ /heading/) - {# handle headings, they are not in element lists - $current_element = $sections{$sec_num}; - #print STDERR "HEADING $_"; - if (! $element) - { - $new_element = shift @elements_list; - $element->{'has_heading'} = 1 if ($new_element->{'top'}); - } - else - { - if ($element->{'top'}) - { - $element->{'has_heading'} = 1; - } - push (@section_lines, &$Texi2HTML::Config::anchor($current_element->{'id'}) . "\n"); - push @section_lines, &$Texi2HTML::Config::heading($current_element); - next; - } - } - elsif (!$index_pages) - {# handle node and structuring elements - $current_element = shift (@all_elements); - #begin debug section - if ($current_element->{'node'}) - { - print STDERR 'NODE ' . "$current_element->{'texi'}($current_element->{'file'})" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - print STDERR "($current_element->{'section_ref'}->{'texi'})" if ($current_element->{'section_ref'} and ($T2H_DEBUG & $DEBUG_ELEMENTS)); - } - else - { - print STDERR 'SECTION ' . $current_element->{'texi'} if ($T2H_DEBUG & $DEBUG_ELEMENTS); - } - print STDERR ": $_" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - #end debug section - - # The element begins a new section if there is no previous - # or it is an element and not the current one or the - # associated section (in case of node) is not the current one - if (!$element - or ($current_element->{'element'} and ($current_element ne $element)) - or ($current_element->{'section_ref'} and ($current_element->{'section_ref'} ne $element))) - { - $new_element = shift @elements_list; - } - # begin debugging section - my $section_element = $new_element; - $section_element = $element unless ($section_element); - if (!$current_element->{'node'} and !$current_element->{'index_page'} and ($section_element ne $current_element)) - { - print STDERR "NODE: $element->{'texi'}\n" if ($element->{'node'}); - warn "elements_list and all_elements not in sync (elements $section_element->{'texi'}, all $current_element->{'texi'}): $_"; - } - # end debugging section - } - else - { # this is a new index section - $new_element = $index_pages->[$index_pages_nr]->{'element'}; - $current_element = $index_pages->[$index_pages_nr]->{'element'}; - print STDERR "New index page '$new_element->{'texi'}' nr: $index_pages_nr\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); - my $list_element = shift @elements_list; - die "element in index_pages $new_element->{'texi'} and in list $list_element->{'texi'} differs\n" unless ($list_element eq $new_element); - } - if ($new_element) - { - $index_nr = 0; - my $old = 'NO_OLD'; - $old = $element->{'texi'} if (defined($element)); - print STDERR "NEW: $new_element->{'texi'}, OLD: $old\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS); -# FIXME this should be done differently now that there could be elements -# associated with the same file - if ($element and ($new_element->{'doc_nr'} != $element->{'doc_nr'}) and @foot_lines and !$Texi2HTML::Config::SEPARATED_FOOTNOTES) - { # note that this can only happen if $Texi2HTML::Config::SPLIT - &$Texi2HTML::Config::foot_section (\@foot_lines); - push @section_lines, @foot_lines; - @foot_lines = (); - $relative_foot_num = 0; - } - # print the element that just finished - $Texi2HTML::THIS_SECTION = \@section_lines; - $Texi2HTML::THIS_HEADER = \@head_lines; - if ($element) - { - #$FH = finish_element($FH, $element, $new_element, $first_section); - finish_element($FH, $element, $new_element, $first_section); - $first_section = 0; - @section_lines = (); - @head_lines = (); - } - else - { - print STDERR "# Writing elements:" if ($T2H_VERBOSE); - if ($Texi2HTML::Config::IGNORE_PREAMBLE_TEXT) - { - @section_lines = (); - @head_lines = (); - } - # remove empty line at the beginning of @section_lines - shift @section_lines while (@section_lines and ($section_lines[0] =~ /^\s*$/)); - } - # begin new element - my $previous_file; - $previous_file = $element->{'file'} if (defined($element)); - $element = $new_element; - $state{'element'} = $element; - $Texi2HTML::THIS_ELEMENT = $element; - #print STDERR "Doing hrefs for $element->{'texi'} First "; - $Texi2HTML::HREF{'First'} = href($element_first, $element->{'file'}); - #print STDERR "Last "; - $Texi2HTML::HREF{'Last'} = href($element_last, $element->{'file'}); - #print STDERR "Index "; - $Texi2HTML::HREF{'Index'} = href($element_chapter_index, $element->{'file'}) if (defined($element_chapter_index)); - #print STDERR "Top "; - $Texi2HTML::HREF{'Top'} = href($element_top, $element->{'file'}); - foreach my $direction (('Up', 'Forward', 'Back', 'Next', - 'Prev', 'FastForward', 'FastBack', 'This', 'NodeUp', - 'NodePrev', 'NodeNext', 'Following' )) - { - my $elem = $element->{$direction}; - $Texi2HTML::NODE{$direction} = undef; - $Texi2HTML::HREF{$direction} = undef; - next unless (defined($elem)); - #print STDERR "$direction "; - if ($elem->{'node'} or $elem->{'external_node'} or $elem->{'index_page'} or !$elem->{'seen'}) - { - $Texi2HTML::NODE{$direction} = $elem->{'text'}; - } - elsif ($elem->{'node_ref'}) - { - $Texi2HTML::NODE{$direction} = $elem->{'node_ref'}->{'text'}; - } - if (!$elem->{'seen'}) - { - $Texi2HTML::HREF{$direction} = do_external_href($elem->{'texi'}); - } - else - { - $Texi2HTML::HREF{$direction} = href($elem, $element->{'file'}); - } - $Texi2HTML::NAME{$direction} = $elem->{'text'}; - $Texi2HTML::NO_TEXI{$direction} = $elem->{'no_texi'}; - $Texi2HTML::UNFORMATTED{$direction} = $elem->{'unformatted'}; - #print STDERR "$direction ($element->{'texi'}): \n NO_TEXI: $Texi2HTML::NO_TEXI{$direction}\n NAME $Texi2HTML::NAME{$direction}\n NODE $Texi2HTML::NODE{$direction}\n HREF $Texi2HTML::HREF{$direction}\n\n"; - } - #print STDERR "\nDone hrefs for $element->{'texi'}\n"; - $files{$element->{'file'}}->{'counter'}--; - #if (! defined($FH)) - if (!defined($previous_file) or ($element->{'file'} ne $previous_file)) - { - my $file = $element->{'file'}; - print STDERR "\n" if ($T2H_VERBOSE and !$T2H_DEBUG); - print STDERR "# Writing to $docu_rdir$file " if $T2H_VERBOSE; - my $do_page_head = 0; - if ($files{$file}->{'filehandle'}) - { - $FH = $files{$file}->{'filehandle'}; - } - else - { - $FH = open_out("$docu_rdir$file"); - $files{$file}->{'filehandle'} = $FH; - $do_page_head = 1; - } - if ($element->{'top'}) - { - &$Texi2HTML::Config::print_Top_header($FH, $do_page_head); - } - else - { - &$Texi2HTML::Config::print_page_head($FH) if ($do_page_head); - &$Texi2HTML::Config::print_chapter_header($FH) if $Texi2HTML::Config::SPLIT eq 'chapter'; - &$Texi2HTML::Config::print_section_header($FH) if $Texi2HTML::Config::SPLIT eq 'section'; - } - $first_section = 1; - } - print STDERR "." if ($T2H_VERBOSE); - print STDERR "\n" if ($T2H_DEBUG); - } - my $label = &$Texi2HTML::Config::anchor($current_element->{'id'}) . "\n"; - if (@section_lines) - { - push (@section_lines, $label); - } - else - { - push @head_lines, $label; - } - if ($index_pages) - { - push @section_lines, &$Texi2HTML::Config::heading($element); - #print STDERR "Do index page $index_pages_nr\n"; - my $page = do_index_page($index_pages, $index_pages_nr); - push @section_lines, $page; - if (defined ($index_pages->[$index_pages_nr + 1])) - { - $index_pages_nr++; - } - else - { - $index_pages = undef; - } - next; - } - push @section_lines, &$Texi2HTML::Config::heading($current_element) if ($current_element->{'element'} and !$current_element->{'top'}); - next; - } - elsif ($tag eq 'printindex') - { - s/\s+(\w+)\s*//; - my $name = $1; - close_paragraph(\$text, \@stack, \%state); - next if (!index_name2prefix($name) or $empty_indices{$name}); - $printed_indices{$name} = 1; - print STDERR "print index $name($index_nr) in `$element->{'texi'}', element->{'indices'}: $element->{'indices'},\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS or $T2H_DEBUG & $DEBUG_INDEX); - print STDERR "element->{'indices'}->[index_nr]: $element->{'indices'}->[$index_nr] (@{$element->{'indices'}->[$index_nr]})\n" if ($T2H_DEBUG & $DEBUG_ELEMENTS or $T2H_DEBUG & $DEBUG_INDEX); - $index_pages = $element->{'indices'}->[$index_nr] if (@{$element->{'indices'}->[$index_nr]} > 1); - $index_pages_nr = 0; - add_prev(\$text, \@stack, do_index_page($element->{'indices'}->[$index_nr], 0)); - $index_pages_nr++; - $index_nr++; - begin_paragraph (\@stack, \%state) if ($state{'preformatted'}); - next if (@stack); - push @section_lines, $text; - $text = ''; - next; - } - elsif ($tag eq 'contents') - { - next; - } - } - scan_line($_, \$text, \@stack, \%state, $line_nr); - #print STDERR "after scan_line: $_"; - #dump_stack(\$text, \@stack, \%state); - next if (@stack); - if ($text ne '' ) - { - push @section_lines, $text; - $text = ''; - } - } - if (@stack) - {# close stack at the end of pass text - close_stack(\$text, \@stack, \%state, $line_nr); - } - if (defined($text)) - { - push @section_lines, $text; - } - print STDERR "\n" if ($T2H_VERBOSE); - $Texi2HTML::THIS_SECTION = \@section_lines; - # if no sections, then simply print document as is - if ($one_section) - { - if (@foot_lines) - { - &$Texi2HTML::Config::foot_section (\@foot_lines); - push @section_lines, @foot_lines; - } - $Texi2HTML::THIS_HEADER = \@head_lines; - if ($element->{'top'}) - { - print STDERR "Bug: `$element->{'texi'}' level undef\n" if (!$element->{'node'} and !defined($element->{'level'})); - $element->{'level'} = 1 if (!defined($element->{'level'})); - $element->{'node'} = 0; # otherwise Texi2HTML::Config::heading may uses the node level - $element->{'text'} = $Texi2HTML::NAME{'Top'}; - print STDERR "[Top]" if ($T2H_VERBOSE); - unless ($element->{'has_heading'}) - { - unshift @section_lines, &$Texi2HTML::Config::heading($element); - } - } - print STDERR "# Write the section $element->{'texi'}\n" if ($T2H_VERBOSE); - &$Texi2HTML::Config::one_section($FH); - close_out($FH); - return; - } - - finish_element ($FH, $element, undef, $first_section); - - ############################################################################ - # Print ToC, Overview, Footnotes - # - for my $direction (('Prev', 'Next', 'Back', 'Forward', 'Up', 'NodeUp', - 'NodePrev', 'NodeNext', 'Following', 'This')) - { - delete $Texi2HTML::HREF{$direction}; - # it is better to undef in case the references to these hash entries - # are used, as if deleted, the - # references are still refering to the old, undeleted element - # (we could do both) - $Texi2HTML::NAME{$direction} = undef; - $Texi2HTML::NO_TEXI{$direction} = undef; - $Texi2HTML::UNFORMATTED{$direction} = undef; - $Texi2HTML::NODE{$direction} = undef; - - $Texi2HTML::THIS_ELEMENT = undef; - } - if (@foot_lines) - { - print STDERR "# writing Footnotes in $docu_foot_file\n" if $T2H_VERBOSE; - #open (FILE, "> $docu_foot_file") || die "$ERROR: Can't open $docu_foot_file for writing: $!\n" - $FH = open_out ($docu_foot_file) - if $Texi2HTML::Config::SPLIT; - $Texi2HTML::HREF{'This'} = $Texi2HTML::HREF{'Footnotes'}; - $Texi2HTML::HREF{'Footnotes'} = '#' . $footnote_element->{'id'}; - $Texi2HTML::NAME{'This'} = $Texi2HTML::NAME{'Footnotes'}; - $Texi2HTML::NO_TEXI{'This'} = $Texi2HTML::NO_TEXI{'Footnotes'}; - $Texi2HTML::UNFORMATTED{'This'} = $Texi2HTML::UNFORMATTED{'Footnotes'}; - $Texi2HTML::THIS_SECTION = \@foot_lines; - $Texi2HTML::THIS_HEADER = [ &$Texi2HTML::Config::anchor($footnote_element->{'id'}) . "\n" ]; - #&$Texi2HTML::Config::print_Footnotes(\*FILE); - &$Texi2HTML::Config::print_Footnotes($FH); - #close(FILE) if $Texi2HTML::Config::SPLIT; - close_out($FH, $docu_foot_file) - #|| die "$ERROR: Error occurred when closing $docu_foot_file: $!\n" - if ($Texi2HTML::Config::SPLIT); - $Texi2HTML::HREF{'Footnotes'} = $Texi2HTML::HREF{'This'}; - } - - if (@{$Texi2HTML::TOC_LINES}) - { - print STDERR "# writing Toc in $docu_toc_file\n" if $T2H_VERBOSE; - #open (FILE, "> $docu_toc_file") || die "$ERROR: Can't open $docu_toc_file for writing: $!\n" - $FH = open_out ($docu_toc_file) - if $Texi2HTML::Config::SPLIT; - $Texi2HTML::HREF{'This'} = $Texi2HTML::HREF{'Contents'}; - $Texi2HTML::HREF{'Contents'} = "#SEC_Contents"; - $Texi2HTML::NAME{'This'} = $Texi2HTML::NAME{'Contents'}; - $Texi2HTML::NO_TEXI{'This'} = $Texi2HTML::NO_TEXI{'Contents'}; - $Texi2HTML::UNFORMATTED{'This'} = $Texi2HTML::UNFORMATTED{'Contents'}; - $Texi2HTML::THIS_SECTION = $Texi2HTML::TOC_LINES; - $Texi2HTML::THIS_HEADER = [ &$Texi2HTML::Config::anchor("SEC_Contents") . "\n" ]; - #&$Texi2HTML::Config::print_Toc(\*FILE); - #close(FILE) if $Texi2HTML::Config::SPLIT; - &$Texi2HTML::Config::print_Toc($FH); - close_out($FH, $docu_toc_file) - #|| die "$ERROR: Error occurred when closing $docu_toc_file: $!\n" - if ($Texi2HTML::Config::SPLIT); - $Texi2HTML::HREF{'Contents'} = $Texi2HTML::HREF{'This'}; - } - - if (@{$Texi2HTML::OVERVIEW}) - { - print STDERR "# writing Overview in $docu_stoc_file\n" if $T2H_VERBOSE; - #open (FILE, "> $docu_stoc_file") || die "$ERROR: Can't open $docu_stoc_file for writing: $!\n" - $FH = open_out ($docu_stoc_file) - if $Texi2HTML::Config::SPLIT; - $Texi2HTML::HREF{This} = $Texi2HTML::HREF{Overview}; - $Texi2HTML::HREF{Overview} = "#SEC_Overview"; - $Texi2HTML::NAME{This} = $Texi2HTML::NAME{Overview}; - $Texi2HTML::NO_TEXI{This} = $Texi2HTML::NO_TEXI{Overview}; - $Texi2HTML::UNFORMATTED{This} = $Texi2HTML::UNFORMATTED{Overview}; - $Texi2HTML::THIS_SECTION = $Texi2HTML::OVERVIEW; - $Texi2HTML::THIS_HEADER = [ &$Texi2HTML::Config::anchor("SEC_Overview") . "\n" ]; - #&$Texi2HTML::Config::print_Overview(\*FILE); - #close(FILE) if $Texi2HTML::Config::SPLIT; - &$Texi2HTML::Config::print_Overview($FH); - close_out($FH,$docu_stoc_file) - #|| die "$ERROR: Error occurred when closing $docu_stoc_file: $!\n" - if ($Texi2HTML::Config::SPLIT); - $Texi2HTML::HREF{Overview} = $Texi2HTML::HREF{This}; - } - my $about_body; - if ($about_body = &$Texi2HTML::Config::about_body()) - { - print STDERR "# writing About in $docu_about_file\n" if $T2H_VERBOSE; - #open (FILE, "> $docu_about_file") || die "$ERROR: Can't open $docu_about_file for writing: $!\n" - $FH = open_out ($docu_about_file) - if $Texi2HTML::Config::SPLIT; - - $Texi2HTML::HREF{This} = $Texi2HTML::HREF{About}; - $Texi2HTML::HREF{About} = "#SEC_About"; - $Texi2HTML::NAME{This} = $Texi2HTML::NAME{About}; - $Texi2HTML::NO_TEXI{This} = $Texi2HTML::NO_TEXI{About}; - $Texi2HTML::UNFORMATTED{This} = $Texi2HTML::UNFORMATTED{About}; - $Texi2HTML::THIS_SECTION = [$about_body]; - $Texi2HTML::THIS_HEADER = [ &$Texi2HTML::Config::anchor("SEC_About") . "\n" ]; - #&$Texi2HTML::Config::print_About(\*FILE); - #close(FILE) if $Texi2HTML::Config::SPLIT; - &$Texi2HTML::Config::print_About($FH); - close_out($FH, $docu_stoc_file) - #|| die "$ERROR: Error occurred when closing $docu_stoc_file: $!\n" - if ($Texi2HTML::Config::SPLIT); - $Texi2HTML::HREF{About} = $Texi2HTML::HREF{This}; - } - - unless ($Texi2HTML::Config::SPLIT) - { - &$Texi2HTML::Config::print_page_foot($FH); - close_out ($FH); - # || die "$ERROR: Error occurred when closing: $!\n"; - } -} - -# print section, close file and undef FH if needed. -sub finish_element($$$$) -{ - my $FH = shift; - my $element = shift; - my $new_element = shift; - my $first_section = shift; -#print STDERR "FINISH_ELEMENT($FH)($element->{'texi'})[$element->{'file'}] counter $files{$element->{'file'}}->{'counter'}\n"; - if ($element->{'top'}) - { - my $top_file = $docu_top_file; - #print STDERR "TOP $element->{'texi'}, @section_lines\n"; - print STDERR "[Top]" if ($T2H_VERBOSE); - $Texi2HTML::HREF{'Top'} = href($element_top, $element->{'file'}); - &$Texi2HTML::Config::print_Top($FH, $element->{'has_heading'}); - my $end_page = 0; - if ($Texi2HTML::Config::SPLIT) - { - if (!$files{$element->{'file'}}->{'counter'}) - { - $end_page = 1; - } - } - &$Texi2HTML::Config::print_Top_footer($FH, $end_page); - close_out($FH, $top_file) if ($end_page); - } - else - { - print STDERR "# do element $element->{'texi'}\n" - if ($T2H_DEBUG & $DEBUG_ELEMENTS); - &$Texi2HTML::Config::print_section($FH, $first_section); - if (defined($new_element) and ($new_element->{'file'} ne $element->{'file'})) - { - if (!$files{$element->{'file'}}->{'counter'}) - { - &$Texi2HTML::Config::print_chapter_footer($FH) if ($Texi2HTML::Config::SPLIT eq 'chapter'); - &$Texi2HTML::Config::print_section_footer($FH) if ($Texi2HTML::Config::SPLIT eq 'section'); - #print STDERR "Close file after $element->{'texi'}\n"; - &$Texi2HTML::Config::print_page_foot($FH); - close_out($FH); - } - else - { - print STDERR "counter $files{$element->{'file'}}->{'counter'} ne 0, file $element->{'file'}\n"; - } - undef $FH; - } - elsif (!defined($new_element)) - { - if ($Texi2HTML::Config::SPLIT) - { # end of last splitted section - &$Texi2HTML::Config::print_chapter_footer($FH) if ($Texi2HTML::Config::SPLIT eq 'chapter'); - &$Texi2HTML::Config::print_section_footer($FH) if ($Texi2HTML::Config::SPLIT eq 'section'); - &$Texi2HTML::Config::print_page_foot($FH); - close_out($FH); - } - else - { - &$Texi2HTML::Config::end_section($FH, 1); - } - } - elsif ($new_element->{'top'}) - { - &$Texi2HTML::Config::end_section($FH, 1); - } - else - { - &$Texi2HTML::Config::end_section($FH); - } - } - return $FH; -} - -# write to files with name the node name for cross manual references. -sub do_node_files() -{ - foreach my $key (keys(%nodes)) - { - my $node = $nodes{$key}; - next unless ($node->{'node_file'}); - my $redirection_file = $docu_doc; - $redirection_file = $node->{'file'} if ($Texi2HTML::Config::SPLIT); - if (!$redirection_file) - { - print STDERR "Bug: file for redirection for `$node->{'texi'}' don't exist\n" unless ($novalidate); - next; - } - next if ($redirection_file eq $node->{'node_file'}); - my $file = "${docu_rdir}$node->{'node_file'}"; - $Texi2HTML::NODE{'This'} = $node->{'text'}; - $Texi2HTML::NO_TEXI{'This'} = $node->{'no_texi'}; - $Texi2HTML::UNFORMATTED{'This'} = $node->{'no_texi'}; - $Texi2HTML::NAME{'This'} = $node->{'text'}; - $Texi2HTML::HREF{'This'} = "$node->{'file'}#$node->{'id'}"; - open (NODEFILE, "> $file") || die "$ERROR Can't open $file for writing: $!\n"; - &$Texi2HTML::Config::print_redirection_page (\*NODEFILE); - close NODEFILE || die "$ERROR: Can't close $file: $!\n"; - } -} - -#+++############################################################################ -# # -# Low level functions # -# # -#---############################################################################ - -sub locate_include_file($) -{ - my $file = shift; - - # APA: Don't implicitely search ., to conform with the docs! - # return $file if (-e $file && -r $file); - foreach my $dir (@Texi2HTML::Config::INCLUDE_DIRS) - { - return "$dir/$file" if (-e "$dir/$file" && -r "$dir/$file"); - } - return undef; -} - -sub open_file($$) -{ - my $name = shift; - my $line_number = shift; - local *FH; - #if ((defined($from_encoding) and open(*FH, ":encoding($from_encoding)", $name)) or open(*FH, $name)) - #if ((defined($from_encoding) and open(*FH, "<:$from_encoding", $name)) or open(*FH, $name)) - if (open(*FH, "<$name")) - { - if (defined($from_encoding)) - { - binmode(*FH, ":encoding($from_encoding)"); - } - my $file = { 'fh' => *FH, - 'input_spool' => { 'spool' => [], - 'macro' => '' }, - 'name' => $name, - 'line_nr' => 0 }; - unshift(@fhs, $file); - $input_spool = $file->{'input_spool'}; - $line_number->{'file_name'} = $name; - $line_number->{'line_nr'} = 1; - } - else - { - warn "$ERROR Can't read file $name: $!\n"; - } -} - -sub open_out($) -{ - my $file = shift; - if ($file eq '-') - { - binmode(STDOUT, ":encoding($to_encoding)") if (defined($to_encoding)); - return \*STDOUT; - } - #unless ((defined($to_encoding) and open(FILE, ">:encoding($to_encoding)", $file)) or open(FILE, "> $file")) - #my $open_style = 'bytes'; - #$open_style = 'utf8' if (defined($to_encoding) and $to_encoding eq 'utf8'); - #if (defined($to_encoding) and $to_encoding eq 'utf8') - #{ - # $open_style = 'utf8'; - # print STDERR "$open_style\n"; - #} - #unless ((defined($to_encoding) and open(FILE, ">:$open_style", $file)) or open(FILE, "> $file")) - unless (open(FILE, ">$file")) - { - die "$ERROR Can't open $file for writing: $!\n"; - } - if (defined($to_encoding)) - { - if ($to_encoding eq 'utf8') - { - binmode(FILE, ':utf8'); - } - else - { - binmode(FILE, ':bytes'); - } - binmode(FILE, ":encoding($to_encoding)"); - } - return \*FILE; -} - -sub close_out($;$) -{ - my $FH = shift; - my $file = shift; - $file = '' if (!defined($file)); - return if ($Texi2HTML::Config::OUT eq ''); - close ($FH) || die "$ERROR: Error occurred when closing $file: $!\n"; -} - -sub next_line($) -{ - my $line_number = shift; - while (@fhs) - { - my $file = $fhs[0]; - $line_number->{'file_name'} = $file->{'name'}; - $input_spool = $file->{'input_spool'}; - if (@{$input_spool->{'spool'}}) - { - $line_number->{'macro'} = $file->{'input_spool'}->{'macro'}; - $line_number->{'line_nr'} = $file->{'line_nr'}; - my $line = shift(@{$input_spool->{'spool'}}); - print STDERR "# unspooling $line" if ($T2H_DEBUG & $DEBUG_MACROS); - return($line); - } - else - { - $file->{'input_spool'}->{'macro'} = ''; - $line_number->{'macro'} = ''; - } - my $fh = $file->{'fh'}; - no strict "refs"; - my $line = <$fh>; - use strict "refs"; - my $chomped_line = $line; - $file->{'line_nr'}++ if (defined($line) and chomp($chomped_line)); - $line_number->{'line_nr'} = $file->{'line_nr'}; - return($line) if (defined($line)); - no strict "refs"; - close($fh); - use strict "refs"; - shift(@fhs); - } - return(undef); -} - -# echo a warning -sub echo_warn($;$) -{ - my $text = shift; - chomp ($text); - my $line_number = shift; - warn "$WARN $text " . format_line_number($line_number) . "\n"; -} - -sub echo_error($;$) -{ - my $text = shift; - chomp ($text); - my $line_number = shift; - warn "$ERROR $text " . format_line_number($line_number) . "\n"; -} - -sub format_line_number($) -{ - my $line_number = shift; - my $macro_text = ''; - #$line_number = undef; - return '' unless (defined($line_number)); - $macro_text = " in $line_number->{'macro'}" if ($line_number->{'macro'} ne ''); - my $file_text = '('; - $file_text = "(in $line_number->{'file_name'} " if ($line_number->{'file_name'} ne $docu); - return "${file_text}l. $line_number->{'line_nr'}" . $macro_text . ')'; -} - -# to debug, dump the result of pass_texi and pass_structure in a file -sub dump_texi($$;$$) -{ - my $lines = shift; - my $pass = shift; - my $numbers = shift; - my $file = shift; - $file = "$docu_rdir$docu_name" . ".pass$pass" if (!defined($file)); - unless (open(DMPTEXI, ">$file")) - { - warn "Can't open $file for writing: $!\n"; - } - print STDERR "# Dump texi\n" if ($T2H_VERBOSE); - my $index = 0; - foreach my $line (@$lines) - { - my $number_information = ''; - my $chomped_line = $line; - $number_information = "$numbers->[$index]->{'file_name'}($numbers->[$index]->{'macro'},$numbers->[$index]->{'line_nr'}) " if (defined($numbers)); - print DMPTEXI "${number_information}$line"; - $index++ if (chomp($chomped_line)); - } - close DMPTEXI; -} - -# return next tag on the line -sub next_tag($) -{ - my $line = shift; - if ($line =~ /^\s*\@(["'~\@\}\{,\.!\?\s\*\-\^`=:\|\/])/o or $line =~ /^\s*\@([a-zA-Z]\w*)([\s\{\}\@])/ or $line =~ /^\s*\@([a-zA-Z]\w*)$/) - { - return ($1); - } - return ''; -} - -sub top_stack($) -{ - my $stack = shift; - return undef unless(@$stack); - return $stack->[-1]; -} - -# return the next element with balanced {} -sub next_bracketed($$) -{ - my $line = shift; - my $line_nr = shift; - my $opened_braces = 0; - my $result = ''; - my $spaces; - if ($line =~ /^(\s*)$/) - { - return ('','',$1); - } - while ($line !~ /^\s*$/) - { -#print STDERR "next_bracketed($opened_braces): $result !!! $line"; - if (!$opened_braces) - { # beginning of item - $line =~ s/^(\s*)//; - $spaces = $1; - #if ($line =~ s/^([^\{\}\s]+)//) - if ($line =~ s/^([^\{\}]+?)(\s+)/$2/ or $line =~ s/^([^\{\}]+?)$//) - { - $result = $1; - $result =~ s/\s*$//; - return ($result, $line, $spaces); - } - elsif ($line =~ s/^([^\{\}]+?)([\{\}])/$2/) - { - $result = $1; - } - } - elsif($line =~ s/^([^\{\}]+)//) - { - $result .= $1; - } - if ($line =~ s/^([\{\}])//) - { - my $brace = $1; - $opened_braces++ if ($brace eq '{'); - $opened_braces-- if ($brace eq '}'); - - if ($opened_braces < 0) - { - echo_error("too much '}' in specification", $line_nr); - $opened_braces = 0; - next; - } - $result .= $brace; - return ($result, $line, $spaces) if ($opened_braces == 0); - } - } - if ($opened_braces) - { - echo_error("'{' not closed in specification", $line_nr); - return ($result . ( '}' x $opened_braces), '', $spaces); - } - print STDERR "BUG: at the end of next_bracketed\n"; - return undef; -} - -# do a href using file and id and taking care of ommitting file if it is -# the same -# element: structuring element to point to -# file: current file -sub href($$) -{ - my $element = shift; - my $file = shift; - return '' unless defined($element); - my $href = ''; - print STDERR "Bug: $element->{'texi'}, id undef\n" if (!defined($element->{'id'})); - print STDERR "Bug: $element->{'texi'}, file undef\n" if (!defined($element->{'file'})); -#foreach my $key (keys(%{$element})) -#{ -# my $value = 'UNDEF'; $value = $element->{$key} if defined($element->{$key}); -# print STDERR "$key: $value\n"; -#}print STDERR "\n"; - $href .= $element->{'file'} if (defined($element->{'file'}) and $file ne $element->{'file'}); - $href .= "#$element->{'id'}" if (defined($element->{'id'})); - return $href; -} - -sub normalise_space($) -{ - return undef unless (defined ($_[0])); - my $text = shift; - $text =~ s/\s+/ /go; - $text =~ s/ $//; - $text =~ s/^ //; - return $text; -} - -sub normalise_node($) -{ - return undef unless (defined ($_[0])); - my $text = shift; - $text = normalise_space($text); - $text =~ s/^top$/Top/i; - return $text; -} - -sub do_math($;$) -{ - #return l2h_ToLatex("\$".$_[0]."\$"); - return Texi2HTML::LaTeX2HTML::to_latex("\$".$_[0]."\$"); -} - -sub do_anchor_label($$$$) -{ - my $command = shift; - #my $anchor = shift; - my $args = shift; - my $anchor = $args->[0]; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - return '' if ($state->{'multiple_pass'}); - $anchor = normalise_node($anchor); - return &$Texi2HTML::Config::anchor($nodes{$anchor}->{'id'}); -} - -sub get_format_command($) -{ - my $format = shift; - my $command = ''; - my $format_name = ''; - my $term = 0; - my $item_nr; - my $paragraph_number; - my $enumerate_type; - my $number; - - if (defined($format) and ref($format) eq "HASH") - { - $command = $format->{'command'}; - $command = '' if (!defined($command)); - $paragraph_number = \$format->{'paragraph_number'}; - $format_name = $format->{'format'}; - $term = 1 if ($format->{'term'}); #This should never happen - $item_nr = $format->{'item_nr'}; - $enumerate_type = $format->{'spec'}; - $number = $format->{'number'}; - } - return ($format_name, $command, $paragraph_number, $term, $item_nr, - $enumerate_type, $number); -} - -sub do_paragraph($$) -{ - my $text = shift; - my $state = shift; - my ($format, $paragraph_command, $paragraph_number, $term, $item_nr, - $enumerate_type, $number) = get_format_command ($state->{'paragraph'}); - delete $state->{'paragraph'}; - my $paragraph_command_formatted; - $state->{'paragraph_nr'}--; - (print STDERR "Bug text undef in do_paragraph", return '') unless defined($text); - my $align = ''; - $align = $state->{'paragraph_style'}->[-1] if ($state->{'paragraph_style'}->[-1]); - - if (exists($style_map_ref->{$paragraph_command}) and - !exists($Texi2HTML::Config::special_list_commands{$format}->{$paragraph_command})) - { - if ($format eq 'itemize') - { - chomp ($text); - $text = do_simple($paragraph_command, $text, $state, [$text]); - $text = $text . "\n"; - } - } - elsif (exists($things_map_ref->{$paragraph_command})) - { - $paragraph_command_formatted = do_simple($paragraph_command, '', $state); - } - return &$Texi2HTML::Config::paragraph($text, $align, $paragraph_command, $paragraph_command_formatted, $paragraph_number, $format, $item_nr, $enumerate_type, $number); -} - -sub do_preformatted($$) -{ - my $text = shift; - my $state = shift; - my ($format, $leading_command, $preformatted_number, $term, $item_nr, $enumerate_type, - $number) = get_format_command($state->{'preformatted_format'}); - delete ($state->{'preformatted_format'}); - my $leading_command_formatted; - my $pre_style = ''; - my $class = ''; - $pre_style = $state->{'preformatted_stack'}->[-1]->{'pre_style'} if ($state->{'preformatted_stack'}->[-1]->{'pre_style'}); - $class = $state->{'preformatted_stack'}->[-1]->{'class'}; - print STDERR "BUG: !state->{'preformatted_stack'}->[-1]->{'class'}\n" unless ($class); - if (exists($style_map_ref->{$leading_command}) and - !exists($Texi2HTML::Config::special_list_commands{$format}->{$leading_command}) and ($style_type{$leading_command} eq 'style')) - { - $text = do_simple($leading_command, $text, $state,[$text]) if ($format eq 'itemize'); - } - elsif (exists($things_map_ref->{$leading_command})) - { - $leading_command_formatted = do_simple($leading_command, '', $state); - } - return &$Texi2HTML::Config::preformatted($text, $pre_style, $class, $leading_command, $leading_command_formatted, $preformatted_number, $format, $item_nr, $enumerate_type, $number); -} - -sub do_external_href($) -{ - my $texi_node = shift; - my $file = ''; - my $node_id = ''; - my $node_xhtml_id = ''; - if ($texi_node =~ s/^\((.+?)\)//) - { - $file = $1; - } - $texi_node = normalise_node($texi_node); - if ($texi_node ne '') - { - if (exists($nodes{$texi_node}) and ($nodes{$texi_node}->{'cross_manual_target'})) - { - $node_id = $nodes{$texi_node}->{'cross_manual_target'}; - } - else - { - $node_id = cross_manual_line($texi_node); - } - $node_xhtml_id = node_to_id($node_id); - } - return &$Texi2HTML::Config::external_href($texi_node, $node_id, - $node_xhtml_id, $file); -} - -# transform node for cross ref name to id suitable for xhtml. -sub node_to_id($) -{ - my $cross_ref_node_name = shift; - $cross_ref_node_name =~ s/^([0-9_])/g_t$1/; - return $cross_ref_node_name; -} - -# return 1 if the following tag shouldn't begin a line -sub no_line($) -{ - my $line = shift; - my $next_tag = next_tag($line); - return 1 if (($line =~ /^\s*$/) or $no_line_macros{$next_tag} or - (($next_tag =~ /^(\w+?)index$/) and ($1 ne 'print')) or - (($line =~ /^\@end\s+(\w+)/) and $no_line_macros{"end $1"})); - return 0; -} - -sub no_paragraph($$) -{ - my $state = shift; - my $line = shift; - return ($state->{'paragraph'} or $state->{'preformatted'} or $state->{'remove_texi'} or no_line($line) or $state->{'no_paragraph'}); -} - -sub automatic_preformatted($$) -{ - my $state = shift; - my $macro = shift; - return ($state->{'preformatted'} and - !$Texi2HTML::Config::format_in_paragraph{$macro}); -} - -# handle raw formatting, ignored regions... -sub do_text_macro($$$$) -{ - my $type = shift; - my $line = shift; - my $state = shift; - my $line_nr = shift; - my $value; - #print STDERR "do_text_macro $type\n"; - - if (not $text_macros{$type}) - { # ignored text - $state->{'ignored'} = $type; - #print STDERR "IGNORED\n"; - } - elsif ($text_macros{$type} eq 'raw' or $text_macros{$type} eq 'special') - { - $state->{'raw'} = $type; - #print STDERR "RAW\n"; - } - elsif ($text_macros{$type} eq 'value') - { - if (($line =~ s/(\s+)($VARRE)$//) or ($line =~ s/(\s+)($VARRE)(\s)//)) - { - $value = $1 . $2; - $value .= $3 if defined($3); - if ($type eq 'ifclear') - { - if (defined($value{$2})) - { - $state->{'ignored'} = $type; - } - else - { - push @{$state->{'text_macro_stack'}}, $type; - } - } - elsif ($type eq 'ifset') - { - unless (defined($value{$2})) - { - $state->{'ignored'} = $type; - } - else - { - push @{$state->{'text_macro_stack'}}, $type; - } - } - } - else - { - echo_error ("Bad $type line: $line", $line_nr); - #warn "$ERROR Bad $type line: $line"; - } - } - else - { - push @{$state->{'text_macro_stack'}}, $type; - } - my $text = "\@$type"; - $text .= $value if defined($value); - return ($line, $text); -} - -# do regions handled specially, currently only tex, going throug latex2html -sub do_special ($$) -{ - my $style = shift; - my $text = shift; - if ($style eq 'tex') - { - # add space to the end -- tex(i2dvi) does this, as well - #return (l2h_ToLatex($text . " ")); - return (Texi2HTML::LaTeX2HTML::to_latex($text . " ")); - } -} - -sub do_insertcopying($) -{ - my $state = shift; - return '' unless @{$region_lines{'copying'}}; - return substitute_text(duplicate_state($state), @{$region_lines{'copying'}}); -} - -sub get_deff_index($$$) -{ - my $tag = shift; - my $line = shift; - my $line_nr = shift; - - $tag =~ s/x$// if $tag =~ /x$/; - my ($style, $category, $name, $type, $class, $arguments); - ($style, $category, $name, $type, $class, $arguments) = parse_def($tag, $line, $line_nr); - # FIXME -- --- ''... should be protected for name and maybe class - $name = &$Texi2HTML::Config::definition_category($name, $class, $style); - return undef if (!$name or ($name =~ /^\s*$/)); - return ($style, $name); -} - -sub parse_def($$$) -{ - my $tag = shift; - my $line = shift; - my $line_nr = shift; - - if (!ref ($Texi2HTML::Config::def_map{$tag})) - { - # substitute shortcuts for definition commands - my $substituted = $Texi2HTML::Config::def_map{$tag}; - $substituted =~ s/(\w+)//; - $tag = $1; - $line = $substituted . $line; - } -#print STDERR "PARSE_DEF $line"; - my ($category, $name, $type, $class, $arguments); - my @args = @{$Texi2HTML::Config::def_map{$tag}}; - my $style = shift @args; - while (@args) - { - my $arg = shift @args; - if (defined($arg)) - { - # backward compatibility, it was possible to have a { in front. - $arg =~ s/^\{//; - my $item; - my $spaces; - ($item, $line,$spaces) = next_bracketed($line, $line_nr); - last if (!defined($item)); - $item =~ s/^\{(.*)\}$/$1/ if ($item =~ /^\{/); - if ($arg eq 'category') - { - $category = $item; - } - elsif ($arg eq 'name') - { - $name = $item; - } - elsif ($arg eq 'type') - { - $type = $item; - } - elsif ($arg eq 'class') - { - $class = $item; - } - elsif ($arg eq 'arg') - { - $line = $spaces . $item . $line; - } - } - else - { - # chomp ($line); - # $line =~ s/\s*$//; - # $arguments = $line if ($line ne ''); - last; - } - } - #return ($style, $category, $name, $type, $class, $arguments); -#print STDERR "PARSE_DEF (style $style, category $category, name $name, type $type, class $class, line $line)\n"; - return ($style, $category, $name, $type, $class, $line); -} - -#FIXME this is rather fragile. -sub begin_deff_item($$;$) -{ - my $stack = shift; - my $state = shift; - my $no_paragraph = shift; - return if ($state->{'cmd_line'}); - #print STDERR "DEF push deff_item for $state->{'deff'}\n"; - push @$stack, { 'format' => 'deff_item', 'text' => '' }; - # there is no paragraph when a new deff just follows the deff we are - # opening - begin_paragraph($stack, $state) if ($state->{'preformatted'} and !$no_paragraph); - $state->{'deff'} = undef; - delete($state->{'deff'}); - #dump_stack(undef, $stack, $state); -} - -sub begin_paragraph($$) -{ - my $stack = shift; - my $state = shift; - - my $command = 1; - my $top_format = top_format($stack); - if (defined($top_format)) - { - $command = $top_format; - } - if ($state->{'preformatted'}) - { - push @$stack, {'format' => 'preformatted', 'text' => '' }; - $state->{'preformatted_format'} = $command if ($command ne '1'); - push @$stack, @{$state->{'paragraph_macros'}} if $state->{'paragraph_macros'}; - delete $state->{'paragraph_macros'}; - return; - } - $state->{'paragraph'} = $command; - $state->{'paragraph_nr'}++; - push @$stack, {'format' => 'paragraph', 'text' => '' }; - # if there are macros which weren't closed when the previous - # paragraph was closed we reopen them here - push @$stack, @{$state->{'paragraph_macros'}} if $state->{'paragraph_macros'}; - delete $state->{'paragraph_macros'}; -} - -sub parse_format_command($$) -{ - my $line = shift; - my $tag = shift; - my $command = 'asis'; - if (($line =~ /^\s*\@([A-Za-z]\w*)(\{\})?$/ or $line =~ /^\s*\@([A-Za-z]\w*)(\{\})?\s/) and ($things_map_ref->{$1} or defined($style_map_ref->{$1}))) - { - $line =~ s/^\s*\@([A-Za-z]\w*)(\{\})?\s*//; - $command = $1; - } - return ('', $command) if ($line =~ /^\s*$/); - chomp $line; - $line = substitute_text ({'keep_nr' => 1, 'keep_texi' => 1, 'check_item' => $tag}, $line); - return ($line, $command); -} - -sub parse_enumerate($) -{ - my $line = shift; - my $spec; - if ($line =~ /^\s*(\w)\b/ and ($1 ne '_')) - { - $spec = $1; - $line =~ s/^\s*(\w)\s*//; - } - return ($line, $spec); -} - -sub parse_multitable($$) -{ - my $line = shift; - my $line_nr = shift; - # first find the table width - my $table_width = 0; - if ($line =~ s/^\s+\@columnfractions\s+//) - { - my @fractions = split /\s+/, $line; - $table_width = $#fractions + 1; - while (@fractions) - { - my $fraction = shift @fractions; - unless ($fraction =~ /^(\d*\.\d+)|(\d+)\.?$/) - { - echo_error ("column fraction not a number: $fraction", $line_nr); - #warn "$ERROR column fraction not a number: $fraction"; - } - } - } - else - { - my $element; - my $line_orig = $line; - while ($line !~ /^\s*$/) - { - my $spaces; - ($element, $line, $spaces) = next_bracketed($line, $line_nr); - if ($element =~ /^\{/) - { - $table_width++; - } - else - { - echo_error ("garbage in multitable specification: $element", $line_nr); - } - } - } - return ($table_width); -} - -sub end_format($$$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $format = shift; - my $line_nr = shift; - #print STDERR "END FORMAT $format\n"; - #dump_stack($text, $stack, $state); - #sleep 1; - close_menu($text, $stack, $state, $line_nr) if ($format_type{$format} eq 'menu'); - if (($format_type{$format} eq 'list') or ($format_type{$format} eq 'table')) - { # those functions return if they detect an inapropriate context - add_item($text, $stack, $state, $line_nr, '', 1); # handle lists - add_term($text, $stack, $state, $line_nr, 1); # handle table - add_line($text, $stack, $state, $line_nr, 1); # handle table - add_row($text, $stack, $state, $line_nr); # handle multitable - } - - #print STDERR "END_FORMAT\n"; - #dump_stack($text, $stack, $state); - - my $format_ref = pop @$stack; - - # debug - if (!defined($format_ref->{'text'})) - { - push @$stack, $format_ref; - print STDERR "Bug: text undef in end_format $format\n"; - dump_stack($text, $stack, $state); - pop @$stack; - } - - if (defined($Texi2HTML::Config::def_map{$format})) - { - close_stack($text, $stack, $state, $line_nr, undef, 'deff_item') unless ($format_ref->{'format'} eq 'deff_item'); - add_prev($text, $stack, &$Texi2HTML::Config::def_item($format_ref->{'text'})); - $format_ref = pop @$stack; # pop deff - if (!defined($format_ref->{'format'}) or !defined($Texi2HTML::Config::def_map{$format_ref->{'format'}})) - { - print STDERR "Bug: not a def* under deff_item\n"; - push (@$stack, $format_ref); - dump_stack($text, $stack, $state); - pop @$stack; - } - elsif ($format_ref->{'format'} ne $format) - { - echo_warn ("Waiting for \@end $format_ref->{'format'}, found \@end $format", $line_nr); - } - add_prev($text, $stack, &$Texi2HTML::Config::def($format_ref->{'text'})); - } - elsif ($format_type{$format} eq 'cartouche') - { - add_prev($text, $stack, &$Texi2HTML::Config::cartouche($format_ref->{'text'})); - } - elsif ($format eq 'float') - { - if (!defined($state->{'float'})) - { - echo_warn ("Waiting for \@end $format_ref->{'format'}, found \@end $format", $line_nr); - } - else - { - my ($caption_lines, $shortcaption_lines) = &$Texi2HTML::Config::caption_shortcaption($state->{'float'}); - my ($caption_text, $shortcaption_text); - $caption_text = substitute_text(duplicate_state($state), @$caption_lines) if (defined($caption_lines)); - $shortcaption_text = substitute_text(duplicate_state($state), @$shortcaption_lines) if (defined($shortcaption_lines)); - add_prev($text, $stack, &$Texi2HTML::Config::float($format_ref->{'text'}, $state->{'float'}, $caption_text, $shortcaption_text)); - delete $state->{'float'}; - } - } - elsif ($format_type{$format} eq 'menu') - { - if ($state->{'preformatted'}) - { - # end the fake complex format - $state->{'preformatted'}--; - pop @{$state->{'preformatted_stack'}}; - pop @$stack; - } - $state->{'menu'}--; - add_prev($text, $stack, &$Texi2HTML::Config::menu($format_ref->{'text'})); - } - elsif ($format_type{$format} eq 'complex') - { - $state->{'preformatted'}--; - pop @{$state->{'preformatted_stack'}}; - # debug - if (!defined($Texi2HTML::Config::complex_format_map->{$format_ref->{'format'}}->{'begin'})) - { - print STDERR "Bug undef $format_ref->{'format'}" . "->{'begin'} (for $format...)\n"; - dump_stack ($text, $stack, $state); - } - #print STDERR "before $format\n"; - #dump_stack ($text, $stack, $state); - add_prev($text, $stack, &$Texi2HTML::Config::complex_format($format_ref->{'format'}, $format_ref->{'text'})); - #print STDERR "after $format\n"; - #dump_stack ($text, $stack, $state); - } - elsif (($format_type{$format} eq 'table') or ($format_type{$format} eq 'list')) - { - #print STDERR "CLOSE $format ($format_ref->{'format'})\n$format_ref->{'text'}\n"; - pop @{$state->{'format_stack'}}; - #dump_stack($text, $stack, $state); - if ($format_ref->{'format'} ne $format) - { - echo_warn ("Waiting for \@end $format_ref->{'format'}, found \@end $format", $line_nr); - } - if ($Texi2HTML::Config::format_map{$format}) - { # table or list has a simple format - add_prev($text, $stack, end_simple_format($format_ref->{'format'}, $format_ref->{'text'})); - } - else - { # table or list handler defined by the user - add_prev($text, $stack, &$Texi2HTML::Config::table_list($format_ref->{'format'}, $format_ref->{'text'}, $format_ref->{'command'})); - } - } - elsif ($format eq 'quotation') - { - my $quotation_args = pop @{$state->{'quotation_stack'}}; - add_prev($text, $stack, &$Texi2HTML::Config::quotation($format_ref->{'text'}, $quotation_args->{'text'}, $quotation_args->{'style_texi'}, $quotation_args->{'style_id'})); - } - elsif ($format_type{$format} eq 'paragraph_style') - { - if ($state->{'paragraph_style'}->[-1] eq $format) - { - pop @{$state->{'paragraph_style'}}; - } - add_prev($text, $stack, &$Texi2HTML::Config::paragraph_style_command($format_ref->{'format'},$format_ref->{'text'})); - } - elsif (exists($Texi2HTML::Config::format_map{$format})) - { - if ($format_ref->{'format'} ne $format) - { # FIXME hasn't that case been handled before ? - echo_warn ("Waiting for \@end $format_ref->{'format'}, found \@end $format", $line_nr); - } - add_prev($text, $stack, end_simple_format($format_ref->{'format'}, $format_ref->{'text'})); - } - else - { - echo_warn("Unknown format $format", $line_nr); - } - # We restart the preformatted format which was stopped by the format - # if in preformatted - if (automatic_preformatted($state,$format)) - { - #print STDERR "restart preformatted, $format\n"; - begin_paragraph($stack, $state); - } -} - -sub do_text($;$) -{ - my $text = shift; - my $state = shift; - return $text if ($state->{'keep_texi'}); - if (defined($state) and !$state->{'preformatted'} and !$state->{'code_style'}) - { - # in normal text `` and '' serve as quotes, --- is for a long dash - # and -- for a medium dash. - # (see texinfo.txi, @node Conventions) - $text = &$Texi2HTML::Config::normal_text($text); - } - if ($state->{'no_protection'}) - { - return $text; - } - return &$Texi2HTML::Config::protect_text($text); -} - -sub end_simple_format($$) -{ - my $tag = shift; - my $text = shift; - - my $element = $Texi2HTML::Config::format_map{$tag}; - return &$Texi2HTML::Config::format($tag, $element, $text); -} - -sub close_menu($$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - if ($state->{'menu_comment'}) - { - #print STDERR "close MENU_COMMENT Before close_stack\n"; - #dump_stack($text, $stack, $state); - close_stack($text, $stack, $state, $line_nr, undef, 'menu_comment'); - # close_paragraph isn't needed in most cases, but A preformatted may - # appear after close_stack if we closed a format, as formats reopen - # preformatted. However it is empty and close_paragraph will remove it - close_paragraph($text, $stack, $state); - my $menu_comment = pop @$stack; - if (!$menu_comment->{'format'} or $menu_comment->{'format'} ne 'menu_comment') - { - warn "Bug waiting for menu_comment, got $menu_comment->{'format'}\n"; - dump_stack($text, $stack, $state); - } - add_prev($text, $stack, &$Texi2HTML::Config::menu_comment($menu_comment->{'text'})); - pop @{$state->{'preformatted_stack'}}; - $state->{'preformatted'}--; - $state->{'menu_comment'}--; - } - if ($state->{'menu_entry'}) - { - close_stack($text, $stack,$state, $line_nr, undef, 'menu_description'); - my $descr = pop(@$stack); - print STDERR "# close_menu: close description\n" if ($T2H_DEBUG & $DEBUG_MENU); - add_prev($text, $stack, menu_description($descr->{'text'}, $state)); - delete $state->{'menu_entry'}; - } -} - -# Format menu link, the -sub do_menu_link($$;$) -{ - my $state = shift; - my $line_nr = shift; - my $simple = shift; - my $menu_entry = $state->{'menu_entry'}; - my $file = $state->{'element'}->{'file'}; - my $node_name = normalise_node($menu_entry->{'node'}); - - my $substitution_state = duplicate_state($state); - my $name = substitute_line($menu_entry->{'name'}, $substitution_state); - my $node = substitute_line($menu_entry->{'node'}, $substitution_state); - - if (($name ne '') and !$state->{'preformatted'} and $Texi2HTML::Config::AVOID_MENU_REDUNDANCY) - { - $name = '' unless (clean_text(remove_texi($menu_entry->{'name'})) - ne clean_text(remove_texi($menu_entry->{'node'}))) - } - - my $entry = ''; - my $href; - my $element = $nodes{$node_name}; - if ($element->{'seen'}) - { - if ($element->{'with_section'}) - { - $element = $element->{'with_section'}; - } - - #print STDERR "SUBHREF in menu for $element->{'texi'}\n"; - $href = href($element, $file); - if (! $element->{'node'}) - { - $entry = $element->{'text'}; # this is the section name without number - $entry = $element->{'name'} if (!$Texi2HTML::Config::NUMBER_SECTIONS); - $entry = "$Texi2HTML::Config::MENU_SYMBOL $entry" if (($entry ne '') and (!defined($element->{'number'}) or ($element->{'number'} =~ /^\s*$/)) and $Texi2HTML::Config::UNNUMBERED_SYMBOL_IN_MENU); - } - } - elsif ($menu_entry->{'node'} =~ /^\s*\(.*\)/ or $novalidate) - {#FIXME this is wrong for $novalidate - # menu entry points to another info manual - #$href = $nodes{$node_name}->{'file'}; - $href = do_external_href($node_name); - } - else - { - echo_error ("Unknown node in menu entry `$node_name'", $line_nr); - } - return &$Texi2HTML::Config::menu_link($entry, $state, $href, $node, $name, $menu_entry->{'ending'}) unless ($simple); - return &$Texi2HTML::Config::simple_menu_link($entry, $state->{'preformatted'}, $href, $node, $name, $menu_entry->{'ending'}); -} - -sub menu_description($$) -{ - my $descr = shift; - my $state = shift; - my $menu_entry = $state->{'menu_entry'}; - my $node_name = normalise_node($menu_entry->{'node'}); - - my $element = $nodes{$node_name}; - if ($element->{'seen'}) - { - if ($element->{'with_section'}) - { - $element = $element->{'with_section'}; - } - if ($Texi2HTML::Config::AVOID_MENU_REDUNDANCY && ($descr ne '') && !$state->{'preformatted'}) - { - $descr = '' if (clean_text($element->{'name'}) eq clean_text($descr)); - } - } - return &$Texi2HTML::Config::menu_description($descr, $state); -} - -sub clean_text($) -{ - my $text = shift; - $text =~ s/[^\w]//g; - return $text; -} - -sub do_xref($$$$) -{ - my $macro = shift; - #my $text = shift; - my $args = shift; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - my $result = ''; - #$text =~ s/\s+/ /gos; # remove useless spaces and newlines - #my @args = split(/\s*,\s*/, $text); - my @args = @$args; - #print STDERR "DO_XREF: $macro\n"; - my $j = 0; - for ($j = 0; $j <= $#$args; $j++) - { - $args[$j] = normalise_space($args[$j]); - # print STDERR " ($j)$args[$j]\n"; - } - #$args[0] = normalise_space($args[0]); - $args[0] = '' if (!defined($args[0])); - my $node_texi = normalise_node($args[0]); - # a ref to a node in an info manual - if ($args[0] =~ s/^\(([^\)]+)\)\s*//) - { - if ($macro eq 'inforef') - { - $args[2] = $1 unless ($args[2]); - } - else - { - $args[3] = $1 unless ($args[3]); - } - } - if (($macro ne 'inforef') and $args[3]) - { - $node_texi = "($args[3])" . normalise_node($args[0]); - } - - if ($macro eq 'inforef') - { - if ((@args < 1) or ($args[0] eq '')) - { - echo_error ("Need a node name for \@$macro", $line_nr); - return ''; - } - if (@args > 3) - { - echo_warn ("Too much arguments for \@$macro", $line_nr); - } - $args[2] = '' if (!defined($args[2])); - $args[1] = '' if (!defined($args[1])); - $node_texi = "($args[2])$args[0]"; - } - - my $i; - my $new_state = duplicate_state($state); - $new_state->{'keep_texi'} = 0; - $new_state->{'keep_nr'} = 0; - for ($i = 0; $i < 5; $i++) - { - $args[$i] = substitute_line($args[$i], $new_state); - } - #print STDERR "(@args)\n"; - - if (($macro eq 'inforef') or ($args[3] ne '') or ($args[4] ne '')) - {# external ref - if ($macro eq 'inforef') - { - $macro = 'xref'; - $args[3] = $args[2]; - } - my $href = ''; - my $node_file = ''; - if ($args[3] ne '') - { - $href = do_external_href($node_texi); - $node_file = "($args[3])$args[0]"; - } - my $section = ''; - if ($args[4] ne '') - { - $section = $args[0]; - if ($args[2] ne '') - { - $section = $args[2]; - } - } - $result = &$Texi2HTML::Config::external_ref($macro, $section, $args[4], $node_file, $href, $args[1]); - } - else - { - my $element = $nodes{$node_texi}; - if ($element and $element->{'seen'}) - { - if ($element->{'with_section'}) - { - $element = $element->{'with_section'}; - } - my $file = ''; - if (defined($state->{'element'})) - { - $file = $state->{'element'}->{'file'}; - } - else - { - echo_warn ("\@$macro not in text (in anchor, node, section...)", $line_nr); - # if Texi2HTML::Config::SPLIT the file is '' which ensures a href with the file - # name. if ! Texi2HTML::Config::SPLIT the 2 file will be the same thus there - # won't be the file name - $file = $element->{'file'} unless ($Texi2HTML::Config::SPLIT); - } - #print STDERR "SUBHREF in ref `$node_texi': $_"; - my $href = href($element, $file); - my $section = $args[2]; - $section = $args[1] if ($section eq ''); - my $name = $section; - my $short_name = $section; - if ($section eq '') - { - $name = $element->{'name'}; - $short_name = $args[0]; - } - $result = &$Texi2HTML::Config::internal_ref ($macro, $href, $short_name, $name, $element->{'section'}); - } - else - { - if (($node_texi eq '') or !$novalidate) - { - echo_error ("Undefined node `$node_texi' in \@$macro", $line_nr); - my $text = ''; - for (my $i = 0; $i < @$args -1; $i++) - { - $text .= $args->[$i] .','; - } - $text .= $args->[-1]; - $result = "\@$macro"."{${text}}"; - } - else - { - $result = &$Texi2HTML::Config::external_ref($macro, '', '', $args[0], do_external_href($node_texi), $args[1]); - } - } - } - return $result; -} - -sub do_acronym_like($$$$$) -{ - my $command = shift; - my $args = shift; - my $acronym_texi = shift @$args; - my $explanation = shift @$args; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - my $explanation_lines; - my $explanation_text; - my $explanation_unformatted; - - if (defined($explanation)) - { - $explanation =~ s/^\s*//; - $explanation =~ s/\s*$//; - $explanation = undef if ($explanation eq ''); - } - $acronym_texi =~ s/^\s*//; - $acronym_texi =~ s/\s*$//; - - return '' if ($acronym_texi eq ''); - - my $with_explanation = 0; - my $normalized_text = cross_manual_line (normalise_node($acronym_texi)); - if (defined($explanation)) - { - $with_explanation = 1; - $acronyms_like{$command}->{$normalized_text} = $explanation; - } - elsif (exists($acronyms_like{$command}->{$normalized_text})) - { - $explanation = $acronyms_like{$command}->{$normalized_text}; - } - - if (defined($explanation)) - { - @$explanation_lines = map {$_ = $_."\n"} split (/\n/, $explanation); - my $text = ''; - foreach my $line(@$explanation_lines) - { - $line .= ' ' if (chomp ($line)); - $text .= $line - } - $text =~ s/ $//; - my $unformatted_state = duplicate_state($state); - $unformatted_state->{'unformatted'} = 1; - $explanation_unformatted = substitute_line($text, $unformatted_state); - $explanation_text = substitute_line($text, duplicate_state($state)); - } - return &$Texi2HTML::Config::acronym_like($command, $acronym_texi, substitute_line ($acronym_texi, duplicate_state($state)), - $with_explanation, $explanation_lines, $explanation_text, $explanation_unformatted); -} - -sub do_caption_shortcaption($$$$$) -{ - my $command = shift; - my $args = shift; - my $text = $args->[0]; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - if (!exists($state->{'float'})) - { -#dump_stack(\"", [], $state); - echo_error("\@$command outside of float", $line_nr); - return ''; - } - my $float = $state->{'float'}; - my @texi_lines = map {$_ = $_."\n"} split (/\n/, $text); - $float->{"${command}_texi"} = \@texi_lines; - return ''; -} - -sub do_float_line($$$$$) -{ - my $command = shift; - my $args = shift; - my @args = @$args; - my $style_texi = shift @args; - my $label_texi = shift @args; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - $style_texi = undef if (defined($style_texi) and $style_texi=~/^\s*$/); - $label_texi = undef if (defined($label_texi) and $label_texi=~/^\s*$/); - if (defined($label_texi)) - { - #my $id = cross_manual_line($label_texi); - $state->{'float'} = $nodes{normalise_node($label_texi)}; - #print STDERR "float: $state->{'float'}, $state->{'float'}->{'texi'}\n"; - } - else - { - $state->{'float'} = { 'float' => 1 }; - if (defined($style_texi)) - { - $state->{'float'}->{'style_texi'} = normalise_space($style_texi); - $state->{'float'}->{'style_id'} = cross_manual_line($style_texi); - $state->{'float'}->{'style'} = substitute_line($style_texi); - } - #print STDERR "float: (no label) $state->{'float'}\n"; - } - return ''; -} - -sub do_quotation_line($$$$$) -{ - my $command = shift; - my $args = shift; - my @args = @$args; - my $style_texi = shift @args; - my $text_texi = shift @args; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - my $text; - - $style_texi = undef if (defined($style_texi) and $style_texi=~/^\s*$/); - $text_texi = undef if (defined($text_texi) and $text_texi=~/^\s*$/); - if (defined($style_texi) and !defined($text_texi)) - { - $text_texi = $style_texi; - $style_texi = undef; - } - if (defined($text_texi)) - { - $text = substitute_line($text_texi, duplicate_state($state)); - $text =~ s/\s*$//; - } - my $quotation_args = { 'style_texi' => $style_texi, 'text' => $text, 'text_texi' => $text_texi }; - if (defined($style_texi)) - { - $quotation_args->{'style_id'} = cross_manual_line(normalize_space($style_texi)); - } - push @{$state->{'quotation_stack'}}, $quotation_args; - $state->{'prepend_text'} = &$Texi2HTML::Config::quotation_prepend_text($style_texi, $text_texi); - return ''; -} - -sub do_def_line($$$$$) -{ - my $command = shift; - my $args = shift; - my @args = @$args; - my $arguments = shift @args; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - $state->{'deff'}->{'arguments'} = $arguments; - return ''; -} - -sub do_footnote($$$$) -{ - my $command = shift; - my $args = shift; - my $text = $args->[0]; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - - $text .= "\n"; - $foot_num++; - $relative_foot_num++; - my $docid = "DOCF$foot_num"; - my $footid = "FOOT$foot_num"; - my $from_file = ''; - if ($state->{'element'} and $Texi2HTML::Config::SPLIT and $Texi2HTML::Config::SEPARATED_FOOTNOTES) - { - $from_file = $state->{'element'}->{'file'}; - } - my %state; - initialise_state (\%state); - if ($Texi2HTML::Config::SEPARATED_FOOTNOTES) - { - $state{'element'} = $footnote_element; - } - else - { - $state{'element'} = $state->{'element'}; - } - my $file = ''; - $file = $docu_foot if ($Texi2HTML::Config::SPLIT and $Texi2HTML::Config::SEPARATED_FOOTNOTES); - - # FIXME use split_lines ? It seems to work like it is now ? - my @lines = substitute_text(\%state, map {$_ = $_."\n"} split (/\n/, $text)); - my ($foot_lines, $foot_label) = &$Texi2HTML::Config::foot_line_and_ref ($foot_num, - $relative_foot_num, $footid, $docid, $from_file, $file, \@lines, $state); - push(@foot_lines, @{$foot_lines}); - return $foot_label; -} - -sub do_image($$$$) -{ - # replace images - my $command = shift; - my $args = shift; - my $text = $args->[0]; - my $style_stack = shift; - my $state = shift; - my $line_nr = shift; - $text =~ s/\s+/ /gos; # remove useless spaces and newlines - my @args = split (/\s*,\s*/, $text); - my $base = $args[0]; - if ($base eq '') - { - echo_error ("no file argument for \@image", $line_nr); - #warn "$ERROR no file argument for \@image\n"; - return ''; - } - $args[4] = '' if (!defined($args[4])); - $args[3] = '' if (!defined($args[3])); - my $image; - my $file_name; - $image = locate_include_file("$base.$args[4]") if (defined($args[4]) and ($args[4] ne '')); - if (defined($image)) - { - $file_name = "$base.$args[4]"; - } - elsif ($image = locate_include_file("$base.png")) - { - $file_name = "$base.png"; - } - elsif ($image = locate_include_file("$base.jpg")) - { - $file_name = "$base.jpg"; - } - elsif ($image = locate_include_file("$base.gif")) - { - $file_name = "$base.gif"; - } - else - { - $image = "$base.jpg"; - $image = "$base.$args[4]" if (defined($args[4]) and ($args[4] ne '')); - $file_name = $image; - echo_error ("no image file for $base, (using $image)", $line_nr); - #warn "$ERROR no image file for $base, (using $image) : $text\n"; - } # FIXME use full file name for alt instead of base when there is no - # alttext ? - if ($args[3] =~ /\S/) - { - # FIXME makeinfo don't do that. - $args[3] = do_text($args[3]); - $base = $args[3] if ($args[3] =~ /\S/); - } - return &$Texi2HTML::Config::image( - &$Texi2HTML::Config::protect_text($path_to_working_dir . $image), - &$Texi2HTML::Config::protect_text($base), - $state->{'preformatted'}, &$Texi2HTML::Config::protect_text($file_name)); -} - -sub duplicate_state($) -{ - my $state = shift; - my $new_state = { 'element' => $state->{'element'}, - 'preformatted' => $state->{'preformatted'}, - 'code_style' => $state->{'code_style'}, - 'keep_texi' => $state->{'keep_texi'}, - 'keep_nr' => $state->{'keep_nr'}, - 'preformatted_stack' => $state->{'preformatted_stack'} - }; - return $new_state; -} - -sub expand_macro($$$$$) -{ - my $name = shift; - my $args = shift; - my $end_line = shift; - my $line_nr = shift; - my $state = shift; - - my $index = 0; - foreach my $arg (@$args) - { # expand @macros in arguments - $args->[$index] = substitute_text({'texi' => 1, 'arg_expansion' => 1}, split_lines($arg)); - $index++; - } - my $macrobody = $macros->{$name}->{'Body'}; - my $formal_args = $macros->{$name}->{'Args'}; - my $args_index = $macros->{$name}->{'Args_index'}; - my $i; - - die "Bug end_line not defined" if (!defined($end_line)); - - for ($i=0; $i<=$#$formal_args; $i++) - { - $args->[$i] = "" unless (defined($args->[$i])); - print STDERR "# arg($i): $args->[$i]\n" if ($T2H_DEBUG & $DEBUG_MACROS); - } - echo_error ("too much arguments for macro $name", $line_nr) if (defined($args->[$i + 1])); - #warn "$ERROR too much arguments for macro $name" if (defined($args->[$i + 1])); - my $result = ''; - while ($macrobody) - { - if ($macrobody =~ s/^([^\\]*)\\//o) - { - $result .= $1 if defined($1); - if ($macrobody =~ s/^\\//) - { - $result .= '\\'; - } - elsif ($macrobody =~ s/^(\@end\sr?macro)$// or $macrobody =~ s/^(\@end\sr?macro\s)// or $macrobody =~ s/^(\@r?macro\s+\w+\s*.*)//) - { # \ protect @end macro - $result .= $1; - } - elsif ($macrobody =~ s/^([^\\]*)\\//) - { - my $arg = $1; - if (defined($args_index->{$arg})) - { - $result .= $args->[$args_index->{$arg}]; - } - else - { - warn "$ERROR \\ not followed by \\ or an arg but by $arg in macro\n"; - $result .= '\\' . $arg; - } - } - next; - } - $result .= $macrobody; - last; - } - #$result .= $end_line; - my @result = split(/^/m, $result); - #my $first_line = shift (@result); - if ($state->{'arg_expansion'}) - { - unshift @{$state->{'spool'}}, (@result, $end_line); - } - else - { - unshift @{$input_spool->{'spool'}}, (@result, $end_line); - $input_spool->{'macro'} = $name if ($input_spool->{'macro'} eq ''); - } - if ($T2H_DEBUG & $DEBUG_MACROS) - { - print STDERR "# macro expansion result:\n"; - #print STDERR "$first_line"; - foreach my $line (@result) - { - print STDERR "$line"; - } - print STDERR "# macro expansion result end\n"; - } - #return $first_line; -} - -sub do_index_summary_file($) -{ - my $name = shift; - my ($Pages, $Entries) = get_index($name); - &$Texi2HTML::Config::index_summary_file_begin ($name, $printed_indices{$name}); - #open(FHIDX, ">$docu_rdir$docu_name" . "_$name.idx") - # || die "Can't open > $docu_rdir$docu_name" . "_$name.idx for writing: $!\n"; - #print STDERR "# writing $name index summary in $docu_rdir$docu_name" . "_$name.idx...\n" if $T2H_VERBOSE; - print STDERR "# writing $name index summary\n" if $T2H_VERBOSE; - - foreach my $key (sort keys %$Entries) - { - #print FHIDX "$key\t$Entries->{$key}->{href}\n"; - my $entry = $Entries->{$key}; - my $label = $entry->{'element'}; - my $entry_element = $label; - # notice that we use the section associated with a node even when - # there is no with_section, i.e. when there is another node preceding - # the sectionning command. - # However when it is the Top node, we use the node instead. - # (for the Top node, 'section_ref' is himself, and 'as_section' is - # true) - $entry_element = $entry_element->{'section_ref'} if ($entry_element->{'node'} and $entry_element->{'section_ref'} and !$entry_element->{'section_ref'}->{'as_section'}); - my $origin_href = $entry->{'file'}; - #print STDERR "$entry $entry->{'entry'}, real elem $label->{'texi'}, section $entry_element->{'texi'}, real $label->{'file'}, entry file $entry->{'file'}\n"; - if ($entry->{'label'}) - { - $origin_href .= '#' . $entry->{'label'}; - } - else - { - # If the $label element and the $index entry are on the same - # file the label is prefered. If they aren't on the same file - # the entry id is choosed as it means that the label element - # and the index entry are separated by a printindex. - print STDERR "id undef ($entry) entry: $entry->{'entry'}, label: $label->{'text'}\n" if (!defined($entry->{'id'})); - if ($entry->{'file'} eq $label->{'file'}) - { - $origin_href .= '#' . $label->{'id'}; - } - else - { - $origin_href .= '#' . $entry->{'id'} ; - } - } - #print STDERR "SUBHREF in index summary file for $entry_element->{'texi'}\n"; - #print FHIDX '' . - &$Texi2HTML::Config::index_summary_file_entry ($name, - $key, $origin_href, - substitute_line($entry->{'entry'}), $entry->{'entry'}, - href($entry_element, ''), - $entry_element->{'text'}, - $printed_indices{$name}); - } - &$Texi2HTML::Config::index_summary_file_end ($name, $printed_indices{$name}); -} - -sub do_index_page($$;$) -{ - my $index_elements = shift; - my $nr = shift; - my $page = shift; - my $index_element = $index_elements->[$nr]; - my $summary = do_index_summary($index_element->{'element'}, $index_elements); - my $entries = do_index_entries($index_element->{'element'}, $index_element->{'page'}, $index_element->{'name'}); - return $summary . $entries . $summary; -} - -sub do_index_summary($$) -{ - my $element = shift; - my $index_elements = shift; - - my @letters; - my @symbols; - - for my $index_element_item (@$index_elements) - { - my $index_element = $index_element_item->{'element'}; - my $file = ''; - $file .= $index_element->{'file'} if ($index_element->{'file'} ne $element->{'file'}); - my $index = 0; - for my $letter (@{$index_element_item->{'page'}->{Letters}}) - { - if ($letter =~ /^[A-Za-z]/) - { - push @letters, &$Texi2HTML::Config::summary_letter($letter, $file, "$index_element->{'id'}" . "_$index"); - } - else - { - push @symbols, &$Texi2HTML::Config::summary_letter($letter, $file, "$index_element->{'id'}" . "_$index"); - } - $index++; - } - } - return &$Texi2HTML::Config::index_summary(\@letters, \@symbols); -} - -sub do_index_entries($$$) -{ - my $element = shift; - my $page = shift; - my $name = shift; - - my $letters = ''; - my $index = 0; - for my $letter (@{$page->{'Letters'}}) - { - my $entries = ''; - for my $entry (@{$page->{'EntriesByLetter'}->{$letter}}) - { - my $label = $entry->{'element'}; - my $entry_element = $label; - # notice that we use the section associated with a node even when - # there is no with_section, i.e. when there is another node preceding - # the sectionning command. - # However when it is the Top node, we use the node instead. - # (for the Top node, 'section_ref' is himself, and 'as_section' is - # true) - $entry_element = $entry_element->{'section_ref'} if ($entry_element->{'node'} and $entry_element->{'section_ref'} and !$entry_element->{'section_ref'}->{'as_section'}); - my $origin_href = ''; - $origin_href = $entry->{'file'} if ($Texi2HTML::Config::SPLIT and $entry->{'file'} ne $element->{'file'}); - #print STDERR "$entry $entry->{'entry'}, real elem $label->{'texi'}, section $entry_element->{'texi'}, real $label->{'file'}, entry file $entry->{'file'}\n"; - if ($entry->{'label'}) - { - $origin_href .= '#' . $entry->{'label'}; - } - else - { - # If the $label element and the $index entry are on the same - # file the label is prefered. If they aren't on the same file - # the entry id is choosed as it means that the label element - # and the index entry are separated by a printindex. - print STDERR "id undef ($entry) entry: $entry->{'entry'}, label: $label->{'text'}\n" if (!defined($entry->{'id'})); - if ($entry->{'file'} eq $label->{'file'}) - { - $origin_href .= '#' . $label->{'id'}; - } - else - { - $origin_href .= '#' . $entry->{'id'} ; - } - } - #print STDERR "SUBHREF in index for $entry_element->{'texi'}\n"; - $entries .= &$Texi2HTML::Config::index_entry ($origin_href, - substitute_line($entry->{'entry'}), - href($entry_element, $element->{'file'}), - $entry_element->{'text'}); - } - $letters .= &$Texi2HTML::Config::index_letter ($letter, "$element->{'id'}" . "_$index", $entries); - $index++; - } - return &$Texi2HTML::Config::print_index($letters, $name); -} - -# remove texi commands, replacing with what seems adequate. see simple_map_texi -# and texi_map. -# Doesn't protect html -sub remove_texi(@) -{ - return substitute_text ({ 'remove_texi' => 1, 'no_protection' => 1 }, @_); -} - -# Same as remove texi but protect text and use special maps for @-commands -sub unformatted_text($@) -{ - my $state = shift; - $state = {} if (!defined($state)); - $state->{'remove_texi'} = 1; - $simple_map_texi_ref = \%Texi2HTML::Config::unformatted_text_simple_map_texi; - $style_map_texi_ref = \%Texi2HTML::Config::unformatted_text_style_map_texi; - $texi_map_ref = \%Texi2HTML::Config::unformatted_text_texi_map; - my $text = substitute_text ($state, @_); - $simple_map_texi_ref = \%Texi2HTML::Config::simple_map_texi; - $style_map_texi_ref = \%Texi2HTML::Config::style_map_texi; - $texi_map_ref = \%Texi2HTML::Config::texi_map; - return $text; -} - -sub enter_table_index_entry($$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - if ($state->{'item'} and ($state->{'table_stack'}->[-1] =~ /^(v|f)table$/)) - { - my $index = $1; - my $macro = $state->{'item'}; - delete $state->{'item'}; - close_stack($text, $stack, $state, $line_nr, undef, 'index_item'); - my $item = pop @$stack; - my $element = $state->{'element'}; - $element = $state->{'node_ref'} unless ($element); - #print STDERR "enter_table_index_entry $item->{'text'}"; - enter_index_entry($index, $line_nr, $item->{'text'}, $state->{'place'}, $element, 0); - add_prev($text, $stack, "\@$macro" . $item->{'text'}); - } -} - -sub scan_texi($$$$;$) -{ - my $line = shift; - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - - die "stack not an array ref" unless (ref($stack) eq "ARRAY"); - local $_ = $line; - - while(1) - { - # scan_texi - #print STDERR "WHILE:$_"; - #dump_stack($text, $stack, $state); - - # In ignored region - if ($state->{'ignored'}) - { - my $line; - if (s/^(.*?\@end\s+$state->{'ignored'})//) - { - $line = $1; - if (s/^$// or s/(\s+)//) - { - $line = $line . $1 if (defined($1)); - } - elsif (/[^\@]/) - { - $_ .= $line; - $line = undef; - } - } - if (defined($line)) - { - delete $state->{'ignored'}; - #dump_stack($text, $stack, $state); - # MACRO_ARG => keep ignored text - if ($state->{'arg_expansion'}) - { - #add_prev ($text, $stack, $1); - add_prev ($text, $stack, $line); - next; - } - return if /^\s*$/o; - next; - } - add_prev ($text, $stack, $_) if ($state->{'arg_expansion'}); - return; - } - - # in macro definition - if (defined($state->{'macro'})) - { - if (s/^([^\\\@]*\\)//) - {# I believe it is correct, although makeinfo don't do that. - $state->{'macro'}->{'Body'} .= $1; - if (s/^\\//) - { - $state->{'macro'}->{'Body'} .= '\\'; - next; - } - elsif (s/^(\@end\sr?macro)$//o or s/^(\@end\sr?macro\s)//o - or s/^(\@r?macro\s+\w+\s*.*)//o) - { - $state->{'macro'}->{'Body'} .= $1; - next; - } - } - #if (s/^(.*?)\@end\sr?macro$//o or s/^(.*?)\@end\sr?macro\s+//o) - if (s/^(\@end\sr?macro)$//o or s/^(\@end\sr?macro\s+)//o) - { - $state->{'macro_inside'}--; - if ($state->{'macro_inside'}) - { - $state->{'macro'}->{'Body'} .= $1; - next; - } - #$state->{'macro'}->{'Body'} .= $1 if defined($1) ; - chomp $state->{'macro'}->{'Body'}; - print STDERR "# end macro def. Body:\n$state->{'macro'}->{'Body'}" - if ($T2H_DEBUG & $DEBUG_MACROS); - delete $state->{'macro'}; - return if (/^\s*$/); - next; - } - elsif(/^(\@r?macro\s+\w+\s*.*)/) - { - $state->{'macro'}->{'Body'} .= $_; - $state->{'macro_inside'}++; - return; - } - elsif (s/^\@(.)//) - { - $state->{'macro'}->{'Body'} .= '@' . $1; - next; - } - elsif (s/^\@//) - { - $state->{'macro'}->{'Body'} .= '@'; - next; - } - else - { - s/([^\@\\]*)//; - $state->{'macro'}->{'Body'} .= $1 if (defined($1)); - if (/^$/) - { - $state->{'macro'}->{'Body'} .= $_; - return; - } - next; - #$state->{'macro'}->{'Body'} .= $_ if defined($_) ; - #return; - } - } - # in macro arguments parsing/expansion - if (defined($state->{'macro_name'})) - { - my $special_chars = quotemeta ('\{}'); - my $multi_args = 0; - my $formal_args = $macros->{$state->{'macro_name'}}->{'Args'}; - $multi_args = 1 if ($#$formal_args >= 1); - $special_chars .= quotemeta(',') if ($multi_args); - if ($state->{'macro_args'}->[-1] eq '') - { - s/^\s*//o; - } - if (s/^([^$special_chars]*)([$special_chars])//) - { - $state->{'macro_args'}->[-1] .= $1 if defined($1); - # \ protects any character in macro arguments - if ($2 eq '\\') - { - print STDERR "# macro call: protected char\n" if ($T2H_DEBUG & $DEBUG_MACROS); - if (s/^(.)//) - { - $state->{'macro_args'}->[-1] .= $1; - } - else - { - $state->{'macro_args'}->[-1] .= '\\'; - } - } - elsif ($2 eq ',') - { # separate args - print STDERR "# macro call: new arg\n" if ($T2H_DEBUG & $DEBUG_MACROS); - s/^\s*//o; - push @{$state->{'macro_args'}}, ''; - } - elsif ($2 eq '}') - { # balanced } ends the macro call, otherwise it is in the arg - $state->{'macro_depth'}--; - if ($state->{'macro_depth'} == 0) - { - print STDERR "# expanding macro $state->{'macro_name'}\n" if ($T2H_DEBUG & $DEBUG_MACROS); - $_ = expand_macro($state->{'macro_name'}, $state->{'macro_args'}, $_, $line_nr, $state); - delete $state->{'macro_name'}; - delete $state->{'macro_depth'}; - delete $state->{'macro_args'}; - return; - } - else - { - print STDERR "# macro call: closing }\n" if ($T2H_DEBUG & $DEBUG_MACROS); - add_text('}', \$state->{'macro_args'}->[-1]); - } - } - elsif ($2 eq '{') - { - print STDERR "# macro call: opening {\n" if ($T2H_DEBUG & $DEBUG_MACROS); - $state->{'macro_depth'}++; - add_text('{', \$state->{'macro_args'}->[-1]); - } - next; - } - print STDERR "# macro call: end of line\n" if ($T2H_DEBUG & $DEBUG_MACROS); - $state->{'macro_args'}->[-1] .= $_; - return; - } - - # in a raw format, verbatim, tex or html - if ($state->{'raw'}) - { - my $tag = $state->{'raw'}; - - # debugging - if (! @$stack or ($stack->[-1]->{'style'} ne $tag)) - { - print STDERR "Bug: raw or special: $tag but not on top of stack\n"; - print STDERR "line: $_"; - dump_stack($text, $stack, $state); - exit 1; - } - - if (s/^(.*?)(\@end\s$tag)$// or s/^(.*?)(\@end\s$tag\s)//) - { - add_prev ($text, $stack, $1); - my $end = $2; - my $style = pop @$stack; - if ($style->{'text'} !~ /^\s*$/ or $state->{'arg_expansion'}) - { - my $after_macro = ''; - $after_macro = ' ' unless (/^\s*$/); - add_prev ($text, $stack, $style->{'text'} . $end . $after_macro); - delete $state->{'raw'}; - } - next; - } - else - { - add_prev ($text, $stack, $_); - last; - } - } - - # in a @verb{ .. } macro - if (defined($state->{'verb'})) - { - my $char = quotemeta($state->{'verb'}); - if (s/^(.*?)$char\}/\}/) - { - add_prev($text, $stack, $1 . $state->{'verb'}); - $stack->[-1]->{'text'} = $state->{'verb'} . $stack->[-1]->{'text'}; - delete $state->{'verb'}; - next; - } - else - { - add_prev($text, $stack, $_); - last; - } - } - - # an @end tag - if (s/^([^{}@]*)\@end(\s+)([a-zA-Z]\w*)//) - { - add_prev($text, $stack, $1); - my $space = $2; - my $end_tag = $3; - if (defined($state->{'text_macro_stack'}) - and @{$state->{'text_macro_stack'}} - and ($end_tag eq $state->{'text_macro_stack'}->[-1])) - { - pop @{$state->{'text_macro_stack'}}; - # we keep menu and titlepage for the following pass - if ((($end_tag eq 'menu') and $text_macros{'menu'}) or ($region_lines{$end_tag}) or $state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@end${space}$end_tag"); - } - else - { - #print STDERR "End $end_tag\n"; - #dump_stack($text, $stack, $state); - return if (/^\s*$/); - } - } - elsif ($text_macros{$end_tag}) - { - echo_error ("\@end $end_tag without corresponding element", $line_nr); - } - else - { - add_prev($text, $stack, "\@end${space}$end_tag"); - } - next; - } - elsif (s/^([^{}@]*)\@(["'~\@\}\{,\.!\?\s\*\-\^`=:\|\/])//o or s/^([^{}@]*)\@([a-zA-Z]\w*)([\s\{\}\@])/$3/o or s/^([^{}@]*)\@([a-zA-Z]\w*)$//o) - { - add_prev($text, $stack, $1); - my $macro = $2; - #print STDERR "MACRO $macro\n"; - $state->{'bye'} = 1 if ($macro eq 'bye'); - if (defined($Texi2HTML::Config::misc_command{$macro}) and - !$Texi2HTML::Config::misc_command{$macro}->{'texi'} - and $macro ne 'documentencoding') - { - my ($line, $args); - ($_, $line, $args) = preserve_command($_, $macro); - add_prev ($text, $stack, $line); - next; - } - # pertusus: it seems that value substitution are performed after - # macro argument expansions: if we have - # @set comma , - # and a call to a macro @macro {arg1 @value{comma} arg2} - # the macro arg is arg1 , arg2 and the comma don't separate - # args. Likewise it seems that the @value are not expanded - # in macro definitions - - # track variables - my $value_macro = 1; - if ($macro eq 'set' and s/^(\s+)($VARRE)(\s+)(.*)$//o) - { - if ($state->{'arg_expansion'}) - { - my $line = "\@$macro" . $1.$2.$3; - $line .= $4 if (defined($4)); - add_prev($text, $stack, $line); - next; - } - $value{$2} = $4; - } - elsif ($macro eq 'clear' and s/^(\s+)($VARRE)//o) - { - if ($state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@$macro" . $1 . $2); - next; - } - delete $value{$2}; - } - else - { - $value_macro = 0; - } - if ($value_macro) - { - return if (/^\s*$/); - next; - } - - if ($macro =~ /^r?macro$/) - { #FIXME what to do if 'arg_expansion' is true (ie within another - # macro call arguments ? - if (/^\s+(\w+)\s*(.*)/) - { - my $name = $1; - if (exists($macros->{$name})) - { - echo_warn ("macro `$name' allready defined " . - format_line_number($macros->{$name}->{'line_nr'}) . " redefined", $line_nr); - } - $state->{'macro_inside'} = 1; - my @args = (); - @args = split(/\s*,\s*/ , $1) - if ($2 =~ /^\s*{\s*(.*?)\s*}\s*/); - # keep the context information of the definition - $macros->{$name}->{'line_nr'} = { 'file_name' => $line_nr->{'file_name'}, - 'line_nr' => $line_nr->{'line_nr'}, 'macro' => $line_nr->{'macro'} } if (defined($line_nr)); - $macros->{$name}->{'Args'} = \@args; - my $arg_index = 0; - my $debug_msg = ''; - foreach my $arg (@args) - { # when expanding macros, the argument index is retrieved - # with Args_index - $macros->{$name}->{'Args_index'}->{$arg} = $arg_index; - $debug_msg .= "$arg($arg_index) "; - $arg_index++; - } - $macros->{$name}->{'Body'} = ''; - $state->{'macro'} = $macros->{$name}; - print STDERR "# macro def $name: $debug_msg\n" - if ($T2H_DEBUG & $DEBUG_MACROS); - } - else - { - echo_error ("Bad macro defintion $_", $line_nr); - #warn "$ERROR Bad macro defintion $_"; - } - return; - } - elsif (defined($text_macros{$macro})) - { - my $tag; - ($_, $tag) = do_text_macro ($macro, $_, $state, $line_nr); - # if it is a raw formatting command or a menu command - # we must keep it for later - my $macro_kept; - if ($state->{'raw'} or (($macro eq 'menu') and $text_macros{'menu'}) or (exists($region_lines{$macro})) or $state->{'arg_expansion'}) - { - add_prev($text, $stack, $tag); - $macro_kept = 1; - } - if ($state->{'raw'}) - { - push @$stack, { 'style' => $macro, 'text' => '' }; - } - next if $macro_kept; - #dump_stack ($text, $stack, $state); - return if (/^\s*$/); - } - elsif ($macro eq 'value') - { - if (s/^{($VARRE)}//) - { - if ($state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@$macro" . '{' . $1 . '}'); - next; - } - $_ = get_value($1) . $_; - } - else - { - if ($state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@$macro"); - next; - } - echo_error ("bad \@value macro", $line_nr); - #warn "$ERROR bad \@value macro"; - } - } - elsif ($macro eq 'definfoenclose') - { - if ($state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@$macro" . $_); - return; - } - if (s/^\s+([a-z]+)\s*,\s*([^\s]+)\s*,\s*([^\s]+)//) - { - $info_enclose{$1} = [ $2, $3 ]; - } - else - { - echo_error("Bad \@$macro", $line_nr); - } - return if (/^\s*$/); - s/^\s*//; - } - elsif ($macro eq 'include') - { - if ($state->{'arg_expansion'}) - { - add_prev($text, $stack, "\@$macro" . $_); - return; - } - #if (s/^\s+([\/\w.+-]+)//o) - if (s/^(\s+)(.*)//o) - { - my $file = locate_include_file($2); - if (defined($file)) - { - open_file($file, $line_nr); - print STDERR "# including $file\n" if $T2H_VERBOSE; - } - else - { - echo_error ("Can't find $2, skipping", $line_nr); - #warn "$ERROR Can't find $1, skipping\n"; - } - } - else - { - echo_error ("Bad include line: $_", $line_nr); - return; - } # makeinfo remove the @include but not the end of line - # FIXME verify if it is right - #return if (/^\s*$/); - } - elsif ($macro eq 'documentencoding') - { - if (s/(\s+)([0-9\w\-]+)//) - { - my $encoding = $2; - $Texi2HTML::Config::DOCUMENT_ENCODING = $encoding; - $from_encoding = set_encoding($encoding); - if (defined($from_encoding)) - { - foreach my $file (@fhs) - { - binmode($file->{'fh'}, ":encoding($from_encoding)"); - } - } - } - add_prev($text, $stack, "\@$macro" . $1 . $2); - } - elsif ($macro eq 'unmacro') - { #FIXME with 'arg_expansion' should it be passed unmodified ? - delete $macros->{$1} if (s/^\s+(\w+)//); - return if (/^\s*$/); - s/^\s*//; - } - elsif (exists($macros->{$macro})) - { - my $ref = $macros->{$macro}->{'Args'}; - # we remove any space/new line before the argument - if (s/^\s*{\s*//) - { - $state->{'macro_args'} = [ "" ]; - $state->{'macro_name'} = $macro; - $state->{'macro_depth'} = 1; - } - elsif ($#$ref >= 1) - { # no brace -> no arg - $_ = expand_macro ($macro, [], $_, $line_nr, $state); - return; - } - else - { # macro with one arg on the line - chomp $_; - $_ = expand_macro ($macro, [$_], "\n", $line_nr, $state); - return; - } - } - elsif ($macro eq ',') - {# the @, causes problems when `,' separates things (in @node, @ref) - $_ = "\@m_cedilla" . $_; - } - elsif (s/^{//) - { - if ($macro eq 'verb') - { - if (/^$/) - { - echo_error ("verb at end of line", $line_nr); - #warn "$ERROR verb at end of line"; - } - else - { - s/^(.)//; - $state->{'verb'} = $1; - } - } - push (@$stack, { 'style' => $macro, 'text' => '' }); - } - else - { - add_prev($text, $stack, "\@$macro"); - } - next; - } - #elsif(s/^([^{}@]*)\@(.)//o) - elsif(s/^([^{}@]*)\@([^\s\}\{\@]*)//o) - { - # No need to warn here it is done later - add_prev($text, $stack, $1 . "\@$2"); - next; - } - elsif (s/^([^{}]*)([{}])//o) - { - add_prev($text, $stack, $1); - if ($2 eq '{') - { - push @$stack, { 'style' => '', 'text' => '' }; - } - else - { - if (@$stack) - { - my $style = pop @$stack; - my $result; - if (($style->{'style'} ne '') and exists($info_enclose{$style->{'style'}}) and !$state->{'arg_expansion'}) - { - $result = $info_enclose{$style->{'style'}}->[0] . $style->{'text'} . $info_enclose{$style->{'style'}}->[1]; - } - elsif ($style->{'style'} ne '') - { - $result = '@' . $style->{'style'} . '{' . $style->{'text'} . '}'; - } - else - { - $result = '{' . $style->{'text'}; - # don't close { if we are closing stack as we are not - # sure this is a licit { ... } construct. - $result .= '}' unless ($state->{'close_stack'} or $state->{'arg_expansion'}); - } - add_prev ($text, $stack, $result); - #print STDERR "MACRO end $style->{'style'} remaining: $_"; - next; - } - else - { - # we warn in the last pass - #echo_error ("'}' without opening '{', before: $_", $line_nr); - #warn "$ERROR '}' without opening '{' line: $line"; - add_prev ($text, $stack, '}'); - } - } - } - else - { - #print STDERR "END_LINE $_"; - add_prev($text, $stack, $_); - last; - } - } - return 1; -} - -sub scan_structure($$$$;$) -{ - my $line = shift; - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - - die "stack not an array ref" unless (ref($stack) eq "ARRAY"); - local $_ = $line; - #print STDERR "SCAN_STRUCTURE: $line"; - #dump_stack ($text, $stack, $state); - if (!$state->{'raw'} and !$state->{'special'} and (!exists($state->{'region_lines'}))) - { - if (!$state->{'verb'} and $state->{'menu'} and /^\*/o) - { - # new menu entry - delete ($state->{'after_element'}); - my $menu_line = $_; - my $node; - if (/^\*\s+($NODERE)::/) - { - $node = $1; - } - elsif (/^\*\s+([^:]+):\s*([^\t,\.\n]+)[\t,\.\n]/) - { - #$name = $1; - $node = $2; - } - if ($node) - { - menu_entry_texi(normalise_node($node), $state, $line_nr); - } - } - if (/\S/ and !no_line($_)) - { - delete $state->{'after_element'}; - } - } - - while(1) - { - # scan structure - #print STDERR "WHILE\n"; - #dump_stack($text, $stack, $state); - - # as texinfo 4.5 - # verbatim might begin at another position than beginning - # of line, and end verbatim might too. To end a verbatim section - # @end verbatim must have exactly one space between end and verbatim - # things following end verbatim are not ignored. - # - # html might begin at another position than beginning - # of line, but @end html must begin the line, and have - # exactly one space. Things following end html are ignored. - # tex and ignore works like html - # - # ifnothtml might begin at another position than beginning - # of line, and @end ifnothtml might too, there might be more - # than one space between @end and ifnothtml but nothing more on - # the line. - # @end itemize, @end ftable works like @end ifnothtml. - # except that @item on the same line than @end vtable doesn't work - # - # text right after the itemize before an item is displayed. - # @item might be somewhere in a line. - # strangely @item on the same line than @end vtable doesn't work - # there should be nothing else than a command following @itemize... - # - # see more examples in formatting directory - - if ($state->{'raw'} or $state->{'special'}) - { - my $tag = $state->{'raw'}; - $tag = $state->{'special'} unless $tag; - if (! @$stack or ($stack->[-1]->{'style'} ne $tag)) - { - print STDERR "Bug: raw or special: $tag but not on top of stack\n"; - print STDERR "line: $_"; - dump_stack($text, $stack, $state); - exit 1; - } - if (s/^(.*?)\@end\s$tag$// or s/^(.*?)\@end\s$tag\s//) - { - add_prev ($text, $stack, $1); - my $style = pop @$stack; - if ($state->{'special'}) - { - delete $state->{'special'}; - if ($style->{'text'} !~ /^\s*$/) - { - add_prev ($text, $stack, do_special($style->{'style'}, $style->{'text'})); - } - - } - else - { - my $after_macro = ''; - $after_macro = ' ' unless (/^\s*$/); - add_prev ($text, $stack, $style->{'text'} . "\@end $state->{'raw'}" . $after_macro); - delete $state->{'raw'}; - } - unless (no_line($_)) - { - delete ($state->{'after_element'}); - } - next; - } - else - { - add_prev ($text, $stack, $_); - last unless ($state->{'special'}); - return; - } - } - - if (defined($state->{'verb'})) - { - my $char = quotemeta($state->{'verb'}); - if (s/^(.*?)$char\}/\}/) - { - add_prev($text, $stack, $1 . $state->{'verb'}); - $stack->[-1]->{'text'} = $state->{'verb'} . $stack->[-1]->{'text'}; - delete $state->{'verb'}; - next; - } - else - { - add_prev($text, $stack, $_); - last; - } - } - - unless (no_line($_)) - { - delete $state->{'after_element'}; - } - if (s/^([^{}@]*)\@end\s+([a-zA-Z]\w*)//) - { - add_prev($text, $stack, $1); - my $end_tag = $2; - $state->{'detailmenu'}-- if ($end_tag eq 'detailmenu' and $state->{'detailmenu'}); - if (defined($state->{'text_macro_stack'}) - and @{$state->{'text_macro_stack'}} - and ($end_tag eq $state->{'text_macro_stack'}->[-1])) - { - pop @{$state->{'text_macro_stack'}}; - if (exists($region_lines{$end_tag})) - { - print STDERR "Bug: end_tag $end_tag ne $state->{'region_lines'}->{'format'}" - if ( $end_tag ne $state->{'region_lines'}->{'format'}); - $state->{'region_lines'}->{'number'}--; - if ($state->{'region_lines'}->{'number'} == 0) - { - $state->{'after_element'} = 1; - delete $state->{'after_element'} unless - ($state->{'region_lines'}->{'after_element'}); - delete $state->{'region_lines'}->{'number'}; - delete $state->{'region_lines'}->{'format'}; - delete $state->{'region_lines'}->{'after_element'}; - delete $state->{'region_lines'}; - } - #dump_stack($text, $stack, $state); - } - if ($end_tag eq 'menu') - { - add_prev($text, $stack, "\@end $end_tag"); - $state->{'menu'}--; - } - else - { - #print STDERR "End $end_tag\n"; - #dump_stack($text, $stack, $state); - return if (/^\s*$/); - } - } - elsif ($text_macros{$end_tag}) - { - echo_error ("\@end $end_tag without corresponding element", $line_nr); - #dump_stack($text, $stack, $state); - } - else - { - if ($end_tag eq 'float' and $state->{'float'}) - { - delete $state->{'float'}; - } - elsif ($end_tag eq $state->{'table_stack'}->[-1]) - { - enter_table_index_entry($text, $stack, $state, $line_nr); - pop @{$state->{'table_stack'}}; - } - #add end tag - add_prev($text, $stack, "\@end $end_tag"); - } - next; - } - #elsif (s/^([^{}@]*)\@([a-zA-Z]\w*|["'~\@\}\{,\.!\?\s\*\-\^`=:\/])//o) - elsif (s/^([^{}@]*)\@(["'~\@\}\{,\.!\?\s\*\-\^`=:\|\/])//o or s/^([^{}@]*)\@([a-zA-Z]\w*)([\s\{\}\@])/$3/o or s/^([^{}@]*)\@([a-zA-Z]\w*)$//o) - { - add_prev($text, $stack, $1); - my $macro = $2; - #print STDERR "MACRO $macro\n"; - if (defined($Texi2HTML::Config::misc_command{$macro})) - { - my $line; - ($_, $line) = misc_command_structure($_, $macro, $state, - $line_nr); - add_prev ($text, $stack, $line); - next; - } - - if ($macro =~ /^(\w+?)index/ and ($1 ne 'print') and ($1 ne 'syncode') and ($1 ne 'syn') and ($1 ne 'def') and ($1 ne 'defcode')) - { - my $index_prefix = $1; - if (/^\s+(.*)/) - { - my $key = $1; - $_ = substitute_texi_line($_); - my $index_entry = enter_index_entry($index_prefix, $line_nr, $key, $state->{'place'}, $state->{'element'}, $state->{'after_element'}); - if ($index_entry) - { - add_prev ($text, $stack, "\@$macro" . $_); - last; - } - elsif (!defined($index_entry)) - { - echo_warn ("Bad index entry: $_", $line_nr); - #warn "$WARN Bad index entry: $_"; - } - } - else - { - echo_warn ("empty index entry", $line_nr); - #warn "$WARN empty index entry\n"; - } - return; - } - elsif (defined($text_macros{$macro})) - { - #print STDERR "TEXT_MACRO: $macro\n"; - if ($text_macros{$macro} eq 'special') - { - $state->{'special'} = $macro; - } - elsif ($text_macros{$macro} eq 'raw') - { - $state->{'raw'} = $macro; - #print STDERR "RAW\n"; - } - elsif ($format_type{$macro} and $format_type{$macro} eq 'menu') - { - $state->{'menu'}++; - delete ($state->{'prev_menu_node'}); - push @{$state->{'text_macro_stack'}}, $macro; - #print STDERR "MENU (text_macro_stack: @{$state->{'text_macro_stack'}})\n"; - } - elsif (exists($region_lines{$macro})) - { - if (exists($state->{'region_lines'}) and ($state->{'region_lines'}->{'format'} ne $macro)) - { - echo_error("\@$macro not allowed within $state->{'region_lines'}->{'format'}", $line_nr); - next; - } - if (!exists($state->{'region_lines'})) - { - $state->{'region_lines'}->{'format'} = $macro; - $state->{'region_lines'}->{'number'} = 1; - $state->{'region_lines'}->{'after_element'} = 1 if ($state->{'after_element'}); - } - else - { - $state->{'region_lines'}->{'number'}++; - } - push @{$state->{'text_macro_stack'}}, $macro; - } - # if it is a raw formatting command or a menu command - # we must keep it for later - my $macro_kept; - if ($state->{'raw'} or ($macro eq 'menu')) - { - add_prev($text, $stack, "\@$macro"); - $macro_kept = 1; - } - if ($state->{'raw'} or $state->{'special'}) - { - push @$stack, { 'style' => $macro, 'text' => '' }; - } - next if $macro_kept; - #dump_stack ($text, $stack, $state); - return if (/^\s*$/); - } - elsif (defined($Texi2HTML::Config::def_map{$macro})) - { - #We must enter the index entries - my ($prefix, $entry) = get_deff_index($macro, $_, $line_nr); - enter_index_entry($prefix, $line_nr, $entry, $state->{'place'}, $state->{'element'}, 0) if ($prefix and defined($entry)); - s/(.*)//; - add_prev($text, $stack, "\@$macro" . $1); - } - elsif ($macro =~ /^itemx?$/) - { - enter_table_index_entry($text, $stack, $state, $line_nr); - if ($state->{'table_stack'}->[-1] =~ /^(v|f)table$/) - { - $state->{'item'} = $macro; - push @$stack, { 'format' => 'index_item', 'text' => "" }; - } - else - { - add_prev($text, $stack, "\@$macro"); - } - } - elsif ($format_type{$macro} and ($format_type{$macro} eq 'table' or $format_type{$macro} eq 'list')) - { # We must enter the index entries of (v|f)table thus we track - # in which table we are - push @{$state->{'table_stack'}}, $macro; - add_prev($text, $stack, "\@$macro"); - } - elsif (s/^{//) - { - if ($macro eq 'verb') - { - if (/^$/) - { - # We allready warned in pass texi - #warn "$ERROR verb at end of line"; - } - else - { - s/^(.)//; - $state->{'verb'} = $1; - } - } - elsif ($macro eq 'footnote' and $Texi2HTML::Config::SEPARATED_FOOTNOTES) - { - $state->{'footnote_element'} = $state->{'element'}; - $state->{'footnote_place'} = $state->{'place'}; - $state->{'element'} = $footnote_element; - $state->{'place'} = $footnote_element->{'place'}; - } - push (@$stack, { 'style' => $macro, 'text' => '' }); - } - else - { - add_prev($text, $stack, "\@$macro"); - } - next; - } - #elsif(s/^([^{}@]*)\@(.)//o) - elsif(s/^([^{}@]*)\@([^\s\}\{\@]*)//o) - { - add_prev($text, $stack, $1 . "\@$2"); - next; - } - elsif (s/^([^{}]*)([{}])//o) - { - add_prev($text, $stack, $1); - if ($2 eq '{') - { - push @$stack, { 'style' => '', 'text' => '' }; - } - else - { - if (@$stack) - { - my $style = pop @$stack; - my $result; - if ($style->{'style'} eq 'anchor') - { - my $anchor = $style->{'text'}; - $anchor = normalise_node($anchor); - if ($nodes{$anchor}) - { - echo_error ("Duplicate node for anchor found: $anchor", $line_nr); - next; - } - $anchor_num++; - $nodes{$anchor} = { 'anchor' => 1, 'seen' => 1, 'texi' => $anchor, 'id' => 'ANC' . $anchor_num}; - push @{$state->{'place'}}, $nodes{$anchor}; - } - elsif ($style->{'style'} eq 'footnote') - { - if ($Texi2HTML::Config::SEPARATED_FOOTNOTES) - { - $state->{'element'} = $state->{'footnote_element'}; - $state->{'place'} = $state->{'footnote_place'}; - } - } - elsif ($style->{'style'} eq 'math' and $Texi2HTML::Config::L2H) - { - add_prev ($text, $stack, do_math($style->{'text'})); - next; - } - elsif ($style->{'style'} eq 'caption' or $style->{'style'} -eq 'shortcaption' and $state->{'float'}) - { - my @texi_lines = map {$_ = $_."\n"} split (/\n/, $style->{'text'}); - $state->{'float'}->{$style->{'style'} . "_texi"} = \@texi_lines; - } - if (($style->{'style'} eq 'titlefont') and ($style->{'text'} =~ /\S/)) - { - $state->{'element'}->{'titlefont'} = $style->{'text'} unless ((exists($state->{'region_lines'}) and ($state->{'region_lines'}->{'format'} eq 'titlepage')) or defined($state->{'element'}->{'titlefont'})) ; - } - if ($style->{'style'}) - { - $result = '@' . $style->{'style'} . '{' . $style->{'text'} . '}'; - } - else - { - $result = '{' . $style->{'text'}; - # don't close { if we are closing stack as we are not - # sure this is a licit { ... } construct. - $result .= '}' unless $state->{'close_stack'}; - } - add_prev ($text, $stack, $result); - #print STDERR "MACRO end $style->{'style'} remaining: $_"; - next; - } - else - { - # We warn in the last pass - #warn "$ERROR '}' without opening '{' line: $line"; - #echo_error ("'}' without opening '{' line: $line", $line_nr); - add_prev ($text, $stack, '}'); - } - } - } - else - { - #print STDERR "END_LINE $_"; - add_prev($text, $stack, $_); - enter_table_index_entry($text, $stack, $state, $line_nr); - last; - } - } - return 1; -} - -sub scan_line($$$$;$) -{ - my $line = shift; - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - - die "stack not an array ref" unless (ref($stack) eq "ARRAY"); - local $_ = $line; - #print STDERR "SCAN_LINE: $line"; - #dump_stack($text, $stack, $state ); - my $new_menu_entry; # true if there is a new menu entry - my $menu_description_in_format; # true if we are in a menu description - # but in another format section (@table....) - if (defined($state->{'prepend_text'})) - { - $_ = $state->{'prepend_text'} . $_; - $state->{'prepend_text'} = undef; - delete $state->{'prepend_text'}; - } - if (defined($state->{'end_of_line_protected'})) - { - #print STDERR "END_OF_LINE_PROTECTED, $_"; - #dump_stack($text, $stack, $state); - delete $state->{'end_of_line_protected'}; - } - if (!$state->{'raw'} and !$state->{'verb'} and $state->{'menu'}) - { # new menu entry - my ($node, $name, $ending); - if (s/^\*(\s+$NODERE)(::)//o) - { - $node = $1; - $ending = $2; - } - elsif (s/^\*(\s+[^:]+):(\s*[^\t,\.\n]+)([\t,\.\n])//o) - { - $name = $1; - $node = $2; - $ending = $3; - } - if ($node) - { - my $top_stack = top_stack($stack); - if ($top_stack and $top_stack->{'format'} and - ( - ($top_stack->{'format'} eq 'menu_description') or - ($top_stack->{'format'} eq 'menu') or - (($top_stack->{'format'} eq 'preformatted') and (stack_order($stack, 'preformatted', 'menu_comment'))) or - ($top_stack->{'format'} eq 'menu_preformatted') or - ($top_stack->{'format'} eq 'menu_comment') - ) - ) - { # we are in a normal menu state. - close_menu($text, $stack, $state, $line_nr); - $new_menu_entry = 1; - $state->{'menu_entry'} = { 'name' => $name, 'node' => $node, - 'ending' => $ending }; - add_prev ($text, $stack, do_menu_link($state, $line_nr)); - print STDERR "# New menu entry: $node\n" if ($T2H_DEBUG & $DEBUG_MENU); - push @$stack, {'format' => 'menu_description', 'text' => ''}; - } - else - { # we are within a macro or a format. In that case we use - # a simplified formatting of menu which should be right whatever - # the context - my $menu_entry = $state->{'menu_entry'}; - $state->{'menu_entry'} = { 'name' => $name, 'node' => $node, - 'ending' => $ending }; - add_prev ($text, $stack, do_menu_link($state, $line_nr, 1)); - $state->{'menu_entry'} = $menu_entry; - } - } - } - # we're in a menu entry description - if ($state->{'menu_entry'} and !$new_menu_entry) - { - my $top_stack = top_stack($stack); - if (/^\s+\S.*$/ or (!$top_stack->{'format'} or ($top_stack->{'format'} ne 'menu_description'))) - { # description continues - $menu_description_in_format = 1 if ($top_stack->{'format'} and ($top_stack->{'format'} ne 'menu_description')); - print STDERR "# Description continues\n" if ($T2H_DEBUG & $DEBUG_MENU); - #dump_stack ($text, $stack, $state); - } - else - { # enter menu comment after menu entry - if (!$top_stack->{'format'} or ($top_stack->{'format'} ne 'menu_description')) - { - print STDERR "Bug: begin menu comment but previous isn't menu_description\n"; - dump_stack ($text, $stack, $state); - } - print STDERR "# Menu comment begins\n" if ($T2H_DEBUG & $DEBUG_MENU); - #dump_stack ($text, $stack, $state); - my $descr = pop(@$stack); - add_prev ($text, $stack, menu_description($descr->{'text'}, $state)); - delete $state->{'menu_entry'}; - unless (/^\s*\@end\s+menu\b/) - { - $state->{'menu_comment'}++; - push @$stack, {'format' => 'menu_comment', 'text' => ''}; - push @{$state->{'preformatted_stack'}}, {'pre_style' => $Texi2HTML::Config::MENU_PRE_STYLE, 'class' => 'menu-comment' }; - $state->{'preformatted'}++; - begin_paragraph($stack, $state); - } - #dump_stack ($text, $stack, $state); - } - } - if ($state->{'open_paragraph'} and !$state->{'no_paragraph'}) - { - delete $state->{'open_paragraph'}; - if ($state->{'preformatted'} or !no_paragraph($state,$_)) - { - begin_paragraph($stack, $state); - } - } - if (($state->{'menu_entry'} and !$menu_description_in_format) or $state->{'raw'} or $state->{'preformatted'} or $state->{'no_paragraph'} or $state->{'keep_texi'} or $state->{'remove_texi'}) - { # empty lines are left unmodified - if (/^\s*$/) - { - add_prev($text, $stack, $_); - return; - } - else - { - my $next_tag = next_tag($_); - if ($state->{'deff'} and !defined($Texi2HTML::Config::def_map{$next_tag})) - { - begin_deff_item($stack, $state); - } - } - } - else - { #FIXME @syncodeindex cp fn - # on a line should also end paragraphs. - if (/^\s*$/) - { - #ignore the line if it just follows a deff - return if ($state->{'deff'}); - - if ($state->{'paragraph'}) - { # An empty line ends a paragraph - close_paragraph($text, $stack, $state, $line_nr); - add_prev($text, $stack, &$Texi2HTML::Config::empty_line($_)); - return 1; - } - else - { - add_prev($text, $stack, &$Texi2HTML::Config::empty_line($_)); - return 1; - } - } - else - { - #print STDERR "a line not empty and not in no paragraph format\n"; - my $next_tag = next_tag($_); - if ($state->{'deff'} and !defined($Texi2HTML::Config::def_map{$next_tag})) - { # finish opening the deff, as this is not a deff tag, it can't be - # a deff macro with x - begin_deff_item($stack, $state); - } - #print STDERR "NEXT_TAG $next_tag:$_"; - if (!no_paragraph($state,$_)) - { # index entries, @html and @* don't trigger new paragraph beginning - # otherwise we begin a new paragraph - #print STDERR "begin paragraph\n"; - begin_paragraph($stack, $state); - } - } - } - - while(1) - { - # scan_line - #print STDERR "WHILE: $_"; - #dump_stack($text, $stack, $state); - # we're in a raw format (html, tex if !L2H, verbatim) - if (defined($state->{'raw'})) - { - (dump_stack($text, $stack, $state), die "Bug for raw ($state->{'raw'})") if (! @$stack or ! ($stack->[-1]->{'style'} eq $state->{'raw'})); - if (s/^(.*?)\@end\s$state->{'raw'}$// or s/^(.*?)\@end\s$state->{'raw'}\s+//) - # don't protect html, it is done by Texi2HTML::Config::raw if needed - { - print STDERR "# end raw $state->{'raw'}\n" if ($T2H_DEBUG & $DEBUG_FORMATS); - add_prev ($text, $stack, $1); - my $style = pop @$stack; - if ($style->{'text'} !~ /^\s*$/) - { - if ($state->{'remove_texi'}) - { - add_prev ($text, $stack, $style->{'text'}); - } - elsif ($state->{'keep_texi'}) - { - add_prev ($text, $stack, $style->{'text'} . "\@end $state->{'raw'}"); - } - else - { - add_prev($text, $stack, &$Texi2HTML::Config::raw($style->{'style'}, $style->{'text'})); - } - } - if (!$state->{'keep_texi'} and !$state->{'remove_texi'}) - { - # reopen preformatted if it was interrupted by the raw format - # if raw format is html the preformatted wasn't interrupted - begin_paragraph($stack, $state) if ($state->{'preformatted'} and (!$Texi2HTML::Config::format_in_paragraph{$state->{'raw'}})); - delete $state->{'raw'}; - return if (/^\s*$/); - } - delete $state->{'raw'}; - next; - } - else - { - print STDERR "#within raw $state->{'raw'}:$_" if ($T2H_DEBUG & $DEBUG_FORMATS); - add_prev ($text, $stack, $_); - last; - } - } - - # we are within a @verb - if (defined($state->{'verb'})) - { - my $char = quotemeta($state->{'verb'}); - if (s/^(.*?)$char\}/\}/) - { - if ($state->{'keep_texi'}) - { - add_prev($text, $stack, $1 . $state->{'verb'}); - $stack->[-1]->{'text'} = $state->{'verb'} . $stack->[-1]->{'text'}; - } - elsif ($state->{'remove_texi'}) - { - add_prev($text, $stack, $1); - } - else - { - add_prev($text, $stack, do_text($1, $state)); - } - delete $state->{'verb'}; - next; - } - else - { - add_prev($text, $stack, $_); - last; - } - } - - # We handle now the end tags - if ($state->{'keep_texi'} and s/^([^{}@]*)\@end\s+([a-zA-Z]\w*)//) - { - my $end_tag = $2; - add_prev($text, $stack, $1 . "\@end $end_tag"); - next; - } - elsif ($state->{'remove_texi'} and s/^([^{}@]*)\@end\s+([a-zA-Z]\w*)//) - { - add_prev($text, $stack, $1); - next; - } - - if (s/^([^{}@,]*)\@end\s+([a-zA-Z]\w*)\s// or s/^([^{}@,]*)\@end\s+([a-zA-Z]\w*)$//) - { - add_prev($text, $stack, do_text($1, $state)); - my $end_tag = $2; - #print STDERR "END_MACRO $end_tag\n"; - #dump_stack ($text, $stack, $state); - - # First we test if the stack is not empty. - # Then we test if the end tag is a format tag. - # If so, we close the styles. - # We then close paragraphs and preformatted at top of the stack. - # We handle the end tag (even when it was not the tag which appears - # on the top of the stack; in that case we close anything - # until that element) - $state->{'detailmenu'}-- if ($end_tag eq 'detailmenu' and $state->{'detailmenu'}); - # FIXME handle in sub skip - next if (defined($Texi2HTML::Config::misc_command{"end $end_tag"})); - my $top_stack = top_stack($stack); - if (!$top_stack) - { - echo_error ("\@end $end_tag without corresponding opening", $line_nr); - add_prev($text, $stack, "\@end $end_tag"); - next; - } - - if (!$format_type{$end_tag}) - { - echo_warn ("Unknown \@end $end_tag", $line_nr); - #warn "$ERROR Unknown \@end $end_tag\n"; - add_prev($text, $stack, "\@end $end_tag"); - next; - } - unless ($Texi2HTML::Config::format_in_paragraph{$end_tag}) - { - close_paragraph($text, $stack, $state, $line_nr); - } - - $top_stack = top_stack($stack); - if (!$top_stack or (!defined($top_stack->{'format'}))) - { - echo_error ("\@end $end_tag without corresponding opening element", $line_nr); - add_prev($text, $stack, "\@end $end_tag"); - next; - } - # Warn if the format on top of stack is not compatible with the - # end tag, and find the end tag. - unless ( - ($top_stack->{'format'} eq $end_tag) - or - ( - ($format_type{$end_tag} eq 'menu') and - ( - ($top_stack->{'format'} eq 'menu_preformatted') or - ($top_stack->{'format'} eq 'menu_comment') or - ($top_stack->{'format'} eq 'menu_description') - ) - ) or - ( - ($end_tag eq 'multitable') and - ( - ($top_stack->{'format'} eq 'cell') or - ($top_stack->{'format'} eq 'null') - ) - ) or - ( - ($format_type{$end_tag} eq 'list' ) and - ($top_stack->{'format'} eq 'item') - ) or - ( - ( - ($format_type{$end_tag} eq 'table') and - ($end_tag ne 'multitable') - ) and - ( - ($top_stack->{'format'} eq 'term') or - ($top_stack->{'format'} eq 'line') - ) - ) or - ( - (defined($Texi2HTML::Config::def_map{$end_tag})) and - ($top_stack->{'format'} eq 'deff_item') - ) or - ( - ($end_tag eq 'row') and - ($top_stack->{'format'} eq 'cell') - ) - ) - { - my $waited_format = $top_stack->{'format'}; - $waited_format = $fake_format{$top_stack->{'format'}} if ($format_type{$top_stack->{'format'}} eq 'fake'); - echo_error ("waiting for end of $waited_format, found \@end $end_tag", $line_nr); - close_stack($text, $stack, $state, $line_nr, undef, $end_tag); - # an empty preformatted may appear when closing things as - # when closed, formats reopen the preformatted environment - # in case there is some text following, but we know it isn't - # the case here, thus we can close paragraphs. - close_paragraph($text, $stack, $state); - my $new_top_stack = top_stack($stack); - next unless ($new_top_stack and defined($new_top_stack->{'format'}) and (($new_top_stack->{'format'} eq $end_tag) - or (($format_type{$new_top_stack->{'format'}} eq 'fake') and ($fake_format{$new_top_stack->{'format'}} eq $format_type{$end_tag})))); - } - # We should now be able to handle the format - if (defined($format_type{$end_tag}) and $format_type{$end_tag} ne 'fake') - { - end_format($text, $stack, $state, $end_tag, $line_nr); - } - else - { # this is a fake format, ie a format used internally, inside - # a real format. We do nothing, hoping the real format will - # get closed, closing the fake internal formats - #print STDERR "FAKE \@end $end_tag\n"; - #add_prev($text, $stack, "\@end $end_tag"); - } - next; - } - # This is a macro - #elsif (s/^([^{}@]*)\@([a-zA-Z]\w*|["'~\@\}\{,\.!\?\s\*\-\^`=:\/])//o) - elsif (s/^([^{},@]*)\@(["'~\@\}\{,\.!\?\s\*\-\^`=:\|\/])//o or s/^([^{}@,]*)\@([a-zA-Z]\w*)([\s\{\}\@])/$3/o or s/^([^{},@]*)\@([a-zA-Z]\w*)$//o) - { - add_prev($text, $stack, do_text($1, $state)); - my $macro = $2; - #print STDERR "MACRO $macro\n"; - #dump_stack ($text, $stack, $state); - # This is a macro added by close_stack to mark paragraph end - if ($macro eq 'end_paragraph') - { - my $top_stack = top_stack($stack); - if (!$top_stack or !$top_stack->{'format'} - or ($top_stack->{'format'} ne 'paragraph')) - { - print STDERR "Bug: end_paragraph but no paragraph to end\n"; - dump_stack ($text, $stack, $state); - next; - } - s/^\s//; - my $paragraph = pop @$stack; - add_prev ($text, $stack, do_paragraph($paragraph->{'text'}, $state)); - next; - } - # Handle macro added by close_stack to mark preformatted region end - elsif ($macro eq 'end_preformatted') - { - my $top_stack = top_stack($stack); - if (!$top_stack or !$top_stack->{'format'} - or ($top_stack->{'format'} ne 'preformatted')) - { - print STDERR "Bug: end_preformatted but no preformatted to end\n"; - dump_stack ($text, $stack, $state); - next; - } - my $paragraph = pop @$stack; - s/^\s//; - add_prev ($text, $stack, do_preformatted($paragraph->{'text'}, $state)); - next; - } - if (defined($Texi2HTML::Config::misc_command{$macro})) - { - # This strange condition is there because for an argument - # appearing on an @itemize line, appended to an @item - # we don't want to keep @c or @comment as otherwise it eats - # the line. Other commands could do that too but then the user - # deserves what he gets. - if (($state->{'keep_texi'} and - (!$state->{'check_item'} or ($macro ne 'c' and $macro ne 'comment'))) - or $state->{'remove_texi'}) - { - my ($line, $args); - ($_, $line, $args) = preserve_command($_, $macro); - if ($state->{'keep_texi'}) - { - add_prev($text, $stack, $line); - } - next; - } - my $keep = $Texi2HTML::Config::misc_command{$macro}->{'keep'}; - $_ = misc_command_text($_, $macro, $stack, $state, $text, $line_nr); - return unless (defined($_)); - unless ($keep) - { - begin_paragraph($stack, $state) if - (!no_paragraph($state,$_)); - next; - } - } -# if ($macro eq 'sp') -# { -# my ($space1, $sp_number, $space2); -# if (s/^(\s+)(\d+)(\s*)//) -# { -# $space1 = $1; -# $sp_number = $2; -# $space2 = $3; -# } -# elsif (s/(\s*)$//) -# { -# $space1 = $1; -# $sp_number = ''; -# $space2 = ''; -# } -# else -# { -# next if ($state->{'remove_texi'}); -# if ($state->{'keep_texi'}) -# { -# add_prev($text, $stack, "\@$macro"); -# next; -# } -# echo_error ("\@$macro needs a numeric arg or no arg", $line_nr); -# next; -# } -# next if ($state->{'remove_texi'}); -# if ($state->{'keep_texi'}) -# { -# add_prev($text, $stack, "\@$macro" . $space1 . $sp_number . $space2); -# next; -# } -# $sp_number = 1 if ($sp_number eq ''); -# add_prev($text, $stack, &$Texi2HTML::Config::sp($sp_number, $state->{'preformatted'})); -# next; -# } - #if ($macro eq 'verbatiminclude' or $macro eq 'listoffloats') - if ($macro eq 'listoffloats') - { - if ($state->{'keep_texi'}) - { - if (s/(.*)//o) - { - add_prev($text, $stack, "\@$macro" . $1); - } - next; - } - return undef if ($state->{'remove_texi'}); - - if (s/^(\s+)(.*)//o) - { - my $arg = $2; -# if ($macro eq 'verbatiminclude') -# { -# my $file = locate_include_file($arg); -# if (defined($file)) -# { -# if (!open(VERBINCLUDE, $file)) -# { -# echo_warn ("Can't read file $file: $!",$line_nr); -# } -# else -# { -# my $verb_text = ''; -# while (my $line = <VERBINCLUDE>) -# { -# $verb_text .= $line; -# } -# add_prev($text, $stack, &$Texi2HTML::Config::raw('verbatim',$verb_text)); -# close VERBINCLUDE; -# } -# } -# else -# { -# echo_error ("Can't find $arg, skipping", $line_nr); -# } -# } -# elsif ($macro eq 'listoffloats') -# { - my $style_id = cross_manual_line (normalise_space($arg)); - my $style = substitute_line (&$Texi2HTML::Config::listoffloats_style($arg)); - if (exists ($floats{$style_id})) - { - close_paragraph($text, $stack, $state, $line_nr); - my @listoffloats_entries = (); - foreach my $float (@{$floats{$style_id}->{'floats'}}) - { - my $float_style = substitute_line(&$Texi2HTML::Config::listoffloats_float_style($arg, $float)); - my $caption_lines = &$Texi2HTML::Config::listoffloats_caption($float); - my $caption = substitute_text({ 'multiple_pass' => 1 }, @$caption_lines); - push @listoffloats_entries, &$Texi2HTML::Config::listoffloats_entry($arg, $float, $float_style, $caption, href($float, $state->{'element'}->{'file'})); - } - add_prev($text, $stack, &$Texi2HTML::Config::listoffloats($arg, $style, \@listoffloats_entries)); - } - else - { - echo_warn ("Unknown float style $arg", $line_nr); - } -# } - } - else - { - echo_error ("Bad \@$macro line: $_", $line_nr); - } - return undef; - } - # This is a @macroname{...} construct. We add it on top of stack - # It will be handled when we encounter the '}' - if (s/^{//) - { - if ($macro eq 'verb') - { - if (/^$/) - { - # Allready warned - #warn "$ERROR verb at end of line"; - } - else - { - s/^(.)//; - $state->{'verb'} = $1; - } - } #FIXME what to do if remove_texi and anchor/ref/footnote ? - elsif ($macro eq 'm_cedilla' and !$state->{'keep_texi'}) - { - $macro = ','; - } - push (@$stack, { 'style' => $macro, 'text' => '', 'arg_nr' => 0 }); - $state->{'no_paragraph'}++ if ($no_paragraph_macro{$macro}); - open_arg($macro, 0, $state); - push (@{$state->{'style_stack'}}, $macro) if (defined($style_type{$macro}) and (($style_type{$macro} eq 'style') or ($style_type{$macro} eq 'accent'))); - next; - } - - # special case if we are checking items - - if ($state->{'check_item'} and ($macro =~ /^itemx?$/ or $macro eq 'headitem')) - { - echo_error("\@$macro on \@$state->{'check_item'} line", $line_nr); - next; - } - - # if we're keeping texi unmodified we can do it now - if ($state->{'keep_texi'}) - { - # We treat specially formats accepting {} on command line - if ($macro eq 'multitable' or defined($Texi2HTML::Config::def_map{$macro})) - { - add_prev($text, $stack, "\@$macro" . $_); - $_ = ''; - next; - } - # @ at the end of line may protect te end of line even when - # keeping texi - if ($macro eq "\n") - { - $state->{'end_of_line_protected'} = 1; - #print STDERR "PROTECTING END OF LINE\n"; - } - - add_prev($text, $stack, "\@$macro"); - if ($text_macros{$macro} and $text_macros{$macro} eq 'raw') - { - $state->{'raw'} = $macro; - push (@$stack, {'style' => $macro, 'text' => ''}); - } - next; - } - # If we are removing texi, the following macros are not removed - # as is but modified - - # a raw macro beginning - if ($text_macros{$macro} and $text_macros{$macro} eq 'raw') - { - if (!$Texi2HTML::Config::format_in_paragraph{$macro}) - { # close paragraph before verbatim (and tex if !L2H) - close_paragraph($text, $stack, $state, $line_nr); - } - $state->{'raw'} = $macro; - push (@$stack, {'style' => $macro, 'text' => ''}); - return if (/^\s*$/); - next; - } - my $simple_macro = 1; - # An accent macro - if (exists($Texi2HTML::Config::accent_map{$macro})) - { - if (s/^(\S)//o) - { - add_prev($text, $stack, do_simple($macro, $1, $state, [ $1 ], $line_nr)); - } - else - { # The accent is at end of line - add_prev($text, $stack, do_text($macro, $state)); - } - } - # an @-command which should be like @command{}. We handle it... - elsif ($things_map_ref->{$macro}) - { - echo_warn ("$macro requires {}", $line_nr); - add_prev($text, $stack, do_simple($macro, '', $state)); - } - # an @-command like @command - elsif (defined($simple_map_ref->{$macro})) - { - add_prev($text, $stack, do_simple($macro, '', $state)); - } - else - { - $simple_macro = 0; - } - if ($simple_macro) - {# if the macro didn't triggered a paragraph start it might now - begin_paragraph($stack, $state) if - ($no_line_macros{$macro} and !no_paragraph($state,$_)); - next; - } - # the following macros are not modified but just ignored - # if we are removing texi - if ($macro =~ /^tex_(\d+)$/o) - { - add_prev($text, $stack, Texi2HTML::LaTeX2HTML::do_tex($1)); - next; - } - if ($state->{'remove_texi'}) - { - if ((($macro =~ /^(\w+?)index$/) and ($1 ne 'print')) or - ($macro eq 'itemize') or ($macro =~ /^(|v|f)table$/) - or ($macro eq 'multitable') or ($macro eq 'quotation')) - { - return; - } - elsif ($macro eq 'enumerate') - { - my $spec; - ($_, $spec) = parse_enumerate ($_); - return if (/^\s*$/); - next; - } - elsif (defined($Texi2HTML::Config::def_map{$macro})) - { - my ($style, $category, $name, $type, $class, $arguments); - ($style, $category, $name, $type, $class, $arguments) = parse_def($macro, $_, $line_nr); - # FIXME maybe a call to substitute_line with state would - # be better ? - $category = remove_texi($category) if (defined($category)); - # FIXME -- --- ''... should be protected (not by makeinfo) - $name = remove_texi($name) if (defined($name)); - # FIXME -- --- ''... should be protected (not by makeinfo) - $type = remove_texi($type) if (defined($type)); - # FIXME -- --- ''... should be protected (not by makeinfo) - $class = remove_texi($class) if (defined($class)); - # FIXME -- --- ''... should be protected - $arguments = remove_texi($arguments) if (defined($arguments)); - chomp($arguments); - add_prev($text, $stack, &$Texi2HTML::Config::def_line_no_texi($category, $name, $type, $arguments)); - return; - } - next; - } - if (($macro =~ /^(\w+?)index$/) and ($1 ne 'print')) - { - add_prev($text, $stack, do_index_entry_label($state,$line_nr)); - return; - } - # a macro which triggers paragraph closing - if ($macro eq 'insertcopying') - { - close_paragraph($text, $stack, $state, $line_nr); - add_prev($text, $stack, do_insertcopying($state)); - # reopen a preformatted format if it was interrupted by the macro - begin_paragraph ($stack, $state) if ($state->{'preformatted'}); - return; - } - if ($macro =~ /^itemx?$/ or ($macro eq 'headitem')) - { - #print STDERR "ITEM: $_"; - #dump_stack($text, $stack, $state); - # these functions return true if the context was their own - abort_empty_preformatted($stack, $state); - # FIXME let the user be able not to close the paragraph - close_paragraph($text, $stack, $state, $line_nr); - my $format; - if ($format = add_item($text, $stack, $state, $line_nr, $_)) - { # handle lists - } - elsif ($format = add_term($text, $stack, $state, $line_nr)) - {# handle table - } - elsif ($format = add_line($text, $stack, $state, $line_nr)) - {# handle table - } - if ($format) - { - if (defined($format->{'appended'})) - { - $_ = $format->{'appended'} . ' ' . $_ if ($format->{'appended'} ne ''); - } - if (defined($format->{'command'})) - { - open_arg($format->{'command'},0, $state); - } - next; - } - $format = add_row ($text, $stack, $state, $line_nr); # handle multitable - unless ($format) - { - echo_warn ("\@$macro outside of table or list", $line_nr); - next; - } - push @$stack, {'format' => 'row', 'text' => '', 'item_cmd' => $macro }; - if ($format->{'max_columns'}) - { - push @$stack, {'format' => 'cell', 'text' => ''}; - $format->{'cell'} = 1; - - if (!no_paragraph($state,$_) or automatic_preformatted($state,$macro)) - { - begin_paragraph($stack, $state); - } - } - else - { - echo_warn ("\@$macro in empty multitable", $line_nr); - } - next; - } - if ($macro eq 'tab') - { - # FIXME let the user be able not to close the paragraph - abort_empty_preformatted($stack, $state); - close_paragraph($text, $stack, $state, $line_nr); - my $format = add_cell ($text, $stack, $state); - #print STDERR "tab, $format->{'cell'}, max $format->{'max_columns'}\n"; - if (!$format) - { - echo_warn ("\@tab outside of multitable", $line_nr); - #warn "$WARN \@tab outside of multitable\n"; - } - elsif (!$format->{'max_columns'}) - { - echo_warn ("\@$macro in empty multitable", $line_nr); - #warn "$WARN \@$macro in empty multitable\n"; - push @$stack, {'format' => 'null', 'text' => ''}; - next; - } - elsif ($format->{'cell'} > $format->{'max_columns'}) - { - echo_warn ("too much \@$macro (multitable has only $format->{'max_columns'} column(s))", $line_nr); - #warn "$WARN cell over table width\n"; - push @$stack, {'format' => 'null', 'text' => ''}; - next; - } - else - { - push @$stack, {'format' => 'cell', 'text' => ''}; - } - if (!no_paragraph($state,$_) or automatic_preformatted($state,$macro)) - { - begin_paragraph($stack, $state); - } - next; - } - # Macro opening a format (table, list, deff, example...) - if ($format_type{$macro} and ($format_type{$macro} ne 'fake')) - { - unless ($Texi2HTML::Config::format_in_paragraph{$macro}) - { - close_paragraph($text, $stack, $state, $line_nr); - } - #print STDERR "begin $macro\n"; - # A deff like macro - if (defined($Texi2HTML::Config::def_map{$macro})) - { - if ($state->{'deff'} and ("$state->{'deff'}->{'command'}x" eq $macro)) - { - $macro =~ s/x$//o; - #print STDERR "DEFx $macro\n"; - } - else - { - # The previous @def command isn't the same @def - # command. We begin the item for the previous @def - # command and immediatly open the new one. - begin_deff_item($stack, $state, 1) if ($state->{'deff'}); - $macro =~ s/x$//o; - #print STDERR "DEF begin $macro\n"; - push @$stack, { 'format' => $macro, 'text' => '' }; - } - #print STDERR "BEGIN_DEFF $macro\n"; - #dump_stack ($text, $stack, $state); - $state->{'deff'}->{'command'} = $macro; - my ($style, $category, $name, $type, $class, $arguments); - #($style, $category, $name, $type, $class, $arguments) = parse_def($macro, $_, $line_nr); - ($style, $category, $name, $type, $class, $_) = parse_def($macro, $_, $line_nr); - #print STDERR "AFTER parse_def $_"; - # duplicate_state ? - #$category = substitute_line($category) if (defined($category)); - $state->{'deff'}->{'style'} = $style; - $state->{'deff'}->{'category'} = substitute_line($category) if (defined($category)); - # FIXME -- --- ''... should be protected (not by makeinfo) - #$name = substitute_line($name) if (defined($name)); - $state->{'deff'}->{'name'} = substitute_line($name) if (defined($name)); - # FIXME -- --- ''... should be protected (not by makeinfo) - #$type = substitute_line($type) if (defined($type)); - $state->{'deff'}->{'type'} = substitute_line($type) if (defined($type)); - # FIXME -- --- ''... should be protected (not by makeinfo) - #$class = substitute_line($class) if (defined($class)); - $state->{'deff'}->{'class'} = substitute_line($class) if (defined($class)); - # FIXME -- --- ''... should be protected - open_cmd_line($stack, $state, ['keep'], \&do_def_line); - next; - #$arguments = substitute_line($arguments) if (defined($arguments)); - #$category = &$Texi2HTML::Config::definition_category($category, $class, $style); - #if (! $category) # category cannot be 0 - #{ - # echo_warn("Bad definition line $_", $line_nr); - # return; - #} - #my $index_label = main::do_index_entry_label ($state) if ($name ne ''); - #add_prev ($text, $stack, &$Texi2HTML::Config::def_line($category, $name, $type, $arguments, $index_label)); - #return; - } - elsif ($format_type{$macro} eq 'menu') - { - # if we are allready in a menu we must close it first - # in order to close the menu comments and entries - close_menu($text, $stack, $state, $line_nr); - $state->{'menu'}++; - push @$stack, { 'format' => $macro, 'text' => '' }; - if ($state->{'preformatted'}) - { - # Start a fake complex format in order to have a given pre style - $state->{'preformatted'}++; - push @$stack, { 'format' => 'menu_preformatted', 'text' => '', 'pre_style' => $Texi2HTML::Config::MENU_PRE_STYLE }; - push @{$state->{'preformatted_stack'}}, {'pre_style' => $Texi2HTML::Config::MENU_PRE_STYLE, 'class' => 'menu-preformatted' }; - } - } - elsif (exists ($Texi2HTML::Config::complex_format_map->{$macro})) - { - $state->{'preformatted'}++; - my $format = { 'format' => $macro, 'text' => '', 'pre_style' => $Texi2HTML::Config::complex_format_map->{$macro}->{'pre_style'} }; - push @{$state->{'preformatted_stack'}}, {'pre_style' =>$Texi2HTML::Config::complex_format_map->{$macro}->{'pre_style'}, 'class' => $macro }; - push @$stack, $format; - unless ($Texi2HTML::Config::format_in_paragraph{$macro}) - { - begin_paragraph($stack, $state); - } - } - elsif ($Texi2HTML::Config::paragraph_style{$macro}) - { - # if there are only spaces after the @center, then the end - # of line has allready been removed and the code triggered - # by end of line for @center closing won't be called. - # thus we don't open it (opening @center means pushing it - # on the paragraph_style stack) - next if (($macro eq 'center') and /^\s*$/); - push @{$state->{'paragraph_style'}}, $macro; - push (@$stack, { 'format' => $macro, 'text' => '' }) unless ($macro eq 'center'); - if (!no_paragraph($state,$_) or automatic_preformatted($state,$macro)) - { - begin_paragraph($stack, $state); - } - } - elsif (($format_type{$macro} eq 'list') or ($format_type{$macro} eq 'table')) - { - my $format; - #print STDERR "BEGIN $macro\n"; - #dump_stack($text, $stack, $state); - if (($macro eq 'itemize') or ($macro =~ /^(|v|f)table$/)) - { - my $command; - my $appended; - ($appended, $command) = parse_format_command($_,$macro); - $format = { 'format' => $macro, 'text' => '', 'command' => $command, 'appended' => $appended, 'term' => 0 }; - $_ = ''; - } - elsif ($macro eq 'enumerate') - { - my $spec; - ($_, $spec) = parse_enumerate ($_); - $spec = 1 if (!defined($spec)); - $format = { 'format' => $macro, 'text' => '', 'spec' => $spec, 'item_nr' => 0 }; - } - elsif ($macro eq 'multitable') - { - my $max_columns = parse_multitable ($_, $line_nr); - if (!$max_columns) - { - echo_warn ("empty multitable", $line_nr); - #warn "$WARN empty multitable\n"; - $max_columns = 0; - } - $format = { 'format' => $macro, 'text' => '', 'max_columns' => $max_columns, 'cell' => 1 }; - } - $format->{'first'} = 1; - $format->{'paragraph_number'} = 0; - push @$stack, $format; - push @{$state->{'format_stack'}}, $format; - if ($macro =~ /^(|v|f)table$/) - { - push @$stack, { 'format' => 'line', 'text' => ''}; - } - elsif ($macro eq 'multitable') - { - if ($format->{'max_columns'}) - { - push @$stack, { 'format' => 'row', 'text' => '', 'item_cmd' => $macro }; - push @$stack, { 'format' => 'cell', 'text' => ''}; - } - else - { - # multitable without row... We use the special null - # format which content is ignored - push @$stack, { 'format' => 'null', 'text' => ''}; - push @$stack, { 'format' => 'null', 'text' => ''}; - } - } - if ($format_type{$macro} eq 'list') - { - push @$stack, { 'format' => 'item', 'text' => ''}; - } - if (($macro ne 'multitable') and - !no_paragraph($state,$_) or automatic_preformatted($state,$macro)) - { - begin_paragraph($stack, $state); - } - return if ($format_type{$macro} eq 'table' or $macro eq 'itemize'); - } - elsif ($macro eq 'float' or $macro eq 'quotation') - { - push @$stack, {'format' => $macro, 'text' => '' }; - if ($macro eq 'float') - { - open_cmd_line($stack, $state, ['keep','keep'], \&do_float_line); - } - elsif ($macro eq 'quotation') - { - open_cmd_line($stack, $state, ['keep','keep'], \&do_quotation_line); - } - #print STDERR "Begin cmd_line\n"; - #dump_stack($text, $stack, $state); - next; - } - # keep this one at the end as there are some other formats - # which are also in format_map - elsif (defined($Texi2HTML::Config::format_map{$macro}) or ($format_type{$macro} eq 'cartouche')) - { - push @$stack, { 'format' => $macro, 'text' => '' }; - if (!no_paragraph($state,$_) or automatic_preformatted($state,$macro)) - { - begin_paragraph($stack, $state); - } - } - return if (/^\s*$/); - next; - } - $_ = do_unknown ($macro, $_, $text, $stack, $state, $line_nr); - next; - } - elsif(s/^([^{}@,]*)\@([^\s\}\{\@]*)//o) - { # A macro with a character which shouldn't appear in macro name - add_prev($text, $stack, do_text($1, $state)); - $_ = do_unknown ($2, $_, $text, $stack, $state, $line_nr); - #add_prev($text, $stack, do_text($1 ."\@$2", $state)); - next; - } - elsif (s/^([^{},]*)([{}])//o or ($state->{'cmd_line'} and /^([^{},]*)$/)) - { - my $leading_text = $1; - my $brace = $2; - if (!defined($brace))#in a command line - { - if (/^$/ and $state->{'end_of_line_protected'} and $state->{'deff'}) - { - return; - } - chomp $leading_text; - } - # a brace closed, at the end of line. If in cmd_line we remove - # the end of line, such that the end of line is detected - elsif ($state->{'cmd_line'} and /^$/) - { - chomp $_; - } - add_prev($text, $stack, do_text($leading_text, $state)); -#if ($state->{'cmd_line'}){print STDERR "CMD_LINE\n"; dump_stack($text, $stack, $state);} - if (defined($brace) and ($brace eq '{')) - { - add_prev($text, $stack, '{'); - unless ($state->{'keep_texi'} or $state->{'remove_texi'}) - { - echo_error ("'{' without macro before: $_", $line_nr); - } - } - else - { # A @macroname{ ...} is closed - if (@$stack and defined($stack->[-1]->{'style'})) - { - my $macro = $stack->[-1]->{'style'}; - if (($macro eq 'cmd_line') and $brace and ($brace eq '}')) - { - add_prev($text, $stack, '}'); - unless ($state->{'keep_texi'} or $state->{'remove_texi'}) - { - echo_error ("A '}' without opening '{' before: $_", $line_nr); - } - next; - } - my $style = pop @$stack; - my $result; - if (ref($style_map_ref->{$macro}) eq 'HASH') - { - push (@{$style->{'args'}}, $style->{'text'}); - $style->{'fulltext'} .= $style->{'text'}; - my $number = 0; - #foreach my $arg(@{$style->{'args'}}) - #{ - #print STDERR " $number: $arg\n"; - # $number++; - #} - $style->{'text'} = $style->{'fulltext'}; - $state->{'keep_texi'} = 0 if (#$state->{'keep_texi'} - ($style_map_ref->{$macro}->{'args'}->[$style->{'arg_nr'}] eq 'keep') - and ($state->{'keep_nr'} == 1)); - } - $state->{'no_paragraph'}-- if ($no_paragraph_macro{$macro}); - if ($macro) - { - $style->{'no_close'} = 1 if ($state->{'no_close'}); - if ($state->{'keep_texi'}) - { # don't expand macros in anchor and ref - close_arg ($macro, $style->{'arg_nr'}, $state); - $result = '@' . $macro . '{' . $style->{'text'} . '}'; - } - else - { - if ($style_map_ref->{$macro} and !$style->{'no_close'} and (defined($style_type{'$macro'})) and (($style_type{'$macro'} eq 'style') or ($style_type{'$macro'} eq 'accent'))) - { - my $style = pop @{$state->{'style_stack'}}; - print STDERR "Bug: $style on 'style_stack', not $macro\n" if ($style ne $macro); - } - $result = do_simple($macro, $style->{'text'}, $state, $style->{'args'}, $line_nr, $style->{'no_open'}, $style->{'no_close'}); - if ($state->{'code_style'} < 0) - { - echo_error ("Bug: negative code_style: $state->{'code_style'}, line:$_", $line_nr); - } - } - } - else - { - #$result = $style->{'text'} . '}'; - print STDERR "Bug: empty style in pass_text\n"; - } - add_prev($text, $stack, $result); - if ($state->{'cmd_line'} and ($style->{'style'} eq 'cmd_line')) - { - if ($state->{'deff'}) - { -#print STDERR "DO DEFF $state->{'deff'}->{'command'} $state->{'deff'}->{'arguments'}\n"; - my $def_style = $state->{'deff'}->{'style'}; - my $category = $state->{'deff'}->{'category'}; - my $class = $state->{'deff'}->{'class'}; - my $type = $state->{'deff'}->{'type'}; - my $name = $state->{'deff'}->{'name'}; - #my $arguments = $state->{'deff'}->{'arguments'}; - my $arguments; - $arguments = substitute_line($state->{'deff'}->{'arguments'}) if (defined($state->{'deff'}->{'arguments'})); - - $category = &$Texi2HTML::Config::definition_category($category, $class, $def_style); - if (! $category) # category cannot be 0 - { - echo_warn("Bad definition line $_", $line_nr); - delete $state->{'cmd_line'}; - return ''; - } - my $index_label = do_index_entry_label ($state,$line_nr) if ($name ne ''); - add_prev($text, $stack, &$Texi2HTML::Config::def_line($category, $name, $type, $arguments, $index_label)); - } - else - # we've got to mark paragraph here as the following - # line will determine whether or not we open a paragraph - { - $state->{'open_paragraph'} = 1; - } - delete $state->{'cmd_line'}; - $state->{'no_paragraph'}--; - return; - } - next; - } - else - { - echo_error("'}' without opening '{' before: $_", $line_nr); - # we cannot be in cmd_line as the stack is empty - if ($state->{'cmd_line'}) - { - print STDERR "Bug: state->{'cmd_line'} true but stack empty\n"; - dump_stack($text, $stack, $state); - delete $state->{'cmd_line'}; - } - add_prev($text, $stack, '}') if ($state->{'keep_texi'}); - } - } - } - elsif (s/^([^,]*)([,])//o) - { - add_prev($text, $stack, do_text($1, $state)); - my $comma = $2; - if ($state->{'cmd_line'} and !@$stack) - { - print STDERR "Bug: state->{'cmd_line'} = $state->{'cmd_line'} but no stack\n"; - dump_stack($text, $stack, $state); - } - if (@$stack and defined($stack->[-1]->{'style'}) - and (ref($style_map_ref->{$stack->[-1]->{'style'}}) eq 'HASH')) - { - my $macro = $stack->[-1]->{'style'}; - my $style_args = $style_map_ref->{$macro}->{'args'}; - if (defined($style_args->[$stack->[-1]->{'arg_nr'} + 1])) - { - push (@{$stack->[-1]->{'args'}}, $stack->[-1]->{'text'}); - $stack->[-1]->{'fulltext'} .= $stack->[-1]->{'text'} . do_text(',', $state); - $stack->[-1]->{'text'} = ''; - close_arg ($macro, $stack->[-1]->{'arg_nr'}, $state); - $stack->[-1]->{'arg_nr'}++; - open_arg ($macro, $stack->[-1]->{'arg_nr'}, $state); - next; - } - } - add_prev($text, $stack, do_text(',', $state)); - } - else - { # no macro nor '}', but normal text - add_prev($text, $stack, do_text($_, $state)); - #print STDERR "END LINE: $_"; - #dump_stack($text, $stack, $state); - - # @item line is closed by end of line - add_term($text, $stack, $state, $line_nr); - # FIXME test @center @item and @item @center - if ($state->{'paragraph_style'}->[-1] eq 'center' and !$state->{'close_stack'}) - { - close_paragraph($text, $stack, $state, $line_nr); - pop @{$state->{'paragraph_style'}}; - #$_ = $/ if (chomp($_)); - $_ = ''; - next; - } - last; - } - } - return 1; -} - -sub open_arg($$$) -{ - my $macro = shift; - my $arg_nr = shift; - my $state = shift; - if (ref($style_map_ref->{$macro}) eq 'HASH') - { - my $arg = $style_map_ref->{$macro}->{'args'}->[$arg_nr]; - if ($arg eq 'code' and !$state->{'keep_texi'}) - { - $state->{'code_style'}++; - } - elsif ($arg eq 'keep') - { - $state->{'keep_nr'}++; - $state->{'keep_texi'} = 1; - } - } - elsif ($code_style_map{$macro} and !$state->{'keep_texi'}) - { - $state->{'code_style'}++; - } -} - -sub close_arg($$$) -{ - my $macro = shift; - my $arg_nr = shift; - my $state = shift; - if (ref($style_map_ref->{$macro}) eq 'HASH') - { - my $arg = $style_map_ref->{$macro}->{'args'}->[$arg_nr]; - if ($arg eq 'code' and !$state->{'keep_texi'}) - { - $state->{'code_style'}--; - } - elsif ($arg eq 'keep') - { - $state->{'keep_nr'}--; - $state->{'keep_texi'} = 0 if ($state->{'keep_nr'} == 0); - } -#print STDERR "c $arg_nr $macro $arg $state->{'code_style'}\n"; - } - elsif ($code_style_map{$macro} and !$state->{'keep_texi'}) - { - $state->{'code_style'}--; - } -} - -sub open_cmd_line($$$$) -{ - my $stack = shift; - my $state = shift; - my $args = shift; - my $function = shift; - push @$stack, {'style' => 'cmd_line', 'text' => '', 'arg_nr' => 0}; - foreach my $hash (\%Texi2HTML::Config::style_map, \%Texi2HTML::Config::style_map_pre, \%Texi2HTML::Config::style_map_texi, \%Texi2HTML::Config::unformatted_text_style_map_texi) - { - $hash->{'cmd_line'}->{'args'} = $args; - $hash->{'cmd_line'}->{'function'} = $function; - } - $state->{'no_paragraph'}++; - open_arg ('cmd_line', 0, $state); - $state->{'cmd_line'} = 1; -} - -sub get_value($) -{ - my $value = shift; - return $value{$value} if ($value{$value}); - return "No value for $value"; -} - -sub add_term($$$$;$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $end = shift; - return unless (exists ($state->{'format_stack'})); - my $format = $state->{'format_stack'}->[-1]; - return unless (($format_type{$format->{'format'}} eq 'table') and ($format->{'format'} ne 'multitable' ) and $format->{'term'}); - #print STDERR "ADD_TERM\n"; - # we set 'term' = 0 early such that if we encounter an end of line - # during close_stack we don't try to do the term once more - $state->{'format_stack'}->[-1]->{'term'} = 0; - $format->{'paragraph_number'} = 0; - # no <pre> allowed in <dt>, thus it is possible there is a @t added - # to have teletype in preformatted. - if ($state->{'preformatted'} and $stack->[-1]->{'style'} and ($stack->[-1]->{'style'} eq 't')) - { - my $style = pop @$stack; - add_prev($text, $stack, do_simple($style->{'style'}, $style->{'text'}, $state, [$style->{'text'}])); - } - - #dump_stack($text, $stack, $state); - close_stack($text, $stack, $state, $line_nr, undef, 'term'); - my $term = pop @$stack; - my $command_formatted; - chomp ($term->{'text'}); - if (exists($style_map_ref->{$format->{'command'}}) and - !exists($Texi2HTML::Config::special_list_commands{$format->{'format'}}->{$format->{'command'}}) and ($style_type{$format->{'command'}} eq 'style')) - { - my $leading_spaces = ''; - my $trailing_spaces = ''; - $term->{'text'} =~ s/^(\s*)//; - $leading_spaces = $1 if (defined($1)); - $term->{'text'} =~ s/(\s*)$//; - $trailing_spaces = $1 if (defined($1)); - $term->{'text'} = do_simple($format->{'command'}, $term->{'text'}, $state, [$term->{'text'}]); - $term->{'text'} = $leading_spaces. $term->{'text'} .$trailing_spaces; - } - elsif (exists($things_map_ref->{$format->{'command'}})) - { - $command_formatted = do_simple($format->{'command'}, '', $state); - } - my $index_label; - if ($format->{'format'} =~ /^(f|v)/) - { - $index_label = do_index_entry_label($state,$line_nr); - print STDERR "Bug: no index entry for $text" unless defined($index_label); - } - add_prev($text, $stack, &$Texi2HTML::Config::table_item($term->{'text'}, $index_label,$format->{'format'},$format->{'command'}, $command_formatted)); - #add_prev($text, $stack, &$Texi2HTML::Config::table_item($term->{'text'}, $index_entry, $state)); - unless ($end) - { - push (@$stack, { 'format' => 'line', 'text' => '' }); - begin_paragraph($stack, $state) if ($state->{'preformatted'}); - } - return $format; -} - -sub add_row($$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $format = $state->{'format_stack'}->[-1]; - return unless ($format->{'format'} eq 'multitable'); - if ($format->{'cell'} > $format->{'max_columns'}) - { - close_stack($text, $stack, $state, $line_nr, undef, 'null'); - pop @$stack; - } - unless ($format->{'max_columns'}) - { # empty multitable - pop @$stack; # pop 'row' - return $format; - } - if ($format->{'first'}) - { # first row - $format->{'first'} = 0; - #dump_stack($text, $stack, $state); - #if ($stack->[-1]->{'format'} and ($stack->[-1]->{'format'} eq 'paragraph') and ($stack->[-1]->{'text'} =~ /^\s*$/) and ($format->{'cell'} == 1)) - if ($stack->[-1]->{'format'} and ($stack->[-1]->{'format'} eq 'cell') and ($stack->[-1]->{'text'} =~ /^\s*$/) and ($format->{'cell'} == 1)) - { - pop @$stack; - pop @$stack; - #pop @$stack; - return $format; - } - } - add_cell($text, $stack, $state); - my $row = pop @$stack; - add_prev($text, $stack, &$Texi2HTML::Config::row($row->{'text'}, $row->{'item_cmd'})); - return $format; -} - -sub add_cell($$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $format = $state->{'format_stack'}->[-1]; - return unless ($format->{'format'} eq 'multitable'); - if ($format->{'cell'} <= $format->{'max_columns'}) - { - close_stack($text, $stack, $state, $line_nr, undef, 'cell'); - my $cell = pop @$stack; - my $row = top_stack($stack); - print STDERR "Bug: top_stack of cell not a row\n" if (!defined($row) or !defined($row->{'format'}) or ($row->{'format'} ne 'row')); - add_prev($text, $stack, &$Texi2HTML::Config::cell($cell->{'text'}, $row->{'item_cmd'})); - $format->{'cell'}++; - } - return $format; -} - -sub add_line($$$$;$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $end = shift; - my $format = $state->{'format_stack'}->[-1]; - return unless ($format_type{$format->{'format'}} eq 'table' and ($format->{'format'} ne 'multitable') and ($format->{'term'} == 0)); - #print STDERR "ADD_LINE\n"; - #dump_stack($text, $stack, $state); - # as in pre the end of line are kept, we must explicitely abort empty - # preformatted, close_stack doesn't abort the empty preformatted regions. - abort_empty_preformatted($stack, $state) if ($format->{'first'}); - close_stack($text, $stack, $state, $line_nr, undef, 'line'); - my $line = pop @$stack; - $format->{'paragraph_number'} = 0; - my $first = 0; - $first = 1 if ($format->{'first'}); - if ($first) - { - $format->{'first'} = 0; - # we must have <dd> or <dt> following <dl> thus we do a - # &$Texi2HTML::Config::table_line here too, although it could have been nice to - # have a normal paragraph. - add_prev($text, $stack, &$Texi2HTML::Config::table_line($line->{'text'})) if ($line->{'text'} =~ /\S/o); - } - else - { - add_prev($text, $stack, &$Texi2HTML::Config::table_line($line->{'text'})); - } - unless($end) - { - push (@$stack, { 'format' => 'term', 'text' => '' }); - # we cannot have a preformatted in table term (no <pre> in <dt>) - # thus we set teletyped style @t if there is no pre_style - push (@$stack, { 'style' => 't', 'text' => '' }) if ($state->{'preformatted'} and (!$state->{'preformatted_stack'}->[-1]->{'pre_style'})); - #push (@$stack, { 'style' => $format->{'command'}, 'text' => $format->{'appended'} }); - } - $format->{'term'} = 1; - return $format; -} - -sub add_item($$$$;$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $line = shift; - my $end = shift; - my $format = $state->{'format_stack'}->[-1]; - return unless ($format_type{$format->{'format'}} eq 'list'); - #print STDERR "ADD_ITEM: \n"; - # as in pre the end of line are kept, we must explicitely abort empty - # preformatted, close_stack doesn't do that. - abort_empty_preformatted($stack, $state) if ($format->{'first'}); - close_stack($text, $stack, $state, $line_nr, undef, 'item'); - $format->{'paragraph_number'} = 0; - if ($format->{'format'} eq 'enumerate') - { - $format->{'number'} = ''; - my $spec = $format->{'spec'}; - $format->{'item_nr'}++; - if ($spec =~ /^[0-9]$/) - { - $format->{'number'} = $spec + $format->{'item_nr'} - 1; - } - else - { - my $base_letter = ord('a'); - $base_letter = ord('A') if (ucfirst($spec) eq $spec); - - my @letter_ords = decompose(ord($spec) - $base_letter + $format->{'item_nr'} - 1, 26); - foreach my $ord (@letter_ords) - {#FIXME? we go directly to 'ba' after 'z', and not 'aa' - #because 'ba' is 1,0 and 'aa' is 0,0. - $format->{'number'} = chr($base_letter + $ord) . $format->{'number'}; - } - } - } - - #dump_stack ($text, $stack, $state); - my $item = pop @$stack; - # the element following ol or ul must be li. Thus even though there - # is no @item we put a normal item. - - # don't do an item if it is the first and it is empty - if (!$format->{'first'} or ($item->{'text'} =~ /\S/o)) - { - my $formatted_command; - if (defined($format->{'command'}) and exists($things_map_ref->{$format->{'command'}})) - { - $formatted_command = do_simple($format->{'command'}, '', $state); - } - #chomp($item->{'text'}); - add_prev($text, $stack, &$Texi2HTML::Config::list_item($item->{'text'},$format->{'format'},$format->{'command'}, $formatted_command, $format->{'item_nr'}, $format->{'spec'}, $format->{'number'})); - } - if ($format->{'first'}) - { - $format->{'first'} = 0; - } - - # Now prepare the new item - unless($end) - { - push (@$stack, { 'format' => 'item', 'text' => '' }); - begin_paragraph($stack, $state) unless (!$state->{'preformatted'} and no_line($line)); - } - return $format; -} - -# format ``simple'' macros, that is macros without arg or style macros -sub do_simple($$$;$$$$) -{ - my $macro = shift; - my $text = shift; - my $state = shift; - my $args = shift; - my $line_nr = shift; - my $no_open = shift; - my $no_close = shift; - my $result; - - my $arg_nr = 0; - $arg_nr = @$args - 1 if (defined($args)); - -#print STDERR "DO_SIMPLE $macro $arg_nr $args @$args\n" if (defined($args)); - if (defined($simple_map_ref->{$macro})) - { - # \n may in certain circumstances, protect end of lines - if ($macro eq "\n") - { - $state->{'end_of_line_protected'} = 1; - #print STDERR "PROTECTING END OF LINE\n"; - } - if ($state->{'keep_texi'}) - { - return "\@$macro"; - } - elsif ($state->{'remove_texi'}) - { -#print STDERR "DO_SIMPLE remove_texi $macro\n"; - return $simple_map_texi_ref->{$macro}; - } - elsif ($state->{'preformatted'}) - { - return $simple_map_pre_ref->{$macro}; - } - else - { - return $simple_map_ref->{$macro}; - } - } - if (defined($things_map_ref->{$macro})) - { - if ($state->{'keep_texi'}) - { - $result = "\@$macro" . '{}'; - } - elsif ($state->{'remove_texi'}) - { - $result = $texi_map_ref->{$macro}; -#print STDERR "DO_SIMPLE remove_texi texi_map $macro\n"; - } - elsif ($state->{'preformatted'}) - { - $result = $pre_map_ref->{$macro}; - } - else - { - $result = $things_map_ref->{$macro}; - } - return $result . $text; - } - elsif (defined($style_map_ref->{$macro})) - { - if ($state->{'keep_texi'}) - { - $result = "\@$macro" . '{' . $text . '}'; - } - else - { - my $style; - if ($state->{'remove_texi'}) - { -#print STDERR "REMOVE $macro, $style_map_texi_ref->{$macro}, fun $style_map_texi_ref->{$macro}->{'function'} remove cmd " . \&Texi2HTML::Config::t2h_remove_command . " ascii acc " . \&t2h_default_ascii_accent; - $style = $style_map_texi_ref->{$macro}; - } - elsif ($state->{'preformatted'}) - { - $style = $style_map_pre_ref->{$macro}; - } - else - { - $style = $style_map_ref->{$macro}; - } - if (defined($style)) - { # known style - $result = &$Texi2HTML::Config::style($style, $macro, $text, $args, $no_close, $no_open, $line_nr, $state, $state->{'style_stack'}); - } - if (!$no_close) - { - close_arg($macro,$arg_nr, $state); - } - } - return $result; - } - # Unknown macro - $result = ''; - my ($done, $result_text, $message) = &$Texi2HTML::Config::unknown_style($macro, $text); - if ($done) - { - echo_warn($message, $line_nr) if (defined($message)); - if (defined($result_text)) - { - $result = $result_text; - } - } - else - { - unless ($no_open) - { # we warn only if no_open is true, i.e. it is the first time we - # close the macro for a multiline macro - echo_warn ("Unknown command with braces `\@$macro'", $line_nr); - $result = do_text("\@$macro") . "{"; - } - $result .= $text; - $result .= '}' unless ($no_close); - } - return $result; -} - -sub do_unknown($$$$$$) -{ - my $macro = shift; - my $line = shift; - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my ($result_line, $result, $result_text, $message) = &$Texi2HTML::Config::unknown($macro, $line); - if ($result) - { - add_prev ($text, $stack, $result_text) if (defined($result_text)); - echo_warn($message, $line_nr) if (defined($message)); - return $result_line; - } - else - { - echo_warn ("Unknown command `\@$macro' (left as is)", $line_nr); - add_prev ($text, $stack, do_text("\@$macro")); - return $line; - } -} - -# used only during @macro processing -sub add_text($@) -{ - my $string = shift; - - return if (!defined($string)); - foreach my $scalar_ref (@_) - { - next unless defined($scalar_ref); - if (!defined($$scalar_ref)) - { - $$scalar_ref = $string; - } - else - { - $$scalar_ref .= $string; - } - return; - } -} - -sub add_prev ($$$) -{ - my $text = shift; - my $stack = shift; - my $string = shift; - - unless (defined($text) and ref($text) eq "SCALAR") - { - die "text not a SCALAR ref: " . ref($text) . ""; - } - #if (!defined($stack) or (ref($stack) ne "ARRAY")) - #{ - # $string = $stack; - # $stack = []; - #} - - return if (!defined($string)); - if (@$stack) - { - $stack->[-1]->{'text'} .= $string; - return; - } - - if (!defined($$text)) - { - $$text = $string; - } - else - { - $$text .= $string; - } -} - -sub close_stack_texi_structure($$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - - return undef unless (@$stack or $state->{'raw'} or $state->{'macro'} or $state->{'macro_name'} or $state->{'ignored'}); - - my $stack_level = $#$stack + 1; - my $string = ''; - - if ($state->{'ignored'}) - { - $string .= "\@end $state->{'ignored'} "; - echo_warn ("closing $state->{'ignored'}", $line_nr); - } - if ($state->{'texi'}) - { - if ($state->{'macro'}) - { - $string .= "\@end macro "; - echo_warn ("closing macro", $line_nr); - } - elsif ($state->{'macro_name'}) - { - $string .= ('}' x $state->{'macro_depth'}) . " "; - echo_warn ("closing $state->{'macro_name'} ($state->{'macro_depth'} braces missing)", $line_nr); - } - elsif ($state->{'verb'}) - { - echo_warn ("closing \@verb", $line_nr); - $string .= $state->{'verb'} . '}'; - } - elsif ($state->{'raw'}) - { - echo_warn ("closing \@$state->{'raw'} raw format", $line_nr); - $string .= "\@end $state->{'raw'} "; - } - if ($string ne '') - { - #print STDERR "scan_texi ($string)\n"; - scan_texi ($string, $text, $stack, $state, $line_nr); - $string = ''; - } - } - elsif ($state->{'verb'}) - { - $string .= $state->{'verb'}; - } - - while ($stack_level--) - { - my $stack_text = $stack->[$stack_level]->{'text'}; - $stack_text = '' if (!defined($stack_text)); - if ($stack->[$stack_level]->{'format'}) - { - my $format = $stack->[$stack_level]->{'format'}; - if ($format eq 'index_item') - { - enter_table_index_entry($text, $stack, $state, $line_nr); - next; - } - elsif (!defined($format_type{$format}) or ($format_type{$format} ne 'fake')) - { - $stack_text = "\@$format\n" . $stack_text; - } - } - elsif (defined($stack->[$stack_level]->{'style'})) - { - my $style = $stack->[$stack_level]->{'style'}; - if ($style ne '') - { - $stack_text = "\@$style\{" . $stack_text; - } - else - { - $stack_text = "\{" . $stack_text; - } - } - pop @$stack; - add_prev($text, $stack, $stack_text); - } - $stack = [ ]; - $stack_level = 0; - #return ($text, [ ], $state); - - $state->{'close_stack'} = 1; - if ($string ne '') - { - if ($state->{'texi'}) - { - #print STDERR "scan_texi in close_stack ($string)\n"; - scan_texi($string, $text, $stack, $state, $line_nr); - } - elsif ($state->{'structure'}) - { - #print STDERR "scan_structure in close_stack ($string)\n"; - scan_structure($string, $text, $stack, $state, $line_nr); - } - } - delete $state->{'close_stack'}; -} - - -# close the stack, closing macros and formats left open. -# the precise behavior of the function depends on $close_paragraph: -# undef -> close everything -# defined -> remove empty paragraphs, close until the first format or paragraph. -# 1 -> don't close styles, duplicate stack of styles not closed -# FIXME never used -# '' -> close styles, don't duplicate - -# if a $format is given the stack is closed according to $close_paragraph but -# if $format is encountered the closing stops - -sub close_stack($$$$;$$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - my $close_paragraph = shift; - my $format = shift; - # FIXME this is not used - my $search_style = shift; - my $new_stack; - - # cancel paragraph states - $state->{'paragraph_style'} = [ '' ] unless (defined($close_paragraph) or defined($format)); - #print STDERR "sub_close_stack\n"; - return $new_stack unless (@$stack); - - my $stack_level = $#$stack + 1; - my $string = ''; - my $verb = ''; - - if ($state->{'verb'}) - { - $string .= $state->{'verb'}; - $verb = $state->{'verb'}; - } - - #debugging - #my $print_format = 'NO FORMAT'; - #$print_format = $format if ($format); - #my $print_close_paragraph = 'close everything'; - #$print_close_paragraph = 'close paragraph without duplicating' if (defined($close_paragraph)); - #$print_close_paragraph = $close_paragraph if ($close_paragraph); - #print STDERR "Close_stack: format $print_format, close_paragraph: $print_close_paragraph\n"; - - while ($stack_level--) - { - if ($stack->[$stack_level]->{'format'}) - { - my $stack_format = $stack->[$stack_level]->{'format'}; - last if (defined($close_paragraph) or (defined($format) and $stack_format eq $format)); - # We silently close paragraphs, preformatted sections and fake formats - if ($stack_format eq 'paragraph') - { - $string .= "\@end_paragraph "; - } - elsif ($stack_format eq 'preformatted') - { - $string .= "\@end_preformatted "; - } - else - { - if ($fake_format{$stack_format}) - { - warn "# Closing a fake format `$stack_format'\n" if ($T2H_VERBOSE); - } - else - { - echo_warn ("closing `$stack_format'", $line_nr); - #dump_stack ($text, $stack, $state); - #warn "$WARN closing `$stack_format'\n"; - } - $string .= "\@end $stack_format "; - } - } - else - { - my $style = $stack->[$stack_level]->{'style'}; - last if (defined($search_style) and $style eq $search_style); - # FIXME images, footnotes, xrefs, anchors with $close_paragraphs ? - if ($close_paragraph) - { #duplicate the stack - if (exists($style_type{$style}) and ($style_type{$style} eq 'style') or (!exists($style_type{$style}))) - { - push @$new_stack, { 'style' => $style, 'text' => '', 'no_open' => 1, 'arg_nr' => 0 }; - $string .= '} '; - } - elsif (exists($style_type{$style}) and ($style_type{$style} eq 'simple')) - { - $string .= '} '; - } - } - else - { - dump_stack ($text, $stack, $state) if (!defined($style)); - $string .= '}'; - echo_warn ("closing $style", $line_nr) if ($style); - } - } - } - $state->{'no_close'} = 1 if ($close_paragraph); - $state->{'close_stack'} = 1; - if ($string ne '') - { - #print STDERR "scan_line in CLOSE_STACK ($string)\n"; - #dump_stack ($text, $stack, $state); - scan_line($string, $text, $stack, $state, $line_nr); - } - delete $state->{'no_close'}; - delete $state->{'close_stack'}; - $state->{'verb'} = $verb if (($verb ne '') and $close_paragraph); - return $new_stack; -} - -# given a stack and a list of formats, return true if the stack contains -# these formats, first on top -sub stack_order($@) -{ - my $stack = shift; - my $stack_level = $#$stack + 1; - while (@_) - { - my $format = shift; - while ($stack_level--) - { - if ($stack->[$stack_level]->{'format'}) - { - if ($stack->[$stack_level]->{'format'} eq $format) - { - $format = undef; - last; - } - else - { - return 0; - } - } - } - return 0 if ($format); - } - return 1; -} - -sub top_format($) -{ - my $stack = shift; - my $stack_level = $#$stack + 1; - while ($stack_level--) - { - if ($stack->[$stack_level]->{'format'} and !$fake_format{$stack->[$stack_level]->{'format'}}) - { - return $stack->[$stack_level]; - } - } - return undef; -} - -sub close_paragraph($$$;$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - my $line_nr = shift; - #my $macro = shift; - #print STDERR "CLOSE_PARAGRAPH\n"; - #dump_stack($text, $stack, $state); - my $new_stack = close_stack($text, $stack, $state, $line_nr, 1); - my $top_stack = top_stack($stack); - if ($top_stack and !defined($top_stack->{'format'})) - { #debug - print STDERR "Bug: no format on top stack\n"; - dump_stack($text, $stack, $state); - } - if ($top_stack and ($top_stack->{'format'} eq 'paragraph')) - { - my $paragraph = pop @$stack; - add_prev($text, $stack, do_paragraph($paragraph->{'text'}, $state)); - $state->{'paragraph_macros'} = $new_stack; - return 1; - #return "\@$macro "; - } - elsif ($top_stack and ($top_stack->{'format'} eq 'preformatted')) - { - my $paragraph = pop @$stack; - add_prev($text, $stack, do_preformatted($paragraph->{'text'}, $state)); - $state->{'paragraph_macros'} = $new_stack; - return 1; - #return "\@$macro "; - } - return; -} - -sub abort_empty_preformatted($$) -{ - my $stack = shift; - my $state = shift; - if (@$stack and $stack->[-1]->{'format'} - and ($stack->[-1]->{'format'} eq 'preformatted') - and ($stack->[-1]->{'text'} !~ /\S/)) - { - pop @$stack; - return 1; - } - return 0; -} - -# for debugging -sub dump_stack($$$) -{ - my $text = shift; - my $stack = shift; - my $state = shift; - - if (defined($$text)) - { - print STDERR "text: $$text\n"; - } - else - { - print STDERR "text: UNDEF\n"; - } - print STDERR "state: "; - foreach my $key (keys(%$state)) - { - my $value = 'UNDEF'; - $value = $state->{$key} if (defined($state->{$key})); - print STDERR "$key: $value "; - } - print STDERR "\n"; - my $stack_level = $#$stack + 1; - while ($stack_level--) - { - print STDERR " $stack_level-> "; - foreach my $key (keys(%{$stack->[$stack_level]})) - { - my $value = 'UNDEF'; - $value = $stack->[$stack_level]->{$key} if - (defined($stack->[$stack_level]->{$key})); - print STDERR "$key: $value "; - } - print STDERR "\n"; - } - if (defined($state->{'format_stack'})) - { - print STDERR "format_stack: "; - foreach my $format (@{$state->{'format_stack'}}) - { - print STDERR "$format->{'format'} "; - } - print STDERR "\n"; - } -} - -# for debugging -sub print_elements($) -{ - my $elements = shift; - foreach my $elem(@$elements) - { - if ($elem->{'node'}) - { - print STDERR "node-> $elem "; - } - else - { - print STDERR "chap=> $elem "; - } - foreach my $key (keys(%$elem)) - { - my $value = "UNDEF"; - $value = $elem->{$key} if (defined($elem->{$key})); - print STDERR "$key: $value "; - } - print STDERR "\n"; - } -} - -sub substitute_line($;$) -{ - my $line = shift; - my $state = shift; - $state = {} if (!defined($state)); - $state->{'no_paragraph'} = 1; - return unformatted_text($state, $line) if ($state->{'unformatted'}); - return substitute_text($state, $line); -} - -sub substitute_text($@) -{ - my $state = shift; - my @stack = (); - my $text = ''; - my $result = ''; - if ($state->{'structure'}) - { - initialise_state_structure($state); - } - elsif ($state->{'texi'}) - { - initialise_state_texi($state); - } - else - { - initialise_state($state); - } - $state->{'spool'} = []; - #print STDERR "SUBST_TEXT begin\n"; - - while (@_ or @{$state->{'spool'}}) - { - my $line; - if (@{$state->{'spool'}}) - { - $line = shift @{$state->{'spool'}}; - } - else - { - $line = shift @_; - } - next unless (defined($line)); - if ($state->{'structure'}) - { - scan_structure ($line, \$text, \@stack, $state); - } - elsif ($state->{'texi'}) - { - scan_texi ($line, \$text, \@stack, $state); - } - else - { - scan_line($line, \$text, \@stack, $state); - } - next if (@stack); - $result .= $text; - $text = ''; - } - # FIXME could we have the line number ? - # close stack in substitute_text - if ($state->{'texi'} or $state->{'structure'}) - { - close_stack_texi_structure(\$text, \@stack, $state, undef); - } - else - { - close_stack(\$text, \@stack, $state, undef); - } - #print STDERR "SUBST_TEXT end\n"; - return $result . $text; -} - -sub substitute_texi_line($) -{ - my $text = shift; - my @text = substitute_text({'structure' => 1}, $text); - my @result = (); - while (@text) - { - push @result, split (/\n/, shift (@text)); - } - return '' unless (@result); - my $result = shift @result; - return $result . "\n" unless (@result); - foreach my $line (@result) - { - chomp $line; - $result .= ' ' . $line; - } - return $result . "\n"; -} - -sub print_lines($;$) -{ - my ($fh, $lines) = @_; - $lines = $Texi2HTML::THIS_SECTION unless $lines; - my @cnt; - my $cnt; - for my $line (@$lines) - { - print $fh $line; - if (defined($Texi2HTML::Config::WORDS_IN_PAGE) and ($Texi2HTML::Config::SPLIT eq 'node')) - { - @cnt = split(/\W*\s+\W*/, $line); - $cnt += scalar(@cnt); - } - } - return $cnt; -} - -sub do_index_entry_label($$) -{ - my $state = shift; - my $line_nr = shift; - my $entry = shift @index_labels; - return '' if ($state->{'multiple_pass'}); - if (!defined($entry)) - { - echo_warn ("Not enough index entries !", $line_nr); - return ''; - } - - print STDERR "[(index) $entry->{'entry'} $entry->{'label'}]\n" - if ($T2H_DEBUG & $DEBUG_INDEX); - return &$Texi2HTML::Config::index_entry_label ($entry->{'label'}, $state->{'preformatted'}, substitute_line($entry->{'entry'}), $index_properties->{$entry->{'prefix'}}->{'name'}); -} - -# decompose a decimal number on a given base. The algorithm looks like -# the division with growing powers (division suivant les puissances -# croissantes) ? -sub decompose($$) -{ - my $number = shift; - my $base = shift; - my @result = (); - - return (0) if ($number == 0); - my $power = 1; - my $remaining = $number; - - while ($remaining) - { - my $factor = $remaining % ($base ** $power); - $remaining -= $factor; - push (@result, $factor / ($base ** ($power - 1))); - $power++; - } - return @result; -} - -# main processing is called here -set_document_language('en') unless ($lang_set); -# APA: There's got to be a better way: -$T2H_USER = &$I('unknown'); - -if ($Texi2HTML::Config::TEST) -{ - # to generate files similar to reference ones to be able to check for - # real changes we use these dummy values if -test is given - $T2H_USER = 'a tester'; - $THISPROG = 'texi2html'; - setlocale( LC_ALL, "C" ); -} -else -{ - # the eval prevents this from breaking on system which do not have - # a proper getpwuid implemented - eval { ($T2H_USER = (getpwuid ($<))[6]) =~ s/,.*//;}; # Who am i - # APA: Provide Windows NT workaround until getpwuid gets - # implemented there. - $T2H_USER = $ENV{'USERNAME'} unless defined $T2H_USER; -} - -open_file($docu, $texi_line_number); -Texi2HTML::LaTeX2HTML::init($docu_name, $docu_rdir, $T2H_DEBUG & $DEBUG_L2H) - if ($Texi2HTML::Config::L2H); -pass_texi(); -dump_texi(\@lines, 'texi', \@lines_numbers) if ($T2H_DEBUG & $DEBUG_TEXI); -if (defined($Texi2HTML::Config::MACRO_EXPAND)) -{ - my @texi_lines = (@first_lines, @lines); - dump_texi(\@texi_lines, '', undef, $Texi2HTML::Config::MACRO_EXPAND); -} -pass_structure(); -if ($T2H_DEBUG & $DEBUG_TEXI) -{ - dump_texi(\@doc_lines, 'first', \@doc_numbers); - if (defined($Texi2HTML::Config::MACRO_EXPAND and $Texi2HTML::Config::DUMP_TEXI)) - { - unshift (@doc_lines, @first_lines); - push (@doc_lines, "\@bye\n"); - dump_texi(\@doc_lines, '', undef, $Texi2HTML::Config::MACRO_EXPAND . ".first"); - } -} -exit(0) if ($Texi2HTML::Config::DUMP_TEXI or defined($Texi2HTML::Config::MACRO_EXPAND)); -rearrange_elements(); -do_names(); -if (@{$region_lines{'documentdescription'}} and (!defined($Texi2HTML::Config::DOCUMENT_DESCRIPTION))) -{ - my $documentdescription = remove_texi(@{$region_lines{'documentdescription'}}); - my @documentdescription = split (/\n/, $documentdescription); - $Texi2HTML::Config::DOCUMENT_DESCRIPTION = shift @documentdescription; - chomp $Texi2HTML::Config::DOCUMENT_DESCRIPTION; - foreach my $line (@documentdescription) - { - chomp $line; - $Texi2HTML::Config::DOCUMENT_DESCRIPTION .= ' ' . $line; - } -} -# do copyright notice inserted in comment at the begining of the files -if (@{$region_lines{'copying'}}) -{ - $copying_comment = &$Texi2HTML::Config::copying_comment($region_lines{'copying'}); - #$copying_comment = remove_texi(@{$region_lines{'copying'}}); - #$copying_comment = &$Texi2HTML::Config::comment($copying_comment); -} -&$Texi2HTML::Config::toc_body(\@elements_list); -#&$Texi2HTML::Config::toc_body(\@elements_list, $do_contents, $do_scontents); -&$Texi2HTML::Config::css_lines(\@css_import_lines, \@css_rule_lines); -$sec_num = 0; -#$Texi2HTML::Config::L2H = l2h_FinishToLatex() if ($Texi2HTML::Config::L2H); -#$Texi2HTML::Config::L2H = l2h_ToHtml() if ($Texi2HTML::Config::L2H); -#$Texi2HTML::Config::L2H = l2h_InitFromHtml() if ($Texi2HTML::Config::L2H); -Texi2HTML::LaTeX2HTML::latex2html(); -pass_text(); -#do_node_files() if ($Texi2HTML::Config::SPLIT ne 'node' and $Texi2HTML::Config::NODE_FILES); -if ($Texi2HTML::Config::IDX_SUMMARY) -{ - foreach my $entry (keys(%$index_properties)) - { - my $name = $index_properties->{$entry}->{'name'}; - do_index_summary_file($name) - unless ($empty_indices{$name}); - } -} -do_node_files() if ($Texi2HTML::Config::NODE_FILES); -#l2h_FinishFromHtml() if ($Texi2HTML::Config::L2H); -#l2h_Finish() if($Texi2HTML::Config::L2H); -Texi2HTML::LaTeX2HTML::finish(); -&$Texi2HTML::Config::finish_out(); -print STDERR "# that's all folks\n" if $T2H_VERBOSE; - -exit(0); - - -############################################################################## - -# These next few lines are legal in both Perl and nroff. - -.00 ; # finish .ig - -'di \" finish diversion--previous line must be blank -.nr nl 0-1 \" fake up transition to first page again -.nr % 0 \" start at page 1 -'; __END__ ############# From here on it's a standard manual page ############ - .so @mandir@/man1/texi2html.1 diff --git a/Build/source/utils/texi2html/texi2html.spec b/Build/source/utils/texi2html/texi2html.spec deleted file mode 100644 index d716b1dc714..00000000000 --- a/Build/source/utils/texi2html/texi2html.spec +++ /dev/null @@ -1,65 +0,0 @@ -Name: texi2html -Version: 1.76 -Release: 1 -Epoch: 0 -License: GPL -Group: Applications/Text -Summary: A highly customizable texinfo to HTML and other formats translator -Source0: %{name}-%{version}.tar.bz2 -#Source: http://texi2html.cvshome.org/servlets/ProjectDownloadList -URL: http://texi2html.cvshome.org/ - -Requires: perl >= 5.004 -Prefix: %{_prefix} -BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) - -%description -The basic purpose of texi2html is to convert Texinfo documents into HTML, -and other formats. Configuration files written in perl provide fine 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. - -%prep -%setup -q - -%build -%configure -make clean -make %{?_smp_mflags} - -%install -rm -rf $RPM_BUILD_ROOT -make install DESTDIR=$RPM_BUILD_ROOT -#%find_lang %{name} - -rm -f $RPM_BUILD_ROOT%{_infodir}/dir - -%clean -rm -rf $RPM_BUILD_ROOT - -%post -/sbin/install-info %{_infodir}/%{name}.info %{_infodir}/dir 2>/dev/null || : - -%preun -if [ $1 = 0 ]; then - /sbin/install-info --delete %{_infodir}/%{name}.info \ - %{_infodir}/dir 2>/dev/null || : -fi - -%files -%defattr(-,root,root) -%doc AUTHORS NEWS README ChangeLog TODO %{name}.init -%{_bindir}/%{name} -%{_datadir}/texinfo/html/%{name}.html -%{_mandir}/man*/%{name}* -%{_infodir}/%{name}.info* -%dir %{_datadir}/%{name} -%{_datadir}/%{name}/*.init -%dir %{_datadir}/%{name}/i18n/ -%{_datadir}/%{name}/i18n/* -%dir %{_datadir}/%{name}/images/ -%{_datadir}/%{name}/images/* - -%changelog -* Mon Mar 23 2004 Patrice Dumas <pertusus@free.fr> 0:1.69-0.fdr.1 -- Initial build. diff --git a/Build/source/utils/texi2html/texi2html.spec.in b/Build/source/utils/texi2html/texi2html.spec.in deleted file mode 100644 index 18ab7e9ff84..00000000000 --- a/Build/source/utils/texi2html/texi2html.spec.in +++ /dev/null @@ -1,65 +0,0 @@ -Name: @PACKAGE_TARNAME@ -Version: @PACKAGE_VERSION@ -Release: 1 -Epoch: 0 -License: GPL -Group: Applications/Text -Summary: A highly customizable texinfo to HTML and other formats translator -Source0: %{name}-%{version}.tar.bz2 -#Source: http://texi2html.cvshome.org/servlets/ProjectDownloadList -URL: http://texi2html.cvshome.org/ - -Requires: perl >= 5.004 -Prefix: %{_prefix} -BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) - -%description -The basic purpose of texi2html is to convert Texinfo documents into HTML, -and other formats. Configuration files written in perl provide fine 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. - -%prep -%setup -q - -%build -%configure -make clean -make %{?_smp_mflags} - -%install -rm -rf $RPM_BUILD_ROOT -make install DESTDIR=$RPM_BUILD_ROOT -#%find_lang %{name} - -rm -f $RPM_BUILD_ROOT%{_infodir}/dir - -%clean -rm -rf $RPM_BUILD_ROOT - -%post -/sbin/install-info %{_infodir}/%{name}.info %{_infodir}/dir 2>/dev/null || : - -%preun -if [ $1 = 0 ]; then - /sbin/install-info --delete %{_infodir}/%{name}.info \ - %{_infodir}/dir 2>/dev/null || : -fi - -%files -%defattr(-,root,root) -%doc AUTHORS NEWS README ChangeLog TODO %{name}.init -%{_bindir}/%{name} -%{_datadir}/texinfo/html/%{name}.html -%{_mandir}/man*/%{name}* -%{_infodir}/%{name}.info* -%dir %{_datadir}/%{name} -%{_datadir}/%{name}/*.init -%dir %{_datadir}/%{name}/i18n/ -%{_datadir}/%{name}/i18n/* -%dir %{_datadir}/%{name}/images/ -%{_datadir}/%{name}/images/* - -%changelog -* Mon Mar 23 2004 Patrice Dumas <pertusus@free.fr> 0:1.69-0.fdr.1 -- Initial build. diff --git a/Build/source/utils/texi2html/translations.pl b/Build/source/utils/texi2html/translations.pl deleted file mode 100644 index 79adb08de59..00000000000 --- a/Build/source/utils/texi2html/translations.pl +++ /dev/null @@ -1,818 +0,0 @@ -$LANGUAGES->{'de'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '@"Uber dieses Dokument', - 'April' => 'April', - 'August' => 'August', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'Dezember', - 'February' => 'Februar', - 'Footnotes' => 'Fu@ss{}noten', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'Januar', - 'July' => 'Juli', - 'Jump to' => '', - 'June' => 'Juni', - 'March' => 'M@"arz', - 'May' => 'Mai', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'November', - 'October' => 'Oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'September', - 'Short Table of Contents' => 'Kurzes Inhaltsverzeichniss', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Inhaltsverzeichniss', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'de'} = { - 'See' => 'Siehe', - 'section' => 'Abschnitt', - 'see' => 'siehe' - }; - - -$LANGUAGES->{'es'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => 'abril', - 'August' => 'agosto', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'diciembre', - 'February' => 'febrero', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'enero', - 'July' => 'julio', - 'Jump to' => '', - 'June' => 'junio', - 'March' => 'marzo', - 'May' => 'mayo', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'noviembre', - 'October' => 'octubre', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'septiembre', - 'Short Table of Contents' => 'Resumen del Contenido', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => '@\'{@dotless{I}}ndice General', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'es'} = { - 'See' => 'V@\'ease', - 'section' => 'secci@\'on', - 'see' => 'v@\'ase' - }; - - -$LANGUAGES->{'fr'} = { - ' The buttons in the navigation panels have the following meaning:' => ' Les boutons de navigation ont la signification suivante :', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => ' Dans cet exemple on est @`a @strong{ Sous section un-deux-trois } dans un document dont la structure est :', - ' Up ' => 'Plus haut', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => 'le %{day} %{month} %{year}', - '%{name} of %{class}' => '%{name} de %{class}', - '%{name} on %{class}' => '%{name} de %{class}', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '%{node_file_href} section `%{section}\' dans @cite{%{book}}', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'A propos de ce document', - 'April' => 'Avril', - 'August' => 'Ao@^ut', - 'Button' => 'Bouton', - 'Contents' => 'Table des mati@`eres', - 'Current Position' => 'Position', - 'December' => 'D@\'ecembre', - 'February' => 'F@\'evrier', - 'Footnotes' => 'Notes de bas de page', - 'From 1.2.3 go to' => 'Depuis 1.2.3 aller @`a', - 'Go to' => 'Aller @`a', - 'Index' => 'Index', - 'Index Entry' => 'Entr@\'ee d\'index', - 'January' => 'Janvier', - 'July' => 'Juillet', - 'Jump to' => 'Aller @`a', - 'June' => 'Juin', - 'March' => 'Mars', - 'May' => 'Mai', - 'Menu:' => 'Menu@ :', - 'Name' => 'Nom', - 'Next' => 'Suivant', - 'November' => 'Novembre', - 'October' => 'Octobre', - 'Overview' => 'Vue d\'ensemble', - 'Overview:' => 'Vue d\'ensemble@ :', - 'Prev' => 'Pr@\'ec@\'edent', - 'Section' => '', - 'Section One' => 'Section un', - 'See %{node_file_href}' => 'Voir %{node_file_href}', - 'See %{node_file_href} @cite{%{book}}' => 'Voir %{node_file_href} @cite{%{book}}', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => 'Voir %{node_file_href} section `%{section}\' dans @cite{%{book}}', - 'See %{reference_name}' => 'Voir %{reference_name}', - 'See @cite{%{book}}' => 'Voir @cite{%{book}}', - 'See section %{reference_name}' => 'Voir la section %{reference_name}', - 'See section `%{section}\' in @cite{%{book}}' => 'Voir la section `%{section}\' dans @cite{%{book}}', - 'September' => 'Septembre', - 'Short Table of Contents' => 'R@\'esum@\'e du contenu', - 'Subsection One-Four' => 'Sous section un-quatre', - 'Subsection One-One' => 'Sous section un-un', - 'Subsection One-Three' => 'Sous section un-trois', - 'Subsection One-Two' => 'Sous section un-deux', - 'Subsubsection One-Two-Four' => 'Sous sous section un-deux-quatre', - 'Subsubsection One-Two-One' => 'Sous sous section un-deux-un', - 'Subsubsection One-Two-Three' => 'Sous sous section un-deux-trois', - 'Subsubsection One-Two-Two' => 'Sous sous section un-deux-deux', - 'T2H_today' => 'le %2$d %1$s %3$d', - 'Table of Contents' => 'Table des mati@`eres', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} @emph{%{date}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'Top' => '', - 'Untitled Document' => 'Document sans titre', - 'about (help)' => '@`a propos (page d\'aide)', - 'beginning of this chapter or previous chapter' => 'd@\'ebut de ce chapitre ou chapitre pr@\'ec@\'edent', - 'by @emph{%{user}}' => 'par @emph{%{user}}', - 'by @emph{%{user}} on @emph{%{date}}' => 'par @emph{%{user}} @emph{%{date}}', - 'cover (top) of document' => 'couverture (top) du document', - 'current' => 'courante', - 'current section' => 'section actuelle', - 'first section in reading order' => 'premi@`e section dans l\'ordre de lecture', - 'following node' => 'node suivant', - 'index' => 'index', - 'last section in reading order' => 'derni@`ere section dans l\'ordre de lecture', - 'next chapter' => 'chapitre suivant', - 'next node' => 'node suivant', - 'next section in reading order' => 'section suivante dans l\'ordre de lecture', - 'next section on same level' => 'section suivante au m@^eme niveau', - 'node following in node reading order' => 'node suivant dans l\'ordre des nodes', - 'node up' => 'node au dessus', - 'on @emph{%{date}}' => '@emph{%{date}}', - 'previous node' => 'node pr@\'ec@\'edent', - 'previous section in reading order' => 'section pr@\'ec@\'edente dans l\'ordre de lecture', - 'previous section on same level' => 'section pr@\'ec@\'edente au m@^eme niveau', - 'section `%{section}\' in @cite{%{book}}' => 'section `%{section}\' dans @cite{%{book}}', - 'see %{node_file_href}' => 'voir %{node_file_href}', - 'see %{node_file_href} @cite{%{book}}' => 'voir %{node_file_href} @cite{%{book}}', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => 'voir %{node_file_href} section `%{section}\' dans @cite{%{book}}', - 'see %{reference_name}' => 'voir %{reference_name}', - 'see @cite{%{book}}' => 'voir @cite{%{book}}', - 'see section %{reference_name}' => 'voir la section %{reference_name}', - 'see section `%{section}\' in @cite{%{book}}' => 'voir la section `%{section}\' dans @cite{{book}}', - 'short table of contents' => 'table des mati@`eres r@\'esum@\'ee', - 'table of contents' => 'table des mati@`eres', - 'unknown' => 'inconnu', - 'up node' => 'node au dessus', - 'up section' => 'section sup@\'erieure' - }; - -$T2H_OBSOLETE_STRINGS->{'fr'} = { - ' This document was generated %{who_and_when_generated} using %{program_homepage_href}.' => ' Ce document a été généré %{who_and_when_generated} en utilisant %{program_homepage_href}.', - ' 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:' => ' Dans cet exemple on est à <strong> Sous section un-deux-trois </strong> dans un document dont la structure est :', - '%{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => '%{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'See' => 'Voir', - 'See %{node_file_href} <cite>%{book}</cite>' => 'Voir %{node_file_href} <cite>%{book}</cite>', - 'See %{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => 'Voir %{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'See <cite>%{book}</cite>' => 'Voir <cite>%{book}</cite>', - 'See section `%{section}\' in <cite>%{book}</cite>' => 'Voir la section `%{section}\' dans <cite>%{book}</cite>', - 'This document was generated by <i>%{user}</i> on <i>%{date}</i> using %{program_homepage_href}.' => 'Ce document a été généré par <i>%{user}</i> <i>%{date}</i> en utilisant %{program_homepage_href}.', - 'This document was generated by <i>%{user}</i> using %{program_homepage_href}.' => 'Ce document a été généré par <i>%{user}</i> en utilisant %{program_homepage_href}.', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} @emph{%{date}} en utilisant %{program_homepage_href}.', - 'This document was generated by @emph{%{user}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e par @emph{%{user}} en utilisant %{program_homepage_href}.', - 'This document was generated on <i>%{date}</i> using %{program_homepage_href}.' => 'Ce document a été généré <i>%{date}</i> en utilisant %{program_homepage_href}.', - 'This document was generated on @emph{%{date}} using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e @emph{%{date}} en utilisant %{program_homepage_href}.', - 'This document was generated on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e @emph{%{date}} en utilisant @uref{%{program_homepage}, @emph{%{program}}}.', - 'This document was generated using %{program_homepage_href}.' => 'Ce document a @\'et@\'e g@\'en@\'er@\'e en utilisant %{program_homepage_href}.', - 'about (this page)' => 'a propos (cette page)', - 'by <i>%{user}</i>' => 'par <i>%{user}</i>', - 'by <i>%{user}</i> on <i>%{date}</i>' => 'par <i>%{user}</i> <i>%{date}</i>', - 'concept index' => 'index', - 'on <i>%{date}</i>' => '<i>%{date}</i>', - 'section' => 'section', - 'section `%{section}\' in <cite>%{book}</cite>' => 'section `%{section}\' dans <cite>%{book}</cite>', - 'see' => 'voir', - 'see %{node_file_href} <cite>%{book}</cite>' => 'voir %{node_file_href} <cite>%{book}</cite>', - 'see %{node_file_href} section `%{section}\' in <cite>%{book}</cite>' => 'voir %{node_file_href} section `%{section}\' dans <cite>%{book}</cite>', - 'see <cite>%{book}</cite>' => 'voir <cite>%{book}</cite>', - 'see section `%{section}\' in <cite>%{book}</cite>' => 'voir la section `%{section}\' dans <cite>%{book}</cite>' - }; - - -$LANGUAGES->{'nl'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'No translation available!', - 'April' => 'April', - 'August' => 'Augustus', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'December', - 'February' => 'Februari', - 'Footnotes' => 'No translation available!', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Index', - 'Index Entry' => '', - 'January' => 'Januari', - 'July' => 'Juli', - 'Jump to' => '', - 'June' => 'Juni', - 'March' => 'Maart', - 'May' => 'Mei', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'November', - 'October' => 'Oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'September', - 'Short Table of Contents' => 'Korte inhoudsopgave', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Inhoudsopgave', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'nl'} = { - 'See' => 'Zie', - 'section' => 'sectie', - 'see' => 'zie' - }; - - -$LANGUAGES->{'no'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => 'No translation available!', - 'April' => 'april', - 'August' => 'august', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'desember', - 'February' => 'februar', - 'Footnotes' => 'No translation available!', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => 'Indeks', - 'Index Entry' => '', - 'January' => 'januar', - 'July' => 'juli', - 'Jump to' => '', - 'June' => 'juni', - 'March' => 'mars', - 'May' => 'mai', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'november', - 'October' => 'oktober', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'september', - 'Short Table of Contents' => 'Kort innholdsfortegnelse', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Innholdsfortegnelse', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'no'} = { - 'See' => 'Se', - 'section' => 'avsnitt', - 'see' => 'se' - }; - - -$LANGUAGES->{'pt'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => 'Abril', - 'August' => 'Agosto', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => 'Dezembro', - 'February' => 'Fevereiro', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => '@\'Indice', - 'Index Entry' => '', - 'January' => 'Janeiro', - 'July' => 'Julho', - 'Jump to' => '', - 'June' => 'Junho', - 'March' => 'Mar@,{c}o', - 'May' => 'Maio', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => 'Novembro', - 'October' => 'Outubro', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => 'Setembro', - 'Short Table of Contents' => 'Breve Sum@\'ario', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '', - 'Table of Contents' => 'Sum@\'ario', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'pt'} = { - 'See' => 'Veja', - 'section' => 'Se@,{c}@~ao', - 'see' => 'veja' - }; - - -$LANGUAGES->{'en'} = { - ' The buttons in the navigation panels have the following meaning:' => '', - ' where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '', - ' Up ' => '', - '%{acronym_like} (%{explanation})' => '', - '%{month}, %{day} %{year}' => '', - '%{name} of %{class}' => '', - '%{name} on %{class}' => '', - '%{node_file_href}' => '', - '%{node_file_href} @cite{%{book}}' => '', - '%{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - '%{reference_name}' => '', - '%{style} %{number}' => '', - '%{style}: %{caption_first_line}' => '', - '%{style}: %{shortcaption_first_line}' => '', - '@b{%{quotation_arg}:} ' => '', - '@cite{%{book}}' => '', - 'About This Document' => '', - 'April' => '', - 'August' => '', - 'Button' => '', - 'Contents' => '', - 'Current Position' => '', - 'December' => '', - 'February' => '', - 'Footnotes' => '', - 'From 1.2.3 go to' => '', - 'Go to' => '', - 'Index' => '', - 'Index Entry' => '', - 'January' => '', - 'July' => '', - 'Jump to' => '', - 'June' => '', - 'March' => '', - 'May' => '', - 'Menu:' => '', - 'Name' => '', - 'Next' => '', - 'November' => '', - 'October' => '', - 'Overview' => '', - 'Overview:' => '', - 'Prev' => '', - 'Section' => '', - 'Section One' => '', - 'See %{node_file_href}' => '', - 'See %{node_file_href} @cite{%{book}}' => '', - 'See %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'See %{reference_name}' => '', - 'See @cite{%{book}}' => '', - 'See section %{reference_name}' => '', - 'See section `%{section}\' in @cite{%{book}}' => '', - 'September' => '', - 'Short Table of Contents' => '', - 'Subsection One-Four' => '', - 'Subsection One-One' => '', - 'Subsection One-Three' => '', - 'Subsection One-Two' => '', - 'Subsubsection One-Two-Four' => '', - 'Subsubsection One-Two-One' => '', - 'Subsubsection One-Two-Three' => '', - 'Subsubsection One-Two-Two' => '', - 'T2H_today' => '%s, %d %d', - 'Table of Contents' => '', - 'This document was generated by @emph{%{user}} on @emph{%{date}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated by @emph{%{user}} using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'This document was generated on @i{%{date}} using @uref{%{program_homepage}, @i{%{program}}}.' => '', - 'This document was generated using @uref{%{program_homepage}, @emph{%{program}}}.' => '', - 'Top' => '', - 'Untitled Document' => '', - 'about (help)' => '', - 'beginning of this chapter or previous chapter' => '', - 'by @emph{%{user}}' => '', - 'by @emph{%{user}} on @emph{%{date}}' => '', - 'cover (top) of document' => '', - 'current' => '', - 'current section' => '', - 'first section in reading order' => '', - 'following node' => '', - 'index' => '', - 'last section in reading order' => '', - 'next chapter' => '', - 'next node' => '', - 'next section in reading order' => '', - 'next section on same level' => '', - 'node following in node reading order' => '', - 'node up' => '', - 'on @emph{%{date}}' => '', - 'previous node' => '', - 'previous section in reading order' => '', - 'previous section on same level' => '', - 'section `%{section}\' in @cite{%{book}}' => '', - 'see %{node_file_href}' => '', - 'see %{node_file_href} @cite{%{book}}' => '', - 'see %{node_file_href} section `%{section}\' in @cite{%{book}}' => '', - 'see %{reference_name}' => '', - 'see @cite{%{book}}' => '', - 'see section %{reference_name}' => '', - 'see section `%{section}\' in @cite{%{book}}' => '', - 'short table of contents' => '', - 'table of contents' => '', - 'unknown' => '', - 'up node' => '', - 'up section' => '' - }; - -$T2H_OBSOLETE_STRINGS->{'en'} = {}; - diff --git a/Build/source/withenable.ac b/Build/source/withenable.ac index 5608ea996e6..f2fa6de1d50 100644 --- a/Build/source/withenable.ac +++ b/Build/source/withenable.ac @@ -15,7 +15,6 @@ ps2eps psutils t1utils texcount -texi2html texinfo tpic2pdftex ]) |
