Commit ca16cd40 authored by jhodgdon's avatar jhodgdon

Issue #569362 by David Hernández, Jaza, effulgentsia: Document attributes template variables

parent 6a1b562b
...@@ -19,10 +19,11 @@ ...@@ -19,10 +19,11 @@
* - delta: An ID for the block, unique within each module. * - delta: An ID for the block, unique within each module.
* - region: The block region embedding the current block. * - region: The block region embedding the current block.
* - content: The content of this block. * - content: The content of this block.
* - attributes: HTML attributes for the containing element. * - attributes: array of HTML attributes populated by modules, intended to
* be added to the main container tag of this template.
* - id: A valid HTML ID and guaranteed unique. * - id: A valid HTML ID and guaranteed unique.
* - title_attributes: HTML attributes for the title element. * - title_attributes: Same as attributes, except applied to the main title
* - content_attributes: HTML attributes for the content element. * tag that appears in the template.
* - title_prefix: Additional output populated by modules, intended to be * - title_prefix: Additional output populated by modules, intended to be
* displayed in front of the main title tag that appears in the template. * displayed in front of the main title tag that appears in the template.
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
......
...@@ -26,8 +26,8 @@ ...@@ -26,8 +26,8 @@
* - status: Comment status. Possible values are: * - status: Comment status. Possible values are:
* unpublished, published, or preview. * unpublished, published, or preview.
* - title: Comment title, linked to the comment. * - title: Comment title, linked to the comment.
* - attributes.class: List of classes that can be used to style contextually * - attributes: HTML attributes for the containing element.
* through CSS. The default values can be one or more of the following: * The attributes.class may contain one or more of the following classes:
* - comment: The current template type; e.g., 'theming hook'. * - comment: The current template type; e.g., 'theming hook'.
* - by-anonymous: Comment by an unregistered user. * - by-anonymous: Comment by an unregistered user.
* - by-{entity-type}-author: Comment by the author of the parent entity, * - by-{entity-type}-author: Comment by the author of the parent entity,
...@@ -40,6 +40,8 @@ ...@@ -40,6 +40,8 @@
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
* displayed after the main title tag that appears in the template. * displayed after the main title tag that appears in the template.
* - content_attributes: List of classes for the styling of the comment content. * - content_attributes: List of classes for the styling of the comment content.
* - title_attributes: Same as attributes, except applied to the main title
* tag that appears in the template.
* *
* These variables are provided to give context about the parent comment (if * These variables are provided to give context about the parent comment (if
* any): * any):
......
...@@ -39,6 +39,12 @@ ...@@ -39,6 +39,12 @@
* teaser listings. * teaser listings.
* - node--unpublished: Appears on unpublished nodes visible only to site * - node--unpublished: Appears on unpublished nodes visible only to site
* admins. * admins.
* - title_attributes: Same as attributes, except applied to the main title
* tag that appears in the template.
* - content_attributes: Same as attributes, except applied to the main
* content tag that appears in the template.
* - author_attributes: Same as attributes, except applied to the author of
* the node tag that appears in the template.
* - title_prefix: Additional output populated by modules, intended to be * - title_prefix: Additional output populated by modules, intended to be
* displayed in front of the main title tag that appears in the template. * displayed in front of the main title tag that appears in the template.
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
......
...@@ -19,10 +19,13 @@ ...@@ -19,10 +19,13 @@
* - delta: An ID for the block, unique within each module. * - delta: An ID for the block, unique within each module.
* - region: The block region embedding the current block. * - region: The block region embedding the current block.
* - content: The content of this block. * - content: The content of this block.
* - attributes: HTML attributes for the containing element. * - attributes: array of HTML attributes populated by modules, intended to
* be added to the main container tag of this template.
* - id: A valid HTML ID and guaranteed unique. * - id: A valid HTML ID and guaranteed unique.
* - title_attributes: HTML attributes for the title element. * - title_attributes: Same as attributes, except applied to the main title
* - content_attributes: HTML attributes for the content element. * tag that appears in the template.
* - content_attributes: Same as attributes, except applied to the main content
* tag that appears in the template.
* - title_prefix: Additional output populated by modules, intended to be * - title_prefix: Additional output populated by modules, intended to be
* displayed in front of the main title tag that appears in the template. * displayed in front of the main title tag that appears in the template.
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
......
...@@ -26,8 +26,8 @@ ...@@ -26,8 +26,8 @@
* - status: Comment status. Possible values are: * - status: Comment status. Possible values are:
* unpublished, published, or preview. * unpublished, published, or preview.
* - title: Comment title, linked to the comment. * - title: Comment title, linked to the comment.
* - attributes.class: List of classes that can be used to style contextually * - attributes: HTML attributes for the containing element.
* through CSS. The default values can be one or more of the following: * The attributes.class may contain one or more of the following classes:
* - comment: The current template type; e.g., 'theming hook'. * - comment: The current template type; e.g., 'theming hook'.
* - by-anonymous: Comment by an unregistered user. * - by-anonymous: Comment by an unregistered user.
* - by-{entity-type}-author: Comment by the author of the parent entity, * - by-{entity-type}-author: Comment by the author of the parent entity,
...@@ -39,6 +39,8 @@ ...@@ -39,6 +39,8 @@
* displayed in front of the main title tag that appears in the template. * displayed in front of the main title tag that appears in the template.
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
* displayed after the main title tag that appears in the template. * displayed after the main title tag that appears in the template.
* - title_attributes: Same as attributes, except applied to the main title
* tag that appears in the template.
* - content_attributes: List of classes for the styling of the comment content. * - content_attributes: List of classes for the styling of the comment content.
* *
* These variables are provided to give context about the parent comment (if * These variables are provided to give context about the parent comment (if
......
...@@ -39,6 +39,12 @@ ...@@ -39,6 +39,12 @@
* teaser listings. * teaser listings.
* - node--unpublished: Appears on unpublished nodes visible only to site * - node--unpublished: Appears on unpublished nodes visible only to site
* admins. * admins.
* - title_attributes: Same as attributes, except applied to the main title
* tag that appears in the template.
* - content_attributes: Same as attributes, except applied to the main
* content tag that appears in the template.
* - author_attributes: Same as attributes, except applied to the author of
* the node tag that appears in the template.
* - title_prefix: Additional output populated by modules, intended to be * - title_prefix: Additional output populated by modules, intended to be
* displayed in front of the main title tag that appears in the template. * displayed in front of the main title tag that appears in the template.
* - title_suffix: Additional output populated by modules, intended to be * - title_suffix: Additional output populated by modules, intended to be
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment