DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
gentoo.org 網站再造(一):以用戶為中心的改版策略與 pytext
編輯:XML詳解     

开发者的通病:项目很讲究,网站很随性

各位软件开发者,我能问个问题吗?我们这些人对 HTML、CGI、Perl、Python、Java 技术、XML 之类的东西熟得不能再熟,可为什么自己那些承载心头好项目的网站,看起来却像是一群精力过剩的十二岁小孩随手拼出来的?为什么?到底是为什么?

是因为大多数时候我们对自己的网站放任不管,而把宝贵时间全砸在打磨那些自由软件项目上吗?至少就我而言,答案是最干脆的「是」。

不写 IBM developerWorks 的稿子、也不被新生儿折腾的时候,我和那群技术过硬的志愿者正疯狂扑在 Gentoo Linux 下一个发行版上。是的,Gentoo Linux 有自己的站点。而在当时(2001 年 3 月),它实在没什么可称道之处——因为我们没在上面花时间,精力都投给了 Gentoo Linux 本身。诚然,站上有几枚我用 Xara X 匆匆画出的可爱标识,但在这层讨喜的外壳之下,问题成堆。也许你的站点也是如此。如果是,那我有句话送给你:欢迎入会。

现状:www.gentoo.org

我们的困境很典型:项目在长,网站不长。当时 Gentoo Linux 正准备 1.0 版本(也就是可以正式向非开发者发布的那一刻),用户群日益扩大,我们不得不认真思考:这个站点怎样才能更好地服务用户。下面是 www.gentoo.org 当时的快照:

图 1:www.gentoo.org 在事件当时(2001 年 3 月)的状态

查看原图(大图)

可以看到,基本要素都有:Gentoo Linux 的介绍、特性列表、由 Python 自动更新的每日 ChangeLog,以及一批重要链接(下载站、邮件列表订阅页、cvsWeb)。文件资源也有三处入口——Gentoo Linux 安装指南、开发指南,以及 Christian Zander 写的 NVIDIA 故障排除指南。

但看着不错,不等于什么都不缺。最明显的短板就是文件:安装指南和开发指南都亟待重写。此外还要补 FAQ、加新链接、写新用户须知……这份清单根本列不完。

第二个问题:内容与显示搅在一起

当时所有工作都以原始 HTML 完成:我不断改 index.html,直到自己看着满意为止。更糟的是,站点的 Web 文件也全是手写 HTML。从开发角度看这绝非好事——真正的内容(段落、节、章)与一大堆显示相关的 HTML 标记混在一处,改内容要连着样式一起改,改样式要连着内容一起改。这套做法当下还能撑,但站点继续长大,它一定会出问题。

显然,我们得在幕后换一套更好的技术:不再直接写 HTML,而是引入类似 XML、XSLT 和 Python 的东西。目标是尽可能自动化,让站点的添加与扩展变得轻松。如果这一步做对了,将来哪怕要做大改造,也不该是一场酷刑。

策略:以用户为中心

要做的事很多,我却完全不知从哪儿下手。正当我理不出头绪时,偶然读到了 Laura Wonnacott 在 InfoWorld 的「Site Savvy」专栏。她在文中阐述了「以用户为中心」的设计理念——在改进网站的同时,始终盯住目标受众(在这个案例中是 Gentoo Linux 的用户与开发者)的真实需要。这篇文章以及其中「以用户为中心设计手册」的链接,帮我把改版整理成了一份可执行的行动计划:

  1. 把站点的正式目标写清楚,落到纸面上:它是干什么的,应该做成什么样。
  2. 识别不同类型的用户,也就是你的目标受众,并按优先级排序:谁对你最重要?
  3. 建立反馈渠道,让受众能告诉你哪里做对了、哪里做错了。
  4. 评估反馈,据此判断哪些部分需要改进或重做,优先处理高优先级的部分。
  5. 选定要改的部分后立刻开工。实现过程中要确认:新增的内容与设计明确对上了目标受众的需要,且已知的短板都被修掉了。
  6. 每完成一块就上线,哪怕它与现有站点风格差异明显。这样用户能马上享受到成果;如果改坏了,你也能更快收到反馈。持续渐进地改进(而不是憋大招一次性推出一个「惊喜」)还能避免用户对剧变产生陌生感。

