网站服务部小组文档

新闻系统的嵌套规范

目的:

规范使用新闻系统,解决编辑和前端修改新闻系统模板时产生的一些问题

当前的使用方法:

  • 将整个页面包括页面框架,静态文本,引用新闻系统数据模块等全部放入新闻系统的模板中

当前存在的问题:

  • 新闻发布系统中编辑器为普通文本编辑框,无高亮,无格式,直接修改容易出现改错、改漏、缺少标签等情况
  • 编辑修改静态文本,技术修改页面交叉进行,容易造成修改覆盖,回档等情况
  • 因代码不同步,前端对页面进行调整需要把到新闻系统中拷贝最新的到本地修改,更新修改操作步骤繁琐,若没有拷贝最新,直接按照本地版本修改提交,会直接覆盖最新的线上文件,而且覆盖过程无提示,覆盖了也无人知道
  • 某一页面的非原开发人员不知道该页面是新闻系统自动生成还是手动提交,确认过程非常繁琐,有时候甚至要靠猜测后进行确定,不利于团队协作,也不利于新手接入工作
  • 在当前团队已引入git进行代码管理后,此种做法非常不利于git代码管理的使用
  • 不方便本地调试页面

新的使用方法:

  • 将调用了新闻发布系统的模块独立出来放入新闻系统中,创建相应的索引模板和索引页,然后在本地页面开发时使用include将对应模块的索引页面引入到本地整个页面的相应位置

新的嵌套方法可以解决的问题及优化:

  • 整个页面保存在本地,可同步到git上,编辑及各前端技术可以保证各自的本地代码最新,多人交叉时不会被覆盖,导致修改回退等问题,同时,若修改有冲突,提交的时候git会提示手动进行代码合并
  • 编辑修改页面可以直接使用专业编辑器打开文件进行编辑,利用编辑器的自动检测减少代码标签书写错误,同时浏览源码时清晰有层次,便于寻找修改点
  • 不存在新闻系统自动发布全页面的情况,非原开发人员仅需直接从git上获取最新代码即可
  • 现在团队正在推广使用的fis可以在本地调试时将include的线上页面文件(即由新闻系统生成的模块索引页面)自动引入到本地环境中,实现本地实时预览,方便编辑及前端修改后预览
  • 整个页面除新闻系统相关模块外保存在本地独立成一个文件,不受新闻系统影响,与新闻系统无耦合,便于git代码管理