User:JulienDethurens/Wiki

This article is a summary of where we are currently at with templates and what you should use when writing articles. It will probably require some adjustments, suggest them on the discussion page or edit the page to do them yourself.

Just as a note, this is not a guideline or anything. It is just to help writers and editors not get confused.

Members

Members (properties, events and methods) should be on their own page, named from their name followed by their type (e.g. FindFirstChild (Method)). The page with the name of the member (in the case of the previous example, FindFirstChild), should be a redirect to the page of the method.

Similar articles

If there is another article which is related to the name of the redirect page, do not make the redirect page redirect to a disambiguation page or be itself a disambiguation page! Instead, edit the page the redirect redirects to and use the {{redirect}} template to link to the other article.

If there are many other articles which are related to the name of the redirect page, do the same thing, but instead make the {{redirect}} template link to a page with the same name as the redirect page, followed by " (disambig)", and create a disambiguation page at that location.

Type of properties

Property pages, even though most of them still use the property argument, should be converted, if possible, to instead use the type argument, which should either use the {{type}} template to indicate the type, either contain a link to the page of the type. However, using the property argument is not wrong, this just means that new property pages should instead use the type argument and that older property pages should be slowly converted to use the type argument instead.

Objects

The same rules about similar articles should apply to objects as to members. An example is the Instance page, which redirects to the page of the Instance object.

Just to make it clear, the {{ObjectPage}} template should always be used and the other object templates should never be used directly (because they are all either inserted by the {{ObjectPage}} template, or deprecated).

Titles

Page titles should always start with a capital letter (the MediaWiki software imposes this, anyway). However, the rest of the words should not be capitalized unless they are normally capitalized in a normal sentence. The same applies to section titles. There are many articles on the wiki which do not follow this, and it should be corrected when possible, though correcting them is not an emergency and capitalizing the title incorrectly is not a crime.

Also, note that titles should ideally never be questions, should never end with punctuation (except when the punction is there as a part of a name) and should never contain links, especially where only part of a heading is linked.

This is described here.

Red links

There is nothing wrong with red links and links that point to inexistant pages should not be removed just because they point to inexistant pages. Of course, links pointing to articles that have no reason to be created should be removed, however, links are good even if they point to an inexistant page.

This is described here.

Code

Lua code, ideally, should always be used either with the {{code and output}} template, either be used with the {{code}} or the {{lua}} template. Putting code in a <code> tag, with or without the lua argument, is not bad, but it is preferrable to use the {{code and output}}, {{code}} or the {{lua}} template. Output which can not be used with the {{code and output}} template should be contained in a <samp> tag, which can optionally be contained in a <pre> tag for the appearance.

Completeness

When adding a new object or member, don't create the page just so it's there, because that's really easy to do. Anyone can do that. Be exceptional by first researching what the object does. If you're stumped, ask for help on the object's talk page.

When adding examples for members, make sure they show the full usage. If a method has arguments, use them. If an event has parameters, use them. Try to come up with an example that's actually useful, instead of just printing a string to show that it works. Once again, if you're stumped, ask for help on the member's talk page.

If you plan on creating a page for an object or member without having researched it, don't bother!

External links

• Wikipedia's manual of style