Help:Discussion

From Team Fortress Wiki
Jump to: navigation, search

When editing discussion pages (especially open review sections), the specific formatting and standards listed below should be used. It is not allowed to edit or remove another user's comments unless they are breaking one of the formatting rules listed below. The only place where you may remove another user's comment is your own user talk. By following these simple conventions, you drastically increase the readability of a discussion.

Replying to old discussions

Replying to old discussions, also known as a necro, should be avoided. If a topic should be discussed again, a new topic should be made instead. Generally, a topic will be considered too old to reply to if the last message on the topic was made 6 months ago or longer.

Signing

Please sign your posts by adding "~~~~" to the end of your messages, or by clicking the signature button above the edit text box (second from the right).

Incorrect:

This is some discussion text.

Correct:

This is some discussion text. -- ~~~~

Pictogram comment.png Note: If you see a User has forgotten to sign their message, use the template {{unsigned}} and remind the User to add their signature

Indentation and outdentation

Indentation

Please indent by using the colon ( : ) character before your comments. Do not use bulleted lists ( * ), as you may disrupt another user's comments.

Incorrect:

This is some discussion text. -- Person A

*I'm responding to Person A. -- Person B

**I'm responding to Person B. -- Person C

Correct:

This is some discussion text. -- Person A

:I'm responding to Person A. -- Person B

::I'm responding to Person B. -- Person C

Outdentation

Please outdent by using the {{Outdent}} template. A general guideline for when to use this template is to use it when you've hit over 7-8 or more indents. As a template parameter, use the amount of indents last used.

Incorrect:

:::::::I've hit 7 indents. -- Person A

::::::::I've hit 8 indents. -- Person B

Correct:

:::::::I've hit 7 indents. -- Person A

┌───────┘ 
I would have hit 8 indents, but have used the outdent template to make it look better. -- Person B

Spacing

Always add a blank line between your comment, and that of the person above you.

Incorrect:

This is some discussion text. -- Person A
:I'm responding to Person A. -- Person B


::I'm responding to Person B. -- Person C

Correct:

This is some discussion text. -- Person A

:I'm responding to Person A. -- Person B

::I'm responding to Person B. -- Person C

Flow

Place your comment below the person you're responding to.

Incorrect:

This is some discussion text. -- Person A

This is some more discussion text. -- Person B

This is also discussion text. -- Person C

:I'm responding to Person A -- Person D

Correct:

This is some discussion text. -- Person A

:I'm responding to Person A -- Person D

This is some more discussion text. -- Person B

This is also discussion text. -- Person C

Section headers

For clarity a section heading should be used when starting a new discussion topic.

Incorrect:

==Topic 1==
This is some discussion text. -- Person A

:I'm responding to Person A -- Person B

I'm talking about something completely different. -- Person C

Correct:

==Topic 1==
This is some discussion text. -- Person A

:I'm responding to Person A -- Person B

==Topic 2==
I'm talking about something completely different. -- Person C