Difference between revisions of "Help:Discussion"

From Team Fortress Wiki
Jump to: navigation, search
m (1 revision: Imported from TF2 Wiki.)
(This is the best way I could incorporate the outdent template, but I can't see it mentioned anywhere before. I've set the max at 7 or 8 for now, feel free to disagree.)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{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), specific formatting and standards should be used.
  
 
__TOC__
 
__TOC__
  
==Signing==
+
== 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).
 
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).
  
Line 12: Line 14:
 
<pre style="margin-left:25px">This is some discussion text. -- ~~~~</pre>
 
<pre style="margin-left:25px">This is some discussion text. -- ~~~~</pre>
  
==Indentation==
+
== Indentation and outdentation ==
Please indent by using the ( ''':''' ) character before your comments. Do not use bulleted lists ( '''*''' ), as you may disrupt another users comments.
+
=== Indentation ===
 +
Please indent by using the colon ( ''':''' ) character before your comments. Do not use bulleted lists ( '''*''' ), as you may disrupt another users comments.
  
 
'''Incorrect''':
 
'''Incorrect''':
Line 33: Line 36:
 
</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 54: Line 74:
 
</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 79: Line 99:
 
</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 107: Line 127:
 
__NOEDITSECTION__
 
__NOEDITSECTION__
 
[[Category:Help]]
 
[[Category:Help]]
 
[[Category:Every page]]
 

Revision as of 20:55, 13 September 2021

When editing discussion pages (especially open review sections), specific formatting and standards should be used.

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

Indentation and outdentation

Indentation

Please indent by using the colon ( : ) character before your comments. Do not use bulleted lists ( * ), as you may disrupt another users 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

By following these simple conventions, you drastically increase the readability of the discussion.