summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-04-21 15:44:57 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-04-21 15:45:35 -0600
commit2cb4baf5b0454e0f3e9a10950d1b9151092f1df1 (patch)
treeed97d800673fb4ba57e4d3e8d932b9dfeaf85b07 /docs/modules
parent50468a34481c5e5093a9909aab314514b98cf223 (diff)
clarify how the docinfodir value is resolved [skip ci]
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 852eea3b..9b109ef3 100644
--- a/docs/modules/ROOT/pages/docinfo.adoc
+++ b/docs/modules/ROOT/pages/docinfo.adoc
@@ -210,15 +210,17 @@ If other AsciiDoc files are added to the same folder, and `docinfo` is set to `s
[#resolving]
== Locating docinfo files
-By default, docinfo files are searched for in the same folder as the document file.
-If you want to keep them anywhere else, set the `docinfodir` attribute to their location:
+By default, docinfo files are searched for in the same directory as the document file (which can be overridden by setting the `:base_dir` API option / `--base-dir` CLI option).
+If you want to load them from another location, set the `docinfodir` attribute to the directory where the files are located.
+If the value of the `docinfodir` attribute is a relative path, that value is appended to the document directory.
+If the value is an absolute path, that value is used as is.
[source,asciidoc]
----
:docinfodir: common/meta
----
-Note that if you use this attribute, only the specified folder will be searched; docinfo files in the document folder will no longer be found.
+Note that if you use this attribute, only the specified folder will be searched; docinfo files in the document directory will no longer be found.
[#attribute-substitution]
== Attribute substitution in docinfo files