网站开发规范.doc

网站开发规范总 论本规范既是一个开发规范，也是一个脚本语言参考，本规范并不是一个一成不变的必须严格遵守的条文，特殊情况下要灵活运用，做一定的变通。但是，请大家千万不要随意更改规范。如果有任何问题，请及时与我联系，我会及时更改本规范的相关代码样例和文档。 基 本 要 求1. 在网站根目录中开设images common temp 三个子目录，根据需要再开设media 子目录，images目录中放不同栏目的页面都要用到的公共图片，例如公司的标志、banner 条、菜单、按钮等等；common 子目录中放css、js,、php、include 等公共文件；temp 子目录放客户提供的各种文字图片等等原始资料；media 子目录中放flash, avi, quick time 等多媒体文件 。2. 在根目录中原则上应该按照首页的栏目结构，给每一个栏目开设一个目录，根据需要在每一个栏目的目录中开设一个images 和media 的子目录用以放置此栏目专有的图片和多媒体文件，如果这个栏目的内容特别多，又分出很多下级栏目，可以相应的再开设其他目录。3. temp 目录中的文件往往会比较多，建议以时间为名称开设目录，将客户陆续提供的资料归类整理。4. 除非有特殊情况，目录、文件的名称全部用小写英文字母、数字、下划线的组合，其中不得包含汉字、空格和特殊字符；目录的命名请尽量以英文为指导，不到万不得已不要以拼音作为目录名称，经验证明，用拼音命名的目录往往连一个月后的自己都看不懂，脚 本 编 写我们应该有一个脚本整体风格一致的概念，意思是一个月后和一个月前的你写的脚本风格保持一致，以及同一个工作组中不同的开发人员编写的脚本风格保持 一致，因为我们不可能永远孤立的开发，你随时都有可能和三个月前的自己合作（你的客户要求改版网站），也经常要和工作室中不同的同事共同开发一个项目，还有可 能被要求修改已经离职人员开发的脚本，当然你自己也有可能会扔下一个项目给后来的同事。1. Html 文件的通用模板： 文档标题 其他meta 标 记样式表定义客户端javascript 函数定义及初始化操作 补充：为了保证网站能够与下一代的web 语言xml 标准兼容，所有的HTML 标签的属性都要用单引号或者双引号括起，即我们应该写 而不 是 .2. 允许全文检索的页面，为了使Internet 上的搜索引擎能够有效检索，在频道的首页的html的之间应该加入Keywords 和Description 元标记，例如 ：3. CSS 文件的格式样例代码 ：这里尤其要注意的是a:link a:visited a:hover a:actived 的排列顺序一定要严格照上面的样例代码，否则或多或少会出问题。另外我们规定重定义的最先，伪类其次，自定义最后，便于自己和他人阅读！为了保证不同浏览器上字号保持一致，字号建议用点数pt和像素px来定义，pt一般使用中文宋体的9pt和11pt，px一般使用中文宋体12px 和14.7px 这是经过优化的字号，黑体字或者宋体字加粗时，一般选用11pt和14.7px 的字号比较合适。在写 互相嵌套时，严格按照的规范，对于单独的一个来说，对 齐， 缩进两个半角空格， 中如果还有嵌套的表格，也缩进两个半角空格，如果中没有任何嵌套的表格， 结束标记应该与 处于同一行，不要换行，如我们注意在源代码中不应有这样的代码：而应该是这样的：这是因为浏览器认为换行相当于一个半角空格，以上不规范的写法相当于无意中增加一个半角空格，如果确实有必要增加一个半角空格，也应该这样写： 属于同一个级别 的 一定是左首对齐的，另外不允许没有任何内容的空的单元格存在，高度大于等于12px 的单元格应该 在 和 之间写一 个 如果高度小于12px, 则应该 在 和 之间插入一个1*1 大小的透明的gif 图片，这是因为某些浏览器认为空单元格非法而不会予以解释。如果代码顺序较乱，在DW3中可以通过command-apply souce formatting进行重新整理！5. Width 和height 的写法也有统一的规范，一般情况下只有一列的表格，width 写在 的标签内，只有一行的表格，height 写在 的标签内，多行多列的表格，width 和height 写在第一行或者第一列的 标签内。总之遵循一条原则：不出现多于一个的控制同一个单元格大小的height 和width, 保证任何一个width 和height 都是有效的，也就是你改动代码中任何一个width 和height 的数值，都应该在浏览器中看到变化。做到这一条不容易，需要较长时间的练习和思考。一 般 原 则1. 在排布表格之前，请大家一定要好好思考一个最佳的方案，表格的嵌套尽量控制在三层以内，并且应该尽量避免 两个标记，经验表明，这两个标记会带来许多麻烦。2. 一个网页要尽量避免用整个一张大表格，所有的内容都嵌套在这个大表格之内，因为浏览器在解释页面的元素时，是以表格为单位逐一显示，如果一张网页是嵌套在 一个大表格之内，那么很可能造成的后果就是，当浏览者敲入网址，他要先面对一片空白很长时间，然后所有的网页内容同时出现。如果必须这样做，请使用 标记，以便能够使这个大表格分块显示。3. 排版中我们经常会遇到需要进行首行缩进的处理，不要使用 或者全角空格来达到效果，规范的做法是在样式表中定义 p text-indent: 2em; 然后给每一段加上 标记，注意，一般情况下，请不要省略 结束标记 。4. 原则上，我们禁止用 来人为干预图片显示的尺寸，而且建议 标签中不要带上width 和height 两个属性，这是因为制作过程中，图片往往需要反复的修改，这样可以避免人为干预图片显示的尺寸，尽可能的发挥浏览器自身的功能；但是这样的一个副作用是当 网页还未加载图片时，不会留出图片的站位大小，可能会造成网页在加载过程中抖动（如果图片是插在一个固定大小的表格里的，不会有这个现象），尤其是当图片 的尺寸较大时，这种现象会很明显，所以当预料到这种会明显导致网页抖动的情况会发生时，请大家务必在最后给 附上 width 和 height 属性。5. 为了最大程度的发挥浏览器自动排版的功能，在一段完整的文字中请尽量不要使用 来人工干预分段。6. 不同语种的文字之间应该有一个半角空格，但避头的符号之前和避尾的符号之后除外汉字之间的标点要用全角标点，英文字母和数字周围的括号应该使用半角括号。7. 所有的字号都应该用样式表来实现，禁止在页面中出现 标记。8. 请不要在网页中连续出现多于一个 的 也尽量少使用全角空格（英文字符集下，全角空格会变成乱码），空白应该尽量使用 text-indent, padding, margin, hspace, vspace 以及透明的gif 图片来实现。9. 中英文混排时，我们尽可能的将英文和数字定义为verdana 和arial 两种字体。10. 行距建议用百分比来定义，常用的两个行距的值是line-height:120%/150%.11. 网站中的路径全部采用相对路径，一般链接到某一目录下的缺省文件的链接路径不必写全名，如我们不必这样： 而应该这样：12、嵌入图形文本的使用较大的字体，建议不要在图形中包括文本。13、“网页大小”定义为网页的所有文件大小的总和，包括HTML文件和所有的嵌入的对象。用户喜欢快的而不是新奇的站点。对于解调器用户，网页大小保持在34K以下为合适。文 件 命 名 原 则1. 每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm2 件名称统一用小写的英文字母、数字和下划线的组合。3. 命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作 。4. 下面以“新闻”（包含“国内新闻”和“国际新闻”）这个栏目来说明html 文件的命名原则 ： 在根目录下开设news目 录 第一条缺省新闻取名index.htm 所有属于“国内新闻”的新闻依次取名为：china_1.htm, china_2.htm, 所有属于“国际新闻”的新闻依次取名为：internation_1.htm, internation _2.htm, 如果文件的数量是两位数，请将前九个文件命名为：china_01.htm, china_02.htm 以保证所有的文件能够在文件夹中正确排序。5. 图片的命名原则遵循以下几条规范 ： 名称分为头尾两两部分，用下划线隔开。 头部分表示此图片的大类性质，例如广告、标志、菜单、按钮等等 。 一般来说:放置在页面顶部的广告、装饰图案等长方形的图片我们取名：banner标志性的图片我们取名为：logo在页面上位置不固定并且带有链接的小图片我们取名为button在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu装饰用的照片我们取名：pic不带链接表示标题的图片我们取名：title依照此原则类推。 尾部分用来表示图片的具体含义。 下面是几个样例，大家应该能够一眼看明白图片的意义：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg pic_hill.jpg.目录建立的原则：以最少的层次提供最清晰简便的访问结构。根目录。根目录指DNS域名服务器指向的索引文件的存放目录。服务器的ftp上传目录默认为html根目录文件根目录只允许存放index.html和main.html文件，以及其他必须的系统文件。每个语言版本存放于独立的目录。已有版本语言设置为：简体中文 gb繁体中文 big5英 语 en日 语 jp每个主要功能(主菜单)建立一个相应的独立目录。根目录下的images为存放公用图片目录，每个目录下私有图片存放于各自独立images目录.例如：menu1imagesmenu2images所有的js文件存放在根目录下统一目录script所有的CSS文件存放在根目录下的style目录所有的CGI程序存放在根目录并列目录cgi_bin目录head区是指首页HTML代码的和之间的内容。必须加入的标签1.公司版权注释2.网页显示字符集简体中文：繁体中文：英 语：3.网页制作者信息4.网站简介5.搜索关键字6.网页的css规范(参见目录及命名规范)7.网页标题xxxxxxxxxxxxxxxxxx.可以选择加入的标签1.设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅。2.禁止浏览器从本地机的缓存中调阅页面内容。3.用来防止别人在框架里调用你的页面。4.自动跳转。5指时间停留5秒。5.网页搜索机器人向导.用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。CONTENT的参数有all,none,index,noindex,follow,nofollow。默认是all。6.收藏夹图标所有的javascript的调用尽量采取外部调用.附标签：标签不属于head区，这里强调一下，为了保证浏览器的兼容性，必须设置页面背景网站文件命名规范文件命名的原则：以最少的字母达到最容易理解的意义。索引文件统一使用index.html文件名(小写)index.html文件统一作为”桥页”，不制作具体内容，仅仅作为跳转页和meta标签页。主内容页为main.html按菜单名的英语翻译取单一单词为名称。例如：关于我们 aboutus信息反馈 feedback产 品 product所有单英文单词文件名都必须为小写，所有组合英文单词文件名第二个起第一个字母大写；所有文件名字母间连线都为下划线图片命名原则以图片英语字母为名。大小原则写同上。例如：网站标志的图片为logo.gif鼠标感应效果图片命名规范为”图片名+_+on/off”。例如：menu1_on.gif/menu1_off.gif五. 其它文件命名规范1.js的命名原则以功能的英语单词为名。例如：广告条的js文件名为:ad.js2.所有的CGI文件后缀为cgi所有CGI程序的配置文件为config.cgi