summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-01-30 23:46:32 -0700
committerDan Allen <dan.j.allen@gmail.com>2022-01-31 00:36:45 -0700
commit5a77a3b3af9d6fe3714b63664ea759ec4104d002 (patch)
tree62555f002205841703943c66ad4a53b747b082b0 /docs/modules
parent6633a673eed457f342bf43c797786f938e228b22 (diff)
rewrite intro for docinfo files
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/pages/docinfo.adoc8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/modules/ROOT/pages/docinfo.adoc b/docs/modules/ROOT/pages/docinfo.adoc
index 39437b71..83e081c0 100644
--- a/docs/modules/ROOT/pages/docinfo.adoc
+++ b/docs/modules/ROOT/pages/docinfo.adoc
@@ -3,14 +3,16 @@
:url-docinfo-example: https://github.com/clojure-cookbook/clojure-cookbook/blob/master/book-docinfo.xml
// um anchor: docinfo-file
-You can add custom content to the head, header or footer of an output document using docinfo files.
-Docinfo files are useful for injecting auxiliary metadata, stylesheet, and script information into the output not added by the converter.
+Docinfo is a feature of AsciiDoc that allows you to insert custom content into the head, header, or footer of the output document.
+This custom content is read from files known as docinfo files by the converter.
+Docinfo files are intended as convenient way to supplement the output produced by a converter.
+Examples include injecting auxiliary metadata, stylesheets, and scripting logic not already provided by the converter.
The docinfo feature does not apply to all backends.
While it works when converting to output formats such as HTML and DocBook, it does not work when converting to PDF using Asciidoctor PDF.
The docinfo feature must be explicitly enabled using the `docinfo` attribute (see <<enable>>).
-Which docinfo files get used depends on the value of the `docinfo` attribute as well as the backend.
+Which docinfo files are consumed depends on the value of the `docinfo` attribute as well as the backend.
[#head]
== Head docinfo files