glyph 0.4.0 → 0.4.1

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.
@@ -1,129 +1,127 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
- head[
5
- <title>{{title}} - Glyph</title>
6
- <meta name="author" content="Fabio Cevasco" />
7
- <meta name="copyright" content="Fabio Cevasco" />
8
- <meta name="robots" content="all, follow" />
9
- <meta name="Revisit-After" content="2 Days" />
10
- <meta name="language" content="en" />
11
- <meta name="target_country" content="en-us" />
12
- <meta name="country" content="United States" />
13
- <meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
14
- <meta name="keywords" content="h3rald, fabio cevasco, glyph, technical writing, html, html5, book" />
15
- <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
16
- <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
17
- <meta content="44.388041;9.073248" name="ICBM" />
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>{{title}} &ndash; Glyph Documentation</title>
18
5
 
19
- <link href="/css/main.css" media="all" rel="stylesheet" type="text/css" />
20
- style[default.css]
21
6
 
22
- ]
23
- <body>
24
- <div id="wrapper">
25
- <a href="http://github.com/h3rald/h3rald"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub" /></a>
26
- <div id="header">
27
- <!--\[if lte IE 6\]>
28
- <div id="ie-warning">
29
- This site is not compatible with Internet Explorer 6 or lower. You should consider using a more modern browser for a better &ndash; and <em>safer</em> &ndash; web experience. \[<a href="http://browsehappy.com/browsers/">Read More...</a>\]
30
- </div>
31
- <!\[endif\]-->
32
- <!-- HEADER START -->
33
- <div id="header-container">
34
- <div id="header-left">
35
- <h1><span class="logo"></span><a id="logo" href="/" title="H3RALD"></a></h1>
36
- </div>
37
- <div id="header-right">
38
- <ul id="navigation">
39
- <li><span class="preload nav-archives"></span><a id="nav-archives" href="/archives/" title="ARCHIVES"></a></li>
40
- <li><span class="preload nav-projects"></span><a id="nav-projects" href="/projects/" title="PROJECTS"></a></li>
41
- <li><span class="preload nav-about"></span><a id="nav-about" href="/about/" title="ABOUT"></a></li>
42
- <li><span class="preload nav-other"></span><a id="nav-other" href="/other/" title="OTHER"></a></li>
43
- </ul>
44
- </div>
45
- </div>
46
- </div>
47
- <!-- HEADER END -->
48
- <div class="ribbon">
49
- </div>
50
- <!-- MAIN START -->
51
- <div id="main">
52
- <!-- CONTAINER START -->
53
- <div id="container">
54
- <!-- CONTENT START -->
55
- <div id="content" class="clearfixstandard">
56
- <div id="page-links">
57
- <span><script type="text/javascript" src="http://w.sharethis.com/button/sharethis.js#publisher=6e34d60c-b14e-4c19-9b2f-7c35a9f0ab09&amp;type=website&amp;linkfg=%23a4282d"></script></span>
58
- </div>
59
7
 
60
- <h2>{{title}}</h2>
61
- <hr />
62
- <div id="content-body">
8
+ <meta charset="utf-8" />
9
+ <meta name="author" content="Fabio Cevasco" />
10
+ <meta name="copyright" content="Fabio Cevasco" />
11
+ <meta name="robots" content="all, follow" />
12
+ <meta name="Revisit-After" content="2 Days" />
13
+ <meta name="language" content="en" />
14
+ <meta name="target_country" content="en-us" />
15
+ <meta name="country" content="United States" />
16
+ <meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
17
+
18
+ <meta name="keywords" content="h3rald, fabio cevasco, glyph" />
19
+ <link rel="shortcut icon" href="/favicon.png" type="image/png" />
20
+ <meta content="44.388041;9.073248" name="ICBM" />
21
+
22
+
23
+ <link rel="stylesheet" type="text/css" href="/styles/html5reset.css" />
24
+ <link rel="stylesheet" type="text/css" href="/styles/style.css" />
25
+
26
+ <!--\[if lte IE 8\]>
27
+ <script src="/js/html5.js" type="text/javascript"></script>
28
+ <!\[endif\]-->
29
+ </head>
30
+ <body>
31
+ <!--\[if lte IE 6\]>
32
+ <div id="ie-warning">
33
+ This site is not compatible with Internet Explorer 6 or lower. You should consider using a more modern browser for a better &ndash; and <em>safer</em> &ndash; web experience. \[<a href="http://browsehappy.com/browsers/">Read More &raquo;</a>\]
34
+ </div>
35
+ <!\[endif\]-->
36
+
37
+ <section id="container">
38
+
39
+ <header class="page">
40
+ <nav class="home-link">
41
+ <a href="/">
42
+ <img src="/images/h3rald_small.png" alt="H3RALD" class="default"/>
43
+ <!\[if !IE\]>
44
+ <img src="/images/h3rald_hover_small.png" alt="H3RALD" class="hover"/>
45
+ <!\[endif\]>
46
+ </a>
47
+ </nav>
48
+
49
+ <nav class="section">
50
+ /<a href="/glyph/" rel="archives">GLYPH</a>
51
+ </nav>
52
+
53
+ </header>
54
+ <article class="page">
55
+ <header>
56
+ <hgroup>
57
+ <h1>{{title}}</h1>
58
+ <h2>Glyph Documentation</h2>
59
+ </hgroup>
60
+ </header>
61
+ <section id="body-text" class="hyphenate glyph-book">
62
+
63
63
  navigation[{{id}}]
