统一用户手册风格

15条评论 / 作者： /

请用户手册编写组成员注意，现在要求统一手册的编写风格，以下有两个简单的范例：
http://www.magiclinux.org/drupal/?q=book/view/155
http://www.magiclinux.org/drupal/?q=book/view/313

在表达命令时使用jackey定义的css，另外请注意命令前 $ 和 ＃ 的不同。

其他还有什么要统一的，请在这里提出，你可以通过在自己章节做个范例，然后请jackey 做成css定义，供大家调用。

另外还有些章节还没有完成，还请注意，如果你不能完成，请告知。

打赏微海报分享

15人评论了“统一用户手册风格”

  1. epaulin

    这个我一直在考虑
    我希望可以将目前的文档转换为DocBook格式，回到学校后一直在研究DocBook，虽然还不能够太明白，不过大体上可以把握了。

    下个星期我希望自己可以抽出空来解决这个问题，至少是作快砖头。
    这个星期时间太紧。

  2. epaulin

    TO jackey
    DocBook早就已经支持中文了，包括PDF打印的输出，不过可能会困难点。
    输出中文HTML的文件，一点问题都没有。
    晚上我可以拿个例子给你看。

    如果说要统一现在的手册风格，最好方法就是使用DocBook。
    比如对于图片的格式要求，对于GUI上的文本、菜单、按纽，用户屏幕显示，输入等等，DocBook中都有统一的定义。

  3. lovewilliam

    jacky，
    jacky，

    我的那个不知道可不可以了。。。

    还剩下一些鸡骨头，我把它办了，

    就完事了？

    淌过熊熊烈火，毫发无伤！

    1. timeout

      epaul
      首先我非常感激你们几位的全力支持，关于文档的风格和是否用docbook我认为应该由你们决定，而不是我来说。所以我想你应该给出一个比较详细的方案，大家认同后我负责配合就行了。docbook我用过，但是不知道怎样让它支持中文，如果你能先写一篇关于怎样让docbook可以用中文的说明将非常有说服力。还有就是你的考虑到如何和drupal配合使用的问题，如果不能和drupal配合，是不是可以用wiki来协同写docbook。网站现在一直在摸索中，不过drupal已经是非常让人满意了，但不能说是100%。如果有需要修改的地方，告诉我一声我尽量搞定。

      timeout=jackey

  5. akar

    我的用戶手冊第六章更新了
    以下是我負責的 [中文環境] 一章的連結:
    http://www.magiclinux.org/drupal/?q=book/view/240

    我想這樣也好, 我覺得那些 css標簽, 除了讓內容表現出來風格統一, 更讓編輯的人更有把握,更有條理地編輯內容.

    另外看了 epaul的 DocBook的資料, 的確是好東西. 讚~!, 讓我們總看到將來, 如果要用epaul的方案,看來大家要更努力了 (以前用gentoo的時候, 也試過gentoo自己的文檔統一方式, 用的是XML+XSLT, 也支持 CJK).

    **我更支持已經可行的解決方案(css)**
    ***to: jackey: 可否把pagetitle也統一風格, 改成 pageTitle?***

  6. 匿名

    我所负责的第三章恐怕不能完成了。
    前一段扭伤了脚，这几天电脑又坏了，目前已经没有M1.2的环境了。大概得等一个星期才行。

    1. epaulin

      图像一般是这样用的
      可以使用figure标记，也可以直接使用screenshot标记，我到现在都很迷惑这两种用法哪一种更好。

      具体的你看我的源码中的。

滚动至顶部