Справка:Basic Editing Guide: различия между версиями

Материал из FIJTeam Project Wiki
Перейти к навигации Перейти к поиску
>Burrito Justice
м (revision request)
>Sneakyranger
м (adds login info)
 
(не показано 10 промежуточных версий 2 участников)
Строка 1: Строка 1:
{{Needs revision|reason=Needs some expansion to explain some of the more in-depth wiki magic to new users.}}
{{Wip}}
{{wip|assign=Chada1}}
{{Tutorial navigation}}
== The Wiki ==
__NOTOC__
So you're interested in contributing to the wiki? Great! This guide will explain the processes of doing such. It will also explain the requirements an edit should meet to be merged in a speedy manner, as well as help guide lines of thinking to improve your experience and get you started.
Thank you for taking the time to consider contributing to the wiki. This guide - along with others that you can navigate to from the top of this page - is designed for all users, even wiki maintainers. Directly below this text is a preface to editing so that you're prepared to do the rest without worry.
'''IMPORTANT:''' To submit changes for review, you need to log in to the wiki. Do not create a new account. Instead, click "log in" and input your forum username and password in the appropriate boxes. They are linked.


=== Criteria for Edit Additions ===
=Foreword About Additions and Approval=
The rules of Editing are simple, and must match one of a select few Criteria, or be otherwise sensible. An edit will be considered but has a drastically lower chance of acceptance if it does not. Lore pages are not exempt from corrections at this moment, but are much more limited in scope. A Lore page with more than minor corrections will require Lore Approval.
Any logged in user can submit changes to nearly any page, but those changes will not be merged unless a wiki maintainer reviews and approves of the changes or you are a maintainer/lore writer yourself. All wiki maintainers are given a large and obvious notification on any wiki page whenever there are submissions that await approval. Be sure to review the [[Help:Style Guide|style guide]] before making large edits to make sure your page is nice and clean. In any case if you have questions or concerns about the wiki or your edits then feel free to contact a maintainer on the discord.


Here is the general criteria of Editing on the wiki:
==Criteria for Edits==
*1. It corrects an error, or otherwise serves to correct a problem.
The rules of editing are simple, and should ideally match one of a select few criteria, or be otherwise sensible. Your edits will be considered but have a drastically lower chance of acceptance if it does not. Lore pages are not exempt from corrections at this moment, but are much more limited in scope. Submitting '''any edit''' to a lore page will require lore approval, regardless of the nature of the edit - ideally this permission is obtained before you make your edits.
*2. It adds additional information to improve the page.
*3. It removes unnecessary clutter.
*4. It rephrases the text to be more clear or user friendly.


An edit that achieves one or more of these criteria is much more likely to be accepted. However, if the change is sensible and it doesn't fit them, it will still be considered but may require Wiki Maintainer input or alterations.
Here is the general criteria of editing on the wiki:
#It corrects an error, or otherwise serves to correct a problem.
#It adds additional information to improve the page.
#It removes unnecessary clutter.
#It rephrases the text to be more clear or user friendly.


=== Criteria for Page Additions ===
An edit that achieves one or more of these criteria is much more likely to be accepted. However, if the change is sensible and it doesn't fit them, it will still be considered but may require wiki maintainer input or alterations.
Creating a brand new page is also encouraged, however, you must understand that the criteria is much more strict than a simple edit, the edit criteria is counted as well in these, and it's limited to Gameplay Mechanics at this moment.
 
==Criteria for Page Creation==
Creating a brand new page is also encouraged, however, you must understand that the criteria is much more strict than a simple edit, the edit criteria is counted as well in these, and it's limited to gameplay mechanics at this moment.


Here is the general criteria of adding a new page to the wiki:
Here is the general criteria of adding a new page to the wiki:
*5. It serves an obvious purpose, not filled adequately by any other page.
#It serves an obvious purpose, not filled adequately by any other page.
*6. It is deemed by the Wiki Maintainer team to be a quality addition, on discussion.
#It is deemed by the wiki maintainer team to be a quality addition, on discussion.


