glyph 0.5.1 → 0.5.2
Sign up to get free protection for your applications and to get access to all the features.
- data/book/config.yml +1 -1
- data/book/document.glyph +5 -5
- data/book/lib/layouts/bookindex.glyph +4 -27
- data/book/lib/layouts/bookpage.glyph +5 -28
- data/book/lib/macros/reference.rb +4 -12
- data/book/text/changelog.glyph +10 -2
- data/book/text/compiling/compiling.glyph +0 -1
- data/book/text/extending/interpreting.glyph +1 -1
- data/book/text/introduction.glyph +21 -29
- data/book/text/license.glyph +1 -1
- data/book/text/macros/macros_core.glyph +0 -3
- data/book/text/ref_commands.glyph +32 -24
- data/book/text/stats/stats.glyph +1 -1
- data/book/text/text_editing/code.glyph +2 -2
- data/book/text/text_editing/evaluation.glyph +6 -6
- data/book/text/text_editing/inclusions.glyph +2 -2
- data/book/text/text_editing/links.glyph +3 -3
- data/config.yml +8 -1
- data/glyph-0.5.1.gem +0 -0
- data/glyph.gemspec +7 -7
- data/lib/glyph.rb +2 -2
- data/lib/glyph/commands.rb +9 -16
- data/lib/glyph/commands/add.rb +1 -1
- data/lib/glyph/commands/compile.rb +1 -1
- data/lib/glyph/commands/config.rb +1 -1
- data/lib/glyph/commands/init.rb +1 -1
- data/lib/glyph/commands/outline.rb +1 -1
- data/lib/glyph/commands/stats.rb +1 -1
- data/lib/glyph/commands/todo.rb +1 -1
- data/lib/glyph/utils.rb +200 -175
- data/macros/block.rb +2 -2
- data/macros/reps/html.rb +4 -3
- data/macros/reps/html5.rb +4 -3
- data/macros/structure.rb +1 -0
- data/spec/config.yml +3 -3
- data/spec/lib/commands_spec.rb +15 -28
- data/spec/macros/core_spec.rb +4 -4
- data/spec/macros/filters_spec.rb +3 -3
- data/spec/macros/html5_spec.rb +3 -3
- data/spec/macros/macros_spec.rb +28 -3
- data/spec/macros/textile_spec.rb +2 -2
- data/spec/macros/web5_spec.rb +4 -4
- data/spec/macros/web_spec.rb +4 -4
- data/spec/spec_helper.rb +12 -1
- data/spec/tasks/generate_spec.rb +1 -1
- data/styles/coderay.css +9 -7
- data/styles/coderay.scss +7 -7
- data/styles/default.css +60 -43
- data/styles/default.scss +68 -40
- data/styles/definitions.scss +1 -1
- data/styles/pagination.css +16 -13
- data/styles/pagination.scss +18 -18
- data/tasks/generate.rake +3 -3
- data/tasks/load.rake +1 -4
- metadata +98 -47
data/book/config.yml
CHANGED
data/book/document.glyph
CHANGED
|
@@ -51,7 +51,7 @@ book[
|
|
|
51
51
|
chapter[
|
|
52
52
|
@title[Authoring Documents]
|
|
53
53
|
section[
|
|
54
|
-
@title[.glyph files]
|
|
54
|
+
@title[code[.glyph] files]
|
|
55
55
|
@src[text_editing/glyph_files]
|
|
56
56
|
]
|
|
57
57
|
section[
|
|
@@ -296,22 +296,22 @@ book[
|
|
|
296
296
|
@title[Configuration Reference]
|
|
297
297
|
@id[cfg_ref]
|
|
298
298
|
section[
|
|
299
|
-
@title[document.*]
|
|
299
|
+
@title[code[document.*]]
|
|
300
300
|
@id[cfg_document]
|
|
301
301
|
@src[config/document]
|
|
302
302
|
]
|
|
303
303
|
section[
|
|
304
|
-
@title[filters.*]
|
|
304
|
+
@title[code[filters.*]]
|
|
305
305
|
@id[cfg_filters]
|
|
306
306
|
@src[config/filters]
|
|
307
307
|
]
|
|
308
308
|
section[
|
|
309
|
-
@title[options.*]
|
|
309
|
+
@title[code[options.*]]
|
|
310
310
|
@id[cfg_options]
|
|
311
311
|
@src[config/options]
|
|
312
312
|
]
|
|
313
313
|
section[
|
|
314
|
-
@title[output.*]
|
|
314
|
+
@title[code[output.*]]
|
|
315
315
|
@id[cfg_output]
|
|
316
316
|
@src[config/output]
|
|
317
317
|
]
|
|
@@ -2,9 +2,6 @@
|
|
|
2
2
|
<html lang="en">
|
|
3
3
|
<head>
|
|
4
4
|
<title>Glyph - Document Authoring Framework</title>
|
|
5
|
-
<link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
|
|
6
|
-
|
|
7
|
-
|
|
8
5
|
|
|
9
6
|
<meta charset="utf-8" />
|
|
10
7
|
<meta name="author" content="Fabio Cevasco" />
|
|
@@ -43,10 +40,10 @@
|
|
|
43
40
|
<header class="page">
|
|
44
41
|
<nav class="home-link">
|
|
45
42
|
<a href="/">
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
43
|
+
<span class="logo">
|
|
44
|
+
<span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span>
|
|
45
|
+
<span class="three">3</span>
|
|
46
|
+
</span>
|
|
50
47
|
</a>
|
|
51
48
|
</nav>
|
|
52
49
|
|
|
@@ -69,32 +66,12 @@
|
|
|
69
66
|
<nav id="sharing-buttons">
|
|
70
67
|
<a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a>
|
|
71
68
|
<script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
|
|
72
|
-
<g:plusone size="medium"></g:plusone>
|
|
73
|
-
<script type="text/javascript">
|
|
74
|
-
(function() {
|
|
75
|
-
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
|
|
76
|
-
po.src = 'https://apis.google.com/js/plusone.js';
|
|
77
|
-
var s = document.getElementsByTagName('script')\[0\]; s.parentNode.insertBefore(po, s);
|
|
78
|
-
})();
|
|
79
|
-
</script>
|
|
80
69
|
</nav>
|
|
81
70
|
</section>
|
|
82
71
|
</article>
|
|
83
72
|
|
|
84
73
|
|
|
85
74
|
<footer>
|
|
86
|
-
<section class="ads">
|
|
87
|
-
<script type="text/javascript"><!--
|
|
88
|
-
google_ad_client = "pub-2871497824158668";
|
|
89
|
-
/* 728x90, created 9/10/10 */
|
|
90
|
-
google_ad_slot = "3963343166";
|
|
91
|
-
google_ad_width = 728;
|
|
92
|
-
google_ad_height = 90;
|
|
93
|
-
//-->
|
|
94
|
-
</script>
|
|
95
|
-
<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
|
96
|
-
</script>
|
|
97
|
-
</section>
|
|
98
75
|
<section>
|
|
99
76
|
<nav>
|
|
100
77
|
<a href="/about/">ABOUT</a>\|<a href="/contact/">CONTACT</a>
|
|
@@ -2,9 +2,6 @@
|
|
|
2
2
|
<html lang="en">
|
|
3
3
|
<head>
|
|
4
4
|
<title>{{title}} - Glyph</title>
|
|
5
|
-
<link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
|
|
6
|
-
|
|
7
|
-
|
|
8
5
|
|
|
9
6
|
<meta charset="utf-8" />
|
|
10
7
|
<meta name="author" content="Fabio Cevasco" />
|
|
@@ -43,10 +40,10 @@
|
|
|
43
40
|
<header class="page">
|
|
44
41
|
<nav class="home-link">
|
|
45
42
|
<a href="/">
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
43
|
+
<span class="logo">
|
|
44
|
+
<span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span>
|
|
45
|
+
<span class="three">3</span>
|
|
46
|
+
</span>
|
|
50
47
|
</a>
|
|
51
48
|
</nav>
|
|
52
49
|
|
|
@@ -70,37 +67,17 @@
|
|
|
70
67
|
<nav id="sharing-buttons">
|
|
71
68
|
<a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a>
|
|
72
69
|
<script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
|
|
73
|
-
<g:plusone size="medium"></g:plusone>
|
|
74
|
-
<script type="text/javascript">
|
|
75
|
-
(function() {
|
|
76
|
-
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
|
|
77
|
-
po.src = 'https://apis.google.com/js/plusone.js';
|
|
78
|
-
var s = document.getElementsByTagName('script')\[0\]; s.parentNode.insertBefore(po, s);
|
|
79
|
-
})();
|
|
80
|
-
</script>
|
|
81
70
|
</nav>
|
|
82
71
|
</section>
|
|
83
72
|
</article>
|
|
84
73
|
|
|
85
74
|
|
|
86
75
|
<footer>
|
|
87
|
-
<section class="ads">
|
|
88
|
-
<script type="text/javascript"><!--
|
|
89
|
-
google_ad_client = "pub-2871497824158668";
|
|
90
|
-
/* 728x90, created 9/10/10 */
|
|
91
|
-
google_ad_slot = "3963343166";
|
|
92
|
-
google_ad_width = 728;
|
|
93
|
-
google_ad_height = 90;
|
|
94
|
-
//-->
|
|
95
|
-
</script>
|
|
96
|
-
<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
|
97
|
-
</script>
|
|
98
|
-
</section>
|
|
99
76
|
<section>
|
|
100
77
|
<nav>
|
|
101
78
|
<a href="/about/">ABOUT</a>\|<a href="/contact/">CONTACT</a>
|
|
102
79
|
</nav>
|
|
103
|
-
<p>H3RALD Web Site v8.1.2 © 2004 —
|
|
80
|
+
<p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p>
|
|
104
81
|
</section>
|
|
105
82
|
</footer>
|
|
106
83
|
</section><!-- #container end -->
|
|
@@ -90,8 +90,9 @@ end
|
|
|
90
90
|
|
|
91
91
|
macro :block_example do
|
|
92
92
|
interpret %{
|
|
93
|
-
|
|
94
|
-
|
|
93
|
+
section[
|
|
94
|
+
@title[Example]
|
|
95
|
+
@notoc[true]
|
|
95
96
|
highlight[=html|
|
|
96
97
|
#{value}
|
|
97
98
|
=]
|
|
@@ -99,15 +100,6 @@ macro :block_example do
|
|
|
99
100
|
}
|
|
100
101
|
end
|
|
101
102
|
|
|
102
|
-
macro :examples do
|
|
103
|
-
%{
|
|
104
|
-
<div class="examples">
|
|
105
|
-
<p><strong>Examples:</strong></p>
|
|
106
|
-
#{value.split("\n").map{|i| "<code>#{i}</code><br />"}.to_s}
|
|
107
|
-
</div>
|
|
108
|
-
}
|
|
109
|
-
end
|
|
110
|
-
|
|
111
103
|
macro :aliases do
|
|
112
104
|
%{<strong>Aliases:</strong> <code>#{value}</code>}
|
|
113
105
|
end
|
|
@@ -130,7 +122,7 @@ macro :ref_macro do
|
|
|
130
122
|
]} if raw_attr(:remarks)
|
|
131
123
|
interpret %{
|
|
132
124
|
section[
|
|
133
|
-
@title[#{m_name}]
|
|
125
|
+
@title[code[#{m_name}]]
|
|
134
126
|
@id[m_#{m_name.gsub(/[^a-z0-1_-]/, '_')}]
|
|
135
127
|
txt[
|
|
136
128
|
#{m_value}
|
data/book/text/changelog.glyph
CHANGED
|
@@ -24,8 +24,6 @@ def:[release|
|
|
|
24
24
|
section[
|
|
25
25
|
@title[v{{0}} – {{1}}]
|
|
26
26
|
{{2}}
|
|
27
|
-
|
|
28
|
-
p/em[→ View closed issues on =>[https://github.com/h3rald/glyph/issues?direction=asc&labels={{0}}&sort=created&state=closed|GitHub].]
|
|
29
27
|
]
|
|
30
28
|
]
|
|
31
29
|
def:[issue|
|
|
@@ -39,6 +37,16 @@ def:[issue|
|
|
|
39
37
|
%:[#>|"#{value} command"]
|
|
40
38
|
%:[$>|"#{value} setting"]
|
|
41
39
|
]
|
|
40
|
+
release[0.5.2|November 11th 2012|
|
|
41
|
+
features[
|
|
42
|
+
issue[208|HTML output now indented automatically.]
|
|
43
|
+
issue[206|CSS improvements.]
|
|
44
|
+
]
|
|
45
|
+
bugs[
|
|
46
|
+
issue[209|Made Glyph compatible with gli v2.x.]
|
|
47
|
+
issue[207|Fixed heading level of aliased macro always set to 2.]
|
|
48
|
+
]
|
|
49
|
+
]
|
|
42
50
|
release[0.5.1|December 4th 2011|
|
|
43
51
|
bugs[
|
|
44
52
|
issue[203|Fixed error in %>[pubdate].]
|
|
@@ -25,7 +25,6 @@ Currently, Glyph supports:
|
|
|
25
25
|
By default, Glyph attempts to use wkhtmltopdf. To change this, set the $>[output_pdf_generator] to code[prince].
|
|
26
26
|
]
|
|
27
27
|
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).]
|
|
28
|
-
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].]
|
|
29
28
|
]
|
|
30
29
|
|
|
31
30
|
section[
|
|
@@ -73,7 +73,7 @@ macro :issue do
|
|
|
73
73
|
end
|
|
74
74
|
=]
|
|
75
75
|
p[The code[issue] macro is only rewriting existing Glyph code around the two parameters provided. In this case, it is possible to do exactly the same thing using the %>[define:] (aliased by @def:@):]
|
|
76
|
-
highlight[=
|
|
76
|
+
highlight[=plain|
|
|
77
77
|
define:[issue\|
|
|
78
78
|
tr[
|
|
79
79
|
td[\/=>[http://github.com/h3rald/glyph/issues/closed#issue/{{0}}\|#{{0}}]]
|
|
@@ -1,21 +1,14 @@
|
|
|
1
1
|
.[
|
|
2
2
|
&:[prince|=>[http://www.princexml.com/|Prince]]
|
|
3
3
|
&:[wkhtml|=>[http://code.google.com/p/wkhtmltopdf/|wkhtmltopdf]]
|
|
4
|
-
|
|
5
|
-
if Glyph.lite? then
|
|
6
|
-
interpret "section[#{raw_value}]"
|
|
7
|
-
else
|
|
8
|
-
interpret "txt[#{raw_value}]"
|
|
9
|
-
end
|
|
10
|
-
=]
|
|
11
|
-
]?txt[Glyph is a _Rapid Document Authoring Framework_.
|
|
4
|
+
]section[txt[Glyph is a _Rapid Document Authoring Framework_.
|
|
12
5
|
|
|
13
|
-
With Glyph, creating and maintaining any kind of document becomes as easy as... _programming_. Glyph enables you to minimize text duplication, focus on content rather than presentation, manage references seamlessly and automate tedious tasks through a simple but effective macro language, specifically geared towards customization and extensibility.
|
|
6
|
+
With Glyph, creating and maintaining any kind of document becomes as easy as... _programming_. Glyph enables you to minimize text duplication, focus on content rather than presentation, manage references seamlessly and automate tedious tasks through a simple but effective macro language, specifically geared towards customization and extensibility.]
|
|
14
7
|
|
|
15
8
|
section[
|
|
16
9
|
@title[Main Features]
|
|
17
10
|
|
|
18
|
-
|
|
11
|
+
§txt[
|
|
19
12
|
@title[Command Line Interface]
|
|
20
13
|
Glyph is 100% command line. Its interface resambles =>[http://git-scm.com/|Git's] for its simplicity and power (thanks to the =>[http://github.com/davetron5000/gli|gli] gem). Here are some example commands:
|
|
21
14
|
|
|
@@ -29,10 +22,11 @@ Glyph is 100% command line. Its interface resambles =>[http://git-scm.com/|Git's
|
|
|
29
22
|
* @glyph stats@ -- Display project statistics.
|
|
30
23
|
]
|
|
31
24
|
|
|
32
|
-
|
|
25
|
+
§[
|
|
33
26
|
@title[Minimalist Syntax]
|
|
34
|
-
Glyph syntax rules can be explained using Glyph itself:
|
|
35
|
-
|
|
27
|
+
p[Glyph syntax rules can be explained using Glyph itself:]
|
|
28
|
+
|
|
29
|
+
highlight[=plain|
|
|
36
30
|
section[
|
|
37
31
|
@title[Something about Glyph]
|
|
38
32
|
txt[
|
|
@@ -54,8 +48,8 @@ or =>[http://code.google.com/p/wkhtmltopdf/\|wkhtmltopdf].
|
|
|
54
48
|
]
|
|
55
49
|
]
|
|
56
50
|
=]
|
|
57
|
-
The Glyph code above corresponds to the following HTML code:
|
|
58
|
-
|
|
51
|
+
p[The Glyph code above corresponds to the following HTML code:]
|
|
52
|
+
highlight[=html|
|
|
59
53
|
<div class="section">
|
|
60
54
|
<h2 id="h_10">Something about Glyph</h2>
|
|
61
55
|
<p>
|
|
@@ -81,50 +75,48 @@ The Glyph code above corresponds to the following HTML code:
|
|
|
81
75
|
=]
|
|
82
76
|
]
|
|
83
77
|
|
|
84
|
-
|
|
78
|
+
§[
|
|
85
79
|
@title[Content Reuse]
|
|
86
|
-
Finding yourself repeating the same sentence over an over? Glyph allows you to create snippets. Within snippets. Within other snippets (and so on, for a long long time...) as long as you don't define a snippet by defining itself, which would be kinda nasty (and Glyph would complain!):
|
|
87
|
-
|
|
80
|
+
txt[Finding yourself repeating the same sentence over an over? Glyph allows you to create snippets. Within snippets. Within other snippets (and so on, for a long long time...) as long as you don't define a snippet by defining itself, which would be kinda nasty (and Glyph would complain!):]
|
|
81
|
+
highlight[=plain|
|
|
88
82
|
snippet:[entities\|snippets and macros]
|
|
89
83
|
snippet:[custom_definitions\|
|
|
90
84
|
p[Glyph allows you to define your own &[entities].]
|
|
91
85
|
]
|
|
92
86
|
&[custom_definitions]
|
|
93
87
|
=]
|
|
94
|
-
...which results in:
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
=]
|
|
98
|
-
If yourself dreaming about _parametric_ snippets, just create your own macros (see the =>[http://github.com/h3rald/glyph/blob/master/book/text/changelog.glyph|source] of Glyph's changelog, just to have an idea).
|
|
88
|
+
p[...which results in:]
|
|
89
|
+
highlight[=html|<p>Glyph allows you to define your own snippets and macros.</p>=]
|
|
90
|
+
txt[If yourself dreaming about _parametric_ snippets, just create your own macros (see the =>[http://github.com/h3rald/glyph/blob/master/book/text/changelog.glyph|source] of Glyph's changelog, just to have an idea).]
|
|
99
91
|
]
|
|
100
|
-
|
|
92
|
+
§txt[
|
|
101
93
|
@title[Automation of Common Tasks]
|
|
102
94
|
If you're writing a book, you shouldn't have to worry about pagination, headers, footers, table of contents, section numbering or similar. Glyph understands you, and will take care of everything for you (with a little help from CSS3, sometimes).
|
|
103
95
|
]
|
|
104
|
-
|
|
96
|
+
§txt[
|
|
105
97
|
@title[Reference Validation]
|
|
106
98
|
Feel free to add plenty of links, snippets, bookmarks, ... if Glyph doesn't find something, it will definitely complain. Broken references are a thing on the past, and you don't need to worry about it.
|
|
107
99
|
]
|
|
108
|
-
|
|
100
|
+
§txt[
|
|
109
101
|
@title[Extreme Extensibility]
|
|
110
102
|
* You miss a code[=!!!=] macro to format really, _really_ important things? Create it. In under 3 seconds, in Ruby or Glyph itself. And yes, you can use special characters, too.
|
|
111
103
|
* You want your own, very special special @glyph create --everything@ command to create all _you_ need in a Glyph project? You can do it. Using your own Rake tasks, too.
|
|
112
104
|
* You want Glyph to output ODF files? You can do it, and you'll be able to run @glyph generate -f odf@. This would probably require a little more time, but it's trivial, from a technical point of view.
|
|
113
105
|
]
|
|
114
|
-
|
|
106
|
+
§txt[
|
|
115
107
|
@title[Convention over Configuration]
|
|
116
108
|
Put your text files in @/text@, your images in @/images@, add custom macros in a @macro@ folder within your @/lib@ folder... you get the picture: Glyph has its special places.
|
|
117
109
|
|
|
118
110
|
Nonetheless, you also have 1 (_one_) configuration file to customize to your heart's content (with smart defaults).
|
|
119
111
|
]
|
|
120
|
-
|
|
112
|
+
§txt[
|
|
121
113
|
@title[Free and Open Source]
|
|
122
114
|
Glyph is 100% Open Source Software, developed using the Ruby Programming Language and licensed under the very permissive terms of the =>[http://www.opensource.org/licenses/mit-license.php|MIT License].
|
|
123
115
|
|
|
124
116
|
If you have Ruby installed, just run @gem install glyph@. That's all it takes.
|
|
125
117
|
]
|
|
126
118
|
]
|
|
127
|
-
|
|
119
|
+
§txt[
|
|
128
120
|
@title[Resources]
|
|
129
121
|
* Home Page: =>[http://www.h3rald.com/glyph/]
|
|
130
122
|
* Repository: =>[http://www.github.com/h3rald/glyph/]
|
data/book/text/license.glyph
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
p[Copyright © 2010-
|
|
1
|
+
p[Copyright © 2010-2012 strong[Fabio Cevasco], =>[http://www.h3rald.com]]
|
|
2
2
|
p[Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
3
3
|
of this software and associated documentation files (the "Software"), to deal
|
|
4
4
|
in the Software without restriction, including without limitation the rights
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
ref_macro[
|
|
3
3
|
@n[add]
|
|
4
4
|
@desc[Adds two or more integers together.]
|
|
5
|
-
@params[Two or more integer values.]
|
|
6
5
|
@example[=add[2\|5\|7]=]
|
|
7
6
|
]
|
|
8
7
|
|
|
@@ -227,7 +226,6 @@ Checks a string against a regular expression.
|
|
|
227
226
|
ref_macro[
|
|
228
227
|
@n[multiply]
|
|
229
228
|
@desc[Multiplies two or more integers together.]
|
|
230
|
-
@params[Two or more integer values.]
|
|
231
229
|
@example[=add[3\|5\|9]=]
|
|
232
230
|
]
|
|
233
231
|
|
|
@@ -325,7 +323,6 @@ s/sub[This is a test string\|/a test/\|another test]
|
|
|
325
323
|
ref_macro[
|
|
326
324
|
@n[subtract]
|
|
327
325
|
@desc[Subtracts two or more integers together.]
|
|
328
|
-
@params[Two or more integer values.]
|
|
329
326
|
@example[=add[10\|5\|2]=]
|
|
330
327
|
]
|
|
331
328
|
|
|
@@ -15,13 +15,13 @@ section[
|
|
|
15
15
|
p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.]
|
|
16
16
|
]
|
|
17
17
|
section[
|
|
18
|
-
@title[code[-
|
|
19
|
-
@id[
|
|
20
|
-
p[
|
|
18
|
+
@title[code[-h], code[--help]]
|
|
19
|
+
@id[help_switch]
|
|
20
|
+
p[Displays help on the program.]
|
|
21
21
|
]
|
|
22
22
|
]
|
|
23
23
|
section[
|
|
24
|
-
@title[add]
|
|
24
|
+
@title[code[add]]
|
|
25
25
|
@id[c_add]
|
|
26
26
|
p[Creates a new text file in the code[text/] folder.]
|
|
27
27
|
example[glyph add introduction.textile]
|
|
@@ -30,7 +30,7 @@ section[
|
|
|
30
30
|
]
|
|
31
31
|
]
|
|
32
32
|
section[
|
|
33
|
-
@title[compile]
|
|
33
|
+
@title[code[compile]]
|
|
34
34
|
@id[c_compile]
|
|
35
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
36
|
example[glyph compile -f pdf]
|
|
@@ -54,12 +54,14 @@ If specified, enable =>[#auto_regeneration|auto regeneration] (requires the =>[h
|
|
|
54
54
|
]
|
|
55
55
|
]
|
|
56
56
|
section[
|
|
57
|
-
@title[config]
|
|
57
|
+
@title[code[config]]
|
|
58
58
|
@id[c_config]
|
|
59
59
|
Gets or sets a configuration setting in the project or global configuration file (\/fmi[configuration files|#cfg]).
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
60
|
+
§[
|
|
61
|
+
@title[Examples]
|
|
62
|
+
@notoc[true]
|
|
63
|
+
p[code[glyph config document.filename]]
|
|
64
|
+
p[code[glyph config -g document.author "Fabio Cevasco"]]
|
|
63
65
|
]
|
|
64
66
|
options[
|
|
65
67
|
-o[global|
|
|
@@ -73,25 +75,27 @@ If specified, the global configuration file is processed instead of the project
|
|
|
73
75
|
]
|
|
74
76
|
]
|
|
75
77
|
section[
|
|
76
|
-
@title[help]
|
|
78
|
+
@title[code[help]]
|
|
77
79
|
@id[c_help]
|
|
78
80
|
Prints information about all Glyph commands or about one specific command.
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
81
|
+
§[
|
|
82
|
+
@title[Examples]
|
|
83
|
+
@notoc[true]
|
|
84
|
+
p[code[glyph help]]
|
|
85
|
+
p[code[glyph help compile]]
|
|
82
86
|
]
|
|
83
87
|
parameters[
|
|
84
88
|
-p[em[command]|A valid Glyph command.]
|
|
85
89
|
]
|
|
86
90
|
]
|
|
87
91
|
section[
|
|
88
|
-
@title[init]
|
|
92
|
+
@title[code[init]]
|
|
89
93
|
@id[c_init]
|
|
90
94
|
Creates a new Glyph project in the current directory (if empty).
|
|
91
95
|
example[glyph init]
|
|
92
96
|
]
|
|
93
97
|
section[
|
|
94
|
-
@title[outline]
|
|
98
|
+
@title[code[outline]]
|
|
95
99
|
@id[c_outline]
|
|
96
100
|
Display an outline of the current document.
|
|
97
101
|
options[
|
|
@@ -108,21 +112,25 @@ Display file names.
|
|
|
108
112
|
Display section titles.
|
|
109
113
|
]
|
|
110
114
|
]
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
glyph outline -
|
|
115
|
+
§[
|
|
116
|
+
@title[Examples]
|
|
117
|
+
@notoc[true]
|
|
118
|
+
p[code[glyph outline -it -l 1]]
|
|
119
|
+
p[code[glyph outline -l 2]]
|
|
120
|
+
p[code[glyph outline -f]]
|
|
115
121
|
]
|
|
116
122
|
]
|
|
117
123
|
section[
|
|
118
|
-
@title[stats]
|
|
124
|
+
@title[code[stats]]
|
|
119
125
|
@id[c_stats]
|
|
120
126
|
def:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]]
|
|
121
127
|
def:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]]
|
|
122
128
|
p[Displays project statistics (\/fmi[this command|#stats]).]
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
129
|
+
§[
|
|
130
|
+
@title[Examples]
|
|
131
|
+
@notoc[true]
|
|
132
|
+
p[code[glyph stats -m]]
|
|
133
|
+
p[code[glyph stats --link=h3rald.com]]
|
|
126
134
|
]
|
|
127
135
|
options[
|
|
128
136
|
stats_option[bookmarks]
|
|
@@ -137,7 +145,7 @@ glyph stats --link=h3rald.com
|
|
|
137
145
|
]
|
|
138
146
|
]
|
|
139
147
|
section[
|
|
140
|
-
@title[todo]
|
|
148
|
+
@title[code[todo]]
|
|
141
149
|
@id[c_todo]
|
|
142
150
|
Prints all the todo items saved using the %>[todo].
|
|
143
151
|
example[glyph todo]
|