ref-document.adoc 21.5 KB
Newer Older
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
= Document Attributes Reference
:y: Yes
:n: No
:en: –

////
Need to update the compatibility guide with:

* numbered = sectnums
* docinfo1 = docinfo
* docinfo2 = docinfo
* toc-class = use custom theme https://github.com/asciidoctor/asciidoctor.org/issues/379[issue #379]
* toc-placement = toc
* notitle = showtitle!
* encoding = ignored always UTF-8
////

Built-in document attributes can be set and unset using an attribute entry.

Automatically Set:: The attribute is set automatically by Asciidoctor and assigned its default value at processing time if you don't set it explicitly in the API, command line, or document.
Automatically set attributes can be unset with the `!`.

Values::
+
* _empty_ value: The _empty_ value indicates the attribute doesn't have an explicit value.
The attribute is simply turned on by being set.
* *default* value: Attributes that have built-in values may have a default value which is indicated by the *bolded value*.
If you set the attribute but leave the value empty, Asciidoctor will fall back to this default value at processing time.
* If the attribute doesn't accept an _empty_ value or have a *default* value, than you must explicitly assign the attribute an accepted built-in or user-defined value.

Header Set:: The attribute can be set and assigned a value (or unset) in the document's header.
In almost all cases, these attributes can also be set, defined, or unset in the API or command line.
If you set an attribute from the command line or API, it's defined for the whole document and can't be changed in the document header or body unless `@` is added to the end of the value.
See xref:assignment-precedence.adoc[] for more information.
The one exception to this rule is the `sectnums` attribute, which can always be changed.

Body Set:: The attribute can be set, assigned a value, or unset in the document's body (anywhere below the document header).
When you set an attribute in the body, it's visible from the point it's set until it's unset (unless it's overridden by the xref:assignment-precedence.adoc[assignment precedence]).

== Compliance attributes

[%autowidth,cols="m,^,,^,^,"]
|===
|Name |Automatically Set |Values |Header Set |Body Set  |Notes

|attribute-missing
|{n}
|`*skip*` +
`drop` +
`drop-line` +
`warn`
|{y}
|{y}
|Controls how xref:unresolved-references.adoc#missing[missing attribute references] are handled.

|attribute-undefined
|{n}
|`*drop-line*` +
`drop`
|{y}
|{y}
|Controls how xref:unresolved-references.adoc#undefined[undefined attributes] are handled.

|compat-mode
|{n}
e|empty
|{y}
|{y}
|Controls when the legacy parser is used to parse the document.

|experimental
|{n}
e|empty
|{y}
|{n}
|Enables xref:macros:ui-macros.adoc[] and xref:macros:keyboard-macro.adoc[].

|reproducible
|{n}
e|empty
|{y}
|{n}
|Prevents last-updated date from being added to HTML footer or DocBook info element.
Useful for storing the output in a source code control system as it prevents spurious changes every time you convert the document.
//Alternatively, you can use the SOURCE_DATE_EPOCH environment variable to fix the value.
|===