做完第 6 步,回到第 4 步,循环往复。

任务说明

让我高兴的是,第 3 步其实已经完成了:我们陆续收到站点访客的邮件建议,开发者邮件列表也一直是我们交换意见的场所。但第 1、2 步我确实没认真做过。虽然答案看起来显而易见,真正坐下来把任务说明写出来,还是让我受益良多:

www.gentoo.org 的存在,是为了帮助所有使用和开发 Gentoo Linux 的人。它提供关于 Gentoo Linux 以及一般 Linux 的最新信息,重点在于 Gentoo Linux 的安装、使用、管理与开发;作为与 Gentoo 相关事务的主要枢纽,它还应发布与 Gentoo Linux 用户和开发者有关的重要新闻。除了服务现有的用户与开发者,www.gentoo.org 还有第二个目的:为潜在的 Gentoo Linux 用户提供判断「Gentoo Linux 是否适合自己」所需的信息。

目标受众

接着是第 2 步,定义受众。www.gentoo.org 有三类受众:Gentoo Linux 开发者、用户、潜在用户。三者并非天生有高下之分,但在当时,开发者的需要是最高优先级,其次是现有用户,再是潜在用户——因为 Gentoo Linux 尚处于预发布状态。等到 1.0 发布,用户与潜在用户的优先级也会随之提上来。

意见与建议

现在来评估收集到的反馈。

过去几个月里,我们收到了大量访客来信。绝大多数时候,人们的诉求高度一致:更好的文件——开发者要,用户也要。另有一些开发者询问,能否开一个专门播报 CVS 提交的邮件列表。

有趣的是,还有几封邮件在问 Gentoo Linux 是商业产品还是免费软件。我猜原因出在主标识上刻着的「Gentoo Technologies, Inc.」(我们的法定公司名),让人误以为这是家在做生意的公司。 remedy 很直接:把标识改成「Gentoo Linux」,并在首页加一小段引言,说明我们是自由软件项目。

改进清单

把这些反馈翻译成一份可执行的改进列表:

  • 重建首页
    实现:更新标识,增加自由软件简介
    目的:明确说明我们是自由软件项目
    目标组:潜在用户
    难度:中等
  • 改进基础用户文件
    实现:新的 XML/XSLT 系统,内容更详尽
    目的:让用户安装 Gentoo Linux 更顺利
    目标组:新用户
    难度:中等
  • 改进/新建开发者文件
    实现:新的 XML/XSLT 系统、CVS 指南、开发系统说明、移植指南
    目的:帮助开发者把工作做得出色
    目标组:开发者
    难度:大
  • 新增 CVS 邮件列表
    实现:复用现有的 Majordomo 邮件列表管理器
    目的:更好地通知开发者
    目标组:开发者
    难度:小

取舍

出于不同原因,清单里有两件事格外突出。

第一件是 CVS 邮件列表——实现成本极低。通常先做最省力的改动是合理的,用户能立刻受益。

第二件是开发者文件。这是个长期工程,工作量不小。在与多位开发者交流后,我们一致认为某种 XML/XSL 方案才是正解。

XML/XSL 原型

为了让事情启动起来,我先做了一套用于全部线上文件的 XML 语法原型,称之为「guide」。它用类似 <section>、<chapter> 这样的标记,把文件明确组织成段落、节、章,同时完全不含任何显示相关的标记。为了产出站上要展示的 HTML,我又写了一组 XSL 转换原型。借助 Sablotron 这类 XSLT 处理器,guide XML 文件可以按下面的方式转成 HTML:

devguide.XML + guide.xsl ---XSLT processor---> devguide.Html

这套方法的妙处在于,它把原始内容(XML)与显示相关信息(集中在 guide.xsl 里)彻底隔开。要改网页外观?只改 guide.xsl,然后把所有 XML 过一遍 XSLT 处理器,全新的 HTML 就出来了。要给开发指南加几章?改 devguide.xml,再过一遍 Sablotron,得到的 devguide.html 就已包含新增章节且格式完整。可以把 XML 理解为内容,把 XSLT 理解为与显示相关的格式化宏。

