glyph 0.4.2 → 0.5.0

data/book/lib/macros/reference.rb

@@ -123,7 +123,7 @@ macro :ref_macro do
 	m_aliases = "aliases[#{raw_attr(:aliases)}]" if raw_attr(:aliases)
 	m_remarks = %{section[
 		@title[Remarks]
-		@notoc[:true]
+		@notoc[true]
 			txt[
 #{raw_attr(:remarks)}
 			]
@@ -187,7 +187,7 @@ macro :class do
 	else
 		path = value
 	end
-	interpret %{=>[&[yardoc]/#{path}|code[#{value}]]}
+	interpret %{=>[&[rubydoc]/#{path}|code[#{value}]]}
 end
 
 

data/book/lib/tasks/tasks.rake

@@ -41,7 +41,7 @@ namespace :generate do
 		(dir/'glyph/book/images/glyph/glyph.eps').unlink 
 		(dir/'glyph/book/images/glyph/glyph.svg').unlink
 		# Create project page
-		project = Glyph.filter %{layout:project[
+		project = Glyph.filter %{layout/project[
 				@contents[#{file_load(Glyph::PROJECT/'text/introduction.glyph')}]
 			]}
 		file_write dir/"glyph.textile", project

data/book/text/acknowledgements.glyph

@@ -7,5 +7,6 @@ Special thanks to the following individuals who contributed to Glyph by reportin
 * =>[http://balcone.eveel.ru|Dmitry A. Ustalov] (eveel)
 * =>[http://www.stuartellis.eu|Stuart Ellis] (stuartellis)
 * Eric Givens (darthzippy)
+* =>[http://www.taylored-software.com/|Tammy Cravit] (tammycravit)
 ]
     

data/book/text/changelog.glyph

@@ -1,134 +1,162 @@
 %[=
 macro :features do
-	verb = (@name == :features) ? "Implemented" : "Fixed"
-	total = @node.child_macros.length
-	name = @name.to_s.capitalize
-	name.chop! if total == 1
-	interpret %{
-		section[
-			@title[#{total} #{name} #{verb}]
-			table[
-				tr[
-					th[ID]
-					th[Description]
-				]
-				#{@node.value}
-			]
-		]
-	}
+  verb = (@name == :features) ? "Implemented" : "Fixed"
+  total = @node.child_macros.length
+  name = @name.to_s.capitalize
+  name.chop! if total == 1
+  interpret %{
+    section[
+      @title[#{total} #{name} #{verb}]
+      table[
+        tr[
+          th[ID]
+          th[Description]
+        ]
+        #{@node.value}
+      ]
+    ]
+  }
 end
 
 macro_alias :bugs => :features
 =]
-rw:[release|
-	section[
-		@title[v{{0}} – {{1}}]
-		{{2}}
-	]
+def:[release|
+  section[
+    @title[v{{0}} – {{1}}]
+    {{2}}
+
+    p/em[→ View closed issues on =>[https://github.com/h3rald/glyph/issues?direction=asc&labels={{0}}&sort=created&state=closed|GitHub].]
+  ]
 ]
-rw:[issue|
-	tr[
-		td[\.=>[http://github.com/h3rald/glyph/issues/closed#issue/{{0}}|#{{0}}]]
-		td[txt[{{1}}]]
-	]
+def:[issue|
+  tr[
+    td[\/=>[https://github.com/h3rald/glyph/issues/{{0}}|#{{0}}]]
+    td[txt[{{1}}]]
+  ]
 ]
 ?[eq[%[ARGV\[0\]]|generate]|
-	%:[%>|"#{value} macro"]
-	%:[#>|"#{value} command"]
-	%:[$>|"#{value} setting"]
+  %:[%>|"#{value} macro"]
+  %:[#>|"#{value} command"]
+  %:[$>|"#{value} setting"]
+]
+release[0.5.0|August 28th 2011|
+  features[
+    issue[152|It is now possible to generate a PDF document through HTML5, not only HTML, by setting the @output.pdf.through@ setting to @html5@.]    
+    issue[165|The %>[fragment] and the %>[embed] can be used to delimit and embed text fragments, in a way much similar to snippets.]
+    issue[177|Introduced the concept of "macro representations", to make macro code output-independent.]
+    issue[179|Macro can be composed with other macros via backslashes, provided that containers only take exactly one parameter. The new %>[xml] dispatcher must be used composed with other macros to create raw XML tags, prepending = to macro names no longer works.]
+    issue[180|Glyph can now generate ebooks in MOBI and EPUB format – with Calibre's help.]
+    issue[181|By using the new %>[let] macro, it is possible to define lexically scoped "variables" via the %>[attribute:], and retrieve them within the scope of the let macro using the %>[attribute].]
+    issue[182|A %>[while] can be used to execute glyph code multiple times.]
+    issue[183|The %>[s] dispatcher can be used to call almost any instance method of the Ruby String class. The @match@ macro cannot be used anymore; use @s/match@ instead.]
+    issue[184|The old @rewrite:@ macro has been renamed to @define:@. The new %>[define:] fully supports recursion.]
+    issue[189|The %>[add], the %>[subtract] and the %>[multiply] macro can be used to perform operations on integers.]
+    issue[190|The lt, gt, lte, gte macros can be used to compare integer values.]
+    issue[194|The %>[load] macro can be used to embed the contents of a file without performing any evaluation.]
+    issue[195|@\\/@ must not be used as invisible space separator, instead of @\\.@.]
+    issue[197|Snippets are no longer managed via a separate snippet.yml file and _must_ be defined within Glyph source files, using the %>[snippet:].]
+    issue[200|Typing @glyph -v@ now prints the current version of Glyph on the screen.]
+    issue[201|Glyph no longer depends on Jeweler to create and manage its gem.]
+  ]
+  bugs[
+    issue[151|Fixed a bug related to Jeweler's gemspec validation. And for all it matters, Jeweler is no longer a development dependency for Glyph.]
+    issue[166|Temporary output files are now placed in a temporary folder.]
+    issue[196|Glyph now handles non-ASCII characters properly with Ruby 1.9 as well.]
+    issue[199|Fixed a bug that caused incorrect TOC nesting when using the @src@ attribute of the %>[section].]
+  ]
 ]
 release[0.4.2|October 22th 2010|
-	features[
-		issue[172|A new %>[output?] macro can be used to test whether Glyph is compiling to a particular output format.]
-		issue[175|The conditional macro now support a third parameter (else branch).]
-		issue[176|A bunch of new aliases and shortcuts are available for the section macro.]
-	]
-	bugs[
-		issue[178|No error is raised anymore if less than the required parameters/attributes are supplied to a rewritten macro.]
-	]
+  features[
+    issue[172|A new %>[output?] can be used to test whether Glyph is compiling to a particular output format.]
+    issue[175|The conditional macro now support a third parameter (else branch).]
+    issue[176|A bunch of new aliases and shortcuts are available for the section macro.]
+  ]
+  bugs[
+    issue[178|No error is raised anymore if less than the required parameters/attributes are supplied to a rewritten macro.]
+  ]
 ]
 release[0.4.1|September 23th 2010|
-	bugs[
-		issue[169|*.scss files are now supported by the %>[style].]
-		issue[170|Improved default CodeRay stylesheet.]
-		issue[171|SCSS now used internally by Glyph to generate default CSS files.]
-		issue[173|Consecutive escape sequences are now interpreted correctly in topics.]
-		issue[174|Fixed error causing broken images in web5/html5 output.]
-	]
+  bugs[
+    issue[169|*.scss files are now supported by the %>[style].]
+    issue[170|Improved default CodeRay stylesheet.]
+    issue[171|SCSS now used internally by Glyph to generate default CSS files.]
+    issue[173|Consecutive escape sequences are now interpreted correctly in topics.]
+    issue[174|Fixed error causing broken images in web5/html5 output.]
+  ]
 ]
 release[0.4.0|September 3th 2010|
-	features[
-		issue[40|A new #>[stats] can be used to display statistics about project files, snippets, macros, bookmarks and links.]
-		issue[73|It is now possible to validate online HTTP links.]
-		issue[112|It is now possible to use _wkhtmltopdf_ instead of Prince to generate PDF files from HTML files.]
-		issue[114|It is now possible to generate documents comprised of multiple files (topics).]
-		issue[115|It is now possible to define layouts (used when generating multi-file outputs) using Glyph macros.]
-		issue[120|It is now possible to compile your project to a single HTML5 file (@html5@ output) or multiple files (@web5@ output)]
-		issue[135|Stylesheets can now be linked and imported as well as embedded.]
-		issue[138|@web@ and @web5@ output formats inherit @html@ macros.]
-		issue[142|A new %>[navigation] can be used in @web@ and @web5@ outputs to navigate through topics.]
-		issue[143|A topic-based TOC is generated when compiling to @web@ or @web5@]
-		issue[144|Two new validators are now available to check whether a macro has (or doesn't have) a certain ancestor: @within@ and @not_within@.]
-		issue[147|The default stylesheets provided by Glyph are now compatible with HTML5 outputs (html5 and web5).]
-		issue[148|It is now possible to create custom tasks and commands to extend Glyph functionality.]
-	]
-	bugs[
-		issue[133|Added HTML charset to Glyph documents (utf-8).]
-		issue[136|Moved utility functions to separate @Glyph::Utils@ module.]
-		issue[139|Heavily restructured Glyph configuration.]
-		issue[140|Added @Glyph::Macro::Helpers@ module to avoid code duplication in macros for different output formats.]
-		issue[141|Prevented non-rb files to be loaded as macros.]
-		issue[145|Dotfiles are now ignored by #>[init].]
-		issue[167|Fixed PDF book download links.]
-	]
+  features[
+    issue[40|A new #>[stats] can be used to display statistics about project files, snippets, macros, bookmarks and links.]
+    issue[73|It is now possible to validate online HTTP links.]
+    issue[112|It is now possible to use _wkhtmltopdf_ instead of Prince to generate PDF files from HTML files.]
+    issue[114|It is now possible to generate documents comprised of multiple files (topics).]
+    issue[115|It is now possible to define layouts (used when generating multi-file outputs) using Glyph macros.]
+    issue[120|It is now possible to compile your project to a single HTML5 file (@html5@ output) or multiple files (@web5@ output)]
+    issue[135|Stylesheets can now be linked and imported as well as embedded.]
+    issue[138|@web@ and @web5@ output formats inherit @html@ macros.]
+    issue[142|A new %>[navigation] can be used in @web@ and @web5@ outputs to navigate through topics.]
+    issue[143|A topic-based TOC is generated when compiling to @web@ or @web5@]
+    issue[144|Two new validators are now available to check whether a macro has (or doesn't have) a certain ancestor: @within@ and @not_within@.]
+    issue[147|The default stylesheets provided by Glyph are now compatible with HTML5 outputs (html5 and web5).]
+    issue[148|It is now possible to create custom tasks and commands to extend Glyph functionality.]
+  ]
+  bugs[
+    issue[133|Added HTML charset to Glyph documents (utf-8).]
+    issue[136|Moved utility functions to separate @Glyph::Utils@ module.]
+    issue[139|Heavily restructured Glyph configuration.]
+    issue[140|Added @Glyph::Macro::Helpers@ module to avoid code duplication in macros for different output formats.]
+    issue[141|Prevented non-rb files to be loaded as macros.]
+    issue[145|Dotfiles are now ignored by #>[init].]
+    issue[167|Fixed PDF book download links.]
+  ]
 ]
 release[0.3.0|June 13th 2010|
-	features[
-		issue[39|A new #>[outline] is available to display the document outline.]
-		issue[110|It is now possible to use Glyph language to produce arbitrary XML code.]
-		issue[111|System settings are now stored within a @system.*@ namespace and cannot be changed via the %>[config:] or the #>[config].]
-		issue[116|It is now possible to use named attributes within Glyph macros.]
-		issue[119|#[new_parser]A new parser was implemented from scratch to improve performance. Treetop gem no longer required.]
-		issue[121|Some macros have been removed in favor of XML fallback, others have been updated.]
-		issue[123|The SyntaxNode class has been specialized to differentiate between macros, attributes, parameters, text and escapes.]
-		issue[124|Implemented new %>[article] and %>[book].]
-		issue[126|A new %>[rewrite:] has been implemented to create simple macros using just Glyph code.]
-		issue[127|A new %>[alias] has been implemented to create macro aliases.]
-		issue[128|A blacklist for XML tags has been exposed via the @language.options.xml_blacklist@ setting.]
-		issue[129|The %>[include] can now be used in lite mode, it can evaluate ruby files and requires relative paths.]
-		issue[130|A new "safe mode" has been implemented to explicitly forbid certain potentially unsafe macros.]
-	]
-	bugs[
-		issue[109|Performance has been dramatically improved by implementing a parser from scratch (see =>[#new_parser|#119])]
-		issue[122|Macro encoding/decoding no longer necessary due to the new parser (see =>[#new_parser|#119])]
-		issue[125|Warning messages have been streamlined.]
-	]
+  features[
+    issue[39|A new #>[outline] is available to display the document outline.]
+    issue[110|It is now possible to use Glyph language to produce arbitrary XML code.]
+    issue[111|System settings are now stored within a @system.*@ namespace and cannot be changed via the %>[config:] or the #>[config].]
+    issue[116|It is now possible to use named attributes within Glyph macros.]
+    issue[119|#[new_parser]A new parser was implemented from scratch to improve performance. Treetop gem no longer required.]
+    issue[121|Some macros have been removed in favor of XML fallback, others have been updated.]
+    issue[123|The SyntaxNode class has been specialized to differentiate between macros, attributes, parameters, text and escapes.]
+    issue[124|Implemented new %>[article] and %>[book].]
+    issue[126|A new @rewrite@ macro has been implemented to create simple macros using just Glyph code.]
+    issue[127|A new %>[alias] has been implemented to create macro aliases.]
+    issue[128|A blacklist for XML tags has been exposed via the @language.options.xml_blacklist@ setting.]
+    issue[129|The %>[include] can now be used in lite mode, it can evaluate ruby files and requires relative paths.]
+    issue[130|A new "safe mode" has been implemented to explicitly forbid certain potentially unsafe macros.]
+  ]
+  bugs[
+    issue[109|Performance has been dramatically improved by implementing a parser from scratch (see =>[#new_parser|#119])]
+    issue[122|Macro encoding/decoding no longer necessary due to the new parser (see =>[#new_parser|#119])]
+    issue[125|Warning messages have been streamlined.]
+  ]
 ]
 release[0.2.0|May 9th 2010|
-	features[
-		issue[62|A new %>[highlight] is available to highlight source code (CodeRay or UltraViolet required).]
-		issue[76|It is now possible to use Glyph programmatically via the new @Glyph#filter@ and @Glyph#compile@ methods.]
-		issue[87|It is now possible to define snippets inside a Glyph source file using the %>[snippet:].]	
-		issue[88|It is now possible to change configuration settings inside a Glyph source file using the %>[config:] (Jabbslad).]	
-		issue[89|It is now possible to compile a single Glyph source file without creating a Glyph project.]
-		issue[92|6 new macros have been defined to allow conditional processing (\.%>[condition], %>[eq], %>[not], %>[and], %>[or], %>[match])]
-		issue[94|It is now possible to add _validators_ to macros, for example to check the number of parameters they take.]
-		issue[97|The #>[compile] command can now take an extra @--auto@ switch to trigger document auto-regeneration whenever a source file is changed (koraktor).]
-		issue[99|Added a @document.draft@ setting. If set to @true@, comments and TODOs are rendered in output files.]
-		issue[100|#[system_css]Glyph CSS files are no longer copied to new projects, but they can be referenced as if they were (see also =>[#css_not_copied|#93]).]
-		issue[108|It is now possible to define Glyph macros within Glyph source files using the %>[macro:].]
-	]
-	bugs[
-		issue[86|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.] 
-		issue[93|#[css_not_copied]Default css files were not copied when creating a new project. The issue has been resolved by allowing the %>[style] to reference Glyph's system styles (see also =>[#system_css|#100]).]
-		issue[95|The #>[config] did not save data to YAML configuration files. This has been fixed ensuring that internal configuration overrides are not saved to the YAML file too.]
-		issue[98|Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.]
-		issue[101|Additional tests have been developed to improve Textile support. There should no longer be errors when using textile block elements inside Glyph macros.]
-		issue[103|Fixed a bug that caused test failures when deleting the test project directory.]
-		issue[104|Nested Glyph macros calling @Macro#interpret@ no longer ignore escape delimiters.]
-		issue[107|Added the possibility to encode (using the @encode@ macro) and decode (using the @decode@ macro) macros so that they can be interpreted later.]
-	]
+  features[
+    issue[62|A new %>[highlight] is available to highlight source code (CodeRay or UltraViolet required).]
+    issue[76|It is now possible to use Glyph programmatically via the new @Glyph#filter@ and @Glyph#compile@ methods.]
+    issue[87|It is now possible to define snippets inside a Glyph source file using the %>[snippet:].]  
+    issue[88|It is now possible to change configuration settings inside a Glyph source file using the %>[config:] (Jabbslad).]  
+    issue[89|It is now possible to compile a single Glyph source file without creating a Glyph project.]
+    issue[92|6 new macros have been defined to allow conditional processing (\/%>[condition], %>[eq], %>[not], %>[and], %>[or], %>[match])]
+    issue[94|It is now possible to add _validators_ to macros, for example to check the number of parameters they take.]
+    issue[97|The #>[compile] command can now take an extra @--auto@ switch to trigger document auto-regeneration whenever a source file is changed (koraktor).]
+    issue[99|Added a @document.draft@ setting. If set to @true@, comments and TODOs are rendered in output files.]
+    issue[100|#[system_css]Glyph CSS files are no longer copied to new projects, but they can be referenced as if they were (see also =>[#css_not_copied|#93]).]
+    issue[108|It is now possible to define Glyph macros within Glyph source files using the %>[macro:].]
+  ]
+  bugs[
+    issue[86|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.] 
+    issue[93|#[css_not_copied]Default css files were not copied when creating a new project. The issue has been resolved by allowing the %>[style] to reference Glyph's system styles (see also =>[#system_css|#100]).]
+    issue[95|The #>[config] did not save data to YAML configuration files. This has been fixed ensuring that internal configuration overrides are not saved to the YAML file too.]
+    issue[98|Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.]
+    issue[101|Additional tests have been developed to improve Textile support. There should no longer be errors when using textile block elements inside Glyph macros.]
+    issue[103|Fixed a bug that caused test failures when deleting the test project directory.]
+    issue[104|Nested Glyph macros calling @Macro#interpret@ no longer ignore escape delimiters.]
+    issue[107|Added the possibility to encode (using the @encode@ macro) and decode (using the @decode@ macro) macros so that they can be interpreted later.]
+  ]
 ]
 release[0.1.0|April 8th 2010|
-	Initial release.
+  Initial release.
 ]

data/book/text/compiling/compiling.glyph

@@ -6,42 +6,54 @@ By default, a Glyph project can be "compiled" into an HTML document. Additionall
 * Web5 (i.e. multiple HTML5 files)
 ]
 section[
-	@title[HTML/HTML5 output]
-	p[To compile a Glyph project to an HTML document, use the #>[compile] within your Glyph project folder. Glyph parses the code[document.glyph] file (and all included files and snippets); if no errors are found, Glyph creates an HTML document in the code[/output/html] folder.] 
-	p[The name of the HTML file can be set in the configuration (\.$>[document.filename]).]
-	p[To create an HTML5 file instead, you must specify it explicitly like this:]
-	p[code[= glyph compile -f html5 =]]
+  @title[HTML/HTML5 output]
+  p[To compile a Glyph project to an HTML document, use the #>[compile] within your Glyph project folder. Glyph parses the code[document.glyph] file (and all included files and snippets); if no errors are found, Glyph creates an HTML document in the code[/output/html] folder.]
+  p[The name of the HTML file can be set in the configuration (\/$>[document.filename]).]
+  p[To create an HTML5 file instead, you must specify it explicitly like this:]
+  p[code[= glyph compile -f html5 =]]
 ]
 section[
-	@title[PDF Output]
-	p[To generate a PDF document, you must specify code[pdf] as format, like this:]
-	p[code[= glyph compile -f pdf =]]
-	p[The command above will attempt to compile the project into an HTML document and then call a third-party PDF generator to convert it into a PDF file.]
-	txt[
+  @title[PDF Output]
+  p[To generate a PDF document, you must specify code[pdf] as format, like this:]
+  p[code[= glyph compile -f pdf =]]
+  p[The command above will attempt to compile the project into an HTML document and then call a third-party PDF generator to convert it into a PDF file.]
+  txt[
 Currently, Glyph supports:
 * &[prince] (version 7.0 or higher) -- a commercial generator that can be used freely for personal use. Prince produces high-quality PDF files and implement most of the new features introduced in CSS3, used heavily in Glyph's =>[#default_stylesheets|code[pagination.css]] default stylesheet.
 * &[wkhtml] (version 1.0 beta4 or higher) -- an open source generator that uses the WebKit rendering engine to transform HTML files into PDF. Although not as advanced as Prince, it produces very satisfactory results.
 
-By default, Glyph attempts to use wkhtmltopdf. To change this, set the $>[output_pdf_generator] to code[prince]. 
-	]
-	note[Glyph expects PDF generators to be installed on the local machine and callable via command line using the code[wkhtmltopdf] or the code[prince] commands. Just install them as you would with any other program, depending on your operating system (yes, they both offer Windows installers).]
-	tip[Glyph's default CSS file use the free em[Gentium] font for all text. You can download it from =>[http://www.sil.org/~gaultney/gentium/|here].]
+By default, Glyph attempts to use wkhtmltopdf. To change this, set the $>[output_pdf_generator] to code[prince].
+  ]
+  note[Glyph expects PDF generators to be installed on the local machine and callable via command line using the code[wkhtmltopdf] or the code[prince] commands. Just install them as you would with any other program, depending on your operating system (yes, they both offer Windows installers).]
+  tip[Glyph's default CSS file use the free em[Gentium] font for all text. You can download it from =>[http://www.sil.org/~gaultney/gentium/|here].]
 ]
+
+section[
+  @title[EPUB/MOBI output]
+  p[To generate .epub or .mobi e-books, you must specify code[epub] or code[mobi] as format, like this:]
+  p[code[= glyph compile -f mobi =]]
+  p[code[= glyph compile -f epub =]]
+  p[This option requires that you have &[calibre] and its command-line tools installed. Glyph assumes the ebook-convert command is installed in /usr/bin. If this is not so, you can set the code[options.ebook.converter] option to the path to the ebook-convert command.]
+  p[If you have cover art for your e-book, put it in the code[images] folder, and specify the name of the file in the code[document.cover] configuration option.]
+  p[You can also specify the output profile used by the code[ebook-convert] command by setting the code[output.epub.profile] and code[output.mobi.profile] options. If these are not specified, the conversion will use the code[kindle] output profile for mobi files, and the code[nook] output profile for epub files. See the documentation for Calibre for a list of available output profiles.]
+  tip[Giving the command code[= glyph compile -f ebooks =] will generate both mobi and epub files.]
+]
+
 section[
-	@title[Web/Web5 Output]
-	@id[web_output]
-	txt[
-To generate a Web or Web5 output, specify @web@ or @web5@ as format. These two output formats behave different way from the others, and require that your project uses =>[#topics|topics] and =>[#layouts|layouts]. 
+  @title[Web/Web5 Output]
+  @id[web_output]
+  txt[
+To generate a Web or Web5 output, specify @web@ or @web5@ as format. These two output formats behave different way from the others, and require that your project uses =>[#topics|topics] and =>[#layouts|layouts].
 
 Basically, here's what happens when you compile your project in web or web5 format:
 # The document code is parsed as normal
 # Separate topic files are generated according to the code[@src] attributes of your sections
-# The code[document.glyph] (or whatever file you're using as document source) is _not_ rendered. Instead, an @index.html@ file will be created in the output folder based on the contents of your =>[#index_layout|index layout]. 
-	]	
+# The code[document.glyph] (or whatever file you're using as document source) is _not_ rendered. Instead, an @index.html@ file will be created in the output folder based on the contents of your =>[#index_layout|index layout].
+  ]
 ]
 section[
-	@title[Auto Regeneration]
-	@id[auto_regeneration]
-	txt[You can also call the #>[compile] with a @--auto@ switch. If you do so, your project will be recompiled automatically every time any source file is changed.]
-	note[Auto regeneration requires the =>[http://rubygems.org/gems/directory_watcher|directory_watcher] gem to be installed.]
+  @title[Auto Regeneration]
+  @id[auto_regeneration]
+  txt[You can also call the #>[compile] with a @--auto@ switch. If you do so, your project will be recompiled automatically every time any source file is changed.]
+  note[Auto regeneration requires the =>[http://rubygems.org/gems/directory_watcher|directory_watcher] gem to be installed.]
 ]

data/book/text/compiling/lite_mode.glyph

@@ -1,12 +1,12 @@
-	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[If you want to write a one-page article or a short draft, however, creating and managing Glyph projects can be an unnecessary burden. Luckily, you don't have to: you can use Glyph to compile single files containing Glyph code, by adding one parameter (or two if you want to specify a custom destination file) to the #>[compile], like this:]
-	p[code[glyph compile source.glyph destination.htm]]
-	p[This command will process a file called code[source.glyph] and produce an HTML file called code[destination.htm].]
-	section[
-		@title[Limitations]
-		@id[lite_limitations]
-		&:[only_defined_through|can only be defined inside the source file, using the]
-		txt[
+  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[If you want to write a one-page article or a short draft, however, creating and managing Glyph projects can be an unnecessary burden. Luckily, you don't have to: you can use Glyph to compile single files containing Glyph code, by adding one parameter (or two if you want to specify a custom destination file) to the #>[compile], like this:]
+  p[code[glyph compile source.glyph destination.htm]]
+  p[This command will process a file called code[source.glyph] and produce an HTML file called code[destination.htm].]
+  section[
+    @title[Limitations]
+    @id[lite_limitations]
+    &:[only_defined_through|can only be defined inside the source file, using the]
+    txt[
 &:[referenced_with_path|must be referenced with their absolute path, or a path relative to the current directory]
 This sort of "lite" mode comes with a few minor limitations: 
 * Snippets &[only_defined_through] %>[snippet:].
@@ -15,5 +15,5 @@ This sort of "lite" mode comes with a few minor limitations:
 * Images &[referenced_with_path], and will not be copied anywhere when the output file is generated.
 * Stylesheets &[referenced_with_path], or the name of an existing Glyph =>[#default_stylesheets|system stylesheet].
 * The files included through the %>[include] &[referenced_with_path].
-		]
-	]
+    ]
+  ]

data/book/text/compiling/programmatic_usage.glyph

@@ -1,73 +1,73 @@
-	txt[
-Besides using Glyph from the command line, you can also use it straight from your code. Glyph's public =>[http://yardoc.org/docs/glyph/Glyph|API] is simple and can be used to:
+  txt[
+Besides using Glyph from the command line, you can also use it straight from your code. Glyph's public =>[&[rubydoc]|API] is simple and can be used to:
 * Retrieve and update configuration settings (using @Glyph\[\]@ and @Glyph\[\]=@)
 * Filter text to HTML (using @Glyph#filter@)
 * Compile Glyph source files into HTML or PDF files (using @Glyph#compile@)
 
 That's pretty much it. Of course, both the @filter@ and @compile@ method cause Glyph to run in =>[#lite_mode|_lite_ mode], so the same =>[#lite_limitations|limitations] apply. 
-	]
-	tip[
-		txt[
+  ]
+  tip[
+    txt[
 For an example on how to use Glyph programmatically (specifically in conjunction with the =>[http://nanoc.stoneship.org/|nanoc] static site generator), see =>[http://github.com/h3rald/h3rald|h3rald.com source code], in particular:
 * =>[http://github.com/h3rald/h3rald/blob/master/lib/glyph_filter.rb|lib/glyph_filter.rb] -- using the @Glyph#filter@ method.
 * =>[http://github.com/h3rald/h3rald/blob/master/lib/glyph_context.rb|lib/glyph_context.rb] -- using the @Glyph#compile@ method to generate PDF files.
-		]
-	]
-	section[
-		@title[Modes]
-		@id[modes]
-		p[It is possible to specify some flags (or "modes") to make Glyph behave slightly different than normal, as shown in the following table (by default, none of these is used).]
-		table[
-			tr[
-				th[Name]
-				th[Writer Method]
-				th[Reader Method]
-				th[Description]
-			]
-			tr[
-				td[Test Mode]
-				td[code[Glyph.test_mode=]]
-				td[code[Glyph.test?]]
-				td[Used internally by the code[rake spec] task to run Glyph's specs.]
-			]
-			tr[
-				td[Library Mode]
-				td[code[Glyph.library_mode=]]
-				td[code[Glyph.library?]]
-				td[If enabled, the #>[compile] command will raise exceptions instead of printing errors on the screen. Enabled by the code[Glyph.compile] command.]
-			]
-			tr[
-				td[Debug Mode]
-				td[code[Glyph.debug_mode=]]
-				td[code[Glyph.debug?]]
-				td[If enabled, additional diagnostic information (such as backtraces or macro values) will be displayed. Enabled by specifying the =>[#debug_switch|debug switch] when running a Glyph command.]
-			]
-			tr[
-				td[Lite Mode]
-				td[code[Glyph.lite_mode=]]
-				td[code[Glyph.lite?]]
-				td[
-					txt[
+    ]
+  ]
+  section[
+    @title[Modes]
+    @id[modes]
+    p[It is possible to specify some flags (or "modes") to make Glyph behave slightly different than normal, as shown in the following table (by default, none of these is used).]
+    table[
+      tr[
+        th[Name]
+        th[Writer Method]
+        th[Reader Method]
+        th[Description]
+      ]
+      tr[
+        td[Test Mode]
+        td[code[Glyph.test_mode=]]
+        td[code[Glyph.test?]]
+        td[Used internally by the code[rake spec] task to run Glyph's specs.]
+      ]
+      tr[
+        td[Library Mode]
+        td[code[Glyph.library_mode=]]
+        td[code[Glyph.library?]]
+        td[If enabled, the #>[compile] command will raise exceptions instead of printing errors on the screen. Enabled by the code[Glyph.compile] command.]
+      ]
+      tr[
+        td[Debug Mode]
+        td[code[Glyph.debug_mode=]]
+        td[code[Glyph.debug?]]
+        td[If enabled, additional diagnostic information (such as backtraces or macro values) will be displayed. Enabled by specifying the =>[#debug_switch|debug switch] when running a Glyph command.]
+      ]
+      tr[
+        td[Lite Mode]
+        td[code[Glyph.lite_mode=]]
+        td[code[Glyph.lite?]]
+        td[
+          txt[
 Used to compile =>[#lite_mode|single files]. Enabled by:
 * The @Glyph.compile@ and @Glyph.filter@ methods.
 * The #>[compile], if at least one parameter is supplied.
-					]
-				]
-			]
-			tr[
-				td[Safe Mode]
-				td[code[Glyph.safe_mode=]]
-				td[code[Glyph.safe?]]
-				td[
-					txt[
+          ]
+        ]
+      ]
+      tr[
+        td[Safe Mode]
+        td[code[Glyph.safe_mode=]]
+        td[code[Glyph.safe?]]
+        td[
+          txt[
 If enabled, the following macros cannot be used and will return an error:
 * %>[ruby]
 * %>[macro:]
 * %>[include]
-* %>[rewrite:]
+* %>[define:]
 * %>[config:]
-					]
-				]
-			]
-		]
-	]
+          ]
+        ]
+      ]
+    ]
+  ]