标签使用说明

- 前言
本系统所使用的标签延续freemarker标签或基于freemarker标签自定的标签,如下分别对原有标签及自定义标签进行说明。如有未说明事项都延续freemarker自身用法。

freemarker模板使用说明

- 标签使用说明
1、freemarker自带支持多种标签开始符号和结束符号,如<> 、[]等。本文档推荐使用 [],后续文档教程中默认使用[],不作特殊说明

2、自定义标签返回结果可能为对象、集合等,为了更好的区分与识别返回结果类型,自定义开发时做了特殊的返回key对应,同时也要求在是用模板获取自定义标签数据时,需要用对应标签的key。系统已支持的的所有自定义标签默认为(具体如何辨别,详见各标签中的返回对象类型,如需要更改,请参考 自定义标签开发教程中第三点特殊说明):
对象(Object): tag_bean
集合(Array) : tag_list
分页对象 : tag_pagination

3、自定义标签区别于freemarker自带标签的使用的在于将 # 替换成 @,如 [@position_page];各标签支持参数请参标签说明

注意:在同一模板中不能同时使用多种开始和结束符号

通用对象说明

栏目模板页面上可直接访问 对象 channel
示例:${channel.url!} 关于栏目对象属性可参考 栏目详情

内容模板页面上可直接访问 对象 content
示例:${content.title!} 关于内容对象属性可参考
内容详情
${txt!}当前访问正文
截取文本n个字符
[@text_cut s=a.title len=’19’ append=’…’/]
pagination 正文分页对象 使用样例如下

