User:JASON10668/中文条目编辑规范

From NetHackWiki
Jump to navigation Jump to search

本页面为NetHackWiki的简体中文条目提供格式指引,此规范目的在于统一各条目的编辑风格,让阅读和编辑更方便。如果对此规范有任何疑问和修改建议,请在本页面的讨论页发起话题。

一般原则

下文列举您在NetHackWiki编辑简体中文条目时需遵循的最基本原则:

  • 信息的传达应简明扼要:能用更短的句子表达清楚的内容就不要写得太长太复杂,但同时也要避免模棱两可或过分注重细节的表达。
    • 在单个条目内,除去调用特定模板的情况外,尽量避免多次提及重复的信息。
    • 条目提供的信息应当集中于大多数玩家在正常地游玩游戏时容易遇到的情况,有时也许会有值得一提的边缘情况,但不应该着墨太多。
  • 编辑完成后,建议使用“预览”功能彻底检视一遍修改的内容,尽量用更少的编辑次数达成目的。
  • 本指引提供的所有原则并非强制。除去蓄意破坏和编辑战之类的行为外,大多数的错误都是允许的。wiki协同编辑的特点使得它能够通过众人的努力逐步完善,请大胆地提交编辑,哪怕它不那么完美。
  • 谨记编辑界面下方的提示语:请注意,您对NetHackWiki的所有贡献都可能被其他贡献者编辑,修改或删除。如果您不希望您的文字被任意修改和再散布,请不要提交。
    您同时也要向我们保证您所提交的内容是您自己所作,或得自一个不受版权保护或相似自由的来源(参阅NetHackWiki:版权声明的细节)。不要在未获授权的情况下发表!

如想了解更多本指引未提及的,关于维基编辑的格式指导,可以参考中文维基百科的格式手册。NetHackWiki并非维基百科的附属,不适用维基百科的规则,但其格式指引仍然可以为不同能力水平的编辑者提供参考。

翻译

将已有英文条目翻译为简体中文是本wiki的简中版块建设工作的主要内容。

语气

NetHackWiki既是游戏百科,也有攻略指引的功能,但其主命名空间的条目仍应当以百科式的语气撰写。撰写时应当清晰地区分客观信息和主观观点,主观性较强的攻略和提示内容应当放置到专门的章节里。

链接

wiki通过[[双层方括号]]来创建内部链接,比如“[[电子虫]]”显示为电子虫。你可以利用管道符“|”来让链接显示成其他文本,例如[[阿斯克勒庇俄斯之杖|A杖]]显示为A杖

通常来说,条目内首次提及游戏内的某个概念时,应当为它创建链接,后文该概念重复出现时,也可以重复创建链接,但大多数情况下没有必要。如果需要并列多个同类概念的链接,不要将它们“嵌入”条目的各个词汇里,这会让阅读者难以辨认链接,条目编辑也会变得麻烦。在适当的地方插入括号并在其中列出各个链接更好。例如说,“非亡灵的巨人(如火巨人霜巨人风暴巨人等)”就比“亡灵的巨人”更好。

Article names

Try to be consistent when naming new and existing articles:

  • Name most pages with lowercase letters, like scroll of identify, but use uppercase for proper nouns, like Amulet of Yendor. By default, MediaWiki forces the first letter of a page name to be uppercase.
  • Prefer singular to plural for article names, e.g. unicorn instead of unicorns.
  • Try to avoid conflating disparate-but-related subjects where possible. As an example, identification, scroll of identify, and spellbook of identify all deal with identifying items, but are very clearly distinct: the first concerns how identification in general functions, the second concerns a specific item that fully identifies objects, and the third concerns both the spell used to identify objects and the spellbook that teaches that spell.

The first time the article name appears in the main text, it should be bolded. This includes the titles of any redirects that point to the article or a section within it. Example: "Gauntlets of power, sometimes abbreviated to GoP, [...]"

Redirects

