summaryrefslogtreecommitdiff
path: root/docs/modules/ROOT
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules/ROOT')
-rw-r--r--docs/modules/ROOT/nav-safe-modes.adoc2
-rw-r--r--docs/modules/ROOT/pages/language-support.adoc46
-rw-r--r--docs/modules/ROOT/pages/reference-safe-mode.adoc (renamed from docs/modules/ROOT/pages/attributes-and-safe-modes.adoc)7
-rw-r--r--docs/modules/ROOT/pages/safe-modes.adoc6
4 files changed, 30 insertions, 31 deletions
diff --git a/docs/modules/ROOT/nav-safe-modes.adoc b/docs/modules/ROOT/nav-safe-modes.adoc
index be07ed4d..2d362d52 100644
--- a/docs/modules/ROOT/nav-safe-modes.adoc
+++ b/docs/modules/ROOT/nav-safe-modes.adoc
@@ -1,2 +1,2 @@
* xref:safe-modes.adoc[]
-** xref:attributes-and-safe-modes.adoc[]
+** xref:reference-safe-mode.adoc[]
diff --git a/docs/modules/ROOT/pages/language-support.adoc b/docs/modules/ROOT/pages/language-support.adoc
index 4af521ff..362411d0 100644
--- a/docs/modules/ROOT/pages/language-support.adoc
+++ b/docs/modules/ROOT/pages/language-support.adoc
@@ -39,85 +39,85 @@ If you're not using the DocBook toolchain for publishing, you must translate eac
One way is to set the following attributes in the document header or by passing the attributes via the API or CLI:
.Attributes that control built-in labels
-[%autowidth]
+[%autowidth,cols="m,,"]
|===
-|Attribute name |Used for |Default
+|Attribute |Default English Value |Notes
|appendix-caption
-|Appendix titles.
|Appendix
+|
|caution-caption
-|CAUTION admonitions (when icons are not in use).
|Caution
+|
|chapter-label
-|Prefix added to chapter titles (i.e., level-1 section titles when doctype is book). _(pdf converter only)_
|Chapter
+|Applies only when `doctype` is `book`.
+PDF converter only.
|example-caption
-|Example titles.
|Example
+|
|figure-caption
-|Automatically prefixed to figure titles.
|Figure
+|
|important-caption
-|IMPORTANT admonitions (when icons are not in use).
|Important
+|
|last-update-label
-|Label for when the document was last updated.
|Last updated
+|
|listing-caption
-|The label for listing blocks.
-By default, listing blocks do not have captions.
-If you specify `listing-caption`, then you also turn on captions for listing blocks.
|_not set_
+|By default, listing blocks do not have captions.
+Specify `listing-caption` to turn on listing block captions.
|manname-title
-|Label for the program name section in the man page.
|NAME
+|Applies only when `doctype` is `manpage`.
|note-caption
-|NOTE admonitions (when icons are not in use).
|Note
+|
|preface-title
-|Title text used for the anonymous preface (when the `doctype` is book).
|_not set_
+|Applies only when `doctype` is `book`.
|table-caption
-|Automatically prefixed to table titles.
|Table
+|
|tip-caption
-|TIP admonitions (when icons are not in use).
|Tip
+|
|toc-title
-|Title of the table of contents.
|Table of Contents
+|
|untitled-label
-|The document title, for documents that have only body content.
|Untitled
+|
|version-label
-|The label preceding the revnumber in the document's byline.
|Version
+|
|warning-caption
-|WARNING admonitions (when icons are not in use).
|Warning
+|
|===
-If you plan to support multiple languages, you'll want to define the attributes for each language inside a conditional preprocessor directive.
+If you plan to support multiple languages, you'll want to define the attributes for each language inside a xref:asciidoc:directives:conditionals.adoc[conditional preprocessor directive].
For example:
-[source]
+[source,asciidoc]
----
\ifeval::["{lang}" == "de"]
:caution-caption: Achtung
diff --git a/docs/modules/ROOT/pages/attributes-and-safe-modes.adoc b/docs/modules/ROOT/pages/reference-safe-mode.adoc
index 1d18c502..8c5b47b2 100644
--- a/docs/modules/ROOT/pages/attributes-and-safe-modes.adoc
+++ b/docs/modules/ROOT/pages/reference-safe-mode.adoc
@@ -1,12 +1,11 @@
-= Manage Attributes By Safe Mode
+= Safe Mode Specific Content
// anchor: set-safe-attrs
-Asciidoctor provides security levels that control the read and write access of attributes, the include directive, macros, and scripts while a document is processing.
-Each level includes the restrictions enabled in the prior security level.
-
Asciidoctor provides access to the xref:safe-modes.adoc[current safe mode] through built-in attributes.
You can use these attributes to enable or disable content based on the current safe mode of the processor.
+== Referencing safe modes
+
The safe mode can be referenced by one of the following attributes:
* The value of the `safe-mode-name` attribute (e.g., unsafe, safe, etc.)
diff --git a/docs/modules/ROOT/pages/safe-modes.adoc b/docs/modules/ROOT/pages/safe-modes.adoc
index 3e06f836..c8ac7d8f 100644
--- a/docs/modules/ROOT/pages/safe-modes.adoc
+++ b/docs/modules/ROOT/pages/safe-modes.adoc
@@ -1,6 +1,6 @@
= Safe Modes
-Asciidoctor provides security levels that control the read and write access of attributes, the include directive, macros, and scripts while a document is processing.
+Asciidoctor provides security levels that control the read and write access of attributes, include directives, macros, and scripts while a document is processing.
Each level includes the restrictions enabled in the prior security level.
== Safe mode levels
@@ -48,7 +48,7 @@ Additionally, it:
* disables `docdir` and `docfile` (as these can reveal information about the host filesystem)
* disables source highlighting
-xref:extensions:register.adoc[Asciidoctor extensions] may still embed content into the document depending whether they honor the safe mode setting.
+xref:extensions:index.adoc[Asciidoctor extensions] may still embed content into the document depending whether they honor the safe mode setting.
*This is the default safe mode for the API.*
Its integer value is `20`.
@@ -80,4 +80,4 @@ TIP: GitHub processes AsciiDoc files using the `SECURE` level.
////
The safe mode can be set from the xref:cli:set-safe-mode.adoc[CLI] and the xref:api:set-safe-mode.adoc[API].
-You can also xref:attributes-and-safe-modes.adoc[manage attributes by safe mode].
+You can also xref:reference-safe-mode.adoc[enable or disable content based on the current safe mode].