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

(!) Discussion


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

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

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

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

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

你的账号

你的维基个人主页

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

请确保个人主页页面底部添加了 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.

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

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 的链接,以避免无意的误删除。

格式化

起始部分

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

避免模棱两可的标题

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.

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!

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 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.)

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 :

Example:

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}} ||

"Work needed" tags

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.

Currently used wiki tags:

  • FixMe - Here is something that needs to be fixed.

  • ToDo - Here is something that needs help to finish.

  • CleanMe - WikiTag related about last migration from Kwiki engine to current MoinMoin engine

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

Creating a page

Before you create a page, ask yourself some questions:

If you decide to proceed:

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:

If you decide to actually rename 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:

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:

Try to preserve page history:

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 的源代码示例。

基本原则如下:

同步翻译内容

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

维基翻译者

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

协助 wiki.debian.org

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

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

推广宣传 wiki.debian.org

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

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

常见问题

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 赞助的机器上(兼有硬件、场地与带宽支持)。