64
64
  {{contents}}
65
65
  navigation[{{id}}]
66
- </div>
67
- <div id="content-footer">
68
- <div class="share">
69
- <script type="text/javascript"><!--
70
- google_ad_client = "pub-2871497824158668";
71
- /* 728x90, h3rald 8.0 */
72
- google_ad_slot = "0081634732";
73
- google_ad_width = 728;
74
- google_ad_height = 90;
75
- //-->
76
- </script>
77
- <script type="text/javascript"
78
- src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
79
- </script>
80
- </div>
81
- </div>
82
- </div>
83
- <!-- CONTENT END -->
84
- </div>
85
- <!-- CONTAINER END -->
86
- </div>
87
- <div class="ribbon"></div>
88
- <!-- MAIN END -->
89
- <div id="border-bottom">
90
- <div id="services">
91
- <div class ="footer-left">
92
- <div id="backtype">
93
- <h3><span class="s-opinions preload"></span><a id="s-opinions" href="http://www.backtype.com/h3rald" title="Opinions"></a></h3>
94
- </div>
95
- </div>
96
- <div class ="footer-center">
97
- <div id="twitter">
98
- <h3><span class="s-tweets preload"></span><a id="s-tweets" href="http://www.twitter.com/h3rald" title="Tweets"></a></h3>
99
- </div>
100
- </div>
101
- <div class ="footer-right">
102
- <div id="delicious">
103
- <h3><span class="s-bookmarks preload"></span><a id="s-bookmarks" href="http://www.delicious.com/h3rald" title="Bookmarks"></a></h3>
104
- </div>
105
- </div>
106
- </div> <!-- SERVICES END -->
107
- </div>
108
- <div class="clearfooter"></div>
109
- </div> <!-- WRAPPER END -->
110
- <div id="footer">
111
- <div id="footer-container">
112
- <div class="footer-div">
113
- H3RALD Web Site v8.0.0 <em>"xStatic"</em> &mdash; &copy; 2004-2010 <strong>Fabio Cevasco</strong> &mdash; <a class="link" href="http://creativecommons.org/licenses/by-nc-nd/3.0/us/">Some rights reserved</a> \| <a href="http://validator.w3.org/check?uri=referer" class="link">XHTML 1.1</a> \| <a href="http://jigsaw.w3.org/css-validator/validator?uri=\.$[output.web.base]{{id}}\.$[output.web.extension]" class="link">CSS 2.1</a>
114
- </div>
115
- </div> <!-- END FOOTER CONTAINER-->
116
- </div> <!-- END FOOTER -->
117
- <!-- Start of StatCounter Code -->
118
- <script type="text/javascript">
119
- var sc_project=6193656;
120
- var sc_invisible=1;
121
- var sc_security="57f7ee2a";
122
- </script>
123
- <script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script>
124
- <!-- End of StatCounter Code -->
125
- <script src='http://www.google-analytics.com/ga.js' type='text/javascript'></script>
126
- <script src="http://www.google.com/jsapi?key=ABQIAAAA6h3j8Jri5D_da53UPbEbThRlq2n1sm52B5HDRR5tm6o8XM18FhTKn3v155RpPeD0kWnWG81QEhhifQ" type="text/javascript"></script>
127
- <script src="/js/compressed.js" type="text/javascript"></script>
128
- </body>
129
- </html>
66
+ </section>
67
+ </article>
68
+
69
+
70
+ <footer>
71
+ <section class="ads">
72
+ <script type="text/javascript"><!--
73
+ google_ad_client = "pub-2871497824158668";
74
+ /* 728x90, created 9/10/10 */
75
+ google_ad_slot = "3963343166";
76
+ google_ad_width = 728;
77
+ google_ad_height = 90;
78
+ //-->
79
+ </script>
80
+ <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
81
+ </script>
82
+ </section>
83
+ <section>
84
+ <nav>
85
+ <a href="/about/">ABOUT</a>\|<a href="/contact/">CONTACT</a>
86
+ </nav>
87
+ <p>H3RALD Web Site v8.1 &mdash; &copy; 2010 &mdash; <em>Fabio Cevasco</em></p>
88
+ </section>
89
+ </footer>
90
+ </section><!-- #container end -->
91
+ <script src="http://www.google.com/jsapi?key=ABQIAAAAr6RY1Z6dchG_sX9WDLSy3xRlq2n1sm52B5HDRR5tm6o8XM18FhR56xHNNH6CsX86uN5VoTrglpyOyQ" type="text/javascript"></script>
92
+ <!-- <script src="/js/jquery.js" type="text/javascript"></script> -->
93
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
94
+ <script src="/js/jquery-timeago.js" type="text/javascript"></script>
95
+ <script src="/js/jquery-easing.js" type="text/javascript"></script>
96
+ <script src="/js/jquery-fancybox.js" type="text/javascript"></script>
97
+ <script src="/js/jquery-toc.js" type="text/javascript"></script>
98
+ <script src="/js/date.js" type="text/javascript"></script>
99
+ <script src="/js/feeds.js" type="text/javascript"></script>
100
+ <script src="/js/search.js" type="text/javascript"></script>
101
+ <script src="/js/hyphenator.min.js" type="text/javascript"></script>
102
+ <script src="/js/init.js" type="text/javascript"></script>
103
+ <!-- Start Google Analytics -->
104
+ <script type="text/javascript">
105
+ .[=
106
+ var _gaq = _gaq \|\| [];
107
+ _gaq.push(['_setAccount', 'UA-18587377-1']);
108
+ _gaq.push(['_trackPageview']);
109
+
110
+ (function() {
111
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
112
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
113
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
114
+ })();
115
+ =]
116
+ </script>
117
+ <!-- End Google Analytics -->
118
+ <!-- Start of StatCounter Code -->
119
+ <script type="text/javascript">
120
+ var sc_project=6193656;
121
+ var sc_invisible=1;
122
+ var sc_security="57f7ee2a";
123
+ </script>
124
+ <script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script>
125
+ <!-- End of StatCounter Code -->
126
+ </body>
127
+ </html>
@@ -3,17 +3,14 @@ permalink: glyph
3
3
  filters_pre:
