Documentation/lilypond-texi2html.init

   1 #!/usr/bin/env perl
   2 # -*- coding: utf-8; -*-
   3
   4 ### texi2html customization script for LilyPond
   5 ### Author: Reinhold Kainhofer <reinhold@kainhofer.com>, 2008.
   6 ###         Some code parts copied from texi2html and adapted. These functions
   7 ###         were written mainly by Patrice Dumas
   8 ### License: GPLv3+
   9 ###
  10 ###
  11 ### Features implemented here:
  12 ### -) For split manuals, the main page is index.html.
  13 ### -) All @unnumbered* sections are placed into the same file
  14 ###    (implemented by split_at_numbered_sections)
  15 ### -) Use our custom CSS file, with IE-specific fixes in another CSS file,
  16 ###    impelmented by lilypond_css_lines
  17 ### -) TOC (folded, with the current page highlighted) in an overflown <div>
  18 ###    is added to every page; implemented by:
  19 ###           lilypond_print_element_header -- building of the TOC
  20 ###           lilypond_toc_body -- generation of customized TOC output
  21 ###           lilypond_print_page_head -- start <div id="main">
  22 ###           print_lilypond_page_foot -- closing id=main, output of footer & TOC
  23 ### -) External refs are formatted only as "Text of the node" (not as >>see
  24 ###    "NODE" section "SECTION" in "BOOK"<< like with default texi2html). Also,
  25 ###    the leading "(book-name)" is removed.
  26 ###    Implemented by overriding lilypond_external_ref
  27 ### -) Navigation bars on top/bottom of the page and between sections are not
  28 ###    left-aligned, but use a combination of left/center/right aligned table
  29 ###    cells; For this, I heavily extend the texi2html code to allow for
  30 ###    differently aligned cells and for multi-line tables);
  31 ###    Implemented in lilypond_print_navigation
  32 ### -) Different formatting than the default: example uses the same formatting
  33 ###    as quote.
  34 ### -) Allow translated section titles: All section titles can be translated,
  35 ###    the original (English) title is associated with @translationof. This is
  36 ###    needed, because the file name / anchor is generated from the original
  37 ###    English title, since otherwise language-autoselection would break with
  38 ###    posted links.
  39 ###    Since it is then no longer possible to obtain the file name from the
  40 ###    section title, I keep a sectionname<=>filename/anchor around. This way,
  41 ###    xrefs from other manuals can simply load that map and retrieve the
  42 ###    correct file name for the link. Implemented in:
  43 ###           lilypond_unknown (handling of @translationof, in case
  44 ###                             extract_texi_filenames.py messes up...)
  45 ###           lilypond_element_file_name (correct file name: use the map)
  46 ###           lilypond_element_target_name (correct anchor: use the map)
  47 ###           lilypond_init_map (read in the externally created map from disk)
  48 ###           lilypond_external_href (load the map for xrefs, use the correct
  49 ###                                   link target)
  50 ### -) The HTML anchors for all sections are derived from the node name /
  51 ###    section title (pre-generated in the .xref-map file). Implemented by:
  52 ###           lilypond_element_target_name (adjust section anchors)
  53 ### -) Use the standard footnote format "<sup>nr</sup> text" instead of the
  54 ###    ugly format of texi2html (<h3>(nr)</h3><p>text</p>). Implemented in
  55 ###           makeinfo_like_foot_line_and_ref
  56 ###           makeinfo_like_foot_lines
  57 ###           makeinfo_like_paragraph
  58 ###
  59 ###
  60 ### Useful helper functions:
  61 ### -) texinfo_file_name($node_name): returns a texinfo-compatible file name
  62 ###    for the given string $node_name (whitespace trimmed/replaced by -,
  63 ###    non-standard chars replaced by _xxxx (ascii char code) and forced to
  64 ###    start with a letter by prepending t_g if necessary)
  65
  66
  67 package Texi2HTML::Config;
  68
  69 use utf8;
  70 use Encode qw(decode);
  71
  72 #############################################################################
  73 ### TRANSLATIONS
  74 #############################################################################
  75
  76 my $LY_LANGUAGES = {};
  77 $LY_LANGUAGES->{'fr'} = {
  78     'Back to Documentation Index' => 'Retour à l\'accueil de la documentation',
  79     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '<p>Remerciements à ${webdev_link} pour l\'hébergement de ${lily_site}.',
  80 };
  81
  82 $LY_LANGUAGES->{'es'} = {
  83     'Back to Documentation Index' => 'Volver al índice de la documentación',
  84     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '<p>Agradecemos a ${webdev_link} el alojamiento de ${lily_site}.',
  85 };
  86
  87 $LY_LANGUAGES->{'de'} = {
  88     'Back to Documentation Index' => 'Zur Dokumentationsübersicht',
  89     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '',
  90 };
  91
  92 $LY_LANGUAGES->{'ja'} = {
  93     'Back to Documentation Index' => 'ドキュメント インデックスに戻る',
  94     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '',
  95 };
  96
  97 $LY_LANGUAGES->{'hu'} = {
  98     'Back to Documentation Index' => 'Vissza a dokumentációk jegyzékéhez',
  99     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => 'Köszönet a ${webdev_link} részére a ${lily_site} tárhelyért.',
 100 };
 101
 102 $LY_LANGUAGES->{'it'} = {
 103     'Back to Documentation Index' => 'Torna all\'indice della documentazione',
 104     '<p>Thanks to ${webdev_link} for hosting ${lily_site}.' => '',
 105 };
 106
 107 # FIXME: request the translations below then send them to texi2html/texinfo devs
 108 $LANGUAGES->{'it'} = {
 109                        '  The buttons in the navigation panels have the following meaning:' => '  I bottoni nei pannelli di navigazione hanno il seguente significato:',
 110                        '  where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '  dove @strong{ Esempio } assume che l\'attuale posizione è alla @strong{ Sottosottosezione Uno-Due-Tre } di un documento che ha la seguente struttura:',
 111                        ' Up ' => ' Su ',
 112                        '(outside of any element)' => '(fuori da qualsiasi elemento)',
 113                        '(outside of any node)' => '(fuori da qualsiasi nodo)',
 114                        '@b{{quotation_arg}:} ' => '@b{{quotation_arg}:} ',
 115                        '@cite{{book}}' => '@cite{{book}}',
 116                        '@{No value for `{value}\'@}' => '@{Nessun valore per `{value}\'@}',
 117                        'About' => 'Informazioni',
 118                        'About (help)' => 'Informazioni (aiuto)',
 119                        'About This Document' => 'Informazioni su questo documento',
 120                        'April' => 'Aprile',
 121                        'August' => 'Agosto',
 122                        'Back' => 'Indietro',
 123                        'Back section in previous file' => '',
 124                        'Beginning of this chapter or previous chapter' => 'Inizio di questo capitolo o capitolo precedente',
 125                        'Button' => 'Bottone',
 126                        'Contents' => 'Contenuti',
 127                        'Cover (top) of document' => 'Copertina (inizio) del documento',
 128                        'Current' => 'Attuale',
 129                        'Current Position' => 'Posizione Attuale',
 130                        'Current section' => 'Sezione attuale',
 131                        'December' => 'Dicembre',
 132                        'FastBack' => 'Indietro veloce',
 133                        'FastForward' => 'Avanti veloce',
 134                        'February' => 'Febbraio',
 135                        'First' => 'Primo',
 136                        'First section in reading order' => 'Prima sezione in ordine di lettura',
 137                        'Following' => 'Seguente',
 138                        'Following node' => 'Nodo seguente',
 139                        'Footnotes' => 'Note a piè di pagina',
 140                        'Forward' => 'Avanti',
 141                        'Forward section in next file' => 'Sezione successiva nel prossimo file',
 142                        'From 1.2.3 go to' => 'Da 1.2.3 vai a',
 143                        'Go to' => 'Vai a',
 144                        'Index' => 'Indice',
 145                        'Index Entry' => 'Voce dell\'indice',
 146                        'January' => 'Gennaio',
 147                        'July' => 'Luglio',
 148                        'Jump to' => 'Salta a',
 149                        'June' => 'Giugno',
 150                        'Last' => 'Ultimo',
 151                        'Last section in reading order' => 'Ultima sezione in ordine di lettura',
 152                        'March' => 'Marzo',
 153                        'May' => 'Maggio',
 154                        'Menu:' => 'Menu',
 155                        'Name' => 'Nome',
 156                        'Next' => 'Successivo',
 157                        'Next chapter' => 'Capitolo successivo',
 158                        'Next file' => 'File successivo',
 159                        'Next node' => 'Nodo successivo',
 160                        'Next section in reading order' => 'Sezione successiva in ordine di lettura',
 161                        'Next section on same level' => 'Sezione successiva sullo stesso livello',
 162                        'NextFile' => 'File successivo',
 163                        'Node following in node reading order' => 'Nodo seguente in ordine di lettura',
 164                        'Node up' => 'Nodo superiore',
 165                        'NodeNext' => 'Nodo successivo',
 166                        'NodePrev' => 'Nodo precedente',
 167                        'NodeUp' => 'Nodo superiore',
 168                        'November' => 'Novembre',
 169                        'October' => 'Ottobre',
 170                        'Overview' => 'Panoramica',
 171                        'Prev' => 'Prec.',
 172                        'PrevFile' => 'File precedente',
 173                        'Previous' => 'Precedente',
 174                        'Previous file' => 'File precedente',
 175                        'Previous node' => 'Nodo precedente',
 176                        'Previous section in reading order' => 'Sezione precedente in ordine di lettura',
 177                        'Previous section on same level' => 'Sezione precedente sullo stesso livello',
 178                        'Section' => 'Sezione',
 179                        'Section One' => 'Sezione uno',
 180                        'See ' => 'Vedi',
 181                        'See @cite{{book}}' => 'Vedi @cite{{book}}',
 182                        'See section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'Vedi la sezione `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}',
 183                        'See section `{section}\' in @cite{{book}}' => 'Vedi la sezione `{section}\' in @cite{{book}}',
 184                        'See section {reference_name}' => 'Vedi la sezione {reference_name}',
 185                        'See {node_file_href}' => 'Vedi {node_file_href}',
 186                        'See {node_file_href} @cite{{book}}' => 'Vedi {node_file_href} @cite{{book}}',
 187                        'See {node_file_href} section `{section}\' in @cite{{book}}' => 'Vedi {node_file_href} nella sezione `{section}\' in @cite{{book}}',
 188                        'See {reference_name}' => 'Vedi {reference_name}',
 189                        'See {ref}' => 'Vedi {ref}',
 190                        'See {title_ref}' => 'Vedi {title_ref}',
 191                        'September' => 'Settembre',
 192                        'Short Table of Contents' => 'Indice breve',
 193                        'Short table of contents' => 'Indice breve',
 194                        'Subsection One-Four' => 'Sottosezione Uno-Quattro',
 195                        'Subsection One-One' => 'Sottosezione Uno-Uno',
 196                        'Subsection One-Three' => 'Sottosezione Uno-Tre',
 197                        'Subsection One-Two' => 'Sottosezione Uno-Due',
 198                        'Subsubsection One-Two-Four' => 'Sottosottosezione Uno-Due-Quattro',
 199                        'Subsubsection One-Two-One' => 'Sottosottosezione Uno-Due-Uno',
 200                        'Subsubsection One-Two-Three' => 'Sottosottosezione Uno-Due-Tre',
 201                        'Subsubsection One-Two-Two' => 'Sottosottosezione Uno-Due-Due',
 202                        'T2H_today' => '%s, %d %d',
 203                        'Table of Contents' => 'Indice',
 204                        'Table of contents' => 'Indice',
 205                        'The node you are looking for is at {href}.' => 'Il nodo che stai cercando è {href}',
 206                        'This' => 'Questo',
 207                        'This document was generated on @i{{date}} using @uref{{program_homepage}, @i{{program}}}.' => 'Questo documento è stato generato il @i{{date}} con @uref{{program_homepage}, @i{{program}}}.',
 208                        'This document was generated using @uref{{program_homepage}, @emph{{program}}}.' => 'Questo documento è stato generato con @uref{{program_homepage}, @emph{{program}}}.',
 209                        'Top' => 'Inizio',
 210                        'Untitled Document' => 'Documento senza titolo',
 211                        'Up' => 'Su',
 212                        'Up node' => 'Nodo superiore',
 213                        'Up section' => 'Sezione superiore',
 214                        'current' => 'attuale',
 215                        'on @emph{{date}}' => 'il @emph{{date}}',
 216                        'section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'sezione `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}',
 217                        'section `{section}\' in @cite{{book}}' => 'sezione `{section}\' in @cite{{book}}',
 218                        'see ' => 'vedi ',
 219                        'see @cite{{book}}' => 'vedi @cite{{book}}',
 220                        'see section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'vedi la sezione `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}',
 221                        'see section `{section}\' in @cite{{book}}' => 'vedi la sezione `{section}\' in @cite{{book}}',
 222                        'see section {reference_name}' => 'vedi la sezione {reference_name}',
 223                        'see {node_file_href}' => 'vedi {node_file_href}',
 224                        'see {node_file_href} @cite{{book}}' => 'vedi {node_file_href} @cite{{book}}',
 225                        'see {node_file_href} section `{section}\' in @cite{{book}}' => 'vedi {node_file_href} nella sezione `{section}\' in @cite{{book}}',
 226                        'see {reference_name}' => 'vedi {reference_name}',
 227                        'see {ref}' => 'vedi {ref}',
 228                        'see {title_ref}' => 'vedi {title_ref}',
 229                        '{acronym_like} ({explanation})' => '{acronym_like} ({explanation})',
 230                        '{name} of {class}' => '{name} di {class}',
 231                        '{name} on {class}' => '{name} in {class}',
 232                        '{node_file_href}' => '{node_file_href}',
 233                        '{node_file_href} @cite{{book}}' => '{node_file_href} @cite{{book}}',
 234                        '{node_file_href} section `{section}\' in @cite{{book}}' => '{node_file_href} nella sezione `{section}\' in @cite{{book}}',
 235                        '{reference_name}' => '{reference_name}',
 236                        '{ref}' => '{ref}',
 237                        '{style} {number}' => '{style} {number}',
 238                        '{style}: {caption_first_line}' => '{style}: {caption_first_line}',
 239                        '{style}: {shortcaption_first_line}' => '{style}: {shortcaption_first_line}',
 240                        '{title_ref}' => '{title_ref}'
 241                      };
 242
 243 $LANGUAGES->{'hu'} = {
 244                        '  The buttons in the navigation panels have the following meaning:' => '  A navigációs panelen levő gombok jelentése a következő:',
 245                        '  where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '  @strong{ Példánkban } az aktuális pozíció az @strong{ 1.2.3 alalszakasz } egy olyan dokumentumban, melynek szerkezete a következő:',
 246                        ' Up ' => 'Fel',
 247                        '(outside of any element)' => '(bármelyik elemen kívül)',
 248                        '(outside of any node)' => '(bármelyik csomóponton kívül)',
 249                        '@b{{quotation_arg}:} ' => '@b{{quotation_arg}:} ',
 250                        '@cite{{book}}' => '@cite{{book}}',
 251                        '@{No value for `{value}\'@}' => '@{Nincs értéke ennek: `{value}\'@}',
 252                        'About' => 'Súgó',
 253                        'About (help)' => 'Segítség a navigációhoz',
 254                        'About This Document' => 'A navigációs panel használata',
 255                        'April' => 'április',
 256                        'August' => 'augusztus',
 257                        'Back' => 'Vissza',
 258                        'Back section in previous file' => 'Előző fájl hátsó szakasza',
 259                        'Beginning of this chapter or previous chapter' => 'Fejezet eleje vagy előző fejezet',
 260                        'Button' => 'Gomb',
 261                        'Contents' => 'Tartalom',
 262                        'Cover (top) of document' => 'Dokumentum címoldala',
 263                        'Current' => 'Aktuális',
 264                        'Current Position' => 'Aktuális pozíció',
 265                        'Current section' => 'Aktuális szakasz',
 266                        'December' => 'december',
 267                        'FastBack' => 'Visszaugrás',
 268                        'FastForward' => 'Előreugrás',
 269                        'February' => 'február',
 270                        'First' => 'Első',
 271                        'First section in reading order' => 'Első szakasz az olvasási sorrendben',
 272                        'Following' => 'Következő',
 273                        'Following node' => 'Következő csomópont',
 274                        'Footnotes' => 'Lábjegyzet',
 275                        'Forward' => 'Előre',
 276                        'Forward section in next file' => 'Következő fájl elülső szakasza',
 277                        'From 1.2.3 go to' => '1.2.3-ból ide jutunk',
 278                        'Go to' => 'Cél',
 279                        'Index' => 'Tárgymutató',
 280                        'Index Entry' => 'Tárgymutató-bejegyzés',
 281                        'January' => 'január',
 282                        'July' => 'július',
 283                        'Jump to' => 'Ugorj ide',
 284                        'June' => 'június',
 285                        'Last' => 'Utolsó',
 286                        'Last section in reading order' => 'Utolsó szakasz az olvasási sorrendben',
 287                        'March' => 'március',
 288                        'May' => 'május',
 289                        'Menu:' => 'Menü:',
 290                        'Name' => 'Név',
 291                        'Next' => 'Következő',
 292                        'Next chapter' => 'Következő fejezet',
 293                        'Next file' => 'Következő fájl',
 294                        'Next node' => 'Következő csomópont',
 295                        'Next section in reading order' => 'Következő szakasz az olvasási sorrendben',
 296                        'Next section on same level' => 'Következő szakasz ugyanazon a szinten',
 297                        'NextFile' => 'KövetkezőFájl',
 298                        'Node following in node reading order' => 'Következő csomópont az olvasási sorrendben',
 299                        'Node up' => 'Szülő csomópont',
 300                        'NodeNext' => 'KövetkezőCsomópont',
 301                        'NodePrev' => 'ElőzőCsomópont',
 302                        'NodeUp' => 'SzülőCsomópont',
 303                        'November' => 'november',
 304                        'October' => 'október',
 305                        'Overview' => 'Áttekintés',
 306                        'Prev' => 'Előző',
 307                        'PrevFile' => 'ElőzőFájl',
 308                        'Previous' => 'Előző',
 309                        'Previous file' => 'Előző fájl',
 310                        'Previous node' => 'Előző csomópont',
 311                        'Previous section in reading order' => 'Előző szakasz az olvasási sorrendben',
 312                        'Previous section on same level' => 'Előző szakasz ugyanazon a szinten',
 313                        'Section' => 'Szakasz',
 314                        'Section One' => 'szakasz',
 315                        'See ' => 'Ld. ',
 316                        'See @cite{{book}}' => 'Ld. @cite{{book}}',
 317                        'See section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'Ld. ezt a szakaszt: `@asis{}`{section_name}\'@asis{}\' itt: @cite{{book}}',
 318                        'See section `{section}\' in @cite{{book}}' => 'Ld. ezt a szakaszt: `{section}\' itt: @cite{{book}}',
 319                        'See section {reference_name}' => 'Ld. ezt a szakaszt: {reference_name}',
 320                        'See {node_file_href}' => 'Ld. {node_file_href}',
 321                        'See {node_file_href} @cite{{book}}' => 'See {node_file_href} @cite{{book}}',
 322                        'See {node_file_href} section `{section}\' in @cite{{book}}' => 'Ld. {node_file_href} ezt a szakaszt: `{section}\' itt: @cite{{book}}',
 323                        'See {reference_name}' => 'Ld. {reference_name}',
 324                        'See {ref}' => 'Ld. {ref}',
 325                        'See {title_ref}' => 'Ld. {title_ref}',
 326                        'September' => 'szeptember',
 327                        'Short Table of Contents' => 'Rövid tartalomjegyzék',
 328                        'Short table of contents' => 'Rövid tartalomjegyzék',
 329                        'Subsection One-Four' => 'alszakasz',
 330                        'Subsection One-One' => 'alszakasz',
 331                        'Subsection One-Three' => 'alszakasz',
 332                        'Subsection One-Two' => 'alszakasz',
 333                        'Subsubsection One-Two-Four' => 'alalszakasz',
 334                        'Subsubsection One-Two-One' => 'alalszakasz',
 335                        'Subsubsection One-Two-Three' => 'alalszakasz',
 336                        'Subsubsection One-Two-Two' => 'alalszakasz',
 337                        'T2H_today' => '%s, %d %d',
 338                        'Table of Contents' => 'Tartalomjegyzék',
 339                        'Table of contents' => 'Tartalomjegyzék',
 340                        'The node you are looking for is at {href}.' => 'A keresett csomópont itt található: {href}.',
 341                        'This' => 'Ez a(z)',
 342                        'This document was generated on @i{{date}} using @uref{{program_homepage}, @i{{program}}}.' => 'Ezt a dokumentumot @i{{date}} napon generálta a(z) @uref{{program_homepage}, @i{{program}}}.',
 343                        'This document was generated using @uref{{program_homepage}, @emph{{program}}}.' => 'Ezt a dokumentumot a(z) @uref{{program_homepage}, @emph{{program}}} generálta.',
 344                        'Top' => 'Címoldal',
 345                        'Untitled Document' => 'Névtelen dokumentum',
 346                        'Up' => 'Fel',
 347                        'Up node' => 'Szülő csomópont',
 348                        'Up section' => 'Szülő szakasz',
 349                        'current' => 'aktuális',
 350                        'on @emph{{date}}' => 'ekkor: @emph{{date}}',
 351                        'section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'szakasz: `@asis{}`{section_name}\'@asis{}\' itt: @cite{{book}}',
 352                        'section `{section}\' in @cite{{book}}' => 'szakasz: `{section}\' itt: @cite{{book}}',
 353                        'see ' => 'ld. ',
 354                        'see @cite{{book}}' => 'ld. @cite{{book}}',
 355                        'see section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => 'ld. ezt a szakaszt: `@asis{}`{section_name}\'@asis{}\' itt: @cite{{book}}',
 356                        'see section `{section}\' in @cite{{book}}' => 'ld. ezt a szakaszt: `{section}\' itt: @cite{{book}}',
 357                        'see section {reference_name}' => 'ld. ezt a szakaszt: {reference_name}',
 358                        'see {node_file_href}' => 'ld. {node_file_href}',
 359                        'see {node_file_href} @cite{{book}}' => 'ld. {node_file_href} @cite{{book}}',
 360                        'see {node_file_href} section `{section}\' in @cite{{book}}' => 'ld. {node_file_href} ezt a szakaszt: `{section}\' itt: @cite{{book}}',
 361                        'see {reference_name}' => 'ld. {reference_name}',
 362                        'see {ref}' => 'ld. {ref}',
 363                        'see {title_ref}' => 'ld. {title_ref}',
 364                        '{acronym_like} ({explanation})' => '{acronym_like} ({explanation})',
 365                        '{name} of {class}' => '{name} típusa: {class}',
 366                        '{name} on {class}' => '{name} ezen: {class}',
 367                        '{node_file_href}' => '{node_file_href}',
 368                        '{node_file_href} @cite{{book}}' => '{node_file_href} @cite{{book}}',
 369                        '{node_file_href} section `{section}\' in @cite{{book}}' => '{node_file_href} szakasz: `{section}\' itt: @cite{{book}}',
 370                        '{reference_name}' => '{reference_name}',
 371                        '{ref}' => '{ref}',
 372                        '{style} {number}' => '{style} {number}',
 373                        '{style}: {caption_first_line}' => '{style}: {caption_first_line}',
 374                        '{style}: {shortcaption_first_line}' => '{style}: {shortcaption_first_line}',
 375                        '{title_ref}' => '{title_ref}'
 376                      };
 377
 378 $LANGUAGES->{'ja'} = {
 379                        '  The buttons in the navigation panels have the following meaning:' => '  ナビゲーション パネルの中にあるボタンには以下のような意味があります:',
 380                        '  where the @strong{ Example } assumes that the current position is at @strong{ Subsubsection One-Two-Three } of a document of the following structure:' => '  この表で、@strong{ 行き先 } は、現在の位置が以下のような構造を持つドキュメントの @strong{ サブサブセクション 1-2-3 } であると仮定しています:',
 381                        ' Up ' => ' 上へ ',
 382                        '(outside of any element)' => '(outside of any element)',
 383                        '(outside of any node)' => '(outside of any node)',
 384                        '@b{{quotation_arg}:} ' => '@b{{quotation_arg}:} ',
 385                        '@cite{{book}}' => '@cite{{book}}',
 386                        '@{No value for `{value}\'@}' => '@{No value for `{value}\'@}',
 387                        'About' => '情報',
 388                        'About (help)' => '情報 (ヘルプ)',
 389                        'About This Document' => 'このドキュメントについて',
 390                        'April' => '4 月',
 391                        'August' => '8 月',
 392                        'Back' => 'Back',
 393                        'Back section in previous file' => '',
 394                        'Beginning of this chapter or previous chapter' => 'この章あるいは前の章の先頭',
 395                        'Button' => 'ボタン',
 396                        'Contents' => '目次',
 397                        'Cover (top) of document' => 'ドキュメントの表紙 (先頭)',
 398                        'Current' => '',
 399                        'Current Position' => '現在の位置',
 400                        'Current section' => '',
 401                        'December' => '12 月',
 402                        'FastBack' => '',
 403                        'FastForward' => '',
 404                        'February' => '2 月',
 405                        'First' => '',
 406                        'First section in reading order' => '',
 407                        'Following' => '',
 408                        'Following node' => '',
 409                        'Footnotes' => '脚注',
 410                        'Forward' => '',
 411                        'Forward section in next file' => '',
 412                        'From 1.2.3 go to' => '1.2.3 からの行き先',
 413                        'Go to' => '行き先',
 414                        'Index' => 'インデックス',
 415                        'Index Entry' => 'インデックス エントリ',
 416                        'January' => '1 月',
 417                        'July' => '7 月',
 418                        'Jump to' => '',
 419                        'June' => '6月',
 420                        'Last' => '',
 421                        'Last section in reading order' => '',
 422                        'March' => '3 月',
 423                        'May' => '5 月',
 424                        'Menu:' => 'メニュー',
 425                        'Name' => '',
 426                        'Next' => '',
 427                        'Next chapter' => '次の章',
 428                        'Next file' => '',
 429                        'Next node' => '',
 430                        'Next section in reading order' => '次のセクション',
 431                        'Next section on same level' => '',
 432                        'NextFile' => '',
 433                        'Node following in node reading order' => '',
 434                        'Node up' => '',
 435                        'NodeNext' => '',
 436                        'NodePrev' => '',
 437                        'NodeUp' => '',
 438                        'November' => '11 月',
 439                        'October' => '10 月',
 440                        'Overview' => '概要',
 441                        'Prev' => '',
 442                        'PrevFile' => '',
 443                        'Previous' => '',
 444                        'Previous file' => '',
 445                        'Previous node' => '',
 446                        'Previous section in reading order' => '前のセクション',
 447                        'Previous section on same level' => '',
 448                        'Section' => 'セクション',
 449                        'Section One' => 'セクション 1',
 450                        'See ' => '',
 451                        'See @cite{{book}}' => '',
 452                        'See section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => '',
 453                        'See section `{section}\' in @cite{{book}}' => '',
 454                        'See section {reference_name}' => '',
 455                        'See {node_file_href}' => '',
 456                        'See {node_file_href} @cite{{book}}' => '',
 457                        'See {node_file_href} section `{section}\' in @cite{{book}}' => '',
 458                        'See {reference_name}' => '',
 459                        'See {ref}' => '',
 460                        'See {title_ref}' => '',
 461                        'September' => '9 月',
 462                        'Short Table of Contents' => '',
 463                        'Short table of contents' => '',
 464                        'Subsection One-Four' => 'サブセクション 1-4',
 465                        'Subsection One-One' => 'サブセクション 1-1',
 466                        'Subsection One-Three' => 'サブセクション 1-3',
 467                        'Subsection One-Two' => 'サブセクション 1-2',
 468                        'Subsubsection One-Two-Four' => 'サブサブセクション 1-2-4',
 469                        'Subsubsection One-Two-One' => 'サブサブセクション 1-2-1',
 470                        'Subsubsection One-Two-Three' => 'サブサブセクション 1-2-3',
 471                        'Subsubsection One-Two-Two' => 'サブサブセクション 1-2-2',
 472                        'T2H_today' => '%s, %d %d',
 473                        'Table of Contents' => '目次',
 474                        'Table of contents' => '目次',
 475                        'The node you are looking for is at {href}.' => '',
 476                        'This' => '',
 477                        'This document was generated on @i{{date}} using @uref{{program_homepage}, @i{{program}}}.' => 'このドキュメントは @i{{date}} に、@uref{{program_homepage}, @i{{program}}} を用いて生成されました。',
 478                        'This document was generated using @uref{{program_homepage}, @emph{{program}}}.' => 'このドキュメントは @uref{{program_homepage}, @emph{{program}}} を用いて生成されました。',
 479                        'Top' => 'トップ',
 480                        'Untitled Document' => '',
 481                        'Up' => '上',
 482                        'Up node' => '',
 483                        'Up section' => '上のセクション',
 484                        'current' => '',
 485                        'on @emph{{date}}' => '@emph{{date}} に',
 486                        'section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => '',
 487                        'section `{section}\' in @cite{{book}}' => '',
 488                        'see ' => '',
 489                        'see @cite{{book}}' => '',
 490                        'see section `@asis{}`{section_name}\'@asis{}\' in @cite{{book}}' => '',
 491                        'see section `{section}\' in @cite{{book}}' => '',
 492                        'see section {reference_name}' => '',
 493                        'see {node_file_href}' => '',
 494                        'see {node_file_href} @cite{{book}}' => '',
 495                        'see {node_file_href} section `{section}\' in @cite{{book}}' => '',
 496                        'see {reference_name}' => '',
 497                        'see {ref}' => '',
 498                        'see {title_ref}' => '',
 499                        '{acronym_like} ({explanation})' => '{acronym_like} ({explanation})',
 500                        '{name} of {class}' => '',
 501                        '{name} on {class}' => '',
 502                        '{node_file_href}' => '',
 503                        '{node_file_href} @cite{{book}}' => '',
 504                        '{node_file_href} section `{section}\' in @cite{{book}}' => '',
 505                        '{reference_name}' => '',
 506                        '{ref}' => '{ref}',
 507                        '{style} {number}' => '{style} {number}',
 508                        '{style}: {caption_first_line}' => '{style}: {caption_first_line}',
 509                        '{style}: {shortcaption_first_line}' => '{style}: {shortcaption_first_line}',
 510                        '{title_ref}' => '{title_ref}'
 511                      };
 512
 513
 514 sub ly_get_string () {
 515     my $lang = $Texi2HTML::THISDOC{current_lang};
 516     my $string = shift;
 517     if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) {
 518         return $LY_LANGUAGES->{$lang}->{$string};
 519     } else {
 520         return $string;
 521     }
 522 }
 523
 524
 525 #############################################################################
 526 ### FUNCTIONALITY FOR MAIN WEB PAGES
 527 #############################################################################
 528
 529 our $web_manual;
 530
 531 #############################################################################
 532 ###  SETTINGS FOR TEXI2HTML
 533 #############################################################################
 534
 535 # Validation fix for texi2html<=1.82
 536 $Texi2HTML::Config::DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
 537
 538 @Texi2HTML::Config::CSS_REFS = (
 539     {FILENAME => "lilypond-mccarty.css", TITLE => "Default style"}
 540     );
 541 @Texi2HTML::Config::ALT_CSS_REFS      = (
 542     {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
 543     {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
 544 );
 545
 546 sub web_settings() {
 547   print STDERR "Initializing settings for web site\n";
 548   $Texi2HTML::Config::BODYTEXT = "";
 549   @Texi2HTML::Config::CSS_REFS      = (
 550       {FILENAME => "lilypond-web.css", TITLE => "Patrick McCarty's design"}
 551       );
 552   @Texi2HTML::Config::ALT_CSS_REFS      = (
 553       {FILENAME => "lilypond-web-alt1.css", TITLE => "Alternate style 1"},
 554       {FILENAME => "lilypond-web-alt2.css", TITLE => "Alternate style 2"},
 555       );
 556 }
 557
 558 $Texi2HTML::Config::USE_ACCESSKEY = 1;
 559 $Texi2HTML::Config::USE_LINKS     = 1;
 560 $Texi2HTML::Config::USE_REL_REV   = 1;
 561 $Texi2HTML::Config::SPLIT_INDEX   = 0;
 562 $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
 563
 564 if ($Texi2HTML::Config::SPLIT eq 'section' or
 565     $Texi2HTML::Config::SPLIT eq 'node') {
 566   $Texi2HTML::Config::element_file_name    = \&lilypond_element_file_name;
 567 }
 568
 569 $Texi2HTML::Config::element_target_name  = \&lilypond_element_target_name;
 570 $default_print_element_header = $Texi2HTML::Config::print_element_header;
 571 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
 572 $Texi2HTML::Config::print_page_foot      = \&print_lilypond_page_foot;
 573 $Texi2HTML::Config::print_navigation     = \&lilypond_print_navigation;
 574 $Texi2HTML::Config::external_ref         = \&lilypond_external_ref;
 575 $default_external_href = $Texi2HTML::Config::external_href;
 576 $Texi2HTML::Config::external_href        = \&lilypond_external_href;
 577 $default_toc_body = $Texi2HTML::Config::toc_body;
 578 $Texi2HTML::Config::toc_body             = \&lilypond_toc_body;
 579 $Texi2HTML::Config::css_lines            = \&lilypond_css_lines;
 580 $default_unknown = $Texi2HTML::Config::unknown;
 581 $Texi2HTML::Config::unknown              = \&lilypond_unknown;
 582 $default_print_page_head = $Texi2HTML::Config::print_page_head;
 583 $Texi2HTML::Config::print_page_head      = \&lilypond_print_page_head;
 584 # $Texi2HTML::Config::foot_line_and_ref    = \&lilypond_foot_line_and_ref;
 585 $Texi2HTML::Config::foot_line_and_ref  = \&makeinfo_like_foot_line_and_ref;
 586 $Texi2HTML::Config::foot_lines         = \&makeinfo_like_foot_lines;
 587 $Texi2HTML::Config::paragraph          = \&makeinfo_like_paragraph;
 588
 589
 590
 591 # Examples should be formatted similar to quotes:
 592 $Texi2HTML::Config::complex_format_map->{'example'} = {
 593   'begin' => q{"<blockquote>"},
 594   'end' => q{"</blockquote>\n"},
 595   'style' => 'code',
 596  };
 597
 598 %Texi2HTML::config::misc_pages_targets = (
 599    'Overview' => 'Overview',
 600    'Contents' => 'Contents',
 601    'About' => 'About'
 602 );
 603
 604
 605 my @section_to_filename;
 606
 607
 608
 609
 610 #############################################################################
 611 ###  DEBUGGING
 612 #############################################################################
 613
 614 use Data::Dumper;
 615 $Data::Dumper::Maxdepth = 2;
 616
 617 sub print_element_info($)
 618 {
 619   my $element = shift;
 620   print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
 621   print "Element: $element\n";
 622   print Dumper($element);
 623 }
 624
 625
 626
 627
 628
 629 #############################################################################
 630 ###  HELPER FUNCTIONS
 631 #############################################################################
 632
 633 # Convert a given node name to its proper file name (normalization as explained
 634 # in the texinfo manual:
 635 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
 636 sub texinfo_file_name($)
 637 {
 638   my $text = shift;
 639   my $result = '';
 640   # File name normalization by texinfo:
 641   # 1/2: letters and numbers are left unchanged
 642   # 3/4: multiple, leading and trailing whitespace is removed
 643   $text = main::normalise_space($text);
 644   # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
 645   #      chars are replaced by _xxxx (xxxx=ascii character code)
 646   while ($text ne '') {
 647     if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
 648       $result .= $1;
 649     } elsif ($text =~ s/^ //o) { # space -> '-'
 650       $result .= '-';
 651     } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
 652       my $ccode = ord($1);
 653       if ( $ccode <= 0xFFFF ) {
 654         $result .= sprintf("_%04x", $ccode);
 655       } else {
 656         $result .= sprintf("__%06x", $ccode);
 657       }
 658     }
 659   }
 660   # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
 661   if ($result !~ /^[a-zA-Z]/) {
 662     $result = 't_g' . $result;
 663   }
 664   # DONE
 665   return lc($result)
 666 }
 667
 668 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
 669 # NODENAME\tFILENAME\tANCHOR
 670 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
 671 sub load_map_file ($)
 672 {
 673   my $mapfile = shift;
 674   my $node_map = ();
 675
 676   # For some unknown reason, Perl on my system (5.10.0 on Fedora 12)
 677   # refuses to open map files of translated documents with
 678   # '<:encoding(utf8)', but decoding from UTF-8 line by line works. -jm
 679   if (open(XREFFILE,'<', $mapfile)) {
 680     my $line;
 681     # print STDERR "*** PRINTING MAP FILE LINES ***\n";
 682     while ( $line = decode ('UTF-8', <XREFFILE>) ) {
 683       # parse the tab-separated entries and insert them into the map:
 684       chomp($line);
 685       my @entries = split(/\t/, $line);
 686       if (scalar (@entries) == 3) {
 687         $node_map->{$entries[0]} = [$entries[1], $entries[2]];
 688         $, = " ";
 689         # print STDERR @entries;
 690         # print STDERR "\n";
 691       } else {
 692         print STDERR "Invalid entry in the node file $mapfile: $line\n";
 693       }
 694     }
 695     close (XREFFILE);
 696   } else {
 697     print STDERR "WARNING: Unable to load the map file $mapfile\n";
 698   }
 699   return $node_map;
 700 }
 701
 702
 703 # Split the given path into dir and basename (with .texi removed). Used mainly
 704 # to get the path/basename of the original texi input file
 705 sub split_texi_filename ($)
 706 {
 707   my $docu = shift;
 708   my ($docu_dir, $docu_name);
 709   if ($docu =~ /(.*\/)/) {
 710     chop($docu_dir = $1);
 711     $docu_name = $docu;
 712     $docu_name =~ s/.*\///;
 713   } else {
 714      $docu_dir = '.';
 715      $docu_name = $docu;
 716   }
 717   $docu_name =~ s/\.te?x(i|info)?$//;
 718   return ($docu_dir, $docu_name);
 719 }
 720
 721
 722
 723
 724
 725 #############################################################################
 726 ###  CSS HANDLING
 727 #############################################################################
 728
 729 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
 730 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
 731 sub lilypond_css_lines ($$)
 732 {
 733   my $import_lines = shift;
 734   my $rule_lines = shift;
 735   return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
 736   if (@$rule_lines or @$import_lines)
 737   {
 738     $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
 739     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
 740     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
 741     $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
 742   }
 743   foreach my $ref (@CSS_REFS)
 744   {
 745     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 746         "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
 747   }
 748   foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
 749   {
 750     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 751         "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
 752   }
 753   # FIXME: the website doesn't use ie7-specific fixes; do the
 754   # docs still need this?  -gp
 755   $Texi2HTML::THISDOC{'CSS_LINES'} .=
 756       "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
 757 }
 758
 759
 760
 761
 762
 763 #############################################################################
 764 ###  SPLITTING BASED ON NUMBERED SECTIONS
 765 #############################################################################
 766
 767 my $lastfilename;
 768 my $docnr = 0;
 769 my $node_to_filename_map = ();
 770
 771
 772 # This function makes sure that files are only generated for numbered sections,
 773 # but not for unnumbered ones. It is called after texi2html has done its own
 774 # splitting and simply returns the filename for the node given as first argument
 775 # Nodes with the same filename will be printed out to the same filename, so
 776 # this really all we need. Also, make sure that the file names for sections
 777 # are derived from the section title. We also might want to name the anchors
 778 # according to node titles, which works by simply overriding the id element of
 779 # the $element hash.
 780 # If an external nodename<=>filename/anchor map file is found (loaded in
 781 # the command handler, use the externally created values, otherwise use the
 782 # same logic here.
 783 sub lilypond_element_file_name($$$)
 784 {
 785   my $element = shift;
 786   my $type = shift;
 787   my $docu_name = shift;
 788   my $docu_ext = $Texi2HTML::Config::EXTENSION;
 789
 790   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 791   # the snippets page does not use nodes for the snippets, so in this case
 792   # we'll have to use the section name!
 793   if ($node_name eq '') {
 794     $node_name = main::remove_texi($element->{'texi'});
 795   }
 796
 797   # If we have an entry in the section<=>filename map, use that one, otherwise
 798   # generate the filename/anchor here. In the latter case, external manuals
 799   # will not be able to retrieve the file name for xrefs!!! Still, I already
 800   # had that code, so I'll leave it in in case something goes wrong with the
 801   # extract_texi_filenames.py script in the lilypond build process!
 802   if (exists ($node_to_filename_map->{$node_name})) {
 803     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 804     $filename .= ".$docu_ext" if (defined($docu_ext));
 805     $filename = lc($filename);
 806
 807     # unnumbered sections (except those at top-level!) always go to the same
 808     # file as the previous numbered section
 809     if (not ($web_manual) and not ($element->{number})
 810         and not ($lastfilename eq '') and ($element->{level} > 1)) {
 811       $filename = $lastfilename;
 812     }
 813     if (($filename eq $lastfilename)) {
 814       $$element{doc_nr} = $docnr;
 815     } else {
 816       $docnr += 1;
 817       $$element{doc_nr} = $docnr;
 818       $lastfilename = $filename;
 819     }
 820     print STDERR "Output file name: $filename\n";
 821     return $filename;
 822
 823   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or
 824            $type eq "stoc" or $type eq "foot" or $type eq "about") {
 825     return;
 826   } else {
 827     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
 828         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
 829                or ($node_name =~ /NOT REALLY USED/);
 830
 831     # Numbered sections will get a filename Node_title, unnumbered sections will use
 832     # the file name of the previous numbered section:
 833     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
 834       # normalize to the same file name as texinfo
 835       if ($element->{translationof}) {
 836         $node_name = main::remove_texi($element->{translationof});
 837       }
 838       my $filename = texinfo_file_name($node_name);
 839       $filename .= ".$docu_ext" if (defined($docu_ext));
 840       $filename = lc($filename);
 841       $docnr += 1;
 842       $$element{doc_nr} = $docnr;
 843       $lastfilename = $filename;
 844       print STDERR "File name: $filename\n";
 845       return $filename;
 846     } else {
 847       $$element{doc_nr} = $docnr;
 848       $filename = lc ($filename);
 849       print STDERR "File name: $filename\n";
 850       return $filename;
 851     }
 852   }
 853
 854   return;
 855 }
 856
 857 sub lilypond_element_target_name($$$)
 858 {
 859   my $element = shift;
 860   my $target = shift;
 861   my $id = shift;
 862   # Target is based on node name (or sec name for secs without node attached)
 863   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 864   if ($node_name eq '') {
 865     $node_name = main::remove_texi($element->{'texi'});
 866   }
 867
 868   # If we have an entry in the section<=>filename map, use that one, otherwise
 869   # generate the anchor here.
 870   if (exists ($node_to_filename_map->{$node_name})) {
 871     (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
 872   } else {
 873     my $anchor = $node_name;
 874     if ($element->{translationof}) {
 875       $anchor = main::remove_texi($element->{translationof});
 876     }
 877     # normalize to the same file name as texinfo
 878     $target = texinfo_file_name($anchor);
 879   }
 880   # TODO: Once texi2html correctly prints out the target and not the id for
 881   #       the sections, change this back to ($id, $target)
 882   # I don't understand this comment, so I'm reluctant to delete it -gp
 883   $target = lc($target);
 884   if ($target eq lc($id)) {
 885     $id = "";
 886   } else {
 887     $id = substr($id, 0, - 2); # remove the "-1"
 888   }
 889   return ($id, $target);
 890 }
 891
 892
 893 ## Load the map file for the corrently processed texi file. We do this
 894 #  using a command init handler, since texi2html does not have any
 895 #  other hooks that are called after THISDOC is filled but before phase 2
 896 #  of the texi2html conversion.
 897 sub lilypond_init_map ()
 898 {
 899     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 900     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 901         || main::locate_include_file ("${docu_name}.xref-map");
 902     print STDERR "Map filename is: $map_filename\nDocu name is $docu_name\n";
 903     if ($docu_name eq 'web') {
 904         $web_manual = 1;
 905         web_settings();
 906     }
 907     $node_to_filename_map = load_map_file ($map_filename);
 908 }
 909 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
 910
 911
 912
 913 #############################################################################
 914 ###  CLEANER LINK TITLE FOR EXTERNAL REFS
 915 #############################################################################
 916
 917 # The default formatting of external refs returns e.g.
 918 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
 919 # file_and_node argument. Also, we want only a very simple format, so we don't
 920 # even call the default handler!
 921 sub lilypond_external_ref($$$$$$)
 922 {
 923   my $type = shift;
 924   my $section = shift;
 925   my $book = shift;
 926   my $file_node = shift;
 927   my $href = shift;
 928
 929   # only lc() the last portion:
 930   my @htmlsplit = split('/', $href);
 931   # change the last portion (the filename)
 932   @htmlsplit[$#array] = lc( @htmlsplit[$#array] );
 933   $href = join("/", @htmlsplit);
 934
 935   my $cross_ref = shift;
 936
 937   my $displaytext = '';
 938
 939   # 1) if we have a cross ref name, that's the text to be displayed:
 940   # 2) For the top node, use the (printable) name of the manual, unless we
 941   #    have an explicit cross ref name
 942   # 3) In all other cases use the section name
 943   if ($cross_ref ne '') {
 944     $displaytext = $cross_ref;
 945   } elsif (($section eq '') or ($section eq 'Top')) {
 946     $displaytext = $book;
 947   } else {
 948     $displaytext = $section;
 949   }
 950
 951   $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
 952   return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
 953 }
 954
 955
 956
 957
 958
 959 #############################################################################
 960 ###  HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
 961 ###                  map stored on disk, xrefs in other manuals load that map
 962 #############################################################################
 963
 964
 965 # Try to make use of @translationof to generate files according to the original
 966 # English section title...
 967 sub lilypond_unknown($$$$$)
 968 {
 969     my $macro = shift;
 970     my $line = shift;
 971     my $pass = shift;
 972     my $stack = shift;
 973     my $state = shift;
 974
 975     # the @translationof macro provides the original English section title,
 976     # which should be used for file/anchor naming, while the title will be
 977     # translated to each language
 978     # It is already used by extract_texi_filenames.py, so this should not be
 979     # necessary here at all. Still, I'll leave the code in just in case the
 980     # python script messed up ;-)
 981     if ($pass == 1 and $macro eq "translationof") {
 982       if (ref($state->{'element'}) eq 'HASH') {
 983         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 984       }
 985       return ('', 1, undef, undef);
 986     } else {
 987       return &$default_unknown($macro, $line, $pass, $stack, $state);
 988     }
 989 }
 990
 991
 992 my %translated_books = ();
 993 # Construct a href to an external source of information.
 994 # node is the node with texinfo @-commands
 995 # node_id is the node transliterated and transformed as explained in the
 996 #         texinfo manual
 997 # node_xhtml_id is the node transformed such that it is unique and can
 998 #     be used to make an html cross ref as explained in the texinfo manual
 999 # file is the file in '(file)node'
1000 sub lilypond_external_href($$$)
1001 {
1002   my $node = shift;
1003   my $node_id = shift;
1004   my $node_hxmlt_id = shift;
1005   my $file = shift;
1006
1007   # 1) Keep a hash of book->section_map
1008   # 2) if not file in keys hash => try to load the map (assign empty map if
1009   #    non-existent => will load only once!)
1010   # 3) if node in the section=>(file, anchor) map, replace node_id and
1011   #    node_xhtml_id by the map's values
1012   # 4) call the default_external_href with these values (or the old ones if not found)
1013
1014   if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
1015     my $map_name = $file;
1016     $map_name =~ s/-big-page//;
1017
1018     # Load the map if we haven't done so already
1019     if (!exists($translated_books{$map_name})) {
1020       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
1021       my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
1022           || main::locate_include_file ("${map_name}.xref-map");
1023       $translated_books{$map_name} = load_map_file ($map_filename);
1024     }
1025
1026     # look up translation. use these values instead of the old filename/anchor
1027     my $section_name_map = $translated_books{$map_name};
1028     my $node_text = main::remove_texi($node);
1029     if (defined($section_name_map->{$node_text})) {
1030       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
1031     } else {
1032       print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
1033     }
1034   }
1035
1036   if (defined $file) {
1037     $href = &$default_external_href($node, $node_id, $node_hxmlt_id, lc($file));
1038     remove_unneeded_anchor($href);
1039
1040     # TODO: very yucky, but will be fixed in issue 1004
1041     if ($web_manual) {
1042       my $only_web = $ENV{ONLY_WEB};
1043       if ($only_web) {
1044         $href = "../../doc/v2.13/Documentation/web/".$href;
1045       }
1046     }
1047
1048     return $href;
1049   } else {
1050     $href = &$default_external_href($node, $node_id, $node_hxmlt_id);
1051     remove_unneeded_anchor($href);
1052     return $href;
1053   }
1054 }
1055
1056 sub remove_unneeded_anchor($)
1057 {
1058   my $ref = shift;
1059   my @hrefsplit = split("/", $href);
1060   for ($i = 0; $i < @hrefsplit; $i++) {
1061     $item = @hrefsplit[$i];
1062     if ($item =~ /#/) {
1063       @splitted = split("#", $item);
1064       if (@splitted[0] == @splitted[1]) {
1065         @hrefsplit[$i] = @splitted[0]
1066       }
1067     }
1068   }
1069   $href = join("/", @hrefsplit);
1070   return $href
1071 }
1072
1073
1074
1075 #############################################################################
1076 ###  CUSTOM TOC FOR EACH PAGE (in a frame on the left)
1077 #############################################################################
1078
1079 my $page_toc_depth = 2;
1080 my @default_toc = [];
1081
1082 # Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
1083 sub lilypond_init_toc_depth ()
1084 {
1085   if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})
1086       and not $web_manual) {
1087     $page_toc_depth = 1;
1088   }
1089 }
1090 # Set the TOC-depth (depending on a texinfo variable short_toc) in a
1091 # command-handler, so we have them available when creating the pages
1092 push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
1093
1094
1095
1096 # recursively generate the TOC entries for the element and its children (which
1097 # are only shown up to maxlevel. All ancestors of the current element are also
1098 # shown with their immediate children, irrespective of their level.
1099 # Unnumbered entries are only printed out if they are at top-level or 2nd level
1100 # or their parent element is an ancestor of the currently viewed node.
1101 # The conditions to call this method to print the entry for a child node is:
1102 # -) the parent is an ancestor of the current page node
1103 # -) the parent is a numbered element at top-level toplevel (i.e. show numbered
1104 #    and unnumbered 2nd-level children of numbered nodes)
1105 # -) the child element is a numbered node below level maxlevel
1106 sub generate_ly_toc_entries($$$$$)
1107 {
1108   my $element = shift;
1109   my $element_path = shift;
1110   my $maxlevel = shift;
1111   if ($web_manual) {
1112     $maxlevel = 1;
1113   }
1114   my $child_count = shift;
1115   my $current_element = shift;
1116   # Skip undefined sections, plus all sections generated by index splitting
1117   return() if (not defined($element) or exists($element->{'index_page'}));
1118   my @result = ();
1119   my $level = $element->{'toc_level'};
1120   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
1121   my $ind = '  ' x $level;
1122   my $this_css_class = " class=\"";
1123   # color indices for the second navigation bar on the website
1124   if ($web_manual) {
1125       my %color_maps = (
1126           'introduction' => [2, 2, 2, 2, 3, 3, 4, 4],
1127           'download' => [2, 2, 2, 3, 3, 4],
1128           'manuals' => [1, 1, 1, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4],
1129           'community' => [1, 1, 1, 2, 2, 2, 3, 3],
1130           );
1131       my $addColor = "colorDefault";
1132       while (($top_section, $color_indices) = each %color_maps) {
1133           if (index ($element->{'sectionup'}->{'file'}, $top_section) >= 0) {
1134               $addColor = "color" . $color_indices->[$child_count];
1135           }
1136       }
1137       $this_css_class .= $addColor;
1138   }
1139   $this_css_class .= $is_parent_of_current ? ' toc_current"' : '"';
1140   my $entry = "$ind<li$this_css_class>" .
1141       &$anchor ($element->{'tocid'},
1142                 "$element->{'file'}#$element->{'target'}",
1143                 $element->{'text'});
1144
1145   push (@result, $entry);
1146   my $children = $element->{'section_childs'};
1147   if (defined($children) and (ref($children) eq "ARRAY")) {
1148     my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
1149     my @child_result = ();
1150     my $sub_child_count = 0;
1151     foreach my $c (@$children) {
1152       my $is_numbered_child = defined ($c->{'number'});
1153       my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
1154       if ($force_children or ($is_numbered_child and $below_maxlevel)) {
1155         my @child_res =
1156             generate_ly_toc_entries($c, $element_path, $maxlevel, $sub_child_count, $current_element);
1157         push (@child_result, @child_res);
1158         $sub_child_count += 1;
1159       }
1160     }
1161     # if no child nodes were generated, e.g. for the index, where expanded pages
1162     # are ignored, don't generate a list at all...
1163     if (@child_result) {
1164       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
1165       if ($web_manual) {
1166         push (@result, "$ind<li class=\"colorDefault" .
1167               ($element->{'text'} eq $current_element->{'text'} ?
1168                ' toc_current">' : '">') .
1169               &$anchor ($element->{'tocid'},
1170                         "$element->{'file'}#$element->{'target'}",
1171                         $element->{'text'}) . "</li>\n");
1172       }
1173       push (@result, @child_result);
1174       push (@result, "$ind</ul>\n");
1175     }
1176   }
1177   push (@result, "$ind</li>\n");
1178   return @result;
1179 }
1180
1181
1182 # Print a customized TOC, containing only the first two levels plus the whole
1183 # path to the current page
1184 sub lilypond_generate_page_toc_body($)
1185 {
1186     my $element = shift;
1187     my $current_element = $element;
1188     my %parentelements;
1189     $parentelements{$element->{'id'}} = 1;
1190     # Find the path to the current element
1191     while ( defined($current_element->{'sectionup'}) and
1192            ($current_element->{'sectionup'} ne $current_element) )
1193     {
1194       $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
1195               if ($current_element->{'sectionup'}->{'id'} ne '');
1196       $current_element = $current_element->{'sectionup'};
1197       if ($web_manual) {
1198         if (exists($main::value{'shallow_toc'})) {
1199           last;
1200         }
1201       }
1202     }
1203     return () if not defined($current_element);
1204     # Create the toc entries recursively
1205     my @toc_entries = "";
1206     if ($web_manual) {
1207         @toc_entries = "<ul$NO_BULLET_LIST_ATTRIBUTE>\n";
1208         # FIXME: add link to main page, really hackily.
1209         if ($element->{'sectionup'}) {
1210             # it's not the top element
1211             push (@toc_entries, "<li><a href=\"index.html\">Main</a></li>\n");
1212         } else {
1213             push (@toc_entries,
1214                   "<li class=\"toc_current\"><a href=\"index.html\">Main</a></li>\n");
1215         }
1216     } else {
1217         push (@toc_entries, "<div class=\"contents\">\n");
1218         push (@toc_entries, "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
1219     }
1220     my $children = $current_element->{'section_childs'};
1221     foreach ( @$children ) {
1222       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0, $element));
1223     }
1224     # search box
1225     local $/=undef;
1226     my $name = "search-box";
1227     $lang = $Texi2HTML::THISDOC{current_lang};
1228     open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$lang/$name.ihtml" or
1229         open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$name.ihtml"  or
1230         die "no such file: $name.ihtml: $!";
1231     my $search_string = decode ('UTF-8', <FILE>);
1232     $search_string = "<li>\n" . $search_string . "</li>\n";
1233     push (@toc_entries, $search_string);
1234     close FILE;
1235
1236     push (@toc_entries, "</ul>\n");
1237     if ($web_manual) {
1238         push (@toc_entries, "\n");
1239     } else {
1240         push (@toc_entries, "</div>\n");
1241     }
1242     return @toc_entries;
1243 }
1244
1245 sub lilypond_print_toc_div ($$)
1246 {
1247   my $fh = shift;
1248   my $tocref = shift;
1249   my @lines = @$tocref;
1250   # use default TOC if no custom lines have been generated
1251   @lines = @default_toc if (not @lines);
1252   if (@lines) {
1253
1254     print $fh "\n\n<div id=\"tocframe\">\n";
1255
1256     # Remove the leading "GNU LilyPond --- " from the manual title
1257     my $topname = $Texi2HTML::NAME{'Top'};
1258     $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
1259
1260     # construct the top-level Docs index (relative path and including language!)
1261     my $lang = $Texi2HTML::THISDOC{current_lang};
1262     if ($lang and $lang ne "en") {
1263       $lang .= ".";
1264     } else {
1265       $lang = "";
1266     }
1267     my $reldir = $ENV{DEPTH};
1268     my $uplink = $reldir."/Documentation/web/manuals.${lang}html";
1269
1270     if (not $web_manual) {
1271       print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
1272          title=\"Documentation Index\">&lt;&lt; " .
1273          &ly_get_string ('Back to Documentation Index') .
1274          "</a></p>\n";
1275
1276       print $fh '<h4 class="toc_header"> ' . &$anchor('',
1277                                     $Texi2HTML::HREF{'Top'},
1278                                     $topname,
1279                                     'title="Start of the manual"'
1280                                    ) . "</h4>\n";
1281     }
1282
1283     foreach my $line (@lines) {
1284       print $fh $line;
1285     }
1286     print $fh "</div>\n\n";
1287   }
1288 }
1289
1290 # Create the custom TOC for this page (partially folded, current page is
1291 # highlighted) and store it in a global variable. The TOC is written out after
1292 # the html contents (but positioned correctly using CSS), so that browsers with
1293 # css turned off still show the contents first.
1294 our @this_page_toc = ();
1295 sub lilypond_print_element_header
1296 {
1297   my $first_in_page = shift;
1298   my $previous_is_top = shift;
1299   if ($first_in_page and not @this_page_toc) {
1300     if (defined($Texi2HTML::THIS_ELEMENT)) {
1301       # Create the TOC for this page
1302       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
1303     }
1304   }
1305   return &$default_print_element_header( $first_in_page, $previous_is_top);
1306 }
1307
1308 # Generate the HTML output for the TOC
1309 sub lilypond_toc_body($)
1310 {
1311     my $elements_list = shift;
1312     # Generate a default TOC for pages without THIS_ELEMENT
1313     @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
1314     return &$default_toc_body($elements_list);
1315 }
1316
1317 # Print out the TOC in a <div> at the beginning of the page
1318 sub lilypond_print_page_head($)
1319 {
1320     my $fh = shift;
1321     &$default_print_page_head($fh);
1322     print $fh "<div id=\"main\">\n";
1323 }
1324
1325 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
1326 # sidebar mimicking a TOC frame
1327 sub print_lilypond_page_foot($)
1328 {
1329   my $fh = shift;
1330   my $program_string = &$program_string();
1331 #   print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
1332   print $fh "<!-- FOOTER -->\n\n";
1333   print $fh "<!-- end div#main here -->\n</div>\n\n";
1334   if ($web_manual) {
1335     # FIXME: This div and p#languages need to be in div#footer.
1336     #        Should we move this div to postprocess_html.py ?
1337     print $fh "<div id=\"verifier_texinfo\">\n";
1338     print $fh "<h3>Validation</h3>\n";
1339     # FIXME: inlined text substitution, move to ly_get_string as soon as another case is needed
1340     my $webdev_link = "<a href=\"http://www.webdev.nl/\">webdev.nl</a>";
1341     my $lily_site = "<code>lilypond.org</code>";
1342     my $hosting_thanks = &ly_get_string ('<p>Thanks to ${webdev_link} for hosting ${lily_site}.');
1343     # this does the variable substitution ("quoting" in Perlish) after the localization
1344     $hosting_thanks =~ s/(\$\{\w+\})/$1/eeg;
1345     print $fh $hosting_thanks . "\n";
1346     print $fh "<a href=\"http://validator.w3.org/check?uri=referer\">\n";
1347     print $fh "<img src=\"http://www.w3.org/Icons/valid-html401\"\n";
1348     print $fh "     alt=\"Valid HTML 4.01 Transitional\"\n";
1349     print $fh "     height=\"31\" width=\"88\"></a></p>\n";
1350     print $fh "</div>";
1351   }
1352
1353   # Print the TOC frame and reset the TOC:
1354   lilypond_print_toc_div ($fh, \@this_page_toc);
1355   @this_page_toc = ();
1356
1357   # Close the page:
1358   print $fh "</body>\n</html>\n";
1359 }
1360
1361
1362
1363
1364
1365 #############################################################################
1366 ###  NICER / MORE FLEXIBLE NAVIGATION PANELS
1367 #############################################################################
1368
1369 sub get_navigation_text
1370 {
1371   my $button = shift;
1372   my $text = $NAVIGATION_TEXT{$button};
1373   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
1374     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
1375   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
1376     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
1377   } elsif ( $button eq 'Up' ) {
1378     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
1379   }
1380   return $text;
1381 }
1382
1383
1384 # Don't automatically create left-aligned table cells for every link, but
1385 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
1386 # button text. It's alignment as well as the colspan will be taken from the
1387 # name of the button. Also, add 'newline' button text to create a new table
1388 # row. The texts of the buttons are generated by get_navigation_text and
1389 # will contain the name of the next/previous section/chapter.
1390 sub lilypond_print_navigation
1391 {
1392     my $buttons = shift;
1393     my $vertical = shift;
1394     my $spacing = 1;
1395     my $result = "<table class=\"nav_table\">\n";
1396
1397     $result .= "<tr>" unless $vertical;
1398     my $beginofline = 1;
1399     foreach my $button (@$buttons)
1400     {
1401         $result .= qq{<tr valign="top" align="left">\n} if $vertical;
1402         # Allow (left|right|center)-aligned-cell and newline as buttons!
1403         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
1404         {
1405           $result .= qq{</td>} unless $beginofline;
1406           $result .= qq{<td valign="middle" align="$1" colspan="$2">};
1407           $beginofline = 0;
1408         }
1409         elsif ( $button eq 'newline' )
1410         {
1411           $result .= qq{</td>} unless $beginofline;
1412           $result .= qq{</tr>};
1413           $result .= qq{<tr>};
1414           $beginofline = 1;
1415
1416         }
1417         elsif (ref($button) eq 'CODE')
1418         {
1419             $result .= &$button($vertical);
1420         }
1421         elsif (ref($button) eq 'SCALAR')
1422         {
1423             $result .= "$$button" if defined($$button);
1424         }
1425         elsif (ref($button) eq 'ARRAY')
1426         {
1427             my $text = $button->[1];
1428             my $button_href = $button->[0];
1429             # verify that $button_href is simple text and text is a reference
1430             if (defined($button_href) and !ref($button_href)
1431                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
1432             {             # use given text
1433                 if ($Texi2HTML::HREF{$button_href})
1434                 {
1435                   my $anchor_attributes = '';
1436                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and
1437                       ($BUTTONS_ACCESSKEY{$button_href} ne ''))
1438                   {
1439                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
1440                   }
1441                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and
1442                       ($BUTTONS_REL{$button_href} ne ''))
1443                   {
1444                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
1445                   }
1446                   $result .=  "" .
1447                         &$anchor('',
1448                                     $Texi2HTML::HREF{$button_href},
1449                                     get_navigation_text($$text),
1450                                     $anchor_attributes
1451                                    );
1452                 }
1453                 else
1454                 {
1455                   $result .=  get_navigation_text($$text);
1456                 }
1457             }
1458         }
1459         elsif ($button eq ' ')
1460         {                       # handle space button
1461             $result .=
1462                 ($ICONS && $ACTIVE_ICONS{' '}) ?
1463                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
1464                         $NAVIGATION_TEXT{' '};
1465             #next;
1466         }
1467         elsif ($Texi2HTML::HREF{$button})
1468         {                       # button is active
1469             my $btitle = $BUTTONS_GOTO{$button} ?
1470                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
1471             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and
1472                 ($BUTTONS_ACCESSKEY{$button} ne ''))
1473             {
1474                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
1475             }
1476             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and
1477                 ($BUTTONS_REL{$button} ne ''))
1478             {
1479                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
1480             }
1481             if ($ICONS && $ACTIVE_ICONS{$button})
1482             {                   # use icon
1483                 $result .= '' .
1484                     &$anchor('',
1485                         $Texi2HTML::HREF{$button},
1486                         &$button_icon_img($BUTTONS_NAME{$button},
1487                                    $ACTIVE_ICONS{$button},
1488                                    $Texi2HTML::SIMPLE_TEXT{$button}),
1489                         $btitle
1490                       );
1491             }
1492             else
1493             {                   # use text
1494                 $result .=
1495                     '[' .
1496                         &$anchor('',
1497                                     $Texi2HTML::HREF{$button},
1498                                     get_navigation_text($button),
1499                                     $btitle
1500                                    ) .
1501                                        ']';
1502             }
1503         }
1504         else
1505         {                       # button is passive
1506             $result .=
1507                 $ICONS && $PASSIVE_ICONS{$button} ?
1508                     &$button_icon_img($BUTTONS_NAME{$button},
1509                                           $PASSIVE_ICONS{$button},
1510                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
1511
1512                                               "[" . get_navigation_text($button) . "]";
1513         }
1514         $result .= "</td>\n" if $vertical;
1515         $result .= "</tr>\n" if $vertical;
1516     }
1517     $result .= "</td>" unless $beginofline;
1518     $result .= "</tr>" unless $vertical;
1519     $result .= "</table>\n";
1520     if ($web_manual) {
1521       return "\n";
1522     } else {
1523       return $result;
1524     }
1525 }
1526
1527
1528 @Texi2HTML::Config::SECTION_BUTTONS =
1529     ('left-aligned-cell-1', 'FastBack',
1530      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1531      'right-aligned-cell-1', 'FastForward',
1532      'newline',
1533      'left-aligned-cell-2', 'Back',
1534      'center-aligned-cell-1', 'Up',
1535      'right-aligned-cell-2', 'Forward'
1536     );
1537
1538 # buttons for misc stuff
1539 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3',
1540                                     'Top', 'Contents', 'Index', 'About');
1541
1542 # buttons for chapter file footers
1543 # (and headers but only if SECTION_NAVIGATION is false)
1544 @Texi2HTML::Config::CHAPTER_BUTTONS =
1545     ('left-aligned-cell-1', 'FastBack',
1546      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1547      'right-aligned-cell-1', 'FastForward',
1548     );
1549
1550 # buttons for section file footers
1551 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
1552     ('left-aligned-cell-1', 'FastBack',
1553      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1554      'right-aligned-cell-1', 'FastForward',
1555      'newline',
1556      'left-aligned-cell-2', 'Back',
1557      'center-aligned-cell-1', 'Up',
1558      'right-aligned-cell-2', 'Forward'
1559     );
1560
1561 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
1562     ('left-aligned-cell-1', 'FastBack',
1563      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1564      'right-aligned-cell-1', 'FastForward',
1565      'newline',
1566      'left-aligned-cell-2', 'Back',
1567      'center-aligned-cell-1', 'Up',
1568      'right-aligned-cell-2', 'Forward'
1569     );
1570
1571
1572
1573
1574
1575 #############################################################################
1576 ###  FOOTNOTE FORMATTING
1577 #############################################################################
1578
1579 # Format footnotes in a nicer way: Instead of printing the number in a separate
1580 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
1581 # before the fn text.
1582
1583
1584 # The following code is copied from texi2html's examples/makeinfo.init and
1585 # should be updated when texi2html makes some changes there!
1586
1587 my $makekinfo_like_footnote_absolute_number = 0;
1588
1589 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
1590 {
1591     my $foot_num = shift;
1592     my $relative_num = shift;
1593     my $footid = shift;
1594     my $docid = shift;
1595     my $from_file = shift;
1596     my $footnote_file = shift;
1597     my $lines = shift;
1598     my $state = shift;
1599
1600     $makekinfo_like_footnote_absolute_number++;
1601
1602     # this is a bit obscure, this allows to add an anchor only if formatted
1603     # as part of the document.
1604     $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
1605
1606     if ($from_file eq $footnote_file)
1607     {
1608         $from_file = $footnote_file = '';
1609     }
1610
1611     my $foot_anchor = "<sup>" .
1612         &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
1613     $foot_anchor = &$anchor($docid,
1614                             "$footnote_file#$footid",
1615                             "($relative_num)") if ($state->{'preformatted'});
1616
1617 #    unshift @$lines, "<li>";
1618 #    push @$lines, "</li>\n";
1619     return ($lines, $foot_anchor);
1620 }
1621
1622 sub makeinfo_like_foot_lines($)
1623 {
1624     my $lines = shift;
1625     unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
1626 #<ol type=\"1\">\n";
1627 #    push @$lines, "</ol>";
1628     return $lines;
1629 }
1630
1631 my %makekinfo_like_paragraph_in_footnote_nr;
1632
1633 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
1634 {
1635     my $text = shift;
1636     my $align = shift;
1637     my $indent = shift;
1638     my $paragraph_command = shift;
1639     my $paragraph_command_formatted = shift;
1640     my $paragraph_number = shift;
1641     my $format = shift;
1642     my $item_nr = shift;
1643     my $enumerate_style = shift;
1644     my $number = shift;
1645     my $command_stack_at_end = shift;
1646     my $command_stack_at_begin = shift;
1647     my $state = shift;
1648 #print STDERR "format: $format\n" if (defined($format));
1649 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
1650     $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
1651           exists($special_list_commands{$format}->{$paragraph_command}));
1652     return '' if ($text =~ /^\s*$/);
1653     foreach my $style(t2h_collect_styles($command_stack_at_begin))
1654     {
1655        $text = t2h_begin_style($style, $text);
1656     }
1657     foreach my $style(t2h_collect_styles($command_stack_at_end))
1658     {
1659        $text = t2h_end_style($style, $text);
1660     }
1661     if (defined($paragraph_number) and defined($$paragraph_number))
1662     {
1663          $$paragraph_number++;
1664          return $text  if (($format eq 'itemize' or $format eq 'enumerate') and
1665             ($$paragraph_number == 1));
1666     }
1667     my $open = '<p';
1668     if ($align)
1669     {
1670         $open .= " align=\"$paragraph_style{$align}\"";
1671     }
1672     my $footnote_text = '';
1673     if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1674     {
1675         my $state = $Texi2HTML::THISDOC{'state'};
1676         $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1677         if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1678         {
1679            $open.=' class="footnote"';
1680            my $document_file = $state->{'footnote_document_file'};
1681            if ($document_file eq $state->{'footnote_footnote_file'})
1682            {
1683                $document_file = '';
1684            }
1685            my $docid = $state->{'footnote_place_id'};
1686            my $doc_state = $state->{'footnote_document_state'};
1687            $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1688            my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1689                  $document_file . "#$state->{'footnote_place_id'}",
1690                  "$state->{'footnote_number_in_page'}");
1691            $footnote_text = "<small>[${foot_label}]</small> ";
1692         }
1693     }
1694     return $open.'>'.$footnote_text.$text.'</p>';
1695 }
1696
1697
1698 #############################################################################
1699 ###  OTHER SETTINGS
1700 #############################################################################
1701
1702 # For split pages, use index.html as start page!
1703 if ($Texi2HTML::Config::SPLIT eq 'section' or
1704     $Texi2HTML::Config::SPLIT eq 'node') {
1705   $Texi2HTML::Config::TOP_FILE = 'index.html';
1706 }
1707
1708
1709 return 1;