all repos — h3rald @ b3442cd80d633f1412303de98a8301e8b8fd86c0

The sources of https://h3rald.com

contents/glyph/book/config/output.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
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
-----
title: "Glyph - <code>output.*</code>"
content-type: page
-----
<nav class="navigation"><a href="/glyph/book/config/options.html">← <code>options.*</code></a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog →</a></nav>










These settings are used to configure output-specific options.


<section class="section">
	<header>
		<h1 id="h_290" class="toc">output.epub.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.epub.extension</code> <a id="s_output_epub_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".epub"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.epub.filter_target</code> <a id="s_output_epub_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.epub.generator</code> <a id="s_output_epub_generator"></a>
			</td>
			<td>
				<p>The external program used to generate <span class="caps">EPUB</span> files. It must be set to
					<code>calibre</code>.</p>
			</td>
			<td>
				<code>
"calibre"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.epub.calibre</code> <a id="s_output_epub_calibre"></a>
			</td>
			<td>
				<p>An array of options to configure Calibre. See the <a
						href="http://calibre-ebook.com/user_manual/cli/ebook-convert-3.html">full list</a>.</p>
			</td>
			<td>
				<code>
{"output-profile"=>"nook"}
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.epub.macro_reps</code> <a id="s_output_epub_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.epub.multifile</code> <a id="s_output_epub_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
false
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_291" class="toc">output.mobi.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.mobi.extension</code> <a id="s_output_mobi_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".mobi"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.mobi.filter_target</code> <a id="s_output_mobi_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.mobi.generator</code> <a id="s_output_mobi_generator"></a>
			</td>
			<td>
				<p>The external program used to generate <span class="caps">MOBI</span> files. It must be set to
					<code>calibre</code>.</p>
			</td>
			<td>
				<code>
"calibre"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.mobi.calibre</code> <a id="s_output_mobi_calibre"></a>
			</td>
			<td>
				<p>An array of options to configure Calibre. See the <a
						href="http://calibre-ebook.com/user_manual/cli/ebook-convert-3.html">full list</a>.</p>
			</td>
			<td>
				<code>
{"no-inline-toc"=>nil, "output-profile"=>"kindle"}
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.mobi.macro_reps</code> <a id="s_output_mobi_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.mobi.multifile</code> <a id="s_output_mobi_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
false
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_292" class="toc">output.pdf.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.pdf.extension</code> <a id="s_output_pdf_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".pdf"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.pdf.filter_target</code> <a id="s_output_pdf_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.pdf.through</code> <a id="s_output_pdf_through"></a>
			</td>
			<td>
				<p>The intermediate format from which a <span class="caps">PDF</span> file is generated. It can be set
					to <code>html</code> or <code>html5</code>.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.pdf.generator</code> <a id="s_output_pdf_generator"></a>
			</td>
			<td>
				<p>The external program used to generate <span class="caps">PDF</span> files. It can be set to
					<code>prince</code> or <code>wkhtmltopdf</code>.</p>
			</td>
			<td>
				<code>
"prince"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.pdf.macro_reps</code> <a id="s_output_pdf_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.pdf.multifile</code> <a id="s_output_pdf_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
false
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_293" class="toc">output.html.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.html.extension</code> <a id="s_output_html_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html.filter_target</code> <a id="s_output_html_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html.macro_reps</code> <a id="s_output_html_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html.multifile</code> <a id="s_output_html_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
false
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_294" class="toc">output.html5.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.html5.extension</code> <a id="s_output_html5_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html5.filter_target</code> <a id="s_output_html5_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html5.macro_reps</code> <a id="s_output_html5_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html5"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.html5.multifile</code> <a id="s_output_html5_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
false
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_295" class="toc">output.web.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.web.base</code> <a id="s_output_web_base"></a>
			</td>
			<td>
				<p>The directory to use as root for all link paths.</p>
			</td>
			<td>
				<code>
"/"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.extension</code> <a id="s_output_web_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.filter_target</code> <a id="s_output_web_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.layout_dirs</code> <a id="s_output_web_layout_dirs"></a>
			</td>
			<td>
				<p>The directories from which layout macros will be loaded (both in Glyph&#8217;s home and the current
					project directory).</p>
			</td>
			<td>
				<code>
nil
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.layouts.index</code> <a id="s_output_web_layouts_index"></a>
			</td>
			<td>
				<p>The name of the layout to use to render the document index file.</p>
			</td>
			<td>
				<code>
"index"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.layouts.topic</code> <a id="s_output_web_layouts_topic"></a>
			</td>
			<td>
				<p>The name of the layout to use to render topic files.</p>
			</td>
			<td>
				<code>
"topic"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.macro_reps</code> <a id="s_output_web_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web.multifile</code> <a id="s_output_web_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
true
			</code>
			</td>
		</tr>
	</table>

</section>
<section class="section">
	<header>
		<h1 id="h_296" class="toc">output.web5.*</h1>
	</header>
	<table>
		<tr>
			<th>Name</th>
			<th>Description</th>
			<th>Default</th>
		</tr>
		<tr>
			<td>
				<code>output.web5.base</code> <a id="s_output_web5_base"></a>
			</td>
			<td>
				<p>The directory to use as root for all link paths.</p>
			</td>
			<td>
				<code>
"/"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.extension</code> <a id="s_output_web5_extension"></a>
			</td>
			<td>
				<p>The extension to use for the output file(s).</p>
			</td>
			<td>
				<code>
".html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.filter_target</code> <a id="s_output_web5_filter_target"></a>
			</td>
			<td>
				<p>The output target for filters. It can be set to <code>html</code> (for RedCloth and MarkDown) or
					<code>latex</code> (RedCloth-only).</p>
			</td>
			<td>
				<code>
"html"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.layout_dirs</code> <a id="s_output_web5_layout_dirs"></a>
			</td>
			<td>
				<p>The directories from which layout macros will be loaded (both in Glyph&#8217;s home and the current
					project directory).</p>
			</td>
			<td>
				<code>
nil
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.layouts.index</code> <a id="s_output_web5_layouts_index"></a>
			</td>
			<td>
				<p>The name of the layout to use to render the document index file.</p>
			</td>
			<td>
				<code>
"index"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.layouts.topic</code> <a id="s_output_web5_layouts_topic"></a>
			</td>
			<td>
				<p>The name of the layout to use to render topic files.</p>
			</td>
			<td>
				<code>
"topic"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.macro_reps</code> <a id="s_output_web5_macro_reps"></a>
			</td>
			<td>
				<p>The name of the representation file from which macro representation will be loaded.</p>
			</td>
			<td>
				<code>
"html5"
			</code>
			</td>
		</tr>
		<tr>
			<td>
				<code>output.web5.multifile</code> <a id="s_output_web5_multifile"></a>
			</td>
			<td>
				<p>If set to <em>true_, the document will be rendered in multiple files, according to the specified
					</em>editing/topics.html#topics&quot;&gt;topics</a>.</p>
			</td>
			<td>
				<code>
true
			</code>
			</td>
		</tr>
	</table>

</section>
<nav class="navigation"><a href="/glyph/book/config/options.html">← <code>options.*</code></a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/changelog.html">Changelog →</a></nav>