all repos — h3rald @ b3442cd80d633f1412303de98a8301e8b8fd86c0

The sources of https://h3rald.com

contents/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
 
-----
title: "Glyph - <code>document.*</code>"
content-type: page
-----
<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&#8217;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> &#8212; Embed stylesheets within the document.</li>
				<li><code>link</code> &#8212; Link stylesheets.</li>
				<li><code>import</code> &#8212; 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>