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>DragoonWraith m (Welcome to the Wiki moved to Help:Welcome to the Wiki: It belongs in the Help namespace, really) |
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.) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This is an introductory guide to contributing to the Wiki. It will describe what should be Wiki'd, how to do so, and what a good Wiki article should contain. This is a very important thing to read, if you aren't familiar with the Wiki concept. Also of note is [[ | This is an introductory guide to contributing to the Wiki. It will describe what should be Wiki'd, how to do so, and what a good Wiki article should contain. This is a very important thing to read, if you aren't familiar with the Wiki concept. Also of note is the [[Help: Wiki Editing Syntax Guide|Wiki Editing Syntax Guide]], which is all about how you do different things in a Wiki. | ||
First of all, know that you are very strongly encouraged to contribute to the Wiki - this resource is only as useful as we make it! There is no reason for anyone to be shy about editing a page and sharing some insights - this is very helpful to us all. | First of all, know that you are very strongly encouraged to contribute to the Wiki - this resource is only as useful as we make it! There is no reason for anyone to be shy about editing a page and sharing some insights - this is very helpful to us all. | ||
| Line 57: | Line 57: | ||
===User Pages=== | ===User Pages=== | ||
Your User Page can be found | Your User Page can be found [[Special:MyPage|here]] - write something in it! It's great for experimenting with Wiki syntax, and for telling us all a little about yourself. People may also leave you messages in your User Talk page - this is a great way to ask about other people, to ask questions of some of our very experienced modders, or to thank someone for making a great contribution to the Wiki! | ||
===Talk Pages=== | ===Talk Pages=== | ||
| Line 70: | Line 70: | ||
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 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): | |||
;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 | |||
: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 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== | ||
| Line 75: | Line 90: | ||
Now you have a pretty good idea what the Wiki is all about, and you're ready to start contributing yourself! | Now you have a pretty good idea what the Wiki is all about, and you're ready to start contributing yourself! | ||
But if you don't know Wiki syntax, that can be a pretty daunting task. For that reason, we also have [[ | But if you don't know Wiki syntax, that can be a pretty daunting task. For that reason, we also have the [[Help: Wiki Editing Syntax Guide|Wiki Editing Syntax Guide]]! Check that out if you have any questions! | ||
[[Category: Tutorials]] | [[Category: Tutorials]] | ||
[[Category: Getting Started]] | [[Category: Getting Started]] | ||