content/glyph/book/compiling/compiling.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 200 201 202 203 204 |
<?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 - Compiling a project</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" />
</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>Compiling a project</h2>
<hr />
<div id="content-body">
<div class="navigation"><a href="/glyph/book/text_editing/conditionals.html">Conditional Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/compiling/lite_mode.html">→ Compiling single Glyph files</a></div>
<p>By default, a Glyph project can be “compiled” into an <span class="caps">HTML</span> document. Additionally, Glyph can also be used to produce documents in the following formats:</p>
<ul>
<li>HTML5</li>
<li><span class="caps">PDF</span> (generated from <span class="caps">HTML</span> using a third-party generator like <a href="http://www.princexml.com/">Prince</a> or <a href="http://code.google.com/p/wkhtmltopdf/">wkhtmltopdf</a>)</li>
<li>Web (i.e. multiple <span class="caps">HTML</span> files)</li>
<li>Web5 (i.e. multiple HTML5 files)</li>
</ul>
<div class="section">
<h4 id="h_41">HTML/HTML5 output</h4>
<p>To compile a Glyph project to an HTML document, use the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command within your Glyph project folder. Glyph parses the <code>document.glyph</code> file (and all included files and snippets); if no errors are found, Glyph creates an HTML document in the <code>/output/html</code> folder.</p>
<p>The name of the HTML file can be set in the configuration (<a href="/glyph/book/config/document.html#s_document_filename"><code>document.filename</code></a> setting).</p>
<p>To create an HTML5 file instead, you must specify it explicitly like this:</p>
<p>
<code>glyph compile -f html5</code>
</p>
</div>
<div class="section">
<h4 id="h_42">PDF Output</h4>
<p>To generate a PDF document, you must specify <code>pdf</code> as format, like this:</p>
<p>
<code>glyph compile -f pdf</code>
</p>
<p>The command above will attempt to compile the project into an HTML document and then call a third-party PDF generator to convert it into a PDF file.</p>
<p>Currently, Glyph supports:</p>
<ul>
<li><a href="http://www.princexml.com/">Prince</a> (version 7.0 or higher) — a commercial generator that can be used freely for personal use. Prince produces high-quality <span class="caps">PDF</span> files and implement most of the new features introduced in CSS3, used heavily in Glyph’s <a href="/glyph/book/text_editing/stylesheets.html#default_stylesheets"><code>pagination.css</code></a> default stylesheet.</li>
<li><a href="http://code.google.com/p/wkhtmltopdf/">wkhtmltopdf</a> (version 1.0 beta4 or higher) — an open source generator that uses the WebKit rendering engine to transform <span class="caps">HTML</span> files into <span class="caps">PDF</span>. Although not as advanced as Prince, it produces very satisfactory results.</li>
</ul>
<p>By default, Glyph attempts to use wkhtmltopdf. To change this, set the <a href="/glyph/book/config/output.html#s_output_pdf_generator"><code>output_pdf_generator</code></a> setting to <code>prince</code>.</p>
<div class="note">
<span class="note-title">Note</span>Glyph expects PDF generators to be installed on the local machine and callable via command line using the <code>wkhtmltopdf</code> or the <code>prince</code> commands. Just install them as you would with any other program, depending on your operating system (yes, they both offer Windows installers).
</div>
<div class="tip">
<span class="note-title">Tip</span>Glyph's default CSS file use the free <em>Gentium</em> font for all text. You can download it from <a href="http://www.sil.org/~gaultney/gentium/">here</a>.
</div>
</div>
<div class="section">
<h4 id="web_output">Web/Web5 Output</h4>
<p>To generate a Web or Web5 output, specify <code>web</code> or <code>web5</code> as format. These two output formats behave different way from the others, and require that your project uses <a href="/glyph/book/text_editing/topics.html#topics">topics</a> and <a href="/glyph/book/extending/layouts.html#layouts">layouts</a>.</p>
<p>Basically, here’s what happens when you compile your project in web or web5 format:</p>
<ol>
<li>The document code is parsed as normal</li>
<li>Separate topic files are generated according to the <code>@src</code> attributes of your sections</li>
<li>The <code>document.glyph</code> (or whatever file you’re using as document source) is <em>not</em> rendered. Instead, an <code>index.html</code> file will be created in the output folder based on the contents of your <a href="/glyph/book/extending/layouts.html#index_layout">index layout</a>.</li>
</ol>
</div>
<div class="section">
<h4 id="auto_regeneration">Auto Regeneration</h4>
<p>You can also call the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command with a <code>--auto</code> switch. If you do so, your project will be recompiled automatically every time any source file is changed.</p>
<div class="note">
<span class="note-title">Note</span>Auto regeneration requires the <a href="http://rubygems.org/gems/directory_watcher">directory_watcher</a> gem to be installed.
</div>
</div>
<div class="navigation"><a href="/glyph/book/text_editing/conditionals.html">Conditional Macros ←</a><a href="/glyph/book/index.html">Contents</a><a href="/glyph/book/compiling/lite_mode.html">→ Compiling single Glyph files</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=/compile.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="http://www.google.com/jsapi?key=ABQIAAAA6h3j8Jri5D_da53UPbEbThRlq2n1sm52B5HDRR5tm6o8XM18FhTKn3v155RpPeD0kWnWG81QEhhifQ" type="text/javascript"></script>
<script src="/js/jquery.js" type="text/javascript"></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/init.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() {
display_opinions(7);
display_tweets(7);
display_bookmarks(7);
});
</script>
</body>
</html>
|