content/glyph/book/extending/output_format.html
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Custom Output Formats – Glyph Documentation</title>
<meta charset="utf-8" />
<meta name="author" content="Fabio Cevasco" />
<meta name="copyright" content="Fabio Cevasco" />
<meta name="robots" content="all, follow" />
<meta name="Revisit-After" content="2 Days" />
<meta name="language" content="en" />
<meta name="target_country" content="en-us" />
<meta name="country" content="United States" />
<meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
<meta name="keywords" content="h3rald, fabio cevasco, glyph" />
<link rel="shortcut icon" href="/favicon.png" type="image/png" />
<meta content="44.388041;9.073248" name="ICBM" />
<link rel="stylesheet" type="text/css" href="/styles/html5reset.css" />
<link rel="stylesheet" type="text/css" href="/styles/style.css" />
<!--[if lte IE 8]>
<script src="/js/html5.js" type="text/javascript"></script>
<![endif]-->
</head>
<body>
<!--[if lte IE 6]>
<div id="ie-warning">
This site is not compatible with Internet Explorer 6 or lower. You should consider using a more modern browser for a better – and <em>safer</em> – web experience. [<a href="http://browsehappy.com/browsers/">Read More »</a>]
</div>
<![endif]-->
<section id="container">
<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]>
</a>
</nav>
<nav class="section">
/<a href="/glyph/" rel="archives">GLYPH</a>
</nav>
</header>
<article class="page">
<header>
<hgroup>
<h1>Custom Output Formats</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/extending/task.html">Defining Custom Tasks ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/command.html">→ Defining Custom Commands</a></nav>
<p>As shown in <a href="/glyph/book/extending/commands_tasks.html#cmd_tasks_arch">How Commands and Tasks work</a>, the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command command calls specific tasks defined in the <code>generate:</code> Rake namespace to generate output files in a particular format.</p>
<p>More specifically, when a <code>--format</code> option is specified, the command looks for a task with the same name within the <code>generate:</code> namespace. This makes adding new output formats to Glyph a fairly easy task, without the need to specify custom commands or similar.</p>
<p>The following sections explain how the <code>h3rald</code> output format was created to integrate this book into the <a href="http://www.h3rald.com">H3RALD.com</a> website.</p>
<section class="section">
<header><h1 id="h_94">Output Configuration</h1></header>
<p>The first step required to add a new output format to Glyph is extending Glyph’s configuration by adding the appropriate output hash, as follows:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> <span class="sy">:output</span>:
<span class="no"> 2</span> <span class="sy">:h3rald</span>:
<span class="no"> 3</span> <span class="sy">:multifile</span>: <span class="er">true</span>
<span class="no"> 4</span> <span class="sy">:extension</span>: <span class="er">'.html'</span>
<span class="no"> 5</span> <span class="sy">:filter_target</span>: <span class="er">'html'</span>
<span class="no"> 6</span> <span class="sy">:base</span>: <span class="er">'/glyph/book/'</span>
<span class="no"> 7</span> <span class="sy">:macro_dirs</span>: [<span class="er">'html', 'html5']</span>
<span class="no"> 8</span> <span class="sy">:layout_dirs</span>: [<span class="er">'web5']</span>
<span class="no"> 9</span> <span class="sy">:layouts</span>:
<span class="no"><strong>10</strong></span> <span class="sy">:topic</span>: <span class="er">bookpage</span>
<span class="no">11</span> <span class="sy">:index</span>: <span class="er">bookindex</span></pre></div>
</div>
<p>In particular, the following keys are mandatory:</p>
<ul>
<li>multifile</li>
<li>extension</li>
<li>filter_target</li>
<li>base</li>
<li>macro_dirs</li>
<li>layout_dirs</li>
</ul>
</section>
<section class="section">
<header><h1 id="h_95">Creating a 'generate:h3rald' task</h1></header>
<p>The next (and final) step involves creating a custom <code>h3rald</code> task within the <code>generate:</code> namespace. This task can be placed in any <code>.rake</code> file within the <code>lib/tasks</code> directory:</p>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> namespace <span class="sy">:generate</span> <span class="r">do</span>
<span class="no"> 2</span> desc <span class="s"><span class="dl">"</span><span class="k">Create output for h3rald.com integration</span><span class="dl">"</span></span>
<span class="no"> 3</span> task <span class="sy">:h3rald</span> => [<span class="sy">:web5</span>] <span class="r">do</span>
<span class="no"> 4</span> dir = <span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">'</span><span class="k">output/h3rald</span><span class="dl">'</span></span>
<span class="no"> 5</span> (dir/<span class="s"><span class="dl">"</span><span class="k">glyph/book</span><span class="dl">"</span></span>).mkpath
<span class="no"> 6</span> <span class="c"># Copy files in subdir</span>
<span class="no"> 7</span> (dir).find <span class="r">do</span> |i|
<span class="no"> 8</span> <span class="r">if</span> i.file? <span class="r">then</span>
<span class="no"> 9</span> <span class="r">next</span> <span class="r">if</span> i.to_s.match(<span class="co">Regexp</span>.escape(dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span>))
<span class="no"><strong>10</strong></span> dest = dir/<span class="s"><span class="dl">"</span><span class="k">glyph/book/</span><span class="il"><span class="idl">#{</span>i.relative_path_from(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/dir)<span class="idl">}</span></span><span class="dl">"</span></span>
<span class="no">11</span> src = i.to_s
<span class="no">12</span> <span class="co">Pathname</span>.new(dest).parent.mkpath
<span class="no">13</span> file_copy src, dest
<span class="no">14</span> <span class="r">end</span>
<span class="no">15</span> <span class="r">end</span>
<span class="no">16</span> <span class="c"># Remove files from output dir</span>
<span class="no">17</span> dir.children.each <span class="r">do</span> |c|
<span class="no">18</span> <span class="r">unless</span> c == dir/<span class="s"><span class="dl">'</span><span class="k">glyph</span><span class="dl">'</span></span> <span class="r">then</span>
<span class="no">19</span> c.directory? ? c.rmtree : c.unlink
<span class="no"><strong>20</strong></span> <span class="r">end</span>
<span class="no">21</span> <span class="r">end</span>
<span class="no">22</span> (dir/<span class="s"><span class="dl">'</span><span class="k">glyph/book/images/glyph/glyph.eps</span><span class="dl">'</span></span>).unlink
<span class="no">23</span> (dir/<span class="s"><span class="dl">'</span><span class="k">glyph/book/images/glyph/glyph.svg</span><span class="dl">'</span></span>).unlink
<span class="no">24</span> <span class="c"># Create project page</span>
<span class="no">25</span> project = <span class="co">Glyph</span>.filter <span class="s"><span class="dl">%{</span><span class="k">layout:project[
<span class="no">26</span> @contents[</span><span class="il"><span class="idl">#{</span>file_load(<span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">'</span><span class="k">text/introduction.glyph</span><span class="dl">'</span></span>)<span class="idl">}</span></span><span class="k">]
<span class="no">27</span> ]</span><span class="dl">}</span></span>
<span class="no">28</span> file_write dir/<span class="s"><span class="dl">"</span><span class="k">glyph.textile</span><span class="dl">"</span></span>, project
<span class="no">29</span> <span class="r">end</span>
<span class="no"><strong>30</strong></span> <span class="r">end</span></pre></div>
</div>
<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.</p>
<p>Additionally, it also generates the <a href="http://www.h3rald.com/glyph/">Glyph project page</a> from the book's introduction (note the usage of a raw custom layout macro).</p>
</section>
<nav><a href="/glyph/book/extending/task.html">Defining Custom Tasks ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/command.html">→ Defining Custom Commands</a></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 — © 2010 — <em>Fabio Cevasco</em></p>
</section>
</footer>
</section><!-- #container end -->
<script src="http://www.google.com/jsapi?key=ABQIAAAAr6RY1Z6dchG_sX9WDLSy3xRlq2n1sm52B5HDRR5tm6o8XM18FhR56xHNNH6CsX86uN5VoTrglpyOyQ" type="text/javascript"></script>
<!-- <script src="/js/jquery.js" type="text/javascript"></script> -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script src="/js/jquery-timeago.js" type="text/javascript"></script>
<script src="/js/jquery-easing.js" type="text/javascript"></script>
<script src="/js/jquery-fancybox.js" type="text/javascript"></script>
<script src="/js/jquery-toc.js" type="text/javascript"></script>
<script src="/js/date.js" type="text/javascript"></script>
<script src="/js/feeds.js" type="text/javascript"></script>
<script src="/js/search.js" type="text/javascript"></script>
<script src="/js/hyphenator.js" type="text/javascript"></script>
<script src="/js/init.js" type="text/javascript"></script>
<!-- Start Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18587377-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<!-- End Google Analytics -->
<!-- Start of StatCounter Code -->
<script type="text/javascript">
var sc_project=6193656;
var sc_invisible=1;
var sc_security="57f7ee2a";
</script>
<script type="text/javascript" src="http://www.statcounter.com/counter/counter_xhtml.js"></script>
<!-- End of StatCounter Code -->
</body>
</html>
|