4
4
  - erb
5
5
  - redcloth
6
- title: "Project: Glyph"
6
+ title: "Glyph"
7
+ subtitle: "A Rapid Document Authoring Framework"
7
8
  type: project
8
9
  github: glyph
9
10
  links:
10
11
  - "Repository": http://www.github.com/h3rald/glyph/
11
- - "Bug Tracking": http://www.github.com/h3rald/glyph/issues
12
- - "Development Wiki": http://wiki.github.com/h3rald/glyph
13
12
  - "Download": http://www.rubygems.org/gems/glyph
14
- - "Book (PDF)": http://github.com/downloads/h3rald/glyph/glyph.pdf
15
- - "Book (Web)": http://www.h3rald.com/glyph/book/
16
- - "Docs": http://rubydoc.info/gems/glyph/
13
+ - "Documentation": /glyph/book/
17
14
  - "User Group": http://groups.google.com/group/glyph-framework
18
15
  status: Active
19
16
  version: %[Glyph::VERSION]
@@ -19,30 +19,27 @@ end
19
19
 
20
20
  namespace :generate do
21
21
  desc "Create output for h3rald.com integration"
22
- task :h3rald => [:web] do
22
+ task :h3rald => [:web5] do
23
23
  dir = Glyph::PROJECT/'output/h3rald'
24
24
  (dir/"glyph/book").mkpath
25
25
  # Copy files in subdir
26
26
  (dir).find do |i|
27
27
  if i.file? then
