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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Defining Custom Tasks – 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>Defining Custom Tasks</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><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></nav>
<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>
<section class="section">
<header><h1 id="custom_generate_task">Creating a 'custom:generate' task</h1></header>
<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>
<div class="CodeRay">
<div class="code"><pre><span class="no"> 1</span> namespace <span class="sy">:custom</span> <span class="r">do</span>
<span class="no"> 2</span> task <span class="sy">:generate</span>, [<span class="sy">:file</span>] <span class="r">do</span> |t, args|
<span class="no"> 3</span> generate = lambda <span class="r">do</span> |source, destination|
<span class="no"> 4</span> <span class="co">Glyph</span>.info <span class="s"><span class="dl">"</span><span class="k">Generating </span><span class="il"><span class="idl">#{</span>destination<span class="idl">}</span></span><span class="k">...</span><span class="dl">"</span></span>
<span class="no"> 5</span> <span class="co">Glyph</span>.compile <span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">"</span><span class="k">text/</span><span class="il"><span class="idl">#{</span>source<span class="idl">}</span></span><span class="k">.glyph</span><span class="dl">"</span></span>,
<span class="no"> 6</span> <span class="co">Glyph</span>::<span class="co">PROJECT</span>/<span class="s"><span class="dl">"</span><span class="k">../</span><span class="il"><span class="idl">#{</span>destination<span class="idl">}</span></span><span class="k">.textile</span><span class="dl">"</span></span>
<span class="no"> 7</span> <span class="r">end</span>
<span class="no"> 8</span> files = {
<span class="no"> 9</span> <span class="sy">:AUTHORS</span> => <span class="sy">:acknowledgements</span>,
<span class="no"><strong>10</strong></span> <span class="sy">:CHANGELOG</span> => <span class="sy">:changelog</span>,
<span class="no">11</span> <span class="sy">:LICENSE</span> => <span class="sy">:license</span>,
<span class="no">12</span> <span class="sy">:README</span> => <span class="sy">:introduction</span>
<span class="no">13</span> }
<span class="no">14</span> arg = args[<span class="sy">:file</span>].upcase.to_sym
<span class="no">15</span> raise <span class="co">RuntimeError</span>, <span class="s"><span class="dl">"</span><span class="k">Unknown file '</span><span class="il"><span class="idl">#{</span>arg<span class="idl">}</span></span><span class="k">.glyph'</span><span class="dl">"</span></span>
<span class="no">16</span> <span class="r">unless</span> files.keys.include? arg
<span class="no">17</span> generate.call files[arg], arg
<span class="no">18</span> <span class="co">Glyph</span>.info <span class="s"><span class="dl">"</span><span class="k">Done.</span><span class="dl">"</span></span>
<span class="no">19</span> <span class="r">end</span>
<span class="no"><strong>20</strong></span> <span class="r">end</span></pre></div>
</div>
<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 <mark>creating custom commands</mark>, see <a href="/glyph/book/extending/command.html#custom_command">Defining Custom Commands</a></span>.</p>
</section>
<nav><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></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.min.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>
|