content/glyph/book/config/document.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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
<!DOCTYPE html>
<html lang="en">
<head>
<title><code>document.*</code> - H3RALD</title>
<link href='https://fonts.googleapis.com/css?family=Crimson+Text:400,400italic,600,600italic,700,700italic' rel='stylesheet' type='text/css'>
<meta charset="utf-8" />
<meta name="author" content="Fabio Cevasco" />
<meta name="robots" content="all, follow" />
<meta name="Revisit-After" content="2 Days" />
<meta name="description" content="H3RALD - Fabio Cevasco's Web Site" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="keywords" content="h3rald, fabio cevasco, glyph, ruby" />
<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/bootstrap.css" />
<link rel="stylesheet" type="text/css" href="/styles/github.css" />
<link rel="stylesheet" type="text/css" href="/styles/style.css" />
<!--[if lt IE 9]>
<script src="https://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script src="https://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 src="https://code.jquery.com/jquery-latest.js" type="text/javascript"></script>
<script src="/js/jquery-timeago.js" type="text/javascript"></script>
<script src="/js/date.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>
<script src="/js/highlight.js" type="text/javascript"></script>
<script src="/js/bootstrap.js" type="text/javascript"></script>
</head>
<body>
<div class="container">
<div class="row" id="header-row">
<div class="col-md-6 main-title">
<h1>
<a href="/"><img src="/img/h3rald.png" alt="H3RALD" /></a>
</h1>
</div>
<div class="col-md-4 col-md-offset-2">
<div class="gcse-searchbox" data-enableAutoComplete="true"></div>
</div>
</div>
<div id="search_results">
<div class="gcse-searchresults" data-linkTarget="_top"></div>
</div>
<div id="main-navbar" class="navbar navbar-inverse" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="/"><i class="fa fa-home"></i> HOME</a></li>
<li><a href="/projects/"><i class="fa fa-briefcase"></i> PROJECTS</a></li>
<li><a href="/tags/"><i class="fa fa-tags"></i> TAGS</a></li>
<li><a href="/archives/"><i class="fa fa-archive"></i> ARCHIVES</a></li>
<li><a href="/about/"><i class="fa fa-question-circle"></i> ABOUT</a></li>
<li><a href="/contact/"><i class="fa fa-envelope"></i> CONTACT</a></li>
</ul>
</div>
</div>
</div>
<div class="container">
<article class="page">
<header class="row">
<hgroup class="col-md-9">
<h1><code>document.*</code></h1>
<h2>Glyph</h2>
</hgroup>
</header>
<section id="body-text" class="hyphenate">
<nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">← Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html"><code>filters.*</code> →</a></nav>
The following configuration settings are related to the current Glyph document. Therefore, you should update them right after creating a project.
<table>
<tr>
<th>Name</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>
<code>document.author</code> <a id="s_document_author"></a>
</td>
<td>
<p>The author of the document.</p>
</td>
<td>
<code>
""
</code>
</td>
</tr>
<tr>
<td>
<code>document.cover</code> <a id="s_document_cover"></a>
</td>
<td>
<p>The image used as the document cover (used only for e-book generation).</p>
</td>
<td>
<code>
false
</code>
</td>
</tr>
<tr>
<td>
<code>document.draft</code> <a id="s_document_draft"></a>
</td>
<td>
<p>If set to <code>true</code>, the document is considered a draft, so <a href="/glyph/book/macros/macros_inline.html#m_draftcomment">draft comments</a> and <a href="/glyph/book/macros/macros_inline.html#m_todo">todo items</a> will be displayed.</p>
</td>
<td>
<code>
false
</code>
</td>
</tr>
<tr>
<td>
<code>document.filename</code> <a id="s_document_filename"></a>
</td>
<td>
<p>The name of the output file.</p>
</td>
<td>
<code>
""
</code>
</td>
</tr>
<tr>
<td>
<code>document.output</code> <a id="s_document_output"></a>
</td>
<td>
<p>The format of the output file. It can be set to:</p>
<ul>
<li><code>epub</code></li>
<li><code>html5</code></li>
<li><code>html</code></li>
<li><code>mobi</code></li>
<li><code>pdf</code></li>
<li><code>web5</code></li>
<li><code>web</code></li>
</ul>
</td>
<td>
<code>
"html"
</code>
</td>
</tr>
<tr>
<td>
<code>document.revision</code> <a id="s_document_revision"></a>
</td>
<td>
<p>The document’s revision.</p>
</td>
<td>
<code>
""
</code>
</td>
</tr>
<tr>
<td>
<code>document.source</code> <a id="s_document_source"></a>
</td>
<td>
<p>The main source file to compile. It can be also be overridden by calling the <a href="/glyph/book/ref_commands.html#c_compile"><code>compile</code></a> command with the <code>-s</code> option.</p>
</td>
<td>
<code>
"document.glyph"
</code>
</td>
</tr>
<tr>
<td>
<code>document.styles</code> <a id="s_document_styles"></a>
</td>
<td>
<p>How to process stylesheets. It can be set to one of the following values:</p>
<ul>
<li><code>embed</code> — Embed stylesheets within the document.</li>
<li><code>link</code> — Link stylesheets.</li>
<li><code>import</code> — Import stylesheets using the <code>@import</code> <span class="caps">CSS</span> directive.</li>
</ul>
</td>
<td>
<code>
"embed"
</code>
</td>
</tr>
<tr>
<td>
<code>document.subtitle</code> <a id="s_document_subtitle"></a>
</td>
<td>
<p>The subtitle of the document, displayed using the <a href="/glyph/book/macros/macros_block.html#m_subtitle"><code>subtitle</code></a> macro.</p>
</td>
<td>
<code>
""
</code>
</td>
</tr>
<tr>
<td>
<code>document.title</code> <a id="s_document_title"></a>
</td>
<td>
<p>The title of the document, displayed using the <a href="/glyph/book/macros/macros_block.html#m_title"><code>title</code></a> macro.</p>
</td>
<td>
<code>
""
</code>
</td>
</tr>
<tr>
<td>
<code>document.isbn</code> <a id="s_document_isbn"></a>
</td>
<td>
<p>The <span class="caps">ISBN</span> of the document, for e-book generation.</p>
</td>
<td>
<code>
false
</code>
</td>
</tr>
</table>
<nav class="navigation"><a href="/glyph/book/macros/macros_structure.html">← Structure Macros</a> | <a href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/config/filters.html"><code>filters.*</code> →</a></nav>
</section>
</article>
</div>
<footer>
<section>
<p>H3RALD Web Site v8.4 © 2004 — 2014 <em>Fabio Cevasco</em></p>
</section>
</footer>
<script type="text/javascript">
var disqus_shortname = 'h3rald';
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
<script>
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</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 -->
</body>
</html>
|