Help:Contributing

Work In Progress This is currently being worked on! Check back later for more information... hopefully.

Thank you for your interest for wanting to contribute to the Roblox Legacy Docs project! Apologies for the short page here, we have a lot of work to do.

Discussion

If you would like to discuss anything about the project - pages we should take a look at, ideas for new articles and guides, etc. it's recommended to reach us at the ROBLOX Client Search Discord server. There is a forum post dedicated to discussion about the project, and all the editors are in it. You may also contact the site admin, realjame, directly.

Getting started

Editing pages is exclusive to users with accounts, and account creation is private. Only User:Realjame can create accounts for new editors. But don't worry! It's not at all a complicated process to get an editor account.

Contact us, preferably in the Discord server, about getting an account. It's extremely lax, and as long as you have some previous history or knowledge with old Roblox, you'll most likely get an account. If you were already active in the Client Search server, it's practically guaranteed.

Things to do

There's always more work to do. Here's some quick links:

• Category:Unwritten_original_pages for new pages that are not yet written.
• Category:Lacks_media for pages without enough media (screenshots, diagrams, video recordings, etc.)
• Category:Low_quality_media for pages with low-quality media that should be replaced.
• Category:Needs_improvement for pages with low-quality writing (the topic is good, but the article should be rewritten to be more professional/readable/understandable/etc.)
• Category:Object_Needs_Description for objects in the API documentation lacking a description.
• Category:Unfinished_Object_Documentation for objects in the API documentation that are not fully documented.
• Category:Outdated_pages for pages that were either noticeably written before 2012 or partially write about the classic Roblox website or client.
• Category:Stubs for pages that have very little information and should be expanded.
• Category:Buried pages for pages with valuable info that deserve to be linked in a primary index (e.g. Tutorials) and/or in related articles.
• Special:Categories is a list of all categories/tags, so look through for any to-do categories not listed here.

Helpful links

• Special:SpecialPages is a list of all special pages.
• Special:NewFiles is a gallery of all images and videos, check here for existing icons you can reuse.
• Special:AllPages is a list of all pages on the wiki
• More reference links is to-do...

MediaWiki special pages

These pages are important templates for the site and generally shouldn't be touched.

• MediaWiki:Sidebar
• MediaWiki:Monobook.css is the CSS theme for the entire site. Don't edit it unless you really know what you're doing, and even then seriously consider!
• MediaWiki:Copyrightwarning2 is the message in the article edit page, below the summary input field and above the save button.

Page standards

This section is somewhat to-do, but here are some things to keep in mind:

Information is circa-2012

As a knowledge base for working with old Roblox clients, 2012 has been selected as the cut-off year for information, for 2 reasons:

1. This Wiki was started from an archive in mid-2012, so all existing information is written in that era or previous.
2. 2012 is arguably considered the cut-off year for "Old Roblox". While 2011/12 had appearance revamps and new features of their own, the appearance and gameplay still retains the classic energy started in 2006. Roblox gradually deviated away from that in the next 4 years.

No documentation of clients from future years may be written about on this wiki. In addition, articles noticably written in an earlier time must be corrected, this also includes screenshots taken in older Roblox versions. Please replace them with an equivalent screenshot taken in a mid-2012 client (on Novetus snapshots, 2012M).

Images must not be modern design

There are no plans or wishes by the editors to rework this wiki into a more modern, 2020s feeling website. We're keeping the look just the way it was in 2012. To that end, new images (primarily icons) must fit the style used in images uploaded by the original Wiki editors back then.

Here are some example icons we've uploaded recently. They are skeuomorphic with complex shading and texture.

There may be icons that resemble flat design, but they generally have a detailed design that does not fit with modern-day approaches, such as this checkmark.

Tip: When searching for images to use, add "before:2014" to the end of your search to only show results from before the specified year (in this case, 2014). You should also be wary of using copyrighted images.

Articles not to edit

Old user pages

Pages stored under original Roblox Wiki users are considered archived and shouldn't be edited. If they show up in categories, please avoid them. Generally, people stored articles under their account to show that it's a work-in-progress they're still writing. If you want to expand it and make it a real article, please fork it (copy the article and write it in a new non-user URL).

Archived pages

Speaking of archived pages, all pages with the "Archived" banner and/or in the Category:Archived_pages category shouldn't be edited in any way, except to further restore the article (by re-uploading missing images).

The only exception to these 2 rules is to replace external links with Wayback Machine archive links. Make sure to find an archive closest to when the article was last edited (check the history tab).

Editing help

Using MediaWiki

