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 # only lc() the last portion of an href
 634 sub lc_last($)
 635 {
 636   my $href = shift;
 637   my @hrefsplit = split('/', $href);
 638   # change the last portion (the filename), if it exists
 639   if ($#array > 0) {
 640     @hrefsplit[$#array] = lc( @hrefsplit[$#array] );
 641     $href = join("/", @hrefsplit);
 642   }
 643   return $href;
 644 }
 645
 646 # Convert a given node name to its proper file name (normalization as explained
 647 # in the texinfo manual:
 648 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
 649 sub texinfo_file_name($)
 650 {
 651   my $text = shift;
 652   my $result = '';
 653   # File name normalization by texinfo:
 654   # 1/2: letters and numbers are left unchanged
 655   # 3/4: multiple, leading and trailing whitespace is removed
 656   $text = main::normalise_space($text);
 657   # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
 658   #      chars are replaced by _xxxx (xxxx=ascii character code)
 659   while ($text ne '') {
 660     if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
 661       $result .= $1;
 662     } elsif ($text =~ s/^ //o) { # space -> '-'
 663       $result .= '-';
 664     } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
 665       my $ccode = ord($1);
 666       if ( $ccode <= 0xFFFF ) {
 667         $result .= sprintf("_%04x", $ccode);
 668       } else {
 669         $result .= sprintf("__%06x", $ccode);
 670       }
 671     }
 672   }
 673   # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
 674   if ($result !~ /^[a-zA-Z]/) {
 675     $result = 't_g' . $result;
 676   }
 677   # DONE
 678   return lc_last($result)
 679 }
 680
 681 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
 682 # NODENAME\tFILENAME\tANCHOR
 683 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
 684 sub load_map_file ($)
 685 {
 686   my $mapfile = shift;
 687   my $node_map = ();
 688
 689   # For some unknown reason, Perl on my system (5.10.0 on Fedora 12)
 690   # refuses to open map files of translated documents with
 691   # '<:encoding(utf8)', but decoding from UTF-8 line by line works. -jm
 692   if (open(XREFFILE,'<', $mapfile)) {
 693     my $line;
 694     # print STDERR "*** PRINTING MAP FILE LINES ***\n";
 695     while ( $line = decode ('UTF-8', <XREFFILE>) ) {
 696       # parse the tab-separated entries and insert them into the map:
 697       chomp($line);
 698       my @entries = split(/\t/, $line);
 699       if (scalar (@entries) == 3) {
 700         $node_map->{$entries[0]} = [$entries[1], $entries[2]];
 701         $, = " ";
 702         # print STDERR @entries;
 703         # print STDERR "\n";
 704       } else {
 705         print STDERR "Invalid entry in the node file $mapfile: $line\n";
 706       }
 707     }
 708     close (XREFFILE);
 709   } else {
 710     print STDERR "WARNING: Unable to load the map file $mapfile\n";
 711   }
 712   return $node_map;
 713 }
 714
 715
 716 # Split the given path into dir and basename (with .texi removed). Used mainly
 717 # to get the path/basename of the original texi input file
 718 sub split_texi_filename ($)
 719 {
 720   my $docu = shift;
 721   my ($docu_dir, $docu_name);
 722   if ($docu =~ /(.*\/)/) {
 723     chop($docu_dir = $1);
 724     $docu_name = $docu;
 725     $docu_name =~ s/.*\///;
 726   } else {
 727      $docu_dir = '.';
 728      $docu_name = $docu;
 729   }
 730   $docu_name =~ s/\.te?x(i|info)?$//;
 731   return ($docu_dir, $docu_name);
 732 }
 733
 734
 735
 736
 737
 738 #############################################################################
 739 ###  CSS HANDLING
 740 #############################################################################
 741
 742 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
 743 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
 744 sub lilypond_css_lines ($$)
 745 {
 746   my $import_lines = shift;
 747   my $rule_lines = shift;
 748   return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
 749   if (@$rule_lines or @$import_lines)
 750   {
 751     $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
 752     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
 753     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
 754     $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
 755   }
 756   foreach my $ref (@CSS_REFS)
 757   {
 758     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 759         "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
 760   }
 761   foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
 762   {
 763     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 764         "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
 765   }
 766   # FIXME: the website doesn't use ie7-specific fixes; do the
 767   # docs still need this?  -gp
 768   $Texi2HTML::THISDOC{'CSS_LINES'} .=
 769       "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
 770 }
 771
 772
 773
 774
 775
 776 #############################################################################
 777 ###  SPLITTING BASED ON NUMBERED SECTIONS
 778 #############################################################################
 779
 780 my $lastfilename;
 781 my $docnr = 0;
 782 my $node_to_filename_map = ();
 783
 784
 785 # This function makes sure that files are only generated for numbered sections,
 786 # but not for unnumbered ones. It is called after texi2html has done its own
 787 # splitting and simply returns the filename for the node given as first argument
 788 # Nodes with the same filename will be printed out to the same filename, so
 789 # this really all we need. Also, make sure that the file names for sections
 790 # are derived from the section title. We also might want to name the anchors
 791 # according to node titles, which works by simply overriding the id element of
 792 # the $element hash.
 793 # If an external nodename<=>filename/anchor map file is found (loaded in
 794 # the command handler, use the externally created values, otherwise use the
 795 # same logic here.
 796 sub lilypond_element_file_name($$$)
 797 {
 798   my $element = shift;
 799   my $type = shift;
 800   my $docu_name = shift;
 801   my $docu_ext = $Texi2HTML::Config::EXTENSION;
 802
 803   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 804   # the snippets page does not use nodes for the snippets, so in this case
 805   # we'll have to use the section name!
 806   if ($node_name eq '') {
 807     $node_name = main::remove_texi($element->{'texi'});
 808   }
 809
 810   # If we have an entry in the section<=>filename map, use that one, otherwise
 811   # generate the filename/anchor here. In the latter case, external manuals
 812   # will not be able to retrieve the file name for xrefs!!! Still, I already
 813   # had that code, so I'll leave it in in case something goes wrong with the
 814   # extract_texi_filenames.py script in the lilypond build process!
 815   if (exists ($node_to_filename_map->{$node_name})) {
 816     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 817     $filename .= ".$docu_ext" if (defined($docu_ext));
 818     $filename = lc_last($filename);
 819
 820     # unnumbered sections (except those at top-level!) always go to the same
 821     # file as the previous numbered section
 822     if (not ($web_manual) and not ($element->{number})
 823         and not ($lastfilename eq '') and ($element->{level} > 1)) {
 824       $filename = $lastfilename;
 825     }
 826     if (($filename eq $lastfilename)) {
 827       $$element{doc_nr} = $docnr;
 828     } else {
 829       $docnr += 1;
 830       $$element{doc_nr} = $docnr;
 831       $lastfilename = $filename;
 832     }
 833     print STDERR "Output file name: $filename\n";
 834     return $filename;
 835
 836   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or
 837            $type eq "stoc" or $type eq "foot" or $type eq "about") {
 838     return;
 839   } else {
 840     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
 841         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
 842                or ($node_name =~ /NOT REALLY USED/);
 843
 844     # Numbered sections will get a filename Node_title, unnumbered sections will use
 845     # the file name of the previous numbered section:
 846     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
 847       # normalize to the same file name as texinfo
 848       if ($element->{translationof}) {
 849         $node_name = main::remove_texi($element->{translationof});
 850       }
 851       my $filename = texinfo_file_name($node_name);
 852       $filename .= ".$docu_ext" if (defined($docu_ext));
 853       $filename = lc_last($filename);
 854       $docnr += 1;
 855       $$element{doc_nr} = $docnr;
 856       $lastfilename = $filename;
 857       print STDERR "File name: $filename\n";
 858       return $filename;
 859     } else {
 860       $$element{doc_nr} = $docnr;
 861       $filename = lc_last($filename);
 862       print STDERR "File name: $filename\n";
 863       return $filename;
 864     }
 865   }
 866
 867   return;
 868 }
 869
 870 sub lilypond_element_target_name($$$)
 871 {
 872   my $element = shift;
 873   my $target = shift;
 874   my $id = shift;
 875   # Target is based on node name (or sec name for secs without node attached)
 876   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 877   if ($node_name eq '') {
 878     $node_name = main::remove_texi($element->{'texi'});
 879   }
 880
 881   # If we have an entry in the section<=>filename map, use that one, otherwise
 882   # generate the anchor here.
 883   if (exists ($node_to_filename_map->{$node_name})) {
 884     (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
 885   } else {
 886     my $anchor = $node_name;
 887     if ($element->{translationof}) {
 888       $anchor = main::remove_texi($element->{translationof});
 889     }
 890     # normalize to the same file name as texinfo
 891     $target = texinfo_file_name($anchor);
 892   }
 893   # TODO: Once texi2html correctly prints out the target and not the id for
 894   #       the sections, change this back to ($id, $target)
 895   # I don't understand this comment, so I'm reluctant to delete it -gp
 896   $target = lc_last($target);
 897   if ($target eq lc_last($id)) {
 898     $id = "";
 899   } else {
 900     $id = substr($id, 0, - 2); # remove the "-1"
 901   }
 902   return ($id, $target);
 903 }
 904
 905
 906 ## Load the map file for the corrently processed texi file. We do this
 907 #  using a command init handler, since texi2html does not have any
 908 #  other hooks that are called after THISDOC is filled but before phase 2
 909 #  of the texi2html conversion.
 910 sub lilypond_init_map ()
 911 {
 912     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 913     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 914         || main::locate_include_file ("${docu_name}.xref-map");
 915     print STDERR "Map filename is: $map_filename\nDocu name is $docu_name\n";
 916     if ($docu_name eq 'web') {
 917         $web_manual = 1;
 918         web_settings();
 919     }
 920     $node_to_filename_map = load_map_file ($map_filename);
 921 }
 922 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
 923
 924
 925
 926 #############################################################################
 927 ###  CLEANER LINK TITLE FOR EXTERNAL REFS
 928 #############################################################################
 929
 930 # The default formatting of external refs returns e.g.
 931 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
 932 # file_and_node argument. Also, we want only a very simple format, so we don't
 933 # even call the default handler!
 934 sub lilypond_external_ref($$$$$$)
 935 {
 936   my $type = shift;
 937   my $section = shift;
 938   my $book = shift;
 939   my $file_node = shift;
 940   my $href = shift;
 941
 942   $href = lc_last($href);
 943
 944   my $cross_ref = shift;
 945
 946   my $displaytext = '';
 947
 948   # 1) if we have a cross ref name, that's the text to be displayed:
 949   # 2) For the top node, use the (printable) name of the manual, unless we
 950   #    have an explicit cross ref name
 951   # 3) In all other cases use the section name
 952   if ($cross_ref ne '') {
 953     $displaytext = $cross_ref;
 954   } elsif (($section eq '') or ($section eq 'Top')) {
 955     $displaytext = $book;
 956   } else {
 957     $displaytext = $section;
 958   }
 959
 960   $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
 961   return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
 962 }
 963
 964
 965
 966
 967
 968 #############################################################################
 969 ###  HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
 970 ###                  map stored on disk, xrefs in other manuals load that map
 971 #############################################################################
 972
 973
 974 # Try to make use of @translationof to generate files according to the original
 975 # English section title...
 976 sub lilypond_unknown($$$$$)
 977 {
 978     my $macro = shift;
 979     my $line = shift;
 980     my $pass = shift;
 981     my $stack = shift;
 982     my $state = shift;
 983
 984     # the @translationof macro provides the original English section title,
 985     # which should be used for file/anchor naming, while the title will be
 986     # translated to each language
 987     # It is already used by extract_texi_filenames.py, so this should not be
 988     # necessary here at all. Still, I'll leave the code in just in case the
 989     # python script messed up ;-)
 990     if ($pass == 1 and $macro eq "translationof") {
 991       if (ref($state->{'element'}) eq 'HASH') {
 992         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 993       }
 994       return ('', 1, undef, undef);
 995     } else {
 996       return &$default_unknown($macro, $line, $pass, $stack, $state);
 997     }
 998 }
 999
1000
1001 my %translated_books = ();
1002 # Construct a href to an external source of information.
1003 # node is the node with texinfo @-commands
1004 # node_id is the node transliterated and transformed as explained in the
1005 #         texinfo manual
1006 # node_xhtml_id is the node transformed such that it is unique and can
1007 #     be used to make an html cross ref as explained in the texinfo manual
1008 # file is the file in '(file)node'
1009 sub lilypond_external_href($$$)
1010 {
1011   my $node = shift;
1012   my $node_id = shift;
1013   my $node_hxmlt_id = shift;
1014   my $file = shift;
1015
1016   # 1) Keep a hash of book->section_map
1017   # 2) if not file in keys hash => try to load the map (assign empty map if
1018   #    non-existent => will load only once!)
1019   # 3) if node in the section=>(file, anchor) map, replace node_id and
1020   #    node_xhtml_id by the map's values
1021   # 4) call the default_external_href with these values (or the old ones if not found)
1022
1023   if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
1024     my $map_name = $file;
1025     $map_name =~ s/-big-page//;
1026
1027     # Load the map if we haven't done so already
1028     if (!exists($translated_books{$map_name})) {
1029       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
1030       my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
1031           || main::locate_include_file ("${map_name}.xref-map");
1032       $translated_books{$map_name} = load_map_file ($map_filename);
1033     }
1034
1035     # look up translation. use these values instead of the old filename/anchor
1036     my $section_name_map = $translated_books{$map_name};
1037     my $node_text = main::remove_texi($node);
1038     if (defined($section_name_map->{$node_text})) {
1039       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
1040     } else {
1041       print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
1042     }
1043   }
1044
1045   if (defined $file) {
1046     $href = &$default_external_href($node, $node_id, $node_hxmlt_id, lc_last($file));
1047     remove_unneeded_anchor($href);
1048
1049     # TODO: very yucky, but will be fixed in issue 1004
1050     if ($web_manual) {
1051       my $only_web = $ENV{ONLY_WEB};
1052       if ($only_web) {
1053         $href = "../../doc/v2.13/Documentation/web/".$href;
1054       }
1055     }
1056
1057     return $href;
1058   } else {
1059     $href = &$default_external_href($node, $node_id, $node_hxmlt_id);
1060     remove_unneeded_anchor($href);
1061     return $href;
1062   }
1063 }
1064
1065 sub remove_unneeded_anchor($)
1066 {
1067   my $ref = shift;
1068   my @hrefsplit = split("/", $href);
1069   for ($i = 0; $i < @hrefsplit; $i++) {
1070     $item = @hrefsplit[$i];
1071     if ($item =~ /#/) {
1072       @splitted = split("#", $item);
1073       if (@splitted[0] == @splitted[1]) {
1074         @hrefsplit[$i] = @splitted[0]
1075       }
1076     }
1077   }
1078   $href = join("/", @hrefsplit);
1079   return $href
1080 }
1081
1082
1083
1084 #############################################################################
1085 ###  CUSTOM TOC FOR EACH PAGE (in a frame on the left)
1086 #############################################################################
1087
1088 my $page_toc_depth = 2;
1089 my @default_toc = [];
1090
1091 # Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
1092 sub lilypond_init_toc_depth ()
1093 {
1094   if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})
1095       and not $web_manual) {
1096     $page_toc_depth = 1;
1097   }
1098 }
1099 # Set the TOC-depth (depending on a texinfo variable short_toc) in a
1100 # command-handler, so we have them available when creating the pages
1101 push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
1102
1103
1104
1105 # recursively generate the TOC entries for the element and its children (which
1106 # are only shown up to maxlevel. All ancestors of the current element are also
1107 # shown with their immediate children, irrespective of their level.
1108 # Unnumbered entries are only printed out if they are at top-level or 2nd level
1109 # or their parent element is an ancestor of the currently viewed node.
1110 # The conditions to call this method to print the entry for a child node is:
1111 # -) the parent is an ancestor of the current page node
1112 # -) the parent is a numbered element at top-level toplevel (i.e. show numbered
1113 #    and unnumbered 2nd-level children of numbered nodes)
1114 # -) the child element is a numbered node below level maxlevel
1115 sub generate_ly_toc_entries($$$$$)
1116 {
1117   my $element = shift;
1118   my $element_path = shift;
1119   my $maxlevel = shift;
1120   if ($web_manual) {
1121     $maxlevel = 1;
1122   }
1123   my $child_count = shift;
1124   my $current_element = shift;
1125   # Skip undefined sections, plus all sections generated by index splitting
1126   return() if (not defined($element) or exists($element->{'index_page'}));
1127   my @result = ();
1128   my $level = $element->{'toc_level'};
1129   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
1130   my $ind = '  ' x $level;
1131   my $this_css_class = " class=\"";
1132   # color indices for the second navigation bar on the website
1133   if ($web_manual) {
1134       my %color_maps = (
1135           'introduction' => [2, 2, 2, 2, 3, 3, 4, 4],
1136           'download' => [2, 2, 2, 3, 3, 4],
1137           'manuals' => [1, 1, 1, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4],
1138           'community' => [1, 1, 1, 2, 2, 2, 3, 3],
1139           );
1140       my $addColor = "colorDefault";
1141       while (($top_section, $color_indices) = each %color_maps) {
1142           if (index ($element->{'sectionup'}->{'file'}, $top_section) >= 0) {
1143               $addColor = "color" . $color_indices->[$child_count];
1144           }
1145       }
1146       $this_css_class .= $addColor;
1147   }
1148   $this_css_class .= $is_parent_of_current ? ' toc_current"' : '"';
1149   my $entry = "$ind<li$this_css_class>" .
1150       &$anchor ($element->{'tocid'},
1151                 "$element->{'file'}#$element->{'target'}",
1152                 $element->{'text'});
1153
1154   push (@result, $entry);
1155   my $children = $element->{'section_childs'};
1156   if (defined($children) and (ref($children) eq "ARRAY")) {
1157     my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
1158     my @child_result = ();
1159     my $sub_child_count = 0;
1160     foreach my $c (@$children) {
1161       my $is_numbered_child = defined ($c->{'number'});
1162       my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
1163       if ($force_children or ($is_numbered_child and $below_maxlevel)) {
1164         my @child_res =
1165             generate_ly_toc_entries($c, $element_path, $maxlevel, $sub_child_count, $current_element);
1166         push (@child_result, @child_res);
1167         $sub_child_count += 1;
1168       }
1169     }
1170     # if no child nodes were generated, e.g. for the index, where expanded pages
1171     # are ignored, don't generate a list at all...
1172     if (@child_result) {
1173       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
1174       if ($web_manual) {
1175         push (@result, "$ind<li class=\"colorDefault" .
1176               ($element->{'text'} eq $current_element->{'text'} ?
1177                ' toc_current">' : '">') .
1178               &$anchor ($element->{'tocid'},
1179                         "$element->{'file'}#$element->{'target'}",
1180                         $element->{'text'}) . "</li>\n");
1181       }
1182       push (@result, @child_result);
1183       push (@result, "$ind</ul>\n");
1184     }
1185   }
1186   push (@result, "$ind</li>\n");
1187   return @result;
1188 }
1189
1190
1191 # Print a customized TOC, containing only the first two levels plus the whole
1192 # path to the current page
1193 sub lilypond_generate_page_toc_body($)
1194 {
1195     my $element = shift;
1196     my $current_element = $element;
1197     my %parentelements;
1198     $parentelements{$element->{'id'}} = 1;
1199     # Find the path to the current element
1200     while ( defined($current_element->{'sectionup'}) and
1201            ($current_element->{'sectionup'} ne $current_element) )
1202     {
1203       $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
1204               if ($current_element->{'sectionup'}->{'id'} ne '');
1205       $current_element = $current_element->{'sectionup'};
1206       if ($web_manual) {
1207         if (exists($main::value{'shallow_toc'})) {
1208           last;
1209         }
1210       }
1211     }
1212     return () if not defined($current_element);
1213     # Create the toc entries recursively
1214     my @toc_entries = "";
1215     if ($web_manual) {
1216         @toc_entries = "<ul$NO_BULLET_LIST_ATTRIBUTE>\n";
1217         # FIXME: add link to main page, really hackily.
1218         if ($element->{'sectionup'}) {
1219             # it's not the top element
1220             push (@toc_entries, "<li><a href=\"index.html\">Main</a></li>\n");
1221         } else {
1222             push (@toc_entries,
1223                   "<li class=\"toc_current\"><a href=\"index.html\">Main</a></li>\n");
1224         }
1225     } else {
1226         push (@toc_entries, "<div class=\"contents\">\n");
1227         push (@toc_entries, "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
1228     }
1229     my $children = $current_element->{'section_childs'};
1230     foreach ( @$children ) {
1231       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0, $element));
1232     }
1233     # search box
1234     local $/=undef;
1235     my $name = "search-box";
1236     $lang = $Texi2HTML::THISDOC{current_lang};
1237     open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$lang/$name.ihtml" or
1238         open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$name.ihtml"  or
1239         die "no such file: $name.ihtml: $!";
1240     my $search_string = decode ('UTF-8', <FILE>);
1241     $search_string = "<li>\n" . $search_string . "</li>\n";
1242     push (@toc_entries, $search_string);
1243     close FILE;
1244
1245     push (@toc_entries, "</ul>\n");
1246     if ($web_manual) {
1247         push (@toc_entries, "\n");
1248     } else {
1249         push (@toc_entries, "</div>\n");
1250     }
1251     return @toc_entries;
1252 }
1253
1254 sub lilypond_print_toc_div ($$)
1255 {
1256   my $fh = shift;
1257   my $tocref = shift;
1258   my @lines = @$tocref;
1259   # use default TOC if no custom lines have been generated
1260   @lines = @default_toc if (not @lines);
1261   if (@lines) {
1262
1263     print $fh "\n\n<div id=\"tocframe\">\n";
1264
1265     # Remove the leading "GNU LilyPond --- " from the manual title
1266     my $topname = $Texi2HTML::NAME{'Top'};
1267     $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
1268
1269     # construct the top-level Docs index (relative path and including language!)
1270     my $lang = $Texi2HTML::THISDOC{current_lang};
1271     if ($lang and $lang ne "en") {
1272       $lang .= ".";
1273     } else {
1274       $lang = "";
1275     }
1276     my $reldir = $ENV{DEPTH};
1277     my $uplink = $reldir."/Documentation/web/manuals.${lang}html";
1278
1279     if (not $web_manual) {
1280       print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
1281          title=\"Documentation Index\">&lt;&lt; " .
1282          &ly_get_string ('Back to Documentation Index') .
1283          "</a></p>\n";
1284
1285       print $fh '<h4 class="toc_header"> ' . &$anchor('',
1286                                     $Texi2HTML::HREF{'Top'},
1287                                     $topname,
1288                                     'title="Start of the manual"'
1289                                    ) . "</h4>\n";
1290     }
1291
1292     foreach my $line (@lines) {
1293       print $fh $line;
1294     }
1295     print $fh "</div>\n\n";
1296   }
1297 }
1298
1299 # Create the custom TOC for this page (partially folded, current page is
1300 # highlighted) and store it in a global variable. The TOC is written out after
1301 # the html contents (but positioned correctly using CSS), so that browsers with
1302 # css turned off still show the contents first.
1303 our @this_page_toc = ();
1304 sub lilypond_print_element_header
1305 {
1306   my $first_in_page = shift;
1307   my $previous_is_top = shift;
1308   if ($first_in_page and not @this_page_toc) {
1309     if (defined($Texi2HTML::THIS_ELEMENT)) {
1310       # Create the TOC for this page
1311       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
1312     }
1313   }
1314   return &$default_print_element_header( $first_in_page, $previous_is_top);
1315 }
1316
1317 # Generate the HTML output for the TOC
1318 sub lilypond_toc_body($)
1319 {
1320     my $elements_list = shift;
1321     # Generate a default TOC for pages without THIS_ELEMENT
1322     @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
1323     return &$default_toc_body($elements_list);
1324 }
1325
1326 # Print out the TOC in a <div> at the beginning of the page
1327 sub lilypond_print_page_head($)
1328 {
1329     my $fh = shift;
1330     &$default_print_page_head($fh);
1331     print $fh "<div id=\"main\">\n";
1332 }
1333
1334 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
1335 # sidebar mimicking a TOC frame
1336 sub print_lilypond_page_foot($)
1337 {
1338   my $fh = shift;
1339   my $program_string = &$program_string();
1340 #   print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
1341   print $fh "<!-- FOOTER -->\n\n";
1342   print $fh "<!-- end div#main here -->\n</div>\n\n";
1343   if ($web_manual) {
1344     # FIXME: This div and p#languages need to be in div#footer.
1345     #        Should we move this div to postprocess_html.py ?
1346     print $fh "<div id=\"verifier_texinfo\">\n";
1347     print $fh "<h3>Validation</h3>\n";
1348     # FIXME: inlined text substitution, move to ly_get_string as soon as another case is needed
1349     my $webdev_link = "<a href=\"http://www.webdev.nl/\">webdev.nl</a>";
1350     my $lily_site = "<code>lilypond.org</code>";
1351     my $hosting_thanks = &ly_get_string ('<p>Thanks to ${webdev_link} for hosting ${lily_site}.');
1352     # this does the variable substitution ("quoting" in Perlish) after the localization
1353     $hosting_thanks =~ s/(\$\{\w+\})/$1/eeg;
1354     print $fh $hosting_thanks . "\n";
1355     print $fh "<a href=\"http://validator.w3.org/check?uri=referer\">\n";
1356     print $fh "<img src=\"http://www.w3.org/Icons/valid-html401\"\n";
1357     print $fh "     alt=\"Valid HTML 4.01 Transitional\"\n";
1358     print $fh "     height=\"31\" width=\"88\"></a></p>\n";
1359     print $fh "</div>";
1360   }
1361
1362   # Print the TOC frame and reset the TOC:
1363   lilypond_print_toc_div ($fh, \@this_page_toc);
1364   @this_page_toc = ();
1365
1366   # Close the page:
1367   print $fh "</body>\n</html>\n";
1368 }
1369
1370
1371
1372
1373
1374 #############################################################################
1375 ###  NICER / MORE FLEXIBLE NAVIGATION PANELS
1376 #############################################################################
1377
1378 sub get_navigation_text
1379 {
1380   my $button = shift;
1381   my $text = $NAVIGATION_TEXT{$button};
1382   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
1383     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
1384   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
1385     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
1386   } elsif ( $button eq 'Up' ) {
1387     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
1388   }
1389   return $text;
1390 }
1391
1392
1393 # Don't automatically create left-aligned table cells for every link, but
1394 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
1395 # button text. It's alignment as well as the colspan will be taken from the
1396 # name of the button. Also, add 'newline' button text to create a new table
1397 # row. The texts of the buttons are generated by get_navigation_text and
1398 # will contain the name of the next/previous section/chapter.
1399 sub lilypond_print_navigation
1400 {
1401     my $buttons = shift;
1402     my $vertical = shift;
1403     my $spacing = 1;
1404     my $result = "<table class=\"nav_table\">\n";
1405
1406     $result .= "<tr>" unless $vertical;
1407     my $beginofline = 1;
1408     foreach my $button (@$buttons)
1409     {
1410         $result .= qq{<tr valign="top" align="left">\n} if $vertical;
1411         # Allow (left|right|center)-aligned-cell and newline as buttons!
1412         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
1413         {
1414           $result .= qq{</td>} unless $beginofline;
1415           $result .= qq{<td valign="middle" align="$1" colspan="$2">};
1416           $beginofline = 0;
1417         }
1418         elsif ( $button eq 'newline' )
1419         {
1420           $result .= qq{</td>} unless $beginofline;
1421           $result .= qq{</tr>};
1422           $result .= qq{<tr>};
1423           $beginofline = 1;
1424
1425         }
1426         elsif (ref($button) eq 'CODE')
1427         {
1428             $result .= &$button($vertical);
1429         }
1430         elsif (ref($button) eq 'SCALAR')
1431         {
1432             $result .= "$$button" if defined($$button);
1433         }
1434         elsif (ref($button) eq 'ARRAY')
1435         {
1436             my $text = $button->[1];
1437             my $button_href = $button->[0];
1438             # verify that $button_href is simple text and text is a reference
1439             if (defined($button_href) and !ref($button_href)
1440                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
1441             {             # use given text
1442                 if ($Texi2HTML::HREF{$button_href})
1443                 {
1444                   my $anchor_attributes = '';
1445                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and
1446                       ($BUTTONS_ACCESSKEY{$button_href} ne ''))
1447                   {
1448                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
1449                   }
1450                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and
1451                       ($BUTTONS_REL{$button_href} ne ''))
1452                   {
1453                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
1454                   }
1455                   $result .=  "" .
1456                         &$anchor('',
1457                                     $Texi2HTML::HREF{$button_href},
1458                                     get_navigation_text($$text),
1459                                     $anchor_attributes
1460                                    );
1461                 }
1462                 else
1463                 {
1464                   $result .=  get_navigation_text($$text);
1465                 }
1466             }
1467         }
1468         elsif ($button eq ' ')
1469         {                       # handle space button
1470             $result .=
1471                 ($ICONS && $ACTIVE_ICONS{' '}) ?
1472                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
1473                         $NAVIGATION_TEXT{' '};
1474             #next;
1475         }
1476         elsif ($Texi2HTML::HREF{$button})
1477         {                       # button is active
1478             my $btitle = $BUTTONS_GOTO{$button} ?
1479                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
1480             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and
1481                 ($BUTTONS_ACCESSKEY{$button} ne ''))
1482             {
1483                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
1484             }
1485             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and
1486                 ($BUTTONS_REL{$button} ne ''))
1487             {
1488                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
1489             }
1490             if ($ICONS && $ACTIVE_ICONS{$button})
1491             {                   # use icon
1492                 $result .= '' .
1493                     &$anchor('',
1494                         $Texi2HTML::HREF{$button},
1495                         &$button_icon_img($BUTTONS_NAME{$button},
1496                                    $ACTIVE_ICONS{$button},
1497                                    $Texi2HTML::SIMPLE_TEXT{$button}),
1498                         $btitle
1499                       );
1500             }
1501             else
1502             {                   # use text
1503                 $result .=
1504                     '[' .
1505                         &$anchor('',
1506                                     $Texi2HTML::HREF{$button},
1507                                     get_navigation_text($button),
1508                                     $btitle
1509                                    ) .
1510                                        ']';
1511             }
1512         }
1513         else
1514         {                       # button is passive
1515             $result .=
1516                 $ICONS && $PASSIVE_ICONS{$button} ?
1517                     &$button_icon_img($BUTTONS_NAME{$button},
1518                                           $PASSIVE_ICONS{$button},
1519                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
1520
1521                                               "[" . get_navigation_text($button) . "]";
1522         }
1523         $result .= "</td>\n" if $vertical;
1524         $result .= "</tr>\n" if $vertical;
1525     }
1526     $result .= "</td>" unless $beginofline;
1527     $result .= "</tr>" unless $vertical;
1528     $result .= "</table>\n";
1529     if ($web_manual) {
1530       return "\n";
1531     } else {
1532       return $result;
1533     }
1534 }
1535
1536
1537 @Texi2HTML::Config::SECTION_BUTTONS =
1538     ('left-aligned-cell-1', 'FastBack',
1539      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1540      'right-aligned-cell-1', 'FastForward',
1541      'newline',
1542      'left-aligned-cell-2', 'Back',
1543      'center-aligned-cell-1', 'Up',
1544      'right-aligned-cell-2', 'Forward'
1545     );
1546
1547 # buttons for misc stuff
1548 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3',
1549                                     'Top', 'Contents', 'Index', 'About');
1550
1551 # buttons for chapter file footers
1552 # (and headers but only if SECTION_NAVIGATION is false)
1553 @Texi2HTML::Config::CHAPTER_BUTTONS =
1554     ('left-aligned-cell-1', 'FastBack',
1555      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1556      'right-aligned-cell-1', 'FastForward',
1557     );
1558
1559 # buttons for section file footers
1560 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
1561     ('left-aligned-cell-1', 'FastBack',
1562      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1563      'right-aligned-cell-1', 'FastForward',
1564      'newline',
1565      'left-aligned-cell-2', 'Back',
1566      'center-aligned-cell-1', 'Up',
1567      'right-aligned-cell-2', 'Forward'
1568     );
1569
1570 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
1571     ('left-aligned-cell-1', 'FastBack',
1572      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1573      'right-aligned-cell-1', 'FastForward',
1574      'newline',
1575      'left-aligned-cell-2', 'Back',
1576      'center-aligned-cell-1', 'Up',
1577      'right-aligned-cell-2', 'Forward'
1578     );
1579
1580
1581
1582
1583
1584 #############################################################################
1585 ###  FOOTNOTE FORMATTING
1586 #############################################################################
1587
1588 # Format footnotes in a nicer way: Instead of printing the number in a separate
1589 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
1590 # before the fn text.
1591
1592
1593 # The following code is copied from texi2html's examples/makeinfo.init and
1594 # should be updated when texi2html makes some changes there!
1595
1596 my $makekinfo_like_footnote_absolute_number = 0;
1597
1598 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
1599 {
1600     my $foot_num = shift;
1601     my $relative_num = shift;
1602     my $footid = shift;
1603     my $docid = shift;
1604     my $from_file = shift;
1605     my $footnote_file = shift;
1606     my $lines = shift;
1607     my $state = shift;
1608
1609     $makekinfo_like_footnote_absolute_number++;
1610
1611     # this is a bit obscure, this allows to add an anchor only if formatted
1612     # as part of the document.
1613     $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
1614
1615     if ($from_file eq $footnote_file)
1616     {
1617         $from_file = $footnote_file = '';
1618     }
1619
1620     my $foot_anchor = "<sup>" .
1621         &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
1622     $foot_anchor = &$anchor($docid,
1623                             "$footnote_file#$footid",
1624                             "($relative_num)") if ($state->{'preformatted'});
1625
1626 #    unshift @$lines, "<li>";
1627 #    push @$lines, "</li>\n";
1628     return ($lines, $foot_anchor);
1629 }
1630
1631 sub makeinfo_like_foot_lines($)
1632 {
1633     my $lines = shift;
1634     unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
1635 #<ol type=\"1\">\n";
1636 #    push @$lines, "</ol>";
1637     return $lines;
1638 }
1639
1640 my %makekinfo_like_paragraph_in_footnote_nr;
1641
1642 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
1643 {
1644     my $text = shift;
1645     my $align = shift;
1646     my $indent = shift;
1647     my $paragraph_command = shift;
1648     my $paragraph_command_formatted = shift;
1649     my $paragraph_number = shift;
1650     my $format = shift;
1651     my $item_nr = shift;
1652     my $enumerate_style = shift;
1653     my $number = shift;
1654     my $command_stack_at_end = shift;
1655     my $command_stack_at_begin = shift;
1656     my $state = shift;
1657 #print STDERR "format: $format\n" if (defined($format));
1658 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
1659     $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
1660           exists($special_list_commands{$format}->{$paragraph_command}));
1661     return '' if ($text =~ /^\s*$/);
1662     foreach my $style(t2h_collect_styles($command_stack_at_begin))
1663     {
1664        $text = t2h_begin_style($style, $text);
1665     }
1666     foreach my $style(t2h_collect_styles($command_stack_at_end))
1667     {
1668        $text = t2h_end_style($style, $text);
1669     }
1670     if (defined($paragraph_number) and defined($$paragraph_number))
1671     {
1672          $$paragraph_number++;
1673          return $text  if (($format eq 'itemize' or $format eq 'enumerate') and
1674             ($$paragraph_number == 1));
1675     }
1676     my $open = '<p';
1677     if ($align)
1678     {
1679         $open .= " align=\"$paragraph_style{$align}\"";
1680     }
1681     my $footnote_text = '';
1682     if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1683     {
1684         my $state = $Texi2HTML::THISDOC{'state'};
1685         $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1686         if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1687         {
1688            $open.=' class="footnote"';
1689            my $document_file = $state->{'footnote_document_file'};
1690            if ($document_file eq $state->{'footnote_footnote_file'})
1691            {
1692                $document_file = '';
1693            }
1694            my $docid = $state->{'footnote_place_id'};
1695            my $doc_state = $state->{'footnote_document_state'};
1696            $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1697            my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1698                  $document_file . "#$state->{'footnote_place_id'}",
1699                  "$state->{'footnote_number_in_page'}");
1700            $footnote_text = "<small>[${foot_label}]</small> ";
1701         }
1702     }
1703     return $open.'>'.$footnote_text.$text.'</p>';
1704 }
1705
1706
1707 #############################################################################
1708 ###  OTHER SETTINGS
1709 #############################################################################
1710
1711 # For split pages, use index.html as start page!
1712 if ($Texi2HTML::Config::SPLIT eq 'section' or
1713     $Texi2HTML::Config::SPLIT eq 'node') {
1714   $Texi2HTML::Config::TOP_FILE = 'index.html';
1715 }
1716
1717
1718 return 1;