helialprofile.png
Welcome to IOPWiki, Commander. You can contribute to this wiki without an account. Learn how to contribute and join our Discord server.

Difference between revisions of "IOP Wiki:Guideline"

Welcome to IOP Wiki. This website is maintained by the Girls' Frontline community and is free to edit by anyone.
Jump to navigation Jump to search
m (Changed protection level for "IOP Wiki:Guideline": Outdated restrictions ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
Line 1: Line 1:
This page lists some guidelines for editors to follow.
+
[[File:Japanese Server Pre-launch G36 Promotion Artwork Illustrated by Shuzi.jpeg|right|300px|thumb|{{doll name|G36|AR|4}} is the mascot of IOP Wiki.]]
 +
This is a quick guide explaining what IOP Wiki is and how to use it.
 +
==What is IOP Wiki ?==
 +
IOP Wiki organizes information about [[Girls' Frontline]] and other games by [[MICA Team]]. Anyone can submit change proposals to add or correct information. We cover topics such as [[T-Doll Index|T-Dolls lists]] and statistics, [[Lore]] and [[:Category:Guides|Guides]], and aim to be up-to-date with the CN version of the game. This Wiki takes the name of [[I.O.P.|Important Operations Prototype Manufacturing Company]], the company that manufactures most [[Tactical Doll]]s in the universe of Girls' Frontline.
  
{{Cleanup|reason=* Needs general guidelines about how to word things (for example: Don't address the reader with "you" and don't ask questions in pages)
+
Our comment system at the bottom of each article let visitors ask questions for topics not covered in the main article. For rules related to the comment system, see [[IOP Wiki:Comments Guidelines]].
* This page needs a better layout
 
* Maybe add some examples of pages
 
* Link to usual template documentations}}
 
  
If you wish to contribute to the wiki and are unsure of where to begin, please refer to the [[Project:Todo List|todo list]] for some ideas.
+
===What IOP Wiki is not===
 +
IOP Wiki only covers official content from Mica Team and associates. We don't host fan-arts or fan-fictions.
  
== General Term Translations ==
+
We also don't take vandalism lightly and will take measures against users trying to harm IOP Wiki by adding low-quality content or deleting legitimate content.
These are the terms the wiki uses for translation. If there you have suggestion or do not agree with the translation, please contact wiki or use the discussion page.
 
  
Please see: [[Girls_Frontline_Wiki:Guideline/General_Namelist|General Namelist]] for glossary.
+
==How to navigate IOP Wiki==
 +
Use the search bar on the top right to search for specific articles.
  
With the release of Girls Frontline EN server, all the available items/skills/costumes/equipment naming are converted to the official terminology used on that server. However all the names for items/skills/costumes/equipment that are not yet available on EN server, their names remains as the translated Chinese phrases.
+
Use the menu on the left side to access general topics.
  
== Updating the main page ==
+
T-Dolls articles have dedicated subpages for their story involvement, quotes and Live2D animations (when applicable). These pages are accessed with tabs at the top of each page.
The main wiki page uses [[Template:mainpage]]. visit the template page and follow the instructions to updpate the main page.
 
  
==Editing/Creating T-Doll Pages==
+
Banners at the top of articles or subsections will warn of spoilers or missing information.
<del>For page restructuring conveniences, T-Doll pages are made through using a single template, please read it on [[Template:T-Doll]]. To create a T-Doll page, simply copy the code in [[Template:T-Doll]], paste them in the desired doll page, and fill in the parameters.</del>
 
  
After template change in July/August 2018, T-Doll pages are now being separated into four (4) distinctive sections, with T-Doll PlayableUnit page as main page and Quotes, Strategy and Story as sub pages.  
+
==How to edit IOP Wiki==
*For T-Doll main page, create page under [[Template:PlayableUnit]] and fill parameters if applicable.
+
On the article you wish to edit, use the "Edit" button at the top of the page to enter the editing screen. You will then be able to modify the text for this article as well as its Wikicode. ''Note that if you edit an article without creating an account, your edit will be submitted with your IP address instead of your account name. Please create an account if you don't want your IP address to be visible to user users.''
**T-Doll main page contains all in game doll general statistics, numerical data, weapon background, character design background and imagery art.
 
*For Quotes sub page create page under [[Template:QuotesSubPage]] and fill parameters if applicable and able.
 
**Quotes sub page contains character quotes and appropriate translations only.
 
*Story And Strategy sub pages do not have template, page format and contents are left open for editors' discretion.
 
**Story sub page contains character personality information and story involvements if applicable.
 
**Strategy sub page editors are free to write analysis and guides for the T-Doll's in game performance.
 
  
:'''For editors wanting to fill these pages but doesn't know the value, please [[Project:About|join the wiki discord channel]].'''
+
Wikicode is a simple text system to add links, images and other objects into an article. Here are some basic examples:
 +
*To add a link to another article on IOP Wiki, put the name of that article between double brackets like so: <code><nowiki>[[Girls' Frontline]]</nowiki></code>. It will create this link: [[Girls' Frontline]].
 +
*To add a link to different website, put the full link and a description between single brackets like so: <code><nowiki>[http://gf.sunborngame.com/ Girls' Frontline Official Website]</nowiki></code>. It will create this link: [http://gf.sunborngame.com/ Girls' Frontline Official Website].
 +
**Links to websites unrelated to the activities of IOP Wiki will be considered vandalism.
 +
*To add an image outside of a gallery, you must first upload it from your computer with the page [[Special:Upload]], using a name that correctly describes the function of the image. Then, in your article, add the following code on the line where you want the image to appear: <code><nowiki>[[File:Your image name.png|thumb|Your caption text|450px]]</nowiki></code>. Your image will then be displayed on the right side of the page with a width of 450 pixels.
 +
**To add an image in a gallery, you just need to add its full name (starting with the prefix "File:" and ending with the file format) on a new line between the <code><nowiki><gallery></nowiki></code> markers. To add a caption, place a vertical line after the image name, then the caption.
 +
**Make sure your picture is of good enough quality and isn't too small. If you are uploading a tutorial screenshot showing a specific part of the screen, take the time to add a black layer at 50 % opacity on the unnecessary parts of the screen for clarity.
 +
**Uploading images unrelated to the activities of IOP Wiki will be considered vandalism.
 +
*Lists like this one are made by adding an asterisk (*) at the start of each line. Add more than one asterisk to create a sub-line.
  
'''ALL''' T-doll pages should be created under the name appear on CN server or translated names from Chinese.
+
Before submitting a change, take the time to explain its content and intent in the "Summary" field under the edit field. Then complete the verification question and use the "Preview" button to check what your change will look like before confirming.
*T-Doll {{doll name|HK416|AR|5}} appears on the EN server just as "416" due to reasons, the actual page name remains to be HK416, however a redirect of the page from "416" should be made.
 
*T-Doll {{doll name|Colt Revolver|HG|4}} CN name is 卡尔特左轮, which directly translates to Colt (卡尔特) Revolver (左轮), page made under the translated name Colt Revolver instead of EN server name 'SAA'.
 
  
Note: Use AimAttackSpecificTarge for "Interdiction Shot" and AimAttackCurrentTarge for "Aimed Shot", those two skills share the same icon.
+
If you need ideas on how to help, see the [[IOP Wiki:Todo List|Todo list]].
  
==Editing/Creating Equipment Pages==
+
If you need more help, you can ask questions in the #suggestions-reports-notes room of our [https://discord.gg/GbyJQBp Discord server].
Similar to T-Doll pages, Equipment pages are made using the [[Template:Equipment]]. Copy the code in [[Template:Equipment]], paste them in the desired doll page, and fill in the parameters.
 
  
Since equipment names are subject to translation phrase changes, the equipment pages should be created first under the editor's translation. When that said piece of equipment is later released on the EN server, the page name should then be changed.
+
===Page templates===
 +
IOP Wiki uses templates to generate a standardized display on certain articles. For example, T-Dolls articles use [[:Template:PlayableUnit]], equipment articles use [[:Template:Equipment]] and NPC articles use [[:Template:NPC]].
  
== Guides ==
+
When editing these articles, take notice of the lines starting with unusual formatting like <code><nowiki>| weaponinfo =</nowiki></code> or <code><nowiki>| trivia = </nowiki></code>. Everything you write after one of these markers and before the next marker will be automatically added to one of the main sections of the article. You should make sure you add your information in the correct section.
Guide pages make use of [[Template:Guide]] :
 
Make sure to add <code><nowiki>{{Guide}}</nowiki></code> to the beginning of a page to have a guide navbox appear as follows:
 
{{Guide}}
 
  
Guides are split into 3 sections: The beginners guides, Menu translations, and in-depth mechanics analysis.
+
If your edit doesn't fit any section already on the article, read the template documentation to see if there is a standardized section you can use. To see the documentation page of a template, fetch the title of the template at the top of the article's code, then search the article titled "Template:" followed by the template name.
  
===Screenshots===
+
===Style templates===
 +
Some templates can be added into a paragraph of text. These templates always start with two curly braces, followed by the template name, if necessary some values separated by a vertical line, and finally two closing curly braces. Here are the most used style templates:
 +
*[[:Template:doll name]] adds details to links of T-Dolls articles. This template needs three values: the article name for this T-Doll, its type and its rarity. Here is an example for [[M4A1]], who is a 4-stars AR: <code><nowiki>{{doll name|M4A1|AR|4}}</nowiki></code> will be rendered as {{doll name|M4A1|AR|4}}.
 +
*[[:Template:enemy name]] displays links to enemies articles in a flashy red color, with a skull for bosses. This template has one mandatory value, the article name for the enemy, and one optional value, the word "boss". Here is an example without the optional value: <code><nowiki>{{enemy name|Dinergate}}</nowiki></code> will be rendered as {{enemy name|Dinergate}}. And here is an example with the optional value: <code><nowiki>{{enemy name|Agent|boss}}</nowiki></code> will be rendered as {{enemy name|Agent|boss}}.
  
We prefer that illustrative screenshots uploaded to the wiki follow the following guidelines:
+
A list of all templates in use can be found in [[:Category:Templates]].
* Screenshots should be 720p if possible.
 
* Labels should be in white text, and should be both bold and underlined.  The font used for labels should be Noto Sans (available [https://www.google.com/get/noto/ here]).
 
* Any labels should be clearly associated with the area of the image to which they refer, either by proximity or by explicitly drawn white lines.
 
* Non-essential areas of the image should be blacked out.  The preferred method is by adding a black layer with 50% opacity or above between the base screenshot and any labels.  In cases where 50% is insufficient, higher opacity levels may be used.
 
Please use thumbs of 450 width format for pictures to ensure clarity of the image as a thumb. e.g. <code><nowiki>[[File:A.png|thumb|captionhere|450p]]</nowiki></code>
 
  
=== Useful Tools ===
+
==Why is my change not visible?==
[[Template:ThumbSlider]] - For a slider of thumbnails.
+
As a measure against bots and low-quality content, changes submitted by visitors and new accounts will be reviewed manually before they can appear in the article.
  
 +
IOP Wiki's administrators will mark your account as self-moderated if you contribute meaningfully to the Wiki. Simply submit quality changes and come say hi in the #suggestions-reports-notes room of our [https://discord.gg/GbyJQBp Discord server].
 +
 +
==Note on references==
 +
When adding information such as real-world weapons background or fictional [[Lore|lore]], adding references gives legitimacy to your edit since it makes it easily verifiable that it is not false of fan-created. References can be an in-game chapter number or an external link. A reference is placed right after a batch of information extracted from the same source, and takes the form of a number that links to the references list at the end of the article.
 +
 +
To add a reference, use the "ref" marker like this: <code><nowiki><ref>My source</ref></nowiki></code>. Some page templates will handle the reference list, but if you need to create it by hand, add these two lines at the end of the article: <code><nowiki>==References==</nowiki></code> and <code><nowiki><references /></nowiki></code>
 +
 +
==Note on translations==
 +
AS IOP Wiki aims to stay up-to-date with the CN versions of the games while offering its content in English, terms that have not yet received an official English version will be referred to with unofficial translations. Official translation will be ignored in some cases, like T-Dolls names censored for trademark reasons such as {{doll name|HK416|AR|5}} and names that have received inconsistent translations.
 +
 +
For a complete glossary, see the [[IOP Wiki:Guideline/General Namelist|General Namelist]].
 
[[Category:Wiki Maintenance]]
 
[[Category:Wiki Maintenance]]

Revision as of 13:57, 8 May 2021

AR G36Thumb button.pngG36  is the mascot of IOP Wiki.

This is a quick guide explaining what IOP Wiki is and how to use it.

What is IOP Wiki ?

IOP Wiki organizes information about Girls' Frontline and other games by MICA Team. Anyone can submit change proposals to add or correct information. We cover topics such as T-Dolls lists and statistics, Lore and Guides, and aim to be up-to-date with the CN version of the game. This Wiki takes the name of Important Operations Prototype Manufacturing Company, the company that manufactures most Tactical Dolls in the universe of Girls' Frontline.

Our comment system at the bottom of each article let visitors ask questions for topics not covered in the main article. For rules related to the comment system, see IOP Wiki:Comments Guidelines.

What IOP Wiki is not

IOP Wiki only covers official content from Mica Team and associates. We don't host fan-arts or fan-fictions.

We also don't take vandalism lightly and will take measures against users trying to harm IOP Wiki by adding low-quality content or deleting legitimate content.

How to navigate IOP Wiki

Use the search bar on the top right to search for specific articles.

Use the menu on the left side to access general topics.

T-Dolls articles have dedicated subpages for their story involvement, quotes and Live2D animations (when applicable). These pages are accessed with tabs at the top of each page.

Banners at the top of articles or subsections will warn of spoilers or missing information.

How to edit IOP Wiki

On the article you wish to edit, use the "Edit" button at the top of the page to enter the editing screen. You will then be able to modify the text for this article as well as its Wikicode. Note that if you edit an article without creating an account, your edit will be submitted with your IP address instead of your account name. Please create an account if you don't want your IP address to be visible to user users.

Wikicode is a simple text system to add links, images and other objects into an article. Here are some basic examples:

  • To add a link to another article on IOP Wiki, put the name of that article between double brackets like so: [[Girls' Frontline]]. It will create this link: Girls' Frontline.
  • To add a link to different website, put the full link and a description between single brackets like so: [http://gf.sunborngame.com/ Girls' Frontline Official Website]. It will create this link: Girls' Frontline Official Website.
    • Links to websites unrelated to the activities of IOP Wiki will be considered vandalism.
  • To add an image outside of a gallery, you must first upload it from your computer with the page Special:Upload, using a name that correctly describes the function of the image. Then, in your article, add the following code on the line where you want the image to appear: [[File:Your image name.png|thumb|Your caption text|450px]]. Your image will then be displayed on the right side of the page with a width of 450 pixels.
    • To add an image in a gallery, you just need to add its full name (starting with the prefix "File:" and ending with the file format) on a new line between the <gallery> markers. To add a caption, place a vertical line after the image name, then the caption.
    • Make sure your picture is of good enough quality and isn't too small. If you are uploading a tutorial screenshot showing a specific part of the screen, take the time to add a black layer at 50 % opacity on the unnecessary parts of the screen for clarity.
    • Uploading images unrelated to the activities of IOP Wiki will be considered vandalism.
  • Lists like this one are made by adding an asterisk (*) at the start of each line. Add more than one asterisk to create a sub-line.

Before submitting a change, take the time to explain its content and intent in the "Summary" field under the edit field. Then complete the verification question and use the "Preview" button to check what your change will look like before confirming.

If you need ideas on how to help, see the Todo list.

If you need more help, you can ask questions in the #suggestions-reports-notes room of our Discord server.

Page templates

IOP Wiki uses templates to generate a standardized display on certain articles. For example, T-Dolls articles use Template:PlayableUnit, equipment articles use Template:Equipment and NPC articles use Template:NPC.

When editing these articles, take notice of the lines starting with unusual formatting like | weaponinfo = or | trivia = . Everything you write after one of these markers and before the next marker will be automatically added to one of the main sections of the article. You should make sure you add your information in the correct section.

If your edit doesn't fit any section already on the article, read the template documentation to see if there is a standardized section you can use. To see the documentation page of a template, fetch the title of the template at the top of the article's code, then search the article titled "Template:" followed by the template name.

Style templates

Some templates can be added into a paragraph of text. These templates always start with two curly braces, followed by the template name, if necessary some values separated by a vertical line, and finally two closing curly braces. Here are the most used style templates:

  • Template:doll name adds details to links of T-Dolls articles. This template needs three values: the article name for this T-Doll, its type and its rarity. Here is an example for M4A1, who is a 4-stars AR: {{doll name|M4A1|AR|4}} will be rendered as AR M4A1Thumb button.pngM4A1 .
  • Template:enemy name displays links to enemies articles in a flashy red color, with a skull for bosses. This template has one mandatory value, the article name for the enemy, and one optional value, the word "boss". Here is an example without the optional value: {{enemy name|Dinergate}} will be rendered as Dinergate. And here is an example with the optional value: {{enemy name|Agent|boss}} will be rendered as Agent.

A list of all templates in use can be found in Category:Templates.

Why is my change not visible?

As a measure against bots and low-quality content, changes submitted by visitors and new accounts will be reviewed manually before they can appear in the article.

IOP Wiki's administrators will mark your account as self-moderated if you contribute meaningfully to the Wiki. Simply submit quality changes and come say hi in the #suggestions-reports-notes room of our Discord server.

Note on references

When adding information such as real-world weapons background or fictional lore, adding references gives legitimacy to your edit since it makes it easily verifiable that it is not false of fan-created. References can be an in-game chapter number or an external link. A reference is placed right after a batch of information extracted from the same source, and takes the form of a number that links to the references list at the end of the article.

To add a reference, use the "ref" marker like this: <ref>My source</ref>. Some page templates will handle the reference list, but if you need to create it by hand, add these two lines at the end of the article: ==References== and <references />

Note on translations

AS IOP Wiki aims to stay up-to-date with the CN versions of the games while offering its content in English, terms that have not yet received an official English version will be referred to with unofficial translations. Official translation will be ignored in some cases, like T-Dolls names censored for trademark reasons such as AR HK416Thumb button.pngHK416  and names that have received inconsistent translations.

For a complete glossary, see the General Namelist.