28
- next if
29
- i.to_s.match(Regexp.escape(dir/'glyph')) ||
30
- i.to_s.match(Regexp.escape(dir/'images')) ||
31
- i.to_s.match(Regexp.escape(dir/'styles'))
28
+ next if i.to_s.match(Regexp.escape(dir/'glyph'))
32
29
  dest = dir/"glyph/book/#{i.relative_path_from(Glyph::PROJECT/dir)}"
33
30
  src = i.to_s
34
31
  Pathname.new(dest).parent.mkpath
35
32
  file_copy src, dest
36
33
  end
37
34
  end
38
- # Remove files
35
+ # Remove files from output dir
39
36
  dir.children.each do |c|
40
- unless [dir/'glyph', dir/'images', dir/'styles'].include? c then
37
+ unless c == dir/'glyph' then
41
38
  c.directory? ? c.rmtree : c.unlink
42
39
  end
43
40
  end
44
- (dir/'images/glyph/glyph.eps').unlink
45
- (dir/'images/glyph/glyph.svg').unlink
41
+ (dir/'glyph/book/images/glyph/glyph.eps').unlink
42
+ (dir/'glyph/book/images/glyph/glyph.svg').unlink
46
43
  # Create project page
47
44
  project = Glyph.filter %{layout:project[
48
45
  @contents[#{file_load(Glyph::PROJECT/'text/introduction.glyph')}]
@@ -35,6 +35,15 @@ rw:[issue|
35
35
  %:[#>|"#{value} command"]
36
36
  %:[$>|"#{value} setting"]
37
37
  ]
38
+ release[0.4.1|September 25th 2010|
39
+ bugs[
40
+ issue[169|*.scss files are now supported by the %>[style].]
41
+ issue[170|Improved default CodeRay stylesheet.]
42
+ issue[171|SCSS now used internally by Glyph to generate default CSS files.]
43
+ issue[173|Consecutive escape sequences are now interpreted correctly in topics.]
44
+ issue[174|Fixed error causing broken images in web5/html5 output.]
45
+ ]
46
+ ]
38
47
  release[0.4.0|September 3th 2010|
39
48
  features[
40
49
  issue[40|A new #>[stats] can be used to display statistics about project files, snippets, macros, bookmarks and links.]
@@ -10,7 +10,7 @@ That's pretty much it. Of course, both the @filter@ and @compile@ method cause G
10
10
  txt[
11
11
  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:
12
12
  * =>[http://github.com/h3rald/h3rald/blob/master/lib/glyph_filter.rb|lib/glyph_filter.rb] -- using the @Glyph#filter@ method.
13
- * =>[http://github.com/h3rald/h3rald/blob/master/Rules|Rules] -- using the @Glyph#compile@ method to generate PDF files.
13
+ * =>[http://github.com/h3rald/h3rald/blob/master/lib/glyph_context.rb|lib/glyph_context.rb] -- using the @Glyph#compile@ method to generate PDF files.
14
14
  ]
15
15
  ]
16
16
  section[
@@ -17,8 +17,8 @@ The first step required to add a new output format to Glyph is extending Glyph's
17
17
  :extension: '.html'
18
18
  :filter_target: 'html'
19
19
  :base: '/glyph/book/'
20
- :macro_dirs: ['html']
21
- :layout_dirs: ['web']
20
+ :macro_dirs: ['html', 'html5']
21
+ :layout_dirs: ['web5']
22
22
  :layouts:
23
23
  :topic: bookpage
24
24
  :index: bookindex
@@ -41,30 +41,27 @@ The next (and final) step involves creating a custom @h3rald@ task within the @g
41
41
  highlight[=ruby|
42
42
  namespace :generate do
43
43
  desc "Create output for h3rald.com integration"
44
- task :h3rald => [:web] do
44
+ task :h3rald => [:web5] do
45
45
  dir = Glyph::PROJECT/'output/h3rald'
46
46
  (dir/"glyph/book").mkpath
47
47
  # Copy files in subdir
48
48
  (dir).find do \|i\|
49
49
  if i.file? then
50
- next if
51
- i.to_s.match(Regexp.escape(dir/'glyph')) \|\|
52
- i.to_s.match(Regexp.escape(dir/'images')) \|\|
53
- i.to_s.match(Regexp.escape(dir/'styles'))
50
+ next if i.to_s.match(Regexp.escape(dir/'glyph'))
54
51
  dest = dir/"glyph/book/#{i.relative_path_from(Glyph::PROJECT/dir)}"
55
52
  src = i.to_s
56
53
  Pathname.new(dest).parent.mkpath
57
54
  file_copy src, dest
58
55
  end
59
56
  end
60
- # Remove files
57
+ # Remove files from output dir
61
58
  dir.children.each do \|c\|
62
- unless [dir/'glyph', dir/'images', dir/'styles'].include? c then
59
+ unless c == dir/'glyph' then
63
60
  c.directory? ? c.rmtree : c.unlink
64
61
  end
65
62
  end
66
- (dir/'images/glyph/glyph.eps').unlink
67
- (dir/'images/glyph/glyph.svg').unlink
63
+ (dir/'glyph/book/images/glyph/glyph.eps').unlink
64
+ (dir/'glyph/book/images/glyph/glyph.svg').unlink
68
65
  # Create project page
69
66
  project = Glyph.filter %{layout:project[
70
67
  @contents[#{file_load(Glyph::PROJECT/'text/introduction.glyph')}]
@@ -73,6 +70,6 @@ namespace :generate do
73
70
  end
74
71
  end
75
72
  =]
76
- p[In this case, this task does not actually renders files in a different format, it just moves the files generated by the @generate:web@ task in different subdirectories.]
73
+ p[In this case, this task does not actually renders files in a different format, it just moves the files generated by the @generate:web5@ task in different subdirectories.]
77
74
  p[Additionally, it also generates the =>[http://www.h3rald.com/glyph/|Glyph project page] from the book's introduction (note the usage of a raw custom layout macro).]
78
75
  ]
@@ -8,17 +8,10 @@ else
8
8
  interpret "txt[#{raw_value}]"
9
9
  end
10
10
  =]
11
- macro:[=?sep|
12
- if Glyph['document.output'] == "h3rald" then
13
- %{<br style="clear:both" />}
14
- end
15
- =]
16
11
  ]?txt[Glyph is a _Rapid Document Authoring Framework_.
17
12
 
18
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.
19
14
 
20
- ?sep[]
21
-
22
15
  section[
23
16
  @title[Main Features]
24
17
 
@@ -65,7 +65,7 @@ For examples see any of the following:
65
65
  @remarks[&[unsafe]]
66
66
  @params[
67
67
  -p[0|The full name of a configuration setting.]
68
- -p[0|The new value of the configuration setting]
68
+ -p[1|The new value of the configuration setting]
69
69
  ]
70
70
  ]
71
71
 
@@ -23,7 +23,7 @@
23
23
  @example[=fmi[creating links\|#links]=]
24
24
  @params[
25
25
  -p[0|The object that needs additional explanation.]
26
- -p[0|A valid bookmark within the document.]
26
+ -p[1|A valid bookmark within the document.]
27
27
  ]
28
28
  ]
29
29
 
@@ -31,12 +31,12 @@ This is another section.
31
31
  th[Notes]
32
32
  ]
33
33
  tr[
34
- td[code[\\\.\[]]
34
+ td[code[\\\[]]
35
35
  td[code[\[]]
36
36
  td[&[sq_esc]]
37
37
  ]
38
38
  tr[
39
- td[code[\\\.\]]]
39
+ td[code[\\\]]]
40
40
  td[code[\]]]
41
41
  td[&[sq_esc]]
42
42
  ]
@@ -46,19 +46,19 @@ This is another section.
46
46
  td[Backslashes do not have to be escaped by default, but an escaped backslash will evaluate to itself.]
47
47
  ]
48
48
  tr[
49
- td[code[\\\.\=]]
49
+ td[code[\\\=]]
50
50
  td[code[\.=]]
51
51
  td[Equal signs do not have to be escaped by default, but an escaped equal sign will evaluate to iself.]
52
52
  ]
53
53
  tr[
54
- td[code[\\\.\|]]
54
+ td[code[\\\|]]
55
55
  td[code[\|]]
56
56
  td[Pipes must be escaped (even within quoting macros) unless they are used to separate macro parameters.]
57
57
  ]
58
58
  tr[
59
- td[code[\\\..]]
59
+ td[code[\\.]]
60
60
  td[]
61
- td[An escaped dot evaluates to nothing. Useful to separate macro identifiers from other characters: br[]code[=_\\\\..=>[#link\|This link is emphasized using Textile]_ =]
61
+ td[An escaped dot evaluates to nothing. Useful to separate macro identifiers from other characters: br[]code[=_\\.=>[#link\|This link is emphasized using Textile]_ =]
62
62
  ]
63
63
  ]
64
64
  ]