Regenerated glyph book.
h3rald h3rald@h3rald.com
Fri, 02 Nov 2012 11:05:47 +0100
61 files changed,
962 insertions(+),
2756 deletions(-)
jump to
M
content/glyph/book/acknowledgements.html
→
content/glyph/book/acknowledgements.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Acknowledgements - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/license.html">License</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project</a></nav> + <nav class="navigation"><a href="/glyph/book/license.html">← License</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project →</a></nav> <p>Glyph was designed and developed by <a href="http://www.h3rald.com">Fabio Cevasco</a> (h3rald).</p> <p>Special thanks to the following individuals who contributed to Glyph by reporting and fixing issues, proposing and implementing new features or provided Glyph-related resources and plugins:</p> <ul>@@ -76,41 +73,21 @@ <li>Eric Givens (darthzippy)</li>
<li><a href="http://www.taylored-software.com/">Tammy Cravit</a> (tammycravit)</li> </ul> - <nav class="navigation"><a href="/glyph/book/license.html">License</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project</a></nav> + <nav class="navigation"><a href="/glyph/book/license.html">← License</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/changelog.html
→
content/glyph/book/changelog.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Changelog - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,16 +61,16 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/config/output.html">output.*</a> | <a href="/glyph/book/index.html">Contents</a> | </nav> + <nav class="navigation"><a href="/glyph/book/config/output.html">← <code>output.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | </nav> <section class="section"> -<header><h1 id="h_286">v0.5.1 – December 4th 2011</h1></header> +<header><h1 id="h_298" class="toc">v0.5.1 – December 4th 2011</h1></header> <section class="section"> -<header><h1 id="h_287">2 Bugs Fixed</h1></header> +<header><h1 id="h_299" class="toc">2 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -98,18 +95,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.5.1&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_288">v0.5.0 – August 28th 2011</h1></header> +<header><h1 id="h_300" class="toc">v0.5.0 – August 28th 2011</h1></header> <section class="section"> -<header><h1 id="h_289">16 Features Implemented</h1></header> +<header><h1 id="h_301" class="toc">16 Features Implemented</h1></header> <table> <tr> <th>ID</th>@@ -235,7 +227,7 @@ </section>
<section class="section"> -<header><h1 id="h_290">4 Bugs Fixed</h1></header> +<header><h1 id="h_302" class="toc">4 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -274,18 +266,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.5.0&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_291">v0.4.2 – October 22th 2010</h1></header> +<header><h1 id="h_303" class="toc">v0.4.2 – October 22th 2010</h1></header> <section class="section"> -<header><h1 id="h_292">3 Features Implemented</h1></header> +<header><h1 id="h_304" class="toc">3 Features Implemented</h1></header> <table> <tr> <th>ID</th>@@ -320,7 +307,7 @@ </section>
<section class="section"> -<header><h1 id="h_293">1 Bug Fixed</h1></header> +<header><h1 id="h_305" class="toc">1 Bug Fixed</h1></header> <table> <tr> <th>ID</th>@@ -338,18 +325,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.4.2&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_294">v0.4.1 – September 23th 2010</h1></header> +<header><h1 id="h_306" class="toc">v0.4.1 – September 23th 2010</h1></header> <section class="section"> -<header><h1 id="h_295">5 Bugs Fixed</h1></header> +<header><h1 id="h_307" class="toc">5 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -395,18 +377,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.4.1&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_296">v0.4.0 – September 3th 2010</h1></header> +<header><h1 id="h_308" class="toc">v0.4.0 – September 3th 2010</h1></header> <section class="section"> -<header><h1 id="h_297">13 Features Implemented</h1></header> +<header><h1 id="h_309" class="toc">13 Features Implemented</h1></header> <table> <tr> <th>ID</th>@@ -511,7 +488,7 @@ </section>
<section class="section"> -<header><h1 id="h_298">7 Bugs Fixed</h1></header> +<header><h1 id="h_310" class="toc">7 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -571,18 +548,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.4.0&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_299">v0.3.0 – June 13th 2010</h1></header> +<header><h1 id="h_311" class="toc">v0.3.0 – June 13th 2010</h1></header> <section class="section"> -<header><h1 id="h_300">13 Features Implemented</h1></header> +<header><h1 id="h_312" class="toc">13 Features Implemented</h1></header> <table> <tr> <th>ID</th>@@ -687,7 +659,7 @@ </section>
<section class="section"> -<header><h1 id="h_301">3 Bugs Fixed</h1></header> +<header><h1 id="h_313" class="toc">3 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -719,18 +691,13 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.3.0&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_302">v0.2.0 – May 9th 2010</h1></header> +<header><h1 id="h_314" class="toc">v0.2.0 – May 9th 2010</h1></header> <section class="section"> -<header><h1 id="h_303">11 Features Implemented</h1></header> +<header><h1 id="h_315" class="toc">11 Features Implemented</h1></header> <table> <tr> <th>ID</th>@@ -821,7 +788,7 @@ </section>
<section class="section"> -<header><h1 id="h_304">8 Bugs Fixed</h1></header> +<header><h1 id="h_316" class="toc">8 Bugs Fixed</h1></header> <table> <tr> <th>ID</th>@@ -888,58 +855,29 @@
</table> </section> - - - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.2.0&sort=created&state=closed">GitHub</a>.</em> -</p> </section> <section class="section"> -<header><h1 id="h_305">v0.1.0 – April 8th 2010</h1></header> +<header><h1 id="h_317" class="toc">v0.1.0 – April 8th 2010</h1></header> Initial release. - <p> -<em>→ View closed issues on <a href="https://github.com/h3rald/glyph/issues?direction=asc&labels=0.1.0&sort=created&state=closed">GitHub</a>.</em> -</p> - </section> - <nav class="navigation"><a href="/glyph/book/config/output.html">output.*</a> | <a href="/glyph/book/index.html">Contents</a> | </nav> + <nav class="navigation"><a href="/glyph/book/config/output.html">← <code>output.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | </nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/compiling/compiling.html
→
content/glyph/book/compiling/compiling.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Compiling a project - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/evaluation.html">← Simple Programming and Code Evaluation</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files →</a></nav> <p>By default, a Glyph project can be “compiled” into an <span class="caps">HTML</span> document. Additionally, Glyph can also be used to produce documents in the following formats:</p> <ul> <li>HTML5</li>@@ -73,7 +70,7 @@ <li>Web (i.e. multiple <span class="caps">HTML</span> files)</li>
<li>Web5 (i.e. multiple HTML5 files)</li> </ul> <section class="section"> -<header><h1 id="h_50">HTML/HTML5 output</h1></header> +<header><h1 id="h_50" class="toc">HTML/HTML5 output</h1></header> <p>To compile a Glyph project to an HTML document, use the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command within your Glyph project folder. Glyph parses the <code>document.glyph</code> file (and all included files and snippets); if no errors are found, Glyph creates an HTML document in the <code>/output/html</code> folder.</p> <p>The name of the HTML file can be set in the configuration (<a href="/glyph/book/config/document.html#s_document_filename"><code>document.filename</code></a> setting).</p> <p>To create an HTML5 file instead, you must specify it explicitly like this:</p>@@ -83,7 +80,7 @@ </p>
</section> <section class="section"> -<header><h1 id="h_51">PDF Output</h1></header> +<header><h1 id="h_51" class="toc">PDF Output</h1></header> <p>To generate a PDF document, you must specify <code>pdf</code> as format, like this:</p> <p> <code> glyph compile -f pdf </code>@@ -99,15 +96,11 @@ <aside class="note">
<span class="note-title">Note</span>Glyph expects PDF generators to be installed on the local machine and callable via command line using the <code>wkhtmltopdf</code> or the <code>prince</code> commands. Just install them as you would with any other program, depending on your operating system (yes, they both offer Windows installers). </aside> - <aside class="tip"> -<span class="note-title">Tip</span>Glyph's default CSS file use the free <em>Gentium</em> font for all text. You can download it from <a href="http://www.sil.org/~gaultney/gentium/">here</a>. - -</aside> </section> <section class="section"> -<header><h1 id="h_52">EPUB/MOBI output</h1></header> +<header><h1 id="h_52" class="toc">EPUB/MOBI output</h1></header> <p>To generate .epub or .mobi e-books, you must specify <code>epub</code> or <code>mobi</code> as format, like this:</p> <p> <code> glyph compile -f mobi </code>@@ -126,7 +119,7 @@
</section> <section class="section"> -<header><h1 id="web_output">Web/Web5 Output</h1></header> +<header><h1 id="web_output" class="toc">Web/Web5 Output</h1></header> <p>To generate a Web or Web5 output, specify <code>web</code> or <code>web5</code> as format. These two output formats behave different way from the others, and require that your project uses <a href="/glyph/book/text_editing/topics.html#topics">topics</a> and <a href="/glyph/book/extending/layouts.html#layouts">layouts</a>.</p> <p>Basically, here’s what happens when you compile your project in web or web5 format:</p> <ol>@@ -137,7 +130,7 @@ </ol>
</section> <section class="section"> -<header><h1 id="auto_regeneration">Auto Regeneration</h1></header> +<header><h1 id="auto_regeneration" class="toc">Auto Regeneration</h1></header> <p>You can also call the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command with a <code>--auto</code> switch. If you do so, your project will be recompiled automatically every time any source file is changed.</p> <aside class="note"> <span class="note-title">Note</span>Auto regeneration requires the <a href="http://rubygems.org/gems/directory_watcher">directory_watcher</a> gem to be installed.@@ -145,41 +138,21 @@
</aside> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/evaluation.html">← Simple Programming and Code Evaluation</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/compiling/lite_mode.html
→
content/glyph/book/compiling/lite_mode.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Compiling single Glyph files - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/compiling/compiling.html">Compiling a project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/compiling.html">← Compiling a project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically →</a></nav> <p>Glyph's primary goal is to author complex documents like books or manuals. In order to do so, a Glyph project is required to keep everything organized and automated via a set of predefined conventions, exactly like Ruby on Rails or other similar frameworks do.</p> <p>If you want to write a one-page article or a short draft, however, creating and managing Glyph projects can be an unnecessary burden. Luckily, you don't have to: you can use Glyph to compile single files containing Glyph code, by adding one parameter (or two if you want to specify a custom destination file) to the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command, like this:</p> <p>@@ -72,7 +69,7 @@ <code>glyph compile source.glyph destination.htm</code>
</p> <p>This command will process a file called <code>source.glyph</code> and produce an HTML file called <code>destination.htm</code>.</p> <section class="section"> -<header><h1 id="lite_limitations">Limitations</h1></header> +<header><h1 id="lite_limitations" class="toc">Limitations</h1></header> <p>This sort of “lite” mode comes with a few minor limitations:</p> <ul> <li>Snippets can only be defined inside the source file, using the <a href="/glyph/book/macros/macros_core.html#m_snippet_"><code>snippet:</code></a> macro.</li>@@ -84,41 +81,21 @@ <li>The files included through the <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro must be referenced with their absolute path, or a path relative to the current directory.</li>
</ul> </section> - <nav class="navigation"><a href="/glyph/book/compiling/compiling.html">Compiling a project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/compiling.html">← Compiling a project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/compiling/programmatic_usage.html
→
content/glyph/book/compiling/programmatic_usage.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Using Glyph programmatically - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/stats.html">Using the stats command</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/lite_mode.html">← Compiling single Glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/stats.html">Using the stats command →</a></nav> <p>Besides using Glyph from the command line, you can also use it straight from your code. Glyph’s public <a href="http://rubydoc.info/gems/glyph"><span class="caps">API</span></a> is simple and can be used to:</p> <ul> <li>Retrieve and update configuration settings (using <code>Glyph[]</code> and <code>Glyph[]=</code>)</li>@@ -81,7 +78,7 @@ </ul>
</aside> <section class="section"> -<header><h1 id="modes">Modes</h1></header> +<header><h1 id="modes" class="toc">Modes</h1></header> <p>It is possible to specify some flags (or "modes") to make Glyph behave slightly different than normal, as shown in the following table (by default, none of these is used).</p> <table> <tr>@@ -158,41 +155,21 @@ </tr>
</table> </section> - <nav class="navigation"><a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/stats.html">Using the stats command</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/lite_mode.html">← Compiling single Glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/stats.html">Using the stats command →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/config/document.html
→
content/glyph/book/config/document.html
@@ -1,10 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>document.* - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - + <title><code>document.*</code> - Glyph</title> <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -58,13 +55,13 @@ </header>
<article class="page glyph-book"> <header> <hgroup> - <h1>document.*</h1> + <h1><code>document.*</code></h1> <h2>Glyph</h2> </hgroup> </header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html">filters.*</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">← Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html"><code>filters.*</code> →</a></nav> The following configuration settings are related to the current Glyph document. Therefore, you should update them right after creating a project. <table>@@ -231,41 +228,21 @@ </code>
</td> </tr> </table> - <nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html">filters.*</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">← Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html"><code>filters.*</code> →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/config/filters.html
→
content/glyph/book/config/filters.html
@@ -1,10 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>filters.* - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - + <title><code>filters.*</code> - Glyph</title> <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -58,13 +55,13 @@ </header>
<article class="page glyph-book"> <header> <hgroup> - <h1>filters.*</h1> + <h1><code>filters.*</code></h1> <h2>Glyph</h2> </hgroup> </header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/config/document.html">document.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/options.html">options.*</a></nav> + <nav class="navigation"><a href="/glyph/book/config/document.html">← <code>document.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/options.html"><code>options.*</code> →</a></nav> These settings are used to configure some special options related to output filters and highlighters. <table>@@ -159,41 +156,21 @@ </code>
</td> </tr> </table> - <nav class="navigation"><a href="/glyph/book/config/document.html">document.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/options.html">options.*</a></nav> + <nav class="navigation"><a href="/glyph/book/config/document.html">← <code>document.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/options.html"><code>options.*</code> →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/config/options.html
→
content/glyph/book/config/options.html
@@ -1,10 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>options.* - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - + <title><code>options.*</code> - Glyph</title> <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -58,13 +55,13 @@ </header>
<article class="page glyph-book"> <header> <hgroup> - <h1>options.*</h1> + <h1><code>options.*</code></h1> <h2>Glyph</h2> </hgroup> </header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/config/filters.html">filters.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/output.html">output.*</a></nav> + <nav class="navigation"><a href="/glyph/book/config/filters.html">← <code>filters.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/output.html"><code>output.*</code> →</a></nav> The following configuration settings are used to enable or disable specific Glyph functionalities and behaviors. <table>@@ -170,41 +167,21 @@ </code>
</td> </tr> </table> - <nav class="navigation"><a href="/glyph/book/config/filters.html">filters.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/output.html">output.*</a></nav> + <nav class="navigation"><a href="/glyph/book/config/filters.html">← <code>filters.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/output.html"><code>output.*</code> →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/config/output.html
→
content/glyph/book/config/output.html
@@ -1,10 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>output.* - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - + <title><code>output.*</code> - Glyph</title> <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -58,13 +55,13 @@ </header>
<article class="page glyph-book"> <header> <hgroup> - <h1>output.*</h1> + <h1><code>output.*</code></h1> <h2>Glyph</h2> </hgroup> </header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/config/options.html">options.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog</a></nav> + <nav class="navigation"><a href="/glyph/book/config/options.html">← <code>options.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog →</a></nav>@@ -79,7 +76,7 @@ These settings are used to configure output-specific options.
<section class="section"> -<header><h1 id="h_278">output.epub.*</h1></header> +<header><h1 id="h_290" class="toc">output.epub.*</h1></header> <table> <tr> <th>Name</th>@@ -168,7 +165,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_279">output.mobi.*</h1></header> +<header><h1 id="h_291" class="toc">output.mobi.*</h1></header> <table> <tr> <th>Name</th>@@ -257,7 +254,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_280">output.pdf.*</h1></header> +<header><h1 id="h_292" class="toc">output.pdf.*</h1></header> <table> <tr> <th>Name</th>@@ -312,7 +309,7 @@ <p>The external program used to generate <span class="caps">PDF</span> files. It can be set to <code>prince</code> or <code>wkhtmltopdf</code>.</p>
</td> <td> <code> -"wkhtmltopdf" +"prince" </code> </td> </tr>@@ -346,7 +343,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_281">output.html.*</h1></header> +<header><h1 id="h_293" class="toc">output.html.*</h1></header> <table> <tr> <th>Name</th>@@ -409,7 +406,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_282">output.html5.*</h1></header> +<header><h1 id="h_294" class="toc">output.html5.*</h1></header> <table> <tr> <th>Name</th>@@ -472,7 +469,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_283">output.web.*</h1></header> +<header><h1 id="h_295" class="toc">output.web.*</h1></header> <table> <tr> <th>Name</th>@@ -587,7 +584,7 @@ </table>
</section> <section class="section"> -<header><h1 id="h_284">output.web5.*</h1></header> +<header><h1 id="h_296" class="toc">output.web5.*</h1></header> <table> <tr> <th>Name</th>@@ -701,41 +698,21 @@ </tr>
</table> </section> - <nav class="navigation"><a href="/glyph/book/config/options.html">options.*</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog</a></nav> + <nav class="navigation"><a href="/glyph/book/config/options.html">← <code>options.*</code></a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/bookmarks_headers.html
→
content/glyph/book/extending/bookmarks_headers.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Bookmarks and Headers - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/placeholders.html">Using Placeholders</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/params_attrs.html">← Parameters and Attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/placeholders.html">Using Placeholders →</a></nav> <p>The <a href="http://rubydoc.info/gems/glyph/Macro"><code>Glyph::Macro</code></a> class also includes a few methods to check and store bookmarks and headers. Consider for example the following source code for the <a href="/glyph/book/macros/macros_inline.html#m_anchor"><code>anchor</code></a> macro:</p> <div class="CodeRay">@@ -75,47 +72,26 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> bookmark <span class="symbol">:id</span> => param(<span class="integer">0</span>), <span class="symbol">:title</span> => param(<span class="integer">1</span>), <span class="symbol">:file</span> => <span class="instance-variable">@source_file</span>
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> <span class="instance-variable">@data</span>[<span class="symbol">:id</span>] = param <span class="integer">0</span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span> <span class="instance-variable">@data</span>[<span class="symbol">:title</span>] = param <span class="integer">1</span> <span class="line-numbers"><a href="#n7" name="n7">7</a></span> render -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span></pre></div> </div> <p>The <code>bookmark?</code> method can be used to check the existance of a particular ID within the whole document, while the <code>bookmark</code> method is used to store bookmark IDs and titles. In a similar way, you can use <code>header?</code> and <code>header</code> methods to check the existance of headers within the documents or store new ones.</p> - <nav class="navigation"><a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/placeholders.html">Using Placeholders</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/params_attrs.html">← Parameters and Attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/placeholders.html">Using Placeholders →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/command.html
→
content/glyph/book/extending/command.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Defining Custom Commands - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/output_format.html">Custom Output Formats</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/output_format.html">← Custom Output Formats</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors →</a></nav> <p>Glyph relies on <a href="http://davetron5000.github.com/gli/"><span class="caps">GLI</span></a> for defining commands. This useful library provides a high-level framework for creating command-line interface similar to <a href="http://git-scm.com/">Git</a>, its <span class="caps">DSL</span> takes care of pretty much everything, from managing command line arguments and options to providing an interactive help system.</p> <section class="section"> -<header><h1 id="h_108">Creating a 'glyph generate' command</h1></header> +<header><h1 id="h_108" class="toc">Creating a 'glyph generate' command</h1></header> <p>Consider the custom task defined in <a href="/glyph/book/extending/task.html#custom_generate_task">Creating a ‘custom:generate’ task</a>. Creating a custom command to call it is fairly straightforward.</p> <p>First of all, create a <code>lib/commands</code> folder in your project directory. Then, create a <code>.rb</code> file within it, e.g. <code>commands.rake</code>.</p> <p>Finally, here’s the source of the command:</p>@@ -82,15 +79,14 @@ <span class="line-numbers"> <a href="#n7" name="n7">7</a></span> <span class="keyword">else</span>
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> <span class="constant">Glyph</span>.run <span class="string"><span class="delimiter">'</span><span class="content">custom:generate</span><span class="delimiter">'</span></span>, args[<span class="integer">0</span>] <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> <span class="keyword">end</span> <span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> <span class="keyword">end</span> -<span class="line-numbers"><a href="#n11" name="n11">11</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n11" name="n11">11</a></span><span class="keyword">end</span></pre></div> </div> <p>That’s it. If you try to run <code>glyph help</code> within your project directory, notice that there’s a new entry for the generate command:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>$ glyph help <span class="line-numbers"> <a href="#n2" name="n2">2</a></span>===================================== -<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>Glyph v/0.5.1 +<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>Glyph v/0.6.0 <span class="line-numbers"> <a href="#n4" name="n4">4</a></span>===================================== <span class="line-numbers"> <a href="#n5" name="n5">5</a></span>usage: glyph command [options] <span class="line-numbers"> <a href="#n6" name="n6">6</a></span>@@ -106,54 +102,32 @@ <span class="line-numbers"><a href="#n15" name="n15">15</a></span> help - Shows list of commands or help for one command
<span class="line-numbers"><a href="#n16" name="n16">16</a></span> init - Create a new Glyph project <span class="line-numbers"><a href="#n17" name="n17">17</a></span> outline - Display the document outline <span class="line-numbers"><a href="#n18" name="n18">18</a></span> stats - Display statistics -<span class="line-numbers"><a href="#n19" name="n19">19</a></span> todo - Display all project TODO items -</pre></div> +<span class="line-numbers"><a href="#n19" name="n19">19</a></span> todo - Display all project TODO items</pre></div> </div> <p>You can now run the Glyph command as expected:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>$ glyph -d generate changelog <span class="line-numbers"><a href="#n2" name="n2">2</a></span>-- Generating CHANGELOG... -<span class="line-numbers"><a href="#n3" name="n3">3</a></span>-- Done. -</pre></div> +<span class="line-numbers"><a href="#n3" name="n3">3</a></span>-- Done.</pre></div> </div> </section> - <nav class="navigation"><a href="/glyph/book/extending/output_format.html">Custom Output Formats</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/output_format.html">← Custom Output Formats</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/commands_tasks.html
→
content/glyph/book/extending/commands_tasks.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Defining Custom Commands and Tasks - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,11 +61,11 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/further_reading.html">Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/further_reading.html">← Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks →</a></nav> <p>In most cases, you can extend Glyph just by creating your own <a href="/glyph/book/extending/macro_def.html#macro_def">custom macros</a>. In some cases though, you may want to further customize Glyph to fit the needs of your project, in terms of creating <a href="/glyph/book/extending/command.html#custom_command">custom commands</a> and <a href="/glyph/book/extending/task.html#custom_task">custom tasks</a>.</p> <p>Glyph’s modular architecture (and the Ruby language itself) lets you to add <em>arbitrary</em> functionality to its core, simply by creating a few Ruby files and putting them in the right places.</p> <section class="section"> -<header><h1 id="cmd_tasks_arch">How Commands and Tasks work</h1></header> +<header><h1 id="cmd_tasks_arch" class="toc">How Commands and Tasks work</h1></header> <p>Before creating custom Glyph commands and tasks, you should have a basic understanding on how they work, and which commands — or better, which tasks — are already available.</p> <p>The following diagram outlines the relationships between the default commands and some tasks:</p> <figure><img src="/glyph/book/images/glyph/commands_tasks.png" /><figcaption>Some of Glyph default commands and tasks</figcaption></figure>@@ -102,41 +99,21 @@
</aside> </section> - <nav class="navigation"><a href="/glyph/book/extending/further_reading.html">Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/further_reading.html">← Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/further_reading.html
→
content/glyph/book/extending/further_reading.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Further Reading - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/layouts.html">Layouts</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/layouts.html">← Layouts</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks →</a></nav> <p>For more examples on how to create more complex macros, have a look at the <a href="http://github.com/h3rald/glyph/tree/master/macros/">source code</a> of the existing ones.</p> <p>To gain a deeper understanding on how macros are executed, have a look at the following Glyph classes:</p> <ul>@@ -74,41 +71,21 @@ <li><a href="http://rubydoc.info/gems/glyph/Glyph/Interpreter"><code>Glyph::Interpreter</code></a></li>
<li><a href="http://rubydoc.info/gems/glyph/Glyph/Document"><code>Glyph::Document</code></a></li> <li><a href="http://rubydoc.info/gems/glyph/Glyph/Macro"><code>Glyph::Macro</code></a></li> </ul> - <nav class="navigation"><a href="/glyph/book/extending/layouts.html">Layouts</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/layouts.html">← Layouts</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/internals.html
→
content/glyph/book/extending/internals.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>A quick look at Glyph's internals - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/stats/links.html">Link Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/macro_def.html">Defining Custom Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/links.html">← Link Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/macro_def.html">Defining Custom Macros →</a></nav> <p>If you plan on extending Glyph, knowing how it works inside helps. It is not mandatory by any means, but it definitely helps, especially when creating complex macros.</p> <p>What happens behind the scenes when you call <code>glyph compile</code>? Glyph's code is parsed, analyzed and then translated into text, and here's how:</p> <figure><img src="/glyph/book/images/glyph/document_generation.png" /><figcaption>A sequence diagram for document generation</figcaption></figure>@@ -75,7 +72,7 @@ <li>The <em>Analysis Phase</em> (Processing) starts when the interpreter method calls the <code>analyze</code> method, instantiating a new <a href="http://rubydoc.info/gems/glyph/Glyph/Document"><code>Glyph::Document</code></a>. The <code>Glyph::Document</code> object evaluates the <span class="caps">AST</span> expanding all macro nodesth (that’s when macros are executed) and generates string.</li>
<li>The <em>Finalization Phase</em> (Post-Processing) starts when the interpreter calls the <code>finalyze</code> method, causing the <code>Glyph::Document</code> object to perform a series of finalizations on the string obtained after analysis, i.e. it replaces escape sequences and placeholders.</li> </ul> <section class="section"> -<header><h1 id="h_83">Example: A short note</h1></header> +<header><h1 id="h_83" class="toc">Example: A short note</h1></header> <p>As an example, consider the following Glyph code:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>fmi[something|#test]@@ -84,8 +81,7 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span>section[
<span class="line-numbers"><a href="#n4" name="n4">4</a></span> @title[Test Section] <span class="line-numbers"><a href="#n5" name="n5">5</a></span> @id[test] <span class="line-numbers"><a href="#n6" name="n6">6</a></span>... -<span class="line-numbers"><a href="#n7" name="n7">7</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span>]</pre></div> </div> <p>This simple snippet uses the <a href="/glyph/book/macros/macros_inline.html#m_fmi"><code>fmi</code></a> macro to link to a section later on in the document. When parsed, the produced AST is the following:</p>@@ -113,8 +109,7 @@ <span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> {<span class="symbol">:value</span>=><span class="string"><span class="delimiter">"</span><span class="char">\n</span><span class="delimiter">"</span></span>}
<span class="line-numbers"><a href="#n21" name="n21">21</a></span> {<span class="symbol">:name</span>=><span class="symbol">:title</span>, <span class="symbol">:escape</span>=><span class="predefined-constant">false</span>} <span class="line-numbers"><a href="#n22" name="n22">22</a></span> {<span class="symbol">:value</span>=><span class="string"><span class="delimiter">"</span><span class="content">Test Section</span><span class="delimiter">"</span></span>} <span class="line-numbers"><a href="#n23" name="n23">23</a></span> {<span class="symbol">:name</span>=><span class="symbol">:id</span>, <span class="symbol">:escape</span>=><span class="predefined-constant">false</span>} -<span class="line-numbers"><a href="#n24" name="n24">24</a></span> {<span class="symbol">:value</span>=><span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>} -</pre></div> +<span class="line-numbers"><a href="#n24" name="n24">24</a></span> {<span class="symbol">:value</span>=><span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span>}</pre></div> </div> <p>This output is produced by calling the <code>inspect</code> method on the AST. Each <a href="http://rubydoc.info/gems/glyph/Glyph/SyntaxNode"><code>Glyph::SyntaxNode</code></a> object in the tree is basically an ordinary Glyph Hash with a parent and 0 or more chidren, so the code snippets above shows how the syntax nodes are nested.</p>@@ -128,8 +123,7 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">section</span><span class="delimiter">"</span></span><span class="tag">></span>
<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="tag"><h2</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span><span class="tag">></span>Test Section<span class="tag"></h2></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span>\/[...\/] <span class="line-numbers"><a href="#n7" name="n7">7</a></span> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span></pre></div> </div> <p>This looks almost perfect, except that:</p>@@ -146,46 +140,25 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">section</span><span class="delimiter">"</span></span><span class="tag">></span>
<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="tag"><h2</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span><span class="tag">></span>Test Section<span class="tag"></h2></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span>[...] <span class="line-numbers"><a href="#n7" name="n7">7</a></span> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span></pre></div> </div> </section> - <nav class="navigation"><a href="/glyph/book/stats/links.html">Link Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/macro_def.html">Defining Custom Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/links.html">← Link Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/macro_def.html">Defining Custom Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/interpreting.html
→
content/glyph/book/extending/interpreting.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Interpreting Glyph Code - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/validators.html">Using Validators</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/layouts.html">Layouts</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/validators.html">← Using Validators</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/layouts.html">Layouts →</a></nav> <p>What if you need to evaluate some Glyph code <em>within</em> a macro? Say for example you want to transform a parameter in a link, and you want to make sure that link gets validated exactly like the others, in this case, you can use the <code>interpret</code> method, as follows:</p>@@ -75,8 +72,7 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span> link = placeholder <span class="keyword">do</span> |document|
<span class="line-numbers"><a href="#n4" name="n4">4</a></span> interpret <span class="string"><span class="delimiter">"</span><span class="content">link[</span><span class="inline"><span class="inline-delimiter">#{</span>href<span class="inline-delimiter">}</span></span><span class="content">]</span><span class="delimiter">"</span></span> <span class="line-numbers"><a href="#n5" name="n5">5</a></span> <span class="keyword">end</span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span> <span class="string"><span class="delimiter">%{</span><span class="content"><span class="fmi">for more information on </span><span class="inline"><span class="inline-delimiter">#{</span>topic<span class="inline-delimiter">}</span></span><span class="content">, see </span><span class="inline"><span class="inline-delimiter">#{</span>link<span class="inline-delimiter">}</span></span><span class="content"></span></span><span class="delimiter">}</span></span> -<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span></pre></div> </div>@@ -88,7 +84,7 @@ <li>Any macro included in the <code>String</code> is evaluated, and the resulting text is returned by the method. Note that this new document does not get finalized: in other words, placeholders will be left as they are, and they’ll eventually be replaced when <em>the main document</em> is finalized.</li>
</ol> <section class="section"> -<header><h1 id="h_93">Dispatching</h1></header> +<header><h1 id="h_93" class="toc">Dispatching</h1></header> <p><a href="/glyph/book/text_editing/macro_composition.html#composition">Macro Composition</a> can be useful to remove nesting, but you can also use it to create your own macro <em>dispatchers</em>. What is a macro dispatcher? The easies way to understand this is by looking at the source code of one of them, the <a href="/glyph/book/macros/macros_core.html#m_s"><code>s</code></a> macro:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>macro <span class="symbol">:s</span> <span class="keyword">do</span>@@ -114,8 +110,7 @@ <span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> <span class="keyword">rescue</span> <span class="constant">Exception</span> => e
<span class="line-numbers"><a href="#n21" name="n21">21</a></span> <span class="comment"># Code omittted</span> <span class="line-numbers"><a href="#n22" name="n22">22</a></span> <span class="keyword">end</span> <span class="line-numbers"><a href="#n23" name="n23">23</a></span> <span class="keyword">end</span> -<span class="line-numbers"><a href="#n24" name="n24">24</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n24" name="n24">24</a></span><span class="keyword">end</span></pre></div> </div> <p>See the <code>dispatch</code> method at the very beginning? This method takes a block with a <code>node</code> parameter, corresponding to the MacroNode of the macro which is being composed with <code>s</code>. So, for example, if you write <code>s/sub[my string|/my/|your]</code> the node of a macro called <code>sub</code> will be passed to the block. Of course there’s no <code>sub</code> macro defined in Glyph, but it doesn’t matter: its name will be interpreted as the name of a method of the Ruby String class in this case, so no worries.</p>@@ -124,7 +119,7 @@
</section> <section class="section"> -<header><h1 id="rewriting">Defining macros using Glyph</h1></header> +<header><h1 id="rewriting" class="toc">Defining macros using Glyph</h1></header> <p>While the <code>interpret</code> method is useful to evaluate Glyph code in a macro while performing other actions (storing a bookmark, checking for the presence of an anchor, etc.), in some cases it may not be necessary. If you simply want your macro to be converted into existing Glyph macro without performing any action excepting parameter substitution, you can just use the <a href="/glyph/book/macros/macros_core.html#m_define_"><code>define:</code></a> macro within your Glyph document</p> <p>Consider the following macro definition:</p> <div class="CodeRay">@@ -135,60 +130,38 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="string"><span class="content"> td[/=>[http://github.com/h3rald/glyph/issues/closed#issue/</span><span class="inline"><span class="inline-delimiter">#{</span>param[<span class="integer">0</span>]<span class="inline-delimiter">}</span></span><span class="content">|#</span><span class="inline"><span class="inline-delimiter">#{</span>param(<span class="integer">0</span>)<span class="inline-delimiter">}</span></span><span class="content">]]</span></span>
<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="string"><span class="content"> td[txt[</span><span class="inline"><span class="inline-delimiter">#{</span>param(<span class="integer">1</span>)<span class="inline-delimiter">}</span></span><span class="content">]]</span></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span><span class="string"><span class="content"> ]</span></span> <span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="string"><span class="content"> </span><span class="delimiter">}</span></span> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span></pre></div> </div> <p>The <code>issue</code> macro is only rewriting existing Glyph code around the two parameters provided. In this case, it is possible to do exactly the same thing using the <a href="/glyph/book/macros/macros_core.html#m_define_"><code>define:</code></a> macro (aliased by @def:@):</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>define:[issue| <span class="line-numbers"><a href="#n2" name="n2">2</a></span> tr[ -<span class="line-numbers"><a href="#n3" name="n3">3</a></span> td[/=<span class="error">></span>[http://github.com/h3rald/glyph/issues/closed#issue/{{0}}|#{{0}}]] +<span class="line-numbers"><a href="#n3" name="n3">3</a></span> td[/=>[http://github.com/h3rald/glyph/issues/closed#issue/{{0}}|#{{0}}]] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> td[txt[{{1}}]] <span class="line-numbers"><a href="#n5" name="n5">5</a></span> ] -<span class="line-numbers"><a href="#n6" name="n6">6</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n6" name="n6">6</a></span>]</pre></div> </div> <p>Within the <a href="/glyph/book/macros/macros_core.html#m_define_"><code>define:</code></a> macro, it is possible to use a special syntax to call the <code>raw_attr</code> or <code>raw_param</code> methods: <br /> <code>{{</code><em>parameter_number</em> or <em>attribute_name</em><code>}}</code></p> </section> - <nav class="navigation"><a href="/glyph/book/extending/validators.html">Using Validators</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/layouts.html">Layouts</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/validators.html">← Using Validators</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/layouts.html">Layouts →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/layouts.html
→
content/glyph/book/extending/layouts.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Layouts - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/further_reading.html">Further Reading</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/interpreting.html">← Interpreting Glyph Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/further_reading.html">Further Reading →</a></nav> <p>When generating <a href="/glyph/book/text_editing/topics.html#topics">topic</a>-based outputs, Glyph uses <em>layouts</em> to render topics as standalone documents. By default, the following two layout are used:</p> <ul> <li><code>topic</code> — used to render standard topics.</li>@@ -72,7 +69,7 @@ <li><code>index</code> — used to render the index page of your document.</li>
</ul> <p>Layouts are nothing more than “fancy” Glyph macros defined using the Glyph language (i.e. by using <a href="/glyph/book/extending/interpreting.html#rewriting">macro rewriting</a>) within a single <code>.glyph</code> file.</p> <section class="section"> -<header><h1 id="h_96">Topic Layout</h1></header> +<header><h1 id="h_96" class="toc">Topic Layout</h1></header> <p>The default layout used to render all web topics (the layout used for web5 topics is very similar) is defined as follows:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>document[@@ -89,8 +86,7 @@ <span class="line-numbers"><a href="#n11" name="n11">11</a></span>{{contents}}
<span class="line-numbers"><a href="#n12" name="n12">12</a></span> navigation[{{id}}] <span class="line-numbers"><a href="#n13" name="n13">13</a></span> ] <span class="line-numbers"><a href="#n14" name="n14">14</a></span> ] -<span class="line-numbers"><a href="#n15" name="n15">15</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n15" name="n15">15</a></span>]</pre></div> </div> <p>Note that it takes the following attributes, passed automatically by Glyph when processing each topic:</p>@@ -102,7 +98,7 @@ </ul>
</section> <section class="section"> -<header><h1 id="index_layout">Index Layout</h1></header> +<header><h1 id="index_layout" class="toc">Index Layout</h1></header> <p>The default layout used to render the web index page (the layout used for the web5 index is very similar) is defined as follows:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>document[@@ -120,15 +116,14 @@ <span class="line-numbers"><a href="#n12" name="n12">12</a></span> frontmatter[
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> toc[] <span class="line-numbers"><a href="#n14" name="n14">14</a></span> ] <span class="line-numbers"><a href="#n15" name="n15">15</a></span> ] -<span class="line-numbers"><a href="#n16" name="n16">16</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n16" name="n16">16</a></span>]</pre></div> </div> <p>Index layouts do not take any attribute or parameter (basically because they are used to produce only one page).</p> </section> <section class="section"> -<header><h1 id="h_98">Creating a Custom Layout</h1></header> +<header><h1 id="h_98" class="toc">Creating a Custom Layout</h1></header> <p>To create a custom layout, proceed as follows:</p> <ul> <li>Create a <code>.glyph</code> file in the <code>lib/layouts</code> directory, within your project, e.g. <code>mytopic.glyph</code></li>@@ -142,41 +137,21 @@ </aside>
</section> - <nav class="navigation"><a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/further_reading.html">Further Reading</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/interpreting.html">← Interpreting Glyph Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/further_reading.html">Further Reading →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/macro_def.html
→
content/glyph/book/extending/macro_def.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Defining Custom Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/internals.html">← A quick look at Glyph's internals</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes →</a></nav> <p>Glyph was created wih extensibility in mind. You can freely extend Glyph Language by creating or overriding macros, to do whatever you like. Macro definitions are written in pure Ruby code and placed in <code>.rb</code> files within the <code>lib/macros/</code> folder of your project.</p> <aside class="box"> <div class="box-title">Alternative Ways to Define Macros</div>@@ -81,8 +78,7 @@ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> <span class="string"><span class="delimiter">%{</span><span class="content"><div class="</span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">"><span class="note-title"></span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span>.to_s.capitalize<span class="inline-delimiter">}</span></span><span class="content"></span></span></span>
<span class="line-numbers"><a href="#n3" name="n3">3</a></span><span class="string"><span class="content"> </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@value</span><span class="inline-delimiter">}</span></span><span class="content"></span></span> <span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="string"><span class="content"></span></span> <span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="string"><span class="content"> </div></span><span class="delimiter">}</span></span> -<span class="line-numbers"><a href="#n6" name="n6">6</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n6" name="n6">6</a></span><span class="keyword">end</span></pre></div> </div> <p>The <code>macro</code> method takes a single <code>Symbol</code> or <code>String</code> parameter, corresponding to the name of the macro. In this case, the entire block (or <em>body</em> of the macro) is a <code>String</code> corresponding to what we want the macro to evaluate to: a <code><div></code> tag containing a note.</p>@@ -139,7 +135,7 @@ <td>A <code>String</code> identifying the source file of the macro.</td>
</tr> </table> <section class="section"> -<header><h1 id="h_85">Representations</h1></header> +<header><h1 id="h_85" class="toc">Representations</h1></header> <p>There’s a small problem with the code used to define the <code>note</code> macro in the previous section: what if I want to format notes using HTML5 instead of <span class="caps">HTML</span>, or another output format?</p> <p>Glyph supports different output formats, therefore macros must be format-independent! In fact, this is the actual source of the <code>note</code> macro:</p> <div class="CodeRay">@@ -147,8 +143,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>macro <span class="symbol">:note</span> <span class="keyword">do</span>
<span class="line-numbers"><a href="#n2" name="n2">2</a></span> <span class="instance-variable">@data</span>[<span class="symbol">:name</span>] = <span class="instance-variable">@name</span> <span class="line-numbers"><a href="#n3" name="n3">3</a></span> <span class="instance-variable">@data</span>[<span class="symbol">:text</span>] = value <span class="line-numbers"><a href="#n4" name="n4">4</a></span> render -<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="keyword">end</span></pre></div> </div> <p>The <span class="caps">HTML</span> representation of the note macro is defined in the <code>macros/reps/html.rb</code> file as follows:</p>@@ -159,8 +154,7 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span> <span class="string"><span class="delimiter">%{</span><span class="content"><div class="</span><span class="inline"><span class="inline-delimiter">#{</span>css_class<span class="inline-delimiter">}</span></span><span class="content">"></span></span>
<span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="string"><span class="content"><span class="note-title"></span><span class="inline"><span class="inline-delimiter">#{</span>data[<span class="symbol">:name</span>].to_s.capitalize<span class="inline-delimiter">}</span></span><span class="content"></span></span><span class="inline"><span class="inline-delimiter">#{</span>data[<span class="symbol">:text</span>]<span class="inline-delimiter">}</span></span><span class="content"></span></span> <span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="string"><span class="content"></span></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span><span class="string"><span class="content"></div></span><span class="delimiter">}</span></span> -<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span></pre></div> </div> <p>The HTML5 representation of the note macro, on the other hand, is defined in the <code>macros/reps/html5.rb</code> file as follows:</p>@@ -171,48 +165,27 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span> <span class="string"><span class="delimiter">%{</span><span class="content"><aside class="</span><span class="inline"><span class="inline-delimiter">#{</span>css_class<span class="inline-delimiter">}</span></span><span class="content">"></span></span>
<span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="string"><span class="content"><span class="note-title"></span><span class="inline"><span class="inline-delimiter">#{</span>data[<span class="symbol">:name</span>].to_s.capitalize<span class="inline-delimiter">}</span></span><span class="content"></span></span><span class="inline"><span class="inline-delimiter">#{</span>data[<span class="symbol">:text</span>]<span class="inline-delimiter">}</span></span><span class="content"></span></span> <span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="string"><span class="content"></span></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span><span class="string"><span class="content"></aside></span><span class="delimiter">}</span></span> -<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="keyword">end</span></pre></div> </div> Note the different tags used to render the note. </section> - <nav class="navigation"><a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/internals.html">← A quick look at Glyph's internals</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/params_attrs.html">Parameters and Attributes →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/output_format.html
→
content/glyph/book/extending/output_format.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Custom Output Formats - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,12 +61,12 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/task.html">Defining Custom Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/command.html">Defining Custom Commands</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/task.html">← Defining Custom Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/command.html">Defining Custom Commands →</a></nav> <p>As shown in <a href="/glyph/book/extending/commands_tasks.html#cmd_tasks_arch">How Commands and Tasks work</a>, the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command command calls specific tasks defined in the <code>generate:</code> Rake namespace to generate output files in a particular format.</p> <p>More specifically, when a <code>--format</code> option is specified, the command looks for a task with the same name within the <code>generate:</code> namespace. This makes adding new output formats to Glyph a fairly easy task, without the need to specify custom commands or similar.</p> <p>The following sections explain how the <code>h3rald</code> output format was created to integrate this book into the <a href="http://www.h3rald.com">H3RALD.com</a> website.</p> <section class="section"> -<header><h1 id="h_105">Output Configuration</h1></header> +<header><h1 id="h_105" class="toc">Output Configuration</h1></header> <p>The first step required to add a new output format to Glyph is extending Glyph’s configuration by adding the appropriate output hash, as follows:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span><span class="symbol">:output</span>:@@ -82,8 +79,7 @@ <span class="line-numbers"> <a href="#n7" name="n7">7</a></span> <span class="symbol">:macro_dirs</span>: [<span class="error">'html', 'html5']</span>
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> <span class="symbol">:layout_dirs</span>: [<span class="error">'web5']</span> <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> <span class="symbol">:layouts</span>: <span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> <span class="symbol">:topic</span>: <span class="error">bookpage</span> -<span class="line-numbers"><a href="#n11" name="n11">11</a></span> <span class="symbol">:index</span>: <span class="error">bookindex</span> -</pre></div> +<span class="line-numbers"><a href="#n11" name="n11">11</a></span> <span class="symbol">:index</span>: <span class="error">bookindex</span></pre></div> </div> <p>In particular, the following keys are mandatory:</p>@@ -98,7 +94,7 @@ </ul>
</section> <section class="section"> -<header><h1 id="h_106">Creating a 'generate:h3rald' task</h1></header> +<header><h1 id="h_106" class="toc">Creating a 'generate:h3rald' task</h1></header> <p>The next (and final) step involves creating a custom <code>h3rald</code> task within the <code>generate:</code> namespace. This task can be placed in any <code>.rake</code> file within the <code>lib/tasks</code> directory:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>namespace <span class="symbol">:generate</span> <span class="keyword">do</span>@@ -130,49 +126,28 @@ <span class="line-numbers"><a href="#n26" name="n26">26</a></span><span class="string"><span class="content"> @contents[</span><span class="inline"><span class="inline-delimiter">#{</span>file_load(<span class="constant">Glyph</span>::<span class="constant">PROJECT</span>/<span class="string"><span class="delimiter">'</span><span class="content">text/introduction.glyph</span><span class="delimiter">'</span></span>)<span class="inline-delimiter">}</span></span><span class="content">]</span></span>
<span class="line-numbers"><a href="#n27" name="n27">27</a></span><span class="string"><span class="content"> ]</span><span class="delimiter">}</span></span> <span class="line-numbers"><a href="#n28" name="n28">28</a></span> file_write dir/<span class="string"><span class="delimiter">"</span><span class="content">glyph.textile</span><span class="delimiter">"</span></span>, project <span class="line-numbers"><a href="#n29" name="n29">29</a></span> <span class="keyword">end</span> -<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span><span class="keyword">end</span></pre></div> </div> <p>In this case, this task does not actually renders files in a different format, it just moves the files generated by the @generate:web5@ task in different subdirectories.</p> <p>Additionally, it also generates the <a href="http://www.h3rald.com/glyph/">Glyph project page</a> from the book's introduction (note the usage of a raw custom layout macro).</p> </section> - <nav class="navigation"><a href="/glyph/book/extending/task.html">Defining Custom Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/command.html">Defining Custom Commands</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/task.html">← Defining Custom Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/command.html">Defining Custom Commands →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/params_attrs.html
→
content/glyph/book/extending/params_attrs.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Parameters and Attributes - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/macro_def.html">Defining Custom Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/macro_def.html">← Defining Custom Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers →</a></nav> <p>Perhaps the most common things to do in a macro definition is accessing parameters and attributes. When doing so, it is important to consider whether we want to retrieve the <em>raw value</em> of and attribute or parameter or its <em>expanded value</em>. The difference between the two will become clearer in the following sections and also in the <a href="/glyph/book/extending/interpreting.html#interpreting">Interpreting Glyph Code</a> section.</p> <section class="section"> -<header><h1 id="expanded_values">Accessing Expanded Values</h1></header> +<header><h1 id="expanded_values" class="toc">Accessing Expanded Values</h1></header> <p>Normally, you just want to get the value of an attribute or parameter and use it in the macro. This means, in other words, its <em>expanded</em> value, i.e. the value resulting from the expansion of the macros (if any) within the attribute or parameter.</p> <p>To access expanded values, use the following methods:</p> <ul>@@ -80,7 +77,7 @@ </ul>
</section> <section class="section"> -<header><h1 id="h_88">Accessing Raw Values</h1></header> +<header><h1 id="h_88" class="toc">Accessing Raw Values</h1></header> <p>While accessing expanded values is simple and immediate, in some cases it may not produce the desired results. Consider the following macro definition:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>macro <span class="symbol">:nest_section</span> <span class="keyword">do</span>@@ -91,8 +88,7 @@ <span class="line-numbers"> <a href="#n5" name="n5">5</a></span><span class="string"><span class="content"> @title[B]</span></span>
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span><span class="string"><span class="content"> </span><span class="inline"><span class="inline-delimiter">#{</span>value<span class="inline-delimiter">}</span></span><span class="content"></span></span> <span class="line-numbers"> <a href="#n7" name="n7">7</a></span><span class="string"><span class="content"> ]</span></span> <span class="line-numbers"> <a href="#n8" name="n8">8</a></span><span class="string"><span class="content"> ]</span><span class="delimiter">}</span></span> -<span class="line-numbers"> <a href="#n9" name="n9">9</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"> <a href="#n9" name="n9">9</a></span><span class="keyword">end</span></pre></div> </div> <p>And suppose to use it as follows:</p>@@ -102,8 +98,7 @@ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> section[
<span class="line-numbers"><a href="#n3" name="n3">3</a></span> <span class="instance-variable">@title</span>[<span class="constant">Inner</span> <span class="constant">Section</span>] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> ... <span class="line-numbers"><a href="#n5" name="n5">5</a></span> ] -<span class="line-numbers"><a href="#n6" name="n6">6</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n6" name="n6">6</a></span>]</pre></div> </div> <p>It produces the following HTML code:</p>@@ -117,8 +112,7 @@ <span class="line-numbers"> <a href="#n6" name="n6">6</a></span> <span class="tag"><h2</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">h_1</span><span class="delimiter">"</span></span><span class="tag">></span>Inner Section<span class="tag"></h2></span>
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span>... <span class="line-numbers"> <a href="#n8" name="n8">8</a></span> <span class="tag"></div></span> <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> <span class="tag"></div></span> -<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span><span class="tag"></div></span> -</pre></div> +<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span><span class="tag"></div></span></pre></div> </div> <p>Everything is fine <em>except</em> for the header level: the heading "Inner Section" is of level 2, but it should be level 4!</p>@@ -136,41 +130,21 @@ <li><code>raw_attribute</code> (or <code>raw_attr</code>): Returns the attribute value of the attribute specified by name.</li>
</ul> </section> - <nav class="navigation"><a href="/glyph/book/extending/macro_def.html">Defining Custom Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/macro_def.html">← Defining Custom Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/placeholders.html
→
content/glyph/book/extending/placeholders.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Using Placeholders - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/validators.html">Using Validators</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/bookmarks_headers.html">← Bookmarks and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/validators.html">Using Validators →</a></nav> <p>Sometimes you may need to access some data that will not be available until the entire document has been fully parsed and analyzed. For example, in order to be able to validate internal links, it is necessary to know in advance if the bookmark ID referenced in the link exists or not, either before (that’s easy) or even <em>after</em> the link.</p> <p>Here’s the source code of the <a href="/glyph/book/macros/macros_inline.html#m_link"><code>link</code></a> macro:</p> <div class="CodeRay">@@ -97,47 +94,26 @@ <span class="line-numbers"><a href="#n26" name="n26">26</a></span> <span class="keyword">end</span>
<span class="line-numbers"><a href="#n27" name="n27">27</a></span> <span class="keyword">else</span> <span class="line-numbers"><a href="#n28" name="n28">28</a></span> <span class="comment"># Code omitted...</span> <span class="line-numbers"><a href="#n29" name="n29">29</a></span> <span class="keyword">end</span> -<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span><span class="keyword">end</span></pre></div> </div> <p>If there’s already a bookmark stored in the current document, then it is possible to retrieve its title and use it as link text. Otherwise, it is necessary to wait until the entire document has been fully processed and then check if the bookmark exists. To do so, use the <code>placeholder</code> method. When called, this method returns an unique placeholder, which is then substituted with the value of the block, right before the document is finalized.</p> <p>Within the <code>placeholder</code> block, the <code>document</code> parameter is, by all means, the fully analyzed document.</p> - <nav class="navigation"><a href="/glyph/book/extending/bookmarks_headers.html">Bookmarks and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/validators.html">Using Validators</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/bookmarks_headers.html">← Bookmarks and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/validators.html">Using Validators →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/task.html
→
content/glyph/book/extending/task.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Defining Custom Tasks - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,11 +61,11 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/output_format.html">Custom Output Formats</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/commands_tasks.html">← Defining Custom Commands and Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/output_format.html">Custom Output Formats →</a></nav> <p>Glyph relies on <a href="http://rake.rubyforge.org/">Rake</a> to perform most of its core operations. Typically, Rake tasks are used do define the high level logic that is used by Glyph commands to, for example, compile a project or load configuration files.</p> <p>Furthermore, Rake provides an easy mechanism to create dependencies among tasks: for example, to make sure that Glyph’s configuration files are loaded before everything else happens.</p> <section class="section"> -<header><h1 id="custom_generate_task">Creating a 'custom:generate' task</h1></header> +<header><h1 id="custom_generate_task" class="toc">Creating a 'custom:generate' task</h1></header> <p>A custom task has been defined for the Glyph project used to produce this document. This custom task is used to compile a few of the documents files into standalone files, deployed in Glyph’s root folder:</p> <ul> <li><code>book/text/introduction.glyph</code> → <code>README.textile</code></li>@@ -98,49 +95,28 @@ <span class="line-numbers"><a href="#n16" name="n16">16</a></span> <span class="keyword">unless</span> files.keys.include? arg
<span class="line-numbers"><a href="#n17" name="n17">17</a></span> generate.call files[arg], arg <span class="line-numbers"><a href="#n18" name="n18">18</a></span> <span class="constant">Glyph</span>.info <span class="string"><span class="delimiter">"</span><span class="content">Done.</span><span class="delimiter">"</span></span> <span class="line-numbers"><a href="#n19" name="n19">19</a></span> <span class="keyword">end</span> -<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span><span class="keyword">end</span></pre></div> </div> <p>That’s it. Note that this task is pretty useless without a command that calls it, and it won’t even show up if you run <code>rake -T</code> within your project directory. <span class="fmi">for more information on <mark>creating custom commands</mark>, see <a href="/glyph/book/extending/command.html#custom_command">Defining Custom Commands</a></span>.</p> </section> - <nav class="navigation"><a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/output_format.html">Custom Output Formats</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/commands_tasks.html">← Defining Custom Commands and Tasks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/output_format.html">Custom Output Formats →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/extending/validators.html
→
content/glyph/book/extending/validators.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Using Validators - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/placeholders.html">Using Placeholders</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/placeholders.html">← Using Placeholders</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code →</a></nav> <p>If you need to make sure that a macro is used properly, consider using <a href="http://rubydoc.info/gems/glyph/Glyph/Macro/Validators">validators</a>. These methods can be used anywhere within the macro code to check whether certain conditions are met or not. Some default validators are provided to check the number of parameters of a macro, and they are actually used in some system macros.</p> <p>If you want to create your own validators, you can call the generic <code>validate</code> method which takes the message to display in case of error, a Hash of options and a block containing the validation to perform.</p> <aside class="box">@@ -79,41 +76,21 @@ <p>Even if you consider all the possibilities within the scope of the default macros provided with Glyph, this could still make the <code>box</code> macro unusable within custom macros.</p>
<p>For the specific cases where a macro does not make sense unless is within another (e.g. the <a href="/glyph/book/macros/macros_core.html#m_eq"><code>eq</code></a> macro), a <code>within</code> validator is used. Note though, that this validator only checks that the macro is used within another, but it is not necessarily its child.</p> </aside> - <nav class="navigation"><a href="/glyph/book/extending/placeholders.html">Using Placeholders</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/placeholders.html">← Using Placeholders</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/interpreting.html">Interpreting Glyph Code →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/getting_started/configuration.html
→
content/glyph/book/getting_started/configuration.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Project Configuration - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/getting_started/structure.html">Document Structure</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/glyph_files.html">.glyph files</a></nav> + <nav class="navigation"><a href="/glyph/book/getting_started/structure.html">← Document Structure</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/glyph_files.html"><code>.glyph</code> files →</a></nav> <p>Glyph stores configuration settings in the following <span class="caps">YAML</span> files:</p> <ol>@@ -102,42 +99,22 @@ </ul>
<p>Note that this guessing is far from being foolproof: If you type something like <em>{:test, 2}</em>, for example, you’ll get an error.</p> </aside> <p>There are plenty of configuration settings that can be modified, but most of them are best if left alone (and in the System Configuration file).</p> -<p>For a complete reference, see <a href="/glyph/book/document.html#cfg_ref">Configuration Reference</a>. For everyday use, you may just want to change the settings defined in the <a href="/glyph/book/config/document.html#cfg_document">document.*</a> namespace.</p> - <nav class="navigation"><a href="/glyph/book/getting_started/structure.html">Document Structure</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/glyph_files.html">.glyph files</a></nav> +<p>For a complete reference, see <a href="/glyph/book/document.html#cfg_ref">Configuration Reference</a>. For everyday use, you may just want to change the settings defined in the <a href="/glyph/book/config/document.html#cfg_document"><code>document.*</code></a> namespace.</p> + <nav class="navigation"><a href="/glyph/book/getting_started/structure.html">← Document Structure</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/glyph_files.html"><code>.glyph</code> files →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/getting_started/create_project.html
→
content/glyph/book/getting_started/create_project.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Creating your first Glyph Project - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/acknowledgements.html">Acknowledgements</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/structure.html">Document Structure</a></nav> + <nav class="navigation"><a href="/glyph/book/acknowledgements.html">← Acknowledgements</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/structure.html">Document Structure →</a></nav> <p>To install Glyph, simply run <code>gem install glyph</code>, like with any other Ruby gem. Then, create a new directory and initialize a new Glyph project, like so:</p> <p><code>mkdir</code> <em>test_document</em></p> <p><code>cd</code> <em>test_document</em></p>@@ -100,41 +97,21 @@ <ul>
<li><code>config.yml</code> — containing your <a href="/glyph/book/getting_started/configuration.html#cfg">Project Configuration</a>.</li> <li><code>document.glyph</code> — containing the <a href="/glyph/book/getting_started/structure.html#struct">structure</a> of your document.</li> </ul> - <nav class="navigation"><a href="/glyph/book/acknowledgements.html">Acknowledgements</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/structure.html">Document Structure</a></nav> + <nav class="navigation"><a href="/glyph/book/acknowledgements.html">← Acknowledgements</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/structure.html">Document Structure →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/getting_started/structure.html
→
content/glyph/book/getting_started/structure.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Document Structure - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/configuration.html">Project Configuration</a></nav> + <nav class="navigation"><a href="/glyph/book/getting_started/create_project.html">← Creating your first Glyph Project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/configuration.html">Project Configuration →</a></nav> <p>Every Glyph project contains a <code>document.glyph</code> file that is typically used to define the document structure. The default <code>document.glyph</code> generated automatically when creating a new project is the following:</p>@@ -97,8 +94,7 @@ <span class="line-numbers"><a href="#n25" name="n25">25</a></span> todo[Write appendix A]
<span class="line-numbers"><a href="#n26" name="n26">26</a></span> include[appendix_a] <span class="line-numbers"><a href="#n27" name="n27">27</a></span> ] <span class="line-numbers"><a href="#n28" name="n28">28</a></span> ] -<span class="line-numbers"><a href="#n29" name="n29">29</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n29" name="n29">29</a></span>]</pre></div> </div>@@ -117,41 +113,21 @@ <li>The <a href="/glyph/book/macros/macros_structure.html#m_book"><code>book</code></a> macro wraps every other macro and is used to create the document header and default title page.</li>
<li>Then, the <code>@frontmatter</code>, <code>@bodymatter</code>, and <code>@backmatter</code> attributes are used to divide the portions of your document according to the rules of <a href="http://en.wikipedia.org/wiki/Book_design">book design</a>. They are not mandatory, but they can be used, for example, to number your appendixes with letters instead of numbers and similar.</li> <li><code>preface</code>, <code>chapter</code>, <code>appendix</code> are just a way to wrap content in <code><div></code> tags, from an <span class="caps">HTML</span> point of view (or <code><section></code> tags, in HTML5), but they are also necessary to nest the content of your document and generate the Table of Contents automatically, together through <code>@title</code> attributes.</li> </ul> - <nav class="navigation"><a href="/glyph/book/getting_started/create_project.html">Creating your first Glyph Project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/configuration.html">Project Configuration</a></nav> + <nav class="navigation"><a href="/glyph/book/getting_started/create_project.html">← Creating your first Glyph Project</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/getting_started/configuration.html">Project Configuration →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/index.html
→
content/glyph/book/index.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Glyph - Document Authoring Framework</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -68,12 +65,11 @@ <section id="body-text" class="hyphenate glyph-index">
<nav class="contents"> <h1 class="toc-header" id="toc">Table of Contents</h1> <ol class="toc"> - <li class="frontmatter introduction"><a href="/glyph/book/introduction.html#h_1">Introduction</a></li><li><ol><li class="frontmatter section"><a href="/glyph/book/license.html#h_12">License</a></li></ol></li> + <li class="frontmatter introduction"><a href="/glyph/book/introduction.html#h_1">Introduction</a></li><li><ol><li class="frontmatter section"><a href="/glyph/book/license.html#h_12">License</a></li><li class="frontmatter section">Resources</li></ol></li> <li class="frontmatter acknowledgement"><a href="/glyph/book/acknowledgements.html#h_13">Acknowledgements</a></li><li class="bodymatter chapter">Getting Started</li><li><ol><li class="bodymatter section"><a href="/glyph/book/getting_started/create_project.html#h_15">Creating your first Glyph Project</a></li><li class="bodymatter section"><a href="/glyph/book/getting_started/structure.html#struct">Document Structure</a></li><li class="bodymatter section"><a href="/glyph/book/getting_started/configuration.html#cfg">Project Configuration</a></li></ol></li> -<li class="bodymatter chapter">Authoring Documents</li><li><ol><li class="bodymatter section"><a href="/glyph/book/text_editing/glyph_files.html#h_19">.glyph files</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/macro_intro.html#macro_intro">Introducing Glyph Macros</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/attribute_intro.html#attribute_intro">Macro attributes</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/macro_composition.html#composition">Macro Composition</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/esc_quot.html#esc_quot">Escaping and Quoting</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/sections.html#sec_head">Sections and Headers</a></li><li><ol><li class="bodymatter section"><a href="/glyph/book/text_editing/section_aliases.html#h_26">Section Aliases</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/topics.html#topics">Topics</a></li></ol></li> +<li class="bodymatter chapter">Authoring Documents</li><li><ol><li class="bodymatter section"><a href="/glyph/book/text_editing/glyph_files.html#h_19"><code>.glyph</code> files</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/macro_intro.html#macro_intro">Introducing Glyph Macros</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/attribute_intro.html#attribute_intro">Macro attributes</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/macro_composition.html#composition">Macro Composition</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/esc_quot.html#esc_quot">Escaping and Quoting</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/sections.html#sec_head">Sections and Headers</a></li><li><ol><li class="bodymatter section"><a href="/glyph/book/text_editing/section_aliases.html#h_26">Section Aliases</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/topics.html#topics">Topics</a></li></ol></li> <li class="bodymatter section"><a href="/glyph/book/text_editing/links.html#links">Links and Bookmarks</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/images.html#img_fig">Images and Figures</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/code.html#source_code">Source Code</a></li><li class="bodymatter section">Other HTML Elements</li><li><ol><li class="bodymatter section"><a href="/glyph/book/text_editing/raw_html.html#h_32">Textile or Markdown</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/xml_fallback.html#h_33">XML Fallback</a></li></ol></li> -<li class="bodymatter section"><a href="/glyph/book/text_editing/stylesheets.html#stylesheets">Adding Stylesheets</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/inclusions.html#incl">Content Reuse</a></li><li><ol><li class="bodymatter section">Remarks</li></ol></li> -<li class="bodymatter section"><a href="/glyph/book/text_editing/conditionals.html#cond_macros">Conditional Macros</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/evaluation.html#h_43">Simple Programming and Code Evaluation</a></li><li><ol><li class="bodymatter section">Turing-completeness</li><li class="bodymatter section">Operations on integer values</li><li class="bodymatter section">Lexically-scoped attribute assignment</li><li class="bodymatter section">Evaluating Ruby code</li></ol></li> +<li class="bodymatter section"><a href="/glyph/book/text_editing/stylesheets.html#stylesheets">Adding Stylesheets</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/inclusions.html#incl">Content Reuse</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/conditionals.html#cond_macros">Conditional Macros</a></li><li class="bodymatter section"><a href="/glyph/book/text_editing/evaluation.html#h_43">Simple Programming and Code Evaluation</a></li><li><ol><li class="bodymatter section">Turing-completeness</li><li class="bodymatter section">Lexically-scoped attribute assignment</li><li class="bodymatter section">Evaluating Ruby code</li></ol></li> </ol></li> <li class="bodymatter chapter">Generating Output Files</li><li><ol><li class="bodymatter section"><a href="/glyph/book/compiling/compiling.html#compile">Compiling a project</a></li><li class="bodymatter section"><a href="/glyph/book/compiling/lite_mode.html#lite_mode">Compiling single Glyph files</a></li><li class="bodymatter section"><a href="/glyph/book/compiling/programmatic_usage.html#h_57">Using Glyph programmatically</a></li></ol></li> <li class="bodymatter chapter">Document Statistics</li><li><ol><li class="bodymatter section"><a href="/glyph/book/stats/stats.html#h_60">Using the stats command</a></li><li class="bodymatter section"><a href="/glyph/book/stats/macros.html#stats_macros">Macro Statistics</a></li><li class="bodymatter section"><a href="/glyph/book/stats/snippets.html#stats_snippets">Snippet Statistics</a></li><li class="bodymatter section"><a href="/glyph/book/stats/bookmarks.html#stats_bookmarks">Bookmark Statistics</a></li><li class="bodymatter section"><a href="/glyph/book/stats/links.html#stats_links">Link Statistics</a></li></ol></li>@@ -81,40 +77,20 @@ <li class="bodymatter chapter">Extending Glyph</li><li><ol><li class="bodymatter section"><a href="/glyph/book/extending/internals.html#h_82">A quick look at Glyph's internals</a></li><li class="bodymatter section"><a href="/glyph/book/extending/macro_def.html#macro_def">Defining Custom Macros</a></li><li><ol><li class="bodymatter section"><a href="/glyph/book/extending/params_attrs.html#h_86">Parameters and Attributes</a></li><li class="bodymatter section"><a href="/glyph/book/extending/bookmarks_headers.html#h_89">Bookmarks and Headers</a></li><li class="bodymatter section"><a href="/glyph/book/extending/placeholders.html#h_90">Using Placeholders</a></li><li class="bodymatter section"><a href="/glyph/book/extending/validators.html#h_91">Using Validators</a></li><li class="bodymatter section"><a href="/glyph/book/extending/interpreting.html#interpreting">Interpreting Glyph Code</a></li><li class="bodymatter section"><a href="/glyph/book/extending/layouts.html#layouts">Layouts</a></li><li class="bodymatter section"><a href="/glyph/book/extending/further_reading.html#h_99">Further Reading</a></li></ol></li>
<li class="bodymatter section"><a href="/glyph/book/extending/commands_tasks.html#h_100">Defining Custom Commands and Tasks</a></li><li><ol><li class="bodymatter section"><a href="/glyph/book/extending/task.html#custom_task">Defining Custom Tasks</a></li><li class="bodymatter section"><a href="/glyph/book/extending/command.html#custom_command">Defining Custom Commands</a></li></ol></li> </ol></li> <li class="bodymatter chapter">Troubleshooting</li><li><ol><li class="bodymatter section"><a href="/glyph/book/troubleshooting/errors_generic.html#h_110">Generic Errors</a></li><li class="bodymatter section"><a href="/glyph/book/troubleshooting/errors_parser.html#h_111">Parsing Errors</a></li><li class="bodymatter section"><a href="/glyph/book/troubleshooting/errors_command.html#h_112">Command Errors</a></li><li class="bodymatter section"><a href="/glyph/book/troubleshooting/errors_macro.html#h_113">Macro Errors</a></li></ol></li> -<li class="backmatter appendix"><a href="/glyph/book/ref_commands.html#cmd_ref">Command Reference</a></li><li class="backmatter appendix">Macro Reference</li><li><ol><li class="appendix section"><a href="/glyph/book/macros/macros_core.html#h_135">Core Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_block.html#h_211">Block Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_inline.html#h_232">Inline Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_filters.html#f_macros">Filter Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_structure.html#h_255">Structure Macros</a></li></ol></li> -<li class="backmatter appendix">Configuration Reference</li><li><ol><li class="appendix section"><a href="/glyph/book/config/document.html#cfg_document">document.*</a></li><li class="appendix section"><a href="/glyph/book/config/filters.html#cfg_filters">filters.*</a></li><li class="appendix section"><a href="/glyph/book/config/options.html#cfg_options">options.*</a></li><li class="appendix section"><a href="/glyph/book/config/output.html#cfg_output">output.*</a></li></ol></li> -<li class="backmatter appendix"><a href="/glyph/book/changelog.html#h_285">Changelog</a></li> +<li class="backmatter appendix"><a href="/glyph/book/ref_commands.html#cmd_ref">Command Reference</a></li><li class="backmatter appendix">Macro Reference</li><li><ol><li class="appendix section"><a href="/glyph/book/macros/macros_core.html#h_139">Core Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_block.html#h_215">Block Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_inline.html#h_240">Inline Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_filters.html#f_macros">Filter Macros</a></li><li class="appendix section"><a href="/glyph/book/macros/macros_structure.html#h_266">Structure Macros</a></li></ol></li> +<li class="backmatter appendix">Configuration Reference</li><li><ol><li class="appendix section"><a href="/glyph/book/config/document.html#cfg_document"><code>document.*</code></a></li><li class="appendix section"><a href="/glyph/book/config/filters.html#cfg_filters"><code>filters.*</code></a></li><li class="appendix section"><a href="/glyph/book/config/options.html#cfg_options"><code>options.*</code></a></li><li class="appendix section"><a href="/glyph/book/config/output.html#cfg_output"><code>output.*</code></a></li></ol></li> +<li class="backmatter appendix"><a href="/glyph/book/changelog.html#h_297">Changelog</a></li> </ol> </nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a>
M
content/glyph/book/introduction.html
→
content/glyph/book/introduction.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Introduction - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,13 +61,15 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/license.html">License</a></nav> - <p>Glyph is a <em>Rapid Document Authoring Framework</em>.</p> + <nav class="navigation"> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/license.html">License →</a></nav> + <section class="section"> +<p>Glyph is a <em>Rapid Document Authoring Framework</em>.</p> <p>With Glyph, creating and maintaining any kind of document becomes as easy as… <em>programming</em>. Glyph enables you to minimize text duplication, focus on content rather than presentation, manage references seamlessly and automate tedious tasks through a simple but effective macro language, specifically geared towards customization and extensibility.</p> -<section class="section"> -<header><h1 id="h_2">Main Features</h1></header> + + <section class="section"> +<header><h1 id="h_2" class="toc">Main Features</h1></header> <section class="section"> -<header><h1 id="h_3">Command Line Interface</h1></header> +<header><h1 id="h_3" class="toc">Command Line Interface</h1></header> <p>Glyph is 100% command line. Its interface resambles <a href="http://git-scm.com/">Git’s</a> for its simplicity and power (thanks to the <a href="http://github.com/davetron5000/gli">gli</a> gem). Here are some example commands:</p> <ul> <li><code>glyph init</code> — to initialize a new Glyph project in the current (empty) directory.</li>@@ -82,119 +81,118 @@ <li><code>glyph compile readme.glyph</code> — to compile a <em>readme.glyph</em> located in the current directory into a single <span class="caps">HTML</span> file.</li>
<li><code>glyph outline -l 2</code> — Display the document outline, up to second-level headers.</li> <li><code>glyph stats</code> — Display project statistics.</li> </ul> + </section> -<section class="section"> -<header><h1 id="h_4">Minimalist Syntax</h1></header> + + <section class="section"> +<header><h1 id="h_4" class="toc">Minimalist Syntax</h1></header> <p>Glyph syntax rules can be explained using Glyph itself:</p> -<div class="code"> -<pre> -<code> -section[ - @title[Something about Glyph] - txt[ -You can use Glyph macros in conjunction -with _Textile_ or _Markdown_ to -produce HTML files effortlessly. - ] - p[Alternatively, you can just use em[Glyph itself] to generate HTML tags.] - section[ - @title[What about PDFs?] - @id[pdf] - p[ -Once you have a single, well-formatted HTML -file, converting it to PDF is -extremely easy with a free 3rd-party -renderer like =>[http://www.princexml.com|Prince] -or =>[http://code.google.com/p/wkhtmltopdf/|wkhtmltopdf]. - ] - ] -] -</code> -</pre> + + <div class="CodeRay"> + <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>section[ +<span class="line-numbers"> <a href="#n2" name="n2">2</a></span> @title[Something about Glyph] +<span class="line-numbers"> <a href="#n3" name="n3">3</a></span> txt[ +<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>You can use Glyph macros in conjunction +<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>with _Textile_ or _Markdown_ to +<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>produce HTML files effortlessly. +<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> ] +<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> p[Alternatively, you can just use em[Glyph itself] to generate HTML tags.] +<span class="line-numbers"> <a href="#n9" name="n9">9</a></span> section[ +<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> @title[What about PDFs?] +<span class="line-numbers"><a href="#n11" name="n11">11</a></span> @id[pdf] +<span class="line-numbers"><a href="#n12" name="n12">12</a></span> p[ +<span class="line-numbers"><a href="#n13" name="n13">13</a></span>Once you have a single, well-formatted HTML +<span class="line-numbers"><a href="#n14" name="n14">14</a></span>file, converting it to PDF is +<span class="line-numbers"><a href="#n15" name="n15">15</a></span>extremely easy with a free 3rd-party +<span class="line-numbers"><a href="#n16" name="n16">16</a></span>renderer like =>[http://www.princexml.com|Prince] +<span class="line-numbers"><a href="#n17" name="n17">17</a></span>or =>[http://code.google.com/p/wkhtmltopdf/|wkhtmltopdf]. +<span class="line-numbers"><a href="#n18" name="n18">18</a></span> ] +<span class="line-numbers"><a href="#n19" name="n19">19</a></span> ] +<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span>]</pre></div> </div> -<p>The Glyph code above corresponds to the following <span class="caps">HTML</span> code:</p> -<div class="code"> -<pre> -<code> -<div class="section"> - <h2 id="h_10">Something about Glyph</h2> - <p> - You can use Glyph macros in conjunction with - <em>Textile</em> or <em>Markdown</em> to - produce HTML files effortlessly. - </p> - <p> - Alternatively, you can just use <em>Glyph itself</em> - to generate HTML tags. - </p> - <div class="section"> - <h3 id="pdf">What about PDFs?</h3> - <p> - Once you have a single, well-formatted HTML - file, converting it to PDF is - extremely easy with a free 3rd-party renderer - like <a href="http://www.princexml.com">Prince</a> - or <a href="http://code.google.com/p/wkhtmltopdf/\">wkhtmltopdf</a>. - </p> - </div> -</div> -</code> -</pre> + +<p>The Glyph code above corresponds to the following HTML code:</p> + <div class="CodeRay"> + <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span><span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">section</span><span class="delimiter">"</span></span><span class="tag">></span> +<span class="line-numbers"> <a href="#n2" name="n2">2</a></span> <span class="tag"><h2</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">h_10</span><span class="delimiter">"</span></span><span class="tag">></span>Something about Glyph<span class="tag"></h2></span> +<span class="line-numbers"> <a href="#n3" name="n3">3</a></span> <span class="tag"><p></span> +<span class="line-numbers"> <a href="#n4" name="n4">4</a></span> You can use Glyph macros in conjunction with +<span class="line-numbers"> <a href="#n5" name="n5">5</a></span> <span class="tag"><em></span>Textile<span class="tag"></em></span> or <span class="tag"><em></span>Markdown<span class="tag"></em></span> to +<span class="line-numbers"> <a href="#n6" name="n6">6</a></span> produce HTML files effortlessly. +<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> <span class="tag"></p></span> +<span class="line-numbers"> <a href="#n8" name="n8">8</a></span> <span class="tag"><p></span> +<span class="line-numbers"> <a href="#n9" name="n9">9</a></span> Alternatively, you can just use <span class="tag"><em></span>Glyph itself<span class="tag"></em></span> +<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> to generate HTML tags. +<span class="line-numbers"><a href="#n11" name="n11">11</a></span> <span class="tag"></p></span> +<span class="line-numbers"><a href="#n12" name="n12">12</a></span> <span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">section</span><span class="delimiter">"</span></span><span class="tag">></span> +<span class="line-numbers"><a href="#n13" name="n13">13</a></span> <span class="tag"><h3</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">pdf</span><span class="delimiter">"</span></span><span class="tag">></span>What about PDFs?<span class="tag"></h3></span> +<span class="line-numbers"><a href="#n14" name="n14">14</a></span> <span class="tag"><p></span> +<span class="line-numbers"><a href="#n15" name="n15">15</a></span> Once you have a single, well-formatted HTML +<span class="line-numbers"><a href="#n16" name="n16">16</a></span> file, converting it to PDF is +<span class="line-numbers"><a href="#n17" name="n17">17</a></span> extremely easy with a free 3rd-party renderer +<span class="line-numbers"><a href="#n18" name="n18">18</a></span> like <span class="tag"><a</span> <span class="attribute-name">href</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://www.princexml.com</span><span class="delimiter">"</span></span><span class="tag">></span>Prince<span class="tag"></a></span> +<span class="line-numbers"><a href="#n19" name="n19">19</a></span> or <span class="tag"><a</span> <span class="attribute-name">href</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://code.google.com/p/wkhtmltopdf/</span><span class="delimiter">"</span></span><span class="tag">></span>wkhtmltopdf<span class="tag"></a></span>. +<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> <span class="tag"></p></span> +<span class="line-numbers"><a href="#n21" name="n21">21</a></span> <span class="tag"></div></span> +<span class="line-numbers"><a href="#n22" name="n22">22</a></span><span class="tag"></div></span></pre></div> </div> + </section> -<section class="section"> -<header><h1 id="h_5">Content Reuse</h1></header> + + <section class="section"> +<header><h1 id="h_5" class="toc">Content Reuse</h1></header> <p>Finding yourself repeating the same sentence over an over? Glyph allows you to create snippets. Within snippets. Within other snippets (and so on, for a long long time…) as long as you don’t define a snippet by defining itself, which would be kinda nasty (and Glyph would complain!):</p> -<div class="code"> -<pre> -<code> -snippet:[entities|snippets and macros] -snippet:[custom_definitions| - p[Glyph allows you to define your own &[entities].] -] -&[custom_definitions] -</code> -</pre> + <div class="CodeRay"> + <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>snippet:[entities|snippets and macros] +<span class="line-numbers"><a href="#n2" name="n2">2</a></span>snippet:[custom_definitions| +<span class="line-numbers"><a href="#n3" name="n3">3</a></span> p[Glyph allows you to define your own &[entities].] +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>&[custom_definitions]</pre></div> </div> -<p>…which results in:</p> -<div class="code"> -<pre> -<code> -<p>Glyph allows you to define your own snippets and macros.</p> -</code> -</pre> + + <p>...which results in:</p> + <div class="CodeRay"> + <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span><span class="tag"><p></span>Glyph allows you to define your own snippets and macros.<span class="tag"></p></span></pre></div> </div> -<p>If yourself dreaming about <em>parametric</em> snippets, just create your own macros (see the <a href="http://github.com/h3rald/glyph/blob/master/book/text/changelog.glyph">source</a> of Glyph’s changelog, just to have an idea).</p> + + <p>If yourself dreaming about <em>parametric</em> snippets, just create your own macros (see the <a href="http://github.com/h3rald/glyph/blob/master/book/text/changelog.glyph">source</a> of Glyph’s changelog, just to have an idea).</p> + </section> -<section class="section"> -<header><h1 id="h_6">Automation of Common Tasks</h1></header> + <section class="section"> +<header><h1 id="h_6" class="toc">Automation of Common Tasks</h1></header> <p>If you’re writing a book, you shouldn’t have to worry about pagination, headers, footers, table of contents, section numbering or similar. Glyph understands you, and will take care of everything for you (with a little help from CSS3, sometimes).</p> + </section> -<section class="section"> -<header><h1 id="h_7">Reference Validation</h1></header> + <section class="section"> +<header><h1 id="h_7" class="toc">Reference Validation</h1></header> <p>Feel free to add plenty of links, snippets, bookmarks, … if Glyph doesn’t find something, it will definitely complain. Broken references are a thing on the past, and you don’t need to worry about it.</p> + </section> -<section class="section"> -<header><h1 id="h_8">Extreme Extensibility</h1></header> + <section class="section"> +<header><h1 id="h_8" class="toc">Extreme Extensibility</h1></header> <ul> <li>You miss a <code>!!!</code> macro to format really, <em>really</em> important things? Create it. In under 3 seconds, in Ruby or Glyph itself. And yes, you can use special characters, too.</li> <li>You want your own, very special special <code>glyph create --everything</code> command to create all <em>you</em> need in a Glyph project? You can do it. Using your own Rake tasks, too.</li> <li>You want Glyph to output <span class="caps">ODF</span> files? You can do it, and you’ll be able to run <code>glyph generate -f odf</code>. This would probably require a little more time, but it’s trivial, from a technical point of view.</li> </ul> + </section> -<section class="section"> -<header><h1 id="h_9">Convention over Configuration</h1></header> + <section class="section"> +<header><h1 id="h_9" class="toc">Convention over Configuration</h1></header> <p>Put your text files in <code>/text</code>, your images in <code>/images</code>, add custom macros in a <code>macro</code> folder within your <code>/lib</code> folder… you get the picture: Glyph has its special places.</p> <p>Nonetheless, you also have 1 (<em>one</em>) configuration file to customize to your heart’s content (with smart defaults).</p> -</section> -<section class="section"> -<header><h1 id="h_10">Free and Open Source</h1></header> + +</section> + <section class="section"> +<header><h1 id="h_10" class="toc">Free and Open Source</h1></header> <p>Glyph is 100% Open Source Software, developed using the Ruby Programming Language and licensed under the very permissive terms of the <a href="http://www.opensource.org/licenses/mit-license.php"><span class="caps">MIT</span> License</a>.</p> <p>If you have Ruby installed, just run <code>gem install glyph</code>. That’s all it takes.</p> + </section> + </section> -<section class="section"> -<header><h1 id="h_11">Resources</h1></header> + <section class="section"> +<header><h1 id="h_11" class="toc">Resources</h1></header> <ul> <li>Home Page: <a href="http://www.h3rald.com/glyph/">http://www.h3rald.com/glyph/</a></li> <li>Repository: <a href="http://www.github.com/h3rald/glyph/">http://www.github.com/h3rald/glyph/</a></li>@@ -206,42 +204,25 @@ <li>Book (Web): <a href="http://www.h3rald.com/glyph/book/">http://www.h3rald.com/glyph/book/</a></li>
<li>Reference Documentation: <a href="http://rubydoc.info/gems/glyph/">http://rubydoc.info/gems/glyph/</a></li> <li>User Group: <a href="http://groups.google.com/group/glyph-framework">http://groups.google.com/group/glyph-framework</a></li> </ul> + </section> - <nav class="navigation"> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/license.html">License</a></nav> + +</section> + <nav class="navigation"> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/license.html">License →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/license.html
→
content/glyph/book/license.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>License - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,8 +61,8 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/introduction.html">Introduction</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/acknowledgements.html">Acknowledgements</a></nav> - <p>Copyright © 2010-2011 <strong>Fabio Cevasco</strong>, <a href="http://www.h3rald.com">http://www.h3rald.com</a></p> + <nav class="navigation"><a href="/glyph/book/introduction.html">← Introduction</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/acknowledgements.html">Acknowledgements →</a></nav> + <p>Copyright © 2010-2012 <strong>Fabio Cevasco</strong>, <a href="http://www.h3rald.com">http://www.h3rald.com</a></p> <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights@@ -82,41 +79,21 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p> - <nav class="navigation"><a href="/glyph/book/introduction.html">Introduction</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/acknowledgements.html">Acknowledgements</a></nav> + <nav class="navigation"><a href="/glyph/book/introduction.html">← Introduction</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/acknowledgements.html">Acknowledgements →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/macros/macros_block.html
→
content/glyph/book/macros/macros_block.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Block Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,31 +61,28 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/macros/macros_core.html">Core Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_inline.html">Inline Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_core.html">← Core Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_inline.html">Inline Macros →</a></nav> <section class="section"> -<header><h1 id="m_box">box</h1></header> +<header><h1 id="m_box" class="toc"><code>box</code></h1></header> <p>Creates a titled box (<code><div></code> tag).</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_217" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>box[Why boxes?| <span class="line-numbers"><a href="#n2" name="n2">2</a></span> Boxes can be used to make a section of text stand out from the rest of the document. -<span class="line-numbers"><a href="#n3" name="n3">3</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n3" name="n3">3</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_213">Parameters</h1></header> +<header><h1 id="h_218" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -113,30 +107,27 @@
<section class="section"> -<header><h1 id="m_codeblock">codeblock</h1></header> +<header><h1 id="m_codeblock" class="toc"><code>codeblock</code></h1></header> <p>Used to render a block of code within <code><pre></code> and <code><code></code> tags.</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_220" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>code[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> def hello <span class="line-numbers"><a href="#n3" name="n3">3</a></span> puts "Hello World" <span class="line-numbers"><a href="#n4" name="n4">4</a></span> end -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_215">Parameters</h1></header> +<header><h1 id="h_221" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -152,7 +143,7 @@ </section>
<section class="section"> -<header><h1 id="h_216">Remarks</h1></header> +<header><h1 id="h_222" class="notoc">Remarks</h1></header> <p>For code highlighting, see the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a> macro.</p> </section>@@ -162,29 +153,26 @@
<section class="section"> -<header><h1 id="m_figure">figure</h1></header> +<header><h1 id="m_figure" class="toc"><code>figure</code></h1></header> <p>Includes an image in the document, with an optional caption (see <a href="/glyph/book/text_editing/images.html#img_fig">Images and Figures</a>).</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_224" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>figure[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> graph.png|Monthly Pageviews <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @width[90%] -<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_218">Parameters</h1></header> +<header><h1 id="h_225" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -206,7 +194,7 @@ </section>
<section class="section"> -<header><h1 id="h_219">Attributes</h1></header> +<header><h1 id="h_226" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -225,30 +213,27 @@
<section class="section"> -<header><h1 id="m_image">image</h1></header> +<header><h1 id="m_image" class="toc"><code>image</code></h1></header> <p>Includes an image in the document</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_228" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>img[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> holidays/landscape.jpg <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @class[photo] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> @style[border: 1px solid black;] -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_221">Parameters</h1></header> +<header><h1 id="h_229" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -264,7 +249,7 @@ </section>
<section class="section"> -<header><h1 id="h_222">Attributes</h1></header> +<header><h1 id="h_230" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -283,7 +268,7 @@
<section class="section"> -<header><h1 id="m_navigation">navigation</h1></header> +<header><h1 id="m_navigation" class="toc"><code>navigation</code></h1></header> <p>Displays links to the document’s <span class="caps">TOC</span> and the previous/next topic (used only in <a href="/glyph/book/extending/layouts.html#layouts">layouts</a>).</p>@@ -291,7 +276,7 @@
<section class="section"> -<header><h1 id="h_224">Parameters</h1></header> +<header><h1 id="h_232" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -310,7 +295,7 @@
<section class="section"> -<header><h1 id="m_note">note</h1></header> +<header><h1 id="m_note" class="toc"><code>note</code></h1></header> <p>Creates a note <code>div</code> containing the value.</p> <strong>Aliases:</strong> <code>important, caution, tip</code> <p><strong>Example:</strong> <code>note[This is a note.]</code></p>@@ -318,7 +303,7 @@
<section class="section"> -<header><h1 id="h_226">Parameters</h1></header> +<header><h1 id="h_234" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -337,7 +322,7 @@
<section class="section"> -<header><h1 id="m_pubdate">pubdate</h1></header> +<header><h1 id="m_pubdate" class="toc"><code>pubdate</code></h1></header> <p>Evaluates to a date string (in the format: <em>current_month</em> <em>current_year</em>; i.e. <em>%B</em> <em>%Y</em>), within a <code><div></code> tag. If a parameter is supplied, its value is used instead of the current date.</p> <p><strong>Example:</strong> <code>pubdate[]</code></p>@@ -345,7 +330,7 @@
<section class="section"> -<header><h1 id="h_228">Parameters</h1></header> +<header><h1 id="h_236" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -364,7 +349,7 @@
<section class="section"> -<header><h1 id="m_revision">revision</h1></header> +<header><h1 id="m_revision" class="toc"><code>revision</code></h1></header> <p>Renders the revision of the document (based on the <a href="/glyph/book/config/document.html#s_document_revision"><code>document.revision</code></a> setting) within a <code><div></code> tag.</p> <p><strong>Example:</strong> <code>revision[]</code></p>@@ -374,7 +359,7 @@
<section class="section"> -<header><h1 id="m_subtitle">subtitle</h1></header> +<header><h1 id="m_subtitle" class="toc"><code>subtitle</code></h1></header> <p>Renders the subtitle of the document (based on the <a href="/glyph/book/config/document.html#s_document_subtitle"><code>document.subtitle</code></a> setting) within a <code><h2></code> tag.</p> <p><strong>Example:</strong> <code>subtitle[]</code></p>@@ -384,48 +369,28 @@
<section class="section"> -<header><h1 id="m_title">title</h1></header> +<header><h1 id="m_title" class="toc"><code>title</code></h1></header> <p>Renders the title of the document (based on the <a href="/glyph/book/config/document.html#s_document_title"><code>document.title</code></a> setting) within a <code><h1></code> tag.</p> <p><strong>Example:</strong> <code>title[]</code></p> </section> - <nav class="navigation"><a href="/glyph/book/macros/macros_core.html">Core Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_inline.html">Inline Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_core.html">← Core Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_inline.html">Inline Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/macros/macros_core.html
→
content/glyph/book/macros/macros_core.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Core Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,35 +61,21 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/ref_commands.html">Command Reference</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_block.html">Block Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/ref_commands.html">← Command Reference</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_block.html">Block Macros →</a></nav> <section class="section"> -<header><h1 id="m_add">add</h1></header> +<header><h1 id="m_add" class="toc"><code>add</code></h1></header> <p>Adds two or more integers together.</p> <p><strong>Example:</strong> <code>add[2|5|7]</code></p> - - - <section class="section"> -<header><h1 id="h_137">Parameters</h1></header> -<table style="width:100%;"> - <tr> - <th style="width:30%">Parameter</th> - <th>Description</th> - </tr> -Two or more integer values. - </table> - -</section> - </section> <section class="section"> -<header><h1 id="m_alias">alias</h1></header> +<header><h1 id="m_alias" class="toc"><code>alias</code></h1></header> <p>Creates a macro alias.</p> <p><strong>Example:</strong> <code>alias[s|section]</code></p>@@ -100,7 +83,7 @@
<section class="section"> -<header><h1 id="h_139">Parameters</h1></header> +<header><h1 id="h_142" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -125,7 +108,7 @@
<section class="section"> -<header><h1 id="m_and">and</h1></header> +<header><h1 id="m_and" class="toc"><code>and</code></h1></header> <p>Conditional <code>and</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p> <p><strong>Example:</strong> <code>?[and[true|false]|This is never displayed.]</code></p>@@ -133,7 +116,7 @@
<section class="section"> -<header><h1 id="h_141">Parameters</h1></header> +<header><h1 id="h_144" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -157,7 +140,7 @@
<section class="section"> -<header><h1 id="m_attribute">attribute</h1></header> +<header><h1 id="m_attribute" class="toc"><code>attribute</code></h1></header> <p>Returns the value of the specified attribute. For a more complete example, see the <a href="#m_let"><code>let</code></a> macro.</p> <strong>Aliases:</strong> <code>@</code> <p><strong>Example:</strong> <code>@[title]</code></p>@@ -165,7 +148,7 @@
<section class="section"> -<header><h1 id="h_143">Parameters</h1></header> +<header><h1 id="h_146" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -184,7 +167,7 @@
<section class="section"> -<header><h1 id="m_attribute_">attribute:</h1></header> +<header><h1 id="m_attribute_" class="toc"><code>attribute:</code></h1></header> <p>Sets the value of the specified attribute. For a more complete example, see the ‡‡‡‡‡PLACEHOLDER¤277‡‡‡‡‡ macro.</p> <strong>Aliases:</strong> <code>@:</code> <p><strong>Example:</strong> <code>@:[title|Test Title]</code></p>@@ -192,7 +175,7 @@
<section class="section"> -<header><h1 id="h_145">Parameters</h1></header> +<header><h1 id="h_148" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -217,7 +200,7 @@
<section class="section"> -<header><h1 id="m_comment">comment</h1></header> +<header><h1 id="m_comment" class="toc"><code>comment</code></h1></header> <p>Evaluates to nothing. Used to add comments in a Glyph document that will not be displayed in output files.</p> <strong>Aliases:</strong> <code>--</code> <p><strong>Example:</strong> <code>--[=>[#link|This link will not be evaluated]]</code></p>@@ -225,7 +208,7 @@
<section class="section"> -<header><h1 id="h_147">Parameters</h1></header> +<header><h1 id="h_150" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -241,7 +224,7 @@ </section>
<section class="section"> -<header><h1 id="h_148">Remarks</h1></header> +<header><h1 id="h_151" class="notoc">Remarks</h1></header> <p>Macros are not expanded within comments.</p> </section>@@ -251,7 +234,7 @@
<section class="section"> -<header><h1 id="m_condition">condition</h1></header> +<header><h1 id="m_condition" class="toc"><code>condition</code></h1></header> <p>Tests a conditional expression. For more information, see <a href="/glyph/book/text_editing/conditionals.html#cond_macros">Conditional Macros</a>.</p> <strong>Aliases:</strong> <code>?</code>@@ -259,7 +242,7 @@
<section class="section"> -<header><h1 id="h_150">Parameters</h1></header> +<header><h1 id="h_153" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -281,7 +264,7 @@ </section>
<section class="section"> -<header><h1 id="h_151">Remarks</h1></header> +<header><h1 id="h_154" class="notoc">Remarks</h1></header> <p>For examples see any of the following:</p> <ul> <li><a href="#m_and"><code>and</code></a> macro</li>@@ -298,7 +281,7 @@
<section class="section"> -<header><h1 id="m_config">config</h1></header> +<header><h1 id="m_config" class="toc"><code>config</code></h1></header> <p>Returns the value of a configuration setting.</p> <strong>Aliases:</strong> <code>$</code> <p><strong>Example:</strong> <code>$[document.author]</code></p>@@ -306,7 +289,7 @@
<section class="section"> -<header><h1 id="h_153">Parameters</h1></header> +<header><h1 id="h_156" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -325,7 +308,7 @@
<section class="section"> -<header><h1 id="m_config_">config:</h1></header> +<header><h1 id="m_config_" class="toc"><code>config:</code></h1></header> <p>Sets the value of a configuration setting.</p> <strong>Aliases:</strong> <code>$:</code> <p><strong>Example:</strong> <code>$:[document.draft|true]</code></p>@@ -333,7 +316,7 @@
<section class="section"> -<header><h1 id="h_155">Parameters</h1></header> +<header><h1 id="h_158" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -355,7 +338,7 @@ </section>
<section class="section"> -<header><h1 id="h_156">Remarks</h1></header> +<header><h1 id="h_159" class="notoc">Remarks</h1></header> <p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p> </section>@@ -365,7 +348,7 @@
<section class="section"> -<header><h1 id="m_eq">eq</h1></header> +<header><h1 id="m_eq" class="toc"><code>eq</code></h1></header> <p>Conditional equality operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p> <p><strong>Example:</strong> <code>?[eq[$[document.draft]|true]|This is displayed only in draft documents.]</code></p>@@ -373,7 +356,7 @@
<section class="section"> -<header><h1 id="h_158">Parameters</h1></header> +<header><h1 id="h_161" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -397,7 +380,7 @@
<section class="section"> -<header><h1 id="m_escape">escape</h1></header> +<header><h1 id="m_escape" class="toc"><code>escape</code></h1></header> <p>Evaluates to its value. Commonly used with the escaping delimiters <code>[=</code> and <code>=]</code>.</p> <strong>Aliases:</strong> <code>.</code> <p><strong>Example:</strong> <code>.[=Macros are escaped here =>[#test].=]</code></p>@@ -405,7 +388,7 @@
<section class="section"> -<header><h1 id="h_160">Parameters</h1></header> +<header><h1 id="h_163" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -424,7 +407,7 @@
<section class="section"> -<header><h1 id="m_fragment">fragment</h1></header> +<header><h1 id="m_fragment" class="toc"><code>fragment</code></h1></header> <p>Delimits a fragment of text that can be embedded using the <a href="#m_embed"><code>embed</code></a> macro.</p> <strong>Aliases:</strong> <code>##</code> <p><strong>Example:</strong> <code>##[test_fragment|This is an embeddable fragment]</code></p>@@ -432,7 +415,7 @@
<section class="section"> -<header><h1 id="h_162">Parameters</h1></header> +<header><h1 id="h_165" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -457,7 +440,7 @@
<section class="section"> -<header><h1 id="m_embed">embed</h1></header> +<header><h1 id="m_embed" class="toc"><code>embed</code></h1></header> <p>Embeds text previously-delimited using the <a href="#m_fragment"><code>fragment</code></a> macro.</p> <strong>Aliases:</strong> <code>&=</code> <p><strong>Example:</strong> <code>&=[test_fragment]</code></p>@@ -465,7 +448,7 @@
<section class="section"> -<header><h1 id="h_164">Parameters</h1></header> +<header><h1 id="h_167" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -487,7 +470,7 @@
<section class="section"> -<header><h1 id="m_gt">gt</h1></header> +<header><h1 id="m_gt" class="toc"><code>gt</code></h1></header> <p>Returns <em>true</em> if the first parameter is gt the second one.</p> <p><strong>Example:</strong> <code>greater than[5|2]</code></p>@@ -495,7 +478,7 @@
<section class="section"> -<header><h1 id="h_166">Parameters</h1></header> +<header><h1 id="h_169" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -522,7 +505,7 @@
<section class="section"> -<header><h1 id="m_gte">gte</h1></header> +<header><h1 id="m_gte" class="toc"><code>gte</code></h1></header> <p>Returns <em>true</em> if the first parameter is gte the second one.</p> <p><strong>Example:</strong> <code>greater than or equal to[5|2]</code></p>@@ -530,7 +513,7 @@
<section class="section"> -<header><h1 id="h_168">Parameters</h1></header> +<header><h1 id="h_171" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -556,7 +539,7 @@
<section class="section"> -<header><h1 id="m_include">include</h1></header> +<header><h1 id="m_include" class="toc"><code>include</code></h1></header> <p>Evaluates to the contents of a text file stored in the <code>text/</code> directory referenced by its relative path. If the <a href="/glyph/book/config/options.html#s_options_filters_by_file_extension"><code>options.filters_by_file_extension</code></a> setting is <code>true</code>, filters the contents of the file using the <a href="/glyph/book/macros/macros_filters.html#f_macros">filter macro</a> corresponding to the file extension.</p> <strong>Aliases:</strong> <code>@</code> <p><strong>Example:</strong> <code>include[frontmatter/introduction]</code></p>@@ -564,7 +547,7 @@
<section class="section"> -<header><h1 id="h_170">Parameters</h1></header> +<header><h1 id="h_173" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -580,7 +563,7 @@ </section>
<section class="section"> -<header><h1 id="h_171">Remarks</h1></header> +<header><h1 id="h_174" class="notoc">Remarks</h1></header> <ul> <li> <p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p>@@ -598,16 +581,14 @@
<section class="section"> -<header><h1 id="m_let">let</h1></header> +<header><h1 id="m_let" class="toc"><code>let</code></h1></header> <p>Used to bind one or more attributes via the <a href="#m_attribute"><code>attribute</code></a> macro. Actually, you can use <a href="#m_attribute"><code>attribute</code></a> macro inside any other macro, but it looks tidier in this way.</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_176" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>let[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @:[a|2] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @:[b|3]@@ -615,16 +596,15 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> section[
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> @title[Testing] <span class="line-numbers"><a href="#n6" name="n6">6</a></span> @[title]: @[a] * @[b] = multiply[@[a]|@[b]] --[Outputs: Testing: 2 * 3 = 6] <span class="line-numbers"><a href="#n7" name="n7">7</a></span> ] -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_173">Parameters</h1></header> +<header><h1 id="h_177" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -643,7 +623,7 @@
<section class="section"> -<header><h1 id="m_load">load</h1></header> +<header><h1 id="m_load" class="toc"><code>load</code></h1></header> <p>Embeds the contents of a file.</p> <p><strong>Example:</strong> <code>load[my_samples.rb]</code></p>@@ -651,7 +631,7 @@
<section class="section"> -<header><h1 id="h_175">Parameters</h1></header> +<header><h1 id="h_179" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -671,7 +651,7 @@
<section class="section"> -<header><h1 id="m_lt">lt</h1></header> +<header><h1 id="m_lt" class="toc"><code>lt</code></h1></header> <p>Returns <em>true</em> if the first parameter is lt the second one.</p> <p><strong>Example:</strong> <code>less than[5|2]</code></p>@@ -679,7 +659,7 @@
<section class="section"> -<header><h1 id="h_177">Parameters</h1></header> +<header><h1 id="h_181" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -706,7 +686,7 @@
<section class="section"> -<header><h1 id="m_lte">lte</h1></header> +<header><h1 id="m_lte" class="toc"><code>lte</code></h1></header> <p>Returns <em>true</em> if the first parameter is lte the second one.</p> <p><strong>Example:</strong> <code>less than or equal to[5|2]</code></p>@@ -714,7 +694,7 @@
<section class="section"> -<header><h1 id="h_179">Parameters</h1></header> +<header><h1 id="h_183" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -740,7 +720,7 @@
<section class="section"> -<header><h1 id="m_match">match</h1></header> +<header><h1 id="m_match" class="toc"><code>match</code></h1></header> <p>Checks a string against a regular expression.</p> <p><strong>Example:</strong> <code>?[match[Hello!|/^hell/i]|This is always displayed]</code></p>@@ -748,7 +728,7 @@
<section class="section"> -<header><h1 id="h_181">Parameters</h1></header> +<header><h1 id="h_185" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -776,7 +756,7 @@ </section>
<section class="section"> -<header><h1 id="h_182">Remarks</h1></header> +<header><h1 id="h_186" class="notoc">Remarks</h1></header> <p>This macro must be used with the <a href="#m_condition"><code>condition</code></a> macro.</p> </section>@@ -786,7 +766,7 @@
<section class="section"> -<header><h1 id="m_macro_">macro:</h1></header> +<header><h1 id="m_macro_" class="toc"><code>macro:</code></h1></header> <p>Defines a macro.</p> <strong>Aliases:</strong> <code>%:</code> <p><strong>Example:</strong> <code>%:[test|"<em>test: #{value}</em>"]</code></p>@@ -794,7 +774,7 @@
<section class="section"> -<header><h1 id="h_184">Parameters</h1></header> +<header><h1 id="h_188" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -816,7 +796,7 @@ </section>
<section class="section"> -<header><h1 id="h_185">Remarks</h1></header> +<header><h1 id="h_189" class="notoc">Remarks</h1></header> <ul> <li> <p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p>@@ -831,31 +811,17 @@
<section class="section"> -<header><h1 id="m_multiply">multiply</h1></header> +<header><h1 id="m_multiply" class="toc"><code>multiply</code></h1></header> <p>Multiplies two or more integers together.</p> <p><strong>Example:</strong> <code>add[3|5|9]</code></p> - - - <section class="section"> -<header><h1 id="h_187">Parameters</h1></header> -<table style="width:100%;"> - <tr> - <th style="width:30%">Parameter</th> - <th>Description</th> - </tr> -Two or more integer values. - </table> - -</section> - </section> <section class="section"> -<header><h1 id="m_not">not</h1></header> +<header><h1 id="m_not" class="toc"><code>not</code></h1></header> <p>Conditional <code>not</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p> <p><strong>Example:</strong> <code>?[not[false]|This is always displayed.]</code></p>@@ -863,7 +829,7 @@
<section class="section"> -<header><h1 id="h_189">Parameters</h1></header> +<header><h1 id="h_192" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -882,7 +848,7 @@
<section class="section"> -<header><h1 id="m_output_">output?</h1></header> +<header><h1 id="m_output_" class="toc"><code>output?</code></h1></header> <p>Evaluates to true if Glyph is generating output in the specified format(s).</p> <p><strong>Example:</strong> <code>?[output?[web|web5]|This text is printed only when generating web or web5 output.]</code></p>@@ -890,7 +856,7 @@
<section class="section"> -<header><h1 id="h_191">Parameters</h1></header> +<header><h1 id="h_194" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -909,7 +875,7 @@
<section class="section"> -<header><h1 id="m_or">or</h1></header> +<header><h1 id="m_or" class="toc"><code>or</code></h1></header> <p>Conditional <code>or</code> operator, to be used with the <a href="#m_condition"><code>condition</code></a> macro.</p> <p><strong>Example:</strong> <code>?[or[true|false]|This is always displayed.]</code></p>@@ -917,7 +883,7 @@
<section class="section"> -<header><h1 id="h_193">Parameters</h1></header> +<header><h1 id="h_196" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -941,16 +907,14 @@
<section class="section"> -<header><h1 id="m_define_">define:</h1></header> +<header><h1 id="m_define_" class="toc"><code>define:</code></h1></header> <p>Defines a new macro in Glyph code (for more information, see <a href="/glyph/book/extending/interpreting.html#rewriting">Defining macros using Glyph</a>)</p> <strong>Aliases:</strong> <code>def:</code> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_198" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>def:[factorial| <span class="line-numbers"> <a href="#n2" name="n2">2</a></span> ?[ <span class="line-numbers"> <a href="#n3" name="n3">3</a></span> eq[{{0}}|0]|1|@@ -959,16 +923,15 @@ <span class="line-numbers"> <a href="#n5" name="n5">5</a></span> {{0}} | factorial[subtract[{{0}}|1]]
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span> ] <span class="line-numbers"> <a href="#n7" name="n7">7</a></span> ] <span class="line-numbers"> <a href="#n8" name="n8">8</a></span>] -<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>factorial[5] -</pre></div> +<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>factorial[5]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_195">Parameters</h1></header> +<header><h1 id="h_199" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -990,7 +953,7 @@ </section>
<section class="section"> -<header><h1 id="h_196">Remarks</h1></header> +<header><h1 id="h_200" class="notoc">Remarks</h1></header> <ul> <li>The new macro can only be used <em>after</em> its declaration.</li> <li>@@ -1005,20 +968,18 @@
<section class="section"> -<header><h1 id="m_ruby">ruby</h1></header> +<header><h1 id="m_ruby" class="toc"><code>ruby</code></h1></header> <p>Evaluates its value as Ruby code within the context of the <a href="http://rubydoc.info/gems/glyph/Glyph">Glyph</a> module.</p> <strong>Aliases:</strong> <code>%</code> - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>%\[Time.now\]</code><br />", "<code>%\[Glyph::VERSION\]</code><br />"] -</div> - +<examples> +%[Time.now] +%[Glyph::VERSION] +</examples> <section class="section"> -<header><h1 id="h_198">Parameters</h1></header> +<header><h1 id="h_202" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -1034,7 +995,7 @@ </section>
<section class="section"> -<header><h1 id="h_199">Remarks</h1></header> +<header><h1 id="h_203" class="notoc">Remarks</h1></header> <p>This macro cannot be used in <a href="/glyph/book/compiling/programmatic_usage.html#modes">safe mode</a>.</p> </section>@@ -1044,23 +1005,22 @@
<section class="section"> -<header><h1 id="m_s">s</h1></header> +<header><h1 id="m_s" class="toc"><code>s</code></h1></header> <p>Can be used to dispatch almost any instance method of the ruby <a href="http://rubydoc.info/stdlib/core/1.9.2/String">String</a> class.</p> - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>s/match\[This is a test string\|/test/\]</code><br />", "<code>s/sub\[This is a test string\|/a test/\|another test\]</code><br />"] -</div> +<examples> +s/match[This is a test string|/test/] +s/sub[This is a test string|/a test/|another test] +</examples> </section> <section class="section"> -<header><h1 id="m_snippet">snippet</h1></header> +<header><h1 id="m_snippet" class="toc"><code>snippet</code></h1></header> <p>Returns the value of a snippet.</p> <strong>Aliases:</strong> <code>&</code> <p><strong>Example:</strong> <code>&[glang]</code></p>@@ -1068,7 +1028,7 @@
<section class="section"> -<header><h1 id="h_202">Parameters</h1></header> +<header><h1 id="h_206" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -1087,7 +1047,7 @@
<section class="section"> -<header><h1 id="m_snippet_">snippet:</h1></header> +<header><h1 id="m_snippet_" class="toc"><code>snippet:</code></h1></header> <p>Defines a snippet.</p> <strong>Aliases:</strong> <code>&:</code> <p><strong>Example:</strong> <code>&:[test|This is a test]</code></p>@@ -1095,7 +1055,7 @@
<section class="section"> -<header><h1 id="h_204">Parameters</h1></header> +<header><h1 id="h_208" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -1117,7 +1077,7 @@ </section>
<section class="section"> -<header><h1 id="h_205">Remarks</h1></header> +<header><h1 id="h_209" class="notoc">Remarks</h1></header> <p>The new snippet can only be used <em>after</em> its declaration.</p> </section>@@ -1127,31 +1087,17 @@
<section class="section"> -<header><h1 id="m_subtract">subtract</h1></header> +<header><h1 id="m_subtract" class="toc"><code>subtract</code></h1></header> <p>Subtracts two or more integers together.</p> <p><strong>Example:</strong> <code>add[10|5|2]</code></p> - - - <section class="section"> -<header><h1 id="h_207">Parameters</h1></header> -<table style="width:100%;"> - <tr> - <th style="width:30%">Parameter</th> - <th>Description</th> - </tr> -Two or more integer values. - </table> - -</section> - </section> <section class="section"> -<header><h1 id="m_xml">xml</h1></header> +<header><h1 id="m_xml" class="toc"><code>xml</code></h1></header> <p>When used composed with another macro, it can be used to render arbitrary raw <span class="caps">XML</span> tags.</p> <p><strong>Example:</strong> <code>xml/img[@src[test.png]@alt[A Test image]]</code></p>@@ -1161,16 +1107,14 @@
<section class="section"> -<header><h1 id="m_while">while</h1></header> +<header><h1 id="m_while" class="toc"><code>while</code></h1></header> <p>Keeps evaluating the second parameter while a condition is satisfied.</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_213" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>let[ <span class="line-numbers"> <a href="#n2" name="n2">2</a></span> @count[5] <span class="line-numbers"> <a href="#n3" name="n3">3</a></span> @text[-]@@ -1179,16 +1123,15 @@ <span class="line-numbers"> <a href="#n5" name="n5">5</a></span> @:[text|s/concat[@[text]|@[count]-]]
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span> @:[count|subtract[@[count]|1]] <span class="line-numbers"> <a href="#n7" name="n7">7</a></span> ] <span class="line-numbers"> <a href="#n8" name="n8">8</a></span> @[text] --[Outputs: -5-4-3-2-1-] -<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>] -</pre></div> +<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_210">Parameters</h1></header> +<header><h1 id="h_214" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -1210,41 +1153,21 @@ </section>
</section> - <nav class="navigation"><a href="/glyph/book/ref_commands.html">Command Reference</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_block.html">Block Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/ref_commands.html">← Command Reference</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_block.html">Block Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/macros/macros_filters.html
→
content/glyph/book/macros/macros_filters.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Filter Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,11 +61,11 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/macros/macros_inline.html">Inline Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_structure.html">Structure Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_inline.html">← Inline Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_structure.html">Structure Macros →</a></nav> <section class="section"> -<header><h1 id="m_markdown">markdown</h1></header> +<header><h1 id="m_markdown" class="toc"><code>markdown</code></h1></header> <p>Uses a Markdown converter (BlueCloth, RDiscount, Maruku or Kramdown) to transform the value into <span class="caps">HTML</span> if the <a href="/glyph/book/config/output.html#cfg_output"><code>output.*.filter_target</code></a> setting is set to <code>html</code>.</p> <p>If the <a href="/glyph/book/config/options.html#s_options_filters_by_file_extension"><code>options.filters_by_file_extension</code></a> setting is <code>true</code>, this macro is called automatically on <a href="/glyph/book/macros/macros_core.html#m_include">included</a> files with a <code>.markdown</code> or a <code>.md</code> extension.</p> <strong>Aliases:</strong> <code>md</code>@@ -77,7 +74,7 @@
<section class="section"> -<header><h1 id="h_244">Parameters</h1></header> +<header><h1 id="h_252" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -97,30 +94,27 @@
<section class="section"> -<header><h1 id="m_markdown_section">markdown_section</h1></header> +<header><h1 id="m_markdown_section" class="toc"><code>markdown_section</code></h1></header> <p>Creates a section (see <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro) whose content can be formatted with markdown markup.</p> <strong>Aliases:</strong> <code>§md, md_section</code> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_254" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>markdown_section[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[Test Section] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[test] <span class="line-numbers"><a href="#n4" name="n4">4</a></span>Some *markdown* text. -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_246">Parameters</h1></header> +<header><h1 id="h_255" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -136,7 +130,7 @@ </section>
<section class="section"> -<header><h1 id="h_247">Attributes</h1></header> +<header><h1 id="h_256" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -167,7 +161,7 @@
<section class="section"> -<header><h1 id="m_textile">textile</h1></header> +<header><h1 id="m_textile" class="toc"><code>textile</code></h1></header> <p>Uses the RedCloth gem to transform the value into <span class="caps">HTML</span> or LaTeX, depending on the value of the <a href="/glyph/book/config/output.html#cfg_output"><code>output.*.filter_target</code></a>.</p> <p>If the <a href="/glyph/book/config/options.html#s_options_filters_by_file_extension"><code>options.filters_by_file_extension</code></a> setting is <code>true</code>, this macro is called automatically on <a href="/glyph/book/macros/macros_core.html#m_include">included</a> files with a <code>.textile</code> or a <code>.txt</code> extension.</p> <strong>Aliases:</strong> <code>txt</code>@@ -176,7 +170,7 @@
<section class="section"> -<header><h1 id="h_249">Parameters</h1></header> +<header><h1 id="h_258" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -196,30 +190,27 @@
<section class="section"> -<header><h1 id="m_textile_section">textile_section</h1></header> +<header><h1 id="m_textile_section" class="toc"><code>textile_section</code></h1></header> <p>Creates a section (see <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro) whose content can be formatted with textile markup.</p> <strong>Aliases:</strong> <code>§txt, txt_section</code> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_260" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>textile_section[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[Test Section] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[test] <span class="line-numbers"><a href="#n4" name="n4">4</a></span>Some *textile* text. -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_251">Parameters</h1></header> +<header><h1 id="h_261" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -235,7 +226,7 @@ </section>
<section class="section"> -<header><h1 id="h_252">Attributes</h1></header> +<header><h1 id="h_262" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -266,30 +257,27 @@
<section class="section"> -<header><h1 id="m_highlight">highlight</h1></header> +<header><h1 id="m_highlight" class="toc"><code>highlight</code></h1></header> <p>Highlights a piece of source code according to the specified language. <span class="fmi">for more information on <mark>code highligting</mark>, see <a href="/glyph/book/text_editing/code.html#source_code">Source Code</a></span>.</p> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_264" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>highlight[ruby| <span class="line-numbers"><a href="#n2" name="n2">2</a></span> def hello <span class="line-numbers"><a href="#n3" name="n3">3</a></span> puts "Hello World" <span class="line-numbers"><a href="#n4" name="n4">4</a></span> end -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_254">Parameters</h1></header> +<header><h1 id="h_265" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -311,41 +299,21 @@ </section>
</section> - <nav class="navigation"><a href="/glyph/book/macros/macros_inline.html">Inline Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_structure.html">Structure Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_inline.html">← Inline Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_structure.html">Structure Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/macros/macros_inline.html
→
content/glyph/book/macros/macros_inline.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Inline Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/macros/macros_block.html">Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav> <section class="section"> -<header><h1 id="m_anchor">anchor</h1></header> +<header><h1 id="m_anchor" class="toc"><code>anchor</code></h1></header> <p>Creates a named anchor (or bookmark).</p> <strong>Aliases:</strong> <code>bookmark, #</code> <p><strong>Example:</strong> <code>#[test|Test Bookmark]</code></p>@@ -75,7 +72,7 @@
<section class="section"> -<header><h1 id="h_234">Parameters</h1></header> +<header><h1 id="h_242" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -100,7 +97,7 @@
<section class="section"> -<header><h1 id="m_draftcomment">draftcomment</h1></header> +<header><h1 id="m_draftcomment" class="toc"><code>draftcomment</code></h1></header> <p>If the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>, displays a draft comment within the document.</p> <strong>Aliases:</strong> <code>dc</code> <p><strong>Example:</strong> <code>dc[This is printed only in draft documents.]</code></p>@@ -108,7 +105,7 @@
<section class="section"> -<header><h1 id="h_236">Parameters</h1></header> +<header><h1 id="h_244" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -127,7 +124,7 @@
<section class="section"> -<header><h1 id="m_fmi">fmi</h1></header> +<header><h1 id="m_fmi" class="toc"><code>fmi</code></h1></header> <p>Creates a <em>For More Information</em> link (for an example usage, see the <a href="#m_link"><code>link</code></a> macro).</p> <p><strong>Example:</strong> <code>fmi[creating links|#links]</code></p>@@ -135,7 +132,7 @@
<section class="section"> -<header><h1 id="h_238">Parameters</h1></header> +<header><h1 id="h_246" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -160,7 +157,7 @@
<section class="section"> -<header><h1 id="m_link">link</h1></header> +<header><h1 id="m_link" class="toc"><code>link</code></h1></header> <p>Creates an hyperlink (<span class="fmi">for more information on <mark>creating links</mark>, see <a href="/glyph/book/text_editing/links.html#links">Links and Bookmarks</a></span>).</p> <strong>Aliases:</strong> <code>=></code> <p><strong>Example:</strong> <code>=>[http://www.h3rald.com|H3RALD.com]</code></p>@@ -168,7 +165,7 @@
<section class="section"> -<header><h1 id="h_240">Parameters</h1></header> +<header><h1 id="h_248" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -193,48 +190,28 @@
<section class="section"> -<header><h1 id="m_todo">todo</h1></header> +<header><h1 id="m_todo" class="toc"><code>todo</code></h1></header> <p>Saves the value as a <span class="caps">TODO</span> item, which can be printed using the <a href="/glyph/book/ref_commands.html#c_todo"><code>todo</code></a> command and included in the document if the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting is set to <code>true</code>.</p> <strong>Aliases:</strong> <code>!</code> <p><strong>Example:</strong> <code>todo[Remember to do this.]</code></p> </section> - <nav class="navigation"><a href="/glyph/book/macros/macros_block.html">Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_block.html">← Block Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_filters.html">Filter Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/macros/macros_structure.html
→
content/glyph/book/macros/macros_structure.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Structure Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/macros/macros_filters.html">Filter Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/document.html">document.*</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_filters.html">← Filter Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/document.html"><code>document.*</code> →</a></nav> <section class="section"> -<header><h1 id="m_article">article</h1></header> +<header><h1 id="m_article" class="toc"><code>article</code></h1></header> <p>Used to create a simple article. By default, it includes the following macros:</p> <ul> <li><code>document</code>@@ -94,7 +91,7 @@
<section class="section"> -<header><h1 id="h_257">Parameters</h1></header> +<header><h1 id="h_268" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -110,7 +107,7 @@ </section>
<section class="section"> -<header><h1 id="h_258">Attributes</h1></header> +<header><h1 id="h_269" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -153,7 +150,7 @@
<section class="section"> -<header><h1 id="m_book">book</h1></header> +<header><h1 id="m_book" class="toc"><code>book</code></h1></header> <p>Used to create a book. By default, it includes the following macros:</p> <ul> <li><code>document</code>@@ -181,7 +178,7 @@
<section class="section"> -<header><h1 id="h_260">Parameters</h1></header> +<header><h1 id="h_271" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -197,7 +194,7 @@ </section>
<section class="section"> -<header><h1 id="h_261">Attributes</h1></header> +<header><h1 id="h_272" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -258,7 +255,7 @@
<section class="section"> -<header><h1 id="m_document">document</h1></header> +<header><h1 id="m_document" class="toc"><code>document</code></h1></header> <p>Creates an <code><html></code> tag and a <span class="caps">DOCTYPE</span> declaration. Called internally by the <a href="#m_book"><code>book</code></a> macro and the <a href="#m_article"><code>article</code></a> macro.</p>@@ -266,7 +263,7 @@
<section class="section"> -<header><h1 id="h_263">Parameters</h1></header> +<header><h1 id="h_274" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -285,7 +282,7 @@
<section class="section"> -<header><h1 id="m_head">head</h1></header> +<header><h1 id="m_head" class="toc"><code>head</code></h1></header> <p>Creates a <code><head></code> tag, pre-populated with <code>title</code> and author/copyright <code><meta></code> tags.</p>@@ -293,7 +290,7 @@
<section class="section"> -<header><h1 id="h_265">Parameters</h1></header> +<header><h1 id="h_276" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -312,30 +309,27 @@
<section class="section"> -<header><h1 id="m_section">section</h1></header> +<header><h1 id="m_section" class="toc"><code>section</code></h1></header> <p>Creates a section (<code><div></code> or <code><section></code> tag).</p> <strong>Aliases:</strong> <code>acknowledgement, addendum, afterword, appendix, bibliography, chapter, colophon, dedication, epilogue, foreword, glossary, imprint, index, inspiration, introduction, lof, lot, part, postscript, preface, prologue, promotion, references, section, section, volume</code> - <div class="example"> - <p> -<strong>Example</strong> -</p> - <div class="CodeRay"> + <section class="section"> +<header><h1 id="h_278" class="notoc">Example</h1></header> +<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>section[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[Test Section] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[test] <span class="line-numbers"><a href="#n4" name="n4">4</a></span>... -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> - </div> +</section> <section class="section"> -<header><h1 id="h_267">Parameters</h1></header> +<header><h1 id="h_279" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -351,7 +345,7 @@ </section>
<section class="section"> -<header><h1 id="h_268">Attributes</h1></header> +<header><h1 id="h_280" class="notoc">Attributes</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Attribute</th>@@ -382,7 +376,7 @@
<section class="section"> -<header><h1 id="m_style">style</h1></header> +<header><h1 id="m_style" class="toc"><code>style</code></h1></header> <p>Embeds the content of a <span class="caps">CSS</span> or Sass file within a <code><style></code> tag (<span class="fmi">for more information on <mark>stylesheets</mark>, see <a href="/glyph/book/text_editing/stylesheets.html#stylesheets">Adding Stylesheets</a></span>).</p> <p><strong>Example:</strong> <code>style[default.css]</code></p>@@ -390,7 +384,7 @@
<section class="section"> -<header><h1 id="h_270">Parameters</h1></header> +<header><h1 id="h_282" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -409,7 +403,7 @@
<section class="section"> -<header><h1 id="m_toc">toc</h1></header> +<header><h1 id="m_toc" class="toc"><code>toc</code></h1></header> <p>Generates a <em>Table of Contents</em> based on how sections are nested in the current document.</p> <p><strong>Example:</strong> <code>toc[1]</code></p>@@ -417,7 +411,7 @@
<section class="section"> -<header><h1 id="h_272">Parameters</h1></header> +<header><h1 id="h_284" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -433,41 +427,21 @@ </section>
</section> - <nav class="navigation"><a href="/glyph/book/macros/macros_filters.html">Filter Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/document.html">document.*</a></nav> + <nav class="navigation"><a href="/glyph/book/macros/macros_filters.html">← Filter Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/document.html"><code>document.*</code> →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/ref_commands.html
→
content/glyph/book/ref_commands.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Command Reference - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">← Macro Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros →</a></nav> <p>Glyph’s command-line interface has been built using the <a href="http://github.com/davetron5000/gli">gli</a> (Git-like interface) gem. Therefore, Glyph commands are all written like this:</p> <p><strong>glyph</strong> <em>global_options</em> <strong>command</strong> <em>options</em> <em>parameters</em></p> <p>Where:</p>@@ -73,26 +70,26 @@ <li><em>global_options</em> and <em>options</em> are in the form: <code>-n</code> <em>value</em> or <code>--name=</code><em>value</em>, e.g. <code>-f pdf</code> or <code>--format=pdf</code></li>
<li><em>parameters</em> are separated by whitespaces, and can be wrapped in quotes.</li> </ul> <section class="section"> -<header><h1 id="h_115">Global Options</h1></header> +<header><h1 id="h_115" class="toc">Global Options</h1></header> <section class="section"> -<header><h1 id="debug_switch"><code>-d</code>, <code>--debug</code></h1></header> +<header><h1 id="debug_switch" class="toc"><code>-d</code>, <code>--debug</code></h1></header> <p>If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.</p> </section> <section class="section"> -<header><h1 id="version_switch"><code>-v</code>, <code>--version</code></h1></header> -<p>Prints the current version of Glyph, ignoring any other command or switches.</p> +<header><h1 id="help_switch" class="toc"><code>-h</code>, <code>--help</code></h1></header> +<p>Displays help on the program.</p> </section> </section> <section class="section"> -<header><h1 id="c_add">add</h1></header> +<header><h1 id="c_add" class="toc"><code>add</code></h1></header> <p>Creates a new text file in the <code>text/</code> folder.</p> <p><strong>Example:</strong> <code>glyph add introduction.textile</code></p> <section class="section"> -<header><h1 id="h_119">Parameters</h1></header> +<header><h1 id="h_119" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -108,12 +105,12 @@ </section>
</section> <section class="section"> -<header><h1 id="c_compile">compile</h1></header> +<header><h1 id="c_compile" class="toc"><code>compile</code></h1></header> <p>Compiles a Glyph document into an output file. If no options are specified, the <code>document.glyph</code> file is used as source to produce a standalone HTML file.</p> <p><strong>Example:</strong> <code>glyph compile -f pdf</code></p> <section class="section"> -<header><h1 id="h_121">Parameters</h1></header> +<header><h1 id="h_121" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -135,7 +132,7 @@ </section>
<section class="section"> -<header><h1 id="h_122">Options</h1></header> +<header><h1 id="h_122" class="notoc">Options</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Option</th>@@ -172,17 +169,21 @@ </section>
</section> <section class="section"> -<header><h1 id="c_config">config</h1></header> +<header><h1 id="c_config" class="toc"><code>config</code></h1></header> Gets or sets a configuration setting in the project or global configuration file (<span class="fmi">for more information on <mark>configuration files</mark>, see <a href="/glyph/book/getting_started/configuration.html#cfg">Project Configuration</a></span>). - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>glyph config document.filename</code><br />", "<code>glyph config -g document.author \"Fabio Cevasco\"</code><br />"] -</div> - + <section class="section"> +<header><h1 id="h_124" class="notoc">Examples</h1></header> +<p> +<code>glyph config document.filename</code> +</p> + <p> +<code>glyph config -g document.author "Fabio Cevasco"</code> +</p> + +</section> <section class="section"> -<header><h1 id="h_124">Options</h1></header> +<header><h1 id="h_125" class="notoc">Options</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Option</th>@@ -201,7 +202,7 @@ </section>
<section class="section"> -<header><h1 id="h_125">Parameters</h1></header> +<header><h1 id="h_126" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -223,17 +224,21 @@ </section>
</section> <section class="section"> -<header><h1 id="c_help">help</h1></header> +<header><h1 id="c_help" class="toc"><code>help</code></h1></header> Prints information about all Glyph commands or about one specific command. - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>glyph help</code><br />", "<code>glyph help compile</code><br />"] -</div> - + <section class="section"> +<header><h1 id="h_128" class="notoc">Examples</h1></header> +<p> +<code>glyph help</code> +</p> + <p> +<code>glyph help compile</code> +</p> + +</section> <section class="section"> -<header><h1 id="h_127">Parameters</h1></header> +<header><h1 id="h_129" class="notoc">Parameters</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Parameter</th>@@ -249,17 +254,17 @@ </section>
</section> <section class="section"> -<header><h1 id="c_init">init</h1></header> +<header><h1 id="c_init" class="toc"><code>init</code></h1></header> Creates a new Glyph project in the current directory (if empty). <p><strong>Example:</strong> <code>glyph init</code></p> </section> <section class="section"> -<header><h1 id="c_outline">outline</h1></header> +<header><h1 id="c_outline" class="toc"><code>outline</code></h1></header> Display an outline of the current document. <section class="section"> -<header><h1 id="h_130">Options</h1></header> +<header><h1 id="h_132" class="notoc">Options</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Option</th>@@ -299,25 +304,37 @@ </table>
</section> - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>glyph outline -it -l 1</code><br />", "<code>glyph outline -l 2</code><br />", "<code>glyph outline -f</code><br />"] -</div> + <section class="section"> +<header><h1 id="h_133" class="notoc">Examples</h1></header> +<p> +<code>glyph outline -it -l 1</code> +</p> + <p> +<code>glyph outline -l 2</code> +</p> + <p> +<code>glyph outline -f</code> +</p> + +</section> </section> <section class="section"> -<header><h1 id="c_stats">stats</h1></header> +<header><h1 id="c_stats" class="toc"><code>stats</code></h1></header> <p>Displays project statistics (<span class="fmi">for more information on <mark>this command</mark>, see <a href="/glyph/book/document.html#stats">Document Statistics</a></span>).</p> - -<div class="examples"> -<p><strong>Examples:</strong></p> -["<code>glyph stats -m </code><br />", "<code>glyph stats --link=h3rald.com</code><br />"] -</div> - + <section class="section"> +<header><h1 id="h_135" class="notoc">Examples</h1></header> +<p> +<code>glyph stats -m</code> +</p> + <p> +<code>glyph stats --link=h3rald.com</code> +</p> + +</section> <section class="section"> -<header><h1 id="h_132">Options</h1></header> +<header><h1 id="h_136" class="notoc">Options</h1></header> <table style="width:100%;"> <tr> <th style="width:30%">Option</th>@@ -399,46 +416,26 @@ </section>
</section> <section class="section"> -<header><h1 id="c_todo">todo</h1></header> +<header><h1 id="c_todo" class="toc"><code>todo</code></h1></header> Prints all the todo items saved using the <a href="/glyph/book/macros/macros_inline.html#m_todo"><code>todo</code></a> macro. <p><strong>Example:</strong> <code>glyph todo</code></p> </section> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">← Macro Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/stats/bookmarks.html
→
content/glyph/book/stats/bookmarks.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Bookmark Statistics - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/stats/snippets.html">Snippet Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/links.html">Link Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/snippets.html">← Snippet Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/links.html">Link Statistics →</a></nav> <section class="section"> -<header><h1 id="h_72">Displaying stats about all bookmarks</h1></header> +<header><h1 id="h_72" class="toc">Displaying stats about all bookmarks</h1></header> <p>To display statistics about all bookmarks, execute <code>glyph stats --bookmarks</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Bookmarks@@ -92,12 +89,11 @@ <span class="line-numbers"><a href="#n19" name="n19">19</a></span>-- Unreferenced Bookmarks:
<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> c_help cmd_ref expanded_values extending h_1 <span class="line-numbers"><a href="#n21" name="n21">21</a></span> h_10 h_102 h_105 h_107 h_109 <span class="line-numbers"><a href="#n22" name="n22">22</a></span> h_111 h_112 h_114 h_115 h_117 -<span class="line-numbers"><a href="#n23" name="n23">23</a></span>[...] -</pre></div> +<span class="line-numbers"><a href="#n23" name="n23">23</a></span>[...]</pre></div> </div> <section class="section"> -<header><h1 id="h_73">Remarks</h1></header> +<header><h1 id="h_73" class="toc">Remarks</h1></header> <ul> <li>All the automatically-generated bookmarks (like headers, starting with <code>h_</code>) are included as well.</li> </ul>@@ -107,7 +103,7 @@
</section> <section class="section"> -<header><h1 id="h_74">Displaying stats about a single bookmark</h1></header> +<header><h1 id="h_74" class="toc">Displaying stats about a single bookmark</h1></header> <p>To display statistics about a single bookmark (e.g. <code>rubydoc</code>), execute <code>glyph stats --bookmark=c_config</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>===== Bookmark 'c_config' (header)@@ -115,12 +111,11 @@ <span class="line-numbers"><a href="#n2" name="n2">2</a></span>-- Defined in: text/ref_commands.glyph
<span class="line-numbers"><a href="#n3" name="n3">3</a></span>-- Referenced in: <span class="line-numbers"><a href="#n4" name="n4">4</a></span> - text/changelog.glyph (2) <span class="line-numbers"><a href="#n5" name="n5">5</a></span> - text/getting_started/configuration.glyph (1) -<span class="line-numbers"><a href="#n6" name="n6">6</a></span> - text/troubleshooting/errors_command.glyph (3) -</pre></div> +<span class="line-numbers"><a href="#n6" name="n6">6</a></span> - text/troubleshooting/errors_command.glyph (3)</pre></div> </div> <section class="section"> -<header><h1 id="h_75">Remarks</h1></header> +<header><h1 id="h_75" class="toc">Remarks</h1></header> <ul> <li>Do not prepend the bookmark ID with <code>#</code>.</li> </ul>@@ -128,41 +123,21 @@
</section> </section> - <nav class="navigation"><a href="/glyph/book/stats/snippets.html">Snippet Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/links.html">Link Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/snippets.html">← Snippet Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/links.html">Link Statistics →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/stats/links.html
→
content/glyph/book/stats/links.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Link Statistics - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/bookmarks.html">← Bookmark Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals →</a></nav> <section class="section"> -<header><h1 id="h_77">Displaying stats about all links</h1></header> +<header><h1 id="h_77" class="toc">Displaying stats about all links</h1></header> <p>To display statistics about all links, execute <code>glyph stats --links</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Links@@ -88,25 +85,24 @@ <span class="line-numbers"><a href="#n15" name="n15">15</a></span> - #cfg_filters
<span class="line-numbers"><a href="#n16" name="n16">16</a></span>[...] <span class="line-numbers"><a href="#n17" name="n17">17</a></span>-- Total External Links: 95 <span class="line-numbers"><a href="#n18" name="n18">18</a></span>-- External Links -<span class="line-numbers"><a href="#n19" name="n19">19</a></span> - <span class="error">&</span>[rubydoc]/Glyph -<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> - <span class="error">&</span>[rubydoc]/Glyph/Document -<span class="line-numbers"><a href="#n21" name="n21">21</a></span> - <span class="error">&</span>[rubydoc]/Glyph/Interpreter -<span class="line-numbers"><a href="#n22" name="n22">22</a></span> - <span class="error">&</span>[rubydoc]/Glyph/Macro -<span class="line-numbers"><a href="#n23" name="n23">23</a></span> - <span class="error">&</span>[rubydoc]/Glyph/Macro/Validators -<span class="line-numbers"><a href="#n24" name="n24">24</a></span> - <span class="error">&</span>[rubydoc]/Glyph/Macro:update_source -<span class="line-numbers"><a href="#n25" name="n25">25</a></span> - <span class="error">&</span>[rubydoc]/Glyph/MacroNode -<span class="line-numbers"><a href="#n26" name="n26">26</a></span> - <span class="error">&</span>[rubydoc]/Glyph/Parser -<span class="line-numbers"><a href="#n27" name="n27">27</a></span> - <span class="error">&</span>[rubydoc]/Glyph/SyntaxNode -<span class="line-numbers"><a href="#n28" name="n28">28</a></span> - <span class="error">&</span>[rubydoc]/Macro +<span class="line-numbers"><a href="#n19" name="n19">19</a></span> - &[rubydoc]/Glyph +<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> - &[rubydoc]/Glyph/Document +<span class="line-numbers"><a href="#n21" name="n21">21</a></span> - &[rubydoc]/Glyph/Interpreter +<span class="line-numbers"><a href="#n22" name="n22">22</a></span> - &[rubydoc]/Glyph/Macro +<span class="line-numbers"><a href="#n23" name="n23">23</a></span> - &[rubydoc]/Glyph/Macro/Validators +<span class="line-numbers"><a href="#n24" name="n24">24</a></span> - &[rubydoc]/Glyph/Macro:update_source +<span class="line-numbers"><a href="#n25" name="n25">25</a></span> - &[rubydoc]/Glyph/MacroNode +<span class="line-numbers"><a href="#n26" name="n26">26</a></span> - &[rubydoc]/Glyph/Parser +<span class="line-numbers"><a href="#n27" name="n27">27</a></span> - &[rubydoc]/Glyph/SyntaxNode +<span class="line-numbers"><a href="#n28" name="n28">28</a></span> - &[rubydoc]/Macro <span class="line-numbers"><a href="#n29" name="n29">29</a></span> - http://code.google.com/p/wkhtmltopdf/ <span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span> - http://coderay.rubychan.de/ <span class="line-numbers"><a href="#n31" name="n31">31</a></span> - http://coderay.rubychan.de/doc/classes/CodeRay/Encoders/HTML.html -<span class="line-numbers"><a href="#n32" name="n32">32</a></span>[...] -</pre></div> +<span class="line-numbers"><a href="#n32" name="n32">32</a></span>[...]</pre></div> </div> <section class="section"> -<header><h1 id="h_78">Remarks</h1></header> +<header><h1 id="h_78" class="toc">Remarks</h1></header> <ul> <li>The only criteria used to determine if a link is internal is whether it starts with a <code>#</code> or not.</li> </ul>@@ -116,7 +112,7 @@
</section> <section class="section"> -<header><h1 id="h_79">Displaying stats about links matching a regular expression</h1></header> +<header><h1 id="h_79" class="toc">Displaying stats about links matching a regular expression</h1></header> <p>To display statistics about links matching a regular expression (e.g. <code>/c_/</code>), execute <code>glyph stats --link=c_</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Links matching /c_/@@ -156,12 +152,11 @@ <span class="line-numbers"><a href="#n34" name="n34">34</a></span> - #c_todo (1)
<span class="line-numbers"><a href="#n35" name="n35">35</a></span> - text/macros/macros_inline.glyph (1) <span class="line-numbers"><a href="#n36" name="n36">36</a></span> - #esc_quot (2) <span class="line-numbers"><a href="#n37" name="n37">37</a></span> - text/extending/macro_def.glyph (1) -<span class="line-numbers"><a href="#n38" name="n38">38</a></span> - text/text_editing/macro_intro.glyph (1) -</pre></div> +<span class="line-numbers"><a href="#n38" name="n38">38</a></span> - text/text_editing/macro_intro.glyph (1)</pre></div> </div> <section class="section"> -<header><h1 id="h_80">Remarks</h1></header> +<header><h1 id="h_80" class="toc">Remarks</h1></header> <ul> <li>No distinction between external and internal targets is made.</li> </ul>@@ -169,41 +164,21 @@
</section> </section> - <nav class="navigation"><a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/bookmarks.html">← Bookmark Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/internals.html">A quick look at Glyph's internals →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/stats/macros.html
→
content/glyph/book/stats/macros.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Macro Statistics - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/stats/stats.html">Using the stats command</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/snippets.html">Snippet Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/stats.html">← Using the stats command</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/snippets.html">Snippet Statistics →</a></nav> <section class="section"> -<header><h1 id="h_62">Displaying stats about all macros</h1></header> +<header><h1 id="h_62" class="toc">Displaying stats about all macros</h1></header> <p>To display statistics about all macros, execute <code>glyph stats --macros</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Macros@@ -76,7 +73,7 @@ <span class="line-numbers"> <a href="#n3" name="n3">3</a></span>-- Total Macro Definitions: 65
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>-- Total Macro Aliases: 57 <span class="line-numbers"> <a href="#n5" name="n5">5</a></span>-- Total Used Macro Definitions: 56 <span class="line-numbers"> <a href="#n6" name="n6">6</a></span>-- Macro Definitions: -<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> #<span class="error">></span> $<span class="error">></span> %<span class="error">></span> alias: aliases +<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> #> $> %> alias: aliases <span class="line-numbers"> <a href="#n8" name="n8">8</a></span> anchor and article author block_example <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> book box class codeblock comment <span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> condition config config: config_table default@@ -91,7 +88,7 @@ <span class="line-numbers"><a href="#n18" name="n18">18</a></span> snippet: stats_for style subtitle textile
<span class="line-numbers"><a href="#n19" name="n19">19</a></span> title toc todo values |xml| <span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> <span class="line-numbers"><a href="#n21" name="n21">21</a></span>-- Used Macro Definitions: -<span class="line-numbers"><a href="#n22" name="n22">22</a></span> #<span class="error">></span> $<span class="error">></span> %<span class="error">></span> aliases anchor +<span class="line-numbers"><a href="#n22" name="n22">22</a></span> #> $> %> aliases anchor <span class="line-numbers"><a href="#n23" name="n23">23</a></span> and author block_example book box <span class="line-numbers"><a href="#n24" name="n24">24</a></span> class codeblock comment condition config <span class="line-numbers"><a href="#n25" name="n25">25</a></span> config_table default document eq error_table@@ -102,12 +99,11 @@ <span class="line-numbers"><a href="#n29" name="n29">29</a></span> parameters pubdate ref_config ref_error ref_macro
<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span> release revision rewrite: ruby section <span class="line-numbers"><a href="#n31" name="n31">31</a></span> snippet snippet: stats_for style subtitle <span class="line-numbers"><a href="#n32" name="n32">32</a></span> textile title toc todo values -<span class="line-numbers"><a href="#n33" name="n33">33</a></span> |xml| -</pre></div> +<span class="line-numbers"><a href="#n33" name="n33">33</a></span> |xml|</pre></div> </div> <section class="section"> -<header><h1 id="h_63">Remarks</h1></header> +<header><h1 id="h_63" class="toc">Remarks</h1></header> <ul> <li>Only macro <em>definitions</em> (not their <em>aliases</em>) are displayed, both default and user-defined.</li> <li>The <code>|xml|</code> macro is a special macro used if the <a href="/glyph/book/config/options.html#s_options_xml_fallback"><code>options.xml_fallback</code></a> setting is enabled.</li>@@ -119,7 +115,7 @@
</section> <section class="section"> -<header><h1 id="h_64">Displaying stats about a single macro</h1></header> +<header><h1 id="h_64" class="toc">Displaying stats about a single macro</h1></header> <p>To display statistics about a single macro (e.g. <code>note</code>), execute <code>glyph stats --macro=note</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Macro 'note'@@ -137,12 +133,11 @@ <span class="line-numbers"><a href="#n12" name="n12">12</a></span> - text/text_editing/inclusions.glyph (3)
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> - text/text_editing/links.glyph (1) <span class="line-numbers"><a href="#n14" name="n14">14</a></span> - text/text_editing/raw_html.glyph (1) <span class="line-numbers"><a href="#n15" name="n15">15</a></span> - text/text_editing/section_aliases.glyph (1) -<span class="line-numbers"><a href="#n16" name="n16">16</a></span> - text/text_editing/xml_fallback.glyph (2) -</pre></div> +<span class="line-numbers"><a href="#n16" name="n16">16</a></span> - text/text_editing/xml_fallback.glyph (2)</pre></div> </div> <section class="section"> -<header><h1 id="h_65">Remarks</h1></header> +<header><h1 id="h_65" class="toc">Remarks</h1></header> <ul> <li>All the instances of the specified macro definition <em>and all its aliases</em> are collected, regardless whether a definition or an alias is specified.</li> <li>If you use custom macros, make sure they call the <a href="http://rubydoc.info/gems/glyph/Glyph/Macro:update_source">Macro#update_source</a> appropriately method if necessary.</li>@@ -152,41 +147,21 @@
</section> </section> - <nav class="navigation"><a href="/glyph/book/stats/stats.html">Using the stats command</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/snippets.html">Snippet Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/stats.html">← Using the stats command</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/snippets.html">Snippet Statistics →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/stats/snippets.html
→
content/glyph/book/stats/snippets.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Snippet Statistics - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,10 +61,10 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/stats/macros.html">Macro Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/macros.html">← Macro Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics →</a></nav> <section class="section"> -<header><h1 id="h_67">Displaying stats about all snippets</h1></header> +<header><h1 id="h_67" class="toc">Displaying stats about all snippets</h1></header> <p>To display statistics about all snippets, execute <code>glyph stats --snippets</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Snippets@@ -85,12 +82,11 @@ <span class="line-numbers"><a href="#n12" name="n12">12</a></span> bin_params called_on_files coderay filter_by_ext
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> glang htmlcode img_attrs img_file <span class="line-numbers"><a href="#n14" name="n14">14</a></span> markups only_after_declaration only_defined_through opt <span class="line-numbers"><a href="#n15" name="n15">15</a></span> referenced_with_path sq_esc unsafe uv -<span class="line-numbers"><a href="#n16" name="n16">16</a></span> rubydoc -</pre></div> +<span class="line-numbers"><a href="#n16" name="n16">16</a></span> rubydoc</pre></div> </div> <section class="section"> -<header><h1 id="h_68">Remarks</h1></header> +<header><h1 id="h_68" class="toc">Remarks</h1></header> <ul> <li>Information on snippet usage and definitions is available only when displaying statistics for a single snippet.</li> </ul>@@ -100,7 +96,7 @@
</section> <section class="section"> -<header><h1 id="h_69">Displaying stats about a single snippet</h1></header> +<header><h1 id="h_69" class="toc">Displaying stats about a single snippet</h1></header> <p>To display statistics about a single snippet (e.g. <code>rubydoc</code>), execute <code>glyph stats --snippet=rubydoc</code>. Glyph displays something like this:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>===== Snippet 'rubydoc'@@ -116,12 +112,11 @@ <span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> - text/extending/internals.glyph (5)
<span class="line-numbers"><a href="#n11" name="n11">11</a></span> - text/extending/macro_def.glyph (3) <span class="line-numbers"><a href="#n12" name="n12">12</a></span> - text/extending/validators.glyph (1) <span class="line-numbers"><a href="#n13" name="n13">13</a></span> - text/macros/macros_core.glyph (2) -<span class="line-numbers"><a href="#n14" name="n14">14</a></span> - text/stats/macros.glyph (1) -</pre></div> +<span class="line-numbers"><a href="#n14" name="n14">14</a></span> - text/stats/macros.glyph (1)</pre></div> </div> <section class="section"> -<header><h1 id="h_70">Remarks</h1></header> +<header><h1 id="h_70" class="toc">Remarks</h1></header> <ul> <li>Nested snippets appear as within the file containing the top-level snippet.</li> </ul>@@ -129,41 +124,21 @@
</section> </section> - <nav class="navigation"><a href="/glyph/book/stats/macros.html">Macro Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/stats/macros.html">← Macro Statistics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/bookmarks.html">Bookmark Statistics →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/stats/stats.html
→
content/glyph/book/stats/stats.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Using the stats command - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">← Using Glyph programmatically</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics →</a></nav> <p>Glyph includes a <a href="/glyph/book/ref_commands.html#c_stats"><code>stats</code></a> command that can be used to display useful statistics about your Glyph project. If you try running Glyph's command help, you'll see that this command can take quite a few options: </p>@@ -84,8 +81,7 @@ <span class="line-numbers"><a href="#n12" name="n12">12</a></span> --link=arg - Display stats about links matching a regular expression
<span class="line-numbers"><a href="#n13" name="n13">13</a></span> -m, --macros - Display stats about macros <span class="line-numbers"><a href="#n14" name="n14">14</a></span> --macro=arg - Display stats about a single macro <span class="line-numbers"><a href="#n15" name="n15">15</a></span> -s, --snippets - Display stats about snippets -<span class="line-numbers"><a href="#n16" name="n16">16</a></span> --snippet=arg - Display stats about a single snippet -</pre></div> +<span class="line-numbers"><a href="#n16" name="n16">16</a></span> --snippet=arg - Display stats about a single snippet</pre></div> </div> <p>If no options are specified, the command returns a summary containing different element totals, i.e.:</p>@@ -128,45 +124,24 @@ <span class="line-numbers"><a href="#n27" name="n27">27</a></span>-- Total Unreferenced Bookmarks: 135
<span class="line-numbers"><a href="#n28" name="n28">28</a></span> <span class="line-numbers"><a href="#n29" name="n29">29</a></span>===== Links <span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span>-- Total Internal Links: 87 -<span class="line-numbers"><a href="#n31" name="n31">31</a></span>-- Total External Links: 97 -</pre></div> +<span class="line-numbers"><a href="#n31" name="n31">31</a></span>-- Total External Links: 97</pre></div> </div> - <nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">Using Glyph programmatically</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics</a></nav> + <nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">← Using Glyph programmatically</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
D
content/glyph/book/styles/default.css
@@ -1,255 +0,0 @@
-* { - font-family: inherit; - border: none; - font-size: 100%; - font-style: inherit; - margin: 0; - padding: 0; } - -html { - background: #fff; } - -ol, ul { - margin: 0.3em 0; } - -p { - margin: 1em 0; } - -table { - border-collapse: collapse; - border-spacing: 0; - margin: auto; - margin-top: 1em; } - -body { - line-height: 1.2em; - margin: 0; - padding: 0; - padding: 0 1em; - text-align: justify; } - -/* Structure */ -.halftitlepage { - margin: auto; - text-align: center; } - -.titlepage { - margin: auto; - text-align: center; } - .titlepage h1 { - font-size: 2.5em; - font-weight: bold; - line-height: 1.5em; - margin-bottom: 0.2em; } - -.halftitlepage h1 { - font-size: 2.5em; - font-weight: bold; - line-height: 1.5em; - margin-bottom: 0.2em; } -.halftitlepage h2 { - font-size: 1.1em; - font-style: italic; - font-weight: bold; - line-height: 1.2em; - margin-bottom: 0.5em; - prince-bookmark-level: none; } - -.titlepage h2 { - font-size: 1.1em; - font-style: italic; - font-weight: bold; - line-height: 1.2em; - margin-bottom: 0.5em; - prince-bookmark-level: none; } - -.author { - font-size: 1em; } - -.pubdate { - font-size: 0.8em; } - -li { - list-style-type: square; - margin: 0.4em 0; - margin-left: 1.5em; } - -ol li { - list-style-type: decimal; } - -.contents li { - list-style-type: none; } - -img { - margin: 0 5px; - padding: 2px; } - -dt { - font-weight: bold; - margin-top: 1em; } - -dd { - font-style: italic; } - -blockquote { - margin: 1em 1em; - font-style: italic; - color: #121212; } - -table { - border: 1px solid #e6e6e6; } - -th { - background: #EEE; } - -tr, td, th { - padding: 5px; } - -td, tr { - border: 1px solid #e6e6e6; } - -sup { - font-size: 0.7em; - font-weight: bold; - margin-left: -0.4em; } - -/* BLOCKS */ -.center { - margin: auto; - text-align: center; } - -.left { - margin: auto; - text-align: left; } - -.right { - margin: auto; - text-align: center; } - -.note, .important, .tip, .caution, .box { - border: 1px solid #e6e6e6; - display: block; - margin: 0.5em auto; - padding: 0 0.5em; - width: 600px; - background: #EEE; - color: #1F1F1F; } - -.note > p, .important > p, .tip > p, .caution > p { - margin: 0; - padding: 0; } - -.note-title { - font-weight: bold; - margin-right: 1em; } - -.box-title { - display: block; - text-align: center; - font-weight: bold; } - -.comment { - display: block; - border: 1px solid #004D00; - background: #7AFF7A; - padding: 3px; - margin: 1px; } - .comment .comment-pre { - color: #004D00; } - -.todo { - display: block; - border: 1px solid #990000; - background: #FF9999; - padding: 3px; - margin: 1px; } - .todo .todo-pre { - color: #990000; } - -/* TEXT */ -body { - color: #000; - font-size: 1em; } - -h2, section section h1, h1.toc-header { - display: block; - font-size: 2em; - font-weight: bold; - margin: 3em 0 1em 0; } - -h3, section section section h1 { - font-size: 1.6em; - font-weight: bold; - margin: 3em 0 1em 0; } - -h4, section section section section h1 { - font-size: 1.3em; - font-weight: bold; - margin: 3em 0 1em 0; } - -h5, section section section section section h1 { - font-size: 1.2em; - font-weight: bold; - margin: 3em 0 1em 0; } - -em { - font-style: italic; } - -a { - color: #007bc4; - text-decoration: none; } - a:hover { - color: #005b91; } - -.code > pre { - -webkit-border-radius: 5px; - -moz-border-radius: 5px; - border-radius: 5px; - color: #222; - padding: 20px; - overflow: auto hidden; - margin: 20px 0 20px 0; } - -code, .CodeRay { - font-size: 0.8em; } - -span.line-numbers { - margin: 0; - padding: 3px; } - -nav, .navigation { - display: block; - margin: 1em auto; - text-align: center; - border: 1px solid #e6e6e6; } - -nav.contents { - margin: auto; - text-align: left; - border: none; } -nav a { - margin: 1em; } - -.navigation a { - margin: 1em; } - -nav.contents a { - margin: 0; } - -mark { - font-weight: bolder; - font-style: italic; - background: none; } - -td p, td ul, td ol { - margin: 0; } - -.topic { - margin: 2em auto; } - -/* FONTS */ -body { - font-family: "Gentium Book Basic", "Book Antiqua", "Times New Roman", "Serif"; } - -code, pre { - font-family: "Droid Sans Mono", "Consolas", "Monaco", "Courier", "Monospace"; }
M
content/glyph/book/text_editing/attribute_intro.html
→
content/glyph/book/text_editing/attribute_intro.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Macro attributes - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,13 +61,12 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_composition.html">Macro Composition</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/macro_intro.html">← Introducing Glyph Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_composition.html">Macro Composition →</a></nav> <p>Although a macro can take any number of parameters, they are often no more than two or three, for readibility reasons: parameters have no name, but their position within a macro is significant.</p> <p>If you have something like this:</p> <div class="CodeRay"> - <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>custom_image[test.png|50%|50%|Test Image] -</pre></div> + <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>custom_image[test.png|50%|50%|Test Image]</pre></div> </div> <p>it may still be easy enough to understand what each parameter is used for, but:</p>@@ -84,8 +80,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>image[test.png
<span class="line-numbers"><a href="#n2" name="n2">2</a></span> @width[50%] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @alt[Test Image] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> @height[50%] -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> <p>More verbose, of course, but definitely more readable. In this way, if you won't want to scale an image, you can safely omit the <code>@width</code> and <code>@height</code> attributes.</p>@@ -93,41 +88,21 @@ <aside class="note">
<span class="note-title">Note</span>Like parameters, attributes can contain other macros, too. </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_composition.html">Macro Composition</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/macro_intro.html">← Introducing Glyph Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_composition.html">Macro Composition →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/code.html
→
content/glyph/book/text_editing/code.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Source Code - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/images.html">Images and Figures</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/images.html">← Images and Figures</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown →</a></nav> <p>If you’re a programmer, chances are that you’re going to include some source code in your articles and books. Glyph offers two ways to format code blocks effortlessly: the <a href="/glyph/book/macros/macros_block.html#m_codeblock"><code>codeblock</code></a> macro, which simply wraps text into <code><pre></code> and <code><code></code> tags, or the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a> macro. The last one requires either <a href="http://coderay.rubychan.de/">Coderay</a> or <a href="http://ultraviolet.rubyforge.org/">Ultraviolet</a>, but it provides syntax highlighting for the most common programming languages.</p> <p>Cosider the following piece of ruby code:</p> <div class="CodeRay">@@ -75,8 +72,7 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> return node if block.call(node)
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> end <span class="line-numbers"><a href="#n6" name="n6">6</a></span> end <span class="line-numbers"><a href="#n7" name="n7">7</a></span> nil -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>end -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>end</pre></div> </div> <p>It can be wrapped in a highlight macro, like so:</p>@@ -90,8 +86,7 @@ <span class="line-numbers"> <a href="#n6" name="n6">6</a></span> end
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span> end <span class="line-numbers"> <a href="#n8" name="n8">8</a></span> nil <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> end -<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>=] -</pre></div> +<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>=]</pre></div> </div> <p>...to produce the following, using the coderay highlighter:</p>@@ -103,8 +98,7 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> <span class="keyword">return</span> node <span class="keyword">if</span> block.call(node)
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> <span class="keyword">end</span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span> <span class="keyword">end</span> <span class="line-numbers"><a href="#n7" name="n7">7</a></span> <span class="predefined-constant">nil</span> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="keyword">end</span></pre></div> </div> <aside class="box">@@ -116,41 +110,21 @@ <li>You must always escape pipes (<code>|</code>) with the code or the highlight macro.</li>
</ul> </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/images.html">Images and Figures</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/images.html">← Images and Figures</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/conditionals.html
→
content/glyph/book/text_editing/conditionals.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Conditional Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/inclusions.html">Content Reuse</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/inclusions.html">← Content Reuse</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation →</a></nav> <p>Sometimes you may want text to be included in a document only if certain conditions are satisfied. For example, you may want to display a disclaimer section only if the document is a draft (see the <a href="/glyph/book/config/document.html#s_document_draft"><code>document.draft</code></a> setting), or use a particular stylesheet only if when you generate a <span class="caps">PDF</span> document.</p> <p>To do so, you can use the <a href="/glyph/book/macros/macros_core.html#m_condition"><code>condition</code></a> macro (aliased by <code>?</code>), and a set of additional macros that can be used as conditional operators i.e.:</p> <ul>@@ -77,8 +74,7 @@ <p>Consider the following code:</p>
<div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>?[$[document.draft]| <span class="line-numbers"><a href="#n2" name="n2">2</a></span>This is a first draft of the Glyph Book| -<span class="line-numbers"><a href="#n3" name="n3">3</a></span>This is the official version of the Glyph Book] -</pre></div> +<span class="line-numbers"><a href="#n3" name="n3">3</a></span>This is the official version of the Glyph Book]</pre></div> </div> <p>In this case, if <code>document.draft</code> is set to <code>true</code>, “This is a first draft of the Glyph Book” will be displayed; if not, “This is the official version of the Glyph Book” will be displayed instead.</p>@@ -96,13 +92,12 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span> |
<span class="line-numbers"><a href="#n4" name="n4">4</a></span> eq[$[tools.pdf_generator]|prince] <span class="line-numbers"><a href="#n5" name="n5">5</a></span> ] <span class="line-numbers"><a href="#n6" name="n6">6</a></span> | -<span class="line-numbers"><a href="#n7" name="n7">7</a></span> style[pagination.css]] -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span> style[pagination.css]]</pre></div> </div> <p>In this case, the <code>pagination.css</code> stylesheet is included only when you're generating a PDF document using Prince XML.</p> <section class="section"> -<header><h1 id="h_42">Results of conditional expressions</h1></header> +<header><h1 id="h_42" class="toc">Results of conditional expressions</h1></header> <p>The <a href="/glyph/book/macros/macros_core.html#m_condition"><code>condition</code></a> macro in Glyph works in a similar way as conditionals in programming languages: if the conditional expression (supplied as first parameter) is satisfied then the second parameter is executed or displayed. But when is a conditional expression satisfied? Glyph is a simple mini-language to perform text manipulation, and has no types, it can only understand text, therefore:</p> <ul> <li>A conditional expression is satisfied if it evaluates to a non-empty string except “false”.</li>@@ -110,41 +105,21 @@ <li>A conditional expression is not satisfied if it evaluates to an empty string or the string “false”.</li>
</ul> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/inclusions.html">Content Reuse</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/inclusions.html">← Content Reuse</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/evaluation.html">Simple Programming and Code Evaluation →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/esc_quot.html
→
content/glyph/book/text_editing/esc_quot.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Escaping and Quoting - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/macro_composition.html">Macro Composition</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/sections.html">Sections and Headers</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/macro_composition.html">← Macro Composition</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/sections.html">Sections and Headers →</a></nav> <p>Glyph doesn’t require any special control characters like LaTeX, and its macro syntax is very straightforward and liberal. This however comes with a price: because square brackets are used as delimiters, you must escape any square bracket in your text with a backslash. That’s not <em>too</em> bad if you think about it, unless you’re writing programming code, in which case escaping every single square bracket can be painful.</p> <p>If a portion of your text contains an excessive amount of square brackets, you may consider using the <a href="/glyph/book/macros/macros_core.html#m_escape"><code>escape</code></a> macro (or its alias <code>.</code>) with the <code>[=</code> and <code>=]</code> delimiters. By itself, the escape macro doesn’t do anything: it just evaluates to its contents, but the special delimiters act as an escape for any square bracket within them. As a consequence, any macro within <code>[=</code> and <code>=]</code> will <em>not</em> be evaluated.</p> <p>You can use the quoting delimiters with <em>any</em> macro identifier. Obviously, using them as delimiters for things like <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macros may not be a good idea, but they should be more or less mandatory with the <a href="/glyph/book/macros/macros_block.html#m_codeblock"><code>codeblock</code></a> macro or the <a href="/glyph/book/macros/macros_filters.html#m_highlight"><code>highlight</code></a> macro, especially when it contains square brackets or even Glyph code, like this:</p>@@ -80,8 +77,7 @@ <span class="line-numbers"> <a href="#n7" name="n7">7</a></span> @title[A nested section]
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span>This is another section. <span class="line-numbers"> <a href="#n9" name="n9">9</a></span> ] <span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span> ] -<span class="line-numbers"><a href="#n11" name="n11">11</a></span>=] -</pre></div> +<span class="line-numbers"><a href="#n11" name="n11">11</a></span>=]</pre></div> </div>@@ -156,41 +152,21 @@ <td>An escaped dot evaluates to nothing. Useful to separate macro identifiers from other characters: <br /><code>_\/=>[#link|This link is emphasized using Textile]_ </code>
</td> </tr> </table> - <nav class="navigation"><a href="/glyph/book/text_editing/macro_composition.html">Macro Composition</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/sections.html">Sections and Headers</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/macro_composition.html">← Macro Composition</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/sections.html">Sections and Headers →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/evaluation.html
→
content/glyph/book/text_editing/evaluation.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Simple Programming and Code Evaluation - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,9 +61,9 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/conditionals.html">Conditional Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/compiling.html">Compiling a project</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/conditionals.html">← Conditional Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/compiling.html">Compiling a project →</a></nav> <section class="section"> -<header><h1 id="h_44">Turing-completeness</h1></header> +<header><h1 id="h_44" class="toc">Turing-completeness</h1></header> <p>As of version 0.5.0, Glyph can be considered <em>Turing-complete</em>, as it satisfies the following <a href="http://c2.com/cgi/wiki?LanguageRequirementsForTuringCompleteness">requirements for Turing-completeness</a>:</p> <ul> <li>A conditional construct, implemented via the <a href="/glyph/book/macros/macros_core.html#m_condition"><code>condition</code></a> macro.</li>@@ -78,25 +75,28 @@
</section> <section class="section"> -<header><h1 id="h_45">Operations on integer values</h1></header> -<p>Glyph can be used to perform operation on integer values (additions, subtractions and multiplications). For example, <code>add[2|3|7]</code> will evaluate to <code>12</code>, and <code>multiply[add[3|7]|subtract[5|1|2]]</code> will return 20.</p> -<p>As a more complex example, consider the following <code>factorial</code> macro, which is able to calculate the factorial of a number recursively:</p> -<div class="CodeRay"> - <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>def:[factorial|<br /> -<span class="line-numbers"><a href="#n2" name="n2">2</a></span> ?[<br /> -<span class="line-numbers"><a href="#n3" name="n3">3</a></span> eq[|0]|1|<br /> -<span class="line-numbers"><a href="#n4" name="n4">4</a></span> multiply[<br /> -<span class="line-numbers"><a href="#n5" name="n5">5</a></span> | factorial[subtract[|1]]<br /> -<span class="line-numbers"><a href="#n6" name="n6">6</a></span> ]<br /> -<span class="line-numbers"><a href="#n7" name="n7">7</a></span> ]<br /> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>]<br /> -</pre></div> +<header><h1 id="h_45" class="toc">Operations on integer values</h1></header> +<p>Glyph can be used to perform operation on integer values (additions, subtractions and multiplications). For example, <code>add[2|3|7]</code> will evaluate to @12@, and <code>multiply[add[3|7]|subtract[5|1|2]]</code> will return 20.</p> + +<p>As a more complex example, consider the following @factorial@ macro, which is able to calculate the factorial of a number recursively:</p> + + <div class="CodeRay"> + <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>def:[factorial| +<span class="line-numbers"><a href="#n2" name="n2">2</a></span> ?[ +<span class="line-numbers"><a href="#n3" name="n3">3</a></span> eq[{{0}}|0]|1| +<span class="line-numbers"><a href="#n4" name="n4">4</a></span> multiply[ +<span class="line-numbers"><a href="#n5" name="n5">5</a></span> {{0}} | factorial[subtract[{{0}}|1]] +<span class="line-numbers"><a href="#n6" name="n6">6</a></span> ] +<span class="line-numbers"><a href="#n7" name="n7">7</a></span> ] +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>]</pre></div> </div> -<p>If you try executing <code>factorial[5]</code>, it will evaluate to <code>120</code>.</p> + + +<p>If you try executing <code>factorial[5]</code>, it will evaluate to @120@.</p> </section> <section class="section"> -<header><h1 id="h_46">Lexically-scoped attribute assignment</h1></header> +<header><h1 id="h_46" class="toc">Lexically-scoped attribute assignment</h1></header> <p><a href="/glyph/book/text_editing/inclusions.html#snippets">Snippets</a> can be used in a similar way as <em>variables</em> are used in programming languages. Or better, they can be used as <em>global variables</em>, as they are visible from anywhere in the Glyph document. If you need something more restricted to, say, a section and all its subsections, you can define your own attributes and use them in a very similar way.</p> <p>Consider the following Glyph code:</p>@@ -109,59 +109,38 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> section[
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> @title[Something more about attributes] <span class="line-numbers"><a href="#n6" name="n6">6</a></span>Attributes are like lexically scoped variables. You can use them to store @[a] and @[b]. <span class="line-numbers"><a href="#n7" name="n7">7</a></span> ] -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>]</pre></div> </div> <p>The <a href="/glyph/book/macros/macros_core.html#m_let"><code>let</code></a> macro here only acts as a dummy macro (it does nothing really) to bind attributes using the <a href="/glyph/book/macros/macros_core.html#m_attribute_"><code>attribute:</code></a> macro (aliased by <code>@:</code>). Attributes can then be used anywhere within the <code>let</code> macro, so the content of the section reads: “Attributes are like lexically-scoped variables. You can use them to store bits and bobs”.</p> <p>Note that attributes defined through the <a href="/glyph/book/macros/macros_core.html#m_attribute_"><code>attribute:</code></a> macro are… well, attributes! Feel free to use the <a href="/glyph/book/macros/macros_core.html#m_attribute"><code>attribute</code></a> macro to access standard attributes like <code>title</code>, etc.</p> <section class="section"> -<header><h1 id="h_47">Evaluating Ruby code</h1></header> +<header><h1 id="h_47" class="toc">Evaluating Ruby code</h1></header> <p>For anything more complex than what described in the previous sections you can also evaluate simple ruby code snippets using the <code>ruby</code> macro (aliased to <code>%</code>), like this:</p> <ul> <li><code>%[2 + 2]</code> → 4</li> - <li><code>%[Time.now]</code> → 2011-12-04 15:00:43 +0100</li> - <li><code>%[Glyph::VERSION]</code> → 0.5.1</li> + <li><code>%[Time.now]</code> → 2012-11-02 10:57:48 +0100</li> + <li><code>%[Glyph::VERSION]</code> → 0.6.0</li> </ul> <p>The scope for the code evaluation is the Kernel module, (with all inclusions required by Glyph itself).</p> <p>Although it is possible to retrieve Glyph configuration settings in this way (e.g. <code>%[cfg('document.author')]</code>), the <a href="/glyph/book/macros/macros_core.html#m_config"><code>config</code></a> macro (aliased to <code>$</code>) makes things slightly simpler (e.g. <code>$[document.author]</code>).</p> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/conditionals.html">Conditional Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/compiling.html">Compiling a project</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/conditionals.html">← Conditional Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/compiling/compiling.html">Compiling a project →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/glyph_files.html
→
content/glyph/book/text_editing/glyph_files.html
@@ -1,10 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>.glyph files - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - + <title><code>.glyph</code> files - Glyph</title> <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -58,51 +55,31 @@ </header>
<article class="page glyph-book"> <header> <hgroup> - <h1>.glyph files</h1> + <h1><code>.glyph</code> files</h1> <h2>Glyph</h2> </hgroup> </header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/getting_started/configuration.html">Project Configuration</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/getting_started/configuration.html">← Project Configuration</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros →</a></nav> <p>The <code>text</code> folder of any Glyph folder contains all the text source files used to produce a document. Although there are no restrictions on the extension of the files in this folder, you may want to use <code>.glyph</code>, especially if <a href="http://www.vim.org">Vim</a> is your favorite text editor.</p> <p>The reason is simple: a Glyph syntax file is <a href="http://www.vim.org/scripts/script.php?script_id=3086">available on vim.org</a>. Although not essential, syntax highlighting does help when editing Glyph files.</p> <p>If you use TextMate, you may want to check out Eric Givens’ <a href="http://github.com/darthzippy/glyph.tmbundle">Glyph TextMate Bundle</a>.</p> - <nav class="navigation"><a href="/glyph/book/getting_started/configuration.html">Project Configuration</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/getting_started/configuration.html">← Project Configuration</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/macro_intro.html">Introducing Glyph Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/images.html
→
content/glyph/book/text_editing/images.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Images and Figures - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/links.html">Links and Bookmarks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/code.html">Source Code</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/links.html">← Links and Bookmarks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/code.html">Source Code →</a></nav> <p>Same as for <a href="/glyph/book/text_editing/links.html#links">links</a>, you can also include images and figures using Textile or Markdown. If you want additional features, you can use the <a href="/glyph/book/macros/macros_block.html#m_image"><code>image</code></a> macro and the <a href="/glyph/book/macros/macros_block.html#m_figure"><code>figure</code></a> macro, as shown in the following example:</p> <aside class="box">@@ -79,8 +76,7 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @height[20%]
<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] <span class="line-numbers"><a href="#n5" name="n5">5</a></span>figure[example.png|An example figure. <span class="line-numbers"><a href="#n6" name="n6">6</a></span> @alt[Example Figure] -<span class="line-numbers"><a href="#n7" name="n7">7</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span>]</pre></div> </div> <p>@@ -91,8 +87,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span><span class="tag"><img</span> <span class="attribute-name">src</span>=<span class="string"><span class="delimiter">"</span><span class="content">images/glyph.svg</span><span class="delimiter">"</span></span> <span class="attribute-name">width</span>=<span class="string"><span class="delimiter">"</span><span class="content">20%</span><span class="delimiter">"</span></span> <span class="attribute-name">height</span>=<span class="string"><span class="delimiter">"</span><span class="content">20%</span><span class="delimiter">"</span></span> <span class="tag">/></span>
<span class="line-numbers"><a href="#n2" name="n2">2</a></span><span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">figure</span><span class="delimiter">"</span></span><span class="tag">></span> <span class="line-numbers"><a href="#n3" name="n3">3</a></span> <span class="tag"><img</span> <span class="attribute-name">src</span>=<span class="string"><span class="delimiter">"</span><span class="content">images/example.png</span><span class="delimiter">"</span></span> <span class="attribute-name">alt</span>=<span class="string"><span class="delimiter">"</span><span class="content">Example Figure</span><span class="delimiter">"</span></span><span class="tag">/></span> <span class="line-numbers"><a href="#n4" name="n4">4</a></span> <span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">caption</span><span class="delimiter">"</span></span><span class="tag">></span>An example figure.<span class="tag"></div></span> -<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="tag"></div></span> -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span><span class="tag"></div></span></pre></div> </div> <p>Any attribute passed to the <a href="/glyph/book/macros/macros_block.html#m_image"><code>image</code></a> macro or the <a href="/glyph/book/macros/macros_block.html#m_figure"><code>figure</code></a> macro is automatically passed to the underlying <code><img></code> tag.</p>@@ -102,41 +97,21 @@ <aside class="note">
<span class="note-title">Note</span>In future releases, figures will be numbered automatically and included in a <em>List of Figures</em> section. </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/links.html">Links and Bookmarks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/code.html">Source Code</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/links.html">← Links and Bookmarks</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/code.html">Source Code →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/inclusions.html
→
content/glyph/book/text_editing/inclusions.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Content Reuse - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,9 +61,9 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">← Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros →</a></nav> <section class="section"> -<header><h1 id="file-inclusions">File inclusions</h1></header> +<header><h1 id="file-inclusions" class="toc">File inclusions</h1></header> <p>If you’re authoring a user manual, a long article, or a book, writing everything inside a single <code>document.glyph</code> file may not be optimal. For this reason, Glyph provides an <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro that can be used to include the contents of any file within the <code>text/</code> directory:</p> <p><code>include[general/introduction.textile]</code></p> <p>The macro call above loads the contents of the <code>introduction.textile</code> file, within the <code>text/general</code> directory.</p>@@ -77,7 +74,7 @@ <li><code>.markdown</code> or <code>.md</code> → <a href="/glyph/book/macros/macros_filters.html#m_markdown"><code>markdown</code></a> macro</li>
</ul> <p>You can override this behavior by setting the <code>filters.by_file_extensions</code> configuration setting to <code>false</code>. If no extension is specified, <code>.glyph</code> is assumed.</p> <section class="section"> -<header><h1 id="h_39">Remarks</h1></header> +<header><h1 id="h_39" class="toc">Remarks</h1></header> <ul> <li>The <a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro can also be used to include (and evaluate) ruby files (with a <code>.rb</code> extension). In this case, the ruby file must be placed within the <code>lib/</code> directory of the current project.</li> <li>The <a href="/glyph/book/macros/macros_core.html#m_load"><code>load</code></a> macro macro can be used to include the content of any file <em>without</em> performing any evaluation.</li>@@ -87,14 +84,13 @@ </section>
</section> <section class="section"> -<header><h1 id="snippets">Snippets</h1></header> +<header><h1 id="snippets" class="toc">Snippets</h1></header> <p>While including the context of an entire file is definitely a useful feature for content reuse, sometimes it can be an overkill. What if, for example, you just want to reuse a short procedure or even a sentence or a single word? In this case, you may want to consider using a <em>snippet</em> instead.</p> <p>Snippets can be defined using the <a href="/glyph/book/macros/macros_core.html#m_snippet_"><code>snippet:</code></a> macro (aliased by <code>&:</code>) and called by using the <a href="/glyph/book/macros/macros_core.html#m_snippet"><code>snippet</code></a> macro (aliased by <code>&</code>). Consider the following simple example:</p> <div class="CodeRay"> - <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span><span class="error">&</span>:[markups|Textile or Markdown] + <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>&:[markups|Textile or Markdown] <span class="line-numbers"><a href="#n2" name="n2">2</a></span> -<span class="line-numbers"><a href="#n3" name="n3">3</a></span>Glyph supports <span class="error">&</span>[markups]. -</pre></div> +<span class="line-numbers"><a href="#n3" name="n3">3</a></span>Glyph supports &[markups].</pre></div> </div> <p>You can use <code>&[markups]</code> anywhere in your document instead of having to type "Textile or Markdown" every time. Additionally, later on you can change the value of the <code>markups</code> to change it everywhere else in the document.</p>@@ -105,41 +101,21 @@ <span class="note-title">Tip</span>Snippets (or any other macro) can be nested within other snippets. Glyph takes care of checking if you nested snippets or macros mutually and warns you as necessary.
</aside> - <nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/stylesheets.html">← Adding Stylesheets</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/conditionals.html">Conditional Macros →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/links.html
→
content/glyph/book/text_editing/links.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Links and Bookmarks - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/topics.html">Topics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/images.html">Images and Figures</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/topics.html">← Topics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/images.html">Images and Figures →</a></nav> <p>Lightweight markups let you create internal and external links in a very easy way, and you can still do so in Glyph. However, if you do so:</p> <ul> <li>you can’t check if they are valid</li>@@ -84,8 +81,7 @@ <div class="CodeRay">
<div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>This is a link to link[#test]. <span class="line-numbers"><a href="#n2" name="n2">2</a></span>... <span class="line-numbers"><a href="#n3" name="n3">3</a></span>This is link[#wrong]. -<span class="line-numbers"><a href="#n4" name="n4">4</a></span>This is a #[test|test anchor]. -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>This is a #[test|test anchor].</pre></div> </div> <p>@@ -95,16 +91,14 @@ <div class="CodeRay">
<div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span><span class="tag"><p></span>This is a link to <span class="tag"><a</span> <span class="attribute-name">href</span>=<span class="string"><span class="delimiter">"</span><span class="content">#test</span><span class="delimiter">"</span></span><span class="tag">></span>test anchor<span class="tag"></a></span>.<span class="tag"></p></span> <span class="line-numbers"><a href="#n2" name="n2">2</a></span><span class="tag"><p></span>...<span class="tag"></p></span> <span class="line-numbers"><a href="#n3" name="n3">3</a></span><span class="tag"><p></span>This is <span class="tag"><a</span> <span class="attribute-name">href</span>=<span class="string"><span class="delimiter">"</span><span class="content">#wrong</span><span class="delimiter">"</span></span><span class="tag">></span>#wrong<span class="tag"></a></span>.<span class="tag"></p></span> -<span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="tag"><p></span>This is a <span class="tag"><a</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span><span class="tag">></span>test anchor<span class="tag"></a></span>.<span class="tag"></p></span> -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span><span class="tag"><p></span>This is a <span class="tag"><a</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">"</span><span class="content">test</span><span class="delimiter">"</span></span><span class="tag">></span>test anchor<span class="tag"></a></span>.<span class="tag"></p></span></pre></div> </div> <p>Additionally, the following warning message is displayed when <a href="/glyph/book/compiling/compiling.html#compile">compiling</a>:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>warning: Bookmark 'wrong' does not exist -<span class="line-numbers"><a href="#n2" name="n2">2</a></span> -<span class="error">></span> source: @: authoring.textile -<span class="line-numbers"><a href="#n3" name="n3">3</a></span> -<span class="error">></span> path: document/body/bodymatter/chapter/@/textile/section/section/box/link -</pre></div> +<span class="line-numbers"><a href="#n2" name="n2">2</a></span> -> source: @: authoring.textile +<span class="line-numbers"><a href="#n3" name="n3">3</a></span> -> path: document/body/bodymatter/chapter/@/textile/section/section/box/link</pre></div> </div> </aside>@@ -120,8 +114,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>section[
<span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[My Section] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[my_section] <span class="line-numbers"><a href="#n4" name="n4">4</a></span>... -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> <p>By default, validation is only enabled for internal links (i.e. the check occurs if the first parameter of the <a href="/glyph/book/macros/macros_inline.html#m_link"><code>link</code></a> macro starts with a <code>#</code>). You can enable it for external links as well by setting the <a href="/glyph/book/config/options.html#s_options_url_validation"><code>options.url_validation</code></a> setting to <code>true</code>. If URL validation is enabled, an error is returned if a link returns an HTTP status greater than 302.</p>@@ -129,41 +122,21 @@ <aside class="important">
<span class="note-title">Important</span>Enabling URL validation may significantly slow down compilation if a lot of external links are present. </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/topics.html">Topics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/images.html">Images and Figures</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/topics.html">← Topics</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/images.html">Images and Figures →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/macro_composition.html
→
content/glyph/book/text_editing/macro_composition.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Macro Composition - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,15 +61,14 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/attribute_intro.html">← Macro attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting →</a></nav> <p>Glyph macros can be <em>composed</em> with other using the <code>/</code> character. Macro composition can be used instead of nesting, provided that macro containers (also called <em>dispatchers</em> in certain situations) take only one parameter and no attributes.</p> <p>For example, the following code:</p> <div class="CodeRay"> <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>?[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> not[output?[pdf]]| <span class="line-numbers"><a href="#n3" name="n3">3</a></span> ... -<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>]</pre></div> </div>@@ -82,8 +78,7 @@ <div class="CodeRay">
<div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>?[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> not/output?[pdf]| <span class="line-numbers"><a href="#n3" name="n3">3</a></span> ... -<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>]</pre></div> </div>@@ -93,41 +88,21 @@ <ul>
<li>The <a href="/glyph/book/macros/macros_core.html#m_s"><code>s</code></a> macro, used to call almost any method of the Ruby String class.</li> <li>The <a href="/glyph/book/macros/macros_core.html#m_xml"><code>xml</code></a> macro, used to render raw <span class="caps">XML</span> tags.</li> </ul> - <nav class="navigation"><a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/attribute_intro.html">← Macro attributes</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/macro_intro.html
→
content/glyph/book/text_editing/macro_intro.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Introducing Glyph Macros - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/glyph_files.html">.glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/glyph_files.html">← <code>.glyph</code> files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes →</a></nav> <p>The most important concept to grasp about Glyph is the concept of <em>macro</em>.</p> <p>A Glyph macro is, in a nutshell, an identifier of some kind that wraps a value or parameters within square brackets. More specifically:</p>@@ -79,41 +76,21 @@ <ul>
<li><code>=>[#test|Test Section]</code></li> <li><code>link[#test|Test Section]</code></li> </ul> - <nav class="navigation"><a href="/glyph/book/text_editing/glyph_files.html">.glyph files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/glyph_files.html">← <code>.glyph</code> files</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/attribute_intro.html">Macro attributes →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/raw_html.html
→
content/glyph/book/text_editing/raw_html.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Textile or Markdown - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/code.html">Source Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/code.html">← Source Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback →</a></nav> <p> Textile or Markdown are very easy and intuitive to use, and they can produce HTML markup with almost no effort. Using them with Glyph is as simple as using the <a href="/glyph/book/macros/macros_filters.html#m_textile"><code>textile</code></a> macro (aliased to <code>txt</code>) and the <a href="/glyph/book/macros/macros_filters.html#m_markdown"><code>markdown</code></a> macro (aliased to <code>md</code>). </p>@@ -79,8 +76,7 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span>This is another paragraph with some -deleted- text.
<span class="line-numbers"><a href="#n5" name="n5">5</a></span>* This is <span class="line-numbers"><a href="#n6" name="n6">6</a></span>* a bulletted <span class="line-numbers"><a href="#n7" name="n7">7</a></span>* list -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>]</pre></div> </div> <p>produces the following HTML code:</p>@@ -91,8 +87,7 @@ <span class="line-numbers"><a href="#n3" name="n3">3</a></span><span class="tag"><ul></span>
<span class="line-numbers"><a href="#n4" name="n4">4</a></span> <span class="tag"><li></span>This is<span class="tag"></li></span> <span class="line-numbers"><a href="#n5" name="n5">5</a></span> <span class="tag"><li></span>a bulletted<span class="tag"></li></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span> <span class="tag"><li></span>list<span class="tag"></li></span> -<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="tag"></ul></span> -</pre></div> +<span class="line-numbers"><a href="#n7" name="n7">7</a></span><span class="tag"></ul></span></pre></div> </div> </aside>@@ -100,41 +95,21 @@ <aside class="important">
<span class="note-title">Important</span>Be careful when using block-level HTML with Textile and Markdown: sometimes it may be necessary to add extra empty lines or escape tags. </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/code.html">Source Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/code.html">← Source Code</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/section_aliases.html
→
content/glyph/book/text_editing/section_aliases.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Section Aliases - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/sections.html">Sections and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/topics.html">Topics</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/sections.html">← Sections and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/topics.html">Topics →</a></nav> <p>There are <em>a lot</em> of macros that can be used in the same way as <code>section</code>, one for each element commonly used in <a href="http://en.wikipedia.org/wiki/Book_design">book design</a>.</p> <p>The following table lists the identifiers of all section-like macros, divided according to the part of the book they should be placed in:</p> <table>@@ -105,41 +102,21 @@ <aside class="note">
<span class="note-title">Note</span><code>frontmatter</code>, <code>bodymatter</code> and <code>backmatter</code> are also macro identifiers, but they are also exposed as attributes for the <a href="/glyph/book/macros/macros_structure.html#m_book"><code>book</code></a> macro and the <a href="/glyph/book/macros/macros_structure.html#m_article"><code>article</code></a> macro, so if you're using either of these two macros as your root macro for your document, there's no need to use them explicitly. </aside> - <nav class="navigation"><a href="/glyph/book/text_editing/sections.html">Sections and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/topics.html">Topics</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/sections.html">← Sections and Headers</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/topics.html">Topics →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/sections.html
→
content/glyph/book/text_editing/sections.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Sections and Headers - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/section_aliases.html">Section Aliases</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/esc_quot.html">← Escaping and Quoting</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/section_aliases.html">Section Aliases →</a></nav> <p>Glyph documents are normally organized as a hierarchical tree of nested chapters, appendixes, sections, etc. To define a section, use the <a href="/glyph/book/macros/macros_structure.html#m_section"><code>section</code></a> macro (aliased by <code>§</code>), like so:</p>@@ -76,8 +73,7 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> section[
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> @title[Section #2] <span class="line-numbers"><a href="#n6" name="n6">6</a></span>This section is nested into the previous one. <span class="line-numbers"><a href="#n7" name="n7">7</a></span> ] --[End of Section #2] -<span class="line-numbers"><a href="#n8" name="n8">8</a></span>] --[End of Section #1] -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span>] --[End of Section #1]</pre></div> </div>@@ -92,14 +88,13 @@ <span class="line-numbers"><a href="#n4" name="n4">4</a></span> <span class="tag"><div</span> <span class="attribute-name">class</span>=<span class="string"><span class="delimiter">"</span><span class="content">section</span><span class="delimiter">"</span></span><span class="tag">></span>
<span class="line-numbers"><a href="#n5" name="n5">5</a></span> <span class="tag"><h3></span>Section #2<span class="tag"></h3></span> <span class="line-numbers"><a href="#n6" name="n6">6</a></span> <span class="tag"><p></span>This section is nested in the previous one<span class="tag"></p></span> <span class="line-numbers"><a href="#n7" name="n7">7</a></span> <span class="tag"></div></span> -<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span> -</pre></div> +<span class="line-numbers"><a href="#n8" name="n8">8</a></span><span class="tag"></div></span></pre></div> </div> <p>By default, in Glyph the first header level is <em>2</em>, so the two headers are rendered as <code>h2</code> and <code>h3</code>, respectively (<code>--[...]</code> macros are <em>comments</em>, therefore they are not included in the final output).</p> <section class="section"> -<header><h1 id="h_25">Markup-aware sections</h1></header> +<header><h1 id="h_25" class="toc">Markup-aware sections</h1></header> <p>Although Glyph can be used on its own to produce valid <span class="caps">HTML</span> or <span class="caps">XML</span> code, you may often want to use Textile or Markdown to save some typing. Typically, you’ll end up writing a lot of code like this:</p> <div class="CodeRay">@@ -108,8 +103,7 @@ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[My Textile section]
<span class="line-numbers"><a href="#n3" name="n3">3</a></span> textile[ <span class="line-numbers"><a href="#n4" name="n4">4</a></span>Textile markup can be used _here_. <span class="line-numbers"><a href="#n5" name="n5">5</a></span> ] -<span class="line-numbers"><a href="#n6" name="n6">6</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n6" name="n6">6</a></span>]</pre></div> </div> <p>To save you even more typing, you can use the <a href="/glyph/book/macros/macros_filters.html#m_textile_section"><code>textile_section</code></a> macro (aliased by <code>txt_section</code> and <code>§txt</code>) and the <a href="/glyph/book/macros/macros_filters.html#m_markdown_section"><code>markdown_section</code></a> macro (aliased by <code>md_section</code> and <code>§md</code>). By doing so, the previous code snippet can be written like this:</p>@@ -117,8 +111,7 @@ <div class="CodeRay">
<div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>§txt[ <span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[My Textile section] <span class="line-numbers"><a href="#n3" name="n3">3</a></span>Textile markup can be used _here_. -<span class="line-numbers"><a href="#n4" name="n4">4</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n4" name="n4">4</a></span>]</pre></div> </div> <aside class="tip">@@ -127,41 +120,21 @@
</aside> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/esc_quot.html">Escaping and Quoting</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/section_aliases.html">Section Aliases</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/esc_quot.html">← Escaping and Quoting</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/section_aliases.html">Section Aliases →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/stylesheets.html
→
content/glyph/book/text_editing/stylesheets.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Adding Stylesheets - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/inclusions.html">Content Reuse</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/xml_fallback.html">← XML Fallback</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/inclusions.html">Content Reuse →</a></nav> <p>Currently, Glyph does not provide any native way to format text and pages. The reason is that there's absolutely no need for that: CSS does the job just fine. In particular, CSS3 offers specific attributes and elements that can be used specifically for paginated documents. That's no replacement for LaTeX by any means, but it is enough if you're not looking for advanced typographical features.</p> <p>You can embed CSS files using the <a href="/glyph/book/macros/macros_structure.html#m_style"><code>style</code></a> macro, like this:</p> <p>@@ -76,7 +73,7 @@ <span class="note-title">Tip</span>By default, stylesheets are embedded within text files. If necessary, you can choose to link them or import them by changing the values of the <a href="/glyph/book/config/document.html#s_document_styles"><code>document.styles</code></a> setting.
</aside> <section class="section"> -<header><h1 id="default_stylesheets">Default Stylesheets</h1></header> +<header><h1 id="default_stylesheets" class="toc">Default Stylesheets</h1></header> <p>Glyph provides the following default stylesheets, that can be referenced directly using the <a href="/glyph/book/macros/macros_structure.html#m_style"><code>style</code></a> macro:</p> <table> <tr>@@ -112,41 +109,21 @@ </tr>
</table> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/xml_fallback.html">XML Fallback</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/inclusions.html">Content Reuse</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/xml_fallback.html">← XML Fallback</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/inclusions.html">Content Reuse →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/topics.html
→
content/glyph/book/text_editing/topics.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Topics - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/section_aliases.html">Section Aliases</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/links.html">Links and Bookmarks</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/section_aliases.html">← Section Aliases</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/links.html">Links and Bookmarks →</a></nav> <p>Sections can also be used to create <em>topics</em>. In a technical writing context, the term topic identifies a single page of an online help (e.g. a Compiled <span class="caps">HTML</span> file, or <span class="caps">CHM</span>). Topics should generally be:</p> <ul> <li>self-contained, in the sense that they should make sense on their own, ideally without the need to be read in sequence</li>@@ -77,8 +74,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>section[
<span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[My First Topic] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[first_topic] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> @src[test/first_topic.glyph] -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> <p>This is an ordinary section with a title and an explicit ID, but it has no contents. Instead, its <code>@src</code> attribute references an external file. If you are generating a single-file document, like a standalone <span class="caps">HTML</span> file or a <span class="caps">PDF</span> file, the code snippet above is exactly the same as the following:</p>@@ -87,8 +83,7 @@ <div class="code"><pre><span class="line-numbers"><a href="#n1" name="n1">1</a></span>section[
<span class="line-numbers"><a href="#n2" name="n2">2</a></span> @title[My First Topic] <span class="line-numbers"><a href="#n3" name="n3">3</a></span> @id[first_topic] <span class="line-numbers"><a href="#n4" name="n4">4</a></span> include[test/first_topic.glyph] -<span class="line-numbers"><a href="#n5" name="n5">5</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n5" name="n5">5</a></span>]</pre></div> </div> <p>On the other hand, if you are planning on producing a document comprised of multiple files (see <a href="/glyph/book/compiling/compiling.html#web_output">Web/Web5 Output</a>), the <code>@src</code> attribute tells Glyph to create a <em>topic</em> for the section. In this case:</p>@@ -99,41 +94,21 @@ <li>The topic file is rendered according to a specific <a href="/glyph/book/extending/layouts.html#layouts">layout</a>.</li>
<li>The location of the topic is the same as the location of the included file, mirrored in the output folder.</li> <li>Glyph takes care of changing the file extensions and resolving links automatically, regardless of the output target.</li> </ul> - <nav class="navigation"><a href="/glyph/book/text_editing/section_aliases.html">Section Aliases</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/links.html">Links and Bookmarks</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/section_aliases.html">← Section Aliases</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/links.html">Links and Bookmarks →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/text_editing/xml_fallback.html
→
content/glyph/book/text_editing/xml_fallback.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>XML Fallback - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/raw_html.html">← Textile or Markdown</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets →</a></nav> <p>Sure Textile and Markdown are great, but sometimes you may want to just use HTML, without the extra verbosity, of course. Take tables for example: Textile offers an easy way to create them, but things may get dirty when you need to have multiple paragraphs or lists within cells.</p> <p>Very early versions of Glyph used to offered some simple <code>table</code>, <code>tr</code>, <code>tr</code>, <code>td</code> macros just for that. Of course the problem was that thy didn't offer any way to customize the markup by adding, for example, CSS classes.</p> <p>Instead, by default, Glyph can convert any unrecognized macro to the corresponding XML element and macro attributes to XML attributes.</p>@@ -97,8 +94,7 @@ <span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> li[...]
<span class="line-numbers"><a href="#n21" name="n21">21</a></span> ] <span class="line-numbers"><a href="#n22" name="n22">22</a></span> ] <span class="line-numbers"><a href="#n23" name="n23">23</a></span> ] -<span class="line-numbers"><a href="#n24" name="n24">24</a></span>] -</pre></div> +<span class="line-numbers"><a href="#n24" name="n24">24</a></span>]</pre></div> </div> <p>@@ -128,8 +124,7 @@ <span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span> <span class="tag"><li></span>...<span class="tag"></li></span>
<span class="line-numbers"><a href="#n21" name="n21">21</a></span> <span class="tag"></ul></span> <span class="line-numbers"><a href="#n22" name="n22">22</a></span> <span class="tag"></td></span> <span class="line-numbers"><a href="#n23" name="n23">23</a></span> <span class="tag"></tr></span> -<span class="line-numbers"><a href="#n24" name="n24">24</a></span><span class="tag"></table></span> -</pre></div> +<span class="line-numbers"><a href="#n24" name="n24">24</a></span><span class="tag"></table></span></pre></div> </div> </aside>@@ -140,7 +135,7 @@
</aside> <p>Additionally, it is possible to force macro-to-<span class="caps">XML</span> conversion by composing the name of a tag with the <a href="/glyph/book/macros/macros_core.html#m_xml"><code>xml</code></a> macro, so for example <code>xml/snippet[test]</code> will be converted into <code><snippet>test</snippet></code>.</p> <section class="section"> -<header><h1 id="xml_blacklist">Blacklisted XML tags</h1></header> +<header><h1 id="xml_blacklist" class="toc">Blacklisted XML tags</h1></header> <p>By default, the following tags are blacklisted and will be ignored:</p> <ul> <li><code>applet</code></li>@@ -163,41 +158,21 @@ <p><span class="note-title">Tip</span>You can change this list by modifying the <a href="/glyph/book/config/options.html#s_options_xml_blacklist"><code>options.xml_blacklist</code></a> setting.</p>
</aside> </section> - <nav class="navigation"><a href="/glyph/book/text_editing/raw_html.html">Textile or Markdown</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets</a></nav> + <nav class="navigation"><a href="/glyph/book/text_editing/raw_html.html">← Textile or Markdown</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/text_editing/stylesheets.html">Adding Stylesheets →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/troubleshooting/errors_command.html
→
content/glyph/book/troubleshooting/errors_command.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Command Errors - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_parser.html">← Parsing Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors →</a></nav> <table style="width:100%;"> <tr>@@ -135,41 +132,21 @@ <td>Returned by the <a href="/glyph/book/ref_commands.html#c_config"><code>config</code></a> command when attempting to override a setting in the <code>system.*</code> namespace.</td>
</tr> </table> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_parser.html">← Parsing Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_macro.html">Macro Errors →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/troubleshooting/errors_generic.html
→
content/glyph/book/troubleshooting/errors_generic.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Generic Errors - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/extending/command.html">Defining Custom Commands</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/command.html">← Defining Custom Commands</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors →</a></nav> <table style="width:100%;"> <tr>@@ -167,41 +164,21 @@ <td>Returned by the <a href="/glyph/book/ref_commands.html#c_stats"><code>stats</code></a> command if the specified snippet is defined but unused.</td>
</tr> </table> - <nav class="navigation"><a href="/glyph/book/extending/command.html">Defining Custom Commands</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/extending/command.html">← Defining Custom Commands</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_parser.html">Parsing Errors →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/troubleshooting/errors_macro.html
→
content/glyph/book/troubleshooting/errors_macro.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Macro Errors - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">Command Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">← Command Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference →</a></nav> <p>The following errors are displayed in the form:</p> <p><em>message</em><br /> source: <em>macro_source</em><br />@@ -229,7 +226,7 @@
<tr> <td>Cannot reset 'system.<em>setting_name</em>' setting (system use only).</td> - <td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_config_">config:</a> when attempting to override a setting in the <code>system.*</code> namespace.</td> + <td>Returned by the <a href="/glyph/book/macros/macros_core.html#m_config_"><code>config:</code></a> when attempting to override a setting in the <code>system.*</code> namespace.</td> </tr>@@ -245,41 +242,21 @@ <td>Returned if a macro was used in the wrong place.</td>
</tr> </table> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">Command Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_command.html">← Command Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/ref_commands.html">Command Reference →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->
M
content/glyph/book/troubleshooting/errors_parser.html
→
content/glyph/book/troubleshooting/errors_parser.html
@@ -2,9 +2,6 @@ <!DOCTYPE html>
<html lang="en"> <head> <title>Parsing Errors - Glyph</title> - <link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'> - - <meta charset="utf-8" /> <meta name="author" content="Fabio Cevasco" />@@ -43,10 +40,10 @@
<header class="page"> <nav class="home-link"> <a href="/"> - <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/> - <![if !IE]> - <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/> - <![endif]> + <span class="logo"> + <span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span> + <span class="three">3</span> + </span> </a> </nav>@@ -64,7 +61,7 @@ </hgroup>
</header> <section id="body-text" class="hyphenate glyph-book"> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_command.html">Command Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_generic.html">← Generic Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_command.html">Command Errors →</a></nav> <table style="width:100%;"> <tr>@@ -119,41 +116,21 @@ <td>Returned if a parameter delimiter is outside a macro or inside an attribute.</td>
</tr> </table> - <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_generic.html">Generic Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_command.html">Command Errors</a></nav> + <nav class="navigation"><a href="/glyph/book/troubleshooting/errors_generic.html">← Generic Errors</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/troubleshooting/errors_command.html">Command Errors →</a></nav> <nav id="sharing-buttons"> <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a> <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> -<g:plusone size="medium"></g:plusone> -<script type="text/javascript"> - (function() { - var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s); - })(); -</script> </nav> </section> </article> <footer> - <section class="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-2871497824158668"; - /* 728x90, created 9/10/10 */ - google_ad_slot = "3963343166"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </section> <section> <nav> <a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a> </nav> - <p>H3RALD Web Site v8.1.2 © 2004 — 2011 <em>Fabio Cevasco</em></p> + <p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p> </section> </footer> </section><!-- #container end -->