Joomla文档中文翻译 - 模板参数详解 - 怎样定义模板参数

joomla_documentation_168templateDetails.xml文件位于Joomla模板的根路径中,例如在Joomla自带的Beez模板中,该文件路径应该是这样的:Joomla根路径/templates/beez/templateDetails.xml

需要注意templateDetails.xml的文件名对大小写字母敏感;我们可以使用标准的代码编辑器对该文件进行编辑。

打开templateDetails.xml文件,找到<params>标签;如果当前文件中没有定义过任何参数,那么需要首先添加<params>标签,注意要添加到<install></install>内。需要提到的是,在Joomla 1.6中,<install>标签将不再使用,取而代之的是<extension>标签

如果你对templateDetails.xml文件还不大熟悉,可以先参考“Joomla文档中文翻译 - templateDetails.xml文件详解”一文稍做了解。

<params></params>中的每一个<param>元素对应着一个模板参数定义;取决于所要定义的参数类型,<param>元素会包含不同数量的必要或可选的参数设置。真正必要的参数是type和name,但是通常default,description和label都会被用到。下面来看看这些参数的具体作用:

  • type(必要参数) :用来定义当前参数在模板参数表单中以怎样的表单元素来呈现,如下拉列表或单选按钮。
  • name(必要参数) :参数名称;模板文件的代码会根据这些名称来获取参数值并做出相应的行为调整。
  • default(可选参数) :参数的默认值。
  • description(可选参数) :参数的功能说明;会作为提示气泡在模板参数设置中向用户显示。
  • label(可选参数) :作为参数的标题,在模板参数设置页面中现实在参数表单项的前面。

下面的截图中,“Color Variation”是label,气泡中的文字是description,下拉列表是type,“Blue”是default。

joomla-template-parameters-what-is-what

下面的示例中,我们定义了两个模板参数,第一个的类型是下拉列表,第二个是单选按钮组,分别用来控制模板的颜色及作者信息的显示。

<params>
<param name="templateColour" type="list" default="blue"
label="Template Colour" description="Choose the template colour.">
<option value="blue">Blue</option>
<option value="red">Red</option>
<option value="green">Green</option>
<option value="black">Black</option>
</param>
<param name="authorCopyright" type="radio" default="1"
label="Author Copyright" description="Show/Hide author copyright.">
<option value="0">hide</option>
<option value="1">show</option>
</param>
</params>

在后台的模板管理中,模板参数的设置表单项会像下面截图中那样呈现:

joomla-template-parameters-example

译者:Viiiix7210

如需转载,请注明官方英文文档及本人译文的出处,谢谢。查看官方英文文档: Tutorial:Template parameters


收藏与分享

添加评论


Security code
换一张图