Legacy Roblox Wiki

Help:Contributing: Difference between revisions

Help page Discussion

Help:Contributing (view source)

Revision as of 22:06, 18 April 2023

5,301 bytes added ,  18 April 2023
Flesh out the page a bit more
VisualWikitext
(Tags descriptions)
(Flesh out the page a bit more)
Line 1: Line 1:
{{WIP|reason=Page standards, useful quick links, editing help}}
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.
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.


Line 34: Line 36:
As a knowledge base for working with old Roblox clients, 2012 has been selected as the cut-off year for information, for 2 reasons:
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.
# This Wiki was started from an archive in mid-2012, so all existing information is written in that era or previous.
2. It's a heavily debated topic, but 2012 is generally considered the cut-off year for "Old Roblox". While 2011/12 had appearance revamps and [[RBX.lua.Dialog_(Object)|new]] [[RBX.lua.Terrain_(Object)|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.
# 2012 is arguably considered the cut-off year for "Old Roblox". While 2011/12 had appearance revamps and [[RBX.lua.Dialog_(Object)|new]] [[RBX.lua.Terrain_(Object)|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, [[:Category:Outdated_pages|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).
No documentation of clients from future years may be written about on this wiki. In addition, [[:Category:Outdated_pages|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).
Line 42: Line 44:
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.
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.


The best example of this is on [[Roblox|the home page]], with the original "Improvement Project" section. The icons look straight out of the 2012 wiki, being skeuomorphic with complex shading and texture, as seen with the magnifying glass icon and "new" icon.
Here are some example icons we've uploaded recently. They are skeuomorphic with complex shading and texture.


[[File:Magnifying_Glass.png|72px]]
[[File:Magnifying_Glass.png|72px]]
Line 48: Line 50:
[[File:NewIcon.png|72px]]
[[File:NewIcon.png|72px]]


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 the checkmark.
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.


[[File:Green_Tick.png|72px]]
[[File:Green_Tick.png|72px]]
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==
==Articles not to edit==
Line 64: Line 68:
=Editing Help=
=Editing Help=


There are a lot of templates, categories, and more to consider.
==Using MediaWiki==
 
MediaWiki is the server software used to host this wiki. It's used by Wikipedia, Fandom, and [https://bulbapedia.bulbagarden.net/wiki/Main_Page many] [https://wikirby.com/ other] [http://www.hrwiki.org/wiki/Main_Page wiki] [https://tcrf.net/The_Cutting_Room_Floor 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===
 
* [https://www.mediawiki.org/wiki/Help:Editing_pages Editing pages]
* [https://www.mediawiki.org/wiki/Help:Starting_a_new_page Starting a new page]
* [https://www.mediawiki.org/wiki/Help:Moving_a_page Moving (renaming) a page]
* [https://www.mediawiki.org/wiki/Help:Deletion_and_undeletion Deleting and undeleting pages]
* [https://www.mediawiki.org/wiki/Help:User_page User page]
* [https://www.mediawiki.org/wiki/Help:Talk_pages Talk pages] (Note that we don't use talk pages. Article and project discussion is on the Discord thread)
 
===Formatting===
 
* [https://www.mediawiki.org/wiki/Help:Formatting Basic formatting]
* [https://www.mediawiki.org/wiki/Help:Lists Lists]
* [https://www.mediawiki.org/wiki/Help:Links Links]
* [https://www.mediawiki.org/wiki/Help:Tables Tables]
* [https://www.mediawiki.org/wiki/Help:Images Images]
* [https://www.mediawiki.org/wiki/Help:Cite Footnotes]
* [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight Code formatting with Lua syntax highlighting]
 
===MediaWiki stuff===
 
* [https://www.mediawiki.org/wiki/Help:Templates Templates]
* [https://www.mediawiki.org/wiki/Help:Categories Categories]
* [https://www.mediawiki.org/wiki/Help:Namespaces Namespaces]
* [https://www.mediawiki.org/wiki/Help:Subpages Subpages]
* [https://www.mediawiki.org/wiki/Help:Managing_files Managing files]
* [https://www.mediawiki.org/wiki/Help:Linking_to_files Linking to files]
* [https://www.mediawiki.org/wiki/Help:Magic_words "Magic words"]
* [https://www.mediawiki.org/wiki/Help:Redirects Redirects]
 
[https://www.mediawiki.org/wiki/Category:Help For more help, here's a list of all help pages on MediaWiki], [https://www.mediawiki.org/wiki/Help:Editing 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.
 
===[[Template:Redirect|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 ====
 
<nowiki>{{</nowiki>redirect|'''redirect'''|'''article'''[|'''text''']<nowiki>}}</nowiki>
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 =====
 
<nowiki>{{redirect|Help|Roblox Wiki:Help|help about this wiki}}</nowiki>
 
===== Result =====
 
{{redirect|Help|Roblox Wiki:Help|help about this wiki}}
===[[Template:CatUp|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.'''
 
<nowiki>{{CatUp|Main Page}}</nowiki>
 
{{CatUp|Main Page}}


The rest of this section is to-do, sadly, except for the tags.


==Tags==
===[[Template:EmphasisBox|Emphasis Box]]===


Tags are important for alerting the reader about things that need to be done, or just a quality of the article itself (if it is archived).
{{EmphasisBox/doc}}


===Stub===
===[[Template:Color|Color]]===
 
Generates a standard color (in hexadecimal format), with a modifier.  Usage:
 
<code><nowiki>{{Color|orange|dark}}</nowiki></code> gives <{{1x|pre}} style="display:inline; display:inline-block; padding:0; border:none; background:transparent; margin:0;">{{Color|orange|dark}}</pre>
 
A full list of colors is available on the template's page.
 
==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.
 
===[[Template:Stub|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 [[:Category:Stubs|go ahead and try to expand them]].
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 [[:Category:Stubs|go ahead and try to expand them]].
Line 78: Line 170:
{{Stub}}
{{Stub}}


===Outdated===
===[[Template:Outdated|Outdated]]===


Pages marked with this are outdated for varying reasons:
Pages marked with this are outdated for varying reasons:
Line 89: Line 181:
{{Outdated}}
{{Outdated}}


===Archived===
===[[Template:Archived|Archived]]===


If an outdated article is solely dedicated to the Roblox website or client or is otherwise historically valuable, mark it as archived instead. It will be added to [[:Category:Archived_Pages|its own category.]]
If an outdated article is solely dedicated to the Roblox website or client or is otherwise historically valuable, mark it as archived instead. It will be added to [[:Category:Archived_Pages|its own category.]]
Line 98: Line 190:


* 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 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 [[https://wiki.realja.me/index.php?title=How_do_I_build_my_place%3F&oldid=82091 | 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.
* If the article is a tutorial about [https://wiki.realja.me/index.php?title=How_do_I_build_my_place%3F&oldid=82091 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.


===Placeholder===
===[[Template:Placeholder]]===


For planned new articles that haven't been written yet. Feel free to take the initiative and [[:Category:Outdated_pages|start them]], even a basic outline or a stub is good enough.  
For planned new articles that haven't been written yet. Feel free to take the initiative and [[:Category:Outdated_pages|start them]], even a basic outline or a stub is good enough.  
Line 112: Line 204:
{{WIP|reason=Describe what needs to be done.}}
{{WIP|reason=Describe what needs to be done.}}


===Needs Improvement===
===[[Template:Sucks|Needs Improvement]]===


To quote [https://tcrf.net/Template:Sucks TCRF]:
To quote [https://tcrf.net/Template:Sucks TCRF]:


<blockquote>
<blockquote>
     "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: <nowiki>{{Sucks|reason=The grammar... The image alignment... The poor jokes...}}</nowiki> to point out that this page needs a rewrite."
     "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? <br>Anyway, use this template, like so: <code><nowiki>{{Sucks|reason=The grammar... the image alignment... the poor jokes...}}</nowiki></code> to point out that this page needs a rewrite."
</blockquote>
</blockquote>


{{Sucks|reason=Describe why it sucks.}}
{{Sucks|reason=The grammar... the image alignment... the poor jokes...}}


===Lacks Media===
===[[Template:LacksMedia|Lacks Media]]===


Pages should have media. Some examples of "media" are:
Pages should have media. Some examples of "media" are:
Line 134: Line 226:
{{LacksMedia|reason=Describe your reason - what specifically should be added? Where?}}
{{LacksMedia|reason=Describe your reason - what specifically should be added? Where?}}


===Low Quality Media===
===[[Template:LowQualityMedia|Low Quality Media]]===


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


* It is blurry.
* It is blurry, low resolution, or has watermarks.
* It is [[:Category:Outdated_pages|outdated]] (e.g a screenshot of a Windows XP menu or pre-2012 client).
* It is [[:Category:Outdated_pages|outdated]] (e.g a screenshot of a Windows XP menu or pre-2012 client).
* It is quite simply bad: poorly made and/or unhelpful.
* 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 [https://jspaint.app/ favorite] [https://getpaint.net image] [https://www.adobe.com/products/photoshop.html editing] [https://www.gimp.org/ software].


{{LowQualityMedia|reason=Describe your reason - what specific media should be replaced?}}
{{LowQualityMedia|reason=Describe your reason - what specific media should be replaced?}}
Note: for improving a page's media, the [https://create.roblox.com/docs/tutorials/scripting/basic-scripting/intro-to-scripting | official Roblox Creator Documentation] is a perfect example of this, and the quality we should strive for with our project.
Retrieved from "https://wiki.realja.me/index.php?title=Special:MobileDiff/82231"