Differences between revisions 2 and 3
Revision 2 as of 2015-10-22 08:14:41
Size: 26960
Editor: BoyuanYang
Comment: link bug fixes
Revision 3 as of 2016-01-02 12:25:48
Size: 26966
Editor: ?lipengbo
Comment:
Deletions are marked like this. Additions are marked like this.
Line 130: Line 130:
== Disambiguation banner == == 避免模棱两可的标题 ==

Translation(s): English - Español - Français - Indonesia- Русский - 简体中文

(!) Discussion


本页面为希望编辑 wiki.debian.org 的内容的人们提供指导。

如果你是新加入的编辑者,也请参考 编辑快速入门 页面。

(!) 请参见: HelpOnSmileys :-) HelpOnMacros 以及 HelpOnLinking 和简短的 HelpOnEditing

如需获得有关 moinmoin wiki 框架下格式化的一般帮助,请阅读 moinmoin 的 帮助目录 页面(可在侧边栏找到)。语法参考 页面同样很易于使用。你可以在 WikiSandBox 这个沙箱页面中进行实验。

如果你对本页面以下任何陈述有不同意见,请将其注释掉,并在 讨论页面 发起一个新的讨论贴。

你的账号

  • 你的维基用户名应当使用 "FirstnameLastname" 的格式("IrcNickname" 或者你的 Debian 开发者帐号名称也可接受)。

  • 你可以在 userprefs 页面调整你的时区设置。

你的维基个人主页

