Asciidoctor has several captions and labels that can be overridden with document attributes. We need to define a document attribute and assign a new value to override a default caption or label. We can use UTF-8 characters as the value. The following list shows captions and labels we can override:
:appendix-caption:
:caution-caption:
:example-caption:
:figure-caption:
:important-caption:
:last-update-label:
:manname-title:
:note-caption:
:table-caption:
:tip-caption:
:toc-title:
:untitled-label:
:version-label:
:warning-caption:
In the next example Asciidoctor document we override caution-caption
and last-update-label
:
1 2 3 4 5 6 7 | = Change default captions :caution-caption: Watch out! :last-update-label: I was created on == Sample CAUTION : Simple caution message to show changed caption. |
We get the following HTML output:
This mechanism can be used to provide messages for other languages than English. The Asciidoctor Github repository contains a file with already translated values for a lot of languages. We include this document in our own Asciidoctor markup and we set the document attribute lang
with the value we want, eg. nl
. In the following example document we include the file https://raw.githubusercontent.com/asciidoctor/asciidoctor/v1.5.5/data/locale/attributes.adoc
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | = Asciidoctor // Set lang document attribute. // This attribute is used in the // included document attributes.adoc. :lang: nl // Include translations for built-in captions and labels. // To make the inclusion with a URI work we must // run Asciidoctor with attribute allow-uri-read: // $ asciidoctor -a allow-uri-read sample.adoc :i18n-labels-uri: https: //raw.githubusercontent.com/asciidoctor/asciidoctor/v1.5.5/data/locale include :: {i18n-labels-uri} /attributes.adoc [] // Simple caution block, where caption // should be replaced by Dutch text. CAUTION : Simpel bericht met `lang` document attribuut: {lang} . // Labels for example blocks are also // translated. .Titel ==== Bijvoorbeeld label voor voorbeelden is ook aangepast. ==== |
When we invoke Asciidoctor via the command line we must add the option -a allow-uri-read
to the remote document is included. The following screenshot shows the output:
Written with Asciidoctor 1.5.5.