网站内容管理系统建设手册.doc

Lerx网站内容管理系统模板建设手册Lerx网络科技2012-11-12一、概述利用Lerx网站内容管理系统（以下简称：Lerx）建立的网站展现的内容其实都是模板的内容。Lerx本身并不主动输出HTML代码，这是Lerx的基本原则之一，即网页右键查看到的网站源代码全是模板代码即是用户自已的代码，包括Javascript代码。因此，模板对于Lerx来说至关重要，设计一份精致的模板会直接影响到网站的美观与性能。Lerx可以很方便的将模板导入导出，导出时Lerx模板将被写入XML文件。当系统出现重大升级时，模板与系统可能出现冲突，可根据经验修改XML文件来修复模板文件。Lerx采用标签来定义变量，模板的设计应以常变化的数据用标签来替代，一些不常变化的数据如导航菜单等等则应直接用HTML来展示，在V2版本中，一些不必要的功能被直接抛弃，如上面所提的导航菜单，这样做的目的是为了加快网站执行速度，不让系统去处理那些并不一定需要处理的功能。Lerx内置了大量数据接口，可以在网页用利用AJAX或JS来调用。二、操作方法1.后台选择相应的风格模板2.点击需要修改的风格模板右边的编辑。 3.在模板的变量列表中选择需要修改的变量，点击右边的详情进行查看或编辑。4.修改变量后，点击提交即可。注意：修改后将立即生效。请注意做好模板的备份工作，以防无法恢复。在操作大容量代码时，建议将变量内容复制进其它文本编辑软件如记事本、EditPlus或UltraEdit等软件进行处理完毕后再粘贴进来进行提交。二、约定Lerx以$data$的格式来存储标签。data是标签名称，中间可能有英文半角逗号（,）或其它一些特定字符。据此，我们进行以下约定：标签：指类似于$data$形式的字符串，该字符串在系统执行时会被相应的数据取代。模块变量：指各模块中的存储的各键的名称，如下图。三、建议1.应使用现有的模板复制为新模板后再修改，以免一些模块变量被漏写。2.在修改模板之前，应将模板复制一份或导出，以防修改错误无法还原。3.可以参考现有模板的代码来改写新模板。4.应首先设计通用部分及Public子模块的代码四、模板说明及执行顺序V2版本模板一般分为通用模块和各子类模块（抽奖系统由于较简单，未设定子模块）。 以下说明以门户模板为例。1.执行顺序 前台系统执行时，除play.action及上传和附件修改这几个独立页面外，其它页面均首先会读取public模块的htmlTemplate模块变量。这一模块如果为空，将输出为空白，所以这一模块变量内容至少包含标签$htmlBody$。大多数网站有html首尾都差不多，所以官方发布的模板为了减少模板代码，将$htmlBody$定义为html的中的内容。 然后根据页面的不同，会读取相应的子类模块。比如，首页会读取index模块，文章页会读取article模块等等。 在子模块中，如果未定义模块变量，将自动读取public模板的模块变量及通用设置中的模块变量。比如：如果网站的css是相同的，那就可以放置在public的css标签中，所有页面将都读取这个css。执行流程见下图。s2.每个子模块设立了specialCode1-4四个标签，用于放置该页面的特殊代码。 例：网站设计时大体css是相同的，但首页、分类页、文章页的css会有自己独特的部分。利用specialCode1-4可以轻松解决这个问题。解决方法：将完全公用的css代码放置在public的css区域，再在这css代码中插入$specialCode1$标签，然后在相应的页面的specialCode1变量中输入特有的css代码。比如首页就在index模块的specialCode1中输出首页特有的css代码。 3.通用设置中设定了publicCode1-4，可以在任何子模块中进行引用。如，上例中的可以反过来进行，或者其它一些通用的代码。五、模块变量及标签详义系统性标签$charset$字符集，从配置文件resourcesApplication_zh_CN.properties中获取$fullSiteName$站点全称$shortSiteName$站点简称$siteName$站点名称，智能标签，以简称优先获取$welcomeStr$站点欢迎词$siteUrl$站点Url，不含http前缀$keyWord$网站关键字$description$网站说明性文字$actionErrors$错误信息$mainTitle$当前应用标题$cssStyle$css代码$htmlBody$HTML主代码$top$顶部代码$footer$底部代码$searchAreaCode$搜索区域代码$key$搜索关键字$webPageTitle$页面标题$locationSplitStr$网站位置标识符$publicCode1-4$共用代码1-4，如$publicCode1$指共用代码1$specialCode1-4$模块指定代码1-4$memberPanel$用户面板代码$contextPath$当前应用路径，应在所有路径如资源文件前加此标签$contextHost$当前应用URL$year$服务器当前时间的年份$htmlRoot$HTML文件的根目录$executeTime$页面执行时间$lerxCmsCurrentVersionNumber$当前Lerx的版本（项目编号）$lerxCmsCurrentVersionBuild$当前Lerx的版本（建立时间）以上标签会在页面执行结束之前被替换成相应的字符串。其中，$contextPath$的使用会大大减少网站资源文件的错误率，在网站迁移时会更有用。门户通用1. styleName该标签为系统性标签，为模板的名称。修改模板的名称即修改此值。注：系统性标签在模板中并无实际应用效果。2. author模板作者，系统性标签。3. description模板说明，系统性标签。4. locationSplitStr网站位置分隔符。默认为-，仅管定义为网站位置分隔符，实际使用中也可以作为其它用途。如下图。参考： - 或 等等5. hrefLineFormatStrOverAll默认的数据行格式。一般如果在模板中没有找到对应的数据行格式，就采用本格式。参考：$title$在该标签中存在多个内置标签。注：内置标签指系统会根据标签内容自动生成相应的数据，切不可随意修改内置标签格式及内容。$id$指数据的ID值。$href$是当前数据的链接URL地址。$title$指数据显示文本。一般为文章的标题或精简标题。此标签为智能内置标签，系统会根据文章的主标题和精简标题来自动生成。生成规则为：精简标题优先及根据栏目限定的标题长度以为文章中的标题突出属性来自动生成。$originalTitle$文章原始标题。$hrefLine$该内置标签为简化标签，可直接生成title。$alt$指提示文本，即鼠标移动到当前位置时的弹出提示文本，该标签在标题长度不足时会自动显示，标题完整时则无。$addTime$是指数据的时间即文章的新增时间。$addTimedateFormat$自定义时间格式。以2012年10月8日15时27分40秒举例：$addTimeyyyy-MM-dd$ 效果： 2012-10-08$addTime MM-dd$ 效果： 10-08$addTimeyyyy-MM-dd hh:mm:ss$ 效果： 2012-10-08 15:27:40$addTimeyyyy-M-d hh:mm $ 效果： 2012-10-8 15:27$member$发布会员$author$作者$authorUrl$作者网址$authorEmail$作者Email$authorDept$作者单位$mainImg$标题图片URL$thumbnail$缩略图URL$imageUrl$图片URL，该标签为智能标签，以缩略图优先的原则显示。全无则取系统内置默认图URL。$mainImgExplain$图片说明文字$views$文章被浏览次数$synopsis$文章简介。该标签智能标签，当没有输入简介时，将将系统定义的截取长度自动生成无格式代码的文字。$editCode$数据行编辑代码$state$文章审核状态标记代码。6. hrefLineFormatWithSnStrOverAll默认的带序号数据行格式。一般如果在模板中没有找到对应的数据行格式，就采用本格式。参考hrefLineFormatStrOverAll，本标签增加了一个内置智能标签$sn$用于显示序号。7. mediaPlayCode1-3播放器1-3代码。该标签存在内置标签$mediaUrl$，指媒体文件的URL地址。Lerx可以提供三种播放器的代码。可以任意设定其中的某一播放器代码，如1中输入flv格式的播放器代码，2输入wmv格式的播放器代码，3输入rm格式的播放器代码。在资源文件resourcesStyle_zh_CN.properties中，有三个键值对进行指定。需要用户根据这里相应的播放器代码设定来指定显示名称。默认设置为：lerx.mediaCodeFormat1=flvlerx.mediaCodeFormat2=wmvlerx.mediaCodeFormat3=rm8. mediaPlayOuterLayerCodeForArtPage文章页播放动作代码，媒体的播放形式有两种，一种是在当前文章页进行播放（一般只有一个媒体文件），一种是利用附件形式打开新窗口进行播放（见下一变量）。内置标签：$playerMainBody$指播放器代码，即mediaPlayCode1-3中的代码。$tid$指文章的id。9. mediaPlayOuterLayerCodeForAttaPage附件页播放动作代码。注意，这里是模板中一个完整的HTML文本。即整个网页的所有HTML均需输入。10. attachmentLineShowForImg、attachmentLineShowForDownload、attachmentLineShowForPlay附件显示格式。一共三种，图片、下载、播放。内置标签：$attaURL$附件URL$attaTitle$附件标题$attaID$附件ID$title$附件智能标题11. lineBlockFormat行区块格式。内置系统标签$data$，此标签不可以改变。如：$data$12. columnBlockFormat列区块格式。内置系统标签$data$，此标签不可以改变。如：$data$13. publicCode1-4定义了四个共用代码，可以在任意模块的HTML或CSS等变量中调用。14. customFormatCode1-8提供了八种数据显示格式。可以在首页或分类页根据需要编写后插入对应的标签使用。也可以利用AJAX动态使用。如：在首页利有第3种格式显示栏目ID为16的数据，可插入如下标签：$customFormatIndex,16,3$15. ajaxStrFormatAJAX提示数据格式。该变量主要用于数据检测，如默认模板中用户注册时输入用户名时系统进行实时检测。内置标签：$resultIcoUrl$ 检测结果状态显示图标URL$resultMsg$检测结果提示文本16. resultPageCode处理结果页代码。该变量需完整HTML文本代码。当一些操作成功或失败后，会将此变量的代码完整输出后再进行跳转相应的页面。如登录成功或登录失败。内置系统性标签：$waitingTime$停留时间。有两个值，短停留和长停留，根据相应的操作，系统会自动进行短或长停留。停留的时间数值在配置文件resourcesApplication_zh_CN.properties中指定。lerx.waitingTimeForPageJumpLong=5/长停留 时间为5秒钟lerx.waitingTimeForPageJumpShort=1/短停留 时间为1秒钟$returnUrl$停留后跳转的URL，该值为系统自动判别。$resultMsg$提示文本。系统自动处理。具体文本将读取配置文件resourcesMessage_zh_CN.properties中的内容进行转码后输出。17. selectOptionLoopCode下拉列表框中的option循环代码。由于Lerx无主动性HTML输出，所以利用本变量来生成下拉列表框的数据。内置系统性标签：$selectState$选中状态。$disabledStr$状态$value$值$display$显示文本18. lastArticleForwardCode、 nextArticleForwardCode上一篇、下一篇格式。内置标签参见hrefLineFormatStrOverAll19. eyeCatchingCode醒目标记格式。如：网站定义醒目格式为加粗,变量内容如下：$title$网站定义字体为红色，则变量内容如下：$title$20. passedStr文章被审核后管理文本。需在23.threadAjaxShowStr中加入标签$passStr$。如代码为： 编辑 $soulStr$ $topOneStr$ 显示为：内置系统标签：$tid$文章ID$soul$精华或推荐的处理状态。$soulStr$精华或推荐的显示文本，读取配置文件$topOne$头条的处理状态$topOneStr$头条的显示文本，读取配置文件21. noPassedStr文章未被审核的管理文本。需在23.threadAjaxShowStr中加入标签$passStr$。如代码为：本文尚未审核！请审核审核并推荐编辑显示为：内置系统标签同上一条。22. noPassedAltStr文章未被审核时被访问的显示内容。当有管理权限时，访问该文章会正常访问并有上述编辑区内容。当没有管理权限时，访问该文章将直接输出本变量内容。23. threadAjaxShowStr文章实时数据显示文本。如：发布：$member$ 审核：$passer$ $passStr$ 被浏览数：$views$ 上次浏览IP：$lastIP$其中$passStr$将被20或21变量替换。内置标签：$member$发布会员名$passer$审核会员名$views$被浏览次数$lastIP$上次浏览IP24. statCode网站统计区域代码。内置标签：$articlesPassed$审核通过的文章数