Cms:container
From OpenCms Wiki
(Difference between revisions)
(Created page with "== cms:container tag == This page extends the <tt>opencms.tld</tt> scarce documentation for the <tt>cms:container</tt> tag. <tag> <description> This ta...") |
(Format) |
||
| (4 intermediate revisions by one user not shown) | |||
| Line 6: | Line 6: | ||
This tag enables the template mechanism for container pages. | This tag enables the template mechanism for container pages. | ||
</description> | </description> | ||
| − | <name>container</name> | + | <name>'''container'''</name> |
<tag-class>org.opencms.jsp.CmsJspTagContainer</tag-class> | <tag-class>org.opencms.jsp.CmsJspTagContainer</tag-class> | ||
<body-content>empty</body-content> | <body-content>empty</body-content> | ||
| Line 14: | Line 14: | ||
=== name === | === name === | ||
<attribute> | <attribute> | ||
| − | <name>name</name> | + | <name>'''name'''</name> |
<required>true</required> | <required>true</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 24: | Line 24: | ||
=== type === | === type === | ||
<attribute> | <attribute> | ||
| − | <name>type</name> | + | <name>'''type'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 30: | Line 30: | ||
<small>opencms.tld</small> | <small>opencms.tld</small> | ||
| − | The <tt>type</tt> attribute can be used to select '''which | + | The <tt>type</tt> attribute can be used to select '''which formatter will be used''': "''Which formatter JSP is used for which container can be configured either in the resource type schema or in the site map configuration''" (see [[Creating OpenCms 8 Container Templates#Formatter Configuration|Creating OpenCms 8 Container]]) |
=== maxElements === | === maxElements === | ||
<attribute> | <attribute> | ||
| − | <name>maxElements</name> | + | <name>'''maxElements'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 42: | Line 42: | ||
=== width === | === width === | ||
<attribute> | <attribute> | ||
| − | <name>width</name> | + | <name>'''width'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 50: | Line 50: | ||
=== tag === | === tag === | ||
<attribute> | <attribute> | ||
| − | <name>tag</name> | + | <name>'''tag'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 56: | Line 56: | ||
<small>opencms.tld</small> | <small>opencms.tld</small> | ||
| − | The default tag name that will be rendered is '''<tt>div</tt>''', but this can be overriden | + | The default tag name that will be rendered is '''<tt>div</tt>''', but this can be overriden (see the [[#example | example below]]). |
=== tagClass === | === tagClass === | ||
<attribute> | <attribute> | ||
| − | <name>tagClass</name> | + | <name>'''tagClass'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
</attribute> | </attribute> | ||
<small>opencms.tld</small> | <small>opencms.tld</small> | ||
| + | |||
| + | Sets the <tt>class</tt> of the rendered tag (see the [[#example | example below]]). | ||
=== detailView === | === detailView === | ||
<attribute> | <attribute> | ||
| − | <name>detailview</name> | + | <name>'''detailview'''</name> |
<required>false</required> | <required>false</required> | ||
<rtexprvalue>true</rtexprvalue> | <rtexprvalue>true</rtexprvalue> | ||
| Line 74: | Line 76: | ||
</tag> | </tag> | ||
<small>opencms.tld</small> | <small>opencms.tld</small> | ||
| + | |||
| + | Sets if the current container is target of detail views. | ||
| + | |||
| + | == Example == | ||
| + | |||
| + | The jsp template code: | ||
| + | |||
| + | <source lang="html4strict"> | ||
| + | <cms:container name="infocontainer" tag="code" tagClass="myClass" /> | ||
| + | </source> | ||
| + | |||
| + | Will render: | ||
| + | |||
| + | <source lang="html4strict"> | ||
| + | <code id="infocontainer" class="myclass GH3XNNECNL"></code> | ||
| + | </source> | ||
Latest revision as of 10:41, 21 August 2012
Contents |
cms:container tag
This page extends the opencms.tld scarce documentation for the cms:container tag.
<tag>
<description>
This tag enables the template mechanism for container pages.
</description>
<name>container</name>
<tag-class>org.opencms.jsp.CmsJspTagContainer</tag-class>
<body-content>empty</body-content>
opencms.tld
cms:container attributes
name
<attribute>
<name>name</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
Sets the container name. It will be rendered as the id value of the tag.
type
<attribute>
<name>type</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
The type attribute can be used to select which formatter will be used: "Which formatter JSP is used for which container can be configured either in the resource type schema or in the site map configuration" (see Creating OpenCms 8 Container)
maxElements
<attribute>
<name>maxElements</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
width
<attribute>
<name>width</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
tag
<attribute>
<name>tag</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
The default tag name that will be rendered is div, but this can be overriden (see the example below).
tagClass
<attribute>
<name>tagClass</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
opencms.tld
Sets the class of the rendered tag (see the example below).
detailView
<attribute>
<name>detailview</name>
<required>false</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
opencms.tld
Sets if the current container is target of detail views.
Example
The jsp template code:
<cms:container name="infocontainer" tag="code" tagClass="myClass" />Will render:
<code id="infocontainer" class="myclass GH3XNNECNL"></code>
