Tears of Themis Wiki:Contributor's guide

From Tears of Themis Wiki

The following is a basic guide for getting started on how to contribute to the Wiki.

If you are familiar with Wiki editing basics, check out the To-do list to see what items need working on!

General[edit source | hide | hide all]

MediaWiki[edit source | hide]

The Wiki uses MediaWiki as its base. Check out the MediaWiki Help pages for documentation on basic formatting, writing guidelines, to more complex templating.

Common basic pages that may be helpful include:

Images[edit source | hide]

Images can be uploaded through Special:Upload or using the MsUpload extension, which allows you to drag and drop images to upload from the source editor.

When uploading an image, make sure to categorize the image appropriately (Or just add it to Category:Images) as well as add licensing if available.

For example, an uploaded game image summary may look like:

== Summary ==
Description of image
[[Category:Images]]
== Licensing ==
{{Copyright game}}

Boilerplates[edit source | hide]

Boilerplates are pages that can be reused repeatedly and also help with maintaining the same standard format across various pages with the same type of content (e.g. Character pages, organization pages, etc.).

Boilerplates can be used when creating a new page in source editor. Above the editor textbox, there will be a "Select Boilerplate" dropdown where you can load various boilerplates.

A list of boilerplates can be found at MediaWiki:Multiboilerplate.

Templates[edit source | hide]

The Wiki relies heavily on using templates for formatting and storing of Cargo data. While templates are powerful, they often aren't as editor-friendly due to often times being incompatible with Visual Editor. Therefore, it is highly recommended to use and get comfortable with editing the Wiki through source editor over Visual Editor.

For instructions on how templates work and how to use templates, read the MediaWiki documentation on templates.

A list of templates on the Wiki can be found at Category:Templates.

Cargo[edit source | hide]

Cargo is a powerful MediaWiki extension that allows storing of data, which can then be queried from across the Wiki. It is used to automate creation of tables, lists, and other templates to reduce the amount of manual maintenance edits.

For more information on Cargo, read the Cargo documentation pages.

Cargo Example[edit source | hide]

Template:Organization member stores member of an organization into a Cargo table. When used on an organization page, it'll then store information about that organization, the member's name, and the member's role.

On National Central University, for example, Luke Pearce is listed as a Graduate (Bioengineering) using Template:Organization member.

{{Organization member
|name=Luke Pearce
|role=Graduate (Bioengineering)
}}

He is also listed as an organization member of Pearce Private Investigations.

On Luke Pearce's page under the Organizations section, instead of manually re-listing all the organizations Luke is a part of, we do the following Cargo query:

{{#cargo_query:tables=OrganizationMember
|fields=organizationName,memberRole
|where=memberName="Luke Pearce"
|format=ul
}}

Essentially, we get the organizationName and memberRole from the OrganizationMember Cargo table where the member's name is Luke Pearce and display it as a list. This will get both his roles in National Capital University as well as Pearce Private Investigations.

Additionally, if Luke is added to another organization, this list will automatically update so that we only need to edit the organization page vs. both the organization and character page.

Specific How-Tos[edit source | hide]

  • Note that most of these require the use of templates. While Visual Editor can sometimes work for editing templates, that is not always the case. It is highly recommended to use source editor to do these tasks.

Adding a new Card[edit source | hide]

When creating the new page, select the "Card Page Template" boilerplate, remove the tags, and fill out the template.

If you're unsure about how to fill out the parameters, look at the documentation for Template:Card info and check the "Parameters" section.

Adding a new Skill[edit source | hide]

Skills are grouped based on their General skill name (e.g. Sharp Debater II and Sharp Debater III will both be on the Sharp Debater page.), so before creating a new page, check if there's a general skill page that already exists.

  • If a general page doesn't exist, select the "Skill Page Template" and remove the tags. There will be two templates. Do not edit the outer template, instead, fill in the "Skill info" template that comes after `|variations=`.
  • If a general page already exists, copy the blank template found on Template:Skill info and fill it in. The page also details how to fill out the parameters.

Adding a new Item[edit source | hide]

Items are grouped based on their General item name (e.g. Logic Chip I and Logic Chip II will both be on Logic Chip), so before creating a new page, check if there's a general item page that already exists.

  • If a general page doesn't exist, select the "Item Page Template" and remove the tags. There will be two templates. Do not edit the outer template, instead, fill in the "Item" template that comes after `|items=`.
  • If a general page already exists, copy the blank template found on Template:Item and fill it in. The page also details how to fill out the parameters.

Adding a new Invitation[edit source | hide]

When creating the new page, select the "Invitation Page Template" boilerplate, remove the tags, and fill out the template.

If you're unsure about how to fill out the parameters, look at the documentation for Template:Invitation and check the "Parameters" section.

Adding a new Badge[edit source | hide]

Go to the Badges page. Copy the template from Template:Badge, add it to the page, and fill it in. The template has descriptions for how to fill out each parameter.

Adding a new Shadows of Themis[edit source | hide]

Go to Shadows of Themis/Archive/2021. Copy the blank template from Template:Shadow of Themis and fill it out. If you're unsure about how to fill out the parameters, look at the documentation on the page and check the "Parameters" section.

Adding scripts/dialogue[edit source | hide]

Note that miHoYo has asked us to not add exact scripts of Main Story/Card Story/Character Story and any other potential content with spoilers. However, short summaries of these are fine. Text Messages/Phone Calls/Private Messages are also fine to add exact scripts of.

The Wiki has Template:Script, Template:Script line and Template:Script choice that we use to maintain script/dialogue formatting across the Wiki. Template:Script has the documentation on how to use the script template.

It has features such as:

  • Dialogue box styling (can be disabled if desired)

When using Template:Script line

  • Automatic styling (bolding speakers, proper colon positioning, color highlighting the male leads' names, etc.)
  • Automatic character linking after specifying it in the template.

When using Template:Script choice

  • Automatic formatting of script choices.