虽然全组都认同 XML/XSLT 方向,但我们对具体用哪套正式语法还没达成一致。我们的开发负责人 Achim 建议直接用 DocBook,而不是自建语法。不过,guide XML 原型的存在已经把决策过程推了起来。既然开发者每天都要跟 XML/XSL 打交道,选一个大家都满意、且能满足全部需要的方案就格外关键。下一篇,我会展示一套真正跑得起来的 XML/XSL 文件系统。

技术插曲:pytext

一般来说,我们当时的站点没什么值得吹的新技术。但有一个例外值得一提——我们的小玩具 pytext,一个嵌入式 Python 解释器。

和很多人一样,我是超级 Python 迷,在所有脚本语言里最爱它。所以给站点加点动态内容时,我自然想用 Python。而写动态 HTML 时,把语言命令直接嵌进 HTML 里通常比别的方式方便得多,于是问题来了:需要一个能接受下面这种文档的嵌入式 Python 解释器:

<p>
Yeah, sure; I got some questions:<br>
<!--code
names=["bob","jimmy","ralph"]
items=["socks","lunch","accordion"]
for x in items:
    for y in names:
        print "Anyone seen",y+"'s",x+"?<br>"
-->
See, told you so.
</p>

……并把它转换成:

<p>
Yeah, sure; I got some questions:<br>
Anyone seen bob's socks?<br>
Anyone seen jimmy's socks?<br>
Anyone seen ralph's socks?<br>
Anyone seen bob's lunch?<br>
Anyone seen jimmy's lunch?<br>
Anyone seen ralph's lunch?<br>
Anyone seen bob's accordion?<br>
Anyone seen jimmy's accordion?<br>
Anyone seen ralph's accordion?<br>
See, told you so.
</p>

下面是 pytext 的源码:

pytext 嵌入式 Python 解释器

#!/usr/bin/env Python
# pytext 2.1
# Copyright 1999-2001 Daniel Robbins
# Distributed under the GPL
import sys
def runfile(myarg):
    "interprets a text file with embedded elements"
    mylocals={}
    try:
        a=open(myarg,'r')
    except IOError:
        sys.stderr.write("!!! Error opening "+myarg+"!\n")
        return
    mylines=a.readlines()
    a.close()
    pos=0
    while pos<len(mylines):
        if mylines[pos][0:8]=="<!--code":
            mycode=""
            pos=pos+1
            while (pos<len(mylines)) and (mylines[pos][0:3]!="-->"):
                mycode=mycode+mylines[pos]
                pos=pos+1
            exec(mycode,globals(),mylocals)
        else:
            sys.stdout.write(mylines[pos])
            pos=pos+1
if len(sys.argv)>1:
    for x in sys.argv[1:]:
        runfile(x)
    sys.exit(0)
else:
    sys.stderr.write("pytext 2.1 -- Copyright 1999-2001 Daniel Robbins. ")
    sys.stderr.write("Distributed under the\nGNU Public License\n\n")
    sys.stderr.write("Usage: "+sys.argv[0]+" file0 [file1]...\n")
    sys.exit(1)

pytext 工作原理

它的逻辑相当直白:逐行扫描输入,大多数行只是原样回显到标准输出。但一旦遇到以 <!--code 开头的行,pytext 就会把直到出现以 --> 开头的行为止的所有内容,依次追加到名为 mycode 的字符串里,然后用内置的 exec() 执行这段字符串——一个嵌入式 Python 解释器就这样成型了。

这个实现里有处细节相当漂亮:我们调用 exec() 的方式,会保留对全局与局部命名空间的全部修改。这意味着你可以在某个嵌入块里 import 模块或定义变量,然后在后面的块里继续使用它们,比如下面这个例子:

<!--code
import os
foo=23
-->
Hello
<!--code
print foo
if os.path.exists("/tmp/mytmpfile"):
    print "it exists"
else:
    print "I don't see it"
-->

很方便,不是吗?pytext 是 Python 强大能力的一次绝佳演示,对 Python 爱好者来说也是个相当趁手的工具。在当时的站点上,我们从 cron 作业里调用它,定期为主页的 ChangeLog 生成 HTML:

pytext index.ehtml > index.Html

就写到这里。下次再见时,我会聊 www.gentoo.org 改版的第一阶段实战!

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved