content/glyph/book/compiling/programmatic_usage.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 196 197 198 199 |
<!DOCTYPE html>
<html lang="en">
<head>
<title>Using Glyph programmatically – 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>Using Glyph programmatically</h1>
<h2>Glyph Documentation</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate glyph-book">
<nav><a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/stats.html">→ Using the stats command</a></nav>
<p>Besides using Glyph from the command line, you can also use it straight from your code. Glyph’s public <a href="http://yardoc.org/docs/glyph/Glyph"><span class="caps">API</span></a> is simple and can be used to:</p>
<ul>
<li>Retrieve and update configuration settings (using <code>Glyph[]</code> and <code>Glyph[]=</code>)</li>
<li>Filter text to <span class="caps">HTML</span> (using <code>Glyph#filter</code>)</li>
<li>Compile Glyph source files into <span class="caps">HTML</span> or <span class="caps">PDF</span> files (using <code>Glyph#compile</code>)</li>
</ul>
<p>That’s pretty much it. Of course, both the <code>filter</code> and <code>compile</code> method cause Glyph to run in <a href="/glyph/book/compiling/lite_mode.html#lite_mode"><em>lite</em> mode</a>, so the same <a href="/glyph/book/compiling/lite_mode.html#lite_limitations">limitations</a> apply.</p>
<aside class="tip">
<span class="note-title">Tip</span><p>For an example on how to use Glyph programmatically (specifically in conjunction with the <a href="http://nanoc.stoneship.org/">nanoc</a> static site generator), see <a href="http://github.com/h3rald/h3rald">h3rald.com source code</a>, in particular:</p>
<ul>
<li><a href="http://github.com/h3rald/h3rald/blob/master/lib/glyph_filter.rb">lib/glyph_filter.rb</a> — using the <code>Glyph#filter</code> method.</li>
<li><a href="http://github.com/h3rald/h3rald/blob/master/lib/glyph_context.rb">lib/glyph_context.rb</a> — using the <code>Glyph#compile</code> method to generate <span class="caps">PDF</span> files.</li>
</ul>
</aside>
<section class="section">
<header><h1 id="modes">Modes</h1></header>
<p>It is possible to specify some flags (or "modes") to make Glyph behave slightly different than normal, as shown in the following table (by default, none of these is used).</p>
<table><tr><th>Name</th>
<th>Writer Method</th>
<th>Reader Method</th>
<th>Description</th></tr>
<tr><td>Test Mode</td>
<td>
<code>Glyph.test_mode=</code>
</td>
<td>
<code>Glyph.test?</code>
</td>
<td>Used internally by the <code>rake spec</code> task to run Glyph's specs.</td></tr>
<tr><td>Library Mode</td>
<td>
<code>Glyph.library_mode=</code>
</td>
<td>
<code>Glyph.library?</code>
</td>
<td>If enabled, the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command command will raise exceptions instead of printing errors on the screen. Enabled by the <code>Glyph.compile</code> command.</td></tr>
<tr><td>Debug Mode</td>
<td>
<code>Glyph.debug_mode=</code>
</td>
<td>
<code>Glyph.debug?</code>
</td>
<td>If enabled, additional diagnostic information (such as backtraces or macro values) will be displayed. Enabled by specifying the <a href="/glyph/book/ref_commands.html#debug_switch">debug switch</a> when running a Glyph command.</td></tr>
<tr><td>Lite Mode</td>
<td>
<code>Glyph.lite_mode=</code>
</td>
<td>
<code>Glyph.lite?</code>
</td>
<td><p>Used to compile <a href="/glyph/book/compiling/lite_mode.html#lite_mode">single files</a>. Enabled by:</p>
<ul>
<li>The <code>Glyph.compile</code> and <code>Glyph.filter</code> methods.</li>
<li>The <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command, if at least one parameter is supplied.</li>
</ul></td></tr>
<tr><td>Safe Mode</td>
<td>
<code>Glyph.safe_mode=</code>
</td>
<td>
<code>Glyph.safe?</code>
</td>
<td><p>If enabled, the following macros cannot be used and will return an error:</p>
<ul>
<li><a href="/glyph/book/macros/macros_core.html#m_ruby"><code>ruby</code></a> macro</li>
<li><a href="/glyph/book/macros/macros_core.html#m_macro_"><code>macro:</code></a> macro</li>
<li><a href="/glyph/book/macros/macros_core.html#m_include"><code>include</code></a> macro</li>
<li><a href="/glyph/book/macros/macros_core.html#m_rewrite_"><code>rewrite:</code></a> macro</li>
<li><a href="/glyph/book/macros/macros_core.html#m_config_"><code>config:</code></a> macro</li>
</ul></td></tr></table>
</section>
<nav><a href="/glyph/book/compiling/lite_mode.html">Compiling single Glyph files ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/stats/stats.html">→ Using the stats command</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>
|