MediaWiki is the server software used to host this wiki. It's used by Wikipedia, Fandom, and many other wiki projects.

There's a lot to consider and keep in mind when writing a page, such as templates, categories, page structure, HTML elements, and more. MediaWiki can get complex at times, but there are a lot of help resources available.

Here are some useful resources, from the official MediaWiki help wiki, on editing pages.

Pages

• Editing pages
• Starting a new page
• Moving (renaming) a page
• Deleting and undeleting pages
• User page
• Talk pages (Note that we don't use talk pages. Article and project discussion is on the Discord thread)

Formatting

• Basic formatting
• Lists
• Links
• Tables
• Images
• Footnotes
• Code formatting with Lua syntax highlighting

MediaWiki stuff

• Templates
• Categories
• Namespaces
• Subpages
• Managing files
• Linking to files
• "Magic words"
• Redirects

For more help, here's a list of all help pages on MediaWiki, and specifically editing help articles here (or you can just use Google or the Discord thread for help).

Templates

Here are some commonplace templates on the Wiki, both in new articles by our team and existing articles.

Redirect

This template is used to indicate that another article might have been searched for by the user who followed a redirect to this page and links either to a disambiguation page, either to the article mentioned.

Usage

{{redirect|redirect|article[|text]}}

Note: text between brackets ([ and ]) is optional, text in bold represents a certain value (something you must replace) and the rest represents things that must be present as-is.

Parameters

1

The name of the redirect.

2

The article to link to. Should be either a disambiguation page, either another article the user might have been searching for.

3

The text that represents the difference between the current article and the other article. If you are linking to a disambiguation page, ignore this and it will be replaced by "other uses".

Example

Code

{{redirect|Help|Roblox Wiki:Help|help about this wiki}}

Result

"Help" redirects here. For help about this wiki, see Roblox Wiki:Help.

Up one category

This template gives a link box in the top right corner of the page, linking back to a previous page to go to. Many pages have them, they provide a very easy to use interface to move around the wiki. Prevents dead ends, prevents lost users, prevents cancer. Use often. Should be noted, it embeds a wee bit into the top of an element. Be careful with that. This template should be in the FIRST line of the page. Not the second or third, the FIRST.

{{CatUp|Main Page}}

Up one category:
Main Page

Emphasis Box

This is a documentation subpage for Help:Contributing.
It contains usage information, categories and other content that is not part of the original template page.

Creates this border and shaded background around something important, making it stand out. Yeah. You like that, don't you? Looks awesome, doesn't it? Use it on occasion, but try to not make entire pages filled with them. Comes in 12 colors (see Template:color), each in dark and light:

{{EmphasisBox|content|red}}

{{EmphasisBox|content|red|dark=yes}}

{{EmphasisBox|content|orange}}

{{EmphasisBox|content|orange|dark=yes}}

{{EmphasisBox|content|yellow}}

{{EmphasisBox|content|yellow|dark=yes}}

{{EmphasisBox|content|lime}}

{{EmphasisBox|content|lime|dark=yes}}

{{EmphasisBox|content|green}}

{{EmphasisBox|content|green|dark=yes}}

{{EmphasisBox|content|turquoise}}

{{EmphasisBox|content|turquoise|dark=yes}}

{{EmphasisBox|content|cyan}}

{{EmphasisBox|content|cyan|dark=yes}}

{{EmphasisBox|content|blue}}

{{EmphasisBox|content|blue|dark=yes}}

{{EmphasisBox|content|indigo}}

{{EmphasisBox|content|indigo|dark=yes}}

{{EmphasisBox|content|purple}}

{{EmphasisBox|content|purple|dark=yes}}

{{EmphasisBox|content|magenta}}

{{EmphasisBox|content|magenta|dark=yes}}

{{EmphasisBox|content|pink}}

{{EmphasisBox|content|pink|dark=yes}}

Gray boxes can be dark too

{{EmphasisBox/start|color}}
Content with tables
{{EmphasisBox/end}}

You can also put a table inside one:

a	b
c	d

by creating the the box like so:

Color

Generates a standard color (in hexadecimal format), with a modifier. Usage:

{{Color|orange|dark}} gives

#AC6E2F

A full list of colors is available on the template's page.

See also

See also: [[{{{1}}}]]

Object Templates

These templates are used for object API documentation.

• Protected item
• Derived classes
• Method
• Property
• Event
• Callback
• Class Reference

Tags/Banner Templates

"Tags", appearing as banners above the article, are important for alerting the reader about things that need to be done, or just a quality of the article itself (e.g it is archived). Using one will add the page to the tag's category, to help editors know what needs immediate improvement.

Stub

Categorize pages as a stub when there is either little information on the page, or none at all. These pages need some love, so if you know what you are doing, then go ahead and try to expand them.

Stub This article is a stub. If you think you know more about this than we do, please help us by contacting a writer. Thank you!

Outdated

Pages marked with this are outdated for varying reasons:

• It reflects an older version of Roblox or is noticeably written before 2012.
• The article is partially about the Roblox website or client as of 2012, which no longer exists in that state.

In the first case, they must be rewritten to fit the "information is circa-2012" standard. In the second, the article must be edited to remove or rework any references to the Roblox website or client. Outdated pages are categorized in Category:Outdated_pages.

Outdated Page This article has outdated information. Please update this page to fit our current standards!

Archived

If an outdated article is solely dedicated to the Roblox website or is otherwise historically valuable, mark it as archived instead. It will be added to its own category.

Archived Page This article has outdated information. It is now archived, only kept for historical purposes. Generally, outdated articles write about how to use or interact with the Roblox website. The services and features as written at the time have been changed or removed by Roblox Corporation. External links may be substituted with a Wayback Machine or Roblox Forum Archive link.

For clarity, the difference between an archived and an outdated page is like so:

• If the article is about the Groups feature on Roblox.com, it has to be archived. Groups were only a feature on the website, which doesn't exist as it did in 2012.
• If the article is a tutorial about how to build your place and it mentions how to select Roblox's default maps, it should be marked as outdated, not archived. The topic of the article is good, because you can still use the old Roblox client via 3rd party launchers and build a place in Studio, simply remove the mention of that defunct feature.

Template:Placeholder

For planned new articles that haven't been written yet. Feel free to take the initiative and start them, even a basic outline or a stub is good enough.

Placeholder This article is empty. We are still planning this article and what it will contain exactly! Sorry for the inconvenience.

Work in Progress

If a page is unfinished, let readers know by adding this tag to the start. It'll also add the page to [[:Category:WIP_Pages}}.

Work In Progress This is currently being worked on! Check back later for more information... hopefully.

Needs Improvement

To quote TCRF:

"Oh boy... Some articles look like they were made by people who have no idea how wikis work. At least they're trying to help out... right?
Anyway, use this template, like so: {{Sucks|reason=The grammar... the image alignment... the poor jokes...}} to point out that this page needs a rewrite."

This page sucks. If you could make it suck less, that would be awesome. Specifically: The grammar... the image alignment... the poor jokes...

Lacks Media

Pages should have media. Some examples of "media" are:

• Screenshots
• Diagrams
• Video recordings

If a page is lacking media, tag it as such. They'll be put in Category:Lacks_media. Template:LacksMedia

Low Quality Media

A page's media may be considered "low quality" for several reasons:

• It is blurry, low resolution, or has watermarks.
• It is outdated (e.g a screenshot of a Windows XP menu or pre-2012 client).
• It is quite simply bad: poorly made and/or unhelpful.

To improve the media, replace it with a higher quality one, which is easier said then done. It's not required to make a pixel-perfect recreation, one that gets the point across like the original will work fine. Either way, making new media for the article will generally require you to make a new map from scratch in Studio, and if it's a tutorial, to follow and do the tutorial. For diagrams, make a new one in your favorite image editing software.

Non-Standard Feature

While the Wiki's info is up to the 2012 client, we still care for previous versions of the game. Some features aren't available in later versions (like DHTML) and some aren't available in earlier versions (like Dialog and Terrain). Use this template to alert the user that they won't be able to use this engine feature in all versions of the game.

(Note that "standard" is kind of a vague definition. Currently, it means the 2010 client.)

Ouch! The following article, Contributing, mentions a feature exclusive to certain versions of the client. Specifically: {{{reason}}}

Buried

Articles marked with this have valuable information but are difficult for people who need the info to discover it.

This page is buried deep in the archives... The following article, Contributing, has valuable information, but is only available through another page or lacks direct links to it entirely! Please show this page some appreciation by including it in a primary index (e.g. Tutorials) or providing more prominent links to increase its visibility!

Not Creatable

If an object documentation page is tagged with this, it notes that the object cannot be created in Studio using Instance.new. You can optionally add a note if it's creatable or not in specific versions.

Not Creatable This object, Contributing, cannot be created through normal means, such as Instance.new! You probably can't use it in your game, or it's used internally by the Roblox engine. Note: Not creatable in 2009E, but can be created in 2009M+.