ECMSV1.0网站内容管理系统模版标签说明书.docx
ECMS 网站 内容管理系统 V1.0 模版 标签 说明书 雨轩工作室 ECMS V1.0 网站内容管理系统模版标签说明书 第 2 页 目录 关亍本文档 ....................................................................................................................................... 3 读者对象 ........................................................................................................................................... 4 一. 基本说明 ........................................................................................................................... 4 二. 标签说明 ........................................................................................................................... 4 2.1 内置型标签 ....................................................................................................................... 4 2.1.1 column .................................................................................................................. 4 2.1.2 content .................................................................................................................. 5 2.1.3 pu ........................................................................................................................... 5 2.1.4 list ........................................................................................................................... 7 2.2 调用型标签 ........................................................................................................................ 7 2.2.1 cms. getContent............................................................................................... 8 2.2.2 cms. getSortList .............................................................................................. 8 2.2.3 cms. getSiteConfigValue .............................................................................. 9 2.2.4 cms. getTags .................................................................................................... 9 2.2.5 cms. getColumn ............................................................................................ 10 2.2.6 cms. getList ..................................................................................................... 11 2.2.7 cms. getListLike ............................................................................................. 11 2.2.8 cms. atTime ........................................................................................... 12 2.2.9 cms. segmentText ......................................................................................... 13 2.2.10 cms. subString ............................................................................................. 13 2.2.11 cms. isEmpty ................................................................................................ 14 ECMS V1.0 网站内容管理系统模版标签说明书 第 3 页 2.2.12 cms. isNull .................................................................................................... 14 2.2.13 cms. getString ............................................................................................. 15 2.2.14 cms. getLong ............................................................................................... 15 2.2.15 cms. atContent .................................................................................. 16 2.2.16 cms. getUser ................................................................................................. 16 2.2.17 cms. getFileSize .......................................................................................... 17 2.2.18 cms. wordExist ............................................................................................ 17 三.标签对象属性 说明 ................................................................................................................. 18 3.1 column ........................................................................................................................... 18 3.2 content ........................................................................................................................... 19 3.3 sort .................................................................................................................................. 20 3.4 tags .................................................................................................................................. 20 3.5 special ............................................................................................................................. 20 关于本文档 本文档 详细 说明了 ECMS 的模版制作方法 ,是用户熟悉和掌握 ECMS 模版制作方法和模版标签的重要文档 。 ECMS V1.0 网站内容管理系统模版标签说明书 第 4 页 读者对象 本文档的读者为 ECMS 使用者 中的模版制作人员 。使用者应具备以下基础知 a 熟悉 HTML 基本知识和相关的 HTML 页面制作方法 一. 基本说明 ECMS 采用 FreeMarker, 并 内置了丰富的模版标签 ,并且提供了强大的调用型标签群 。灵活而强大,可以丌断的扩展。 二. 标签说明 2.1 内置型 标签 2.1.1 column 【基本描述】 栏目标签 ,包含栏目的基本信息。 【使用范围】 发布栏目页 ,内容页 时使用 【参数说明 】 无 【属性说明 】 为 column 对象 , 属性详见 对象 属性说明章节 ECMS V1.0 网站内容管理系统模版标签说明书 第 5 页 【使用示例】 { column .id} 获取栏目 ID 2.1.2 content 【基本描述】 内容页发布,该标签表示内容对象 【使用范围】 内容页 【参数说明 】 无 【属性说明 】 为 content 对象列表, 属性详见对象属性说明章节 【使用示例】 { content .title} 获取 内容的标题 2.1.3 pu 【基本描述】 分页标签 【使用范围】 无限制 【参数说明 】 无 ECMS V1.0 网站内容管理系统模版标签说明书 第 6 页 【属性说明 】 pagesize 每页的 记彔数 pagecount 一共有多少页 totalcount 总的 记彔 数 start 当前 开始 条目 编号,从 0 开始 end 当前结束条目 编号 currentpageno 当前 处亍第几页,从 1 开始 filepath 页面路径,如 /list/ filename 页面名称 , 如 index filetype 页面类型,如 shtml pageInfo 分页导航条信息对象 first 首页 Item 对象 last 末页 Item 对象 prew 上页 Item 对象 next 下页 Item 对象 filename 同 pu 下的属性 filetype 同 pu 下的属性 filepath 同 pu 下的属性 Separator list 分页间隔符号,如 ” -” Item 对象说明 boolean isenable 是否可用 ECMS V1.0 网站内容管理系统模版标签说明书 第 7 页 String url 当前页地址,只包含文件名含后缀 boolean isnowpage 是否是当前页 int id 页面编号 【使用示例】 获取总页数 { pu .pagecount} 2.1.4 list 【基本描述】 列表页发布时,如果自动加载数据,则该对象有数据 【使用范围】 列表页 【参数说明 】 无 【属性说明 】 content 对象的 List 对象,可以迭代获取内容 【使用示例】 {item.id} //内容 ID 2.2 调用型 标签 这类标签基本没有使用范围限制,可以在栏目模板,内容模板,和引用模板里使用。 ECMS V1.0 网站内容管理系统模版标签说明书 第 8 页 2.2.1 cms. getContent 【基本描述】 获取指定内容对象 【参数说明 】 contentid 内容 ID 【 返回说明 】 返回对象 content, 属性详见对象属性说明章节 【使用示例】 {item.title} 获取文章 ID 为 1578 的标题 2.2.2 cms. getSortList 【基本描述】 获取所有的分类对象 【参数说明 】 无 【 返回说明 】 sort 对象的 List 对象,可以迭代获取内容 【使用示例】 ECMS V1.0 网站内容管理系统模版标签说明书 第 9 页 {item.id} 2.2.3 cms. getSiteConfigValue 【基本描述】 获取 网站配置的值 【参数说明 】 codeStr 配置的代码,字符串 【 返回说明 】 String 对象 【使用示例】 2.2.4 cms. getTags 【基本描述】 获取指定 标签类别 【参数说明 】 start 开始的记彔位置, 0 开始 num 取记彔的条数 dir 排序的属性名 addtime 事件, weight 权重 ECMS V1.0 网站内容管理系统模版标签说明书 第 10 页 sort 排序模式 asc 升序 desc 降序 shuffle 是否随机打乱, 0 丌打乱, 1 打乱 【 返回说明 】 内容对象的 List 对象,可以迭代获取内容 ,对象具体说明见【 2.4 标签对象属性说明】 【使用示例】 {item.name} //标签的名字 2.2.5 cms. getColumn 【基本描述】 获取栏目对象 【参数说明 】 columnid 栏目 ID 【 返回说明 】 返回对象 column,属性详见对象属性说明章节 【使用示例】 {item.name} 获取栏目 ID 为 1578 的 名称 ECMS V1.0 网站内容管理系统模版标签说明书 第 11 页 2.2.6 cms. getList 【基本描述】 获取指定栏目下的内容列表 【参数说明 】 columnid 栏目 ID start 开始记彔 标识 num 获取记彔数量 dir 可选, 排序的字段 sort 可选, 排序模式 asc 升序 desc 降序 【 返回说明 】 content 对象的 List 对象,可以迭代获取内容 【使用示例】 {item.id} 2.2.7 cms. getListLike 【基本描述】 获取指定栏目下的内容列表 ,递归子栏目内容 【参数说明 】 ECMS V1.0 网站内容管理系统模版标签说明书 第 12 页 columnid 栏目 ID start 开始记彔标识 num 获取记彔数量 dir 可选,排序的字段 sort 可选,排序模式 asc 升序 desc 降序 【 返回说明 】 content 对象的 List 对象,可以迭代获取内容 【使用示例】 {item.id} 2.2.8 cms. atTime 【基本描述】 时间转换标签 【参数说明 】 date Long 型参数,时间戳 at 字符串,转换后的时间格式。 【 返回说明 】 返回字符串对象 【使用示例】 ECMS V1.0 网站内容管理系统模版标签说明书 第 13 页 2.2.9 cms. segmentText 【基本描述】 对文本进行分词 【参数说明 】 source 需要分词的字符串 num 取词数量 sepeartor 分完 词后,词不词之间的间隔符 【 返回说明 】 返回字符串对象 【使用示例】 无 2.2.10 cms. subString 【基本描述】 字符串截取 【使用范围】 没有限制 【参数说明 】 ECMS V1.0 网站内容管理系统模版标签说明书 第 14 页 src 源字符串 length 需要的长度 suffix 后缀 ,通常是。。。 【 返回说明 】 返回字符串对象 【使用示例】 2.2.11 cms. isEmpty 【基本描述】 判断一个对象是否为空 【参数说明 】 value 基本数据类型 【 返回说明 】 返回 boolean 【使用示例】 无 2.2.12 cms. isNull 【基本描述】 判断一个对象是否 为 Null ECMS V1.0 网站内容管理系统模版标签说明书 第 15 页 【参数说明 】 value 基本数据类型 【 返回说明 】 返回 boolean 【使用示例】 无 2.2.13 cms. getString 【基本描述】 获取字符串,如果字符串为空,则会返回参数默认值 【参数说明 】 value 字符串 1 defalut 字符串 2 【 返回说明 】 如果 value 为空或者 null,则返回 defalut,反之返回 value 【使用示例】 无 2.2.14 cms. getLong 【基本描述】 获取 Long,如果 参数 1 为空,则会返回参数默认值 【参数说明 】 ECMS V1.0 网站内容管理系统模版标签说明书 第 16 页 value 字符串 1 defalut 字符串 2 【 返回说明 】 如果 value 为空或者 null,则返回 defalut,反之返回 value 【使用示例】 无 2.2.15 cms. atContent 【基本描述】 对内容进行格式化 ,正文内容再输出时需要使用该标签进行格式化。 【参数说明 】 source 需要 格式化的字符串 【 返回说明 】 返回字符串对象 【使用示例】 无 2.2.16 cms. getUser 【基本描述】 获取指定 用户对象 【参数说明 】 ECMS V1.0 网站内容管理系统模版标签说明书 第 17 页 userid 用户 ID 【 返回说明 】 返回对象 user,属性详见对象属性说明章节 【使用示例】 无 2.2.17 cms. getFileSize 【基本描述】 获取指定用户对象 【参数说明 】 size Long 型,文件大小 【 返回说明 】 返回对象 字符串,根据文件的大小格式成带 B, K, M, G 的字符串 【使用示例】 无 2.2.18 cms. wordExist 【基本描述】 判断 指定 的词在字符串中是否包含 【参数说明 】 src 源 字符串 ECMS V1.0 网站内容管理系统模版标签说明书 第 18 页 wordsperator 源字符串单词的间隔符号 word 目标单词 【 返回说明 】 Boolean 【使用示例】 无 三. 标签 对象属性 说明 3.1 column Long id; String name; String alias; Long parentid; Long type; String metatitle; String metadesc; String metakeyword; String adduser; Long addtime; Long ordernum; Long columnTemplate; String columnRule; Long columnPagesize; Long contentTemplate; String contentRule; Long contentPagesize; String smallpicPixels; Long autogenSmallpic; String waterpic; Long autogenWaterpic; String bigpicPixels; Long bigpicMaxsize; String bigpicType; ECMS V1.0 网站内容管理系统模版标签说明书 第 19 页 Long commentTemplate; String commentRule; Long commentPagesize; Long needPublish; Long autoLoadData; String publishurl; Long rootSortid; String referurl; 3.2 content Long id; Long columnid; String title; String subtitle; String shorttitle; String author; Long status; String sort; String summary; String content; Long ordernum; String refername; String referurl; String keyword; Long hits; Long addtime; String adduser; Long deleteflag; Long ispublished; String publishurl; Long publishtime; String smallpic; String outerurl; String bigpic; String attach; Long adduserid; String statusDesc; Long attachSize; Long topIndex; Long topColumn; Long topSpecial; Long kind; ECMS V1.0 网站内容管理系统模版标签说明书 第 20 页 Long Del; Long price; Long hitsComment; Long hitsDownload; Long hitsFavor; String dc1; String dc2; String dc3; String dc4; 3.3 sort Long id; String name; Long pid; String composeurl; Long template; Long pagesize; Long ordernum; String publishurl; Long needPublish; Long autoLoadData; String rule; 3.4 tags 、 Long id; String name; Long weight; Long addtime; 3.5 special 、 Long id; String name; Long template; Long pagesize; Long ordernum; Long integral; ECMS V1.0 网站内容管理系统模版标签说明书 第 21 页 Long pid; Long needPublish; Long autoLoadData; String rule;