glyph 0.4.2 → 0.5.0

data/book/text/macros/macros_filters.glyph

@@ -1,4 +1,4 @@
-rw:[filtered_section|
+def:[filtered_section|
 	ref_macro[
 		@n[{{markup}}_section]
 		@desc[Creates a section (see %>[section]) whose content can be formatted with {{markup}} markup.]

data/book/text/macros/macros_inline.glyph

@@ -29,9 +29,9 @@
 
 	ref_macro[
 		@n[link]
-		@desc[Creates an hyperlink (\.fmi[creating links|#links]).]
-		@aliases[\.=>]
-		@example[=\.=>[http://www.h3rald.com\|H3RALD.com]=]
+		@desc[Creates an hyperlink (\/fmi[creating links|#links]).]
+		@aliases[\/=>]
+		@example[=\/=>[http://www.h3rald.com\|H3RALD.com]=]
 		@params[
 			-p[0|A valid bookmark within the document or an URL.]
 			-p[1|The text of the link &[opt].]

data/book/text/macros/macros_structure.glyph

@@ -83,7 +83,7 @@ section[
 
 	ref_macro[
 		@n[style]
-		@desc[Embeds the content of a CSS or Sass file within a @<style>@ tag (\.fmi[stylesheets|#stylesheets]).]
+		@desc[Embeds the content of a CSS or Sass file within a @<style>@ tag (\/fmi[stylesheets|#stylesheets]).]
 		@example[=style[default.css]=]
 		@params[-p[0|The stylesheet file to embed.]]
 	]

data/book/text/ref_commands.glyph

@@ -4,136 +4,141 @@ Glyph's command-line interface has been built using the =>[http://github.com/dav
 strong[glyph] em[global_options] strong[command] em[options] em[parameters]
 
 Where:
-* em[global_options] and _options_ are in the form: @-n@ _value_ or @--name=@\._value_, e.g. @-f pdf@ or @--format=pdf@
+* em[global_options] and _options_ are in the form: @-n@ _value_ or @--name=@\/_value_, e.g. @-f pdf@ or @--format=pdf@
 * _parameters_ are separated by whitespaces, and can be wrapped in quotes.
 ]
 section[
-	@title[Global Options]
-	section[
-		@title[code[-d], code[--debug]]
-		@id[debug_switch]
-		p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.]
-	]
+  @title[Global Options]
+  section[
+    @title[code[-d], code[--debug]]
+    @id[debug_switch]
+    p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.]
+  ]
+  section[
+    @title[code[-v], code[--version]]
+    @id[version_switch]
+    p[Prints the current version of Glyph, ignoring any other command or switches.]
+  ]
 ]
 section[
-	@title[add]
-	@id[c_add]
-	p[Creates a new text file in the code[text/] folder.]
-	example[glyph add introduction.textile]
-	parameters[
-	-p[em[file_name]|The name (or relative path) of the new file to be created.]
-	]
+  @title[add]
+  @id[c_add]
+  p[Creates a new text file in the code[text/] folder.]
+  example[glyph add introduction.textile]
+  parameters[
+  -p[em[file_name]|The name (or relative path) of the new file to be created.]
+  ]
 ]
 section[
-	@title[compile]
-	@id[c_compile]
-	p[Compiles a Glyph document into an output file. If no options are specified, the code[document.glyph] file is used as source to produce a standalone HTML file.]
-	example[glyph compile -f pdf]
-	parameters[
-	-p[em[source]|The source glyph file to compile em[(Optional)].]
-	-p[em[destination]|The destination file em[(Optional)].]
-	]
-	options[
-		-o[source|
+  @title[compile]
+  @id[c_compile]
+  p[Compiles a Glyph document into an output file. If no options are specified, the code[document.glyph] file is used as source to produce a standalone HTML file.]
+  example[glyph compile -f pdf]
+  parameters[
+  -p[em[source]|The source glyph file to compile em[(Optional)].]
+  -p[em[destination]|The destination file em[(Optional)].]
+  ]
+  options[
+    -o[source|
 The source file to compile. 
-			default[document.glyph]
-	]
-		-o[format|
+      default[document.glyph]
+  ]
+    -o[format|
 The format of the output file.
-			default[html]
-			values[html, pdf]
-		]
-		-o[auto|
+      default[html]
+      values[html, pdf]
+    ]
+    -o[auto|
 If specified, enable =>[#auto_regeneration|auto regeneration] (requires the =>[http://rubygems.org/gems/directory_watcher|directory_watcher] gem to be installed).
-		]
-	]
+    ]
+  ]
 ]
 section[
-	@title[config]
-	@id[c_config]
-Gets or sets a configuration setting in the project or global configuration file (\.fmi[configuration files|#cfg]).
-	examples[
+  @title[config]
+  @id[c_config]
+Gets or sets a configuration setting in the project or global configuration file (\/fmi[configuration files|#cfg]).
+  examples[
 glyph config document.filename
 glyph config -g document.author "Fabio Cevasco"
-	]
-	options[
-		-o[global|
+  ]
+  options[
+    -o[global|
 If specified, the global configuration file is processed instead of the project file.
-		default[false]
-		]
-	]
-	parameters[
-		-p[em[setting]|The name of a valid =>[#cfg_ref|configuration setting].]
-		-p[em[value]|The new value of the configuration setting.]
-	]
+    default[false]
+    ]
+  ]
+  parameters[
+    -p[em[setting]|The name of a valid =>[#cfg_ref|configuration setting].]
+    -p[em[value]|The new value of the configuration setting.]
+  ]
 ]
 section[
-	@title[help]
-	@id[c_help]
+  @title[help]
+  @id[c_help]
 Prints information about all Glyph commands or about one specific command.
-	examples[
+  examples[
 glyph help
 glyph help compile
-	]
-	parameters[
-		-p[em[command]|A valid Glyph command.]
-	]
+  ]
+  parameters[
+    -p[em[command]|A valid Glyph command.]
+  ]
 ]
 section[
-	@title[init]
-	@id[c_init]
+  @title[init]
+  @id[c_init]
 Creates a new Glyph project in the current directory (if empty).
-	example[glyph init]
+  example[glyph init]
 ]
 section[
-	@title[outline]
-	@id[c_outline]
+  @title[outline]
+  @id[c_outline]
 Display an outline of the current document.
-	options[
-		-o[limit|
+  options[
+    -o[limit|
 Only display headers until the specified level.
-		]
-		-o[ids|
+    ]
+    -o[ids|
 Display section IDs.
-		]
-		-o[files|
+    ]
+    -o[files|
 Display file names.
-		]
-		-o[titles|
+    ]
+    -o[titles|
 Display section titles.
-		]
-	]
-	examples[
+    ]
+  ]
+  examples[
 glyph outline -it -l 1
 glyph outline -l 2
 glyph outline -f
-	]
+  ]
 ]
 section[
-	@title[stats]	
-	@id[c_stats]
-	rw:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]]
-	rw:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]]
-	p[Displays project statistics (\.fmi[this command|#stats]).]
-	examples[
-glyph	stats -m 
+  @title[stats] 
+  @id[c_stats]
+  def:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]]
+  def:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]]
+  p[Displays project statistics (\/fmi[this command|#stats]).]
+  examples[
+glyph stats -m 
 glyph stats --link=h3rald.com
-	]
-	options[
-		stats_option[bookmarks]
-		stats_long_option[bookmark]
-		-o[files|If specified, general statistics about project files are displayed.]
-		stats_option[links]
-		long_option[link|Display detailed statistics about all links whose target matches the specified regular expression.]
-		stats_option[macros]
-		stats_long_option[macro]
-		stats_option[snippets]
-		stats_long_option[snippet]
-	]
+  ]
+  options[
+    stats_option[bookmarks]
+    stats_long_option[bookmark]
+    -o[files|If specified, general statistics about project files are displayed.]
+    stats_option[links]
+    long_option[link|Display detailed statistics about all links whose target matches the specified regular expression.]
+    stats_option[macros]
+    stats_long_option[macro]
+    stats_option[snippets]
+    stats_long_option[snippet]
+  ]
 ]
 section[
-	@title[todo]
-	@id[c_todo]
+  @title[todo]
+  @id[c_todo]
 Prints all the todo items saved using the %>[todo].
-	example[glyph todo]
+  example[glyph todo]
 ]

data/book/text/snippets.glyph

@@ -0,0 +1,18 @@
+&:[glang|Glyph Language]
+&:[macros|Glyph Macros]
+&:[sq_esc|Square brackets must be escaped unless used as macro delimiters or within a quoting macro.]
+&:[gcode|The following Glyph code:]
+&:[htmlcode|Is translated into the following HTML code:]
+&:[markups|Textile or Markdown]
+&:[filter_by_ext|the $>[options.filters_by_file_extension] is @true@]
+&:[called_on_files|If &[filter_by_ext], this macro is called automatically on =>[#m_include|included] files]
+&:[only_after_declaration|can only be used _after_ its declaration]
+&:[coderay|=>[http://coderay.rubychan.de/|Coderay]]
+&:[uv|=>[http://ultraviolet.rubyforge.org/|Ultraviolet]]
+&:[rubydoc|http://rubydoc.info/gems/glyph]
+&:[unsafe|This macro cannot be used in =>[#modes|safe mode].]
+&:[bin_params|-p[0|The first expression to test]-p[1|The second expression to test]]
+&:[img_file|The name of the image file (relative to the code[images/] folder).]
+&:[img_attrs|Any attribute supported by the =>[http://www.w3schools.com/tags/tag_IMG.asp|img tag].]
+&:[opt|em[(optional)]]
+&:[calibre|=>[http://calibre-ebook.com/|Calibre]]

data/book/text/stats/bookmarks.glyph

@@ -1,16 +1,16 @@
 stats_for[
-	@title[all bookmarks]
-	@object[all bookmarks]
-	@command[--bookmarks]
-	@example[
+  @title[all bookmarks]
+  @object[all bookmarks]
+  @command[--bookmarks]
+  @example[
 ===== Bookmarks
 -- Total Bookmarks: 241
 -- Total Referenced Bookmarks: 89
 -- Total Unreferenced Bookmarks: 155
 -- Bookmarks:
-     attribute_intro     auto_regeneration      c_add         c_compile    c_config                           
-     c_help              c_init                 c_outline     c_todo       cfg                                
-     cfg_document        cfg_filters            cfg_ref       cmd_ref      compile  
+     attribute_intro  auto_regeneration   c_add      c_compile  c_config                           
+     c_help           c_init              c_outline  c_todo     cfg                                
+     cfg_document     cfg_filters         cfg_ref    cmd_ref    compile  
 \[...\]
 -- Referenced Bookmarks:
    - attribute_intro (1)
@@ -27,23 +27,23 @@ stats_for[
      h_111      h_112      h_114                  h_115         h_117    
 \[...\] 
   ]
-	@remarks[
+  @remarks[
 * All the automatically-generated bookmarks (like headers, starting with @h_@) are included as well. 
-	]
+  ]
 ]
 stats_for[
-	@title[a single bookmark]
-	@object[a single bookmark (e.g. code[yardoc])]
-	@command[--bookmark=c_config]
-	@example[
+  @title[a single bookmark]
+  @object[a single bookmark (e.g. code[rubydoc])]
+  @command[--bookmark=c_config]
+  @example[
 ===== Bookmark 'c_config' (header)
 -- Defined in: text/ref_commands.glyph
 -- Referenced in:
    - text/changelog.glyph (2)
    - text/getting_started/configuration.glyph (1)
    - text/troubleshooting/errors_command.glyph (3)
-	]
-	@remarks[
+  ]
+  @remarks[
 * Do not prepend the bookmark ID with @#@.
-	]
+  ]
 ]

data/book/text/stats/links.glyph

@@ -1,8 +1,8 @@
 stats_for[
-	@title[all links]
-	@object[all links]
-	@command[--links]
-	@example[
+  @title[all links]
+  @object[all links]
+  @command[--links]
+  @example[
 ===== Links
 -- Total Internal Links: 89
 -- Internal Links
@@ -21,30 +21,30 @@ stats_for[
 \[...\]
 -- Total External Links: 95
 -- External Links
-   - &\[yardoc\]/Glyph 
-   - &\[yardoc\]/Glyph/Document 
-   - &\[yardoc\]/Glyph/Interpreter 
-   - &\[yardoc\]/Glyph/Macro 
-   - &\[yardoc\]/Glyph/Macro/Validators 
-   - &\[yardoc\]/Glyph/Macro:update_source 
-   - &\[yardoc\]/Glyph/MacroNode 
-   - &\[yardoc\]/Glyph/Parser 
-   - &\[yardoc\]/Glyph/SyntaxNode 
-   - &\[yardoc\]/Macro 
+   - &\[rubydoc\]/Glyph 
+   - &\[rubydoc\]/Glyph/Document 
+   - &\[rubydoc\]/Glyph/Interpreter 
+   - &\[rubydoc\]/Glyph/Macro 
+   - &\[rubydoc\]/Glyph/Macro/Validators 
+   - &\[rubydoc\]/Glyph/Macro:update_source 
+   - &\[rubydoc\]/Glyph/MacroNode 
+   - &\[rubydoc\]/Glyph/Parser 
+   - &\[rubydoc\]/Glyph/SyntaxNode 
+   - &\[rubydoc\]/Macro 
    - http://code.google.com/p/wkhtmltopdf/ 
    - http://coderay.rubychan.de/ 
    - http://coderay.rubychan.de/doc/classes/CodeRay/Encoders/HTML.html 
 \[...\]   
   ]
-	@remarks[
+  @remarks[
 * The only criteria used to determine if a link is internal is whether it starts with a @#@ or not.
-	]
+  ]
 ]
 stats_for[
-	@title[links matching a regular expression]
-	@object[links matching a regular expression (e.g. code[/c_/])]
-	@command[--link=c_]
-	@example[
+  @title[links matching a regular expression]
+  @object[links matching a regular expression (e.g. code[/c_/])]
+  @command[--link=c_]
+  @example[
 ===== Links matching /c_/
 -- Total Links: 8
 -- Link Targets:
@@ -83,8 +83,8 @@ stats_for[
    - #esc_quot (2)
      - text/extending/macro_def.glyph (1)
      - text/text_editing/macro_intro.glyph (1)
-	]
-	@remarks[
+  ]
+  @remarks[
 * No distinction between external and internal targets is made.
-	]
+  ]
 ]

data/book/text/stats/macros.glyph

@@ -1,8 +1,8 @@
 stats_for[
-	@title[all macros]
-	@object[all macros]
-	@command[--macros]
-	@example[
+  @title[all macros]
+  @object[all macros]
+  @command[--macros]
+  @example[
 ===== Macros
 -- Total Macro Instances: 2497
 -- Total Macro Definitions: 65
@@ -37,17 +37,17 @@ stats_for[
      textile       title         toc           todo          values        
      \|xml\|         
   ]
-	@remarks[
+  @remarks[
 * Only macro _definitions_ (not their _aliases_) are displayed, both default and user-defined.
 * The @\|xml\|@ macro is a special macro used if the $>[options.xml_fallback] is enabled.
 * There's no distinction between macros defined by the user and macros defined by Glyph itself.
-	]
+  ]
 ]
 stats_for[
-	@title[a single macro]
-	@object[a single macro (e.g. code[note])]
-	@command[--macro=note]
-	@example[
+  @title[a single macro]
+  @object[a single macro (e.g. code[note])]
+  @command[--macro=note]
+  @example[
 ===== Macro 'note' 
 -- Total Instances: 18
 -- Occurrences:
@@ -64,10 +64,10 @@ stats_for[
    - text/text_editing/raw_html.glyph (1)
    - text/text_editing/section_aliases.glyph (1)
    - text/text_editing/xml_fallback.glyph (2)
-	]
-	@remarks[
+  ]
+  @remarks[
 * All the instances of the specified macro definition _and all its aliases_ are collected, regardless whether a definition or an alias is specified.
-* If you use custom macros, make sure they call the =>[&[yardoc]/Glyph/Macro:update_source|Macro#update_source] appropriately method if necessary.
+* If you use custom macros, make sure they call the =>[&[rubydoc]/Glyph/Macro:update_source|Macro#update_source] appropriately method if necessary.
 * If macros are used within =>[#rewriting|rewritten] macros, they'll be also listed in each file where the rewritten macro is used. 
-	]
+  ]
 ]