网站模版管理详细设计说明书.doc

.net网站内容管理系统网站模版管理详细设计文档.net网站内容管理系统网站模版管理(详细设计说明书)编写单位：中经网 网站制作部设计人员：贾慧版 本：1.0编写日期：2011/8/26 .net网站内容管理系统网站模版管理详细设计文档第一部分、引言1.1编写目的本说明书在目前已有的.net网站内容管理系统的基础上，对网站模版管理的各模块、程序分别进行了实现层面上的要求和说明。软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。1.2背景说明：A、 软件系统的名称: .net网站内容管理系统B、 任务提出者：实际使用的通用用户开发者：.net开发组C、 现有系统网站的后台还是比较功能还是比较实用的，经过很多客户的使用。它有它自己的优势。在通用的用户网站中，一般只使用到了文章信息管理功能，最多加上留言板、会员功能。至于网站的丰富的前台展示，完全是靠模版来实现的。现有系统在实际应用时，需要改动最多的就是前台模版页面及程序的改动。目前这部分工作在现有系统中，还只能是程序员能做。所以迫切需要开发一个方便用户自己进行修改网站模版的功能。1.3定义网页模板 ：网页模板在这里指的是网站页面模板，是当网站中有许多页面版式色彩相同的情况下，将其定义为网页模板，并定义其中部分可编辑，部分不可编辑，那么在利用网页模板制作其他页面时就会很方便，不易出错。这里我们称为普通网页模板。模块：又称构件，是能够单独命名并独立地完成一定功能的程序语句的集合（即程序代码和数据结构的集合体）。它具有两个基本的特征：外部特征和内部特征。外部特征是指模块跟外部环境联系的接口（即其他模块或程序调用该模块的方式，包括有输入输出参数、引用的全局变量）和模块的功能；内部特征是指模块的内部环境具有的特点（即该模块的局部数据和程序代码）。1.4参考资料相关的文件包括：A、 .net网站内容管理系统需求说明；B、 .net网站内容管理系统详细设计说明书；C、 .net网站内容管理系统概要设计说明书；D、 网站模版管理 原来的设计文档参考资料：Trs 网站内容管理系统 模版管理动易网站 论坛 模版管理 其他wcm网站内容管理系统等第二部分、总体设计2.1 功能概述本系统是可以支持多网站的。每个网站的风格、样式、排版都可以不同。当然多个网站也可以使用一样的风格、样式。一个网站的显示是由页面、样式表、js脚本及其他文件构成的。样式表控制这个网站的字体、色调等。页面是整个显示的布局、排版。页面又是由不同的模块组成的。网 站样式表 （css）页面 (aspx)样式表1 (css)样式表2 (css)页面1 (aspx)页面2 (aspx)页面3 (aspx)模块1 (ascx)模块2 (ascx)模块3 (ascx)模块1 (ascx)模块2 (ascx)模块3 (ascx)模块1 (ascx)模块2 (ascx)模块3 (ascx)脚本文件 (js)其他文件该系统为了两大部分：后台模版管理和前台内容展示。其中使用RewriteURL库来实现用户模版的选择展示，实现标准包括：1、前台内容展示A、工程类型：.net项目；B、工程名称：模版管理C、编译生成文件：dll形式D、引用的组件：RewriteURL库E、模版存放目录和文件：用户自定义目录名称和文件内容注：以上提供的是工具集合，具体用到的类都包含在里面2、后台模版管理：用户模板管理、启用模板配置、导出用户模板、导入用户模板。 2.2 软件结构 后台模板管理结构 网站模板管理网站模块管理网站页面管理网站样式管理Js文件管理其他文件管理添加、编辑、删除、复制 恢复默认、发布上传文件、删除文件、文件重命名新建目录、目录重命名（不能上传asp、aspx、acsx、js、exe、cs、css等类型的文件）生成、预览模板编辑、删除模板 第三部分、程序描述3.1 用户网站模版管理3.1.1 功能流程图 1、添加用户模版 2、 用户模版管理 3.1.2功能描述1、 添加用户模板a) 功能类型：添加数据b) 功能描述：添加用户网站模板c) 前提业务：登录成功d) 后继业务：用户模板管理e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m0）2、 用户模板管理a) 功能类型：查询数据b) 功能描述：显示查询结果c) 前提业务：登录成功d) 后继业务：模块管理、页面管理、样式表管理、js文件管理、其他管理、生成、预览等e) 功能约束：权限约束f) 约束描述：只能查询出本网站管理员录入的网站模板数据g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.1.3 界面设计1、 添加用户模板添加网站模板模板名称： *目录名称： *克隆模板： （可为空）添加 重置数据要求：添加网站模板时，目录名称只能是数字字母_的组合，克隆模板是一个下拉框，数据是从数据库里面当前用户已有的模板（当前用户添加的模板和默认模板）中选择。模板名称、目录名称为必填项。目录名称不能重复。添加数据时，将选择的克隆模板的全部数据记录复制一份保存到数据库中即可。2、 用户模板管理用户模板列表模板名称目录名管理操作生成预览用户模板1（已启用）User1编辑模板 删除模板模块管理 页面管理 样式表管理JS文件管理 其他文件管理已生成重新生成预览用户模板2User2编辑模板 删除模板模块管理 页面管理 样式表管理JS文件管理 其他文件管理未生成生成预览说明：a) 编辑模板时，已经生成的模板只能编辑模板的名称，不能在编辑目录名称了。b) 已生成的模板才可以进行其他文件管理的操作。c) 生成模板操作，将数据库里面的模板数据生成对应的文件数据。同时如果克隆模板已经生成了的话，需要提示用户是否将克隆模板目录下面的其他文件也复制过去。3.1.4 内部逻辑1、 添加用户模板 Template_Add.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m0,Session) = 0 没权限。提交后，判断此目录是否在数据库中已经存在了，若存在，提示。若添加数据成功，并且用户选择了克隆模板，将选择的克隆模板的全部数据记录复制一份保存到数据库中2、 用户模板管理 Template_Manage.aspx.cs判断用户是否已登录及其是否有操作权限：Common.IsPower(m0,Session) = 0 没权限。只查询此用户网站下的模版数据。显示数据时，判断模板的生成状态。3.1.5 存储分配 表名称：前缀_Template表名、字段名命名习惯：表名复数，字段头字母大写表说明：存放系统所有模板数据。字段名称字段说明字段类型字段长度备注说明Int_temp_idId模板标识int4唯一标识，非自动递增Var_temp_nameName模板名称Varchar100必填Var_temp_folder模板目录Varchar50必填Int_pre_temp_id克隆模板Int4与模板标识关联Tnt_is_default是否默认模板Tinyint10：不是1：是Tnt_is_PublishPublished是否生成Tinyint10：不是1：是Dtm_add_time新建时间Datetime8Dtm_publish_time最新生成时间Datetime8Var_adn_id最后操作人Varchar50Var_adn_ip最后操作IPVarchar50Dtm_update_time最后操作时间Datetime83.2 模块管理3.2.1 功能流程图1、 添加模块2、 模块管理 3.2.2功能描述1、添加模块a) 功能类型：添加数据b) 功能描述：添加网站模块c) 前提业务：添加模板、模版管理d) 后继业务：模块管理e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）2、模块管理a) 功能类型：查询数据b) 功能描述：显示查询结果c) 前提业务：添加模板、模版管理d) 后继业务：修改、删除、生成模块等e) 功能约束：权限约束f) 约束描述：只能查询出此模版下面的网站模块数据g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.2.3 界面设计1、 添加模块添加新模块选择模块类型选择模块类型： *模块名称： *文件名称： 下一步 重 置说明：对于未生成的模块信息，可以编辑文件名称，已经生成过的就不能再修改文件名称了。文件名称在此模板中不能重复。文件名称如果为空，系统按照当前类型及顺序号，自动生成文件名称。模块类型可选项为：广告详情模块、广告列表显示模块、简单搜索文章模块、高级搜索模块、搜索结果模块、文章列表模块、文章详情模块、相关文章列表模块（按关键字关联）、栏目导航列表模块、子栏目列表模块、当前栏目名称模块、会员登录模块、会员注册模块、会员查看信息详情模块、会员找回密码模块、会员修改密码模块、特殊位置显示的主题模块、用户留言详情模块、主题详情模块?、用户留言列表模块、主题列表模块、首页模块?、用户投票模块、投票列表模块、投票后模块、首页投票模块、投票结果查看模块、底部信息模块、网站计数模块、分页显示模块、错误页模块、自定义模块。“下一步”页面：添加新模块编辑模块内容当前模版：*模块类型：* 模块名称：* 文件名称：*模块内容：（编辑器）嵌入模块 | 字体 | 插入图片 | 代码切换 此模块类型的默认代码类似html代码添 加 重 置数据要求：模块内容的编辑器类似现在使用的ewebhtml编辑器，但是又不是完全相同。只保留ewebhtml里面一些非常简单的字体设置等按钮就行。工具栏中加入嵌入模块和代码切换两个按钮。默认文字编辑区显示的是html代码。点击“代码切换”显示简单的内容框架。还有html代码里面如果涉及到服务器标签，使用ceicms来代替，其属性用简单易懂的文字来表示。“嵌入模块”的页面：可选模块栏目列表模块文章详情模块广告详情模块留言板详情模块。说明：可选模块都是已经在此模版中建立好的模块，不包含当前模块。选择“栏目列表模块”后，弹出此模块的属性窗口（每个模块按照模块类型判断，他们的属性窗口都是不同的）栏目列表模块属性是否显示首页链接：是 否当前栏目标识数字：_ 默认0其他未知属性等等：_确 定 重 填点击“确定”按钮后，将会在编辑器的相应位置显示这个模块的代码。2、 模块管理 当前位置：网站模板管理用户模板管理-模块管理当前模板名称：用户模板1 目录名称：User1 生成状态：未生成此模板下的模块列表 添加 模块名称文件名管理操作模块类型最后操作（时间/人）状态栏目导航列表模块Column_List编辑 删除 栏目导航列表模块未生成生成文章详情模块News_Info编辑 删除 文章详情模块已生成重新生成分页栏说明：删除操作，对于已生成的模块来说，还得去删除对应的模块文件。如果已经被其他页面活模块使用了此模块，则不能删除此模块3.2.4 内部逻辑1、添加模块 Module_Add.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。a)选择模块类型提交后，如果文件名为空，查询数据库此类型的顺序号，自动生成文件名。判断此文件名是否在数据库中已经存在了，若存在，提示。添加此数据到数据库中。 b)下一步模版内容编辑 根据选择的模块类型，读取此模块类型默认的代码显示在编辑区中。 提交后，要判断此类型模块内容html代码是否都正确。如服务器标签类型是否正确，id是否是唯一等等。 全部判断正确后，修改本条数据。2、模块管理 Module_Manage.aspx.cs判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。只查询此模版下的模块数据。显示数据时，判断模块的生成和引用状态。3.2.5 存储分配 表名称：前缀_Template_Module表说明：存放系统所有模块数据。字段名称字段说明字段类型字段长度备注说明Int_mod_id模块标识int4唯一标识，非自动递增Var_mod_name模块名称Varchar100必填Var_mod_file模块文件名Varchar50必填Int_temp_id所属模板int4Txt_file_cont模块内容text16Txt_Other_cont其他内容text16Tnt_file_type类型Tinyint10：模块1：页面2：样式表3：jsTnt_mod_type模块类型Tinyint1见最后模块类型表说明Tnt_is_Publish是否生成Tinyint10：不是1：是2：生成后，重新编辑了Dtm_add_time新建时间Datetime8Dtm_publish_time最新发布时间Datetime8Var_adn_id最后操作人Varchar50Var_adn_ip最后操作IPVarchar50Dtm_update_time最后操作时间Datetime8表名称：前缀_Template_Module_Type表说明：存放系统所有模块类型属性的数据增加“属性明细表”ModuleProperties。字段名称字段说明字段类型字段长度备注说明Tnt_mod_type模块类型Tinyint1唯一标识Var_mod_type_name模块类型名称Varchar200var_type_name所有属性说明text16多个属性用 $ 分开var_type_id所有属性Idtext16多个Id用$分开var_type_input属性类型text16多个类型用$分开（指输入的是数字、字符、单选等）3.3 页面管理3.3.1 功能流程图1、添加页面2、页面管理 3.3.2功能描述1、添加页面a) 功能类型：添加数据b) 功能描述：添加网站页面c) 前提业务：添加模板、模版管理d) 后继业务：页面管理e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）2、页面管理a) 功能类型：查询数据b) 功能描述：显示查询结果c) 前提业务：添加模板、模版管理d) 后继业务：修改、删除、生成页面等e) 功能约束：权限约束f) 约束描述：只能查询出此模版下面的网站页面数据g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.3.3 界面设计1、 添加页面 添加页面 当前模版：*页面名称： *文件名称： *页面内容：（编辑器）嵌入模块 | 字体 | 插入图片 | 代码切换 添 加 重 置 “代码切换”内容显示添加页面 当前模版：*页面名称： *文件名称： *页面内容：（编辑器）嵌入模块 | 字体 | 插入图片 | 代码切换 头部模块左侧模块右侧模块底部模块添 加 重 置说明：在代码区内可以直接写代码，内容区内，点击某个模块名称可以进行该模块的编辑。2、 页面管理 当前位置：网站模板管理用户模板管理页面管理当前模板名称：用户模板1 目录名称：User1 生成状态：未生成此模板下的页面列表 添加 页面名称文件名管理操作最后操作（时间/人）状态首页index编辑 删除 未生成生成文章列表页Column编辑 删除 已生成重新生成分页栏 3.3.4 内部逻辑1、添加页面 Page_Add.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。 代码切换时，使用编辑器里面的代码去比对数据库，将标签替换成已有模块的名称说明。点击模块名称，缓存当前页面输入的数据项内容，读取该模块数据跳转到该模块的编辑页面，模块编辑成功后，返回该页面的编辑页。提交后，要判断此类型模块内容html代码是否都正确。如服务器标签类型是否正确，id是否是唯一等等，嵌入的模块是否正确（需要查询模块库表）。 全部判断正确后，添加数据。2、页面管理 Page_Manage.aspx.cs判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。只查询此模版下的页面数据。显示数据时，判断页面的生成状态。3.3.5 存储分配同 3.2.5 模块存储分配。3.4 样式表管理3.4.1 功能流程图同3.3.1 页面功能流程图。3.4.2功能描述1、添加样式表a) 功能类型：添加数据b) 功能描述：添加样式表c) 前提业务：添加模板、模版管理d) 后继业务：样式表管理e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）2、样式表管理a) 功能类型：查询数据b) 功能描述：显示查询结果c) 前提业务：添加模板、模版管理d) 后继业务：修改、删除、生成样式表等e) 功能约束：权限约束f) 约束描述：只能查询出此模版下面的样式表数据g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.4.3 界面设计1、 添加样式表 添加样式表 当前模版：*文件名称： *内容： 多行文本输入框添 加 重 置2、 样式表管理 当前位置：网站模板管理用户模板管理样式表管理当前模板名称：用户模板1 目录名称：User1 生成状态：未生成此模板下的样式表列表 添加 文件名管理操作最后操作（时间/人）状态style编辑 删除 未生成生成css编辑 删除 已生成重新生成分页栏 3.4.4 内部逻辑1、添加样式表 Style_Add.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。 提交成功后，添加数据。2、样式表管理 Style_Manage.aspx.cs判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。只查询此模版下的样式表数据。显示数据时，判断样式表的生成状态。3.4.5 存储分配同 3.2.5 模块存储分配。 3.5 JS文件管理3.5.1 功能流程图同3.3.1 页面功能流程图。3.5.2功能描述1、添加样式表a) 功能类型：添加数据b) 功能描述：添加Js文件c) 前提业务：添加模板、模版管理d) 后继业务：JS文件管理e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）2、JS文件管理a) 功能类型：查询数据b) 功能描述：显示查询结果c) 前提业务：添加模板、模版管理d) 后继业务：修改、删除、生成JS文件等e) 功能约束：权限约束f) 约束描述：只能查询出此模版下面的Js文件数据g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.5.3 界面设计1、 添加JS文件 添加JS文件 当前模版：*文件名称： *内容： 多行文本输入框添 加 重 置2、 JS文件管理 当前位置：网站模板管理用户模板管理JS文件管理当前模板名称：用户模板1 目录名称：User1 生成状态：未生成此模板下的JS文件列表 添加 文件名管理操作最后操作（时间/人）状态style编辑 删除 未生成生成css编辑 删除 已生成重新生成分页栏 3.5.4 内部逻辑1、添加JS文件 Js_Add.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。 提交成功后，添加数据。2、JS文件管理 Js_Manage.aspx.cs判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。只查询此模版下的JS文件数据。显示数据时，判断Js文件的生成状态。3.5.5 存储分配同 3.2.5 模块存储分配。 3.6 生成功能3.6.1 功能流程图 1、 样式表的生成2、 JS文件的生成3、 模块的生成4、 页面的生成5、 网站模版的生成3.6.2功能描述a) 功能类型：生成文件b) 功能描述：生成页面、模块、样式表、JS文件。c) 前提业务：添加页面、模块、样式表、JS文件d) 后继业务：无e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.6.3 界面设计 无3.6.4 内部逻辑1、样式表的生成 Style_Save.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的样式表参数，取得样式表数据，判断此样式表是否存在。根据所属模版参数，取得模版目录名称。判断模版目录在服务器路径上是否已经存在，若不存在，建立此目录。根据文件名称，文件内容，在此目录下生成样式表文件。改变此样式表的生成状态。 2、JS文件的生成 JS_Save.aspx.cs同样式表的生成。3、模块的生成 Module_Save.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模块参数，取得模块数据，判断此模块是否存在。根据所属模版参数，取得模版目录名称。判断模版目录在服务器路径上是否已经存在，若不存在，建立此目录。模块文件内容，要先处理下，判断下模块类型，文件头需要加什么类库，然后把里面的服务器标签及属性都替换成程序中真正需要的标签和属性。根据文件名称，处理后的模块内容，在此目录下生成模块文件。改变此模块的生成状态。4、页面的生成 Page_Save.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的页面参数，取得页面数据，判断此页面是否存在。根据所属模版参数，取得模版目录名称。判断模版目录在服务器路径上是否已经存在，若不存在，建立此目录。页面文件内容，要先处理下，根据文件内容，取得此页面包含的模块，然后在文件头部引用上此模块的类库，同时要把这些模块按照模块生成的流程先生成文件。把页面里面的服务器标签及属性都替换成程序中真正需要的标签和属性。根据文件名称，处理后的页面内容，在此目录下生成页面文件。改变此页面的生成状态。5、网站模版的生成 Template_Save.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。 判断模版目录在服务器路径上是否已经存在，若不存在，建立此目录。取得全部模块、页面、JS文件、样式表的数据，先按顺序生成这些数据的文件。改变此模版的生成状态。3.6.5 存储分配 服务器硬盘上。3.7 删除功能3.7.1 功能流程图 1、 样式表、JS文件、模块、页面的删除2、 网站模版的删除3.7.2功能描述a) 功能类型：删除文件、删除数据b) 功能描述：删除页面、模块、样式表、JS文件。c) 前提业务：添加页面、模块、样式表、JS文件d) 后继业务：无e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.7.3 界面设计 没有界面，但是 删除操作执行前，要提示用户删除操作不可恢复，是否确定要删除。尤其是模版的删除操作，更需要慎重操作。3.7.4 内部逻辑1、样式表的删除 Style_Del.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的样式表参数，取得样式表数据，判断此样式表是否存在。根据所属模版参数，取得模版目录名称。判断此样式表文件是否已经存在，若存在删除此文件。删除此样式表的数据。 2、JS文件的生成 JS_Del.aspx.cs同样式表的删除。3、模块的删除 Module_Del.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模块参数，取得模块数据，判断此模块是否存在。判断此模块是否被其他页面、模块嵌入了，若已嵌入不能删除。根据所属模版参数，取得模版目录名称。判断此模块文件是否已经存在，若存在删除此模块。删除此模块的数据。4、页面的删除 Page_Del.aspx.cs 同样式表的删除。 5、网站模版的删除 Template_Del.aspx.cs 判断用户是否已登录及其是否有操作权限：Common.IsPower(m1,Session) = 0 没权限。根据传递的模版参数，取得模版数据，判断此模版是否存在。 取得全部模块、页面、JS文件、样式表的数据，删除这些数据。判断模版目录在服务器路径上是否已经存在，若存在，删除此目录。 3.7.5 存储分配无。3.8 模版预览功能3.8.1 功能流程图 3.8.2功能描述a) 功能类型：生成文件b) 功能描述：生成全部的模版文件。c) 前提业务：添加模版、页面等d) 后继业务：无e) 功能约束：权限约束f) 约束描述：无g) 操作权限：有此权限的管理员才能操作 权限代码（m1）3.8.3