Main article: NetHackWiki:Redirects

Redirects are used as a form of convenience for readers and editors alike, and are typically employed for the following purposes:

  • Alternate subject names, including any spelling, capitalization or hyphenation recognized by NetHack or a variant of NetHack
  • Frequently-used community terms
  • Topics that are a subset of a primary article
  • Keeping links to a page active after it has been moved, even once internal links are updated; this also applies for links in edit summaries

See the article above for the types of redirects used on NetHackWiki, and see metawikimedia:Help:Redirect for help creating redirects.

New articles

Do not create empty new articles or new articles that contain nothing but the {{stub}} message just in hopes of seeing someone add more content to them. Add the content yourself! A "{{stub}}"-only page is somewhat like applying a magic marker to write a blank scroll. Bare-minimum content stubs are also discouraged as well: an acceptable stub should have enough of a foundation for you or other editors to actively build on. Remember that articles which are not as complete as they could be are not necessarily stubs: even longer articles may be in need of some TLC, and length does not always translate to completeness.

With all of the above in mind, remember that certain subjects may not always require a full-length article to cover in their entirety, and some of these articles may even be merged into others - it is fine for multiple articles to cover different aspects of a subject, provided there is sufficient focus on those aspects to keep the articles distinct. Do a thorough search beforehand to make sure that the new article's information is not needlessly duplicated from elsewhere on the wiki. If you do not know about the subject, learn about it or ask politely at the Community Portal for someone to create the article.

Capitalization

In general, if the game or the source code capitalizes something, it should be capitalized the same on this wiki, e.g. "Archon", "Book of the Dead", and "Moloch's Sanctum" - "Archon" is an example that is not normally capitalized in a majority of instances, but should be capitalized when referring to the NetHack monster. Conversely, do not capitalize things that the game does not capitalize and treats like common nouns (most monsters and objects fall into this category), e.g. "luck", "potion of hallucination", "tiger", and "rust trap". "Luck" in particular refers to the in-game luck stat, rather than factors such as RNG falling in a player's favor or not, and should be left uncapitalized - for this case, it is best to use "fortune" or other synonyms when referring to the player's luck instead of the character's in-game luck.

Article organization

Each article should begin with a brief introduction before going into specifics. This introduction (also known as the "lede" in Wikipedia jargon) should be followed by the table of contents where possible, which is usually handled automatically for articles with multiple sub-headers. The highest header level that should be used is ideally level 2 (i.e. ==This==), with the highest-level headers (i.e. =These=) reserved for the article main title, though some exceptions may occur.

章节名称

大部分条目都使用统一的章节结构,常见的章节名称如下:

  • 生成(Generation)
  • 描述(Description)
  • 地图(Map/Maps)
  • 策略(Strategy)
  • 消息(Messages)
  • 衍生作品(Variants)
  • 神话(Mythology)
  • 历史(History)
  • 百科文本(Encyclopedia entry)
  • 另请参阅(See also)
  • 引用及注释(References)
  • 外部链接(External links)

“生成”章节用于解释条目介绍的事物在何处寻得或如何创造出来。

“历史”章节用于记录条目介绍的对象在NetHack的早期版本中有何不同。关于条目介绍对象在现实或神话故事中的历史,则应该根据实际情况纳入“神话”或“起源”章节。

“百科文本”章节记录条目介绍对象在NetHack百科中的文本。文本应使用{{encyclopedia}}模板引述。该模板会原样显示文本里的空白字符(类似于HTML的<pre>标签),因此,请删除文本中不需要的换行和空格。不同浏览器的窗口宽度差异很大!除去翻译外,不要修改这些文本,它们应当与游戏中的百科原文保持一致。

Categories

Each new article should have at least one category assigned to it; read the category tree to find an appropriate one. Remember to update that tree if you create a new category.

表格

本wiki中的大多数表格都使用MediaWiki:Common.css的prettytable样式。调用该样式的方法如下:

