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
 379 sub ly_get_string () {
 380     my $lang = $Texi2HTML::THISDOC{current_lang};
 381     my $string = shift;
 382     if ($lang and $lang ne "en" and $LY_LANGUAGES->{$lang}->{$string}) {
 383         return $LY_LANGUAGES->{$lang}->{$string};
 384     } else {
 385         return $string;
 386     }
 387 }
 388
 389
 390 #############################################################################
 391 ### FUNCTIONALITY FOR MAIN WEB PAGES
 392 #############################################################################
 393
 394 our $web_manual;
 395
 396 #############################################################################
 397 ###  SETTINGS FOR TEXI2HTML
 398 #############################################################################
 399
 400 # Validation fix for texi2html<=1.82
 401 $Texi2HTML::Config::DOCTYPE = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
 402
 403 @Texi2HTML::Config::CSS_REFS = (
 404     {FILENAME => "lilypond-mccarty.css", TITLE => "Default style"}
 405     );
 406 @Texi2HTML::Config::ALT_CSS_REFS      = (
 407     {FILENAME => "lilypond.css", TITLE => "Andrew Hawryluk's design" },
 408     {FILENAME => "lilypond-blue.css", TITLE => "Kurt Kroon's blue design" },
 409 );
 410
 411 sub web_settings() {
 412   print STDERR "Initializing settings for web site\n";
 413   $Texi2HTML::Config::BODYTEXT = "";
 414   @Texi2HTML::Config::CSS_REFS      = (
 415       {FILENAME => "lilypond-web.css", TITLE => "Patrick McCarty's design"}
 416       );
 417   @Texi2HTML::Config::ALT_CSS_REFS      = (
 418       {FILENAME => "lilypond-web-alt1.css", TITLE => "Alternate style 1"},
 419       {FILENAME => "lilypond-web-alt2.css", TITLE => "Alternate style 2"},
 420       );
 421 }
 422
 423 $Texi2HTML::Config::USE_ACCESSKEY = 1;
 424 $Texi2HTML::Config::USE_LINKS     = 1;
 425 $Texi2HTML::Config::USE_REL_REV   = 1;
 426 $Texi2HTML::Config::SPLIT_INDEX   = 0;
 427 $Texi2HTML::Config::SEPARATED_FOOTNOTES = 0; # Print footnotes on same page, not separated
 428
 429 if ($Texi2HTML::Config::SPLIT eq 'section' or
 430     $Texi2HTML::Config::SPLIT eq 'node') {
 431   $Texi2HTML::Config::element_file_name    = \&lilypond_element_file_name;
 432 }
 433
 434 $Texi2HTML::Config::element_target_name  = \&lilypond_element_target_name;
 435 $default_print_element_header = $Texi2HTML::Config::print_element_header;
 436 $Texi2HTML::Config::print_element_header = \&lilypond_print_element_header;
 437 $Texi2HTML::Config::print_page_foot      = \&print_lilypond_page_foot;
 438 $Texi2HTML::Config::print_navigation     = \&lilypond_print_navigation;
 439 $Texi2HTML::Config::external_ref         = \&lilypond_external_ref;
 440 $default_external_href = $Texi2HTML::Config::external_href;
 441 $Texi2HTML::Config::external_href        = \&lilypond_external_href;
 442 $default_toc_body = $Texi2HTML::Config::toc_body;
 443 $Texi2HTML::Config::toc_body             = \&lilypond_toc_body;
 444 $Texi2HTML::Config::css_lines            = \&lilypond_css_lines;
 445 $default_unknown = $Texi2HTML::Config::unknown;
 446 $Texi2HTML::Config::unknown              = \&lilypond_unknown;
 447 $default_print_page_head = $Texi2HTML::Config::print_page_head;
 448 $Texi2HTML::Config::print_page_head      = \&lilypond_print_page_head;
 449 # $Texi2HTML::Config::foot_line_and_ref    = \&lilypond_foot_line_and_ref;
 450 $Texi2HTML::Config::foot_line_and_ref  = \&makeinfo_like_foot_line_and_ref;
 451 $Texi2HTML::Config::foot_lines         = \&makeinfo_like_foot_lines;
 452 $Texi2HTML::Config::paragraph          = \&makeinfo_like_paragraph;
 453
 454
 455
 456 # Examples should be formatted similar to quotes:
 457 $Texi2HTML::Config::complex_format_map->{'example'} = {
 458   'begin' => q{"<blockquote>"},
 459   'end' => q{"</blockquote>\n"},
 460   'style' => 'code',
 461  };
 462
 463 %Texi2HTML::config::misc_pages_targets = (
 464    'Overview' => 'Overview',
 465    'Contents' => 'Contents',
 466    'About' => 'About'
 467 );
 468
 469
 470 my @section_to_filename;
 471
 472
 473
 474
 475 #############################################################################
 476 ###  DEBUGGING
 477 #############################################################################
 478
 479 use Data::Dumper;
 480 $Data::Dumper::Maxdepth = 2;
 481
 482 sub print_element_info($)
 483 {
 484   my $element = shift;
 485   print "~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n";
 486   print "Element: $element\n";
 487   print Dumper($element);
 488 }
 489
 490
 491
 492
 493
 494 #############################################################################
 495 ###  HELPER FUNCTIONS
 496 #############################################################################
 497
 498 # Convert a given node name to its proper file name (normalization as explained
 499 # in the texinfo manual:
 500 # http://www.gnu.org/software/texinfo/manual/texinfo/html_node/HTML-Xref-Node-Name-Expansion.html
 501 sub texinfo_file_name($)
 502 {
 503   my $text = shift;
 504   my $result = '';
 505   # File name normalization by texinfo:
 506   # 1/2: letters and numbers are left unchanged
 507   # 3/4: multiple, leading and trailing whitespace is removed
 508   $text = main::normalise_space($text);
 509   # 5/6: all remaining spaces are converted to '-', all other 7- or 8-bit
 510   #      chars are replaced by _xxxx (xxxx=ascii character code)
 511   while ($text ne '') {
 512     if ($text =~ s/^([A-Za-z0-9]+)//o) { # number or letter stay unchanged
 513       $result .= $1;
 514     } elsif ($text =~ s/^ //o) { # space -> '-'
 515       $result .= '-';
 516     } elsif ($text =~ s/^(.)//o) { # Otherwise use _xxxx (ascii char code)
 517       my $ccode = ord($1);
 518       if ( $ccode <= 0xFFFF ) {
 519         $result .= sprintf("_%04x", $ccode);
 520       } else {
 521         $result .= sprintf("__%06x", $ccode);
 522       }
 523     }
 524   }
 525   # 7: if name does not begin with a letter, prepend 't_g' (so it starts with a letter)
 526   if ($result !~ /^[a-zA-Z]/) {
 527     $result = 't_g' . $result;
 528   }
 529   # DONE
 530   return lc($result)
 531 }
 532
 533 # Load a file containing a nodename<=>filename map (tab-sepatared, i.e.
 534 # NODENAME\tFILENAME\tANCHOR
 535 # Returns a ref to a hash "Node title" => ["FilenameWithoutExt", "Anchor"]
 536 sub load_map_file ($)
 537 {
 538   my $mapfile = shift;
 539   my $node_map = ();
 540
 541   # For some unknown reason, Perl on my system (5.10.0 on Fedora 12)
 542   # refuses to open map files of translated documents with
 543   # '<:encoding(utf8)', but decoding from UTF-8 line by line works. -jm
 544   if (open(XREFFILE,'<', $mapfile)) {
 545     my $line;
 546     # print STDERR "*** PRINTING MAP FILE LINES ***\n";
 547     while ( $line = decode ('UTF-8', <XREFFILE>) ) {
 548       # parse the tab-separated entries and insert them into the map:
 549       chomp($line);
 550       my @entries = split(/\t/, $line);
 551       if (scalar (@entries) == 3) {
 552         $node_map->{$entries[0]} = [$entries[1], $entries[2]];
 553         $, = " ";
 554         # print STDERR @entries;
 555         # print STDERR "\n";
 556       } else {
 557         print STDERR "Invalid entry in the node file $mapfile: $line\n";
 558       }
 559     }
 560     close (XREFFILE);
 561   } else {
 562     print STDERR "WARNING: Unable to load the map file $mapfile\n";
 563   }
 564   return $node_map;
 565 }
 566
 567
 568 # Split the given path into dir and basename (with .texi removed). Used mainly
 569 # to get the path/basename of the original texi input file
 570 sub split_texi_filename ($)
 571 {
 572   my $docu = shift;
 573   my ($docu_dir, $docu_name);
 574   if ($docu =~ /(.*\/)/) {
 575     chop($docu_dir = $1);
 576     $docu_name = $docu;
 577     $docu_name =~ s/.*\///;
 578   } else {
 579      $docu_dir = '.';
 580      $docu_name = $docu;
 581   }
 582   $docu_name =~ s/\.te?x(i|info)?$//;
 583   return ($docu_dir, $docu_name);
 584 }
 585
 586
 587
 588
 589
 590 #############################################################################
 591 ###  CSS HANDLING
 592 #############################################################################
 593
 594 # Include our standard CSS file, not hard-coded CSS code directly in the HTML!
 595 # For IE, conditionally include the lilypond-ie-fixes.css style sheet
 596 sub lilypond_css_lines ($$)
 597 {
 598   my $import_lines = shift;
 599   my $rule_lines = shift;
 600   return if (defined($Texi2HTML::THISDOC{'CSS_LINES'}));
 601   if (@$rule_lines or @$import_lines)
 602   {
 603     $Texi2HTML::THISDOC{'CSS_LINES'} = "<style type=\"text/css\">\n<!--\n";
 604     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$import_lines) . "\n" if (@$import_lines);
 605     $Texi2HTML::THISDOC{'CSS_LINES'} .= join('',@$rule_lines) . "\n" if (@$rule_lines);
 606     $Texi2HTML::THISDOC{'CSS_LINES'} .= "-->\n</style>\n";
 607   }
 608   foreach my $ref (@CSS_REFS)
 609   {
 610     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 611         "<link rel=\"stylesheet\" type=\"text/css\" title=\"$ref->{TITLE}\" href=\"$ref->{FILENAME}\">\n";
 612   }
 613   foreach my $ref (@Texi2HTML::Config::ALT_CSS_REFS)
 614   {
 615     $Texi2HTML::THISDOC{'CSS_LINES'} .=
 616         "<link rel=\"alternate stylesheet\" type=\"text/css\" href=\"$ref->{FILENAME}\" title=\"$ref->{TITLE}\">\n";
 617   }
 618   # FIXME: the website doesn't use ie7-specific fixes; do the
 619   # docs still need this?  -gp
 620   $Texi2HTML::THISDOC{'CSS_LINES'} .=
 621       "<!--[if lte IE 7]>\n<link href=\"lilypond-ie-fixes.css\" rel=\"stylesheet\" type=\"text/css\">\n<![endif]-->\n";
 622 }
 623
 624
 625
 626
 627
 628 #############################################################################
 629 ###  SPLITTING BASED ON NUMBERED SECTIONS
 630 #############################################################################
 631
 632 my $lastfilename;
 633 my $docnr = 0;
 634 my $node_to_filename_map = ();
 635
 636
 637 # This function makes sure that files are only generated for numbered sections,
 638 # but not for unnumbered ones. It is called after texi2html has done its own
 639 # splitting and simply returns the filename for the node given as first argument
 640 # Nodes with the same filename will be printed out to the same filename, so
 641 # this really all we need. Also, make sure that the file names for sections
 642 # are derived from the section title. We also might want to name the anchors
 643 # according to node titles, which works by simply overriding the id element of
 644 # the $element hash.
 645 # If an external nodename<=>filename/anchor map file is found (loaded in
 646 # the command handler, use the externally created values, otherwise use the
 647 # same logic here.
 648 sub lilypond_element_file_name($$$)
 649 {
 650   my $element = shift;
 651   my $type = shift;
 652   my $docu_name = shift;
 653   my $docu_ext = $Texi2HTML::Config::EXTENSION;
 654
 655   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 656   # the snippets page does not use nodes for the snippets, so in this case
 657   # we'll have to use the section name!
 658   if ($node_name eq '') {
 659     $node_name = main::remove_texi($element->{'texi'});
 660   }
 661
 662   # If we have an entry in the section<=>filename map, use that one, otherwise
 663   # generate the filename/anchor here. In the latter case, external manuals
 664   # will not be able to retrieve the file name for xrefs!!! Still, I already
 665   # had that code, so I'll leave it in in case something goes wrong with the
 666   # extract_texi_filenames.py script in the lilypond build process!
 667   if (exists ($node_to_filename_map->{$node_name})) {
 668     (my $filename, my $anchor) = @{$node_to_filename_map->{$node_name}};
 669     $filename .= ".$docu_ext" if (defined($docu_ext));
 670     $filename = lc($filename);
 671
 672     # unnumbered sections (except those at top-level!) always go to the same
 673     # file as the previous numbered section
 674     if (not $docu_name == "web" and not ($element->{number})
 675         and not ($lastfilename eq '') and ($element->{level} > 1)) {
 676       $filename = $lastfilename;
 677     }
 678     if (($filename eq $lastfilename)) {
 679       $$element{doc_nr} = $docnr;
 680     } else {
 681       $docnr += 1;
 682       $$element{doc_nr} = $docnr;
 683       $lastfilename = $filename;
 684     }
 685     print STDERR "Output file name: $filename\n";
 686     return $filename;
 687
 688   } elsif ($type eq "top" or $type eq "toc" or $type eq "doc" or
 689            $type eq "stoc" or $type eq "foot" or $type eq "about") {
 690     return;
 691   } else {
 692     print STDERR "WARNING: Node '$node_name' was NOT found in the map\n"
 693         unless ($node_name eq '') or ($element->{'tag'} eq 'unnumberedsec')
 694                or ($node_name =~ /NOT REALLY USED/);
 695
 696     # Numbered sections will get a filename Node_title, unnumbered sections will use
 697     # the file name of the previous numbered section:
 698     if (($element->{number}) or ($lastfilename eq '') or ($element->{level} == 1)) {
 699       # normalize to the same file name as texinfo
 700       if ($element->{translationof}) {
 701         $node_name = main::remove_texi($element->{translationof});
 702       }
 703       my $filename = texinfo_file_name($node_name);
 704       $filename .= ".$docu_ext" if (defined($docu_ext));
 705       $filename = lc($filename);
 706       $docnr += 1;
 707       $$element{doc_nr} = $docnr;
 708       $lastfilename = $filename;
 709       print STDERR "File name: $filename\n";
 710       return $filename;
 711     } else {
 712       $$element{doc_nr} = $docnr;
 713       $filename = lc ($filename);
 714       print STDERR "File name: $filename\n";
 715       return $filename;
 716     }
 717   }
 718
 719   return;
 720 }
 721
 722 sub lilypond_element_target_name($$$)
 723 {
 724   my $element = shift;
 725   my $target = shift;
 726   my $id = shift;
 727   # Target is based on node name (or sec name for secs without node attached)
 728   my $node_name = main::remove_texi($element->{'node_ref'}->{'texi'});
 729   if ($node_name eq '') {
 730     $node_name = main::remove_texi($element->{'texi'});
 731   }
 732
 733   # If we have an entry in the section<=>filename map, use that one, otherwise
 734   # generate the anchor here.
 735   if (exists ($node_to_filename_map->{$node_name})) {
 736     (my $filename, $target) = @{$node_to_filename_map->{$node_name}};
 737   } else {
 738     my $anchor = $node_name;
 739     if ($element->{translationof}) {
 740       $anchor = main::remove_texi($element->{translationof});
 741     }
 742     # normalize to the same file name as texinfo
 743     $target = texinfo_file_name($anchor);
 744   }
 745   # TODO: Once texi2html correctly prints out the target and not the id for
 746   #       the sections, change this back to ($id, $target)
 747   $target = lc($target);
 748   return ($target, $target);
 749 }
 750
 751
 752 ## Load the map file for the corrently processed texi file. We do this
 753 #  using a command init handler, since texi2html does not have any
 754 #  other hooks that are called after THISDOC is filled but before phase 2
 755 #  of the texi2html conversion.
 756 sub lilypond_init_map ()
 757 {
 758     my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 759     my $map_filename = main::locate_include_file ("${docu_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 760         || main::locate_include_file ("${docu_name}.xref-map");
 761     print STDERR "Map filename is: $map_filename\nDocu name is $docu_name\n";
 762     if ($docu_name eq 'web') {
 763         $web_manual = 1;
 764         web_settings();
 765     }
 766     $node_to_filename_map = load_map_file ($map_filename);
 767 }
 768 push @Texi2HTML::Config::command_handler_init, \&lilypond_init_map;
 769
 770
 771
 772 #############################################################################
 773 ###  CLEANER LINK TITLE FOR EXTERNAL REFS
 774 #############################################################################
 775
 776 # The default formatting of external refs returns e.g.
 777 # "(lilypond-internals)Timing_translator", so we remove all (...) from the
 778 # file_and_node argument. Also, we want only a very simple format, so we don't
 779 # even call the default handler!
 780 sub lilypond_external_ref($$$$$$)
 781 {
 782   my $type = shift;
 783   my $section = shift;
 784   my $book = shift;
 785   my $file_node = shift;
 786   my $href = lc(shift);
 787   my $cross_ref = shift;
 788
 789   my $displaytext = '';
 790
 791   # 1) if we have a cross ref name, that's the text to be displayed:
 792   # 2) For the top node, use the (printable) name of the manual, unless we
 793   #    have an explicit cross ref name
 794   # 3) In all other cases use the section name
 795   if ($cross_ref ne '') {
 796     $displaytext = $cross_ref;
 797   } elsif (($section eq '') or ($section eq 'Top')) {
 798     $displaytext = $book;
 799   } else {
 800     $displaytext = $section;
 801   }
 802
 803   $displaytext = &$anchor('', $href, $displaytext) if ($displaytext ne '');
 804   return &$I('%{node_file_href}', { 'node_file_href' => $displaytext });
 805 }
 806
 807
 808
 809
 810
 811 #############################################################################
 812 ###  HANDLING TRANSLATED SECTIONS: handle @translationof, secname<->filename
 813 ###                  map stored on disk, xrefs in other manuals load that map
 814 #############################################################################
 815
 816
 817 # Try to make use of @translationof to generate files according to the original
 818 # English section title...
 819 sub lilypond_unknown($$$$$)
 820 {
 821     my $macro = shift;
 822     my $line = shift;
 823     my $pass = shift;
 824     my $stack = shift;
 825     my $state = shift;
 826
 827     # the @translationof macro provides the original English section title,
 828     # which should be used for file/anchor naming, while the title will be
 829     # translated to each language
 830     # It is already used by extract_texi_filenames.py, so this should not be
 831     # necessary here at all. Still, I'll leave the code in just in case the
 832     # python script messed up ;-)
 833     if ($pass == 1 and $macro eq "translationof") {
 834       if (ref($state->{'element'}) eq 'HASH') {
 835         $state->{'element'}->{'translationof'} = main::normalise_space($line);
 836       }
 837       return ('', 1, undef, undef);
 838     } else {
 839       return &$default_unknown($macro, $line, $pass, $stack, $state);
 840     }
 841 }
 842
 843
 844
 845
 846 my %translated_books = ();
 847 # Construct a href to an external source of information.
 848 # node is the node with texinfo @-commands
 849 # node_id is the node transliterated and transformed as explained in the
 850 #         texinfo manual
 851 # node_xhtml_id is the node transformed such that it is unique and can
 852 #     be used to make an html cross ref as explained in the texinfo manual
 853 # file is the file in '(file)node'
 854 sub lilypond_external_href($$$)
 855 {
 856   my $node = shift;
 857   my $node_id = shift;
 858   my $node_hxmlt_id = shift;
 859   my $file = shift;
 860
 861   # 1) Keep a hash of book->section_map
 862   # 2) if not file in keys hash => try to load the map (assign empty map if
 863   #    non-existent => will load only once!)
 864   # 3) if node in the section=>(file, anchor) map, replace node_id and
 865   #    node_xhtml_id by the map's values
 866   # 4) call the default_external_href with these values (or the old ones if not found)
 867
 868   if (($node_id ne '') and defined($file) and ($node_id ne 'Top')) {
 869     my $map_name = $file;
 870     $map_name =~ s/-big-page//;
 871
 872     # Load the map if we haven't done so already
 873     if (!exists($translated_books{$map_name})) {
 874       my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
 875       my $map_filename = main::locate_include_file ("${map_name}.$Texi2HTML::THISDOC{current_lang}.xref-map")
 876           || main::locate_include_file ("${map_name}.xref-map");
 877       $translated_books{$map_name} = load_map_file ($map_filename);
 878     }
 879
 880     # look up translation. use these values instead of the old filename/anchor
 881     my $section_name_map = $translated_books{$map_name};
 882     my $node_text = main::remove_texi($node);
 883     if (defined($section_name_map->{$node_text})) {
 884       ($node_id, $node_hxmlt_id) = @{$section_name_map->{$node_text}};
 885     } else {
 886       print STDERR "WARNING: Unable to find node '$node_text' in book $map_name.\n";
 887     }
 888   }
 889
 890   if (defined $file) {
 891     return &$default_external_href($node, $node_id, $node_hxmlt_id, lc($file));
 892   } else {
 893     return &$default_external_href($node, $node_id, $node_hxmlt_id);
 894   }
 895 }
 896
 897
 898
 899
 900
 901 #############################################################################
 902 ###  CUSTOM TOC FOR EACH PAGE (in a frame on the left)
 903 #############################################################################
 904
 905 my $page_toc_depth = 2;
 906 my @default_toc = [];
 907
 908 # Initialize the toc_depth to 1 if the command-line option -D=short_toc is given
 909 sub lilypond_init_toc_depth ()
 910 {
 911   if (exists($main::value{'short_toc'}) and not exists($main::value{'bigpage'})
 912       and not $web_manual) {
 913     $page_toc_depth = 1;
 914   }
 915 }
 916 # Set the TOC-depth (depending on a texinfo variable short_toc) in a
 917 # command-handler, so we have them available when creating the pages
 918 push @Texi2HTML::Config::command_handler_process, \&lilypond_init_toc_depth;
 919
 920
 921
 922 # recursively generate the TOC entries for the element and its children (which
 923 # are only shown up to maxlevel. All ancestors of the current element are also
 924 # shown with their immediate children, irrespective of their level.
 925 # Unnumbered entries are only printed out if they are at top-level or 2nd level
 926 # or their parent element is an ancestor of the currently viewed node.
 927 # The conditions to call this method to print the entry for a child node is:
 928 # -) the parent is an ancestor of the current page node
 929 # -) the parent is a numbered element at top-level toplevel (i.e. show numbered
 930 #    and unnumbered 2nd-level children of numbered nodes)
 931 # -) the child element is a numbered node below level maxlevel
 932 sub generate_ly_toc_entries($$$$)
 933 {
 934   my $element = shift;
 935   my $element_path = shift;
 936   my $maxlevel = shift;
 937   if ($web_manual) {
 938     $maxlevel = 1;
 939   }
 940   my $child_count = shift;
 941   # Skip undefined sections, plus all sections generated by index splitting
 942   return() if (not defined($element) or exists($element->{'index_page'}));
 943   my @result = ();
 944   my $level = $element->{'toc_level'};
 945   my $is_parent_of_current = $element->{'id'} && $element_path->{$element->{'id'}};
 946   my $ind = '  ' x $level;
 947   my $this_css_class = " class=\"";
 948   # color indices for the second navigation bar on the website
 949   if ($web_manual) {
 950       my %color_maps = (
 951           'introduction' => [2, 2, 2, 2, 3, 3, 4, 4],
 952           'download' => [2, 2, 2, 3, 3, 4],
 953           'manuals' => [1, 1, 1, 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4],
 954           'community' => [1, 1, 1, 2, 2, 2, 3, 3],
 955           );
 956       my $addColor = "colorDefault";
 957       while (($top_section, $color_indices) = each %color_maps) {
 958           if (index ($element->{'sectionup'}->{'file'}, $top_section) >= 0) {
 959               $addColor = "color" . $color_indices->[$child_count];
 960           }
 961       }
 962       $this_css_class .= $addColor;
 963   }
 964   $this_css_class .= $is_parent_of_current ? ' toc_current"' : '"';
 965   my $entry = "$ind<li$this_css_class>" .
 966       &$anchor ($element->{'tocid'},
 967                 "$element->{'file'}#$element->{'target'}",
 968                 $element->{'text'});
 969
 970   push (@result, $entry);
 971   my $children = $element->{'section_childs'};
 972   if (defined($children) and (ref($children) eq "ARRAY")) {
 973     my $force_children = $is_parent_of_current or ($level == 1 and $element->{'number'});
 974     my @child_result = ();
 975     my $sub_child_count = 0;
 976     foreach my $c (@$children) {
 977       my $is_numbered_child = defined ($c->{'number'});
 978       my $below_maxlevel = $c->{'toc_level'} le $maxlevel;
 979       if ($force_children or ($is_numbered_child and $below_maxlevel)) {
 980         my @child_res =
 981             generate_ly_toc_entries($c, $element_path, $maxlevel, $sub_child_count);
 982         push (@child_result, @child_res);
 983         $sub_child_count += 1;
 984       }
 985     }
 986     # if no child nodes were generated, e.g. for the index, where expanded pages
 987     # are ignored, don't generate a list at all...
 988     if (@child_result) {
 989       push (@result, "\n$ind<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
 990       if ($web_manual) {
 991         push (@result, "$ind<li class=\"colorDefault toc_current\">" .
 992               &$anchor ($element->{'tocid'},
 993                         "$element->{'file'}#$element->{'target'}",
 994                         $element->{'text'}) . "</li>\n");
 995       }
 996       push (@result, @child_result);
 997       push (@result, "$ind</ul>\n");
 998     }
 999   }
1000   push (@result, "$ind</li>\n");
1001   return @result;
1002 }
1003
1004
1005 # Print a customized TOC, containing only the first two levels plus the whole
1006 # path to the current page
1007 sub lilypond_generate_page_toc_body($)
1008 {
1009     my $element = shift;
1010     my $current_element = $element;
1011     my %parentelements;
1012     $parentelements{$element->{'id'}} = 1;
1013     # Find the path to the current element
1014     while ( defined($current_element->{'sectionup'}) and
1015            ($current_element->{'sectionup'} ne $current_element) )
1016     {
1017       $parentelements{$current_element->{'sectionup'}->{'id'}} = 1
1018               if ($current_element->{'sectionup'}->{'id'} ne '');
1019       $current_element = $current_element->{'sectionup'};
1020       if ($web_manual) {
1021         if (exists($main::value{'shallow_toc'})) {
1022           last;
1023         }
1024       }
1025     }
1026     return () if not defined($current_element);
1027     # Create the toc entries recursively
1028     my @toc_entries = "";
1029     if ($web_manual) {
1030         @toc_entries = "<ul$NO_BULLET_LIST_ATTRIBUTE>\n";
1031         # FIXME: add link to main page, really hackily.
1032         if ($element->{'sectionup'}) {
1033             # it's not the top element
1034             push (@toc_entries, "<li><a href=\"index.html\">Main</a></li>\n");
1035         } else {
1036             push (@toc_entries,
1037                   "<li class=\"toc_current\"><a href=\"index.html\">Main</a></li>\n");
1038         }
1039     } else {
1040         push (@toc_entries, "<div class=\"contents\">\n");
1041         push (@toc_entries, "<ul$NO_BULLET_LIST_ATTRIBUTE>\n");
1042     }
1043     my $children = $current_element->{'section_childs'};
1044     foreach ( @$children ) {
1045       push (@toc_entries, generate_ly_toc_entries($_, \%parentelements, $page_toc_depth, 0));
1046     }
1047     # search box
1048     local $/=undef;
1049     my $name = "search-box";
1050     $lang = $Texi2HTML::THISDOC{current_lang};
1051     open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$lang/$name.ihtml" or
1052         open FILE, "$ENV{TOP_SRC_DIR}/Documentation/$name.ihtml"  or
1053         die "no such file: $name.ihtml: $!";
1054     my $search_string = <FILE>;
1055     $search_string = "<li>\n" . $search_string . "</li>\n";
1056     push (@toc_entries, $search_string);
1057     close FILE;
1058
1059     push (@toc_entries, "</ul>\n");
1060     if ($web_manual) {
1061         push (@toc_entries, "\n");
1062     } else {
1063         push (@toc_entries, "</div>\n");
1064     }
1065     return @toc_entries;
1066 }
1067
1068 sub lilypond_print_toc_div ($$)
1069 {
1070   my $fh = shift;
1071   my $tocref = shift;
1072   my @lines = @$tocref;
1073   # use default TOC if no custom lines have been generated
1074   @lines = @default_toc if (not @lines);
1075   if (@lines) {
1076
1077     print $fh "\n\n<div id=\"tocframe\">\n";
1078
1079     # Remove the leading "GNU LilyPond --- " from the manual title
1080     my $topname = $Texi2HTML::NAME{'Top'};
1081     $topname =~ s/^GNU LilyPond(:| &[mn]dash;) //;
1082
1083     # construct the top-level Docs index (relative path and including language!)
1084     my $lang = $Texi2HTML::THISDOC{current_lang};
1085     if ($lang and $lang ne "en") {
1086       $lang .= ".";
1087     } else {
1088       $lang = "";
1089     }
1090     my $reldir = "";
1091     $reldir = "../" if ($Texi2HTML::Config::SPLIT eq 'section');
1092     my $uplink = $reldir."web/manuals.${lang}html";
1093
1094     if (not $web_manual) {
1095       print $fh "<p class=\"toc_uplink\"><a href=\"$uplink\"
1096          title=\"Documentation Index\">&lt;&lt; " .
1097          &ly_get_string ('Back to Documentation Index') .
1098          "</a></p>\n";
1099
1100       print $fh '<h4 class="toc_header"> ' . &$anchor('',
1101                                     $Texi2HTML::HREF{'Top'},
1102                                     $topname,
1103                                     'title="Start of the manual"'
1104                                    ) . "</h4>\n";
1105     }
1106
1107     foreach my $line (@lines) {
1108       print $fh $line;
1109     }
1110     print $fh "</div>\n\n";
1111   }
1112 }
1113
1114 # Create the custom TOC for this page (partially folded, current page is
1115 # highlighted) and store it in a global variable. The TOC is written out after
1116 # the html contents (but positioned correctly using CSS), so that browsers with
1117 # css turned off still show the contents first.
1118 our @this_page_toc = ();
1119 sub lilypond_print_element_header
1120 {
1121   my $first_in_page = shift;
1122   my $previous_is_top = shift;
1123   if ($first_in_page and not @this_page_toc) {
1124     if (defined($Texi2HTML::THIS_ELEMENT)) {
1125       # Create the TOC for this page
1126       @this_page_toc = lilypond_generate_page_toc_body($Texi2HTML::THIS_ELEMENT);
1127     }
1128   }
1129   return &$default_print_element_header( $first_in_page, $previous_is_top);
1130 }
1131
1132 # Generate the HTML output for the TOC
1133 sub lilypond_toc_body($)
1134 {
1135     my $elements_list = shift;
1136     # Generate a default TOC for pages without THIS_ELEMENT
1137     @default_toc = lilypond_generate_page_toc_body(@$elements_list[0]);
1138     return &$default_toc_body($elements_list);
1139 }
1140
1141 # Print out the TOC in a <div> at the beginning of the page
1142 sub lilypond_print_page_head($)
1143 {
1144     my $fh = shift;
1145     &$default_print_page_head($fh);
1146     print $fh "<div id=\"main\">\n";
1147 }
1148
1149 # Print out the TOC in a <div> at the end of th page, which will be formatted as a
1150 # sidebar mimicking a TOC frame
1151 sub print_lilypond_page_foot($)
1152 {
1153   my $fh = shift;
1154   my $program_string = &$program_string();
1155 #   print $fh "<p><font size='-1'>$program_string</font><br>$PRE_BODY_CLOSE</p>\n";
1156   print $fh "<!-- FOOTER -->\n\n";
1157   print $fh "<!-- end div#main here -->\n</div>\n\n";
1158   if ($web_manual) {
1159     # FIXME: This div and p#languages need to be in div#footer.
1160     #        Should we move this div to postprocess_html.py ?
1161     print $fh "<div id=\"verifier_texinfo\">\n";
1162     print $fh "<h3>Validation</h3>\n";
1163     # FIXME: inlined text substitution, move to ly_get_string as soon as another case is needed
1164     my $webdev_link = "<a href=\"http://www.webdev.nl/\">webdev.nl</a>";
1165     my $lily_site = "<code>lilypond.org</code>";
1166     my $hosting_thanks = &ly_get_string ('<p>Thanks to ${webdev_link} for hosting ${lily_site}.');
1167     # this does the variable substitution ("quoting" in Perlish) after the localization
1168     $hosting_thanks =~ s/(\$\{\w+\})/$1/eeg;
1169     print $fh $hosting_thanks . "\n";
1170     print $fh "<a href=\"http://validator.w3.org/check?uri=referer\">\n";
1171     print $fh "<img src=\"http://www.w3.org/Icons/valid-html401\"\n";
1172     print $fh "     alt=\"Valid HTML 4.01 Transitional\"\n";
1173     print $fh "     height=\"31\" width=\"88\"></a></p>\n";
1174     print $fh "</div>";
1175   }
1176
1177   # Print the TOC frame and reset the TOC:
1178   lilypond_print_toc_div ($fh, \@this_page_toc);
1179   @this_page_toc = ();
1180
1181   # Close the page:
1182   print $fh "</body>\n</html>\n";
1183 }
1184
1185
1186
1187
1188
1189 #############################################################################
1190 ###  NICER / MORE FLEXIBLE NAVIGATION PANELS
1191 #############################################################################
1192
1193 sub get_navigation_text
1194 {
1195   my $button = shift;
1196   my $text = $NAVIGATION_TEXT{$button};
1197   if ( ($button eq 'Back') or ($button eq 'FastBack') ) {
1198     $text = $text . $Texi2HTML::NODE{$button} . "&nbsp;";
1199   } elsif ( ($button eq 'Forward') or ($button eq 'FastForward') ) {
1200     $text = "&nbsp;" . $Texi2HTML::NODE{$button} . $text;
1201   } elsif ( $button eq 'Up' ) {
1202     $text = "&nbsp;".$text.":&nbsp;" . $Texi2HTML::NODE{$button} . "&nbsp;";
1203   }
1204   return $text;
1205 }
1206
1207
1208 # Don't automatically create left-aligned table cells for every link, but
1209 # instead create a <td> only on an appropriate '(left|right|center)-aligned-cell-n'
1210 # button text. It's alignment as well as the colspan will be taken from the
1211 # name of the button. Also, add 'newline' button text to create a new table
1212 # row. The texts of the buttons are generated by get_navigation_text and
1213 # will contain the name of the next/previous section/chapter.
1214 sub lilypond_print_navigation
1215 {
1216     my $buttons = shift;
1217     my $vertical = shift;
1218     my $spacing = 1;
1219     my $result = "<table class=\"nav_table\">\n";
1220
1221     $result .= "<tr>" unless $vertical;
1222     my $beginofline = 1;
1223     foreach my $button (@$buttons)
1224     {
1225         $result .= qq{<tr valign="top" align="left">\n} if $vertical;
1226         # Allow (left|right|center)-aligned-cell and newline as buttons!
1227         if ( $button =~ /^(.*)-aligned-cell-(.*)$/ )
1228         {
1229           $result .= qq{</td>} unless $beginofline;
1230           $result .= qq{<td valign="middle" align="$1" colspan="$2">};
1231           $beginofline = 0;
1232         }
1233         elsif ( $button eq 'newline' )
1234         {
1235           $result .= qq{</td>} unless $beginofline;
1236           $result .= qq{</tr>};
1237           $result .= qq{<tr>};
1238           $beginofline = 1;
1239
1240         }
1241         elsif (ref($button) eq 'CODE')
1242         {
1243             $result .= &$button($vertical);
1244         }
1245         elsif (ref($button) eq 'SCALAR')
1246         {
1247             $result .= "$$button" if defined($$button);
1248         }
1249         elsif (ref($button) eq 'ARRAY')
1250         {
1251             my $text = $button->[1];
1252             my $button_href = $button->[0];
1253             # verify that $button_href is simple text and text is a reference
1254             if (defined($button_href) and !ref($button_href)
1255                and defined($text) and (ref($text) eq 'SCALAR') and defined($$text))
1256             {             # use given text
1257                 if ($Texi2HTML::HREF{$button_href})
1258                 {
1259                   my $anchor_attributes = '';
1260                   if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button_href})) and
1261                       ($BUTTONS_ACCESSKEY{$button_href} ne ''))
1262                   {
1263                       $anchor_attributes = "accesskey=\"$BUTTONS_ACCESSKEY{$button_href}\"";
1264                   }
1265                   if ($USE_REL_REV and (defined($BUTTONS_REL{$button_href})) and
1266                       ($BUTTONS_REL{$button_href} ne ''))
1267                   {
1268                       $anchor_attributes .= " rel=\"$BUTTONS_REL{$button_href}\"";
1269                   }
1270                   $result .=  "" .
1271                         &$anchor('',
1272                                     $Texi2HTML::HREF{$button_href},
1273                                     get_navigation_text($$text),
1274                                     $anchor_attributes
1275                                    );
1276                 }
1277                 else
1278                 {
1279                   $result .=  get_navigation_text($$text);
1280                 }
1281             }
1282         }
1283         elsif ($button eq ' ')
1284         {                       # handle space button
1285             $result .=
1286                 ($ICONS && $ACTIVE_ICONS{' '}) ?
1287                     &$button_icon_img($BUTTONS_NAME{$button}, $ACTIVE_ICONS{' '}) :
1288                         $NAVIGATION_TEXT{' '};
1289             #next;
1290         }
1291         elsif ($Texi2HTML::HREF{$button})
1292         {                       # button is active
1293             my $btitle = $BUTTONS_GOTO{$button} ?
1294                 'title="' . $BUTTONS_GOTO{$button} . '"' : '';
1295             if ($USE_ACCESSKEY and (defined($BUTTONS_ACCESSKEY{$button})) and
1296                 ($BUTTONS_ACCESSKEY{$button} ne ''))
1297             {
1298                 $btitle .= " accesskey=\"$BUTTONS_ACCESSKEY{$button}\"";
1299             }
1300             if ($USE_REL_REV and (defined($BUTTONS_REL{$button})) and
1301                 ($BUTTONS_REL{$button} ne ''))
1302             {
1303                 $btitle .= " rel=\"$BUTTONS_REL{$button}\"";
1304             }
1305             if ($ICONS && $ACTIVE_ICONS{$button})
1306             {                   # use icon
1307                 $result .= '' .
1308                     &$anchor('',
1309                         $Texi2HTML::HREF{$button},
1310                         &$button_icon_img($BUTTONS_NAME{$button},
1311                                    $ACTIVE_ICONS{$button},
1312                                    $Texi2HTML::SIMPLE_TEXT{$button}),
1313                         $btitle
1314                       );
1315             }
1316             else
1317             {                   # use text
1318                 $result .=
1319                     '[' .
1320                         &$anchor('',
1321                                     $Texi2HTML::HREF{$button},
1322                                     get_navigation_text($button),
1323                                     $btitle
1324                                    ) .
1325                                        ']';
1326             }
1327         }
1328         else
1329         {                       # button is passive
1330             $result .=
1331                 $ICONS && $PASSIVE_ICONS{$button} ?
1332                     &$button_icon_img($BUTTONS_NAME{$button},
1333                                           $PASSIVE_ICONS{$button},
1334                                           $Texi2HTML::SIMPLE_TEXT{$button}) :
1335
1336                                               "[" . get_navigation_text($button) . "]";
1337         }
1338         $result .= "</td>\n" if $vertical;
1339         $result .= "</tr>\n" if $vertical;
1340     }
1341     $result .= "</td>" unless $beginofline;
1342     $result .= "</tr>" unless $vertical;
1343     $result .= "</table>\n";
1344     if ($web_manual) {
1345       return "\n";
1346     } else {
1347       return $result;
1348     }
1349 }
1350
1351
1352 @Texi2HTML::Config::SECTION_BUTTONS =
1353     ('left-aligned-cell-1', 'FastBack',
1354      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1355      'right-aligned-cell-1', 'FastForward',
1356      'newline',
1357      'left-aligned-cell-2', 'Back',
1358      'center-aligned-cell-1', 'Up',
1359      'right-aligned-cell-2', 'Forward'
1360     );
1361
1362 # buttons for misc stuff
1363 @Texi2HTML::Config::MISC_BUTTONS = ('center-aligned-cell-3',
1364                                     'Top', 'Contents', 'Index', 'About');
1365
1366 # buttons for chapter file footers
1367 # (and headers but only if SECTION_NAVIGATION is false)
1368 @Texi2HTML::Config::CHAPTER_BUTTONS =
1369     ('left-aligned-cell-1', 'FastBack',
1370      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1371      'right-aligned-cell-1', 'FastForward',
1372     );
1373
1374 # buttons for section file footers
1375 @Texi2HTML::Config::SECTION_FOOTER_BUTTONS =
1376     ('left-aligned-cell-1', 'FastBack',
1377      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1378      'right-aligned-cell-1', 'FastForward',
1379      'newline',
1380      'left-aligned-cell-2', 'Back',
1381      'center-aligned-cell-1', 'Up',
1382      'right-aligned-cell-2', 'Forward'
1383     );
1384
1385 @Texi2HTML::Config::NODE_FOOTER_BUTTONS =
1386     ('left-aligned-cell-1', 'FastBack',
1387      'center-aligned-cell-3', 'Top', 'Contents', 'Index', 'About',
1388      'right-aligned-cell-1', 'FastForward',
1389      'newline',
1390      'left-aligned-cell-2', 'Back',
1391      'center-aligned-cell-1', 'Up',
1392      'right-aligned-cell-2', 'Forward'
1393     );
1394
1395
1396
1397
1398
1399 #############################################################################
1400 ###  FOOTNOTE FORMATTING
1401 #############################################################################
1402
1403 # Format footnotes in a nicer way: Instead of printing the number in a separate
1404 # (nr) heading line, use the standard way of prepending <sup>nr</sup> immediately
1405 # before the fn text.
1406
1407
1408 # The following code is copied from texi2html's examples/makeinfo.init and
1409 # should be updated when texi2html makes some changes there!
1410
1411 my $makekinfo_like_footnote_absolute_number = 0;
1412
1413 sub makeinfo_like_foot_line_and_ref($$$$$$$$)
1414 {
1415     my $foot_num = shift;
1416     my $relative_num = shift;
1417     my $footid = shift;
1418     my $docid = shift;
1419     my $from_file = shift;
1420     my $footnote_file = shift;
1421     my $lines = shift;
1422     my $state = shift;
1423
1424     $makekinfo_like_footnote_absolute_number++;
1425
1426     # this is a bit obscure, this allows to add an anchor only if formatted
1427     # as part of the document.
1428     $docid = '' if ($state->{'outside_document'} or $state->{'multiple_pass'});
1429
1430     if ($from_file eq $footnote_file)
1431     {
1432         $from_file = $footnote_file = '';
1433     }
1434
1435     my $foot_anchor = "<sup>" .
1436         &$anchor($docid, "$footnote_file#$footid", $relative_num) . "</sup>";
1437     $foot_anchor = &$anchor($docid,
1438                             "$footnote_file#$footid",
1439                             "($relative_num)") if ($state->{'preformatted'});
1440
1441 #    unshift @$lines, "<li>";
1442 #    push @$lines, "</li>\n";
1443     return ($lines, $foot_anchor);
1444 }
1445
1446 sub makeinfo_like_foot_lines($)
1447 {
1448     my $lines = shift;
1449     unshift @$lines, "<hr>\n<h4>$Texi2HTML::I18n::WORDS->{'Footnotes_Title'}</h4>\n";
1450 #<ol type=\"1\">\n";
1451 #    push @$lines, "</ol>";
1452     return $lines;
1453 }
1454
1455 my %makekinfo_like_paragraph_in_footnote_nr;
1456
1457 sub makeinfo_like_paragraph ($$$$$$$$$$$$$)
1458 {
1459     my $text = shift;
1460     my $align = shift;
1461     my $indent = shift;
1462     my $paragraph_command = shift;
1463     my $paragraph_command_formatted = shift;
1464     my $paragraph_number = shift;
1465     my $format = shift;
1466     my $item_nr = shift;
1467     my $enumerate_style = shift;
1468     my $number = shift;
1469     my $command_stack_at_end = shift;
1470     my $command_stack_at_begin = shift;
1471     my $state = shift;
1472 #print STDERR "format: $format\n" if (defined($format));
1473 #print STDERR "paragraph @$command_stack_at_end; @$command_stack_at_begin\n";
1474     $paragraph_command_formatted = '' if (!defined($paragraph_command_formatted) or
1475           exists($special_list_commands{$format}->{$paragraph_command}));
1476     return '' if ($text =~ /^\s*$/);
1477     foreach my $style(t2h_collect_styles($command_stack_at_begin))
1478     {
1479        $text = t2h_begin_style($style, $text);
1480     }
1481     foreach my $style(t2h_collect_styles($command_stack_at_end))
1482     {
1483        $text = t2h_end_style($style, $text);
1484     }
1485     if (defined($paragraph_number) and defined($$paragraph_number))
1486     {
1487          $$paragraph_number++;
1488          return $text  if (($format eq 'itemize' or $format eq 'enumerate') and
1489             ($$paragraph_number == 1));
1490     }
1491     my $open = '<p';
1492     if ($align)
1493     {
1494         $open .= " align=\"$paragraph_style{$align}\"";
1495     }
1496     my $footnote_text = '';
1497     if (defined($command_stack_at_begin->[0]) and $command_stack_at_begin->[0] eq 'footnote')
1498     {
1499         my $state = $Texi2HTML::THISDOC{'state'};
1500         $makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number}++;
1501         if ($makekinfo_like_paragraph_in_footnote_nr{$makekinfo_like_footnote_absolute_number} <= 1)
1502         {
1503            $open.=' class="footnote"';
1504            my $document_file = $state->{'footnote_document_file'};
1505            if ($document_file eq $state->{'footnote_footnote_file'})
1506            {
1507                $document_file = '';
1508            }
1509            my $docid = $state->{'footnote_place_id'};
1510            my $doc_state = $state->{'footnote_document_state'};
1511            $docid = '' if ($doc_state->{'outside_document'} or $doc_state->{'multiple_pass'});
1512            my $foot_label = &$anchor($state->{'footnote_footnote_id'},
1513                  $document_file . "#$state->{'footnote_place_id'}",
1514                  "$state->{'footnote_number_in_page'}");
1515            $footnote_text = "<small>[${foot_label}]</small> ";
1516         }
1517     }
1518     return $open.'>'.$footnote_text.$text.'</p>';
1519 }
1520
1521
1522 #############################################################################
1523 ###  OTHER SETTINGS
1524 #############################################################################
1525
1526 # For split pages, use index.html as start page!
1527 if ($Texi2HTML::Config::SPLIT eq 'section' or
1528     $Texi2HTML::Config::SPLIT eq 'node') {
1529   $Texi2HTML::Config::TOP_FILE = 'index.html';
1530 }
1531
1532
1533 return 1;