Regenerated Glyph book.
h3rald h3rald@h3rald.com
Wed, 22 Sep 2010 13:51:33 +0200
68 files changed,
300 insertions(+),
215 deletions(-)
jump to
M
content/glyph.textile
→
content/glyph.textile
@@ -3,15 +3,14 @@ permalink: glyph
filters_pre: - erb - redcloth -title: "Project: Glyph" +title: "Glyph" +subtitle: "A Rapid Document Authoring Framework" type: project github: glyph links: - "Repository": http://www.github.com/h3rald/glyph/ -- "Bug Tracking": http://www.github.com/h3rald/glyph/issues - "Download": http://www.rubygems.org/gems/glyph -- "Book": http://www.h3rald.com/glyph/book/ -- "Docs": http://rubydoc.info/gems/glyph/ +- "Documentation": /glyph/book/ - "User Group": http://groups.google.com/group/glyph-framework status: Active version: 0.4.1
M
content/glyph/book/acknowledgements.html
→
content/glyph/book/acknowledgements.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Acknowledgements</title> + <title>Acknowledgements – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Acknowledgements</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/changelog.html
→
content/glyph/book/changelog.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Changelog</title> + <title>Changelog – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Changelog</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><a href="/glyph/book/config/output.html">output.* ←</a><a href="/glyph/book/index.html">Contents</a></nav>@@ -68,7 +69,7 @@
<section class="section"> <header><h1 id="h_231">v0.4.1 – September 25th 2010</h1></header> <section class="section"> -<header><h1 id="h_232">4 Bugs Fixed</h1></header> +<header><h1 id="h_232">5 Bugs Fixed</h1></header> <table><tr><th>ID</th> <th>Description</th></tr>@@ -83,7 +84,10 @@ <tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/171">#171</a></td>
<td><p><span class="caps">SCSS</span> now used internally by Glyph to generate default <span class="caps">CSS</span> files.</p></td></tr> <tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/173">#173</a></td> - <td><p>Consecutive escape sequences are now interpreted correctly in topics.</p></td></tr></table> + <td><p>Consecutive escape sequences are now interpreted correctly in topics.</p></td></tr> + + <tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/174">#174</a></td> + <td><p>Fixed error causing broken images in web5/html5 output.</p></td></tr></table> </section>
M
content/glyph/book/compiling/compiling.html
→
content/glyph/book/compiling/compiling.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Compiling a project</title> + <title>Compiling a project – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Compiling a project</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><a href="/glyph/book/text_editing/conditionals.html">Conditional Macros ←</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>
M
content/glyph/book/compiling/lite_mode.html
→
content/glyph/book/compiling/lite_mode.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Compiling single Glyph files</title> + <title>Compiling single Glyph files – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Compiling single Glyph files</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/compiling/programmatic_usage.html
→
content/glyph/book/compiling/programmatic_usage.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Using Glyph programmatically</title> + <title>Using Glyph programmatically – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Using Glyph programmatically</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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://yardoc.org/docs/glyph/Glyph"><span class="caps">API</span></a> is simple and can be used to:</p>
M
content/glyph/book/config/document.html
→
content/glyph/book/config/document.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - document.*</title> + <title>document.* – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>document.*</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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> The following configuration settings are related to the current Glyph document. Therefore, you should update them right after creating a project.
M
content/glyph/book/config/filters.html
→
content/glyph/book/config/filters.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - filters.*</title> + <title>filters.* – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>filters.*</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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> These settings are used to configure some special options related to output filters and highlighters.
M
content/glyph/book/config/options.html
→
content/glyph/book/config/options.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - options.*</title> + <title>options.* – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>options.*</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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> The following configuration settings are used to enable or disable specific Glyph functionalities and behaviors.
M
content/glyph/book/config/output.html
→
content/glyph/book/config/output.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - output.*</title> + <title>output.* – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>output.*</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/bookmarks_headers.html
→
content/glyph/book/extending/bookmarks_headers.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Bookmarks and Headers</title> + <title>Bookmarks and Headers – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Bookmarks and Headers</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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://yardoc.org/docs/h3rald-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>
M
content/glyph/book/extending/command.html
→
content/glyph/book/extending/command.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Defining Custom Commands</title> + <title>Defining Custom Commands – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Defining Custom Commands</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/commands_tasks.html
→
content/glyph/book/extending/commands_tasks.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Defining Custom Commands and Tasks</title> + <title>Defining Custom Commands and Tasks – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Defining Custom Commands and Tasks</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>@@ -66,7 +67,7 @@ <section class="section">
<header><h1 id="cmd_tasks_arch">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 commands and tasks:</p> - <figure><img alt="-" src="images/glyph/commands_tasks.png" /> + <figure><img alt="-" src="/glyph/book/images/glyph/commands_tasks.png" /> <figcaption>Glyph default commands and tasks</figcaption></figure> <p>As you can see:</p> <ul>
M
content/glyph/book/extending/further_reading.html
→
content/glyph/book/extending/further_reading.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Further Reading</title> + <title>Further Reading – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Further Reading</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/internals.html
→
content/glyph/book/extending/internals.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - A quick look at Glyph's internals</title> + <title>A quick look at Glyph's internals – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,14 +55,15 @@ <article class="page">
<header> <hgroup> <h1>A quick look at Glyph's internals</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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 alt="-" src="images/glyph/document_generation.png" /> + <figure><img alt="-" src="/glyph/book/images/glyph/document_generation.png" /> <figcaption>A sequence diagram for document generation</figcaption></figure> <p>From the diagram, it is possible to divide the document generation process into three phases:</p> <ul>
M
content/glyph/book/extending/interpreting.html
→
content/glyph/book/extending/interpreting.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Interpreting Glyph Code</title> + <title>Interpreting Glyph Code – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Interpreting Glyph Code</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/layouts.html
→
content/glyph/book/extending/layouts.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Layouts</title> + <title>Layouts – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Layouts</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/macro_def.html
→
content/glyph/book/extending/macro_def.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Defining Custom Macros</title> + <title>Defining Custom Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Defining Custom Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/output_format.html
→
content/glyph/book/extending/output_format.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Custom Output Formats</title> + <title>Custom Output Formats – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Custom Output Formats</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>@@ -103,30 +104,28 @@ <span class="no"> 5</span> (dir/<span class="s"><span class="dl">"</span><span class="k">glyph/book</span><span class="dl">"</span></span>).mkpath
<span class="no"> 6</span> <span class="c"># Copy files in subdir</span> <span class="no"> 7</span> (dir).find <span class="r">do</span> |i| <span class="no"> 8</span> <span class="r">if</span> i.file? <span class="r">then</span> -<span class="no"> 9</span> <span class="r">next</span> <span class="r">if</span> -<span class="no"><strong>10</strong></span> i.to_s.match(<span class="co">Regexp</span>.escape(dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span>)) || -<span class="no">11</span> i.to_s.match(<span class="co">Regexp</span>.escape(dir/<span class="s"><span class="dl">'</span><span class="k">images</span><span class="dl">'</span></span>)) -<span class="no">12</span> dest = dir/<span class="s"><span class="dl">"</span><span class="k">glyph/book/</span><span class="il"><span class="idl">#{</span>i.relative_path_from(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/dir)<span class="idl">}</span></span><span class="dl">"</span></span> -<span class="no">13</span> src = i.to_s -<span class="no">14</span> <span class="co">Pathname</span>.new(dest).parent.mkpath -<span class="no">15</span> file_copy src, dest -<span class="no">16</span> <span class="r">end</span> -<span class="no">17</span> <span class="r">end</span> -<span class="no">18</span> <span class="c"># Remove files</span> -<span class="no">19</span> dir.children.each <span class="r">do</span> |c| -<span class="no"><strong>20</strong></span> <span class="r">unless</span> [dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span>, dir/<span class="s"><span class="dl">'</span><span class="k">images</span><span class="dl">'</span></span>].include? c <span class="r">then</span> -<span class="no">21</span> c.directory? ? c.rmtree : c.unlink -<span class="no">22</span> <span class="r">end</span> -<span class="no">23</span> <span class="r">end</span> -<span class="no">24</span> (dir/<span class="s"><span class="dl">'</span><span class="k">images/glyph/glyph.eps</span><span class="dl">'</span></span>).unlink -<span class="no">25</span> (dir/<span class="s"><span class="dl">'</span><span class="k">images/glyph/glyph.svg</span><span class="dl">'</span></span>).unlink -<span class="no">26</span> <span class="c"># Create project page</span> -<span class="no">27</span> project = <span class="co">Glyph</span>.filter <span class="s"><span class="dl">%{</span><span class="k">layout:project[ -<span class="no">28</span> @contents[</span><span class="il"><span class="idl">#{</span>file_load(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">'</span><span class="k">text/introduction.glyph</span><span class="dl">'</span></span>)<span class="idl">}</span></span><span class="k">] -<span class="no">29</span> ]</span><span class="dl">}</span></span> -<span class="no"><strong>30</strong></span> file_write dir/<span class="s"><span class="dl">"</span><span class="k">glyph.textile</span><span class="dl">"</span></span>, project -<span class="no">31</span> <span class="r">end</span> -<span class="no">32</span> <span class="r">end</span></pre></div> +<span class="no"> 9</span> <span class="r">next</span> <span class="r">if</span> i.to_s.match(<span class="co">Regexp</span>.escape(dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span>)) +<span class="no"><strong>10</strong></span> dest = dir/<span class="s"><span class="dl">"</span><span class="k">glyph/book/</span><span class="il"><span class="idl">#{</span>i.relative_path_from(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/dir)<span class="idl">}</span></span><span class="dl">"</span></span> +<span class="no">11</span> src = i.to_s +<span class="no">12</span> <span class="co">Pathname</span>.new(dest).parent.mkpath +<span class="no">13</span> file_copy src, dest +<span class="no">14</span> <span class="r">end</span> +<span class="no">15</span> <span class="r">end</span> +<span class="no">16</span> <span class="c"># Remove files from output dir</span> +<span class="no">17</span> dir.children.each <span class="r">do</span> |c| +<span class="no">18</span> <span class="r">unless</span> c == dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span> <span class="r">then</span> +<span class="no">19</span> c.directory? ? c.rmtree : c.unlink +<span class="no"><strong>20</strong></span> <span class="r">end</span> +<span class="no">21</span> <span class="r">end</span> +<span class="no">22</span> (dir/<span class="s"><span class="dl">'</span><span class="k">glyph/book/images/glyph/glyph.eps</span><span class="dl">'</span></span>).unlink +<span class="no">23</span> (dir/<span class="s"><span class="dl">'</span><span class="k">glyph/book/images/glyph/glyph.svg</span><span class="dl">'</span></span>).unlink +<span class="no">24</span> <span class="c"># Create project page</span> +<span class="no">25</span> project = <span class="co">Glyph</span>.filter <span class="s"><span class="dl">%{</span><span class="k">layout:project[ +<span class="no">26</span> @contents[</span><span class="il"><span class="idl">#{</span>file_load(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">'</span><span class="k">text/introduction.glyph</span><span class="dl">'</span></span>)<span class="idl">}</span></span><span class="k">] +<span class="no">27</span> ]</span><span class="dl">}</span></span> +<span class="no">28</span> file_write dir/<span class="s"><span class="dl">"</span><span class="k">glyph.textile</span><span class="dl">"</span></span>, project +<span class="no">29</span> <span class="r">end</span> +<span class="no"><strong>30</strong></span> <span class="r">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>
M
content/glyph/book/extending/params_attrs.html
→
content/glyph/book/extending/params_attrs.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Parameters and Attributes</title> + <title>Parameters and Attributes – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Parameters and Attributes</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/placeholders.html
→
content/glyph/book/extending/placeholders.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Using Placeholders</title> + <title>Using Placeholders – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Using Placeholders</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/task.html
→
content/glyph/book/extending/task.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Defining Custom Tasks</title> + <title>Defining Custom Tasks – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Defining Custom Tasks</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/extending/validators.html
→
content/glyph/book/extending/validators.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Using Validators</title> + <title>Using Validators – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Using Validators</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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://yardoc.org/docs/h3rald-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>
M
content/glyph/book/getting_started/configuration.html
→
content/glyph/book/getting_started/configuration.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Project Configuration</title> + <title>Project Configuration – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Project Configuration</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/getting_started/create_project.html
→
content/glyph/book/getting_started/create_project.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Creating your first Glyph Project</title> + <title>Creating your first Glyph Project – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Creating your first Glyph Project</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/getting_started/structure.html
→
content/glyph/book/getting_started/structure.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Document Structure</title> + <title>Document Structure – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Document Structure</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/index.html
→
content/glyph/book/index.html
@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,10 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Glyph - Document Authoring Framework</h1> - <h2>Online Help</h2> + <h2>Documentation</h2> </hgroup> </header> - <section id="body-text"> + <section id="body-text" class="glyph-index"> <nav class="contents"> <h1 class="toc-header" id="toc">Table of Contents</h1> <ol class="toc">
M
content/glyph/book/introduction.html
→
content/glyph/book/introduction.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Introduction</title> + <title>Introduction – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Introduction</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/license.html
→
content/glyph/book/license.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - License</title> + <title>License – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>License</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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 <strong>Fabio Cevasco</strong>, <a href="http://www.h3rald.com">http://www.h3rald.com</a></p>
M
content/glyph/book/macros/macros_block.html
→
content/glyph/book/macros/macros_block.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Block Macros</title> + <title>Block Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Block Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/macros/macros_core.html
→
content/glyph/book/macros/macros_core.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Core Macros</title> + <title>Core Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Core Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>@@ -257,7 +258,7 @@ </tr>
<tr> - <td>0</td> + <td>1</td> <td>The new value of the configuration setting</td> </tr> </table>
M
content/glyph/book/macros/macros_filters.html
→
content/glyph/book/macros/macros_filters.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Filter Macros</title> + <title>Filter Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Filter Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/macros/macros_inline.html
→
content/glyph/book/macros/macros_inline.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Inline Macros</title> + <title>Inline Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Inline Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>@@ -143,7 +144,7 @@ </tr>
<tr> - <td>0</td> + <td>1</td> <td>A valid bookmark within the document.</td> </tr> </table>
M
content/glyph/book/macros/macros_structure.html
→
content/glyph/book/macros/macros_structure.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Structure Macros</title> + <title>Structure Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Structure Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/ref_commands.html
→
content/glyph/book/ref_commands.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Command Reference</title> + <title>Command Reference – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Command Reference</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/stats/bookmarks.html
→
content/glyph/book/stats/bookmarks.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Bookmark Statistics</title> + <title>Bookmark Statistics – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Bookmark Statistics</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/stats/links.html
→
content/glyph/book/stats/links.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Link Statistics</title> + <title>Link Statistics – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Link Statistics</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/stats/macros.html
→
content/glyph/book/stats/macros.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Macro Statistics</title> + <title>Macro Statistics – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Macro Statistics</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/stats/snippets.html
→
content/glyph/book/stats/snippets.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Snippet Statistics</title> + <title>Snippet Statistics – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Snippet Statistics</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/stats/stats.html
→
content/glyph/book/stats/stats.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Using the stats command</title> + <title>Using the stats command – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Using the stats command</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/attribute_intro.html
→
content/glyph/book/text_editing/attribute_intro.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Macro attributes</title> + <title>Macro attributes – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Macro attributes</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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/esc_quot.html">→ Escaping and Quoting</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>
M
content/glyph/book/text_editing/code.html
→
content/glyph/book/text_editing/code.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Source Code</title> + <title>Source Code – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Source Code</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/conditionals.html
→
content/glyph/book/text_editing/conditionals.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Conditional Macros</title> + <title>Conditional Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Conditional Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><a href="/glyph/book/text_editing/evaluation.html">Evaluating Ruby code and Configuration Settings ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/compiling/compiling.html">→ Compiling a project</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>
M
content/glyph/book/text_editing/esc_quot.html
→
content/glyph/book/text_editing/esc_quot.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Escaping and Quoting</title> + <title>Escaping and Quoting – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Escaping and Quoting</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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/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>
M
content/glyph/book/text_editing/evaluation.html
→
content/glyph/book/text_editing/evaluation.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Evaluating Ruby code and Configuration Settings</title> + <title>Evaluating Ruby code and Configuration Settings – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,15 +55,16 @@ <article class="page">
<header> <hgroup> <h1>Evaluating Ruby code and Configuration Settings</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><a href="/glyph/book/text_editing/inclusions.html">Including Files and Snippets ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/text_editing/conditionals.html">→ Conditional Macros</a></nav> <p>Glyph Language is not a full-blown programming language and it is currently not Turing-complete (it does not provide loops). However, it is possible to 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> → Wed Sep 22 11:49:09 +0200 2010</li> + <li><code>%[Time.now]</code> → Wed Sep 22 13:49:51 +0200 2010</li> <li><code>%[Glyph::VERSION]</code> → 0.4.1</li> </ul> <p>The scope for the code evaluation is the Kernel module, (with all inclusions required by Glyph itself).</p>
M
content/glyph/book/text_editing/glyph_files.html
→
content/glyph/book/text_editing/glyph_files.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - .glyph files</title> + <title>.glyph files – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>.glyph files</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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.<br />
M
content/glyph/book/text_editing/images.html
→
content/glyph/book/text_editing/images.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Images and Figures</title> + <title>Images and Figures – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Images and Figures</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/inclusions.html
→
content/glyph/book/text_editing/inclusions.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Including Files and Snippets</title> + <title>Including Files and Snippets – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Including Files and Snippets</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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/evaluation.html">→ Evaluating Ruby code and Configuration Settings</a></nav> <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>
M
content/glyph/book/text_editing/links.html
→
content/glyph/book/text_editing/links.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Links and Bookmarks</title> + <title>Links and Bookmarks – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Links and Bookmarks</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/macro_intro.html
→
content/glyph/book/text_editing/macro_intro.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Introducing Glyph Macros</title> + <title>Introducing Glyph Macros – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Introducing Glyph Macros</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/raw_html.html
→
content/glyph/book/text_editing/raw_html.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Textile or Markdown</title> + <title>Textile or Markdown – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Textile or Markdown</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/section_aliases.html
→
content/glyph/book/text_editing/section_aliases.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Section Aliases</title> + <title>Section Aliases – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Section Aliases</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>. Each one of them is a simple wrapper for a <code><div></code> tag with a <code>class</code> attribute set to its name.</p>
M
content/glyph/book/text_editing/sections.html
→
content/glyph/book/text_editing/sections.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Sections and Headers</title> + <title>Sections and Headers – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Sections and Headers</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/stylesheets.html
→
content/glyph/book/text_editing/stylesheets.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Adding Stylesheets</title> + <title>Adding Stylesheets – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Adding Stylesheets</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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">→ Including Files and Snippets</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>
M
content/glyph/book/text_editing/topics.html
→
content/glyph/book/text_editing/topics.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Topics</title> + <title>Topics – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Topics</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/text_editing/xml_fallback.html
→
content/glyph/book/text_editing/xml_fallback.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - XML Fallback</title> + <title>XML Fallback – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>XML Fallback</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/troubleshooting/errors_command.html
→
content/glyph/book/troubleshooting/errors_command.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Command Errors</title> + <title>Command Errors – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Command Errors</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/troubleshooting/errors_generic.html
→
content/glyph/book/troubleshooting/errors_generic.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Generic Errors</title> + <title>Generic Errors – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Generic Errors</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/troubleshooting/errors_macro.html
→
content/glyph/book/troubleshooting/errors_macro.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Macro Errors</title> + <title>Macro Errors – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Macro Errors</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/glyph/book/troubleshooting/errors_parser.html
→
content/glyph/book/troubleshooting/errors_parser.html
@@ -1,7 +1,7 @@
<!DOCTYPE html> <html lang="en"> <head> - <title>Glyph - Parsing Errors</title> + <title>Parsing Errors – Glyph Documentation</title>@@ -47,7 +47,7 @@ </a>
</nav> <nav class="section"> - /<a href="/projects/" rel="archives">PROJECTS</a> + /<a href="/glyph/" rel="archives">GLYPH</a> </nav> </header>@@ -55,9 +55,10 @@ <article class="page">
<header> <hgroup> <h1>Parsing Errors</h1> + <h2>Glyph Documentation</h2> </hgroup> </header> - <section id="body-text" class="hyphenate"> + <section id="body-text" class="hyphenate glyph-book"> <nav><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>
M
content/h3rald.textile
→
content/h3rald.textile
@@ -3,7 +3,8 @@ permalink: h3rald
filters_pre: - erb - redcloth -title: "Project: H3RALD Web Site" +title: "H3RALD Web Site" +subtitle: "The site you're looking at" type: project github: h3rald links:
M
content/herald-vim-color-scheme.textile
→
content/herald-vim-color-scheme.textile
@@ -1,6 +1,7 @@
----- permalink: herald-vim-color-scheme -title: "Project: herald.vim" +title: "herald.vim" +subtitle: "An easy to read, portable and pretty Vim Color Scheme" type: project ----- *herald* is a dark color scheme for "Vim":http://www.vim.org which aims to be easy to read, eye-appealing, portable on multiple terminals, and suitable for source code highlighting in multiple languages.
M
content/rawline.textile
→
content/rawline.textile
@@ -3,7 +3,8 @@ permalink: rawline
filters_pre: - erb - redcloth -title: "Project: RawLine" +title: "RawLine" +subtitle: A pure-ruby alternative to ReadLine type: project github: rawline links:
M
content/styles/_content.scss
→
content/styles/_content.scss
@@ -194,6 +194,10 @@ #body-text ul, ol {
margin-left: 2em; } +ol.toc, ol.toc ol { + list-style-type: none; +} + dl { margin: 2em 0; dt {@@ -224,6 +228,22 @@ td {
padding: 5px; } +} + +/* Glyph Book */ + +section.glyph-book > nav { + text-align: center; + margin: 2em auto; + a { + margin: 0 1em; + text-size: 120%; + font-weight: bold; + } +} + +section.glyph-index h1.toc-header { + display: none; } /* TOC */