Difference between revisions of "Help:Wiki Editing Style Guide"
sigh, how long has Wrye's stuff been here? Way to unilaterally decide our stylistic mores, Wrye. No, we don't want subpaging. Yes, we do want tutorials. Sigh. Good thing no one reads this.
imported>Wrye (→Style: Page titles, person. A bit blunt, probably ought to be toned down a little.) |
imported>DragoonWraith (sigh, how long has Wrye's stuff been here? Way to unilaterally decide our stylistic mores, Wrye. No, we don't want subpaging. Yes, we do want tutorials. Sigh. Good thing no one reads this.) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 71: | Line 71: | ||
By adding yourself to the appropriate [[:Category:User Categories|User Lists]], you let us know a bit about yourself. It's a great way to start here at the Wiki! | By adding yourself to the appropriate [[:Category:User Categories|User Lists]], you let us know a bit about yourself. It's a great way to start here at the Wiki! | ||
==Style== | ==Style Do's== | ||
;Use appropriate Templates in an article. | |||
:The Wiki has a number of useful [[:Category:Templates|Templates]] for use in articles. In particular, the [[:Category:Article Tags|Article Tags]] can help draw the attention of editors to your page, and [[:Category:Structural Templates|Structural Templates]] like [[:Template:Function]] and [[:Template:Tools]] standardize the format of some of your information so it is easy for readers to get quickly. | |||
==Style Don'ts== | |||
Some specific rules on style (how to write pages): | Some specific rules on style (how to write pages): | ||
;Don't use colons in page titles. | |||
:Colons are used in wiki to designate namespaces (e.g. User:, Template:, etc.). While the article will generally behave correctly, it's best not to tempt fate. | |||
;Don't Repeat the Page Title | ;Don't Repeat the Page Title | ||
:The page title is automatically displayed at the top of the page (effectively as a level one header). Hence the title should not be repeated at the beginning of the page text. | :The page title is automatically displayed at the top of the page (effectively as a level one header). Hence the title should not be repeated at the beginning of the page text. | ||
;Don't | ;Don't Submit Useless Information | ||
: | :Keep in mind that the point of the Wiki is to communicate information that is ''likely to be useful'' to readers of the wiki. (Note the "likely".) I.e. don't describe some clever script that your wrote at length -- unless doing will likely be instructive to a good number of readers. If it will be useful, then trim it down to the bare bones that illustrates the information that you're trying to communicate. Or submit it in full, in a version that can just be plugged into a mod that uses it, at [[:Category:Useful Code|Useful Code]]. | ||
==Conclusion== | ==Conclusion== | ||