[#assign p=tag_pagination/]
[#assign number=p.number + 1/]

<div[#if pageClass??] class="${pageClass}"[/#if][#if pageStyle??] style="${pageStyle}"[/#if]>
共${p.totalElements}条记录 ${number}/${p.totalPages}页
[#if p.first] 首页 上一页[#t/]
[#else] 首页 上一页[#t/]
[/#if]
[#if p.last] 下一页 尾页
[#else] 下一页 尾页
[/#if]
第<select onChange="if(this.value==1){location.href=encodeURI('${hrefFormer}${hrefLatter}')}else{location.href=encodeURI('${hrefFormer}_'+this.value+'${hrefLatter}')}this.disabled='disabled'">
[#list 1..p.totalPages as i]
<option value="${i}" [#if number==i]selected="selected"[/#if]>${i}</option>
[/#list]
</select>页

任意页面可访问对象 site user 主要说明如下

参数 类型 示例值 说明
id number 1 站点ID
description string 站点描述
seoDescription string seo描述
seoKeyword string seo关键字
seoTitle string seo标题
domain string 域名
name string 名称
systemIco string 系统标识图ICO 地址
globalConfig string 全局配置对象
- -› memberOpen boolean 是否开启会员功能
- -› memberRegisterOpen boolean 是否开启会员注册功能
- -› memberRegisterCaptcha boolean 是否会员注册需要图形验证码
参数 类型 示例值 说明
id number 1 用户ID
username string 会员账户
name string 姓名
nickname string 昵称
email string 邮箱
phone string 电话
gender string 性别 1 男 2 女 3 保密
birthday string 生日
enabled string 是否启用 false-否 true-是
headImgUrl string 会员头像url
headImgId string 头像图片资源id
exp string 成长值
levelName string 会员等级名称
levelImageUrl string 会员等级图片
admin boolena 是否管理员
参数 类型 示例值 说明
name number 1 名称
title string 标题
description string 描述
keywords string 关键词
customerServiceMobile string 客服电话
customerServiceEmail string 客服邮箱
address string 地址
areaDistrict string 显示地区(区)
areaCity string 显示地区(市)
searchKeyWords string[] 搜索关键词数组
hotWords string 搜索热词
logo string logo
loginAndRegLogo string 注册登录页log
userRegisterAgreement string 用户注册协议
area Array 地区数据
copyright string 版权信息
wechatQRcodeUrl string 微信公众号图片
miniprogramQRcodeUrl string 微信小程序图片
qqOpen boolena qq登录是否开启
wechatOpen boolena 微信登录是否开启
weiboOpen boolena 微博登录是否开启

栏目列表

参数 类型 必填 示例值 说明
siteId number 1 站点id
parentId number 1 父级id
display boolean false 是否显示
参数 类型 示例值 说明
id Number 11 id
name string 新闻 名称

详细可参考内容详情对象
栏目详情

栏目详情

参数 类型 必填 示例值 说明
id number 1 栏目id
siteId number 1 站点id
path string 1 栏目路径
参数 类型 示例值 说明
id number 栏目id
name string 新闻 栏目名称
url string URL
urlWhole Boolean URL绝对地址
description string 新闻 栏目描述
previewUrl string 预览URL
realDescription string 栏目描述
title string SEO标题
descriptions string SEO描述
keywords string SEO关键字
deep int 栏目所处层级深度
pageSize int 栏目分页数量
iconUrl string 栏目图片路径
realDisplay Boolean 是否显示
realLinkTarget Boolean 是否新窗口打开
realContribute Boolean 是否允许投稿
txtPageCount int 栏目富文本数量
isListChannel int 是否列表栏目
topChannel Object 栏目所属顶层栏目
parent Object 栏目所属父栏目
nodeList List<Object> 顶层栏目到自身集合
childAll List<Object> 栏目自身所有子栏目集合
- -› id string 栏目ID
- -› name string 栏目名称
realTxts List<Object> 栏目富文本对象集合
- -› txtCount int 富文本分页
- -› attrKey string 名称
- -› attrTxt string 富文本值
model Object 所属模型
- -› modelName string 模型名称
- -› id string 模型ID
site Object 所属站点
- -› name string 站点名称
- -› id string 站点ID
channelAttrs Object 自定义属性
- -› attrName string 扩展字段名
- -› attrValue string 扩展字段值(普通类型,组织、地址、城市、资源类型除外的字段)
- -› attrType string 数据类型(对应模型字段数据类型 值有组织organize 邮箱email 真实姓名 realname 性别 sex 地址 address 传真fax 城市city 身份证identity 生日birthday 座机phone 手机 mobile 年龄age 多图multiImageUpload 音频audioUpload 视频videoUpload 附件fileUpload 单图 imageUpload 富文本 ueditor)
- -› address string (地址类型)省市县+详细地址
- -› cityArea string (城市city类型)省市
- -› resUrl string ( 单图、视频、附件、单图资源路径)
- -› resAlias string 资源名称
- -› orgName string (组织类型)组织名称
- -› orgId int (组织类型)组织id
- -› channelAttrRes Object (多资源)资源集合
- -› - -› description string 描述
- -› - -› resUrl string 资源地址
- -› - -› resAlias string 资源名称
- -› - -› secretName string 密级名称
attr Map 自定义字段属性Map
- -› - -› xxxx string 字段名称(xxxx是模型字段里面写的标签名称)【可能为空需要判断对象是否为空】
- -› - -› xxxx -› **- yyyy string 字段名称(yyyy等同于 channelAttrs 下级属性)

内容分页

参数 类型 必填 示例值 说明
channelId Array false [1,2] 栏目id集合
tagId Array false [2,3] tag词id集合
channelPath Array false [‘/aa’,’/ff’] 栏目路径集合
siteId Array false [2,4]] 站点id集合
typeId Array false [1,3] 内容类型id集合
title string false 1 标题
new boolean false false true 新内容
isTop boolean false true true 置顶
timeBegin Date false 开始时间
timeEnd Date false 结束时间
excludeId Array false 1 排除id集合
orderBy number false 1 1创建时间降序2创建时间升序3总访问数降序4总访问数升序5月访问数降序6月访问数升序7周访问数降序8周访问数升序9日访问数降序10日访问数升序11总评论数降序12总评论数升序13月评论数降序14月评论数升序15周评论数降序16周评论数升序17日评论数降序18日评论数升序19总点赞数降序20总点赞数升序21月点赞数降序22月点赞数升序23周点赞数降序24周点赞数升序25日点赞数降序26日点赞数升序27发布时间降序28发布时间升序29置顶降序30id升序31id降序32日下载降序33周下载降序34月下载降序35总下载降序
pageNo number true 1 内容id
count number false 1 数量

|参数|类型|示例值|说明|
对象格式参考详情
内容详情

内容列表

参数 类型 必填 示例值 说明
ids number false 1 内容id集合
channelId Array false [1,2] 栏目id集合
tagId Array false [2,3] tag词id集合
channelPath Array false 1 栏目路径集合
siteId Array false 1 站点id集合
typeId Array false 1 内容类型id集合
title string false 1 标题
new boolean false 1 true 新内容
isTop boolean false 1 true 置顶
timeBegin Date false 1 开始时间
timeEnd Date false 1 结束时间
count number false 1 数量
excludeId Array false 1 排除id集合
orderBy number false 1 1创建时间降序2创建时间升序3总访问数降序4总访问数升序5月访问数降序6月访问数升序7周访问数降序8周访问数升序9日访问数降序10日访问数升序11总评论数降序12总评论数升序13月评论数降序14月评论数升序15周评论数降序16周评论数升序17日评论数降序18日评论数升序19总点赞数降序20总点赞数升序21月点赞数降序22月点赞数升序23周点赞数降序24周点赞数升序25日点赞数降序26日点赞数升序27发布时间降序28发布时间升序29置顶降序30id升序31id降序32日下载降序33周下载降序34月下载降序35总下载降序
id number false 1 内容id
relate number true 1 1手动关联内容2手动关联加tag词关联3tag词关联内容

|参数|类型|示例值|说明|
对象格式参考详情
内容详情

内容详情

参数 类型 必填 示例值 说明
id number 1 内容id
next number 0 1 下一页 0 上一页
channelId number 1 栏目id
参数 类型 示例值 说明
id number 1 内容id
title string 标题
url string 访问地址
urlWhole string 访问绝对地址
titleIsBold boolean true 内容标题是否加粗 true加粗
titleColor string #666666 内容标题的颜色
newContentUrl string /u/t/dd.jpg 是新内容的显示用的图标
shortTitle string #666666 简短标题
top boolean true 是否置顶 true 置顶
releaseTime date 2019-07-30 14:58:44 发布时间
views number 1235 总访问量
comments number 88 总评论量
ups number 45 总点赞量
downs number 33 总点踩量
downloads number 22 总下载量
url string /default/content/1.html 访问地址
keyWord string 关键字
description string 摘要
target boolean true 新窗口打开链接(0-否 1-是)
releaseTimeString string 刚刚 发布时间
iconUrl string /u/t/taa/d.jpg 资源路径
author string 作者
issueOrg string 发文-机关代号
issueYear string 发文字号-年份
issueNum string 发文字号-顺序号
viewsMonth int 本月访问量
commentsMonth int 本月评论量
downloadsMonth int 本月下载量
upsMonth int 本月点赞数
downsMonth int 本月点踩数
viewsWeek int 本周访问量
commentsWeek int 本周评论量
downloadsWeek int 本周下载量
upsWeek int 本周点赞数
downsWeek int 本周点踩数
viewsDay int 本日访问量
commentsDay int 本日评论量
downloadsDay int 本日下载量
upsDay int 本日点赞数
downsDay int 本日点踩数
pdfUrl string 内容文库资源地址
source Object 来源对象
- -› sourceName string 来源名称
- -› sourceLink string 来源链接
- -› isOpenTarget string 是否新窗口打开
site Object 所属站点
- -› name string 站点名称
- -› id string 站点ID
- -› url string 站点首页地址
channel Object 所属栏目
- -› name string 栏目名称
- -› id int 栏目ID
- -› url string 栏目访问地址
model Object 所属模型
- -› modelName string 模型名称
- -› id string 模型ID
tagIds Array 内容关联tagId集合
tagNames Array 内容关联tag词集合
typeIds Array 内容关联类型集合
typeNames Array 内容关联类型名称集合
txts Array 内容富文本集合
contentAttrs Array 自定义字段属性
- -› attrName string 扩展字段名
- -› attrValue string 扩展字段值(普通类型,组织、地址、城市、资源类型除外的字段)
- -› attrType string 数据类型(对应模型字段数据类型 值有组织organize 邮箱email 真实姓名 realname 性别 sex 地址 address 传真fax 城市city 身份证identity 生日birthday 座机phone 手机 mobile 年龄age 多图multiImageUpload 音频audioUpload 视频videoUpload 附件fileUpload 单图 imageUpload 富文本 ueditor)
- -› address string (地址类型)省市县+详细地址
- -› cityArea string (城市city类型)省市
- -› resUrl string ( 单图、视频、附件、单图资源路径)
- -› resAlias string 资源名称
- -› resDuration int 音视频时长
- -› orgName string (组织类型)组织名称
- -› orgId int (组织类型)组织id
- -› channelAttrRes Object (多资源)资源集合
- -› - -› description string 描述
- -› - -› resUrl string 资源地址
- -› - -› resAlias string 资源名称
- -› - -› resType int 资源类型(1图片 2视频 3音频 4附件)
- -› - -› resSize string 资源大小
- -› - -› secretName string 密级名称
attr Map 自定义字段属性Map
- -› - -› xxxx string 字段名称(xxxx是模型字段里面写的标签名称)【可能为空需要判断对象是否为空】
- -› - -› xxxx -› **- yyyy string 字段名称(yyyy等同于 contentAttrs 下级属性)

tag分页

参数 类型 必填 示例值 说明
count number 1 数量
参数 类型 示例值 说明
id number id
tagName string 文明 tag词名称
refCounter number 22 引用内容数

搜索词列表

参数 类型 必填 示例值 说明
count number 5 查询数量
参数 类型 示例值 说明
id number 1 搜索词id
word string 国足 搜索词
iniChinese string gz 搜索词首字母
isRecommend boolean true 是否推荐
searchCount number 22 搜索次数

友情链接分类列表

参数 类型 必填 示例值 说明
count number 4 数量
参数 类型 示例值 说明
id number 1 友情链接分类id
typeName string www.jeecms.com 友情链接分类

友情链接列表

参数 类型 必填 示例值 说明
linkTypeId number 1 友情链接分类id
count number 1 条数
参数 类型 示例值 说明
id number 12 友情链接id
linkName string jeecms 友情链接名称
linkUrl Url http://www.jeecms.com 友情链接
remark string 我是备注 备注
linkTypeId number 22 友情链接分类id
linkTypeName string test 友情链接分类名称
resourcesSpaceData Object 资源对象
- -› url string /u/cms/www/201907/23183028i9yr.jpg 图片路径

模板资源文件、变量说明

模板文件夹
/WEB-INF/t/cms/www/default 其中www是站点目录 default是方案目录文件夹
模板资源文件夹
/r/cms/www/default 其中www是站点目录 default是方案目录文件夹
模板文件夹下子文件夹说明
channel 栏目列表文件
content 内容详情文件
index 首页

通用url对应模板规则
(/member/ /member- 前缀url都要求用户登录,未登录服务端会重定向到登录页)
${base}/tag.htm 对应模板文件 /tag.html
${base}/special-tag.htm 对应模板文件 /special/tag.html (-代表文件夹分隔)
${base}/member-center.htm 对应模板文件 /member/center.html(-代表文件夹分隔)
访问域名对应站点的首页模板
channel、content 模板需要在栏目那设置模板 查看模板的效果

特殊url对应模板
/login.html 登录页 对应登录url ${base}/login
/csi/login_csi.html 登录状态页 对应登录url ${base}/login_csi 注意登录状态页不可直接用include包含进来是需要动态load ${base}/login_csi 加载的(有静态页面的情况)

公共模板变量:
${base} url前缀,获取栏目内容url(${content.url!} 这种不需要加${base}/)
${$res} PC模板资源路径 对应的 /r/cms/www/default 其中www是站点路径 default是pc端方案路径
${mobileRes} 手机模板资源路径 对应的 /r/cms/www/mobile 其中www是站点路径 mobile是手机端方案路径
${user} 当前登录用户对象 ${user.username!} 获取当前登录用户名
${globalConfig} 全局配置对象

资源文件引用
${res} PC模板资源路径 对应 /r/cms/www/default/
${mobileRes} 手机模板资源路径 对应 /r/cms/www/mobile/

特殊说明
/member/ /member- 等需要用户登录交互类请求,如果不想重定向页面则需要新增header头 Redirect-Header 值为false

包含页面语法类似如下
[#include “../include/header.html”/]

内容页下载文库地址
/download/o_doc_download?contentId=${content.id}

/download/byContent?contentId=${content.id} 整个内容所有附件批量下载

/download/byField?contentId=${content.id}&field=字段名称 整个内容某附件字段所有附件批量下载

/download/byResId?resId=资源id 单附件资源下载