clarify how page attributes are defined and used
authorDan Allen <dan@opendevise.com>
Tue, 10 Sep 2019 07:01:30 +0000 (01:01 -0600)
committerDan Allen <dan@opendevise.com>
Tue, 10 Sep 2019 07:01:30 +0000 (01:01 -0600)
- mention that they can be defined in the playbook
- show an example that contains a hyphen in the name
- correct the terminology

docs/modules/ROOT/pages/templates.adoc

index dbe5182..3ea263a 100644 (file)
@@ -65,10 +65,11 @@ Only set if site.url is defined.
 Sourced from AsciiDoc and converted to HTML by the Asciidoctor processor.
 
 | page.attributes
-| All AsciiDoc header attributes prefixed with `page-`.
-The `page-` prefix is dropped from the name in this model.
-For example, the header attribute `page-foo` (e.g., `:page-foo: bar`) is accessed via the UI model as `page.attributes.foo`.
-The `page-` prefix is required to isolate page-related attributes from all other document attributes in AsciiDoc.
+| Any AsciiDoc document attribute prefixed with `page-`.
+The `page-` prefix is dropped from the name used in this model.
+For example, the value of the document attribute named `page-support-phone` can be accessed via the UI model using `page.attributes.support-phone`.
+Page attributes can be defined per page in the AsciiDoc document header (e.g., `:page-support-phone: +1 212-555-1234`) or globally in the playbook under the key `asciidoc.attributes`.
+The `page-` prefix is used to isolate page-related attributes from the numerous other document attributes in AsciiDoc.
 
 | page.description
 | The text of the description attribute in the AsciiDoc header, if specified.