erbook 6.0.1 → 6.1.0

data/doc/intro.erb

@@ -21,7 +21,7 @@
   * [Grutatxt](http://www.triptico.com/software/grutatxt.html)
 
   <% section "Logistics" do %>
-    * <%= xref "history", "Release notes" %> --- history of project releases.
+    * <%= xref "History", "Release notes" %> --- history of project releases.
     * [Source code](http://github.com/sunaku/<%= $program %>) --- obtain via [Git](http://git.or.cz) or browse online.
     * [API reference](api/index.html) --- documentation for source code.
 
@@ -74,12 +74,25 @@
     <%# include ../LICENSE #%>
   <% end %>
 
-  <% section "Credits" do %>
-    <%= $logo = "![#{$project} logo](#{$program}.png)".to_inline_xhtml %>
+  <% section "Credits" do |n| %>
+    <%= $logo = n.xref_link("![#{$project} logo](#{$program}.png)".to_inline_xhtml) %>
     <%# include README #%>
+
+    **<%= $project %>** is made possible by
+    <%= xref "History", "contributions" %>
+    from users like you:
+
+    * Jens Vierbuchen
+    * Maunika Gosike
+    * [Zhang Chiyuan](http://lifegoo.pluskid.org)
   <% end %>
 
   <% section "Reviews" do %>
+    Tom Cloyd in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/327499):
+
+    > This documentation is simply gorgeous!
+
+
     Vitor Peres in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283052):
 
     > I actually felt like printing \[this manual], because it's just so well-thought typographically... Even if \[**<%= $project %>**] weren't great by itself, I'd feel good just looking at the manual.
@@ -87,7 +100,7 @@
 
     Ara T. Howard in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/282949):
 
-    > \[this manual is] a insanely complete and nice looking bit of documentation \[... **<%= $project %>**] looks like a great project
+    > \[This manual is] a insanely complete and nice looking bit of documentation \[... **<%= $project %>**] looks like a great project
 
 
     Martin DeMello in [ruby-talk](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/283304):

data/doc/usage.erb

@@ -1,17 +1,17 @@
 <% chapter "Usage" do %>
   <% section "Command-line interface" do %>
-    <pre><%= `ruby bin/erbook -h` %></pre>
+    <pre><%= `ruby bin/#{$program} -h` %></pre>
 
-    The first command-line argument to erbook is either the name of a predefined format (FormatName) or the path to a <%= xref "SpecFile", "format specification file" %> (FormatFile).
+    The first command-line argument to **<%= $project %>** is either the name of a predefined format (FormatName) or the path to a <%= xref "SpecFile", "format specification file" %> (FormatFile).
 
-    Predefined formats are simply short-hand names of format specification files located in the <tt>fmt/</tt> subdirectory of the erbook installation directory (see <%= xref "Manifest" %>).
+    Predefined formats are simply short-hand names of format specification files located in the <tt>fmt/</tt> subdirectory of the **<%= $project %>** installation directory (see <%= xref "Manifest" %>).
 
     <% section "Saving the output to a file" do %>
       Simply redirect the standard ouput stream (STDOUT) to a file like this:
 
-          erbook > YOUR_PATH_HERE
+          <%= $program %> > YOUR_PATH_HERE
 
-      In the above example, **YOUR\_PATH\_HERE** is the path of the file in which the output should be saved.
+      In the above example, *YOUR\_PATH\_HERE* is the path of the file in which the output should be saved.
 
       <% important "Save XHTML output as <tt>.xhtml</tt>" do %>
         When you use the XHTML format, ensure that the file extension of your saved output document is either <tt>.xhtml</tt> or <tt>.xml</tt>. Alternatively, ensure that your saved output document is served to web browsers under the <tt>application/xhtml+xml</tt> mime type.
@@ -26,14 +26,14 @@
 
         <%%# include YOUR_PATH_HERE #%>
 