你可以在创建你的个人主页时使用 HomepageTemplate 模板。以下列出可能出现的内容点子,它们从现有用户的个人主页上整理而来,供你参考:

  • 你的全名;
  • 你在本维基以外所使用的个人主页;
  • 你的电子邮件地址;
  • 你的位置(城市与国家) 可对于时区等信息起参考作用

  • 如果你使用 IRC,你常用的服务器、频道与昵称;
  • 如果你是 Debian Developer(DD),你的登陆名(以及一个指向 http://qa.debian.org/developer.php?login=foobar@debian.org 的链接);

  • 非 Debian 开发者可以添加指向 http://bugs.debian.org/from:foo@bar.com 的链接;

  • 你的主要兴趣爱好(不必限定于 Debian 相关内容);
  • 你的 !ToDo/Done 列表;
  • 你的(某些)对开源社区的贡献(漏洞报告、写作、翻译、开发、维护、……)。

请确保个人主页页面底部添加了 CategoryHomepage 标签(如果使用 HomepageTemplate 模板的话已经默认存在)。

订阅页面更改

  • 你可以订阅自己感兴趣的页面,并在其被修改时收到通知。

密码遗失

如果你丢失了你的 wiki.debian.org 帐号密码,请前往页面 recoverpass,然后按照提示进行操作(填入你的电子邮件地址,然后点击 "Mail me my account data")。

写作风格、维基礼节

当前至少有有五类主要的维基页面风格:

Elements of good style for each type are explained further on their individual pages.

请在写作时保持平衡与公正。详细来说,这包括视觉效果上的平衡,以及避免添加含有主观偏见的内容。如果你发现你的评论具有争议性,请将其标记出来,这样他人在公开持有反对意见时将更加自由。

  • Don't make EveryThing into a UselessWikiName. Knowing when to make a new page is one of the hardest parts of WikiStyle.

  • RefactorMercilessly There is no page in the WikiUniverse that is finished. All content can be refined. See RefactoringWikiPages for many useful thoughts.

  • If the wiki topic is fairly long, then it would be good style to give a quick overview of what has been discussed in the topic as a sort of concluding paragraph. If a concluding paragraph cannot be easily written then perhaps the scoping of the topic was not right, and it should either be separated into subtopics or merged with others into one larger topic. This is common when ThreadMode meanders off topic.

See also this GoodStyle page.

超链接

不要滥用链接。如果链接过多,读者不会了解到到底哪个链接是真正有用的。你可以将某些链接移动到页面底部的 "参见" 部分(同样的,不要添加过多链接)。

如果该链接指向以另一个语言写成的页面,请在文字中附加“(in $语言)”的内容。例如: ?Something (in French)

也请参见 moinmoin 的 HelpOnLinking

内部链接

内部链接(指向本维基内部):

  1. [[FooPage]] 是一般被推荐的语法。

  2. [[SomeParentPagewith/FooPage|FooPage]] 常常被用来缩短子页面的文本显示长度。

  3. [[EditorGuide|editor guide]] 可被用来将链接名变为常见小写英文单词以适合在西文正文中出现。

  4. 不要 重命名 链接,例如 [[PageName|Another title]] (如果你必须这样做,它暗示该页面命名有误)。

在任何情况下,请确保链接标签对访问者是有意义的,即该链接不应当指向某些出乎意料的地方(常见做法是,链接标签应当与页面标题一致)。

如需在页面内部进行链接,你应当在目标位置定义一个锚,使用 <<Anchor(bar)>> 的语法。请参考 HelpOnMacros),然后使用 [[#bar|Bar Chapter]] 或者 [[Foo#bar|Bar Chapter]](在这里,Bar Chapter 是真实的段落标题)。

指向外部站点的链接

较好的标记出外部资源链接的方法是:

(避免以  [[http://www.foo.com|link label]] 这样的方式做出标记,此做法会隐藏目标 URL,除非上下文已经明确了内容的来源,如:"John Doe provides a script named test.sh.")

  • 建议在页面的最后一个部分成组地存放外部链接。
  • 请将该部分命名为 外部链接

  • 任何 "项目主页" 的链接均可放入该部分中,或者在没有其它外部链接的情况下,放入参见 部分。

Use InterWiki format to link to Debian packages, bugs, RFCs and Wikipedia articles.

外部站点指来的链接

如果有一个(重要的)页面被 Debian 以外的链接所指向,建议将页面添加上 CategoryPermalink 的链接,以避免无意的误删除。

格式化

起始部分

有一些内容被很自然地算入一个(可选的)“起始”部分,位于页面的顶部。它们包括:

  • 指向翻译版本的链接(请确保这些页面真的存在!),例如:

    Translation(s): [[de/DebianWiki/EditorGuide|Deutsch]] - [[fr/DebianWiki/EditorGuide|Français]]

  • A Discussion link, for controversial material: (!) [[/Discussion|Discussion]]

  • Compare DefaultTemplate

  • Don't use <<Include()>> macro for translations. Why? Because could overload this Wiki server if it's used on every page. 维基首页是唯一的例外。

避免模棱两可的标题

Sometimes, a page's name can be ambiguous. If this can't be avoided, you can insert something like this at the top of the page:

Disambiguation : This page is about Debian Conferences.
For Debian configuration management system, see debconf.

  • Sample:

    ||<tablestyle="width:65%;margin-left:35%;padding-left:30pt" style="border:1pt solid #b48;border-left:5pt solid #d4a">'''Disambiguation :''' This page is about ''Debian Conferences''.<<BR>> For ''Debian configuration management system'', see [[debconf]].||

Debian "official material" banner

Often, the content of a Debian wiki page is also covered by some piece of "official" Debian Documentation (or in some other "reference" location). The wiki page can still be useful for collaboration. It's a good idea to add a link to the reference location at the top of the page.

Sample link presentation to some official page, related to the current subject.

Table of Contents sections

If a page gets long, you might want to add a Table of Contents. See the example at the top of this page!

  • Sample (note how the table is indented with one space):

     <<TableOfContents(2)>>

FAQ sections

A typical FAQ section could be formatted like this:

Q. How do I do XXXX?
A1) You can do XXXX by doing X.
A2) You can do XXXX by doing Y.

Sample (notice the space at the beginning of the lines):

 Q. How do I do XXXX? :: A1) You can do XXXX by doing X.
 :: A2) You can do XXXX by doing Y.

Material that naturally belongs in an (optional) "footer" area at the end of the page includes:

Page Fragments

Not only code can be be reused - page content can too! If you notice that a given paragraph has to be repeated on many pages, you can reuse ("include") a page fragment each time. (Do not abuse this to duplicate content everywhere!)

  • A page meant to be included in another should be named */!PageFragment/*
  • Add a hidden comment (##) at the top of the page so people understand why it's "incomplete" (a fragment!)

  • See the <<Include()>> macro in HelpOnMacros

A sample is available at InstallingDebianOn and InstallingDebianOn/PageFragments/Philosophy. Also note how the page is included inside a table (but don't use this hack to bypass moinmoin formatting limitations: see Complex Formatting).

Advanced Formatting/Complex Formatting

Avoid using "advanced" formatting (using tables, include, etc.)

  • It's difficult to understand and maintain for you and other wiki editors.
  • It's difficult to read the diff of complex formatting.

  • The GUI editor may break your layout.

Images, media and attachments

See also: moinmoin's HelpOnLinking.

Add credits and copyright information at the bottom of the page where you attach an image, typically:

## attachments:
##  openlogo-100.jpg  Copyright 1999 "Software in the Public Interest" from http://www.debian.org/logos/openlogo-100.jpg

Attachment location

It's often a good idea to attach the image to the parent page (in case the image is reused in other subpages).

For translated pages, attach the image to the English version (internationalized/localized images should be attached to the internationalized/localized pages).

Screenshots

If you want to include a screenshot, you might want to store it on http://screenshots.debian.net/, then use :

  •  [[http://screenshots.debian.net/screenshot/amide|{{http://screenshots.debian.net/thumbnail/amide|Screenshot|width=160}}]] 
  • Note the package name appears twice in this block.

Example:

  • Screenshot

Image position

http://www.debian.org/logos/openlogo-nd-75.jpg

It is possible to shift the images to right of the page, thanks to CSS' float:right:

||<tablestyle="float:right; width:100px; background:transparent; margin: 0 0 1em 1em;" style="padding:0.5em; border-style:none;"> {{http://www.debian.org/logos/openlogo-nd-75.jpg}} ||
  • Note: adjust width:100px to fit your need.

"Work needed" tags

Translation(s): English - español - Português (Brasil) - Українська


A tag is a WikiName that has special meaning to the community. It is used to group pages, by searching for the tag and seeing all the pages that have it. Under MoinMoin wiki, one should use Categories.

WikiTags related to ongoing work on the wiki can be found at DebianWiki/Administration#Current_tasks.

Note: do not use the #deprecated processing instruction, as it prevents further editing of the page (e.g. to fix broken links). If you need to mark a page as needing to be improved/removed, use an appropriate WikiTag instead.

These tags are meant for wiki editors, not for visitors, so don't make them too intrusive; instead of putting a warning tag at the top of the page, insert it in the page's footer.

Pages

URL/page naming conventions

  • Use only CamelCase formatting (as opposed to Underscore_Separated).

  • The first letter of the first word should be upper case.
  • Special characters should be avoided in page names.
  • Slashes function to create (directory-style) groups of related subpages. If your page clearly belongs to a collection, you might consider creating it as a subpage - see for example the Moinmoin documentation SubPages.

  • For translated pages, see Translation section.

  • Picking an appropriate name is important. It should clearly state what the page is about and should contain the word visitors will search for.
  • Avoid ambiguous names - don't use, for instance:
    • "About"... about what? About the Debian OS, community, wiki...?
    • "Release"... does it mean previous releases, the current stable release, the release life-cycle, future release status, release process, release team, etc...

Creating a page

Before you create a page, ask yourself some questions:

  • Is a new page really needed? Might it already exist under a different name? Could the content be added to an existing page?
  • Does it comply with the wiki.debian.org Content guidelines?

If you decide to proceed:

  • Choose a name for a page - see URL/page naming conventions.

  • Search for an appropriate portal page on the CategoryPortal page (you may find more than one; choose the best)

  • Create a link to your new page in this portal, then click on it.
  • Pick the appropriate template (DefaultTemplate is recommended)

  • If your page relates to a subject already covered by some official Debian documentation, link to it at the top (see Debian official material)

  • Once the page is complete, make links to it from relevant pages (one link is often enough).
  • More hints:
    • Re-read it two days later (does it still look good?)
    • Subscribe to that page.
    • This page isn't "yours", so don't be offended when other people "improve" it.

See also: moinmoin's HelpOnPageCreation.

Renaming a page

Cool URIs don't change (w3). Still, sometime it's a good idea to rename a page when its name don't accurately describe the page content.

Before you rename a page:

  • Verify that this page isn't tagged with CategoryPermalink.

  • Use Google (or equivalent) to check whether the page is linked from outside this wiki. Search link:wiki.debian.org/FooBar. If it is referenced, think twice before renaming the page. If you rename the page, consider creating a redirect page and contacting the owner of the referring page to get the links updated.

  • Check if this page is linked from inside this wiki (open the page and click on the title to get the list of back links).

If you decide to actually rename the page:

  • Choose a name for a page. see URL/page naming conventions.

  • Make sure you update all the pages that used to point to the old name (type the previous page name into the search bar, then click "Text"!).
  • Also take care of translated versions of the page.

Note: If the page-rename seems to require a "redirect" page, that might mean that the page shouldn't be renamed!

Deleting a page

Read the Renaming a page hints, since they apply here too.

If you think a page should be removed, you can either:

  • Delete the page yourself (writing your rationale in the comment field).
  • or Tag the page with "CategoryProposedDeletion" so other editors can react (i.e. put the tag and explanation at the bottom of the page).

Don't be rude: do not copy-paste the content of an existing page into a new one, and delete the old page - this loses page history. Instead see Merging and splitting pages.

Again, if there are translated versions, deal with them too!

Merging and splitting pages

Reorganizing pages is a good idea. You are encouraged to:

  • Merge "duplicate" pages covering the same subject.
  • Merge similar page, if both are "too short".
  • Split long pages that cover more than one topic (but consider adding a <<TableOfContents>> instead.).

Try to preserve page history:

  • Use the Comment field to record the "before" and "after" page-names in splits or mergers.
  • Merge pages into one of the existing pages, not into a newly created page.

For translations: if you can't merge/split translated pages, add directions (comments) in the translated version so translators can keep up!

Redirect pages

On some occasions, you might want to create a "redirect" page (which automatically redirects the browser to the proper page).

Don't over-use this tool.

sample :

#redirect DestinationPage
go to [[DestinationPage]]

Note that #refresh isn't enabled on this wiki.

See also: moinmoin's HelpOnProcessingInstructions.

Categories

moinmoin wiki's help: using categories.

The list of categories used on this wiki: CategoryCategory.

Portals

Portals are hub pages containing links to articles. They complement the relational structure offered by CategoryCategory, and the integrated search engine.

Portal pages should be based on PortalTemplate.

Turning pages into portals

To make your article into a portal page, add the tag CategoryPortal to its footer and find an appropriate portal to attach it to.

Don't create portals full of dead links.

Image Data Base

Commonly-used icons and portal logos can be centralized to Portal/IDB. This is useful for translated portals and for making artwork consistent.

翻译

每个页面的顶端显示了本页面其它语言版本的链接——请参阅 Headers,以及 DefaultTemplate 的源代码示例。

基本原则如下:

  • 任何关于同一主题的维基页面可能拥有许多翻译,但是只有一个“原始”页面。
  • 鉴于原始页面总是由某一种语言写成,我们将其规定为使用美式英语版本作为原始页面。
  • 被翻译的页面使用以下的命名组合 "languagecode" + "/" + "EnglishName"。例如:

  • 当你修改某个翻译页面时 ,请同时更新英语版本,或者在英语版本上做出标记与通知。
  • 请尽量在所有语言的版本上保持页面布局相同,这样可以简化同步所需的工作(这一点尤其有用,因为它能够帮助那些对该页面所用语言不甚了解的编辑者寻找并更新某些页面信息)。
  • 如果该页面的英语版本不存在,请同样创建之。如果你编写英语页面有困难,也可只填入通用的页面头部与指向你的已翻译页面的链接。此时请确保你在页面上标出 UpdateEnglish 标签以供识别。

  • 如果该页面对于你使用的语言的翻译版本不存在,从复制/粘贴现有的英语版本内容开始,然后更新页面头部的信息以匹配页面名称,然后尝试翻译全文,具体步骤如下一段所述。

同步翻译内容

当你在更新页面,以使之与另一语言的版本相一致时(即,“同步”版本时),

  • 所有版本的页面应当保持相同的页面布局(格式化方式、段落顺序、等等);
  • 确保页面的版本清晰明了;
    • (或是)一次性更新整个页面,然后在页面顶部修改并标注“版本”号,
    • (或是)在你停止更新的地方添加上类似 ## TRANSLATION UPDATE STOPPED here 的注释作为标记。

  • 如果被翻译的页面比上游英文版更新:
    • (或是)自行更新英文版页面,如果你有能力进行的话(不要担心语法上的小错误——会有人去订正的),
    • (或是)在页面底部附加一个 "UpdateEnglish" 的标签,然后在“英文版本”的注释旁添加 "+ IMPROVEMENTS" 的提示信息。

维基翻译者

参与翻译维基页面的贡献者应当在他们的主页上添加 CategoryWikiTranslator 标签。

协助 wiki.debian.org

任何人都可以帮助改进 wiki.debian.org:

  • 只要你有能力,便可以帮助改进任何页面的内容;
  • 在你所访问的维基页面的底部添加你自己的评价与疑问;
  • 对页面进行语法检查(许多内容是由非母语用户贡献的);
  • 翻译 页面;

  • Search for backlinks to ?HelpWanted, FixMe and ToDo.

  • ReFactor anything you can.

  • Cleanup (see ThreadMode)

  • 将你安装、使用 Debian 的知识传递下去;
  • If you don't work in IT, you can create a page to explain how you use computers in your day-to-day work. Explain your problems and needs.

Debian 同样需要拥有非 IT 技能人员的帮助(法律事务、市场营销、组织活动、募捐款项、提升公众关系与知名度、等等)。请务必参见 http://www.debian.org/intro/help

推广宣传 wiki.debian.org

最好、最方便的宣传本维基方法是自己使用它,并且经由贡献有价值的内容来使它变得有用。(同时请遵守 ?内容指导方针)

当你在邮件列表、论坛或者 IRC 频道上被问及一个问题时,

  • 第一选项,也是最好的选择,应当是将对方指向正式的 Debian 文档内容(www.debian.org/*、man 手册页、README 文档 、等等)。如有必要,请向内容作者或维护者提出改进意见与建议;
  • 其次的选择应当是更新合适的维基页面,以此保证页面回答了该问题,并且将对方引导至该页面。

常见问题

Q) 我能够得到本维基全部页面的列表吗?

A) 可以,请查看 标题索引

Q) 如果这个维基的页面能够更好地组织起来,它会更加有用的吧?
A) 也许吧,但是一个结构化的维基大部分时候只是一个自相矛盾的说法。内容的精良是更加重要的。

Q) 有什么方法可以找到孤立文章吗?

A) No (OrphanedPages is broken; links in the form [[PageName|Link Label]] aren't counted). But being an orphan is only a problem if there are pages that should link to it and don't (so fix those), or if the page fails to show up in searches (so make sure it includes the appropriate keywords).

Q) 我该如何跟踪内容更改?
A) 你可以使用侧边栏的两个功能:
  • 指向“最近改动”页面的链接(对访客限制在两周以内,登陆用户可查看90天内信息);
  • 订阅选项,当页面发生修改时将发送电子邮件提示信息。

技术信息

本维基使用 moinmoin 软件,版本号为 1.9 (请查看维基 配置信息)。它目前运行在由 Dembach Goo Informatik GmbH & Co KG 赞助的机器上(兼有硬件、场地与带宽支持)。