[#builtin-attributes-i18n]
== Internationalization and numbering

[%autowidth,cols="m,^,,^,^,"]
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|appendix-caption
|Only when section assigned `Appendix` style
|`*Appendix*` +
_user-defined_
|{y}
|{y}
|Label added before an xref:sections:appendix.adoc[appendix title].

|appendix-number
|Only when section assigned `Appendix` style
|`*A*` +
_letter or number_
|{y}
|{y}
|Stores appendix letter or number sequence start.

|appendix-refsig
|
|`*Appendix*` +
_any_
|{y}
|{y}
|Signifier added to Appendix title cross references.

|caution-caption
|{y}
|`*Caution*` +
_any_
|{y}
|{y}
|Text used to label CAUTION admonitions when icons aren't enabled.

|chapter-number
|Only when `doctype` is `book`
|`*1*` +
_number_
|
|
|Stores chapter number sequence start.

|chapter-refsig
|
|`*Chapter*` +
_any_
|{y}
|{y}
|Signifier added to Chapter titles in cross references.

|chapter-label
|Only when `doctype` is `book`
|`*Chapter*` +
_any_
|{y}
|{y}
|xref:sections:chapters.adoc[Label added to level-1 section titles (chapters)].
_PDF converter only_.
_Book doctype only_.

|example-caption
|{y}
|`*Example*` +
_any_
|{y}
|{y}
|Text used to label example blocks.

|example-number
|{y}
|`*1*` +
_number_
|
|
|Stores example number sequence start.

|figure-caption
|{y}
|`*Figure*` +
_any_
|{y}
|{y}
|Text used to label images and figures.

|figure-number
|{y}
|`*1*` +
_number_
|
|
|Stores figure number sequence start.

|important-caption
|{y}
|`*Important*` +
_any_
|{y}
|{y}
|Text used to label IMPORTANT admonitions when icons are not enabled.

|lang
|
|`*en*` +
valid XML country code
|{y}
|
|Language used on root element of the output document

|last-update-label
|
|`*Last updated*`, _any_
|{y}
|
|Text used for “Last updated” label in footer.

|listing-caption
|{n}
|_any_
|{y}
|{y}
|Text used to label listing blocks.

|listing-number
|
|`*1*`, _number_
|
|
|Stores listing number sequence start.

|manname-title
|
|`*NAME*`, _any_
|{y}
|
|Label for program name section in the man page.

|nolang
|{n}
|_empty_
|{y}
|
|Prevents `lang` attribute from being added to root element of the output document.

|note-caption
|{y}
|`*Note*`, _any_
|{y}
|{y}
|Text used to label NOTE admonitions when icons aren't enabled.

|preface-title
|{n}
|_any_
|{y}
|{y}
|Title text for an anonymous preface when `doctype` is `book`.

|section-refsig
|
|`*Section*` +
_any_
|{y}
|{y}
|Signifier added to title of numbered sections in cross reference text.

|table-caption
|{y}
|`*Table*` +
_any_
|{y}
|{y}
|Text of label prefixed to table titles.

|table-number
|{y}
|`*1*` +
_number_
|{y}
|{y}
|Stores table number sequence start.

|tip-caption
|{y}
|`*Tip*` +
_any_
|{y}
|{y}
|Text used to label TIP admonitions when icons aren't enabled.

|toc-title
|Only if `toc` is set
|`*Table of Contents*` +
_any_
|{y}
|
|xref:toc:title.adoc[Title for table of contents].

|untitled-label
|
|`*Untitled*` +
_any_
|{y}
|
|Default document title if document doesn't have a document title.

|warning-caption
|{y}
|`*Warning*` +
_any_
|{y}
|{y}
|Text used to label TIP admonitions when icons aren't enabled.
|===

== Header and metadata attributes

309
[cols="10m,^15,15,^5,^5,30"]
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
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|app-name
|{n}
|_any_
|{y}
|
|Adds `application-name` meta element for mobile devices inside HTML document head.

|author
|Only if present in author info line
|_any_
|{y}
|{n}
|Can be set automatically via the author info line or explicitly.
See xref:document:author-information.adoc[].

|authorinitials
|Only if present in author info line or `author`
|_any_
|{y}
|{n}
|Derived from the author attribute by default.
See xref:document:author-information.adoc[].

|authors
|Only if present in author info line
|_any_
|{y}
|{n}
|Can be set automatically via the author info line or explicitly as a comma-separated value list.
See xref:document:author-information.adoc[].

|copyright
|{n}
|_any_
|{y}
|{n}
|Adds `copyright` meta element in HTML document head.

|doctitle
|Only if document has a title (`=`)
|_any_
|{y}
|{n}
|See xref:document:title.adoc#reference-doctitle[doctitle attribute].

|description
|{n}
|_any_
|{y}
|{n}
|Adds xref:document:metadata.adoc#description[description] meta element in HTML document head.

|email
|Only if present in author info line
|_any_
|{y}
|{n}
|Can be any inline macro, such as a URL.
See xref:document:author-information.adoc[].

|firstname
|Only if present in author info line
|_any_
|{y}
|{n}
|See xref:document:author-information.adoc[].

|front-matter
|If front matter is captured
|_any_
|n/a
|n/a
|If `skip-front-matter` is set via the API or CLI, any YAML-style frontmatter skimmed from the top of the document is stored in this attribute.

|keywords
|{n}
|_any_
|{y}
|{n}
|Adds xref:document:metadata.adoc#keywords[keywords] meta element in HTML document head.

|lastname
|Only if present in author info line
|_any_
|{y}
|{n}
|See xref:document:author-information.adoc[].

|middlename
|Only if present in author info line
|_any_
|{y}
|{n}
|See xref:document:author-information.adoc[].

|orgname
|{n}
|_any_
|{y}
|{n}
|Adds `<orgname>` element value to DocBook info element.

|revdate
|Only if present in version info line
|_any_
|{y}
|{n}
|See xref:document:revision-information.adoc[].

|revremark
|Only if present in version info line
|_any_
|{y}
|{n}
|See xref:document:revision-information.adoc[].

|revnumber
|Only if present in version info line
|_any_
|{y}
|{n}
|See xref:document:revision-information.adoc[].

|title
|{n}
|_any_
|{y}
|{n}
|Value of `<title>` element in HTML `<head>` or main DocBook `<info>` of output document.
Used as a fallback when the document title is not specified.
See xref:document:title.adoc#title-attr[title attribute].

|version-label
|Only if `revnumber` is set
|*Version*, _any_
|{y}
|
|See xref:document:version-label.adoc[].
|===

== Section titles and table of contents attributes

455
[cols="10m,^15,15,^5,^5,30"]
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
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|idprefix
|{y}
|*_*, valid XML ID start character
|{y}
|{n}
|Prefix of auto-generated section IDs.
See xref:sections:id-prefix-and-separator.adoc#prefix[Change the ID prefix].

|idseparator
|{y}
|*_*, valid XML ID character
|{y}
|{n}
|Word separator used in auto-generated section IDs.
See xref:sections:id-prefix-and-separator.adoc#separator[Change the ID word separator].

|leveloffset
|{n}
|*0*, (+/-)0{en}5 (a leading + or - makes it relative)
|{y}
|{y}
|Increases or decreases level of headings in include files.
//<<include-partitioning>>

|partnums
|{n}
|*_empty_*
|{y}
|{n}
|See xref:sections:part-numbers-and-labels.adoc#partnums[Part numbers].
_Book doctype only_.

|sectanchors
|{n}
|_empty_
|{y}
|{n}
|xref:sections:title-links.adoc#anchor[Adds anchor in front of section title] on mouse cursor hover.

|sectids
|{y}
|*_empty_*
|{y}
|{n}
|Generates and assigns an ID to any section that does not have an ID.
See xref:sections:ids.adoc#disable[Disable ID generation].

|sectlinks
|{n}
|_empty_
|{y}
|{n}
|xref:sections:title-links.adoc[Turns section titles into self-referencing links].

|sectnums
|{n}
|*_empty_*, all
|{y}
|{n}
|xref:sections:numbers.adoc[Numbers sections] to depth specified by `sectnumlevels`.

|sectnumlevels
|Only if `sectnums` is set
|*3*, 0{en}5
|{y}
|{n}
|xref:sections:numbers.adoc#numlevels[Controls depth of section numbering].

|title-separator
|{y}
|*:*, _any_
|{y}
|{n}
|Character used to xref:document:subtitle.adoc[separate document title and subtitle].

|toc
|{n}
536
|`*auto*`, `left`, `right`, `macro` or `preamble`
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
|{y}
|{n}
|Turns on xref:toc:index.adoc[table of contents] and specifies xref:toc:position.adoc[its location].

|toclevels
|Only if `toc` is set
|*2*, 1{en}5
|{y}
|{n}
|xref:toc:section-depth.adoc[Maximum section level to display].

// NOTE toc-placement moved to deprecated table in migration guide
//|toc-placement
//|Location where table of contents is inserted.
//Should be treated as read-only.
//|Based on value of `toc` attribute.
//|auto, preamble, macro
//|{y}
//|

|fragment
|{n}
|_empty_
|
|
|Informs parser that document is a fragment and that it shouldn't enforce proper section nesting.
|===

== General content and formatting attributes

567
[cols="10m,^15,15,^5,^5,30"]
568
569
570
571
572
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|asset-uri-scheme
|{n}
573
|`https`, _empty_
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|{y}
|{n}
|Controls protocol used for assets hosted on a CDN.

|cache-uri
|{n}
|_empty_
|{y}
|{n}
|Cache content read from URIs.
//<<caching-uri-content>>

|data-uri
|{n}
|_empty_
|{y}
|
|Embed graphics as data-uri elements in HTML elements so file is completely self-contained.
//<<managing-images>>

|docinfo
|{n}
596
|`shared`, `private`, `shared-head`, `private-head`, `shared-footer`, `private-footer`
597
598
599
600
601
602
603
|{y}
|
|Read input from one or more DocBook info files.
//<<naming-docinfo-files>>

|docinfodir
|
604
|*base directory*, _Directory_
605
606
607
608
609
610
611
|{y}
|
|Location of docinfo files.
//<<locating-docinfo-files>>

|docinfosubs
|
612
|*attributes*, _comma-separated list of substitution names_
613
614
615
616
617
618
619
|{y}
|
|AsciiDoc substitutions that are applied to docinfo content.
//<<attribute-substitution-in-docinfo-files>>

|doctype
|{y}
620
|`*article*`, `book`, `inline`, `manpage`
621
622
623
624
625
626
627
|{y}
|{n}
|Output document type.
//<<document-types>>

|eqnums
|{n}
628
|`*AMS*`, `all`, `none`
629
630
631
632
633
634
635
|{y}
|
|Controls automatic equation numbering on LaTeX blocks in HTML output (MathJax).
If the value is AMS, only LaTeX content enclosed in an `+\begin{equation}...\end{equation}+` container will be numbered.
If the value is all, then all LaTeX blocks will be numbered.
See https://docs.mathjax.org/en/v2.5-latest/tex.html#automatic-equation-numbering[equation numbering in MathJax].

636
|hardbreaks-option
637
638
639
640
|{n}
|*_empty_*
|{y}
|{y}
641
|xref:blocks:hard-line-breaks.adoc#per-document[Preserve hard line breaks].
642
643
644
645
646
647

|hide-uri-scheme
|{n}
|_empty_
|{y}
|
648
|xref:macros:links.adoc#hide-uri-scheme[Hides URI scheme] for raw links.
649
650
651

|media
|{n}
652
|`*screen*`, `prepress`, `print`
653
654
655
|{y}
|
|Specifies media type of output and enables behavior specific to that media type.
656
_PDF converter only_.
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731

|nofooter
|{n}
|_empty_
|{y}
|
|Turns off footer.
//<<footer-docinfo-files>>

|nofootnotes
|{n}
|_empty_
|{y}
|
|Turns off footnotes.
//<<user-footnotes>>

|noheader
|{n}
|_empty_
|{y}
|
|Turns off header.
//<<doc-header>>

|outfilesuffix
|
|_File extension_
|{y}
|
|File extension of output file, including dot (`.`), such as `.html`.
// <<navigating-between-source-files>>

|pagewidth
|{n}
|*425*, _integer_
|{y}
|
|Page width used to calculate the absolute width of tables in the DocBook output.

|relfileprefix
|
|_empty_, _path segment_
|
|
|The path prefix to add to relative xrefs.
//<<navigating-between-source-files>>

|relfilesuffix
|{y} _value of outfilesuffix_
|Path segment
|{y}
|
|The path suffix (e.g., file extension) to add to relative xrefs.
(Preferred over modifying outfilesuffix).
//|<<navigating-between-source-files>>

|show-link-uri
|{n}
|_empty_
|{y}
|
|Prints the URI of a link after the linked text.
_PDF converter only_.

|showtitle
|{n}
|_empty_
|{y}
|{n}
|xref:document:title.adoc#hide-or-show[Displays an embedded document's title].
Mutually exclusive with the `notitle` attribute.

|stem
|{n}
732
|`*asciimath*`, `latexmath`
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
|{y}
|
|Enables xref:stem:stem.adoc[mathematics processing and interpreter].

|tabsize
|{n}
|0 or more
|{y}
|{y}
|Converts tabs to spaces in verbatim content blocks (e.g., listing, literal).

|webfonts
|{n}
|_empty_ (use default fonts), Google Fonts collection spec
|{y}
|{n}
|Control whether webfonts are loaded, and which ones, when using the default stylesheet.
The value populates the `family` query string parameter in the Google Fonts URL.
//<<applying-a-theme>> and {url-org}/asciidoctor.org/issues/410[issue #410^]

|xrefstyle
|{n}
755
|`full`, `short`, `basic`
756
757
758
759
760
761
762
763
|{y}
|{n}
|xref:macros:xref-text-and-style.adoc#cross-reference-styles[Formatting style to apply to cross reference text].
//_Introduced in 1.5.6._
|===

== Image and icon attributes

764
[cols="10m,^15,15,^5,^5,30"]
765
766
767
768
769
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|iconfont-cdn
|Only when `icons` attribute is set to `font`
770
|_url_
771
772
|{y}
|{n}
773
774
|If not specified, uses the cdnjs.com service.
Overrides CDN used to link to the Font Awesome stylesheet.
775
776
777

|iconfont-name
|Only when `icons` attribute is set to `font`
778
|_any_
779
780
781
|{y}
|
|Overrides the name of the icon font stylesheet.
782
By default, this value is *font-awesome*.
783
784
785
786
787
788
789
790
791
792
793
794
//<<icons>>

|iconfont-remote
|{n}
|_empty_
|{y}
|{n}
|Allows use of a CDN for resolving the icon font.
Only used when `icons` attribute is set to `font`.

|icons
|{n}
795
|`*image*`, `font`
796
797
|{y}
|{y}
798
|Chooses xref:macros:icons.adoc#icons-attribute[images or font icons] instead of text for admonitions.
799
800
801

|iconsdir
|Only used when `icons` attribute is set to `image`
802
|_Directory_
803
804
805
|{y}
|{n}
|Location of non-font-based image icons.
806
Points to the _icons_ folder under `imagesdir` by default.
807
808
809

|icontype
|Only used when `icons` attribute is set to `image`
810
|`*png*`, `jpg`, `svg`, `gif`
811
812
813
814
815
816
|{y}
|{n}
|File type for image icons.

|imagesdir
|{y}
817
|*_empty_*, _Directory_
818
819
820
821
822
823
824
|{y}
|{n}
|Location of image files.
|===

== Code highlighting and formatting attributes

825
[cols="10m,^15,15,^5,^5,30"]
826
827
828
829
830
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|coderay-css
|
831
|`*class*`, `style`
832
833
834
835
836
837
|{y}
|{n}
|Controls whether CodeRay uses CSS classes or inline styles.

|coderay-linenums-mode
|
838
|`*table*`, `inline`
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
|{y}
|{n}
|Sets how CodeRay inserts line numbers into source listings.

|coderay-unavailable
|
|_empty_
|{y}
|{n}
|Tells processor not to load CodeRay.

|highlightjsdir
|{n}
|_Directory_
|{y}
|{n}
|Location of the highlight.js source code highlighter library.

|highlightjs-theme
|
|*github*, _highlight.js style name_
|{y}
|{n}
|Name of theme used by highlight.js.

|prettifydir
|{n}
|_Directory_
|{y}
|{n}
|Location of non-CDN prettify source code highlighter library.

|prettify-theme
|
|*prettify*, _prettify style name_
|{y}
|{n}
|Name of theme used by prettify.

|prewrap
|{n}
|_empty_
|{y}
|{y}
883
|xref:asciidoctor:html-backend:verbatim-line-wrap.adoc[Wrap wide code listings].
884
885
886

|pygments-css
|
887
|`*class*`, `style`
888
889
890
891
892
893
|{y}
|{n}
|Controls whether Pygments uses CSS classes or inline styles.

|pygments-linenums-mode
|
894
|`*table*`, `inline`
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
|{y}
|{n}
|Sets how Pygments inserts line numbers into source listings.

|pygments-style
|
|_Pygments style name_
|{y}
|{n}
|Name of style used by Pygments.

|pygments-unavailable
|{n}
|_empty_
|{y}
|{n}
|Tells the processor not to load Pygments.

|source-highlighter
|{n}
915
|`coderay`, `highlight.js`, `pygments`, `rouge`
916
917
918
|{y}
|{n}
|xref:verbatim:source-highlighter.adoc[Specifies source code highlighter].
919
Any other value is permitted, but must be supported by a custom syntax highlighter adapter.
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946

|source-indent
|{n}
|_Integer_
|{y}
|{y}
|Normalize block indentation in source code listings.
//<<normalize-block-indentation>>

|source-language
|{n}
|_Source code language name_
|{y}
|{y}
|xref:verbatim:source-highlighter.adoc[Default language for source code blocks].

|source-linenums-option
|{n}
|_empty_
|{y}
|{y}
|Turns on line numbers for source code listings.
//_Introduced in 1.5.6._
|===

== HTML styling attributes

947
[cols="10m,^15,15,^5,^5,30"]
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
|===
|Name |Automatically Set |Values |Header Set |Body Set |Notes

|copycss
|Only when `linkcss` is set
|_empty_, location of the custom stylesheet (if used)
|{y}
|{n}
|Copy CSS files to output.
//<<applying-a-theme>>

|css-signature
|{n}
|_Valid XML ID_
|{y}
|{n}
|Assign value to `id` attribute of HTML `<body>` element.
*Preferred approach is to assign an ID to document title*.

|linkcss
|Only when safe mode is SECURE
|_empty_
|{y}
|{n}
|Links to stylesheet instead of embedding it.
Can't be unset in SECURE mode.
//<<styling-the-html-with-css>>

|max-width
|{n}
|CSS length (e.g. 55em, 12cm, etc)
|{y}
|{n}
|Constrains maximum width of document body.
*Not recommended.
Use CSS stylesheet instead.*

|stylesdir
|{y}
987
|*. (Same directory as document)*, _Directory_
988
989
990
991
992
993
994
995
996
997
998
999
1000
|{y}
|{n}
|Location of CSS stylesheets.
//<<creating-a-theme>>

|stylesheet
|{y}
|*default stylesheet*, _file name_
|{y}
|{n}
|CSS stylesheet file name.
//<<applying-a-theme>>

For faster browsing, not all history is shown. View entire blame