erbook 5.0.0 → 6.0.0

data/lib/erbook/to_xhtml.rb

@@ -37,16 +37,23 @@ class String
   # Transforms this string into XHTML while ensuring that the
   # result contains one or more block-level elements at the root.
   #
-  # If aInline is true, then the resulting XHTML will be an *inline* string.
+  # inline:: If true, the resulting XHTML will *not*
+  #          contain a block-level element at the root.
   #
-  def to_xhtml aInline = false
-    protect(self, VERBATIM_TAGS, true) do |text|
-      html = protect(text, PROTECTED_TAGS, false) {|s| s.thru_maruku aInline }
+  def to_xhtml inline = false
+    with_protected_tags(self, VERBATIM_TAGS, true) do |text|
+      html = with_protected_tags(text, PROTECTED_TAGS, false) do
+        |s| s.thru_maruku inline
+      end
 
       # Markdown's "code spans" should really be "pre spans"
       while html.gsub! %r{(<pre>)<code>(.*?)</code>(</pre>)}m, '\1\2\3'
       end
 
+      # allow user to type <pre> blocks on single lines
+      # without affecting the display of their content
+      html.gsub! %r{(<pre>)[ \t]*\r?\n|\r?\n[ \t]*(</pre>)}, '\1\2'
+
       # ensure tables have a border: this *greatly* improves
       # readability in text-based web browsers like w3m and lynx
       html.gsub! %r/<table\b/, '\& border="1"'
@@ -58,12 +65,12 @@ class String
 
   # Returns the result of running this string through Maruku.
   #
-  # If aInline is true, then the resulting XHTML will
-  # *not* be wrapped in a XHTML paragraph element.
+  # inline:: If true, the resulting XHTML will *not*
+  #          be wrapped in a XHTML paragraph element.
   #
-  def thru_maruku aInline = false #:nodoc:
+  def thru_maruku inline = false #:nodoc:
     html = Maruku.new(self).to_html
-    html.sub! %r{\A<p>(.*)</p>\Z}, '\1' if aInline
+    html.sub! %r{\A<p>(.*)</p>\Z}, '\1' if inline
     html
   end
 
@@ -73,7 +80,7 @@ class String
   # applied.  Otherwise, the programming language is assumed to be ruby.
   def thru_coderay #:nodoc:
     gsub %r{<(code)(.*?)>(.*?)</\1>}m do
