Python论坛  - 讨论区

标题:[python-chinese] 我正在做的一个协同文档系统

2007年05月18日 星期五 11:22

ro rosettas在gmail.com
星期五 五月 18 11:22:12 HKT 2007

hi all

我正在用turbogears编写一个协同文档系统,我主要要解决的API类型的文档的编写问题

这个系统主要会有以下几个功能
1.模版功能
系统会把文档的编辑界面和显示界面的决定权交给用户.也就是说,用户可以自定义他写一篇文档时候填写哪些表单,表单的位置如何等等,同样,他也可以自定义在显示的时候,这些表单内容以何种方式显示.模版就是一个完整的html文件

之所以做这个功能的理由:
1)一个api的编辑者应该关心的是api的几个关键部分,比如函数参数,返回值,头文件,示例等等,编写api文档时不应该花时间去处理"函数返回值"这样的题头的显示问题
2)不同api会有不同要求,无法提炼出一个适合所有api编写的编辑界面,比方说1000个api中900的头文件是foo.h,那么给一个edit让他粘贴900次显然不如给他一个下拉选单来的合适,但下拉选单的内容无法完全事先预料,因此交给用户自己去决定是看到一个edit还是一个combobox.

2.翻译支持
系统可以为某个文档项目生成翻译副本.翻译副本完全复制主项目中的文档结构.翻译副本可以编辑但是不可以改变文档之间的关联结构(父子关系).当主项目中文档结构发生了变化--改变了父子关系或者新增了文档--可以同步文档结构到翻译副本.

3.生成静态页面
可以为某个文档项目按照其文档结构生成静态页面.生成静态页面后如果文档内容发生更改,则只重新生成更改后的页面

4.用户管理


目前我已经完成了页面的新增,修改,删除,模版功能,文档项目的复制等等,主要功能上差翻译副本的结构同步和生成静态页面.预计1-2天内可以完成.

后续我还希望做页面的注释,修改历史的记录,文档中某部分和svn中代码同步等功能.

不知是否有人对这个项目有兴趣?

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 11:53

ro rosettas在gmail.com
星期五 五月 18 11:53:22 HKT 2007

我指的兴趣是有没有一起开发或者使用的兴趣,不是来做广告卖的....-_-|

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 11:54

Bruce Wang number5在gmail.com
星期五 五月 18 11:54:20 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
>
> hi all
>
> 我正在用turbogears编写一个协同文档系统,我主要要解决的API类型的文档的编写问题
>
> 这个系统主要会有以下几个功能
> 1.模版功能
> 系统会把文档的编辑界面和显示界面的决定权交给用户.也就是说
> ,用户可以自定义他写一篇文档时候填写哪些表单,表单的位置如何等等,同样,他也可以自定义在显示的时候,
> 这些表单内容以何种方式显示.模版就是一个完整的html文件
>
> 之所以做这个功能的理由:
>
> 1)一个api的编辑者应该关心的是api的几个关键部分,比如函数参数,返回值,头文件,示例等等,编写api文档时不应该花时间去处理"函数返回值"这样的题头的显示问题
> 2)不同api会有不同要求,无法提炼出一个适合所有api编写的编辑界面,比方说1000个api中900的头文件是foo.h
> ,那么给一个edit让他粘贴900次显然不如给他一个下拉选单来的合适,但下拉选单的内容无法完全事先预料,因此交给用户自己去决定是看到一个edit还是一个combobox.
>
> 2.翻译支持
> 系统可以为某个文档项目生成翻译副本.翻译副本完全复制主项目中的文档结构.翻译副本可以编辑但是不可以改变文档之间的关联结构
> (父子关系).当主项目中文档结构发生了变化--改变了父子关系或者新增了文档--可以同步文档结构到翻译副本.
>
> 3.生成静态页面
> 可以为某个文档项目按照其文档结构生成静态页面.生成静态页面后如果文档内容发生更改,则只重新生成更改后的页面
>
> 4.用户管理
>
>
> 目前我已经完成了页面的新增,修改,删除,模版功能,文档项目的复制等等,主要功能上差翻译副本的结构同步和生成静态页面.预计1-2天内可以完成.
>
> 后续我还希望做页面的注释,修改历史的记录,文档中某部分和svn中代码同步等功能.
>
> 不知是否有人对这个项目有兴趣?
>
>

a pudge[1] clone?

或者是 pudge + rosseta[2]?

[1] http://pudge.lesscode.org/
[2] https://launchpad.net/rosetta/

-- 
simple is good
http://brucewang.net
skype: number5
-------------- 下一部分 --------------
一个HTML附件被移除...
URL: http://python.cn/pipermail/python-chinese/attachments/20070518/9a4de4c8/attachment.html 

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 12:34

