Difference between revisions of "User:Sirryan2002/GradingTest"

From Paradise Station Wiki
Jump to navigation Jump to search
(blanked)
Tag: Blanking
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:


---------------------------------------
---------------------------------------
---------------------------------------
Hello and welcome to Paradise Station's Wiki. You are likely a prospective wiki contributor wondering how exactly you can contribute to our server wiki. Before making significant changes, contributors should read through our Wiki's Rules. The Guide to Wiki Editing seeks to outline how our wiki is structured, how one can make edits on our wiki, where contributors should be focusing their efforts, how to make an effective and useful edit, and finally how to begin writing quality articles.
==Wiki Rules==
This is the official policy for the Paradise Station Wiki. Violations of these rules will result in a revocation of wiki editing privilege's.
# Paradise Station [https://www.paradisestation.org/rules/ Server Rules] extend to the wiki, a violation of those rules is considered a violation of wiki rules.
# Page Vandalism is not allowed. Page Vandalism is editing a page in an intentionally disruptive or malicious manner. Vandalism includes any addition, removal, or modification that is intentionally nonsensical, misinformative, or degrading in any way.
# Edit Wars and reactionary article revisions are not permitted. Conflicts between contributors should be immediately be discussed between both parties and brought to wiki admins if a solution cannot be reached.
# Hostility towards another contributor or players in any context on the #Wiki-Development channel on discord is strictly prohibited.
# Large-scale edits to the wiki (25+ non-minor edits in quick succession) without first giving notice in the #Wiki-Development channel on discord is heavily discouraged
# Lore pages (except for grammatical/spelling corrections) are not to be edited without first contacting a Wiki Admin and getting approval from Server Heads of Staff
==What is a Wiki and How Does it work?==
At its core, the Paradise Station Wiki is a website that allows collaborative editing of its content and structure by its users. It serves to document our server's game mechanics and features in an easy to read and understand way so that information is digestible and available to our playerbase. Most importantly, it no only makes information available, but also organizes it in a way that a player can find what they're looking for with relative ease. If it is available in-game, a player should be able to find out more about it through our wiki.
Our wiki is not automatically updated, in order to stay up date, a community member must update it every time a Pull Request (that changes a feature) is merged into our codebase. Since the wiki has a tremendous amount of content, it requires the effort of many community members to keep it up to date and to completely populate its contents. As of the time you are reading this article, the wiki is likely not 100% up to date, and all content that should be added is still not completely there. That is where non wiki-contributing members of our community step in, they make their first edit! First time contributors shouldn't worry about whether or not their first edit adheres to our wiki editing standards, instead they should be focused on learning the mechanics of wiki editing. If you are worried about messing up something, just make an edit on your user page!
==Making Edits==
Anytime the wiki is changed, it must be ''edited'' by a wiki editor. The only restriction for someone to edit the wiki is to be a forums member and login with their forum credentials. Other than our wiki rules, there is NO restrictions on who can edit the wiki or who is "encouraged/discouraged" from editing the wiki. Go wild! Since editing the wiki can come in different forums based on the action you wish to perform, it has been broken down into multiple sections detailing all the ways one can affect change on the wiki.
If you're concerned weather or not your edit went through, you can check [[Special:RecentChanges|Recent Changes]] to see if your edit went through. This page is also a good tool to see where edits are being made on the wiki currently and how development has been going for the last 30 days!
===Creating a Page===
[[File:Creating a Page From Search Menu.png|right|thumb]]
As new content is added to the game, something may be added that is unique enough to justify the feature having its own wiki page. Or perhaps you are just creating your user page so you can let people know who you are or have a playground for testing wiki code.
'''There are two methods from which to begin creating a page:'''
* If there is a red link anywhere on the page (such as your username in the top right), you can click on it and it will take you to the page creation tab.
* Type the name of the page you wish to create in the search bar in the top right and press enter. You will then need to click the red link with the name of the page you wish to create right under the search bar on the page.<br>
[[File:Page Creation Tab.png|border|640px|This is the Page Creator tab, you can add the wikicode in the textbox, add a summary in the text input, preview your edits with the show preview button, and save the page with the blue button!]]<br>
You can now add ''whatever'' you want to the page. If its your user page, introduce yourself! Learn how to link your forum profile and discord profile! If its a content page, feel free to put in a summary of what you want players to know about the topic. If you want to see a page created about something but don't know how or want to fill it out, just put <nowiki>"{{Stub}}"</nowiki> as the contents. Once You've filled out the page, write your reason for creating the page, and hit the save button. Your page should now be saved!
===Editing An Article===
[[File:Editing A Page.png|right|thumb]]
Since wiki articles require many edits to keep up to date and add all content, its important to know how to edit an article. To begin editing an article, one must view the page they want to edit and then click the edit button (it is next to the "read" and "view history" buttons).<br>
[[File:Page Creation Tab.png|border|640px|This is the Article editor tab, you can add the wikicode in the textbox, add a summary in the text input, preview your edits with the show preview button, and save the page with the blue button!]]<br>
You can now alter the page, edits will not save until you hit the save button don't worry! If its your user page, do whatever you want to it. If its an existing page, make sure you're preserving the quality of the page and improving it! Once You've filled out the page, write your reason for creating the page, and hit the save button. Your page should now be saved!
===Uploading a File===
===Editing a Template===
==ALL OTHER STUFF==
'''When editing, do not edit any Lore pages without asking the heads first. Editing these pages without permission may result in your Wiki privileges being revoked.'''
=General Guidelines=
This is simply a quick list of introductory wiki editing guidelines for our Wiki.
''If you're ever uncertain about something, feel free to ask in the #wiki-development channel on our Discord.''
'''General Wiki Etiquette'''
* Capitalize links and link names. This fits in better with how the Wiki supports article names at a software level, and proper nouns are supposed to be capitalized anyway.
** Not every reference needs to be a link unless it's for internal navigation. Link the first couple references to another page, but refer to it in plain-text further down the page.
** Do not use external links. Information should be contained on the wiki itself both for convenience and security purposes. There are a limited number of exceptions to this, such as with [https://www.paradisestation.org/rules/ rules].
* After performing an edit, please fill out a general statement (it can be as few as 2 words) to let people know what you did.
* Minor edits are for things like typos, missing punctuation, or minor grammatical quibbles. Anything larger than that is not a minor edit.
* This wiki uses proper British/Canadian English wherever possible. While using American spelling is fine, do not make edits to correct British/Canadian spelling to American spelling.
'''Wiki Guidelines/Editing Tips'''
* Keep on subject. Try to keep articles related to the title. If you feel like you're going off on a tangent, try linking to a new article.
* Several pages use standardized colour schemes, structure, and templates. If you're creating a new page, please follow the structure/colours/templating of similar existing pages.
* Keep header names short and to the point. Lengthy headers make the Table of Contents ridiculously and needlessly wide.
** If you change a page's headers, make sure to click the ''"What links here"'' button on the sidebar and fix any potentially broken redirects.
* If information is highly important/not easy to find, you should consider making a redirect for likely search terms. Redirects look like this: <nowiki>#REDIRECT[[pagename]]</nowiki>
'''Wiki Humour/Bolding'''
* Please refrain from using strikethrough, random bolding, scaled up text, or making excessive random jokes.
** We strive to keep the wiki as a to-the-point and semi-serious resource. The occasional clever joke in an article is fine, constant strikethrough humour is not.
** Bolding and text-scaling should be reserved for headers, disclaimers, or important notes. You should never be using bold text in the middle of a sentence unless absolutely necessary.
'''Location Pages'''
* Obvious exits should not include cardinal directions to reduce page bloat. Simply list the exits in a flowing list, IE: Central Primary Hallway, [[Bar/Chapel Maintenance]]
* Access Level should list the exact access required to access that location.
* Clearance should list ''only'' the minimum job rank/most obvious job rank required to access a location.
* Clearance (when listed) should contain page links to the jobs put under clearance.
* Any text on the page should appear in the description field and not below the template.
* The Department field should match the section the area is found in under the Template:Locations template.
'''New Pages'''
* Create new pages only for legitimately new content. IE: Was a new and complicated system reported that needs its own page? Was a new antagonist added?
* If a new page was added, add links to it in the primary navigation pages such as "Guides" (people can't find it otherwise).
* Do not create new pages for testing purposes. This inflates our article count and they can be navigated to through 'Random page.'
** If you need to test something, use your userpage. For instance, if your username is NeoTokyo, navigate to User:NeoTokyo and create a page there.
*** Userpages are not subject to editing from other contributors (please don't edit other people's userpages).
*** However, userpages that contain dead links or otherwise generate issues may be edited at the discretion of the people maintaining the wiki.
=Images and Image Use=
==Calling and Using Images==
In order to use an image, you will need to call the <nowiki>[[File:]]</nowiki> command.
Here's the appropriate syntax for the command to call an image of a burger: '''<nowiki>[[File:Burger.png]]</nowiki>'''
'''This will display as:''' [[File:Burger.png]]
Unless we're putting this image in a table, it's probably way too big! In order to fix that we need to add a size modifier.
To add a size modifier, we need to use the line identifier followed by a size in pixels: '''<nowiki>[[File:Burger.png|32px]]</nowiki>'''
'''This will display as:''' [[File:Burger.png|32px]]
If we wanted it even smaller for some reason, we would put: '''<nowiki>[[File:Burger.png|16px]]</nowiki>'''
'''This will display as:''' [[File:Burger.png|16px]]
As you can see, when we downsize to such a level we start losing a lot of visual fidelity. The same is also true if we upscale the image like so: '''<nowiki>[[File:Burger.png|96px]]</nowiki>'''
'''This will display as:''' [[File:Burger.png|92px]]
If we put all the images side-by-side, the loss in visual fidelity is immediately obvious when scaling above 64px (native resolution) or below 32px (native SS13 resolution).
{|class="wikitable"
| 92px (some loss):
| 64px (no loss):
| 32px (no loss):
| 16px (some loss):
|-
| [[File:Burger.png|center|92px]]
| [[File:Burger.png|center]]
| [[File:Burger.png|center|32px]]
| [[File:Burger.png|center|16px]]
|}
   
When using the file command, you should always specify your intended filesize (either 32, or 64px).
''Note: If you want a 64px version of an image but only a 32px version exists and you're unable to upload it yourself, it's still better to upsize to 64px and lose that visual fidelity. It will be an obvious and immediate indicator to any editor who comes across the page that the image needs to be uploaded.''
==File Modifiers==
The <nowiki>[[File:]]</nowiki> command has a variety of modifiers that can be applied to it, sizing is just one.
'''<nowiki>[[File:Burger.png|center]]</nowiki>''' will align the image in the center of wherever it's placed (be it in a table or elsewhere). You can also align it using left or right instead of center.
'''<nowiki>[[File:Burger.png|frame]]</nowiki>''' will frame the image in a standard MediaWiki box and align it on the right-hand margin.
'''<nowiki>[[File:Burger.png|frame|caption]]</nowiki>''' will add a caption below the frame. Simply replace the word caption with your description.
'''<nowiki>[[File:Burger.png|link=Space Law]]</nowiki>''' will add a link to the image. You can now click the image to navigate to the page, in this case clicking the icon navigates to the Space Law page.
Here's what a captioned, centered, framed, and linked image call would look like.
'''<nowiki>[[File:Burger.png|link=Space Law|center|frame|oh wow this is pretty neat|32px]]</nowiki>'''
{|class="wikitable"
| style="width: 100pt" | Centered Image
| style="width: 100pt" | Framed Image
| style="width: 100pt" | Image w/ Caption
| style="width: 100pt" | Linked Image
| style="width: 100pt" | All of the Above
|-
| [[File:Burger.png|center]]
| [[File:Burger.png|frame]]
| [[File:Burger.png|frame|caption]]
| [[File:Burger.png|link=Space Law]]
| [[File:Burger.png|link=Space Law|center|frame|oh wow this is pretty neat|32px]]
|}
==Uploading/Finding Images==
Alright, but how do we find/upload images?
It's actually pretty straight-forward. On the left-hand margin of the web-page underneath the Paradise Logo you'll see a list of links. Click '''Upload File'''.
Once you've navigated to the Upload File page, at the top there's a link to view "List of Uploaded Files."
* Clicking it will bring you to a searchbar that can navigate/search for images.
* You can also find the File List in the Special Pages listing.
* You can also just [[Special:ListFiles|click the words here to find it.]]
Now that we know how to reach the Upload File and Special:ListFiles pages, it's important that we run down a few important things when uploading images.
'''Basic File Etiquette'''
* Prior to uploading a new image, please ensure there isn't already a version of that image on the wiki.
** If you are uploading a superior version, maintain the same filename.
'''File Extensions/Image Sourcing'''
* Images must be in .png format, or .gif format for animated files. '''Never upload a file in .jpg or .bmp.'''
** The .jpg extension is not lossless (it loses fidelity when uploaded) and .bmp has a larger file-size (which wastes wiki resources).
* Images should be sourced directly from the codebase .DMI files located on the [https://github.com/ParadiseSS13/Paradise/tree/master/icons GitHub].
* Once you have the appropriate .DMI open (BYOND will open it) and have found your image, right-click it, hit "Export As," and save it as a .png.
'''Resizing/Modifying Your Image'''
* Images should be scaled up from their 32x32 size to 64x64 either using '''no scaling filter, or nearest neighbour scaling'''.
** Settings such as "Bilinear," "Bicubic," "Best Quality," and so on will cause a loss of quality when scaling SS13's pixel-art style.
** If all you have is MSPaint, you should consider downloading a free editor such as Paint.net or GIMP. MSPaint causes artifacts (colour loss) when rescaling.
* Icons must have a transparent background. If you sourced from the .dmi, it already does so you don't need to worry about this. If it doesn't, edit out the background.
'''Naming Your Image'''
* Name your file something appropriate when uploading it so it can be easily found. "dragonsbreath" isn't ideal, but "shotgun_dragonsbreath" would be.
** Unless using capitalization somehow clarifies the file-name, only the first-letter of the filename should be capitalized.
** Try to keep the image name short and to the point "bananacake" is fine, "food_bananacake" is also fine, but "food_bananacakechefkitchensliceable" is not.
'''Licensing Your Image'''
* You are required to select an appropriate license for your image.
** CC-BY-SA is for game files.
** CC-BY-NC-SA is for game files in the goon folder.
** GFDL 1.3+ is for wiki-specific files.
Assuming you followed these steps properly, you're all set to upload! If there's a duplicate file already on the wiki, you will be automatically warned. If the existing file is identical/superior, please use it instead of the file you're trying to upload (duplicate files not only create more work for everyone, they waste resources)!
=Templates and Categories=
Here is a list of all Categories and the important Templates we are using. If you make one, add it to the list (some templates automatically add categories to an article if you use them).
*[[:Category:Templates|Templates]]
*[[Special:Categories|Categories]] (Note: Some Categories redirect to a wikipage. To get to the Category, click on the reference below the pagename)
'''Please read the description in every Category and add it to an article where appropriate. If you want to add a category, please consult someone in charge of the Wiki.'''
==Templates==
Templates are outlines that accept a variety of parameters in order to create a standardized Wiki element.
Here's an example of what an unfilled template looks like.
<div style="display:table;">
{{JobGuides}}
</div>
When viewing a template's source, the elements surrounded by three curly brackets, such as <nowiki>{{{department}}}</nowiki>, indicate where the template will accept input.
The words "placeholder" may indicate other parameters that the template is looking for. To find them, we would look at the template's source. For now, we'll try modifying a few parameters!
To call a template, we used a template call which consists of two curly brackets like so: '''<nowiki>{{JobGuides}}</nowiki>'''
In this case, we're calling the job-guides template! We can define the parameters by opening up the Template Call and using some line identifiers like so:
<nowiki>{{JobGuides
| colour    = #CCAE18
| department = Burger
| image      = Burger.png
| roleheader = Burger Jobs
| roleguides = Burger Guides
}}</nowiki>
Doing this will fill in some of those missing parameters, and we'll get the following result:
<div style="display:table;">
{{JobGuides
| colour      = #CCAE18
| department  = Burger
| image      = Burger.png
| roleheader  = Burger Jobs
| guideheader = Burger Guides
}}
</div>
As a rule of thumb, it's always a good idea to look at another page that has the template to see how it's being utilized. This not only cuts down on time, it will usually tell you what those other hidden parameters are!
==Categories==
Categories categorizes the pages and files of the wiki to help people find them easier. Auto-generating categories are also a useful tool for editors looking for issues on the wiki.
==Basic Syntax==
The Wiki accepts BBCode, basic HTML, and CSS styling to create a variety of formats.
Here's a list of some commonly used tags on our wiki.
===Word Tags===
<nowiki>=text=</nowiki> creates the largest headline
<nowiki>======text======</nowiki> creates the smallest headline
<nowiki>'''texthere''' Creates bold text</nowiki>
<nowiki>''texthere'' Creates italic text</nowiki>
<nowiki><font size="3"></font> Sets size of font, from 1 to 7</nowiki>
<nowiki><font color="green"></font> Sets font color, using name or hex value</nowiki>
===Links===
<nowiki>[[Page Name Here]] creates a hyperlink</nowiki>
<nowiki>[[File:Filename.filetype|sizepx]] creates an image/link</nowiki>
<nowiki>[[Page Name Here#Subsection Here]] creates a target location within a document</nowiki>
<nowiki>[[#Subsection In Page]] links to that target location from elsewhere in the document</nowiki>
===Formatting===
<nowiki><br> Inserts a line break</nowiki>
<nowiki><ol></ol> Creates a numbered list</nowiki>
<nowiki><ul></ul> Creates a bulleted list. You can also just use * to create manual bullets.</nowiki>
<nowiki><li></li> Precedes each list item, and adds a number or symbol depending upon the type of list selected</nowiki>
<nowiki><hr> Inserts a horizontal rule</nowiki>
<nowiki><hr size="3"> Sets size (height) of rule</nowiki>
<nowiki><hr width="80%"> Sets width of rule, in percentage or absolute value</nowiki>
<nowiki><hr noshade> Creates a rule without a shadow</nowiki>
<nowiki><big></big> Scales up text to a larger size</nowiki>
===Tables===
<nowiki>{| Starts a table. It's the initial table call.
| The standard table line. Specifies an item in the table.
|- A table-break. When creating tables, the first break will signal the end of the column headers.
|+ A special table-header. This header will appear in plain, bolded text above the table.
! A table header. This applies a special light-grey background and bolds any text.
|] Closes an established table.</nowiki>
[[Category:Guides]]

Latest revision as of 03:14, 11 May 2022

Retrieved from "https://paradisestation.org/wiki/index.php?title=User:Sirryan2002/GradingTest&oldid=37730"