glyph 0.2.0 → 0.3.0

data/AUTHORS.textile

@@ -5,4 +5,4 @@ Special thanks to the following individuals who contributed to Glyph by reportin
 * <a href="http://koraktor.github.com">Sebastian Staudt</a> (koraktor)
 
 
-    
+    

data/CHANGELOG.textile

@@ -1,260 +1,157 @@
 
 
-		<div class="section">
-<h2 id="h_1">v0.2.0 &ndash; May 9th 2010</h2>
-			<div class="section">
-<h3 id="h_2">11 Features Implemented</h3>
-			<table>
-<tr>
-<th>ID</th>
-					<th>Description</th>	
-</tr>
-				<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/62">#62</a>
 
-</td>
-			<td>
-<p>A new highlight macro is available to highlight source code (CodeRay or UltraViolet requireed).</p>
 
-</td>	
-</tr>
-	
-		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/76">#76</a>
 
-</td>
-			<td>
-<p>It is now possible to use Glyph programmatically via the new <code>Glyph#filter</code> and <code>Glyph#compile</code> methods.</p>
-
-</td>	
-</tr>
-	
+	<div class="section">
+<h2 id="h_1">v0.3.0 &ndash; June 13th 2010</h2>
+<div class="section">
+<h3 id="h_2">27 Features Implemented</h3>
+<table><tr><th>ID</th>
+					<th>Description</th></tr>
+				
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/87">#87</a>
-
-</td>
-			<td>
-<p>It is now possible to define snippets inside a Glyph source file using the snippet: macro.</p>
-
-</td>	
-</tr>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/39">#39</a></td>
+		<td><p>A new outline command is available to display the document outline.</p></td></tr>
 		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/110">#110</a></td>
+		<td><p>It is now possible to use Glyph language to produce arbitrary <span class="caps">XML</span> code.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/88">#88</a>
-
-</td>
-			<td>
-<p>It is now possible to change configuration settings inside a Glyph source file using the config: macro macro (Jabbslad).</p>
-
-</td>	
-</tr>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/111">#111</a></td>
+		<td><p>System settings are now stored within a <code>system.*</code> namespace and cannot be changed via the config: macro or the config command.</p></td></tr>
 		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/116">#116</a></td>
