<cms:include> 标签的基本使用方法

<cms:include> 标签的基本使用方法

                         [王毅原创，转载注明]

<cms:include>用于运行中从OpenCms VFS动态包含文件，包含的文件被当成一个请求的附加参数。

使用一下一些属性来标识要包含的对象文件名称:

• page
• property
• attribute

如果这些属性都没有设定, <cms:include> 标签的标签体将使用别的方法得到文件名称.

注意: 如果不能通过上诉方法得到包含的文件名称, 就会调用 当前 CmsRequestContext 的 getUri() 方法返回名称.

属性:

page (file)     

    这个属性的值指明要包含的文件的 name 。属性名称 "page" 和 "file" 在这里是等价的. 

property

    这个属性的值指明要包含的指定 JSP 文件的某个属性值作为文件名称.

attribute

    这个属性的值是当前页面请求的参数列表的一个参数键名称的值. 在使用前必须通过程序来设定这个键值对.

element 

    如果目标jsp文件被 cms:template 标签分割为几个模板元素, 那么只有指定的元素被包含进来. 否则，不管jsp文件被分割为几个模板元素也会被全部包含进来。
注意: element 被作为当前请求的附加请求参数被传递.   

suffix   

    给通过 property 和 attribue 属性包含的文件追加后缀名.

cachable 

    如果这个属性的值被设置为 "false", 那么这个被包含进来的部分不会进行 Flexcache 缓存.

标签体:

如果没有设置 page/ file, property 或者 attribute 这些属性的任何一个，那么可以使用 jsp 来写标签体.

可以添加额外的键值对参数到被包含的页面, 例如： <cms:param name="myparam" value="myvalue" />.

示例用法:

包含页面 "some_page.html":

<cms:include page="some_page.html" /> or <cms:include file="some_page.html" />

读取当前文件的 "template" 属性, 并且给这个属性值追加 "_head.jsp" 作为文件名称 ("suffix"属性可选):

<cms:include property="template" suffix="_head.jsp" />

处理另一个标签，将结果作为本标签的标签体，比如这里读取某个文件的一个属性值作为标签体:

<cms:include>

<cms:property name="template" file="parent"/>

</cms:include>

设置页面请求参数列表来传递将要包含的文件的名称:

<%

...

request.setAttribute( "body", "../elements/template-body.html" );

...

%>



<cms:include attribute="body">

    <cms:param name="__locale"><%= locale %></cms:param>

</cms:include>

包含某个文件，并且传递一些属性, 将增加的属性作为键值对传递给将要包含的文件:

<cms:include file="../elements/template-nav-top.jsp">

    <cms:param name="__locale"><%= locale %></cms:param>

    <cms:param name="__navpart" value="toprow" />

</cms:include>

包含 "template" 属性指明的 jsp 文件的 “head” 模板元素:

<cms:include property="template" element="head" />

我的相关日志：

2008-05-13 | <cms:template>标签的使用
2008-05-12 | 对 OpenCms 的 <cms:user> 标签的使用补充
2008-04-12 | <cms:param>标签的使用
2008-04-11 | <cms:img>标签的用法举例说明
2008-04-10 | 再谈<cms:contentaccess>标签的使用
2008-04-09 | 浅谈<cms:contentaccess>标签的使用
2008-03-21 | <cms:contentload>标签的使用
2007-12-14 | <cms:editable>标签的使用
2007-12-13 | <cms:contentshow>标签的使用
2007-12-12 | <cms:contentloop> 标签的使用