Difference between revisions of "Help:Discussion"

From Team Fortress Wiki
Jump to: navigation, search
m (Added necro rule, feel free to change the amount of time before it becomes too old, I just put what I generally do)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Help navbar}}
 
{{Help navbar}}
  
When editing '''discussion''' pages (especially open review sections), specific formatting and standards should be used.
+
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 [[Special:MyTalk|your own user talk]]. By following these simple conventions, you drastically increase the readability of a discussion.
  
 
__TOC__
 
__TOC__
  
==Signing==
+
== Replying to old discussions ==
Please sign your posts by adding "<nowiki>~~~~</nowiki>" to the end of your messages, or by clicking the signature button above the edit text box (second from the right).
+
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 "<nowiki>~~~~</nowiki>" to the '''end''' of your messages, or by clicking the signature button above the edit text box (second from the right).
  
 
'''Incorrect''':
 
'''Incorrect''':
Line 14: Line 17:
 
<pre style="margin-left:25px">This is some discussion text. -- ~~~~</pre>
 
<pre style="margin-left:25px">This is some discussion text. -- ~~~~</pre>
  
==Indentation==
+
{{Note|Note: If you see a User has forgotten to sign their message, use the template {{tl|unsigned}} and remind the User to add their signature}}
Please indent by using the ( ''':''' ) character before your comments. Do not use bulleted lists ( '''*''' ), as you may disrupt another users comments.
+
 
 +
== 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''':
 
'''Incorrect''':
Line 35: Line 41:
 
</pre>
 
</pre>
  
==Spacing==
+
=== Outdentation ===
 +
Please outdent by using the {{tl|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''':
 +
<pre style="margin-left:25px">
 +
:::::::I've hit 7 indents. -- Person A
 +
 
 +
::::::::I've hit 8 indents. -- Person B
 +
</pre>
 +
 
 +
'''Correct''':
 +
<pre style="margin-left:25px">
 +
:::::::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
 +
</pre>
 +
== Spacing ==
 
Always add a blank line between your comment, and that of the person above you.
 
Always add a blank line between your comment, and that of the person above you.
  
Line 56: Line 79:
 
</pre>
 
</pre>
  
==Flow==
+
== Flow ==
 
Place your comment ''below'' the person you're ''responding'' to.
 
Place your comment ''below'' the person you're ''responding'' to.
  
Line 81: Line 104:
 
</pre>
 
</pre>
  
==Section headers==
+
== Section headers ==
 
For clarity a section heading should be used when starting a new discussion topic.
 
For clarity a section heading should be used when starting a new discussion topic.
  
Line 104: Line 127:
 
I'm talking about something completely different. -- Person C
 
I'm talking about something completely different. -- Person C
 
</pre>
 
</pre>
 
By following these simple conventions, you drastically increase the readability of the discussion.
 
  
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 23:59, 12 January 2024

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