ro rosettas在gmail.com
星期五 五月 18 12:34:13 HKT 2007

On 5/18/07, Bruce Wang <number5在gmail.com> wrote:

>
> a pudge[1] clone?
>
> 或者是 pudge + rosseta[2]?
>
> [1] http://pudge.lesscode.org/
> [2] https://launchpad.net/rosetta/
>

四月时候在这个list上看到Davies提出的要做一个协同翻译平台的想法,我当时也有类似的想法并且对文档编辑有一些其他的想法,因此四月下旬着手开始做了.

我不大清楚pudge项目的情况.
我比较关心三部分的功能,一个是文档编辑时候的界面和提交的表单参数完全用户自定义,包括表单参数名.另一个是翻译时候可以主副本同步文档结构.还有就是生成离线文档

不知道你说的两个系统是否有这样的实现呢

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 12:54

limodou limodou在gmail.com
星期五 五月 18 12:54:08 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
> On 5/18/07, Bruce Wang <number5在gmail.com> wrote:
>
> >
> > a pudge[1] clone?
> >
> > 或者是 pudge + rosseta[2]?
> >
> > [1] http://pudge.lesscode.org/
> > [2] https://launchpad.net/rosetta/
> >
>
> 四月时候在这个list上看到Davies提出的要做一个协同翻译平台的想法,我当时也有类似的想法并且对文档编辑有一些其他的想法,因此四月下旬着手开始做了.
>
> 我不大清楚pudge项目的情况.
> 我比较关心三部分的功能,一个是文档编辑时候的界面和提交的表单参数完全用户自定义,包括表单参数名.另一个是翻译时候可以主副本同步文档结构.还有就是生成离线文档
>
> 不知道你说的两个系统是否有这样的实现呢
>
有没有可能用django来做呢?


-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:08

ro rosettas在gmail.com
星期五 五月 18 13:08:55 HKT 2007

On 5/18/07, limodou <limodou在gmail.com> wrote:
> 有没有可能用django来做呢?
>

当然,如果你有兴趣和时间参与的话;)

我可能很难再用一个月的时间去边学django边做了,如果要在django上做我需要比较多的帮助.

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:16

limodou limodou在gmail.com
星期五 五月 18 13:16:11 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
> On 5/18/07, limodou <limodou在gmail.com> wrote:
> > 有没有可能用django来做呢?
> >
>
> 当然,如果你有兴趣和时间参与的话;)
>
> 我可能很难再用一个月的时间去边学django边做了,如果要在django上做我需要比较多的帮助.
>
turbogears我研究甚少,不过django还算熟,学习django的人也还算多些,交流可能会更方便。

-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:27

ro rosettas在gmail.com
星期五 五月 18 13:27:36 HKT 2007

On 5/18/07, limodou <limodou在gmail.com> wrote:
> turbogears我研究甚少,不过django还算熟,学习django的人也还算多些,交流可能会更方便。

OK,我想知道你是否认为这个项目有价值做并愿意参与编码呢,其实如果有功能类似的成熟项目我更愿意使用别人的,呵呵

我想把这个项目转到django的主要麻烦在orm部分,View的部分改django模版输出应该主要是修改字符串的工作量问题,controll部分应该基本不用动

因此如果你能参与的话这个应该会比较快

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:39

Bruce Wang number5在gmail.com
星期五 五月 18 13:39:58 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
>
> On 5/18/07, Bruce Wang <number5在gmail.com> wrote:
>
> >
>
> 我不大清楚pudge项目的情况.
> 我比较关心三部分的功能,一个是文档编辑时候的界面和提交的表单参数完全用户自定义,
> 包括表单参数名.另一个是翻译时候可以主副本同步文档结构.还有就是生成离线文档
>
> 不知道你说的两个系统是否有这样的实现呢
>
>
pudge是一个python原生系统,API文档主要都是python代码的docstrings生成的,他不支持网上编辑,这个例子举得不好。

倒是TurboGears本身有个半死不活的项目Docudo[1][2]功能和你的设想比较类似, 原型是基于TurboGears的Wiki

Rosetta 是Ubuntu用来做基于gettext的软件界面文字翻译的网上协作系统、

[1] http://groups.google.com/group/docudo
[2] http://trac.docudo.org/browser/trunk/doc/spec.txt

-- 
simple is good
http://brucewang.net
skype: number5
-------------- 下一部分 --------------
一个HTML附件被移除...
URL: http://python.cn/pipermail/python-chinese/attachments/20070518/86cc7ac6/attachment.html 

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:51

ro rosettas在gmail.com
星期五 五月 18 13:51:11 HKT 2007

