模板命名规范
动易 WebFuture 系统支持在站群管理、站点管理、节点管理甚至发布内容时指定相关模型模板模板、节点模板和内容页模板,高度自由的模板体系给站群应用带来极大的自由。为了方便客户实现“开箱即用”的方式构建整个网站,按规律深入研究系统模板功能,系统提供文件命名规范和目录结构规范的 WebFuture 标准模板。
任何一套动易 WebFuture 模板方案,模板文件只要遵循本方案中的命名规范进行命名,遵循本方案中的目录结构,无论是谁制作的站群模板,都可以实现在站群后台“一次指定模板方案、全站无缝更换模板”的效果,而无须再繁琐地一一重新指定模板设置。
命名约定
- 遵循简明原则,以简明扼要的简称进行命名。
- 遵循从内容模型类型、模板应用范围、内容展示类型等范围由大到小的原则进行串式命名。
- 以单个名词,或两个及以上相关名词用连接号组成一个意义单位,如 “模型或模块名称-模板类型-展示效果.cshtml”。
提示
- 网站首页.cshtml
- 文章-列表页.cshtml
- 文章-列表页-图片式.cshtml
- 文章-新闻资讯-首页.cshtml
文章 - 列表页 - 图片式 .cshtml
| | | |
模型名称 模板类型 展示效果 文件后缀
旅游频道 - 文章列表页 - 图片式 .cshtml
| | | |
指定名称 模型和模板类型 展示效果 文件后缀
- 可在模型中通用,且不指定用于特定频道和栏目的模板,应以“文章”、“图片”等模型名开头:
提示
以内容模型名称开头命名的模板,是可以在相应模型中通用的模板:
- 文章-***.cshtml
- 图片-***.cshtml
- 视频-***.cshtml
- 专题-***.cshtml
- 指定某频道、栏目、专题或功能模块专用的模板,以特定名称开头:
提示
以特定名称开头命名的模板,应用于指定范围或模块中展示特定的效果:
- 发展历程.cshtml
- 机构设置-首页.cshtml
- 党建专题-文章列表页.cshtml
- 旅游频道-图片列表页.cshtml
- 若模板在专有区域或功能模块中使用,命名应指定模块的名称、使用范围和模板类型,名称过长应合并名词以减少连接号,如:
提示
命名中的连接符不宜过多,可适当合并名词:
- 招商引资专题-文章首页.cshtml
- 招商引资专题-文章列表页-图片式.cshtml
- 信息公开-部门体裁-区块式.cshtml
- 信息公开-部门信息公开目录-部门分类.cshtml
- 连接号为英文破折号,例:正确 - ,错误 -;
- 模板按应用范围一般的可以分为首页/父列表页、列表页和内容页:
注意
- 首页:通常把网站第一个页面或浏览站内某个频道的第一个页面称为首页。这个页面会按一定的需求自由布局,以展示站内的综合数据和信息引导。
- 父列表页/列表页:将某一类信息显示名称、简介、时间等信息列表,并按照一定的排列规律以循环列表方式展示本类的更多信息。父列表页中包含子栏目信息。
- 内容页:用一个专门的页面展示某一个信息的详细内容,如标题、作者、详细内容、用户评价、相关信息等。
存储规则
- 模型公用的模板,存储在
ContentManage
目录中,以子目录区分各个内容模型中通用的模板,命名以模型开头,如:
提示
- ContentManage/Article/文章-列表页.cshtml
- ContentManage/Photo/图片-列表页.cshtml
- ContentManage/Leader/领导-列表页.cshtml
- ……
- 模块、专题等特定使用范围的模板,存储于各自模块名称的目录中,命名以特有名称或易理解的名称开头,如:
提示
- InfoPublicity/信息公开-文章-内容页.cshtml
- Survey/调查问卷内容页.cshtml
- ……
目录结构
- 各模型模板以内置模型名称目录进行分类,如:
提示
- 文章模型:/ContentManage/Article/
- 图片模型:/ContentManage/Photo/
- 视频模型:/ContentManage/Video/
- 友情链接:/ContentManage/FriendlyLink/
- 专题:/ContentManage/Special/
- 模板文件和组件文件保存于
Views
目录中,并依据访问终端类型进行目录分类,如:
提示
- 电脑版文章模型:/Views/main/ContentManage/Article/文章模型-列表页.cshtml
- 平板版文章模型:/Views.Pad/main/ContentManage/Article/文章模型-列表页.cshtml
- 手机版文章模型:/Views.Phone/main/ContentManage/Article/文章模型-列表页.cshtml
- CSS 样式、图片、JS 文件保存于 Content 目录中,并依据访问终端类型进行目录分类,如:
提示
- 电脑版样式:/wwwroot/content/main/contentManage/home/css/index.css
- 平板版样式:/wwwroot/content.pad/main/contentManage/home/css/archive.css
- 手机版样式:/wwwroot/content.phone/main/contentManage/home/css/archive.css
- 若指定节点相应的“移动设备”为开启,则系统自动开启相应终端的模板对应,请保持相应路径的
.Pad
或.Phone
目录中有对应的模板文件:
移动设备
是否启用手机端 是/否
是否启用平板端 是/否
- 在站点、节点的设置中,指定模板路径、节点参数设置中内置电脑版模板路径时,系统提供变量
{SiteIdentifier}
获得当前站点的标识符。如站点标识符为“hbj”
的子站在设置节点模板时填写路径:
提示
- 节点中填写的模板路径为:
~/Views/{SiteIdentifier}/ContentManage/Article/文章-列表页.cshtml
- 模板路径解析结果为:
~/Views/hbj/ContentManage/Article/文章-列表页.cshtml
- 站点中所有的模板中,调用模板地址、样式、图片等的都应当使用自动判断本站点标识符的组件
{this.Context.GetCurrentSite().Identifier}
,以自动解析本站点标识符。如站点标识符为“hbj”
的子站模板中:
模板:~/Views/{this.Context.GetCurrentSite().Identifier}/Layout/公共布局页.cshtml
模板最终解析结果为:~/Views/hbj/Layout/公共布局页.cshtml
样式:~/content/@(this.Context.GetCurrentSite().Identifier)/home/css/index.css
模板最终解析结果为:~/content/hbj/home/css/index.css
JS调用:~/content/@(this.Context.GetCurrentSite().Identifier)/base/js/index.js
模板最终解析结果为:~/content/hbj/base/js/index.js
图片:~/content/@(this.Context.GetCurrentSite().Identifier)/base/img/abc.jpg
模板最终解析结果为:~/content/hbj/base/img/abc.jpg