content/glyph/book/extending/task.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 |
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Glyph</title>
<meta name="author" content="Fabio Cevasco" />
<meta name="copyright" content="Fabio Cevasco" />
<meta name="generator" content="Glyph v0.4.0 (http://www.h3rald.com/glyph)" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>Defining Custom Tasks - Glyph</title>
<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, technical writing, html, html5, book" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta content="44.388041;9.073248" name="ICBM" />
<link href="/css/main.css" media="all" rel="stylesheet" type="text/css" />
<link href="/glyph/book/styles/default.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="wrapper">
<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>
<div id="header">
<!--[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]-->
<!-- HEADER START -->
<div id="header-container">
<div id="header-left">
<h1><span class="logo"></span><a id="logo" href="/" title="H3RALD"></a></h1>
</div>
<div id="header-right">
<ul id="navigation">
<li><span class="preload nav-archives"></span><a id="nav-archives" href="/archives/" title="ARCHIVES"></a></li>
<li><span class="preload nav-projects"></span><a id="nav-projects" href="/projects/" title="PROJECTS"></a></li>
<li><span class="preload nav-about"></span><a id="nav-about" href="/about/" title="ABOUT"></a></li>
<li><span class="preload nav-other"></span><a id="nav-other" href="/other/" title="OTHER"></a></li>
</ul>
</div>
</div>
</div>
<!-- HEADER END -->
<div class="ribbon">
</div>
<!-- MAIN START -->
<div id="main">
<!-- CONTAINER START -->
<div id="container">
<!-- CONTENT START -->
<div id="content" class="clearfixstandard">
<div id="page-links">
<span><script type="text/javascript" src="http://w.sharethis.com/button/sharethis.js#publisher=6e34d60c-b14e-4c19-9b2f-7c35a9f0ab09&type=website&linkfg=%23a4282d"></script></span>
</div>
<h2>Defining Custom Tasks</h2>
<hr />
<div id="content-body">
<div class="navigation"><a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/output_format.html">→ Custom Output Formats</a></div>
<p>Glyph relies on <a href="http://rake.rubyforge.org/">Rake</a> to perform most of its core operations. Typically, Rake tasks are used do define the high level logic that is used by Glyph commands to, for example, compile a project or load configuration files.</p>
<p>Furthermore, Rake provides an easy mechanism to create dependencies among tasks: for example, to make sure that Glyph’s configuration files are loaded before everything else happens.</p>
<div class="section">
<h5 id="custom_generate_task">Creating a 'custom:generate' task</h5>
<p>A custom task has been defined for the Glyph project used to produce this document. This custom task is used to compile a few of the documents files into standalone files, deployed in Glyph’s root folder:</p>
<ul>
<li><code>book/text/introduction.glyph</code> → <code>README.textile</code></li>
<li><code>book/text/changelog.glyph</code> → <code>CHANGELOG.textile</code></li>
<li><code>book/text/license.glyph</code> → <code>LICENSE.textile</code></li>
<li><code>book/text/acknowledgement.glyph</code> → <code>AUTHORS.textile</code></li>
</ul>
<p>First of all, create a <code>lib/tasks</code> folder in your project directory. Then, create a <code>.rake</code> file within it, e.g. <code>tasks.rake</code>.</p>
<p>Finally, here’s the source of the task:</p>
<pre class="lazy"><span class="line-numbers"> 1 </span> namespace <span class="Constant"><span class="Constant">:</span>custom</span> <span class="Keyword">do</span>
<span class="line-numbers"> 2 </span> task <span class="Constant"><span class="Constant">:</span>generate</span>, [<span class="Constant"><span class="Constant">:</span>file</span>] <span class="Keyword">do </span>|<span class="Variable">t</span>, <span class="Variable">args</span>|
<span class="line-numbers"> 3 </span> generate <span class="Keyword">=</span> lambda <span class="Keyword">do </span>|<span class="Variable">source</span>, <span class="Variable">destination</span>|
<span class="line-numbers"> 4 </span> <span class="Support">Glyph</span>.<span class="Entity">info</span> <span class="String"><span class="String">"</span>Generating <span class="String"><span class="String">#{</span>destination<span class="String">}</span></span>...<span class="String">"</span></span>
<span class="line-numbers"> 5 </span> <span class="Support">Glyph</span>.<span class="Entity">compile</span> <span class="Support">Glyph</span>::<span class="Entity">PROJECT</span><span class="Keyword">/</span><span class="String"><span class="String">"</span>text/<span class="String"><span class="String">#{</span>source<span class="String">}</span></span>.glyph<span class="String">"</span></span>,
<span class="line-numbers"> 6 </span> <span class="Support">Glyph</span>::<span class="Entity">PROJECT</span><span class="Keyword">/</span><span class="String"><span class="String">"</span>../<span class="String"><span class="String">#{</span>destination<span class="String">}</span></span>.textile<span class="String">"</span></span>
<span class="line-numbers"> 7 </span> <span class="Keyword">end</span>
<span class="line-numbers"> 8 </span> files <span class="Keyword">=</span> {
<span class="line-numbers"> 9 </span> <span class="Constant"><span class="Constant">:</span>AUTHORS</span> => <span class="Constant"><span class="Constant">:</span>acknowledgements</span>,
<span class="line-numbers"> 10 </span> <span class="Constant"><span class="Constant">:</span>CHANGELOG</span> => <span class="Constant"><span class="Constant">:</span>changelog</span>,
<span class="line-numbers"> 11 </span> <span class="Constant"><span class="Constant">:</span>LICENSE</span> => <span class="Constant"><span class="Constant">:</span>license</span>,
<span class="line-numbers"> 12 </span> <span class="Constant"><span class="Constant">:</span>README</span> => <span class="Constant"><span class="Constant">:</span>introduction</span>
<span class="line-numbers"> 13 </span> }
<span class="line-numbers"> 14 </span> arg <span class="Keyword">=</span> args[<span class="Constant"><span class="Constant">:</span>file</span>].<span class="Entity">upcase</span>.<span class="Entity">to_sym</span>
<span class="line-numbers"> 15 </span> <span class="Keyword">raise</span> <span class="Variable">RuntimeError</span>, <span class="String"><span class="String">"</span>Unknown file '<span class="String"><span class="String">#{</span>arg<span class="String">}</span></span>.glyph'<span class="String">"</span></span>
<span class="line-numbers"> 16 </span> <span class="Keyword">unless</span> files.<span class="Entity">keys</span>.<span class="Entity">include?</span> arg
<span class="line-numbers"> 17 </span> generate.<span class="Entity">call</span> files[arg], arg
<span class="line-numbers"> 18 </span> <span class="Support">Glyph</span>.<span class="Entity">info</span> <span class="String"><span class="String">"</span>Done.<span class="String">"</span></span>
<span class="line-numbers"> 19 </span> <span class="Keyword">end</span>
<span class="line-numbers"> 20 </span> <span class="Keyword">end</span>
</pre>
<p>That’s it. Note that this task is pretty useless without a command that calls it, and it won’t even show up if you run <code>rake -T</code> within your project directory. <span class="fmi">for more information on creating custom commands, see <a href="/glyph/book/extending/command.html#custom_command">Defining Custom Commands</a></span>.</p>
</div>
<div class="navigation"><a href="/glyph/book/extending/commands_tasks.html">Defining Custom Commands and Tasks ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/extending/output_format.html">→ Custom Output Formats</a></div>
</div>
<div id="content-footer">
<div class="share">
<script type="text/javascript"><!--
google_ad_client = "pub-2871497824158668";
/* 728x90, h3rald 8.0 */
google_ad_slot = "0081634732";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
</div>
</div>
<!-- CONTENT END -->
</div>
<!-- CONTAINER END -->
</div>
<div class="ribbon"></div>
<!-- MAIN END -->
<div id="border-bottom">
<div id="services">
<div class ="footer-left">
<div id="backtype">
<h3><span class="s-opinions preload"></span><a id="s-opinions" href="http://www.backtype.com/h3rald" title="Opinions"></a></h3>
</div>
</div>
<div class ="footer-center">
<div id="twitter">
<h3><span class="s-tweets preload"></span><a id="s-tweets" href="http://www.twitter.com/h3rald" title="Tweets"></a></h3>
</div>
</div>
<div class ="footer-right">
<div id="delicious">
<h3><span class="s-bookmarks preload"></span><a id="s-bookmarks" href="http://www.delicious.com/h3rald" title="Bookmarks"></a></h3>
</div>
</div>
</div> <!-- SERVICES END -->
</div>
<div class="clearfooter"></div>
</div> <!-- WRAPPER END -->
<div id="footer">
<div id="footer-container">
<div class="footer-div">
H3RALD Web Site v8.0.0 <em>"xStatic"</em> — © 2004-2010 <strong>Fabio Cevasco</strong> — <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=/custom_task.html" class="link">CSS 2.1</a>
</div>
</div> <!-- END FOOTER CONTAINER-->
</div> <!-- END FOOTER -->
<!-- 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 -->
<script src='http://www.google-analytics.com/ga.js' type='text/javascript'></script>
<script src="http://www.google.com/jsapi?key=ABQIAAAA6h3j8Jri5D_da53UPbEbThRlq2n1sm52B5HDRR5tm6o8XM18FhTKn3v155RpPeD0kWnWG81QEhhifQ" type="text/javascript"></script>
<script src="/js/compressed.js" type="text/javascript"></script>
</body>
</html>
|