多客内容管理系统-DKCMS-模板引擎

dkCms 模板

1.模板使用

1.1 切换模板

image

点击『使用此模板』提示切换成功，即可完成模板切换

1.2 获取新模板

下载模板后，部署在dkcms template 目中，点击上图中『刷新列表』按钮，如果模板符合系统要求，即可加载成功。

2.定制模板

2.1 模板的加载机制

template目录下，每个子目录，即可成为一个独立的模板。
同时，目录中必须包含 tpl.info 文件，文件中包含如下信息：

name:dk-blog 极简1号
author: dkcms
authorInfo: dkcms 模板小组
description:参考 https://hyunseob.github.io/ 简洁模板
snapshot:
type:enjoy
tag:个人博客,blog,信息门户

dkCms 启动完成后，或管理员点击了『刷新模板』按钮后，系统会重新扫描template 目录下子目录，并解析 tpl.info 文件，保存为系统模板清单。

同时，系统维持了 currentTemplate 变量，保存了当前使用模板的模板路径，即模板所在目录的目录名。

其中，type 可选值为 thymeleaf 和 enjoy。默认值为thymeleaf。

2.2 模板渲染引擎

当静态页生成时，或用户预览某内容时，模板引擎被实例化，并渲染对应的模板，输出到对应的输出流。

渲染过程中，Render 根据当前渲染对象，确定模板名称，并组装数据。
Render 根据模板名，和currentTemplate，组装模板文件最终路径。
Render 根据模板的type值，选择实例化 thymeleaf 引擎，或者 enjoy模板引擎。调用模板渲染机制，获得渲染结果。
Render 根据当前任务是『预览』还是『静态化』，选择将渲染结果，输出到 HttpServletResponse.getWriter 或者 FileWriter 中。
渲染流程结束
渲染流程，统一封装在DKCmsRenderWrapper 中，将两种模板引擎，封装为统一的操作流程。
某个单一渲染流程，由单独一个 DKCmsRenderContext 来贯穿。Context 保存了当前渲染任务的：目标页面、模板信息、变量信息、静态化参数，保存了渲染所需全部信息。
一个 DKCmsRenderContext 实例，唯一确定了一个渲染任务，为渲染全流程提供参数支撑。

2.3 dkcms页面类型

全部渲染页面，被抽象为一下几种。
每种类型，对应了

一组固定的模板变量
一组固定的模板定位方式
一组固定的渲染流程

public enum DkCmsRenderPageType {
    SITE_HOMEPAGE,
    CATEGORY_HOME,
    CATEGORY_LIST,
    CATEGORY_ARTICLE,
    SINGLE_PAGE,
    SITE_MAP,
    ARTICLE_LIST_BY_TAG,
    SEARCH_RESULT;
   }

2.4 dkcms模板标签

dkcms提供了大量方便使用的模板标签，可以及其方便的展示内容。标签在 tymeleaf 模板和 enjoy模板中的名称保存一致，参数名保持一致。由于模板的具体限制，细节上个别不同。
标签详细讲解参考：dkcms模板定制

dkcms模板标签清单

模板标签	用途
articleList	内容列表
articleDetail	内容详情
articleRank	各类特定内容列表，热门，推荐，最新等
articleRelevant	相关类型
articleUrl	输出某一格内容的url，能在预览和静态页面中输出正确的内容，避免模板中写固定url
-	-
categoryList	栏目列表
categoryDetail	栏目详情
categoryUrl	输出某一栏目的url，能在预览和静态页面中输出正确的内容，避免模板中写固定url
-	-
tagArticle	按标签拉取内容列表
tagList	标签列表，读取全部标签
-	-
pageList	读取全部单页面
pageUrl	输出某一单页面内容url，能在预览和静态页面中输出正确的内容，避免模板中写固定url
-	-
commentList	最新评论数据
-	-
getSetting	读取所有设置项
ad	广告位
breadcrumb	面包屑导航
mianbaoxie	同上
pageNav	分页，页面中必须调用过articleList 才有效
homePageUrl	首页地址，能在预览和静态页面中输出正确的内容，避免模板中写固定url

2.4.1 enjoy 模板支持如下模板指令

  ENJOY_ENGINE.addDirective("getSetting", DirectiveGetSetting.class);


        //@Deprecated
        ENJOY_ENGINE.addDirective("contentList", ArticleList.class);

        ENJOY_ENGINE.addDirective("articleList", ArticleList.class);
        ENJOY_ENGINE.addDirective("articleDetail", ArticleDetail.class);
        ENJOY_ENGINE.addDirective("articleRank", ArticleRank.class);
        ENJOY_ENGINE.addDirective("articleRelevant", ArticleRelevant.class);
        ENJOY_ENGINE.addDirective("articleUrl", ArticleUrl.class);

        ENJOY_ENGINE.addDirective("ad", Ad.class);
        ENJOY_ENGINE.addDirective("breadcrumb", Breadcrumb.class);
        ENJOY_ENGINE.addDirective("mianbaoxie", Breadcrumb.class);
        ENJOY_ENGINE.addDirective("pageNav", PageNav.class);
        ENJOY_ENGINE.addDirective("homePageUrl", HomePageUrl.class);

        ENJOY_ENGINE.addDirective("categoryList", CategoryList.class);
        ENJOY_ENGINE.addDirective("categoryDetail", CategoryDetail.class);
        ENJOY_ENGINE.addDirective("categoryUrl", CategoryUrl.class);

        ENJOY_ENGINE.addDirective("tagArticle", TagArticleList.class);
        ENJOY_ENGINE.addDirective("tagList", TagList.class);


        ENJOY_ENGINE.addDirective("pageList", SinglePageList.class);
        ENJOY_ENGINE.addDirective("pageUrl", SinglePageUrl.class);

        // map param
        ENJOY_ENGINE.addDirective("commentList", CommentList.class);

2.4.1 thymeleaf 模板中支持如下模板指令

  Set processors = new HashSet<>();
        processors.add(new StandardXmlNsTagProcessor(TemplateMode.HTML, dialectPrefix));
        processors.add(new CategoryList(dialectPrefix));
        processors.add(new CategoryDetail(dialectPrefix));
        processors.add(new ArticleList(dialectPrefix));
        processors.add(new ArticleRank(dialectPrefix));
        processors.add(new ArticleDetail(dialectPrefix));
        processors.add(new Navbar(dialectPrefix));
        processors.add(new PageNav(dialectPrefix));
        processors.add(new Tag(dialectPrefix));
        processors.add(new TagList(dialectPrefix));
        processors.add(new SinglePageUrl(dialectPrefix));
        processors.add(new SinglePageList(dialectPrefix));
        processors.add(new CategoryUrl(dialectPrefix));
        processors.add(new ArticleUrl(dialectPrefix));
        processors.add(new HomePageUrl(dialectPrefix));

2.5 二次开发增加标签

参考：dkcms模板定制

3.模板社区

3.1 下载和安装新模板

3.2 发布新模板

3.2 模板市场

模板定制二次开发开源项目技术支持商务合作 https://dkcms.cc