{| class="prettytable"
! 表头 1
! 表头 2
|-
| 单元格 1
| 单元格 2
|-
| 单元格 3
| 单元格 4
|}

显示为:

表头 1 表头 2
单元格 1 单元格 2
单元格 3 单元格 4

你也可以在样式列表中添加“striped”(为表格添加深浅条纹样式)和“sortable”(将表格变为可排序的)样式。

Colored NetHack glyphs

For example: A, n, D

Use the 16-color function templates for displaying individual symbols. For monsters you should usually use {{monsym}}, or {{monsymlink}}.

To make colored ASCII screenshots, wrap the function templates in <div class="ttymap"></div>, or use User:Paxed/ReplaceCharsBlock with ruleset {{ttymap}} to allow easier editing.

While editing an article, it's possible to have a "popup" window where you can select the colored symbols with mouse; Just click the "Color symbols" link at the bottom of the page.

Item pages

Put the appropriate template out of Template:scroll, Template:potion, Template:ring, Template:wand, Template:spellbook, Template:weapon, Template:armor, Template:comestible, Template:amulet, Template:artifact, Template:artifact weapon and Template:tool at the top of the item page, or Template:item for any other type of item.

Each item page should also list the effects of the item, and any messages that item can generate. Tips and strategy relating to that item should go next, and if there is an entry from the NetHack encyclopedia, that can go at the bottom. Use potion of object detection, scroll of amnesia and scroll of genocide as guides.

Variants and coverage

There are a plethora of NetHack variants, and many of them both add new features and gameplay elements and make substantial changes to existing ones from the version of NetHack that they are iterated upon. Articles covering variant-related subjects in part or in whole should adhere to the following guidelines:

General variant guidelines

  1. For capitalization of variant names not listed below, consult the variant's main page.
  2. Variants should always get their own articles if possible, along with their added features that do not originate in NetHack.

Variant sections on NetHack articles

  1. Only add variant information to an article if it covers a substantial change to the article's topic and has an impact on strategy. Changes to other elements that impact strategy involving the article's subject may be too tangential to cover on that article.
  2. For articles on NetHack subjects where multiple variants are covered, create a 'Variants' section using a level-two header (e.g. "==Variants==") near the bottom of the page, just above the encyclopedia entry. Information specific to each variant is then given a level-three subsection within that section: if there is only one applicable variant to cover, then it is acceptable to have that variant occupy a section with a level-two header. In either case, keep the main body of a NetHack article focused specifically on vanilla NetHack: avoid paragraphs, sentences, parentheticals, or asides referencing a variant outside of its section.
  3. Avoid further subdividing a single variant's section into more subsections if possible - if a variant section has multiple level-four section breaks, then it may be more ideal to split that section into its own article.
  4. If a NetHack subject has an article(s) dedicated to its appearance in a specific variant(s), the article(s) in question can optionally be linked in the appropriate subsection within the vanilla article's Variants section. This link should be accompanied by a brief summary of the relevant changes made - don't create a subsection just to provide a link to the main article.
  5. Never add variant categories to a vanilla NetHack article - use them only for articles which are entirely about a variant(s) of NetHack.

SLASH'EM

For the sake of convention, though there is no consensus on an "official" spelling, the name of the variant SLASH'EM should be written in all-capital letters to reflect its status as an acronym.

GnollHack

Per the request of GnollHack developer User:TommiGustafsson‎, top-level GnollHack-specific articles should be created as a subpage of the primary GnollHack article, e.g. GnollHack weapons should be listed in an article titled [[GnollHack/Weapons|GnollHack weapons]] (which displays as GnollHack weapons).

Source code

When writing a piece of factual information, you may wish to document it by linking to the source code like this:

The vibrating square level is not eligible to leave bones files.{{refsrc|src/bones.c|36|nethack=3.6.0|comment=vibrating square does not leave bones}}

which looks like this:

The vibrating square level is not eligible to leave bones files.[1]