On 5/18/07, Bruce Wang <number5在gmail.com> wrote:
> pudge是一个python原生系统,API文档主要都是python代码的docstrings生成的,他不支持网上编辑,这个例子举得不好。
>
> 倒是TurboGears本身有个半死不活的项目Docudo[1][2]功能和你的设想比较类似,
> 原型是基于TurboGears的Wiki
>
> Rosetta 是Ubuntu用来做基于gettext的软件界面文字翻译的网上协作系统、
>
> [1] http://groups.google.com/group/docudo
> [2] http://trac.docudo.org/browser/trunk/doc/spec.txt
>

呵呵,那我还是自己做吧,我已经基本上实现了对1.0版本的功能预期

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 13:58

limodou limodou在gmail.com
星期五 五月 18 13:58:39 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
> On 5/18/07, Bruce Wang <number5在gmail.com> wrote:
> > pudge是一个python原生系统,API文档主要都是python代码的docstrings生成的,他不支持网上编辑,这个例子举得不好。
> >
> > 倒是TurboGears本身有个半死不活的项目Docudo[1][2]功能和你的设想比较类似,
> > 原型是基于TurboGears的Wiki
> >
> > Rosetta 是Ubuntu用来做基于gettext的软件界面文字翻译的网上协作系统、
> >
> > [1] http://groups.google.com/group/docudo
> > [2] http://trac.docudo.org/browser/trunk/doc/spec.txt
> >
>
> 呵呵,那我还是自己做吧,我已经基本上实现了对1.0版本的功能预期
>

我可以先看一下相关的东西,看一看时间来得及可以考虑。

-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 14:03

ro rosettas在gmail.com
星期五 五月 18 14:03:13 HKT 2007

On 5/18/07, limodou <limodou在gmail.com> wrote:
> 我可以先看一下相关的东西,看一看时间来得及可以考虑。

你有没有可控制的svn server,我可以把代码提交进去

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 14:21

wyh wyhross在gmail.com
星期五 五月 18 14:21:34 HKT 2007

ÄúºÃ£¬
     Ô­À´Ã»ÓнӴ¥¹ýdjango,ÏëÁ˽âһϣ¬ÓÐûÏà¹ØµÄ×ÊÔ´£¿

¶àл£¡



wyh
2007-05-18



·¢¼þÈË£º limodou
·¢ËÍʱ¼ä£º 2007-05-18 14:00:28
ÊÕ¼þÈË£º python-chinese在lists.python.cn
³­ËÍ£º 
Ö÷Ì⣺ Re: [python-chinese]ÎÒÕýÔÚ×öµÄÒ»¸öЭͬÎĵµÏµÍ³

On  5/18/07,  ro   <rosettas在gmail.com >  wrote:
>  On  5/18/07,  Bruce  Wang   <number5在gmail.com >  wrote:
>   >  pudgeÊÇÒ»¸öpythonÔ­Éúϵͳ£¬APIÎĵµÖ÷Òª¶¼ÊÇpython´úÂëµÄdocstringsÉú³ÉµÄ£¬Ëû²»Ö§³ÖÍøÉϱ༭£¬Õâ¸öÀý×Ӿٵò»ºÃ¡£
>   >
>   >  µ¹ÊÇTurboGears±¾ÉíÓиö°ëËÀ²»»îµÄÏîÄ¿Docudo[1][2]¹¦ÄܺÍÄãµÄÉèÏë±È½ÏÀàËÆ,
>   >  Ô­ÐÍÊÇ»ùÓÚTurboGearsµÄWiki
>   >
>   >  Rosetta  ÊÇUbuntuÓÃÀ´×ö»ùÓÚgettextµÄÈí¼þ½çÃæÎÄ×Ö·­ÒëµÄÍøÉÏЭ×÷ϵͳ¡¢
>   >
>   >  [1]  http://groups.google.com/group/docudo
>   >  [2]  http://trac.docudo.org/browser/trunk/doc/spec.txt
>   >
>
>  ºÇºÇ,ÄÇÎÒ»¹ÊÇ×Ô¼º×ö°É,ÎÒÒѾ­»ù±¾ÉÏʵÏÖÁ˶Ô1.0°æ±¾µÄ¹¦ÄÜÔ¤ÆÚ
>

ÎÒ¿ÉÒÔÏÈ¿´Ò»ÏÂÏà¹ØµÄ¶«Î÷£¬¿´Ò»¿´Ê±¼äÀ´µÃ¼°¿ÉÒÔ¿¼ÂÇ¡£

