View source

== cms:container tag ==
This page extends the <tt>opencms.tld</tt> scarce documentation for the <tt>cms:container</tt> 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>
 <small>opencms.tld</small>

== cms:container attributes ==
=== name ===
        <attribute>
            <name>'''name'''</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
 <small>opencms.tld</small>

Sets the container name. It will be rendered as the '''<tt>id</tt> value''' of the tag.

=== type ===
        <attribute>
            <name>'''type'''</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>        
 <small>opencms.tld</small>

The <tt>type</tt> attribute can be used to select '''which formater 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 ===
        <attribute>
            <name>'''maxElements'''</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
        </attribute>
 <small>opencms.tld</small>

=== width ===
        <attribute>
        	<name>'''width'''</name>
        	<required>false</required>
        	<rtexprvalue>true</rtexprvalue>
        </attribute>
 <small>opencms.tld</small>

=== tag ===
        <attribute>
        	<name>'''tag'''</name>
        	<required>false</required>
        	<rtexprvalue>true</rtexprvalue>
        </attribute>
 <small>opencms.tld</small>

The default tag name that will be rendered is '''<tt>div</tt>''', but this can be overriden (see the [[#example | example below]]).

=== tagClass ===
        <attribute>
        	<name>'''tagClass'''</name>
        	<required>false</required>
        	<rtexprvalue>true</rtexprvalue>
        </attribute>
 <small>opencms.tld</small>

Sets the <tt>class</tt> of the rendered tag (see the [[#example | example below]]).

=== detailView ===
        <attribute>
        	<name>'''detailview'''</name>
        	<required>false</required>
        	<rtexprvalue>true</rtexprvalue>
        </attribute>
    </tag>
 <small>opencms.tld</small>

Sets if the current container is target of detail views.

== Example ==

The jsp template code:

  <cms:container name="infocontainer" tag="code" tagClass="myClass" />

Will rendered:

  <code id="infocontainer" class="myclass GH3XNNECNL"></code>