content/glyph/book/extending/commands_tasks.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 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Defining Custom Commands and Tasks - Glyph</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="readability-verification" content="XmaVzRjmcFL5Bb2Fu9TZVdDKzhA3apQdxexTB2rK"/>
<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" />
<script src="http://www.google.com/jsapi?key=ABQIAAAAr6RY1Z6dchG_sX9WDLSy3xRlq2n1sm52B5HDRR5tm6o8XM18FhR56xHNNH6CsX86uN5VoTrglpyOyQ" type="text/javascript"></script>
<script src="/js/sevenup.js" type="text/javascript"></script>
<script src="/js/sevenup_black.js" type="text/javascript"></script>
<script type="text/javascript">google.load("jquery", "1");</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/date.js" type="text/javascript"></script>
<script src="/js/feeds.js" type="text/javascript"></script>
<script src="/js/hyphenator.js" type="text/javascript"></script>
<script src="/js/init.js" type="text/javascript"></script>
<script src="/js/search.js" type="text/javascript"></script>
</head>
<body>
<section id="container">
<header class="page">
<nav class="home-link">
<a href="/">
<span class="logo">
<span class="hrald"><span class="h">H</span> <span class="rald">RALD</span></span>
<span class="three">3</span>
</span>
</a>
</nav>
<nav class="section">
/<a href="/glyph/" rel="glyph">GLYPH</a>
</nav>
</header>
<article class="page glyph-book">
<header>
<hgroup>
<h1>Defining Custom Commands and Tasks</h1>
<h2>Glyph</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav class="navigation"><a href="/glyph/book/extending/further_reading.html">← Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks →</a></nav>
<p>In most cases, you can extend Glyph just by creating your own <a href="/glyph/book/extending/macro_def.html#macro_def">custom macros</a>. In some cases though, you may want to further customize Glyph to fit the needs of your project, in terms of creating <a href="/glyph/book/extending/command.html#custom_command">custom commands</a> and <a href="/glyph/book/extending/task.html#custom_task">custom tasks</a>.</p>
<p>Glyph’s modular architecture (and the Ruby language itself) lets you to add <em>arbitrary</em> functionality to its core, simply by creating a few Ruby files and putting them in the right places.</p>
<section class="section">
<header><h1 id="cmd_tasks_arch" class="toc">How Commands and Tasks work</h1></header>
<p>Before creating custom Glyph commands and tasks, you should have a basic understanding on how they work, and which commands — or better, which tasks — are already available.</p>
<p>The following diagram outlines the relationships between the default commands and some tasks:</p>
<figure><img src="/glyph/book/images/glyph/commands_tasks.png" /><figcaption>Some of Glyph default commands and tasks</figcaption></figure>
<p>As you can see:</p>
<ul>
<li>All commands call at at least one task.</li>
<li>There are several task inter-dependencies spanning across three main Rake namespaces:
<ul>
<li><code>project:</code> — used for tasks affecting only the physical structure of the Glyph project.</li>
<li><code>load:</code> — used to load all kinds of files.</li>
<li><code>generate:</code> — used to generate files or copy files from source to output directories</li>
</ul></li>
</ul>
<aside class="box">
<div class="box-title">Example</div>
<p>Suppose you want to generate a <span class="caps">PDF</span> file by issuing the <code>glyph compile -f pdf</code> command. Under the hood, Glyph calls the following tasks:</p>
<ol>
<li><code>load:config</code> — Load the configuration files</li>
<li><code>load:tasks</code> — Load custom tasks (if any)</li>
<li><code>load:commands</code> — Load custom commands (if any)</li>
<li><code>load:snippets</code> — Load snippets from the <code>snippet.yml</code> file</li>
<li><code>load:macros</code> — Load macros</li>
<li><code>load:all</code> — Dummy task used to call the previous ones</li>
<li><code>generate:document</code> — Parse, analyze and finalize the Glyph document</li>
<li><code>generate:images</code> — Copy images to the output directory (if any)</li>
<li><code>generate:styles</code> — Copy stylesheets to the output directory (if necessary)</li>
<li><code>generate:html</code> — Generate a standalone <span class="caps">HTML</span> file</li>
<li><code>generate:pdf</code> — Generate a <span class="caps">PDF</span> file from a standalone <span class="caps">HTML</span> file</li>
</ol>
</aside>
</section>
<nav class="navigation"><a href="/glyph/book/extending/further_reading.html">← Further Reading</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/extending/task.html">Defining Custom Tasks →</a></nav>
<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>
</nav>
</section>
</article>
<footer>
<section>
<nav>
<a href="/about/">ABOUT</a>|<a href="/contact/">CONTACT</a>
</nav>
<p>H3RALD Web Site v8.1.2 © 2004 — 2012 <em>Fabio Cevasco</em></p>
</section>
</footer>
</section><!-- #container end -->
<!-- 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>
|