--  
I  like  python!
UliPad   <  >:  http://wiki.woodpecker.org.cn/moin/UliPad
My  Blog:  http://www.donews.net/limodou
_______________________________________________
python-chinese
Post:  send  python-chinese在lists.python.cn
Subscribe:  send  subscribe  to  python-chinese-request在lists.python.cn
Unsubscribe:  send  unsubscribe  to    python-chinese-request在lists.python.cn
Detail  Info:  http://python.cn/mailman/listinfo/python-chinese
-------------- 下一部分 --------------
Ò»¸öHTML¸½¼þ±»ÒƳý...
URL: http://python.cn/pipermail/python-chinese/attachments/20070518/e0f5335c/attachment.html 

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 14:56

风向标 vaneoooo在gmail.com
星期五 五月 18 14:56:05 HKT 2007

to wyh:

http://www.woodpecker.org.cn/obp/django/django-stepbystep/newtest/doc/

http://www.woodpecker.org.cn/obp/django/django-faq/TableOfContents.html

http://www.djangoproject.com/documentation/

¶¼ÊÇ´óÁ¿µÄdjango×ÊÁÏ


ÁíÍâÏëÇëÎÊÏÂlimodouÐÖÔø¾­ËµÏë·¢Æð¸ödjangoϵÄÖÐÎļìË÷ÏîÄ¿£¬²»ÖªµÀÏÖÔÚÈçºÎÁË£¿
-------------- 下一部分 --------------
Ò»¸öHTML¸½¼þ±»ÒƳý...
URL: http://python.cn/pipermail/python-chinese/attachments/20070518/7e22addd/attachment.htm 

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 15:55

limodou limodou在gmail.com
星期五 五月 18 15:55:51 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
> On 5/18/07, limodou <limodou在gmail.com> wrote:
> > 我可以先看一下相关的东西,看一看时间来得及可以考虑。
>
> 你有没有可控制的svn server,我可以把代码提交进去
>
可以在code.google上创建一个项目,然后把我加进去。

-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 17:30

ro rosettas在gmail.com
星期五 五月 18 17:30:54 HKT 2007

On 5/18/07, limodou <limodou在gmail.com> wrote:
> On 5/18/07, ro <rosettas在gmail.com> wrote:
> > On 5/18/07, limodou <limodou在gmail.com> wrote:
> > > 我可以先看一下相关的东西,看一看时间来得及可以考虑。
> >
> > 你有没有可控制的svn server,我可以把代码提交进去
> >
> 可以在code.google上创建一个项目,然后把我加进去。
>

done

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月18日 星期五 21:26

limodou limodou在gmail.com
星期五 五月 18 21:26:25 HKT 2007

On 5/18/07, ro <rosettas在gmail.com> wrote:
> On 5/18/07, limodou <limodou在gmail.com> wrote:
> > On 5/18/07, ro <rosettas在gmail.com> wrote:
> > > On 5/18/07, limodou <limodou在gmail.com> wrote:
> > > > 我可以先看一下相关的东西,看一看时间来得及可以考虑。
> > >
> > > 你有没有可控制的svn server,我可以把代码提交进去
> > >
> > 可以在code.google上创建一个项目,然后把我加进去。
> >
>
> done
>

链接是什么?

-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月20日 星期日 11:44

ro rosettas在gmail.com
星期日 五月 20 11:44:25 HKT 2007

On 5/18/07, limodou <limodou在gmail.com> wrote:
> On 5/18/07, ro <rosettas在gmail.com> wrote:
> > On 5/18/07, limodou <limodou在gmail.com> wrote:
> > > On 5/18/07, ro <rosettas在gmail.com> wrote:
> > > > On 5/18/07, limodou <limodou在gmail.com> wrote:
> > > > > 我可以先看一下相关的东西,看一看时间来得及可以考虑。
> > > >
> > > > 你有没有可控制的svn server,我可以把代码提交进去
> > > >
> > > 可以在code.google上创建一个项目,然后把我加进去。
> > >
> >
> > done
> >
>
> 链接是什么?

你在自己的profile里面可以看到,cudoc
你管理下有个openbookplatform项目,是类似的项目吗

-- 
with kind regards

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

2007年05月20日 星期日 12:25

limodou limodou在gmail.com
星期日 五月 20 12:25:48 HKT 2007

> 你在自己的profile里面可以看到,cudoc
> 你管理下有个openbookplatform项目,是类似的项目吗
>
我那个是访djangobook.com的项目,不过增加了多用户管理的功能。

-- 
I like python!
UliPad <>: http://wiki.woodpecker.org.cn/moin/UliPad
My Blog: http://www.donews.net/limodou

[导入自Mailman归档:http://www.zeuux.org/pipermail/zeuux-python]

如下红色区域有误,请重新填写。

    你的回复:

    请 登录 后回复。还没有在Zeuux哲思注册吗?现在 注册 !

    Zeuux © 2025

    京ICP备05028076号