-      atts, code = $2, CGI.unescapeHTML($3)
+      atts, code = $2, CGI.unescapeHTML($3).sub(/\A\r?\n/, '')
       lang = atts[/\blang=('|")(.*?)\1/i, 2] || :ruby
 
       html = CodeRay.scan(code, lang).html(:css => :style)
@@ -89,17 +96,18 @@ class String
   # that protected input to the given block, restores the
   # given tags in the result of the block and returns it.
   #
-  # If aVerbatim is true, the content of the elments having the given tags will
-  # not be temporarily altered so that process nested elements can be processed.
+  # verbatim:: If true, the content of the elments having the
+  #            given tags will not be temporarily altered so
+  #            that process nested elements can be processed.
   #
-  def protect aInput, aTags, aVerbatim #:nodoc: :yields: aInput
+  def with_protected_tags input, tags, verbatim #:nodoc: :yields: input
     raise ArgumentError unless block_given?
 
-    input = aInput.dup
+    input = input.dup
     escapes = {}
 
     # protect the given tags by escaping them
-    aTags.each do |tag|
+    tags.each do |tag|
       input.gsub! %r{(<#{tag}.*?>)(.*?)(</#{tag}>)}m do
         head, body, tail = $1, $2, $3
 
@@ -109,13 +117,13 @@ class String
         body.gsub! %r/\\/, '\&\&'
 
         original =
-          if aVerbatim
+          if verbatim
             body
           else
             head << CGI.escapeHTML(CGI.unescapeHTML(body)) << tail
           end
 
-        escaped = ERBook.digest(original)
+        escaped = ERBook::Document.digest(original)
         escapes[escaped] = original
 
         escaped
@@ -123,7 +131,7 @@ class String
     end
 
     # invoke the given block with the protected input
-    output = yield(input)
+    output = yield input
 
     # restore the protected tags by unescaping them
     until escapes.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: erbook
 version: !ruby/object:Gem::Version 
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-22 00:00:00 -08:00
+date: 2009-01-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: trollop
+  name: inochi
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "1.10"
+        version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: maruku
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.7"
     version: 
-description: Extensible document processor based on eRuby.
+description: Extensible document processor based on eRuby
 email: sunaku@gmail.com
 executables: 
 - erbook
@@ -80,60 +80,54 @@ files:
 - fmt/text.yaml
 - lib
 - lib/erbook
+- lib/erbook/template.rb
 - lib/erbook/to_xhtml.rb
+- lib/erbook/document.rb
 - lib/erbook/rdoc.rb
 - lib/erbook.rb
 - Rakefile
 - bin
 - bin/erbook
 - LICENSE
-- README
 - doc
-- doc/manual.erb
+- doc/intro.erb
+- doc/setup.erb
 - doc/erbook.svg
 - doc/erbook.png
 - doc/HelloWorld.input
-- doc/feed-icon-28x28.png
 - doc/HelloWorld.spec
+- doc/theory.erb
 - doc/index.xhtml
 - doc/api
-- doc/api/classes
-- doc/api/classes/RDoc.html
-- doc/api/classes/String.src
-- doc/api/classes/String.src/M000001.html
-- doc/api/classes/String.src/M000002.html
-- doc/api/classes/String.html
-- doc/api/classes/ERBook.html
-- doc/api/classes/RDoc
-- doc/api/classes/RDoc/TopLevel.src
-- doc/api/classes/RDoc/TopLevel.src/M000010.html
-- doc/api/classes/RDoc/TopLevel.src/M000011.html
-- doc/api/classes/RDoc/TopLevel.src/M000008.html
-- doc/api/classes/RDoc/TopLevel.src/M000007.html
-- doc/api/classes/RDoc/TopLevel.src/M000012.html
-- doc/api/classes/RDoc/TopLevel.src/M000009.html
-- doc/api/classes/RDoc/TopLevel.html
-- doc/api/classes/RDoc/AnyMethod.src
-- doc/api/classes/RDoc/AnyMethod.src/M000005.html
-- doc/api/classes/RDoc/AnyMethod.src/M000004.html
-- doc/api/classes/RDoc/AnyMethod.src/M000003.html
-- doc/api/classes/RDoc/AnyMethod.src/M000006.html
-- doc/api/classes/RDoc/AnyMethod.html
-- doc/api/fr_method_index.html
-- doc/api/rdoc-style.css
-- doc/api/files
-- doc/api/files/lib
-- doc/api/files/lib/erbook_rb.html
-- doc/api/files/lib/erbook
-- doc/api/files/lib/erbook/rdoc_rb.html
-- doc/api/files/lib/erbook/to_xhtml_rb.html
-- doc/api/created.rid
+- doc/api/ERBook
+- doc/api/ERBook/Document.html
+- doc/api/ERBook/Document
+- doc/api/ERBook/Document/Node.html
+- doc/api/ERBook/Template.html
+- doc/api/syntax_highlight.css
+- doc/api/style.css
+- doc/api/RDoc.html
+- doc/api/jquery.js
+- doc/api/all-methods.html
+- doc/api/app.js
+- doc/api/String.html
+- doc/api/readme.html
+- doc/api/all-namespaces.html
 - doc/api/index.html
-- doc/api/fr_file_index.html
-- doc/api/fr_class_index.html
+- doc/api/ERBook.html
+- doc/api/RDoc
+- doc/api/RDoc/TopLevel.html
+- doc/api/RDoc/DummyMarkup.html
+- doc/api/RDoc/DummyOptions.html
+- doc/api/RDoc/DummyMixin.html
+- doc/api/RDoc/AnyMethod.html
+- doc/usage.erb
+- doc/history.erb
+- doc/index.erb
 - doc/README
+- doc/formats.erb
 has_rdoc: true
-homepage: http://snk.tuxfamily.org/lib/erbook
+homepage: http://snk.tuxfamily.org/lib/erbook/
 post_install_message: 
 rdoc_options: []
 
@@ -154,9 +148,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sunaku
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Extensible document processor based on eRuby.
+summary: Extensible document processor based on eRuby
 test_files: []
 

data/README

@@ -1,14 +0,0 @@
-erbook : write books and documents in eRuby
-===========================================
-
-erbook is an extensible document processor that emits XHTML
-(web page), LaTeX (PDF), man (UNIX manual page), plain text,
-and any document format you can imagine from eRuby templates
-that allow scripting and dynamic content generation.
-
-erbook is a light (210 source lines of code), extensible
-(create your own document formats), and flexible (your content
-is scriptable) alternative to DocBook, Deplate, and SiSU.
-
-Please see the ./doc/index.xhtml file in your web browser or
-visit http://snk.tuxfamily.org/lib/erbook/ for more information.

data/doc/api/classes/ERBook.html

@@ -1,164 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: ERBook</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">ERBook</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/erbook_rb.html">
-                lib/erbook.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-Project and release information.
-</p>
-
-    </div>
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
-
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">PROJECT</td>
-          <td>=</td>
-          <td class="context-item-value">'erbook'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">VERSION</td>
-          <td>=</td>
-          <td class="context-item-value">'5.0.0'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">RELEASE</td>
-          <td>=</td>
-          <td class="context-item-value">'2008-11-22'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">WEBSITE</td>
-          <td>=</td>
-          <td class="context-item-value">'http://snk.tuxfamily.org/lib/erbook'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">SUMMARY</td>
-          <td>=</td>
-          <td class="context-item-value">'Extensible document processor based on eRuby.'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">DISPLAY</td>
-          <td>=</td>
-          <td class="context-item-value">PROJECT + ' ' + VERSION</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">INSTALL_DIR</td>
-          <td>=</td>
-          <td class="context-item-value">File.expand_path File.join(File.dirname(__FILE__), '..')</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">FORMATS_DIR</td>
-          <td>=</td>
-          <td class="context-item-value">File.join INSTALL_DIR, 'fmt'</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">FORMAT_FILES</td>
-          <td>=</td>
-          <td class="context-item-value">Dir[File.join(FORMATS_DIR, '*.yaml')]</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-
-
-
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>

data/doc/api/classes/RDoc.html

@@ -1,112 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: RDoc</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">RDoc</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/erbook/rdoc_rb.html">
-                lib/erbook/rdoc.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Class <a href="RDoc/AnyMethod.html" class="link">RDoc::AnyMethod</a><br />
-Class <a href="RDoc/TopLevel.html" class="link">RDoc::TopLevel</a><br />
-
-    </div>
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>