RubyGems - glyph - Versions diffs - 0.5.1 → 0.5.2 - Mend

glyph 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

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

@@ -4,7 +4,7 @@
   :subtitle: Rapid Document Authoring Framework
   :author: Fabio Cevasco
   :draft: true
-  :revision: v0.5.1
+  :revision: v0.5.2
   :filename: glyph
   :title: Glyph
   :styles: link

data/book/document.glyph CHANGED

@@ -51,7 +51,7 @@ book[
 		chapter[
 			@title[Authoring Documents]
 			section[
-				@title[.glyph files]
+				@title[code[.glyph] files]
 				@src[text_editing/glyph_files]
 			]
 			section[
@@ -296,22 +296,22 @@ book[
 			@title[Configuration Reference]
 			@id[cfg_ref]
 			section[
-				@title[document.*]
+				@title[code[document.*]]
 				@id[cfg_document]
 				@src[config/document]
 			]
 			section[
-				@title[filters.*]
+				@title[code[filters.*]]
 				@id[cfg_filters]
 				@src[config/filters]
 			]
 			section[
-				@title[options.*]
+				@title[code[options.*]]
 				@id[cfg_options]
 				@src[config/options]
 			]
 			section[
-				@title[output.*]
+				@title[code[output.*]]
 				@id[cfg_output]
 				@src[config/output]
 			]

data/book/lib/layouts/bookindex.glyph CHANGED

@@ -2,9 +2,6 @@
 <html lang="en">
 	<head>
 		<title>Glyph - Document Authoring Framework</title>
-		<link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
 		<meta charset="utf-8" />
 		<meta name="author" content="Fabio Cevasco" />
@@ -43,10 +40,10 @@
 				<header class="page">
 	<nav class="home-link">
 		<a href="/">
-			<img src="/images/h3rald_small.png" alt="H3RALD" class="default"/>
-			<!\[if !IE\]>
-			<img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/>
-			<!\[endif\]>
+      <span class="logo">
+        <span class="hrald"><span class="h">H</span>&nbsp;<span class="rald">RALD</span></span>
+        <span class="three">3</span>
+      </span>
 		</a>
 	</nav>
@@ -69,32 +66,12 @@
           <nav id="sharing-buttons">
 <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a>
 <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
-<g:plusone size="medium"></g:plusone>
-<script type="text/javascript">
-  (function() {
-    var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
-    po.src = 'https://apis.google.com/js/plusone.js';
-    var s = document.getElementsByTagName('script')\[0\]; s.parentNode.insertBefore(po, s);
-  })();
-</script>
 </nav>
 					</section>
 				</article>
 			<footer>
-				<section class="ads">
-					<script type="text/javascript"><!--
-						google_ad_client = "pub-2871497824158668";
-						/* 728x90, created 9/10/10 */
-						google_ad_slot = "3963343166";
-						google_ad_width = 728;
-						google_ad_height = 90;
-						//-->
-					</script>
-					<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-					</script>
-				</section>
 				<section>
 					<nav>
 						<a href="/about/">ABOUT</a>\|<a href="/contact/">CONTACT</a>

data/book/lib/layouts/bookpage.glyph CHANGED

@@ -2,9 +2,6 @@
 <html lang="en">
 	<head>
     <title>{{title}} - Glyph</title>
-		<link href='http://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
 		<meta charset="utf-8" />
 		<meta name="author" content="Fabio Cevasco" />
@@ -43,10 +40,10 @@
 				<header class="page">
 	<nav class="home-link">
 		<a href="/">
-			<img src="/images/h3rald_small.png" alt="H3RALD" class="default"/>
-			<!\[if !IE\]>
-			<img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/>
-			<!\[endif\]>
+      <span class="logo">
+        <span class="hrald"><span class="h">H</span>&nbsp;<span class="rald">RALD</span></span>
+        <span class="three">3</span>
+      </span>
 		</a>
 	</nav>
@@ -70,37 +67,17 @@
 										<nav id="sharing-buttons">
 <a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="h3rald">Tweet</a>
 <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
-<g:plusone size="medium"></g:plusone>
-<script type="text/javascript">
-  (function() {
-    var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
-    po.src = 'https://apis.google.com/js/plusone.js';
-    var s = document.getElementsByTagName('script')\[0\]; s.parentNode.insertBefore(po, s);
-  })();
-</script>
 </nav>
 					</section>
 				</article>
 			<footer>
-				<section class="ads">
-					<script type="text/javascript"><!--
-						google_ad_client = "pub-2871497824158668";
-						/* 728x90, created 9/10/10 */
-						google_ad_slot = "3963343166";
-						google_ad_width = 728;
-						google_ad_height = 90;
-						//-->
-					</script>
-					<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-					</script>
-				</section>
 				<section>
 					<nav>
 						<a href="/about/">ABOUT</a>\|<a href="/contact/">CONTACT</a>
 					</nav>
-					<p>H3RALD Web Site v8.1.2 &copy; 2004 &mdash; 2011 <em>Fabio Cevasco</em></p>
+					<p>H3RALD Web Site v8.1.2 &copy; 2004 &mdash; 2012 <em>Fabio Cevasco</em></p>
 				</section>
 			</footer>
 		</section><!-- #container end -->

data/book/lib/macros/reference.rb CHANGED

@@ -90,8 +90,9 @@ end
 macro :block_example do
 	interpret %{
-		div[@class[example]
-			p[strong[Example]]
+		section[
+			@title[Example]
+      @notoc[true]
 			highlight[=html|
 #{value}
 			=]
@@ -99,15 +100,6 @@ macro :block_example do
 	}
 end
-macro :examples do
-	%{
-<div class="examples">
-<p><strong>Examples:</strong></p>
-#{value.split("\n").map{|i| "<code>#{i}</code><br />"}.to_s}
-</div>
-	}
-end
 macro :aliases do
 	%{<strong>Aliases:</strong> <code>#{value}</code>}
 end
@@ -130,7 +122,7 @@ macro :ref_macro do
 		]} if raw_attr(:remarks)
 	interpret %{
 	section[
-		@title[#{m_name}]
+		@title[code[#{m_name}]]
 		@id[m_#{m_name.gsub(/[^a-z0-1_-]/, '_')}]
 		txt[
 #{m_value}

data/book/text/changelog.glyph CHANGED

@@ -24,8 +24,6 @@ def:[release|
   section[
     @title[v{{0}} &ndash; {{1}}]
     {{2}}
-    p/em[&rarr; View closed issues on =>[https://github.com/h3rald/glyph/issues?direction=asc&amp;labels={{0}}&amp;sort=created&amp;state=closed|GitHub].]
   ]
 ]
 def:[issue|
@@ -39,6 +37,16 @@ def:[issue|
   %:[#>|"#{value} command"]
   %:[$>|"#{value} setting"]
 ]
+release[0.5.2|November 11th 2012|
+  features[
+    issue[208|HTML output now indented automatically.]
+    issue[206|CSS improvements.]
+  ]
+  bugs[
+    issue[209|Made Glyph compatible with gli v2.x.]
+    issue[207|Fixed heading level of aliased macro always set to 2.]
+  ]
+]
 release[0.5.1|December 4th 2011|
   bugs[
     issue[203|Fixed error in %>[pubdate].]

data/book/text/compiling/compiling.glyph CHANGED

@@ -25,7 +25,6 @@ Currently, Glyph supports:
 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[

data/book/text/extending/interpreting.glyph CHANGED

@@ -73,7 +73,7 @@ macro :issue do
 end
 		=]
 		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:@):]
-		highlight[=html|
+		highlight[=plain|
 define:[issue\|
   tr[
     td[\/=>[http://github.com/h3rald/glyph/issues/closed#issue/{{0}}\|#{{0}}]]

data/book/text/introduction.glyph CHANGED

@@ -1,21 +1,14 @@
 .[
 	&:[prince|=>[http://www.princexml.com/|Prince]]
 	&:[wkhtml|=>[http://code.google.com/p/wkhtmltopdf/|wkhtmltopdf]]
-	macro:[=?txt|
-if Glyph.lite? then
-	interpret "section[#{raw_value}]"
-else
-	interpret "txt[#{raw_value}]"
-end
-	=]
-]?txt[Glyph is a _Rapid Document Authoring Framework_.
+]section[txt[Glyph is a _Rapid Document Authoring Framework_.
-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.
+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.]
 	section[
 		@title[Main Features]
-		section[
+		§txt[
 			@title[Command Line Interface]
 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:
@@ -29,10 +22,11 @@ Glyph is 100% command line. Its interface resambles =>[http://git-scm.com/|Git's
 * @glyph stats@ -- Display project statistics.
 		]
-		section[
+		§[
 			@title[Minimalist Syntax]
-Glyph syntax rules can be explained using Glyph itself:
-			codeblock[=
+p[Glyph syntax rules can be explained using Glyph itself:]
+			highlight[=plain|
 section[
   @title[Something about Glyph]
   txt[
@@ -54,8 +48,8 @@ or =>[http://code.google.com/p/wkhtmltopdf/\|wkhtmltopdf].
   ]
 ]
 			=]
-The Glyph code above corresponds to the following HTML code:
-				codeblock[=
+p[The Glyph code above corresponds to the following HTML code:]
+				highlight[=html|
 <div class="section">
   <h2 id="h_10">Something about Glyph</h2>
   <p>
@@ -81,50 +75,48 @@ The Glyph code above corresponds to the following HTML code:
 			=]
 		]
-		section[
+		§[
 			@title[Content Reuse]
-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!):
-			codeblock[=
+      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!):]
+			highlight[=plain|
 snippet:[entities\|snippets and macros]
 snippet:[custom_definitions\|
 	p[Glyph allows you to define your own &[entities].]
 ]
 &[custom_definitions]
 			=]
-		...which results in:
-			codeblock[=
-<p>Glyph allows you to define your own snippets and macros.</p>
-			=]
-		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).
+		p[...which results in:]
+			highlight[=html|<p>Glyph allows you to define your own snippets and macros.</p>=]
+		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).]
 		]
-		section[
+		§txt[
 		@title[Automation of Common Tasks]
 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).
 		]
-		section[
+		§txt[
 		@title[Reference Validation]
 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.
 		]
-		section[
+		§txt[
 			@title[Extreme Extensibility]
 * 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.
 * 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.
 * 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.
 		]
-		section[
+		§txt[
 			@title[Convention over Configuration]
 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.
 Nonetheless, you also have 1 (_one_) configuration file to customize to your heart's content (with smart defaults).
 		]
-		section[
+		§txt[
 		@title[Free and Open Source]
 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].
 If you have Ruby installed, just run @gem install glyph@. That's all it takes.
 		]
 	]
-	section[
+	§txt[
 		@title[Resources]
 * Home Page: =>[http://www.h3rald.com/glyph/]
 * Repository: =>[http://www.github.com/h3rald/glyph/]

data/book/text/license.glyph CHANGED

@@ -1,4 +1,4 @@
-p[Copyright &copy; 2010-2011 strong[Fabio Cevasco], =>[http://www.h3rald.com]]
+p[Copyright &copy; 2010-2012 strong[Fabio Cevasco], =>[http://www.h3rald.com]]
 p[Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

data/book/text/macros/macros_core.glyph CHANGED

@@ -2,7 +2,6 @@
   ref_macro[
     @n[add]
     @desc[Adds two or more integers together.]
-    @params[Two or more integer values.]
     @example[=add[2\|5\|7]=]
   ]
@@ -227,7 +226,6 @@ Checks a string against a regular expression.
   ref_macro[
     @n[multiply]
     @desc[Multiplies two or more integers together.]
-    @params[Two or more integer values.]
     @example[=add[3\|5\|9]=]
   ]
@@ -325,7 +323,6 @@ s/sub[This is a test string\|/a test/\|another test]
   ref_macro[
     @n[subtract]
     @desc[Subtracts two or more integers together.]
-    @params[Two or more integer values.]
     @example[=add[10\|5\|2]=]
   ]

data/book/text/ref_commands.glyph CHANGED

@@ -15,13 +15,13 @@ section[
     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.]
+    @title[code[-h], code[--help]]
+    @id[help_switch]
+    p[Displays help on the program.]
   ]
 ]
 section[
-  @title[add]
+  @title[code[add]]
   @id[c_add]
   p[Creates a new text file in the code[text/] folder.]
   example[glyph add introduction.textile]
@@ -30,7 +30,7 @@ section[
   ]
 ]
 section[
-  @title[compile]
+  @title[code[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]
@@ -54,12 +54,14 @@ If specified, enable =>[#auto_regeneration|auto regeneration] (requires the =>[h
   ]
 ]
 section[
-  @title[config]
+  @title[code[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"
+  §[
+    @title[Examples]
+    @notoc[true]
+    p[code[glyph config document.filename]]
+    p[code[glyph config -g document.author "Fabio Cevasco"]]
   ]
   options[
     -o[global|
@@ -73,25 +75,27 @@ If specified, the global configuration file is processed instead of the project
   ]
 ]
 section[
-  @title[help]
+  @title[code[help]]
   @id[c_help]
 Prints information about all Glyph commands or about one specific command.
-  examples[
-glyph help
-glyph help compile
+  §[
+    @title[Examples]
+    @notoc[true]
+    p[code[glyph help]]
+    p[code[glyph help compile]]
   ]
   parameters[
     -p[em[command]|A valid Glyph command.]
   ]
 ]
 section[
-  @title[init]
+  @title[code[init]]
   @id[c_init]
 Creates a new Glyph project in the current directory (if empty).
   example[glyph init]
 ]
 section[
-  @title[outline]
+  @title[code[outline]]
   @id[c_outline]
 Display an outline of the current document.
   options[
@@ -108,21 +112,25 @@ Display file names.
 Display section titles.
     ]
   ]
-  examples[
-glyph outline -it -l 1
-glyph outline -l 2
-glyph outline -f
+  §[
+    @title[Examples]
+    @notoc[true]
+    p[code[glyph outline -it -l 1]]
+    p[code[glyph outline -l 2]]
+    p[code[glyph outline -f]]
   ]
 ]
 section[
-  @title[stats]
+  @title[code[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
+  §[
+    @title[Examples]
+    @notoc[true]
+    p[code[glyph stats -m]]
+    p[code[glyph stats --link=h3rald.com]]
   ]
   options[
     stats_option[bookmarks]
@@ -137,7 +145,7 @@ glyph stats --link=h3rald.com
   ]
 ]
 section[
-  @title[todo]
+  @title[code[todo]]
   @id[c_todo]
 Prints all the todo items saved using the %>[todo].
   example[glyph todo]