explain page attributes more clearly in docs
authorDan Allen <dan@opendevise.com>
Sat, 24 Aug 2019 22:42:32 +0000 (16:42 -0600)
committerDan Allen <dan@opendevise.com>
Sat, 24 Aug 2019 22:42:32 +0000 (16:42 -0600)
docs/modules/ROOT/pages/templates.adoc

index 2d628af..caf08a9 100644 (file)
@@ -60,9 +60,10 @@ Here's an overview of the available UI model:
 Sourced from AsciiDoc and converted to HTML by the Asciidoctor processor.
 
 | page.attributes
-| AsciiDoc header attributes that are prefixed with `page-`.
-The `page-` prefix is dropped from these names. A header attribute `:page-foo: bar` 
-is accessed as `page.attributes.foo`.
+| 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.
 
 | page.description
 | The text of the description attribute in the AsciiDoc header, if specified.