+		<td><p>It is now possible to use named attributes within Glyph macros.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/89">#89</a>
-
-</td>
-			<td>
-<p>It is now possible to compile a single Glyph source file without creating a Glyph project.</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/119">#119</a></td>
+		<td><p><a id="new_parser"></a>A new parser was implemented from scratch to improve performance. Treetop gem no longer required.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/92">#92</a>
-
-</td>
-			<td>
-<p>6 new macros have been defined to allow conditional processing (condition macro, eq macro, not macro, and macro, or macro, match macro)</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/121">#121</a></td>
+		<td><p>Some macros have been removed in favor of <span class="caps">XML</span> fallback, others have been updated.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/94">#94</a>
-
-</td>
-			<td>
-<p>It is now possible to add <em>validators</em> to macros, for example to check the number of parameters they take.</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/123">#123</a></td>
+		<td><p>The SyntaxNode class has been specialized to differentiate between macros, attributes, parameters, text and escapes.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/97">#97</a>
-
-</td>
-			<td>
-<p>The compile command command can now take an extra <code>--auto</code> switch to trigger document auto-regeneration whenever a source file is changed (koraktor).</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/124">#124</a></td>
+		<td><p>Implemented new article macro and book macro.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/99">#99</a>
-
-</td>
-			<td>
-<p>Added a <code>document.draft</code> setting. If set to <code>true</code>, comments and TODOs are rendered in output files.</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/126">#126</a></td>
+		<td><p>A new rewrite: macro has been implemented to create simple macros using just Glyph code.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/100">#100</a>
-
-</td>
-			<td>
-<p><a id="system_css"></a>Glyph <span class="caps">CSS</span> files are no longer copied to new projects, but they can be referenced as if they were (see also <a href="#css_not_copied">#93</a>).</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/127">#127</a></td>
+		<td><p>A new alias macro has been implemented to create macro aliases.</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/108">#108</a>
-
-</td>
-			<td>
-<p>It is now possible to define Glyph macros within Glyph source files using the macro: macro.</p>
-
-</td>	
-</tr>
-</table>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/128">#128</a></td>
+		<td><p>A blacklist for <span class="caps">XML</span> tags has been exposed via the language.options.xml_blacklist setting.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/129">#129</a></td>
+		<td><p>The include macro can now be used in lite mode, it can evaluate ruby files and requires relative paths.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/130">#130</a></td>
+		<td><p>A new &#8220;safe mode&#8221; has been implemented to explicitly forbid certain potentially unsafe macros.</p></td></tr></table>
 
 </div>
 	
 	
 		<div class="section">
-<h3 id="h_3">8 Bugs Fixed</h3>
-			<table>
-<tr>
-<th>ID</th>
-					<th>Description</th>	
-</tr>
-				<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/86">#86</a>
-
-</td>
-			<td>
-<p>Warning and error messages have been updated, and it is now possible to show additional debug information. Additionally, syntax errors are now handled before the document is processed.</p>
-
-</td>	
-</tr>
-	
+<h3 id="h_3">7 Bugs Fixed</h3>
+<table><tr><th>ID</th>
+					<th>Description</th></tr>
+				
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/93">#93</a>
-
-</td>
-			<td>
-<p><a id="css_not_copied"></a>Default css files were not copied when creating a new project. The issue has been resolved by allowing the style macro to reference Glyph&#8217;s system styles (see also <a href="#system_css">#100</a>).</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/109">#109</a></td>
+		<td><p>Performance has been dramatically improved by implementing a parser from scratch (see <a href="#new_parser">#119</a>)</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/95">#95</a>
-
-</td>
-			<td>
-<p>The config command did not save data to <span class="caps">YAML</span> configuration files. This has been fixed ensuring that internal configuration overrides are not saved to the <span class="caps">YAML</span> file too.</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/122">#122</a></td>
+		<td><p>Macro encoding/decoding no longer necessary due to the new parser (see <a href="#new_parser">#119</a>)</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/98">#98</a>
-
-</td>
-			<td>
-<p>Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.</p>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/125">#125</a></td>
+		<td><p>Warning messages have been streamlined.</p></td></tr></table>
 
-</td>	
-</tr>
-	
-		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/101">#101</a>
+</div>
 
-</td>
-			<td>
-<p>Additional tests have been developed to improve Textile support. There should no longer be errors when using textile block elements inside Glyph macros.</p>
+</div>
 
-</td>	
-</tr>
-	
+	<div class="section">
+<h2 id="h_4">v0.2.0 &ndash; May 9th 2010</h2>
+<div class="section">
+<h3 id="h_5">23 Features Implemented</h3>
+<table><tr><th>ID</th>
+					<th>Description</th></tr>
+				
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/103">#103</a>
-
-</td>
-			<td>
-<p>Fixed a bug that caused test failures when deleting the test project directory.</p>
-
-</td>	
-</tr>
-	
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/62">#62</a></td>
+		<td><p>A new highlight macro is available to highlight source code (CodeRay or UltraViolet required).</p></td></tr>
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/104">#104</a>
-
-</td>
-			<td>
-<p>Nested Glyph macros calling <code>Macro#interpret</code> no longer ignore escape delimiters.</p>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/76">#76</a></td>
+		<td><p>It is now possible to use Glyph programmatically via the new <code>Glyph#filter</code> and <code>Glyph#compile</code> methods.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/87">#87</a></td>
+		<td><p>It is now possible to define snippets inside a Glyph source file using the snippet: macro.</p></td></tr>	
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/88">#88</a></td>
+		<td><p>It is now possible to change configuration settings inside a Glyph source file using the config: macro (Jabbslad).</p></td></tr>	
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/89">#89</a></td>
+		<td><p>It is now possible to compile a single Glyph source file without creating a Glyph project.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/92">#92</a></td>
+		<td><p>6 new macros have been defined to allow conditional processing (condition macro, eq macro, not macro, and macro, or macro, match macro)</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/94">#94</a></td>
+		<td><p>It is now possible to add <em>validators</em> to macros, for example to check the number of parameters they take.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/97">#97</a></td>
+		<td><p>The compile command command can now take an extra <code>--auto</code> switch to trigger document auto-regeneration whenever a source file is changed (koraktor).</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/99">#99</a></td>
+		<td><p>Added a <code>document.draft</code> setting. If set to <code>true</code>, comments and TODOs are rendered in output files.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/100">#100</a></td>
+		<td><p><a id="system_css"></a>Glyph <span class="caps">CSS</span> files are no longer copied to new projects, but they can be referenced as if they were (see also <a href="#css_not_copied">#93</a>).</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/108">#108</a></td>
+		<td><p>It is now possible to define Glyph macros within Glyph source files using the macro: macro.</p></td></tr></table>
 
-</td>	
-</tr>
+</div>
 	
+	
+		<div class="section">
+<h3 id="h_6">17 Bugs Fixed</h3>
+<table><tr><th>ID</th>
+					<th>Description</th></tr>
+				
 		
-		<tr>
-<td>
-<a href="http://github.com/h3rald/glyph/issues/closed#issue/107">#107</a>
-
-</td>
-			<td>
-<p>Added the possibility to encode (using the encode macro) and decode (using the decode macro) macros so that they can be interpreted later.</p>
-
-</td>	
-</tr>
-</table>
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/86">#86</a></td>
+		<td><p>Warning and error messages have been updated, and it is now possible to show additional debug information. Additionally, syntax errors are now handled before the document is processed.</p></td></tr> 
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/93">#93</a></td>
+		<td><p><a id="css_not_copied"></a>Default css files were not copied when creating a new project. The issue has been resolved by allowing the style macro to reference Glyph&#8217;s system styles (see also <a href="#system_css">#100</a>).</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/95">#95</a></td>
+		<td><p>The config command did not save data to <span class="caps">YAML</span> configuration files. This has been fixed ensuring that internal configuration overrides are not saved to the <span class="caps">YAML</span> file too.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/98">#98</a></td>
+		<td><p>Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/101">#101</a></td>
+		<td><p>Additional tests have been developed to improve Textile support. There should no longer be errors when using textile block elements inside Glyph macros.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/103">#103</a></td>
+		<td><p>Fixed a bug that caused test failures when deleting the test project directory.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/104">#104</a></td>
+		<td><p>Nested Glyph macros calling <code>Macro#interpret</code> no longer ignore escape delimiters.</p></td></tr>
+		
+	<tr><td><a href="http://github.com/h3rald/glyph/issues/closed#issue/107">#107</a></td>
+		<td><p>Added the possibility to encode (using the <code>encode</code> macro) and decode (using the <code>decode</code> macro) macros so that they can be interpreted later.</p></td></tr></table>
 
 </div>
 
 </div>
-	
 
-		<div class="section">
-<h2 id="h_4">v0.1.0 &ndash; April 8th 2010</h2>
-			Initial release.
+	<div class="section">
+<h2 id="h_7">v0.1.0 &ndash; April 8th 2010</h2>
+Initial release.
 
-</div>
-	
+</div>

data/LICENSE.textile

@@ -23,4 +23,4 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 </code>
 </pre>
-</div>
+</div>

data/README.textile

@@ -1,11 +1,11 @@
+
 Glyph is a _Rapid Document Authoring Framework_. 
 
-Think of it like a sort of <a href="http://www.rubyonrails.org">Ruby on Rails</a> but for creating text documents instead of web sites. With Glyph, you can manage your documents tidily in _projects_ that can be used to generate deliverables in different formats such as HTML or PDF (through <a href="http://www.princexml.com/">Prince</a>).
+With Glyph, you can manage your documents tidily in _projects_ and generate deliverables in different formats such as HTML or PDF (through <a href="http://www.princexml.com/">Prince</a>).
 
 <div class="section">
 <h2 id="h_1">Main Features</h2>
-
-Glyph uses a simple macro system to perform a wide variety of advanced tasks:
+Glyph comes with its very own macro system to perform a wide variety of advanced tasks:
 * Generate block-level HTML tags not commonly managed by lightweight markups, like @head@, @body@, @div@ and @table@.
 * Create and validate internal and external links.
 * Include and validate images and figures.
@@ -14,37 +14,40 @@ Glyph uses a simple macro system to perform a wide variety of advanced tasks:
 * Store common snippets of text in a single YAML file and use them anywhere in your document, as many times as you need.
 * Store configuration settings in a YAML file and use them anywhere in your document, as many times as you need.
 * Evaluate Ruby code within your document.
+* Include content only if certain conditions are satisfied.
+* Define macros, snippets and configuration settings directly within your document.
+* Highlight source code.
 * Call macros from other macros (including snippets), avoiding mutual calls.
-* Include text files in other text files.
+* Include text files within other text files.
 * Include the value of any configuration setting (like author, title) in the document.
-* Filter input explicitly or implicitly, based on file extensions when including files. 
-* Manage comments and todo items.
+* Filter input explicitly or implicitly (based on file extensions). 
+* Manage draft comments and todo items.
+* Provide a simple, less-verbose syntax to write XML code.
 
 </div>
 
 <div class="section">
 <h2 id="h_2">Installation</h2>
-
 @gem install glyph@ -- simple, as always.
 
 </div>
 
 <div class="section">
 <h2 id="h_3">Essential Glyph commands</h2>
-
 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: 
 
 * @glyph init@ -- to initialize a new Glyph project in the current (empty) directory.
 * @glyph add introduction.textile@ -- to create a new file called _introduction.textile_.
 * @glyph compile@ -- to compile the current document into a single HTML file.
+* @glyph compile --auto@ -- to keep recompiling the current document every time a file is changed.
 * @glyph compile -f pdf@ -- to compile the current document into HTML and then transform it into PDF using <a href="http://www.princexml.com/">Prince</a>.
 * @glyph compile readme.glyph@ -- to compile a _readme.glyph_ located in the current directory into a single HTML file.
+* @glyph outline -l 2@ -- Display the document outline, up to second-level headers.
 
 </div>
 
 <div class="section">
 <h2 id="macros_nutshell">Glyph macros in a nutshell</h2>
-
 Format your documents using Textile or Markdown, and use Glyph Macros to do everything else:
 
 **Glyph Source:**
@@ -53,11 +56,20 @@ Format your documents using Textile or Markdown, and use Glyph Macros to do ever
 <div class="code">
 <pre>
 <code>
-section[header[Something about Glyph]
-You can use Glyph macros in conjunction
- with _Textile_ or _Markdown_ to
+section[
+  @title[Something about Glyph]
+  txt[
+You can use Glyph macros in conjunction 
+with _Textile_ or _Markdown_ to
 produce HTML files effortlessly.
-  section[header[What about PDFs?|pdf]
+  ]
+  p[
+Alternatively, you can just use em[Glyph itself]
+to generate HTML tags.
+  ]
+  section[
+    @title[What about PDFs?]
+    @id[pdf]
 Once you have a single, well-formatted HTML 
 file, converting it to PDF is
 extremely easy with a 3rd-party 
@@ -76,15 +88,23 @@ renderer like =>[http://www.princexml.com|Prince].
 <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>
+    You can use Glyph macros in conjunction with 
+    <em>Textile</em> or <em>Markdown</em> to
+    produce HTML files effortlessly.
+  </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 3rd-party renderer 
-      like <a href="http://www.princexml.com">Prince</a>.</p>
+   <p>
+     Once you have a single, well-formatted HTML 
+     file, converting it to PDF is
+     extremely easy with a 3rd-party renderer 
+     like <a href="http://www.princexml.com">Prince</a>.
+   </p>
+   <p>
+     Alternatively, you can just use <em>Glyph itself</em>
+     to generate HTML tags.
+   </p>
   </div>
 </div>
 </code>
@@ -95,14 +115,13 @@ renderer like =>[http://www.princexml.com|Prince].
 
 <div class="section">
 <h2 id="h_5">Resources</h2>
-
 * Home Page: <a href="http://www.h3rald.com/glyph/">http://www.h3rald.com/glyph/</a>
 * Repository: <a href="http://www.github.com/h3rald/glyph/">http://www.github.com/h3rald/glyph/</a>
 * Bug Tracking: <a href="http://www.github.com/h3rald/glyph/issues">http://www.github.com/h3rald/glyph/issues</a>
 * Development Wiki <a href="http://wiki.github.com/h3rald/glyph">http://wiki.github.com/h3rald/glyph</a>
 * RubyGem Download <a href="http://www.rubygems.org/gems/glyph">http://www.rubygems.org/gems/glyph</a>
-* Book (PDF): <a href="http://github.com/h3rald/glyph/raw/0.1.0/book/output/pdf/glyph.pdf">http://github.com/h3rald/glyph/raw/0.1.0/book/output/pdf/glyph.pdf</a>
+* Book (PDF): <a href="http://github.com/h3rald/glyph/raw/0.2.0/book/output/pdf/glyph.pdf">http://github.com/h3rald/glyph/raw/0.2.0/book/output/pdf/glyph.pdf</a>
 * Reference Documentation: <a href="http://yardoc.org/docs/h3rald-glyph/">http://yardoc.org/docs/h3rald-glyph/</a>
 * User Group: <a href="http://groups.google.com/group/glyph-framework">http://groups.google.com/group/glyph-framework</a>
 
-</div>
+</div>