Skip to content
This repository
Browse code

Updated changelog.

  • Loading branch information...
commit 0c62e37b66792ace3b9d18b6f43e12d0f64c6d41 1 parent 93cb6b5
Fabio Cevasco authored
239 book/text/changelog.glyph
... ... @@ -1,152 +1,161 @@
1 1 %[=
2 2 macro :features do
3   - verb = (@name == :features) ? "Implemented" : "Fixed"
4   - total = @node.child_macros.length
5   - name = @name.to_s.capitalize
6   - name.chop! if total == 1
7   - interpret %{
8   - section[
9   - @title[#{total} #{name} #{verb}]
10   - table[
11   - tr[
12   - th[ID]
13   - th[Description]
14   - ]
15   - #{@node.value}
16   - ]
17   - ]
18   - }
  3 + verb = (@name == :features) ? "Implemented" : "Fixed"
  4 + total = @node.child_macros.length
  5 + name = @name.to_s.capitalize
  6 + name.chop! if total == 1
  7 + interpret %{
  8 + section[
  9 + @title[#{total} #{name} #{verb}]
  10 + table[
  11 + tr[
  12 + th[ID]
  13 + th[Description]
  14 + ]
  15 + #{@node.value}
  16 + ]
  17 + ]
  18 + }
19 19 end
20 20
21 21 macro_alias :bugs => :features
22 22 =]
23 23 def:[release|
24   - section[
25   - @title[v{{0}} – {{1}}]
26   - {{2}}
  24 + section[
  25 + @title[v{{0}} – {{1}}]
  26 + {{2}}
27 27
28 28 p/em[→ View closed issues on =>[https://github.com/h3rald/glyph/issues?direction=asc&labels={{0}}&sort=created&state=closed|GitHub]]
29   - ]
  29 + ]
30 30 ]
31 31 def:[issue|
32   - tr[
33   - td[\/=>[https://github.com/h3rald/glyph/issues/{{0}}|#{{0}}]]
34   - td[txt[{{1}}]]
35   - ]
  32 + tr[
  33 + td[\/=>[https://github.com/h3rald/glyph/issues/{{0}}|#{{0}}]]
  34 + td[txt[{{1}}]]
  35 + ]
36 36 ]
37 37 ?[eq[%[ARGV\[0\]]|generate]|
38   - %:[%>|"#{value} macro"]
39   - %:[#>|"#{value} command"]
40   - %:[$>|"#{value} setting"]
  38 + %:[%>|"#{value} macro"]
  39 + %:[#>|"#{value} command"]
  40 + %:[$>|"#{value} setting"]
41 41 ]
42 42 release[0.5.0|??? 2011|
43   - features[
  43 + features[
  44 + issue[152|It is now possible to generate a PDF document through HTML5, not only HTML, by setting the $>[output.pdf.through] to @html5@.]
44 45 issue[165|The %>[fragment] and the %>[embed] can be used to delimit and embed text fragments, in a way much similar to snippets.]
45   - 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.]
  46 + issue[177|Introduced the concept of "macro representations", to make macro code output-independent.]
  47 + 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.]
46 48 issue[180|Glyph can now generate ebooks in MOBI and EPUB format – with Calibre's help.]
47 49 issue[181|By using the new %>[let] macro, it is possible to define lexically scoped "variables" via the %>[attrubute:], and retrieve them within the scope of the let macro using the %>[attribute].]
48 50 issue[182|A %>[while] can be used to execute glyph code multiple times.]
49   - 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.]
50   - issue[184|The old "rewrite" macro has been renamed to "define". The new %>[define] fully supports recursion.]
  51 + 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.]
  52 + issue[184|The old @rewrite:@ macro has been renamed to @define:@. The new %>[define] fully supports recursion.]
51 53 issue[189|The %>[add], the %>[subtract] and the %>[multiply] macro can be used to perform operations on integers.]
52 54 issue[190|The lt, gt, lte, gte macros can be used to compare integer values.]
53 55 issue[194|The %>[load] macro can be used to embed the contents of a file without performing any evaluation.]
  56 + issue[195|@\\/@ must not be used as invisible space separator, instead of @\\.@.]
  57 + issue[197|Snippets are no longer managed via a separate snippet.yml file and _must_ be defined within Glyph source files, using the %>[snippet:].]
  58 + issue[200|Typing @glyph -v@ now prints the current version of Glyph on the screen.]
  59 + issue[201|Glyph no longer depends on Jeweler to create and manage its gem.]
54 60 ]
55 61 bugs[
56   - issue[|]
  62 + 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.]
  63 + issue[166|Temporary output files are now placed in a temporary folder.]
  64 + issue[196|Glyph now handles non-ASCII characters properly with Ruby 1.9 as well.]
57 65 ]
  66 +]
58 67 release[0.4.2|October 22th 2010|
59   - features[
60   - issue[172|A new %>[output?] can be used to test whether Glyph is compiling to a particular output format.]
61   - issue[175|The conditional macro now support a third parameter (else branch).]
62   - issue[176|A bunch of new aliases and shortcuts are available for the section macro.]
63   - ]
64   - bugs[
65   - issue[178|No error is raised anymore if less than the required parameters/attributes are supplied to a rewritten macro.]
66   - ]
  68 + features[
  69 + issue[172|A new %>[output?] can be used to test whether Glyph is compiling to a particular output format.]
  70 + issue[175|The conditional macro now support a third parameter (else branch).]
  71 + issue[176|A bunch of new aliases and shortcuts are available for the section macro.]
  72 + ]
  73 + bugs[
  74 + issue[178|No error is raised anymore if less than the required parameters/attributes are supplied to a rewritten macro.]
  75 + ]
67 76 ]
68 77 release[0.4.1|September 23th 2010|
69   - bugs[
70   - issue[169|*.scss files are now supported by the %>[style].]
71   - issue[170|Improved default CodeRay stylesheet.]
72   - issue[171|SCSS now used internally by Glyph to generate default CSS files.]
73   - issue[173|Consecutive escape sequences are now interpreted correctly in topics.]
74   - issue[174|Fixed error causing broken images in web5/html5 output.]
75   - ]
  78 + bugs[
  79 + issue[169|*.scss files are now supported by the %>[style].]
  80 + issue[170|Improved default CodeRay stylesheet.]
  81 + issue[171|SCSS now used internally by Glyph to generate default CSS files.]
  82 + issue[173|Consecutive escape sequences are now interpreted correctly in topics.]
  83 + issue[174|Fixed error causing broken images in web5/html5 output.]
  84 + ]
76 85 ]
77 86 release[0.4.0|September 3th 2010|
78   - features[
79   - issue[40|A new #>[stats] can be used to display statistics about project files, snippets, macros, bookmarks and links.]
80   - issue[73|It is now possible to validate online HTTP links.]
81   - issue[112|It is now possible to use _wkhtmltopdf_ instead of Prince to generate PDF files from HTML files.]
82   - issue[114|It is now possible to generate documents comprised of multiple files (topics).]
83   - issue[115|It is now possible to define layouts (used when generating multi-file outputs) using Glyph macros.]
84   - issue[120|It is now possible to compile your project to a single HTML5 file (@html5@ output) or multiple files (@web5@ output)]
85   - issue[135|Stylesheets can now be linked and imported as well as embedded.]
86   - issue[138|@web@ and @web5@ output formats inherit @html@ macros.]
87   - issue[142|A new %>[navigation] can be used in @web@ and @web5@ outputs to navigate through topics.]
88   - issue[143|A topic-based TOC is generated when compiling to @web@ or @web5@]
89   - 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@.]
90   - issue[147|The default stylesheets provided by Glyph are now compatible with HTML5 outputs (html5 and web5).]
91   - issue[148|It is now possible to create custom tasks and commands to extend Glyph functionality.]
92   - ]
93   - bugs[
94   - issue[133|Added HTML charset to Glyph documents (utf-8).]
95   - issue[136|Moved utility functions to separate @Glyph::Utils@ module.]
96   - issue[139|Heavily restructured Glyph configuration.]
97   - issue[140|Added @Glyph::Macro::Helpers@ module to avoid code duplication in macros for different output formats.]
98   - issue[141|Prevented non-rb files to be loaded as macros.]
99   - issue[145|Dotfiles are now ignored by #>[init].]
100   - issue[167|Fixed PDF book download links.]
101   - ]
  87 + features[
  88 + issue[40|A new #>[stats] can be used to display statistics about project files, snippets, macros, bookmarks and links.]
  89 + issue[73|It is now possible to validate online HTTP links.]
  90 + issue[112|It is now possible to use _wkhtmltopdf_ instead of Prince to generate PDF files from HTML files.]
  91 + issue[114|It is now possible to generate documents comprised of multiple files (topics).]
  92 + issue[115|It is now possible to define layouts (used when generating multi-file outputs) using Glyph macros.]
  93 + issue[120|It is now possible to compile your project to a single HTML5 file (@html5@ output) or multiple files (@web5@ output)]
  94 + issue[135|Stylesheets can now be linked and imported as well as embedded.]
  95 + issue[138|@web@ and @web5@ output formats inherit @html@ macros.]
  96 + issue[142|A new %>[navigation] can be used in @web@ and @web5@ outputs to navigate through topics.]
  97 + issue[143|A topic-based TOC is generated when compiling to @web@ or @web5@]
  98 + 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@.]
  99 + issue[147|The default stylesheets provided by Glyph are now compatible with HTML5 outputs (html5 and web5).]
  100 + issue[148|It is now possible to create custom tasks and commands to extend Glyph functionality.]
  101 + ]
  102 + bugs[
  103 + issue[133|Added HTML charset to Glyph documents (utf-8).]
  104 + issue[136|Moved utility functions to separate @Glyph::Utils@ module.]
  105 + issue[139|Heavily restructured Glyph configuration.]
  106 + issue[140|Added @Glyph::Macro::Helpers@ module to avoid code duplication in macros for different output formats.]
  107 + issue[141|Prevented non-rb files to be loaded as macros.]
  108 + issue[145|Dotfiles are now ignored by #>[init].]
  109 + issue[167|Fixed PDF book download links.]
  110 + ]
102 111 ]
103 112 release[0.3.0|June 13th 2010|
104   - features[
105   - issue[39|A new #>[outline] is available to display the document outline.]
106   - issue[110|It is now possible to use Glyph language to produce arbitrary XML code.]
107   - issue[111|System settings are now stored within a @system.*@ namespace and cannot be changed via the %>[config:] or the #>[config].]
108   - issue[116|It is now possible to use named attributes within Glyph macros.]
109   - issue[119|#[new_parser]A new parser was implemented from scratch to improve performance. Treetop gem no longer required.]
110   - issue[121|Some macros have been removed in favor of XML fallback, others have been updated.]
111   - issue[123|The SyntaxNode class has been specialized to differentiate between macros, attributes, parameters, text and escapes.]
112   - issue[124|Implemented new %>[article] and %>[book].]
113   - issue[126|A new %>[rewrite:] has been implemented to create simple macros using just Glyph code.]
114   - issue[127|A new %>[alias] has been implemented to create macro aliases.]
115   - issue[128|A blacklist for XML tags has been exposed via the @language.options.xml_blacklist@ setting.]
116   - issue[129|The %>[include] can now be used in lite mode, it can evaluate ruby files and requires relative paths.]
117   - issue[130|A new "safe mode" has been implemented to explicitly forbid certain potentially unsafe macros.]
118   - ]
119   - bugs[
120   - issue[109|Performance has been dramatically improved by implementing a parser from scratch (see =>[#new_parser|#119])]
121   - issue[122|Macro encoding/decoding no longer necessary due to the new parser (see =>[#new_parser|#119])]
122   - issue[125|Warning messages have been streamlined.]
123   - ]
  113 + features[
  114 + issue[39|A new #>[outline] is available to display the document outline.]
  115 + issue[110|It is now possible to use Glyph language to produce arbitrary XML code.]
  116 + issue[111|System settings are now stored within a @system.*@ namespace and cannot be changed via the %>[config:] or the #>[config].]
  117 + issue[116|It is now possible to use named attributes within Glyph macros.]
  118 + issue[119|#[new_parser]A new parser was implemented from scratch to improve performance. Treetop gem no longer required.]
  119 + issue[121|Some macros have been removed in favor of XML fallback, others have been updated.]
  120 + issue[123|The SyntaxNode class has been specialized to differentiate between macros, attributes, parameters, text and escapes.]
  121 + issue[124|Implemented new %>[article] and %>[book].]
  122 + issue[126|A new %>[rewrite:] has been implemented to create simple macros using just Glyph code.]
  123 + issue[127|A new %>[alias] has been implemented to create macro aliases.]
  124 + issue[128|A blacklist for XML tags has been exposed via the @language.options.xml_blacklist@ setting.]
  125 + issue[129|The %>[include] can now be used in lite mode, it can evaluate ruby files and requires relative paths.]
  126 + issue[130|A new "safe mode" has been implemented to explicitly forbid certain potentially unsafe macros.]
  127 + ]
  128 + bugs[
  129 + issue[109|Performance has been dramatically improved by implementing a parser from scratch (see =>[#new_parser|#119])]
  130 + issue[122|Macro encoding/decoding no longer necessary due to the new parser (see =>[#new_parser|#119])]
  131 + issue[125|Warning messages have been streamlined.]
  132 + ]
124 133 ]
125 134 release[0.2.0|May 9th 2010|
126   - features[
127   - issue[62|A new %>[highlight] is available to highlight source code (CodeRay or UltraViolet required).]
128   - issue[76|It is now possible to use Glyph programmatically via the new @Glyph#filter@ and @Glyph#compile@ methods.]
129   - issue[87|It is now possible to define snippets inside a Glyph source file using the %>[snippet:].]
130   - issue[88|It is now possible to change configuration settings inside a Glyph source file using the %>[config:] (Jabbslad).]
131   - issue[89|It is now possible to compile a single Glyph source file without creating a Glyph project.]
132   - issue[92|6 new macros have been defined to allow conditional processing (\/%>[condition], %>[eq], %>[not], %>[and], %>[or], %>[match])]
133   - issue[94|It is now possible to add _validators_ to macros, for example to check the number of parameters they take.]
134   - issue[97|The #>[compile] command can now take an extra @--auto@ switch to trigger document auto-regeneration whenever a source file is changed (koraktor).]
135   - issue[99|Added a @document.draft@ setting. If set to @true@, comments and TODOs are rendered in output files.]
136   - 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]).]
137   - issue[108|It is now possible to define Glyph macros within Glyph source files using the %>[macro:].]
138   - ]
139   - bugs[
140   - 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.]
141   - 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]).]
142   - 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.]
143   - issue[98|Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.]
144   - 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.]
145   - issue[103|Fixed a bug that caused test failures when deleting the test project directory.]
146   - issue[104|Nested Glyph macros calling @Macro#interpret@ no longer ignore escape delimiters.]
147   - 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.]
148   - ]
  135 + features[
  136 + issue[62|A new %>[highlight] is available to highlight source code (CodeRay or UltraViolet required).]
  137 + issue[76|It is now possible to use Glyph programmatically via the new @Glyph#filter@ and @Glyph#compile@ methods.]
  138 + issue[87|It is now possible to define snippets inside a Glyph source file using the %>[snippet:].]
  139 + issue[88|It is now possible to change configuration settings inside a Glyph source file using the %>[config:] (Jabbslad).]
  140 + issue[89|It is now possible to compile a single Glyph source file without creating a Glyph project.]
  141 + issue[92|6 new macros have been defined to allow conditional processing (\/%>[condition], %>[eq], %>[not], %>[and], %>[or], %>[match])]
  142 + issue[94|It is now possible to add _validators_ to macros, for example to check the number of parameters they take.]
  143 + issue[97|The #>[compile] command can now take an extra @--auto@ switch to trigger document auto-regeneration whenever a source file is changed (koraktor).]
  144 + issue[99|Added a @document.draft@ setting. If set to @true@, comments and TODOs are rendered in output files.]
  145 + 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]).]
  146 + issue[108|It is now possible to define Glyph macros within Glyph source files using the %>[macro:].]
  147 + ]
  148 + bugs[
  149 + 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.]
  150 + 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]).]
  151 + 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.]
  152 + issue[98|Glyph is now fully compatible with Ruby 1.9.1 and JRuby 1.4.0.]
  153 + 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.]
  154 + issue[103|Fixed a bug that caused test failures when deleting the test project directory.]
  155 + issue[104|Nested Glyph macros calling @Macro#interpret@ no longer ignore escape delimiters.]
  156 + 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.]
  157 + ]
149 158 ]
150 159 release[0.1.0|April 8th 2010|
151   - Initial release.
  160 + Initial release.
152 161 ]
4 book/text/macros/macros_core.glyph
@@ -114,7 +114,7 @@ For examples see any of the following:
114 114 @n[fragment]
115 115 @desc[Delimits a fragment of text that can be embedded using the %>[embed].]
116 116 @aliases[##]
117   - @example[=##\[test_fragment|This is an embeddable fragment\]=]
  117 + @example[=##\[test_fragment\|This is an embeddable fragment\]=]
118 118 @params[
119 119 -p[0|The ID of the fragment.]
120 120 -p[1|The contents of the fragment.]
@@ -265,7 +265,7 @@ Checks a string against a regular expression.
265 265 @block_example[=
266 266 def:[factorial\|
267 267 ?[
268   - eq[{{0}}\|0]\|1|
  268 + eq[{{0}}\|0]\|1\|
269 269 multiply[
270 270 {{0}} \| factorial[subtract[{{0}}\|1]]
271 271 ]
187 book/text/ref_commands.glyph
@@ -8,132 +8,137 @@ Where:
8 8 * _parameters_ are separated by whitespaces, and can be wrapped in quotes.
9 9 ]
10 10 section[
11   - @title[Global Options]
12   - section[
13   - @title[code[-d], code[--debug]]
14   - @id[debug_switch]
15   - p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.]
16   - ]
  11 + @title[Global Options]
  12 + section[
  13 + @title[code[-d], code[--debug]]
  14 + @id[debug_switch]
  15 + p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.]
  16 + ]
  17 + section[
  18 + @title[code[-v], code[--version]]
  19 + @id[version_switch]
  20 + p[Prints the current version of Glyph, ignoring any other command or switches.]
  21 + ]
17 22 ]
18 23 section[
19   - @title[add]
20   - @id[c_add]
21   - p[Creates a new text file in the code[text/] folder.]
22   - example[glyph add introduction.textile]
23   - parameters[
24   - -p[em[file_name]|The name (or relative path) of the new file to be created.]
25   - ]
  24 + @title[add]
  25 + @id[c_add]
  26 + p[Creates a new text file in the code[text/] folder.]
  27 + example[glyph add introduction.textile]
  28 + parameters[
  29 + -p[em[file_name]|The name (or relative path) of the new file to be created.]
  30 + ]
26 31 ]
27 32 section[
28   - @title[compile]
29   - @id[c_compile]
30   - 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.]
31   - example[glyph compile -f pdf]
32   - parameters[
33   - -p[em[source]|The source glyph file to compile em[(Optional)].]
34   - -p[em[destination]|The destination file em[(Optional)].]
35   - ]
36   - options[
37   - -o[source|
  33 + @title[compile]
  34 + @id[c_compile]
  35 + 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.]
  36 + example[glyph compile -f pdf]
  37 + parameters[
  38 + -p[em[source]|The source glyph file to compile em[(Optional)].]
  39 + -p[em[destination]|The destination file em[(Optional)].]
  40 + ]
  41 + options[
  42 + -o[source|
38 43 The source file to compile.
39   - default[document.glyph]
40   - ]
41   - -o[format|
  44 + default[document.glyph]
  45 + ]
  46 + -o[format|
42 47 The format of the output file.
43   - default[html]
44   - values[html, pdf]
45   - ]
46   - -o[auto|
  48 + default[html]
  49 + values[html, pdf]
  50 + ]
  51 + -o[auto|
47 52 If specified, enable =>[#auto_regeneration|auto regeneration] (requires the =>[http://rubygems.org/gems/directory_watcher|directory_watcher] gem to be installed).
48   - ]
49   - ]
  53 + ]
  54 + ]
50 55 ]
51 56 section[
52   - @title[config]
53   - @id[c_config]
  57 + @title[config]
  58 + @id[c_config]
54 59 Gets or sets a configuration setting in the project or global configuration file (\/fmi[configuration files|#cfg]).
55   - examples[
  60 + examples[
56 61 glyph config document.filename
57 62 glyph config -g document.author "Fabio Cevasco"
58   - ]
59   - options[
60   - -o[global|
  63 + ]
  64 + options[
  65 + -o[global|
61 66 If specified, the global configuration file is processed instead of the project file.
62   - default[false]
63   - ]
64   - ]
65   - parameters[
66   - -p[em[setting]|The name of a valid =>[#cfg_ref|configuration setting].]
67   - -p[em[value]|The new value of the configuration setting.]
68   - ]
  67 + default[false]
  68 + ]
  69 + ]
  70 + parameters[
  71 + -p[em[setting]|The name of a valid =>[#cfg_ref|configuration setting].]
  72 + -p[em[value]|The new value of the configuration setting.]
  73 + ]
69 74 ]
70 75 section[
71   - @title[help]
72   - @id[c_help]
  76 + @title[help]
  77 + @id[c_help]
73 78 Prints information about all Glyph commands or about one specific command.
74   - examples[
  79 + examples[
75 80 glyph help
76 81 glyph help compile
77   - ]
78   - parameters[
79   - -p[em[command]|A valid Glyph command.]
80   - ]
  82 + ]
  83 + parameters[
  84 + -p[em[command]|A valid Glyph command.]
  85 + ]
81 86 ]
82 87 section[
83   - @title[init]
84   - @id[c_init]
  88 + @title[init]
  89 + @id[c_init]
85 90 Creates a new Glyph project in the current directory (if empty).
86   - example[glyph init]
  91 + example[glyph init]
87 92 ]
88 93 section[
89   - @title[outline]
90   - @id[c_outline]
  94 + @title[outline]
  95 + @id[c_outline]
91 96 Display an outline of the current document.
92   - options[
93   - -o[limit|
  97 + options[
  98 + -o[limit|
94 99 Only display headers until the specified level.
95   - ]
96   - -o[ids|
  100 + ]
  101 + -o[ids|
97 102 Display section IDs.
98   - ]
99   - -o[files|
  103 + ]
  104 + -o[files|
100 105 Display file names.
101   - ]
102   - -o[titles|
  106 + ]
  107 + -o[titles|
103 108 Display section titles.
104   - ]
105   - ]
106   - examples[
  109 + ]
  110 + ]
  111 + examples[
107 112 glyph outline -it -l 1
108 113 glyph outline -l 2
109 114 glyph outline -f
110   - ]
  115 + ]
111 116 ]
112 117 section[
113   - @title[stats]
114   - @id[c_stats]
115   - def:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]]
116   - def:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]]
117   - p[Displays project statistics (\/fmi[this command|#stats]).]
118   - examples[
119   -glyph stats -m
  118 + @title[stats]
  119 + @id[c_stats]
  120 + def:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]]
  121 + def:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]]
  122 + p[Displays project statistics (\/fmi[this command|#stats]).]
  123 + examples[
  124 +glyph stats -m
120 125 glyph stats --link=h3rald.com
121   - ]
122   - options[
123   - stats_option[bookmarks]
124   - stats_long_option[bookmark]
125   - -o[files|If specified, general statistics about project files are displayed.]
126   - stats_option[links]
127   - long_option[link|Display detailed statistics about all links whose target matches the specified regular expression.]
128   - stats_option[macros]
129   - stats_long_option[macro]
130   - stats_option[snippets]
131   - stats_long_option[snippet]
132   - ]
  126 + ]
  127 + options[
  128 + stats_option[bookmarks]
  129 + stats_long_option[bookmark]
  130 + -o[files|If specified, general statistics about project files are displayed.]
  131 + stats_option[links]
  132 + long_option[link|Display detailed statistics about all links whose target matches the specified regular expression.]
  133 + stats_option[macros]
  134 + stats_long_option[macro]
  135 + stats_option[snippets]
  136 + stats_long_option[snippet]
  137 + ]
133 138 ]
134 139 section[
135   - @title[todo]
136   - @id[c_todo]
  140 + @title[todo]
  141 + @id[c_todo]
137 142 Prints all the todo items saved using the %>[todo].
138   - example[glyph todo]
  143 + example[glyph todo]
139 144 ]
36 document.glyph
... ... @@ -1,29 +1,29 @@
1 1 book[
2 2 @frontmatter[
3   - toc[]
4   - preface[
5   - @title[Preface]
6   - todo[Write the preface]
7   - include[preface]
8   - ]
9   - ]
  3 + toc[]
  4 + preface[
  5 + @title[Preface]
  6 + todo[Write the preface]
  7 + include[preface]
  8 + ]
  9 + ]
10 10 @bodymatter[
11 11 chapter[
12   - @title[Chapter 1]
13   - todo[Write chapter 1]
  12 + @title[Chapter 1]
  13 + todo[Write chapter 1]
14 14 include[chapter_1]
15 15 ]
16 16 chapter[
17   - @title[Chapter 2]
18   - todo[Write chapter 2]
  17 + @title[Chapter 2]
  18 + todo[Write chapter 2]
19 19 include[chapter_2]
20 20 ]
21 21 ]
22   - @backmatter[
23   - appendix[
24   - @title[Appendix A]
25   - todo[Write appendix A]
26   - include[appendix_a]
27   - ]
28   - ]
  22 + @backmatter[
  23 + appendix[
  24 + @title[Appendix A]
  25 + todo[Write appendix A]
  26 + include[appendix_a]
  27 + ]
  28 + ]
29 29 ]

0 comments on commit 0c62e37

Please sign in to comment.
Something went wrong with that request. Please try again.