== Your Wiki/Forum Account ==
=Your Wiki/Forum Account=
Aurora station utilizes a cross platform system that enables you to use the same account between the Forum and the Wiki. You will need to log onto the Wiki through your Forum account. To register a Wiki account, you must first register a Forum account. You can do that [https://forums.aurorastation.org/ucp.php?mode=register| at this link]. If you have trouble logging onto the wiki and have spaces in your username, contact Staff.
Aurora station utilizes a cross platform system that enables you to use the same account between the forum and the wiki. You will need to log onto the wiki through your forum account. To register a wiki account, you must first register a forum account. You can do that [https://forums.aurorastation.org/ucp.php?mode=register| at this link]. If you have trouble logging onto the wiki and have spaces in your username then you should contact staff.


=== How-To Edit an Existing Page ===
=Editing=
Once you've logged in and found an error on the Wiki, click 'Edit' at the top to begin the simple process of correcting it. The button should look like this, and you must be on the page you wish to edit.
Once you've logged in and found an error on the Wiki, click 'Edit' at the top to begin the simple process of correcting it. The button should look like this, and you must be on the page you wish to edit:


[[File:Editing Page.png]]
[[File:Editing Page.png|166px]]


Once you click that edit button, you should be brought to a textbox containing the entire page. Ctrl-F to the error or scroll down to begin adding, correct it, add it, rephrase it, and then at the bottom where it says 'Watch this page' you should click 'This is a minor edit' as well as type a Summary. It should look similar to this.
Once you click that edit button, you should be brought to a the wiki parser containing everything that renders the page you're working on. Ctrl-F to the error or scroll down to it and begin your edits. At the bottom where it says 'Watch this page' you should type a summary. If the edits you made were relatively minor (fixing typos, formatting, etc) then you can click the 'This is a minor edit' button. It should look similar to this:


[[File:Editing_Page2.png|700px]]
[[File:Editing_Page2.png|700px]]


When you click 'Save Page', this should appear.
Before submitting your changes, ''always'' preview your work to make sure your changes haven't accidentally messed something up. You may even catch some other issues that you missed at first glance. Anyway, when you're sure you're done with your edits and want to submit them, click 'Save changes' to queue the submission up for approval, after which it's just a matter of waiting for wiki maintainer input. You should see this if all went well:


[[File:Pending_Review.png|300px]]
[[File:Pending_Review.png|300px]]


Then you must only wait for it to be reviewed. In the event of a long wait, you may contact Staff on Discord about your addition. Note; Refer to the Criteria of Editing and Creating Pages for an idea on if your edit will be accepted.
==Formatting==
<small><i>See also: [[Help:Formatting|The Guide to Formatting]]</i></small><br>
Mediawiki has some bits and bobs to stylize your text, which can aid in readability if used properly. Be sure to take a look at the [[Help:Style Guide|style guide]] for info on how these tools may best be used. Regardless, the following table provides examples on some of the most common formatting:
{| class="wikitable" border="1" style="border-collapse: collapse; border-color: #666666; background-color: #efefef; width: " cellpadding="5"
|+ Example Wikitext
|-
! What you type || What it looks like
|-
|<pre>''italic text''</pre> || ''italic text''
|-
|<pre>'''bold text'''</pre> || '''bold text'''
|-
|<pre><small>small text</small></pre> || <small>small text</small>
|-
|<pre>
no indent
:single indent
::double indent
:::triple indent
</pre>
||
no indent
:single indent
::double indent
:::triple indent
|-
|<pre>
#Entry 1
#Entry 2
#Entry 3
##Entry 3 subtype 1
</pre>
||
#Entry 1
#Entry 2
#Entry 3
##Entry 3 subtype 1
|-
|<pre>
*Bullet 1
*Bullet 2
*Bullet 3
**Bullet 3 subtype 1
*#Bullet 3 number 1
</pre>
||
*Bullet 1
*Bullet 2
*Bullet 3
**Bullet 3 subtype 1
*#Bullet 3 number 1
|-
|<pre>
=Heading Level 1=
==Heading Level 2==
===Heading Level 3===
====Heading Level 4====
</pre>
||


=== How-To Create a New Page ===
=Heading Level 1=
To begin creating a page, you search the desired title in the search bar at the top right. It will inform you that the page doesn't exist, it should look like this.
==Heading Level 2==
===Heading Level 3===
====Heading Level 4====
<br>
|}


[[File:Creating a page.png|300px]]
==Linking==
<small><i>See also: [[Help:Links|The Guide to Links]]</i></small><br>
You're probably already familiar with links if you've managed to reach this guide. It's the blue text you often see around wiki pages, [[#Linking|and it usually looks like this]]. Your first inclination when adding inter-wiki links is probably to just paste the URL and be done with it, but the ideal method is actually way easier. Below you'll find a table that explains how to properly add links to the page you're working on:
{| class="wikitable" border="1" style="border-collapse: collapse; border-color: #666666; background-color: #efefef; width: " cellpadding="5"
|+ Example Links
|-
! || What you type || What it looks like || What it's for
|-
! 1
|<pre>[[Assistant]]</pre> || [[Assistant]] || This is the standard inter-wiki link. If you want to link to another page on the wiki, then use this.
|-
! 2
|<pre>[[Assistant|Dirty maintenance gremlins]]</pre> || [[Assistant|Dirty maintenance gremlins]] || Adding a <code><nowiki>|</nowiki></code> (known as a [[wikipedia:Vertical_bar|vertical bar]]) between the page name and some text will render that link as the text you put in, in case you want to hide a link inside some relevant information. You may discover that this very guide uses this method in more than a few areas!
|-
! 3
|<pre>[[Guide to EVA#Jetpacks|How to use Jetpacks]]</pre> || [[Guide to EVA#Jetpacks|How to use Jetpacks]] || Sometimes only a specific part of a page is relevant to what you're typing about, so in this case we link to the page ''and'' the relevant subheading. Anything that appears in the table of contents (or is otherwise "anchored") can be linked to this way.
|-
! 4
|<pre>[[#Editing|The Editing subheading]]</pre> || [[#Editing|The Editing subheading]] || If you want to link to a subheading that's already on the page you're editing, you can forego having to include the name of the page and only include the subheading name.
|-
! 5
|<pre>[[wikipedia:Space Station 13|Wikipedia Article about SS13]]</pre> || [[wikipedia:Space Station 13|Wikipedia Article about SS13]] || This simply links back to Wikipedia. You probably won't be using this much since Aurora's setting is purely fictional, but this is here for posterity.
|-
! 6
|<pre>[https://forums.aurorastation.org/topic/7780-looking-for-wiki-developers/#comment-153366 Burrito's cry for help]</pre> || [https://forums.aurorastation.org/topic/7780-looking-for-wiki-developers/#comment-153366 Burrito's cry for help] || If you must link to something outside of the wiki then this is what you'd use. Note that there is nothing separating the URL from the rendered text except for a space, and that the entire link is surrounded by single brackets, not double. ''Please'' do not link to unrelated or malicious websites - this feature is mostly reserved for linking to Aurora-related websites like the forums.
|}


then you click the red name, fill out the page and format it with links and code to be readable, then click 'Save Page' button in the bottom left. A summary of your changes is suggested.
==Images==
<small><i>See also: [[Help:Images|The Guide to Images]]</i></small><br>
Images are just that: images. On the wiki they're media that's rendered in pretty ways on the page and - hopefully - breaks up the flow of information to make the page more digestible to the viewer. To upload a file, do the following:
#Click the '''Upload file''' button on the left of your screen<br>'''OR'''<br>Click on a red link to the file of your choosing.
#Click '''Choose file''' to select what file to upload from your PC.
#*Ideally this is in a common image format (JPG, PNG, GIF, etc).
#Give the file a name, ideally relevant to what the file is about.
#*If you went with the red link method then the filename is probably already populated.
#Give it a summary if you want.
#Click '''Upload file''' to finish.
That should do it, as long as there are no errors (most common being duplicate images). Note that due to how caching works that it may take a while for your file to actually render on pages it's used.
 
'''Please note:''' If you are uploading sprites from the game, ensure that their dimensions are 32x32 (or whatever their original resolution is). If you want to scale a sprite up, do it through the wiki, not an image editor (see below). Ideally all sprites are retrieved from the game's files and not from screenshots. [[Help:Images|See the images guide for a how-to on getting the best possible sprites]].
 
{| class="wikitable" border="1" style="border-collapse: collapse; border-color: #666666; background-color: #efefef; width: " cellpadding="5"
|+ Various ways to link a file
|-
! What you type || What it looks like || Explanation
|-
|<pre>[[File:Btoolbox.png]]</pre> || [[File:Btoolbox.png]] || This is the simplest way to display an image. These will typically default to the left side of the page.
|-
|<pre>[[File:Btoolbox.png|64px]]</pre> || [[File:Btoolbox.png|64px]] || By using <code>64px</code> (or any other number, ideally multiples of 32 if it's a sprite) you can scale an image via the wiki.
|-
|<pre>[[File:Btoolbox.png|64px|center]]</pre> || [[File:Btoolbox.png|64px|center]] || You can use <code>center</code> to put an image directly in the center of the page. There are other directions you can use as well, like <code>right</code>.
|-
|<pre>[[File:Btoolbox.png|link=Help:Contents|I AM VERY LOUD LOOKING TEXT]]</pre> || [[File:Btoolbox.png|link=Help:Contents|I AM VERY LOUD LOOKING TEXT]] || The first part transforms the image into a link to another page. Normally this would link back to the image itself. The second part adds a caption to images that is only visible if you hover your cursor over it, which can be useful for additional-but-not-useful info about an item.
|-
|<pre>[[File:Btoolbox.png|link=|This image goes no where]]</pre> || [[File:Btoolbox.png|link=|This image goes no where]] || By setting the link to an empty value you can make the image do nothing if it's clicked on.
|-
|<pre>[[File:Btoolbox.png|thumb|Caption!]]</pre> || [[File:Btoolbox.png|thumb|Caption!]] || If you want information related to an image to be readily visible then you can use the <code>thumb</code> parameter, followed by the info you'd like to type. Thumbs will default to the right side of the page.
|-
|}
 
=Page Creation=
'''Remember:''' Only create a new page if the content you're writing about is no where else on the wiki ''and'' doesn't belong on an existing page, or if adding information to existing entries would detract from the page that it exists on.
 
Creating a page is as simple as looking up a missing page and clicking on the red link:
 
[[File:Creating_a_page.png|300px]]
 
After that, you'll get a wiki parser similar to what you'd see when editing another page, except this time it's completely empty. This is perhaps a bit daunting at first, but if what you're writing about is similar to another page then you can probably use most of its content here (ex. you're writing about a new job, there are lots of other standalone job pages that you can draw resources from). If you're still working on it, or don't think you can finish the page, then you can throw a <code><nowiki>{{Wip}}</nowiki></code> template at the top to say that the page is a work in progress, after which it's added to the WIP category for tracking.
 
Either way, once you're done writing and stylizing everything you can hit '''Save page''' at the bottom along with a summary of what the page is about.


[[File:Save_page.png|300px]]  
[[File:Save_page.png|300px]]  


When you click 'Save Page', this should appear.
After that, this should probably appear, followed by either approval or denial from wiki maintainers:


[[File:Pending_Review.png|300px]]
[[File:Pending_Review.png|300px]]
Then you must only wait for it to be reviewed. In the event of a long wait, you may contact Staff on Discord about your addition. Note; Refer to the Criteria of Editing and Creating Pages for an idea on if your page will be accepted.

Текущая версия от 20:33, 5 января 2024

Файл:Cone.pngЭта страница находится на плановых ремонтных работахФайл:Cone.png
Пожалуйста, согласуйте ваши правки с подрядчиком:
None


Contents
Beginner's guide
Navigation
Style guide
Formatting
Links
Images
Tables


Thank you for taking the time to consider contributing to the wiki. This guide - along with others that you can navigate to from the top of this page - is designed for all users, even wiki maintainers. Directly below this text is a preface to editing so that you're prepared to do the rest without worry. IMPORTANT: To submit changes for review, you need to log in to the wiki. Do not create a new account. Instead, click "log in" and input your forum username and password in the appropriate boxes. They are linked.

Foreword About Additions and Approval

Any logged in user can submit changes to nearly any page, but those changes will not be merged unless a wiki maintainer reviews and approves of the changes or you are a maintainer/lore writer yourself. All wiki maintainers are given a large and obvious notification on any wiki page whenever there are submissions that await approval. Be sure to review the style guide before making large edits to make sure your page is nice and clean. In any case if you have questions or concerns about the wiki or your edits then feel free to contact a maintainer on the discord.

Criteria for Edits

The rules of editing are simple, and should ideally match one of a select few criteria, or be otherwise sensible. Your edits will be considered but have a drastically lower chance of acceptance if it does not. Lore pages are not exempt from corrections at this moment, but are much more limited in scope. Submitting any edit to a lore page will require lore approval, regardless of the nature of the edit - ideally this permission is obtained before you make your edits.

Here is the general criteria of editing on the wiki:

  1. It corrects an error, or otherwise serves to correct a problem.
  2. It adds additional information to improve the page.
  3. It removes unnecessary clutter.
  4. It rephrases the text to be more clear or user friendly.

An edit that achieves one or more of these criteria is much more likely to be accepted. However, if the change is sensible and it doesn't fit them, it will still be considered but may require wiki maintainer input or alterations.

Criteria for Page Creation

Creating a brand new page is also encouraged, however, you must understand that the criteria is much more strict than a simple edit, the edit criteria is counted as well in these, and it's limited to gameplay mechanics at this moment.

Here is the general criteria of adding a new page to the wiki:

  1. It serves an obvious purpose, not filled adequately by any other page.
  2. It is deemed by the wiki maintainer team to be a quality addition, on discussion.

Your Wiki/Forum Account

Aurora station utilizes a cross platform system that enables you to use the same account between the forum and the wiki. You will need to log onto the wiki through your forum account. To register a wiki account, you must first register a forum account. You can do that at this link. If you have trouble logging onto the wiki and have spaces in your username then you should contact staff.

Editing

Once you've logged in and found an error on the Wiki, click 'Edit' at the top to begin the simple process of correcting it. The button should look like this, and you must be on the page you wish to edit:

Once you click that edit button, you should be brought to a the wiki parser containing everything that renders the page you're working on. Ctrl-F to the error or scroll down to it and begin your edits. At the bottom where it says 'Watch this page' you should type a summary. If the edits you made were relatively minor (fixing typos, formatting, etc) then you can click the 'This is a minor edit' button. It should look similar to this:

Before submitting your changes, always preview your work to make sure your changes haven't accidentally messed something up. You may even catch some other issues that you missed at first glance. Anyway, when you're sure you're done with your edits and want to submit them, click 'Save changes' to queue the submission up for approval, after which it's just a matter of waiting for wiki maintainer input. You should see this if all went well:

Formatting

See also: The Guide to Formatting
Mediawiki has some bits and bobs to stylize your text, which can aid in readability if used properly. Be sure to take a look at the style guide for info on how these tools may best be used. Regardless, the following table provides examples on some of the most common formatting:

Example Wikitext
What you type What it looks like
''italic text''
italic text
'''bold text'''
bold text
<small>small text</small>
small text
no indent
:single indent
::double indent
:::triple indent

no indent

single indent
double indent
triple indent
#Entry 1
#Entry 2
#Entry 3
##Entry 3 subtype 1
  1. Entry 1
  2. Entry 2
  3. Entry 3
    1. Entry 3 subtype 1
*Bullet 1
*Bullet 2
*Bullet 3
**Bullet 3 subtype 1
*#Bullet 3 number 1
  • Bullet 1
  • Bullet 2
  • Bullet 3
    • Bullet 3 subtype 1
    1. Bullet 3 number 1
=Heading Level 1=
==Heading Level 2==
===Heading Level 3===
====Heading Level 4====

Heading Level 1

Heading Level 2

Heading Level 3

Heading Level 4


Linking

See also: The Guide to Links
You're probably already familiar with links if you've managed to reach this guide. It's the blue text you often see around wiki pages, and it usually looks like this. Your first inclination when adding inter-wiki links is probably to just paste the URL and be done with it, but the ideal method is actually way easier. Below you'll find a table that explains how to properly add links to the page you're working on:

Example Links
What you type What it looks like What it's for
1
[[Assistant]]
Assistant This is the standard inter-wiki link. If you want to link to another page on the wiki, then use this.
2
[[Assistant|Dirty maintenance gremlins]]
Dirty maintenance gremlins Adding a | (known as a vertical bar) between the page name and some text will render that link as the text you put in, in case you want to hide a link inside some relevant information. You may discover that this very guide uses this method in more than a few areas!
3
[[Guide to EVA#Jetpacks|How to use Jetpacks]]
How to use Jetpacks Sometimes only a specific part of a page is relevant to what you're typing about, so in this case we link to the page and the relevant subheading. Anything that appears in the table of contents (or is otherwise "anchored") can be linked to this way.
4
[[#Editing|The Editing subheading]]
The Editing subheading If you want to link to a subheading that's already on the page you're editing, you can forego having to include the name of the page and only include the subheading name.
5
[[wikipedia:Space Station 13|Wikipedia Article about SS13]]
Wikipedia Article about SS13 This simply links back to Wikipedia. You probably won't be using this much since Aurora's setting is purely fictional, but this is here for posterity.
6
[https://forums.aurorastation.org/topic/7780-looking-for-wiki-developers/#comment-153366 Burrito's cry for help]
Burrito's cry for help If you must link to something outside of the wiki then this is what you'd use. Note that there is nothing separating the URL from the rendered text except for a space, and that the entire link is surrounded by single brackets, not double. Please do not link to unrelated or malicious websites - this feature is mostly reserved for linking to Aurora-related websites like the forums.

Images

See also: The Guide to Images
Images are just that: images. On the wiki they're media that's rendered in pretty ways on the page and - hopefully - breaks up the flow of information to make the page more digestible to the viewer. To upload a file, do the following:

  1. Click the Upload file button on the left of your screen
    OR
    Click on a red link to the file of your choosing.
  2. Click Choose file to select what file to upload from your PC.
    • Ideally this is in a common image format (JPG, PNG, GIF, etc).
  3. Give the file a name, ideally relevant to what the file is about.
    • If you went with the red link method then the filename is probably already populated.
  4. Give it a summary if you want.
  5. Click Upload file to finish.

That should do it, as long as there are no errors (most common being duplicate images). Note that due to how caching works that it may take a while for your file to actually render on pages it's used.

Please note: If you are uploading sprites from the game, ensure that their dimensions are 32x32 (or whatever their original resolution is). If you want to scale a sprite up, do it through the wiki, not an image editor (see below). Ideally all sprites are retrieved from the game's files and not from screenshots. See the images guide for a how-to on getting the best possible sprites.

Various ways to link a file
What you type What it looks like Explanation
[[File:Btoolbox.png]]
This is the simplest way to display an image. These will typically default to the left side of the page.
[[File:Btoolbox.png|64px]]
By using 64px (or any other number, ideally multiples of 32 if it's a sprite) you can scale an image via the wiki.
[[File:Btoolbox.png|64px|center]]
You can use center to put an image directly in the center of the page. There are other directions you can use as well, like right.
[[File:Btoolbox.png|link=Help:Contents|I AM VERY LOUD LOOKING TEXT]]
I AM VERY LOUD LOOKING TEXT The first part transforms the image into a link to another page. Normally this would link back to the image itself. The second part adds a caption to images that is only visible if you hover your cursor over it, which can be useful for additional-but-not-useful info about an item.
[[File:Btoolbox.png|link=|This image goes no where]]
This image goes no where By setting the link to an empty value you can make the image do nothing if it's clicked on.
[[File:Btoolbox.png|thumb|Caption!]]
Caption!
If you want information related to an image to be readily visible then you can use the thumb parameter, followed by the info you'd like to type. Thumbs will default to the right side of the page.

Page Creation

Remember: Only create a new page if the content you're writing about is no where else on the wiki and doesn't belong on an existing page, or if adding information to existing entries would detract from the page that it exists on.

Creating a page is as simple as looking up a missing page and clicking on the red link:

After that, you'll get a wiki parser similar to what you'd see when editing another page, except this time it's completely empty. This is perhaps a bit daunting at first, but if what you're writing about is similar to another page then you can probably use most of its content here (ex. you're writing about a new job, there are lots of other standalone job pages that you can draw resources from). If you're still working on it, or don't think you can finish the page, then you can throw a {{Wip}} template at the top to say that the page is a work in progress, after which it's added to the WIP category for tracking.

Either way, once you're done writing and stylizing everything you can hit Save page at the bottom along with a summary of what the page is about.

After that, this should probably appear, followed by either approval or denial from wiki maintainers: