管理小工具
在Orchard中,一个小工具就是一个UI块(比如HTML)或者代码(比如content part),它能用于当前主题的块或者任意区域,比如工具条等。在示例中,我们使用了导航菜单、图片展示、广告等小工具。
这篇文章讲解了小工具的基础知识及其如何管理小工具。
层、区域和小工具
Orchard中,点击Widgets 来管理小工具。 Widgets 管理界面展示了已经启用的小工具,让你可以在层和区域中新增小工具
你可以把层当作角色,用于控制是否显示小工具。比如,只有用户登陆以后,才会在页面中显示某些小组件。区域用于在页面中定位小工具的位置。
下面是小工具管理页面:
启用小工具
当一个小工具已经启用 (在Modules管理页面的Features标签页中启用小工具),Orchard能够在当前主题中的特定区域中新增小工具。
比如,在小工具管理界面,单击Header块上的Add按钮,会弹出一个对话框,选择需要显示的小工具。
下面显示了Orchard中默认启用的小工具:
Widget |
Description |
Blog Archives |
显示特定博客 |
Container Widget |
显示 "contained" 文本项, 比如列表。 |
Html Widget |
显示 HTML 内容 |
Recent Blog Posts |
显示特定博客最近的帖子 |
层
Orchard 默认定义了一些层。如果需要,你也可以自定义一些层,(我们会在 Adding a Layer中讲解)。在小工具管理页面,你能够选择需要编辑的层,然后单击Edit按钮,或者单击Add a new layer新增层。
下面的表格显示了默认的层,及其他们的规则和描述。
Layer |
Rule |
Description |
Default |
true |
在每个页面上都会显示 |
Authenticated |
authenticated |
登陆用户会显示 |
Anonymous |
not authenticated |
匿名用户会显示 |
Disabled |
false |
不会显示。这一层提供了一种途径,用于保存不需要显示的小工具的配置。 |
TheHomepage |
url("~/") |
主页会显示 |
块
在Orchard,一个页面被分为了多个块。页面主题定义了多个块。在小工具配置页面,你能看到当前选中层有哪些块 ,以及块上面有哪些小工具。
查看默认主题各个块的更多详情,请看Customizing the Default Theme.
新增层
在Dashboard的小工具管理页面,点击Add a new layer。进入新增层界面
为了定义一个新层,你需要录入层的名称,描述和规则。录入完成以后,点击保存。
层规则的值,是一个返回True或者False的表达式。如果表达式的值是 true, 这一层上的小工具就会显示。否则不会显示
下面的表格是对层规则表达式的说明
Rule Syntax |
Description |
url("<url path>") |
如果当前URL和path匹配,返回ture。如果你在path后面加上星号(*),当前路径前面包含此path会返回true (比如, url("~/home*")). |
authenticated |
登陆了会返回true |
ContentType("<Type>") |
如果页面的类型和设置的类型一致,返回true。比如: ContentType("Page") |
not |
逻辑否 |
and |
逻辑和 |
or |
逻辑或 |
表达式中能够包含括号
比如,下面的表达式用于在登陆的用户访问任意页面或者任意用户访问About页面时显示
(not authenticated and url("~/about")) or authenticated
匹配多个URL路径,可以采用下面的方式:
url("~/foo") or url("~/bar")
在块中加入小工具
在块中加入小工具,单击块右边的 Add 按钮,然后在弹出页面中选择需要加入的小工具。
比如,单击Header块右边的 Add 块,然后在弹出框中选择Html Widget.
不同的小工具,配置的内容不一样,但是,所有的小工具都有Zone, Layer, Title 和 Position 字段。 Position 字段决定了该块中的小工具的顺序。记住,该块中的小工具,可能来源于多个层。比如,两个不同的层,可能在同一块加入了小工具。
Position 字段的值,可以是整数或者由.分隔的整数序列。比如,下面的值都是有效的: 5, 10.1, 7.5.3.1。值越小,越先渲染。
填好了字段的值以后,点击保存。
编辑或者删除小工具
为了编辑或者删除小工具,在小工具管理页面 ,在 Current Layer 下拉框选择中选择小工具所在层。在显示的块列表中,单击你需要编辑的小工具。编辑页面就会弹出:
编辑字段,单击保存按钮。
如果需要删除小组件,单击旁边的删除按钮