jdoc 语句包含在每个 Joomla 模板中,用于指示 Joomla 或其扩展的其他部分输出内容在整个网页中的位置。本文将简单的介绍一下Joomla模板开发中常用到的<jdoc>标签语法,并且介绍不同类型的<jdoc>标签元素的功能。
JDoc语句
一个典型的 jdoc 语句如下所示:
<jdoc:include type="component" />
<jdoc:include />
语句是 Joomla! 模板用来显示与所查看页面特定内容的方法。有多种 <jdoc:include />
语句,每种返回 Joomla! 页面的不同部分。 可以简单的理解为占位符。实际的替换过程在 JDocumentHTML::_renderTemplate
方法中完成
type 属性
type属性是必须的。type
属性指定了在 <jdoc:include />
元素位置渲染的内容类型。例如,语句 <jdoc:include type="head" />
使用了 head
类型(type="head"
)。(注意:jdoc 表达式要求属性使用双引号,单引号无效。结尾 />
前的空格也是必需的。)
<jdoc:include type="component" />
- 该元素在模板的
<body>
元素中应仅出现一次,用于渲染与当前查看页面相关的主要内容。
- 该元素在模板的
<jdoc:include type="head" />
- 该元素在模板的
<head>
元素中应仅出现一次,用于渲染与当前页面关联的样式 (style)、脚本 (script) 和元数据 (meta) 元素的内容。
- 该元素在模板的
<jdoc:include type="installation" />
- 该元素仅在 Joomla! 安装程序的模板中使用(适用于 Joomla! 1.5 及以下版本),在前端或后端模板中没有特定用途。它大致相当于
'component'
类型,用于渲染安装步骤的主要内容。
- 该元素仅在 Joomla! 安装程序的模板中使用(适用于 Joomla! 1.5 及以下版本),在前端或后端模板中没有特定用途。它大致相当于
<jdoc:include type="message" />
- 该元素在模板的
<body>
元素中应仅出现一次,用于渲染请求过程中发生的系统和错误消息。系统消息的 CSS 样式可在templates\system\css\system.css
中找到。
- 该元素在模板的
<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />
- 该元素渲染由
name
和title
属性指定的单个模块:name
应匹配模块类型(如上面示例中的mod_breadcrumbs
和mod_menu
),而title
应是所需模块的名称。所涉及的模块必须已发布且当前用户可以访问才能显示。如果支持,可以提供额外的属性来控制模块的布局和外观。
- 该元素渲染由
<jdoc:include type="modules" name="[position_name]" />
- 页面上的模块使用以下代码示例之一进行渲染。模块使用在
templatedetails.xml
文件中设定的模板位置 (template positions) 分隔在模板的不同区域。通过jdoc:include
的name="[模板位置名称]"
属性,可以分别调用、渲染和设置位于各自位置的模块样式。如果支持,可以提供额外的属性来控制模块的布局和外观。
- 页面上的模块使用以下代码示例之一进行渲染。模块使用在
style 属性
style属性是可选的 ,style属性可用于 <jdoc:include />
语句的 type="module"
和 type="modules"
类型。该属性值指的是用于包装模块生成输出的装饰样式 (chrome style)。如果未提供样式,则默认使用 "none"
。模板设计师可以添加额外的装饰名称,具体如何操作,请关注joomla中文网的相关教程文章。
评论 (0)