-    In the above example, **YOUR\_PATH\_HERE** is the path of the file whose content you wish to insert into the input document.
+    In the above example, *YOUR\_PATH\_HERE* is the path of the file whose content you wish to insert into the input document.
 
     You can divide a large document into separate files for easier editing and stitch them together, dynamically, into a single document using the **include** directive.
   <% end %>
 
   <% section "Unindenting nodes hierarchically" do %>
-    When writing erbook documents, I prefer to indent the content of nodes according to their depth because my [text editor of choice](http://jedit.org) automatically folds blocks of text based on indentation.
+    When writing **<%= $project %>** documents, I prefer to indent the content of nodes according to their depth because my [text editor of choice](http://jedit.org) automatically folds blocks of text based on indentation.
 
-    If you also prefer to write documents in this way, be sure to pass the <tt>--unindent</tt> option to **erbook** so that the indentation will not affect the resulting output.
+    If you also prefer to write documents in this way, be sure to pass the <tt>--unindent</tt> option to **<%= $project %>** so that the indentation will not affect the resulting output.
   <% end %>
 <% end %>

data/fmt/xhtml.yaml

@@ -90,7 +90,7 @@ code: |
       #
 
       def type_label #:nodoc:
-        type.to_s.capitalize
+        ERBook::PHRASES[type.to_s.capitalize]
       end
 
       # Returns the title of this node as XHTML.
@@ -151,16 +151,21 @@ code: |
       PREV_SIGN = '△' # white up-pointing triangle
       NEXT_SIGN = '▽' # white down-pointing triangle
 
+      LIST_TEXT = ERBook::PHRASES['Reverse jump to listing']
+      HERE_TEXT = ERBook::PHRASES['Jump to this segment']
+      PREV_TEXT = ERBook::PHRASES['Jump to previous segment']
+      NEXT_TEXT = ERBook::PHRASES['Jump to next segment']
+
       # Calculates a local navigation menu containing links
       # to the given URI fragments (which can be nil).
       def self.navigation here_frag, list_frag, prev_frag, next_frag
-        list_link = list_frag ? %{<a title="Reverse jump to listing" href="##{list_frag}">#{LIST_SIGN}</a>} : LIST_SIGN
+        list_link = list_frag ? %{<a title="#{LIST_TEXT}" href="##{list_frag}">#{LIST_SIGN}</a>} : LIST_SIGN
 
-        here_link = here_frag ? %{<a title="Jump to this segment" href="##{here_frag}">#{HERE_SIGN}</a>} : HERE_SIGN
+        here_link = here_frag ? %{<a title="#{HERE_TEXT}" href="##{here_frag}">#{HERE_SIGN}</a>} : HERE_SIGN
 
-        prev_link = prev_frag ? %{<a title="Jump to previous segment" href="##{prev_frag}">#{PREV_SIGN}</a>} : PREV_SIGN
+        prev_link = prev_frag ? %{<a title="#{PREV_TEXT}" href="##{prev_frag}">#{PREV_SIGN}</a>} : PREV_SIGN
 
-        next_link = next_frag ? %{<a title="Jump to next segment" href="##{next_frag}">#{NEXT_SIGN}</a>} : NEXT_SIGN
+        next_link = next_frag ? %{<a title="#{NEXT_TEXT}" href="##{next_frag}">#{NEXT_SIGN}</a>} : NEXT_SIGN
 
         %{<a name="#{here_frag}"/><div class="nav" id="#{here_frag}">#{list_link}#{prev_link}#{next_link}#{here_link}</div>}
       end
@@ -180,7 +185,7 @@ code: |
           if type == 'reference'
             prefix
           else
-            [prefix, title].compact.join('. ')
+            [prefix, (%{"#{title}"} if title)].compact.join('. ')
           end
 
         title_xhtml =
@@ -499,19 +504,12 @@ nodes:
       inline: true
       output: |
         <%=
-          target = @nodes_by_type['reference'].find {|n| n.title == @node.args[0]}
+          target = @nodes_by_type['reference'].find {|n| n.title == @node.title }
 
           if target
             '<sup>[%s]</sup>' % [
-
-              '<a class="%s" href="#%s">%s</a>' % [
-                @node.type,
-                target.here_frag,
-                target.number
-              ],
-
+              target.xref_link(target.number),
               *@node.args[1..-1]
-
             ].join(', ')
           else
             raise ArgumentError, "invalid citation for #{@node.title.inspect}", @node.trace
@@ -571,7 +569,7 @@ output: |
           %{<li><a id="#{n.list_frag}" href="##{n.here_frag}">#{n.title.to_s.to_inline_xhtml}</a></li>}
         end
 
-        label = type.capitalize << 's' # TODO: pluralize this properly
+        label = ERBook::PHRASES[type.capitalize << 's']
         lof_sections << label
 
         %{#{ERBook::Document::Node.navigation label, "rev:#{label}", nil, nil}<h2 class="title">#{label}</h2> <ol>#{nested}</ol>}
@@ -643,10 +641,10 @@ output: |
       <%
         # menu of links to link sections
         nav = [
-          ('Abstract' if abstract),
-          'Contents',
+          (ERBook::PHRASES['Abstract'] if abstract),
+          ERBook::PHRASES['Contents'],
           lof_sections,
-          ('References' if references)
+          (ERBook::PHRASES['References'] if references)
         ].flatten.compact
 
         if nav.length > 1
@@ -708,13 +706,13 @@ output: |
 
       <% unless toc.empty? %>
         <div id="toc">
-          <%= ERBook::Document::Node.navigation "Contents", "rev:Contents", nil, nil %>
-          <h1 class="title">Contents</h1>
+          <%= ERBook::Document::Node.navigation 'Contents', 'rev:Contents', nil, nil %>
+          <h1 class="title"><%= ERBook::PHRASES['Contents'] %></h1>
           <ul>
             <%= toc %>
 
             <% if references %>
-            <li><a id="rev:References" href="#References">References</a></li>
+            <li><a id="rev:References" href="#References"><%= ERBook::PHRASES['References'] %></a></li>
             <% end %>
           </ul>
         </div>
@@ -732,8 +730,8 @@ output: |
 
       <% if references %>
       <div id="bib">
-        <%= ERBook::Document::Node.navigation "References", "rev:References", nil, nil %>
-        <h1 class="title" >References</h1>
+        <%= ERBook::Document::Node.navigation 'References', 'rev:References', nil, nil %>
+        <h1 class="title"><%= ERBook::PHRASES['References'] %></h1>
         <ol>
         <% references.each do |n| %>
           <li id="<%= n.here_frag %>"><%= n.content_xhtml %></li>
@@ -751,11 +749,20 @@ output: |
       <%= node = @nodes_by_type['footer_inside_above'].first and node.output %>
       <% if footer = @nodes_by_type['footer'].first %>
         <%= footer.content.to_s.to_xhtml %>
-      <% else %>
-        Generated by <a href="<%= ERBook::WEBSITE %>"><%= ERBook::DISPLAY %></a> on <%= Time.now %>.
-      <% end %>
+      <%
+        else
+          ERBook::PHRASES[
+            'Generated by %s on %s.',
+            %{<a href="#{ERBook::WEBSITE}">#{ERBook::DISPLAY}</a>},
+            Time.now
+          ]
+        end
+      %>
 
       <div id="footer-credits">
+        <%
+          icon_credits = 'The icons shown above are part of %s, which is copyright %s and is distributed under %s.'
+        %>
         <p>
           <% ICONS.select {|i| i.origin == 'tango' }.each do |icon| %>
             <%= icon.to_xhtml %>
@@ -763,7 +770,17 @@ output: |
 
           <br/>
 
-          The icons shown above are &copy; 2005 <a href="http://tango.freedesktop.org">Tango Desktop Project</a>. They are part of the <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a> set, which is distributed under the <a href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License Agreement</a>.
+          <%=
+            ERBook::PHRASES[
+              icon_credits,
+
+              '<a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a>',
+
+              '&copy; 2005 <a href="http://tango.freedesktop.org">Tango Desktop Project</a>',
+
+              '<a href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License Agreement</a>'
+            ]
+          %>
         </p>
 
         <p>
@@ -773,7 +790,17 @@ output: |
 
           <br/>
 
-          The icons shown above are &copy; 2007 <a href="https://www.ohloh.net/projects/mediawiki/contributors">MediaWiki contributors</a>. They are part of the <a href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a> software, which is distributed under the <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License, version 2</a>.
+          <%=
+            ERBook::PHRASES[
+              icon_credits,
+
+              '<a href="http://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a>',
+
+              '&copy; 2007 <a href="https://www.ohloh.net/projects/mediawiki/contributors">MediaWiki contributors</a>',
+
+              '<a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License, version 2</a>'
+            ]
+          %>
         </p>
       </div>
       <%= node = @nodes_by_type['footer_inside_below'].first and node.output %>
@@ -817,7 +844,7 @@ styles:
       {
           height            : 0;
           border            : 0;
-          border-top        : 2px solid #FF0000;
+          border-top        : thin dashed #000000;
       }
 
     /* source code */
@@ -1252,7 +1279,7 @@ styles:
       .nav a:link,
       .nav a:visited
       {
-          color             : #D3D3D3;
+          color             : #C0C0C0;
       }
 
       .nav a:hover,

data/lang/de.yaml

@@ -0,0 +1,33 @@
+# de (German)
+Caution: Vorsicht
+Cautions: Vorsichtsmaßnahmen
+Chapter: Kapitel
+Contents: Inhalt
+Equation: Gleichung
+Equations: Gleichungen
+Example: Beispiel
+Examples: Beispiele
+Figure: Abbildung
+Figures: Abbildungen
+Generated by %s on %s.: Erzeugt durch %s auf %s.
+Important: Wichtig
+Importants: Importants
+Jump to next segment: Springen Sie, um zunächst zu segmentieren
+Jump to previous segment: Springen Sie zum vorhergehenden Segment
+Jump to this segment: Springen Sie zu diesem Segment
+Note: Merken Sie
+Notes: Anmerkungen
+Part: Teil
+Procedure: Verfahren
+Procedures: Verfahren
+Reference: Hinweis
+References: Hinweise
+Reverse jump to listing: Rücksprung zur Auflistung
+Section: Abschnitt
+Table: Tabelle
+Tables: Tabellen
+The icons shown above are part of %s, which is copyright %s and is distributed under %s.: Die Ikonen, die oben gezeigt werden, sind ein Teil %s, das copyright %s ist und unter %s. verteilt wird.
+Tip: Spitze
+Tips: Spitzen
+Warning: Warnung
+Warnings: Warnungen

data/lang/el.yaml

@@ -0,0 +1,33 @@
+# el (Greek)
+Caution: Προσοχή
+Cautions: Προσοχές
+Chapter: Κεφάλαιο
+Contents: Περιεχόμενο
+Equation: Εξίσωση
+Equations: Εξισώσεις
+Example: Παράδειγμα
+Examples: Παραδείγματα
+Figure: Αριθμός
+Figures: Αριθμοί
+Generated by %s on %s.: Παραγμένος από %s %s.
+Important: Σημαντικός
+Importants: Importants
+Jump to next segment: Άλμα στο επόμενο τμήμα
+Jump to previous segment: Άλμα στο προηγούμενο τμήμα
+Jump to this segment: Άλμα σε αυτό το τμήμα
+Note: Σημείωση
+Notes: Σημειώσεις
+Part: Μέρος
+Procedure: Διαδικασία
+Procedures: Διαδικασίες
+Reference: Αναφορά
+References: Αναφορές
+Reverse jump to listing: Αντίστροφο άλμα στη λίστα
+Section: Τμήμα
+Table: Πίνακας
+Tables: Πίνακες
+The icons shown above are part of %s, which is copyright %s and is distributed under %s.: Τα εικονίδια που παρουσιάζονται ανωτέρω είναι μέρος %s, το οποίο είναι πνευματικά δικαιώματα %s και διανέμεται κάτω από %s.
+Tip: Άκρη
+Tips: Άκρες
+Warning: Προειδοποίηση
+Warnings: Προειδοποιήσεις

data/lang/es.yaml

@@ -0,0 +1,33 @@
+# es (Spanish)
+Caution: Precaución
+Cautions: Precauciones
+Chapter: Capítulo
+Contents: Contenido
+Equation: Ecuación
+Equations: Ecuaciones
+Example: Ejemplo
+Examples: Ejemplos
+Figure: Figura
+Figures: Figuras
+Generated by %s on %s.: Generado por %s en %s.
+Important: Importante
+Importants: Importants
+Jump to next segment: Salte para dividir en segmentos después
+Jump to previous segment: Salte al segmento anterior
+Jump to this segment: Salte a este segmento
+Note: Observe
+Notes: Notas
+Part: Parte
+Procedure: Procedimiento
+Procedures: Procedimientos
+Reference: Referencia
+References: Referencias
+Reverse jump to listing: Salto reverso al listado
+Section: Sección
+Table: Tabla
+Tables: Tablas
+The icons shown above are part of %s, which is copyright %s and is distributed under %s.: Los iconos demostrados arriba son parte de %s, que es los derechos reservados %s y se distribuye debajo de %s.
+Tip: Extremidad
+Tips: Extremidades
+Warning: Advertencia
+Warnings: Advertencias

data/lang/fr.yaml

@@ -0,0 +1,33 @@
+# fr (French)
+Caution: Attention
+Cautions: Attentions
+Chapter: Chapitre
+Contents: Contenu
+Equation: Équation
+Equations: Équations
+Example: Exemple
+Examples: Exemples
+Figure: Figure
+Figures: Figures
+Generated by %s on %s.: Produit par %s sur %s.
+Important: Important
+Importants: Importants
+Jump to next segment: Sautez pour segmenter après
+Jump to previous segment: Sautez au segment précédent
+Jump to this segment: Sautez à ce segment
+Note: Notez
+Notes: Notes
+Part: Partie
+Procedure: Procédé
+Procedures: Procédures
+Reference: Référence
+References: Références
+Reverse jump to listing: Saut renversé à la liste
+Section: Section
+Table: Tableau
+Tables: Tableaux
+The icons shown above are part of %s, which is copyright %s and is distributed under %s.: Les icônes montrées ci-dessus font partie de %s, qui est copyright %s et est distribué sous %s.
+Tip: Bout
+Tips: Bouts
+Warning: Avertissement
+Warnings: Avertissements

data/lang/it.yaml

@@ -0,0 +1,33 @@
+# it (Italian)
+Caution: Attenzione
+Cautions: Avvertenze
+Chapter: Capitolo
+Contents: Soddisfare
+Equation: Equazione
+Equations: Equazioni
+Example: Esempio
+Examples: Esempi
+Figure: Figura
+Figures: Figure
+Generated by %s on %s.: Generato da %s su %s.
+Important: Importante
+Importants: Importants
+Jump to next segment: Salti dopo per suddividersi
+Jump to previous segment: Salti al segmento precedente
+Jump to this segment: Salti a questo segmento
+Note: Noti
+Notes: Note
+Part: Parte
+Procedure: Procedura
+Procedures: Procedure
+Reference: Riferimento
+References: Riferimenti
+Reverse jump to listing: Salto d'inversione all'elenco
+Section: Sezione
+Table: Tabella
+Tables: Tabelle
+The icons shown above are part of %s, which is copyright %s and is distributed under %s.: Le icone indicate sopra fa parte di %s, che è copyright %s e si distribuisce sotto %s.
+Tip: Punta
+Tips: Punte
+Warning: Avvertimento
+Warnings: Avvertimenti