doc/api/classes/String.html in erbook-4.0.0 vs doc/api/classes/String.html in erbook-5.0.0
- old
+ new
@@ -53,12 +53,12 @@
<td class="class-name-in-header">String</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
- <a href="../files/lib/erbook/html_rb.html">
- lib/erbook/html.rb
+ <a href="../files/lib/erbook/to_xhtml_rb.html">
+ lib/erbook/to_xhtml.rb
</a>
<br />
</td>
</tr>
@@ -84,14 +84,12 @@
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000004">thru_coderay</a>
- <a href="#M000003">thru_maruku</a>
- <a href="#M000002">to_html</a>
- <a href="#M000001">to_inline_html</a>
+ <a href="#M000001">to_inline_xhtml</a>
+ <a href="#M000002">to_xhtml</a>
</div>
</div>
</div>
@@ -110,11 +108,11 @@
<td class="context-item-name">PROTECTED_TAGS</td>
<td>=</td>
<td class="context-item-value">%w[tt code pre]</td>
<td width="3em"> </td>
<td class="context-item-desc">
-The content of these HTML tags will be preserved while they are being
+The content of these XHTML tags will be preserved while they are being
processed by Textile. By doing this, we avoid unwanted Textile
transformations, such as quotation marks becoming curly (&8192;), in
source code.
</td>
@@ -123,126 +121,63 @@
<td class="context-item-name">VERBATIM_TAGS</td>
<td>=</td>
<td class="context-item-value">%w[noformat]</td>
<td width="3em"> </td>
<td class="context-item-desc">
-The content of these HTML tags will be preserved <b>verbatim</b> throughout
-the text-to-HTML conversion process.
+The content of these XHTML tags will be preserved <b>verbatim</b>
+throughout the text-to-XHTML conversion process.
</td>
</tr>
</table>
</div>
</div>
- <div id="aliases-list">
- <h3 class="section-bar">External Aliases</h3>
- <div class="name-list">
- <table summary="aliases">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">to_html</td>
- <td>-></td>
- <td class="context-item-value">to_html_maruku</td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td> </td>
- <td colspan="2" class="context-item-desc">
-XXX: Maruku also defines <a href="String.html#M000002">String#to_html</a>
-so we have to hack around it :-(
-</td>
- </tr>
- </table>
- </div>
- </div>
-
-
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000004" class="method-detail">
- <a name="M000004"></a>
+ <div id="method-M000001" class="method-detail">
+ <a name="M000001"></a>
<div class="method-heading">
- <a href="String.src/M000004.html" target="Code" class="method-signature"
- onclick="popupCode('String.src/M000004.html');return false;">
- <span class="method-name">thru_coderay</span><span class="method-args">()</span>
+ <a href="String.src/M000001.html" target="Code" class="method-signature"
+ onclick="popupCode('String.src/M000001.html');return false;">
+ <span class="method-name">to_inline_xhtml</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
-Adds syntax coloring to <code> elements in the given text. If the
-<code> tag has an attribute lang="…", then that is
-considered the programming language for which appropriate syntax coloring
-should be applied. Otherwise, the programming language is assumed to be
-ruby.
+Transforms this string into an <b>inline</b> XHTML string (one that does
+not contain any block-level XHTML elements at the root).
</p>
</div>
</div>
- <div id="method-M000003" class="method-detail">
- <a name="M000003"></a>
-
- <div class="method-heading">
- <a href="String.src/M000003.html" target="Code" class="method-signature"
- onclick="popupCode('String.src/M000003.html');return false;">
- <span class="method-name">thru_maruku</span><span class="method-args">(aInline = false)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Returns the result of running this string through Maruku.
-</p>
-<p>
-If aInline is true, then the resulting HTML will <b>not</b> be wrapped in a
-HTML paragraph element.
-</p>
- </div>
- </div>
-
<div id="method-M000002" class="method-detail">
<a name="M000002"></a>
<div class="method-heading">
<a href="String.src/M000002.html" target="Code" class="method-signature"
onclick="popupCode('String.src/M000002.html');return false;">
- <span class="method-name">to_html</span><span class="method-args">(aInline = false)</span>
+ <span class="method-name">to_xhtml</span><span class="method-args">(aInline = false)</span>
</a>
</div>
<div class="method-description">
<p>
-Transforms this string into HTML while ensuring that the result contains
+Transforms this string into XHTML while ensuring that the result contains
one or more block-level elements at the root.
</p>
<p>
-If aInline is true, then the resulting HTML will be an <b>inline</b>
+If aInline is true, then the resulting XHTML will be an <b>inline</b>
string.
-</p>
- </div>
- </div>
-
- <div id="method-M000001" class="method-detail">
- <a name="M000001"></a>
-
- <div class="method-heading">
- <a href="String.src/M000001.html" target="Code" class="method-signature"
- onclick="popupCode('String.src/M000001.html');return false;">
- <span class="method-name">to_inline_html</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Transforms this string into an <b>inline</b> HTML string (one that does not
-contain any block-level HTML elements at the root).
</p>
</div>
</div>
\ No newline at end of file