If the reference is placed after a word with a punctuation mark, don't insert it between the word and the punctuation mark; put it after both.

You must include the <references/> tag at the bottom of the page like this:

==References==
<references/>

That will create a list of footnotes:

  1. src/bones.c in NetHack 3.6.0, line 36: vibrating square does not leave bones

The templates {{refsrc}}, {{reffunc}}, {{sourcecode}}, and {{function}} are designed for use in source code references.

Other useful templates

Main article: NetHackWiki:Templates

{{DOD}} should go at the bottom of every page which is based on a spoiler by Dylan O'Donnell.

{{disambig}} should go at the bottom of every disambiguation page, e.g. Fire. A disambiguation page is a list of links to articles all associated with the same title.

{{stub}} can be used on a page to plea for someone to expand it. From time to time, some editors will look over Category:Stubs for articles to expand. It can take no parameters, or it can take an optional parameter explaining what needs to be expanded:

{{stub|What's the best strategy for killing the Wizard of Yendor?}}

{{merge}} is a plea for someone to merge a page with another, or several others. You should give details of which other page you mean in the parameter:

{{merge|Some of this information belongs in [[this article]].}}

{{otheruses}} is for a page whose title has multiple meanings, like Izchak. In many cases, a disambiguation page may be more appropriate, but where one meaning dominates the others, it deserves the page title. Also see the {{for}}, {{for2}} and {{distinguish}} templates.

{{main}} can be used to link to the main article for a topic, per this section:

{{main|NetHackWiki:Templates}}

{{upcoming}} is for changes that have been made in an unreleased future version of NetHack. Since the development version is subject to change, it would be premature to try and document new features in the regular page text, so use this instead.

Namespaces

Anything to do with NetHack belongs in the main article space. Anything to do with NetHackWiki belongs in the NetHackWiki namespace.

User pages

You can create a vanity page in the main namespace if you want to, but unless you are famous or otherwise notable it would be a better idea to create a NetHackWiki account and put personal information on your own User page.

Sign your posts

When writing on an article or user's talk page or certain community pages, sign your posts with four tildes, ~~~~. That will automatically expand to your signature with timestamp, as in "ZeroOne 17:57, 15 August 2006 (UTC)".

Dealing with unsigned comments

The templates {{unsigned}} and {{unsigned2}} can be used at the end of an unsigned comment to attach the username or IP to the comment. None of these templates automatically populate (fill in) the name or IP of the poster and the time of the post. That information is best copied from the history page and pasted into the following templates. Note: All of the unsigned templates must be substituted.

Wikimarkup Resulting code Resulting display
{{subst:unsigned|user name or IP}} {{subst:unsigned|Example}} — Preceding unsigned comment added by Example (talkcontribs)
{{subst:unsigned|user name or IP|date}} {{subst:unsigned|Example|11:15, 1 June 2005 (UTC)}} — Preceding unsigned comment added by Example (talkcontribs) 11:15, 1 June 2005 (UTC)

The template {{unsigned2}} does almost the same thing as {{unsigned}} when used with two parameters, but the ordering of the parameters is reversed. The resulting display is the same. This template may be useful when copying and pasting from the edit history, where the timestamp appears before the username.

Wikimarkup Resulting code Resulting display
{{subst:unsigned2|date|user name or ip}} {{subst:unsigned2|11:15, 1 June 2005 (UTC)|Example}} — Preceding unsigned comment added by Example (talkcontribs) 11:15, 1 June 2005 (UTC)

External links

When inserting an external link, if the link is to another wiki, consult the Interwiki table to see if there is a prefix available to use. For external links to other websites, remember to use https where possible so that the link remains secure for the convenience of readers (e.g. "https://example.com" instead of "http://example.com") - nethack.org in particular will put up a red-letter warning if accessed via http instead of https.

Make sure that the link itself relates to the article or section it is being placed in: using external links to deliberately spread spam, malware or other unwanted services is a blockable offense.