View source for Guide:How to TSPedia

This is a meta article dedicated to publishing good practices and standards for writing roleplay content on TSPedia.

This article contains some basic information related to implementing wikitext formatting, but is not intended to be a detailed guide for it; more detailed knowledge is best obtained by asking active wiki writers or by looking at the formatting implementations of preexisting pages.

==Formatting==
Several formatting rules and recommendations for TSPedia pages exist to help increase readability and standardization.
===Canon tags===
All roleplay-related TSPedia page titles have a suffix that denotes their canon; these are “abc (Pacifica)”, “def (A1-0)”, “ghi (Aurora)”, and rarely “jkl (Extra-canon)”. This suffix must always be present. Additionally, only the first word and proper nouns should be capitalized in page titles; for example, a page should be titled “List of major cities in Nation” and not “List Of Major Cities In Nation”.
===Section headers===
Page header/subheader structures have no clearly defined standard; if you are confused about what an appropriate header arrangement for a page would be, consider looking at TSPedia or Wikipedia pages with similar content. Headers should not be made into links; instead, the “Main” and “See also” templates should be used.
===Text===
Major style guidelines governing text are:
{{bulleted list
|The article title and any mentioned alternate names and languages should be bolded or italicized like as follows when stated in the first paragraph of a page: “The '''Abc''' (other language: '''Абв''', ''Abv''), also known as the '''Def''' or the '''Ghi''', is text text text…”
|Outside of the above case, text should not be bolded. Italics should also be avoided except to denote book and film titles, ship names, and other cases as are similar to other style guides.
}}

==Tables==
{| class="wikitable"
|-
! Colspan="6" style="background:#00BFFF; color:#FFFFE0;" | '''Tables'''
|-
! Colspan="6" style="background:#F0F8FF;" | Introduction and basics
|-
| colspan="6" style:"background:#FFFFFF; text-align:left; text-align:up;" | TSPedia allows for the use of wikitables, which are a powerful and flexible way to display data, lists, pictures, and many other types of information that may be contained within a wiki page.
<br>{{bulleted list
| The “insert” tab at the top of the wikitext editor can be used to automatically paste in the formatting for a basic 2x2 cell table, which can then be extended further to show basic information
| This table presents some of the many types of formatting that can be used to style such tables in ways that most effectively display your desired information; this includes the colspan and rowspan parameters, the application of cell text and cell background colors, and text alignment.
| Some tables are sortable; this is done by replacing the <nowiki>class="wikitable" setting with class="wikitable sortable"</nowiki>. In order to ensure that numerical information is properly sorted by such tables and is not perturbed by inclusions such as dividing commas or plus symbols (e.g. in the number 1,000+), remember to wrap such numbers in the <nowiki>{{formatnum}} template like so: {{formatnum:1000+}}</nowiki>.
}}
|-
! Colspan="6" style="background:#F0F8FF;" | Colspan and rowspan
|-
! colspan="2" style="background:#F0F8FF;" | Demo subheader 1
! colspan="2" style="background:#F0F8FF;" | Demo subheader 2
! colspan="2" style="background:#F0F8FF;" | Demo subheader 3
|-
| colspan="6" style:"background:#FFFFFF; text-align:left; text-align:up;" | Above is a demonstration of the type of formatting that is achievable with the colspan parameter of tables; similar formatting for rows is also available through the rowspan parameter. These commands allow for the creation of headers and subheaders that can be used, primarily, to group rows and columns of similar data together under a single label. They may be implemented by prefacing a cell with the text <nowiki>colspan="2" for columns and rowspan="2" for rows</nowiki>, with the “2” in each example replaced with the desired number of rows or columns to be spanned over. Take special note of the fact that the quotations used in the formatting must be straight quotations "", and not the normal quotations “” which are used by default on mobile keyboards; mobile users can access straight quotation marks in the same manner as other character variants.
|-
! Colspan="6" style="background:mediumvioletred; color:#FFFFFF; text-align:left;" | Colors and text alignment
|-
| colspan="6" style:"background:#FFFFFF; text-align:left; text-align:up;" | Colors can be used to give your table a theme, distinguish certain sections from each other, and otherwise break up the large gray blob that unformatted tables can display. Similarly, some cells may be better presented with different text alignment settings manually set. These properties are all set by prefacing the cell with the text <nowiki>| style:"background:#FFFFFF; color:#FFFFFF; text-align;left; text-align:up;"</nowiki>, with properties removed or adjusted as appropriate. Colors can also be set by substituting hexadecimals with names from the [[Wikipedia:Web colors#Extended_colors|extended HTML colors list shown here]].
|-
! Colspan="6" style="background:#F0F8FF;" | Images
|-
| colspan="6" style:"background:#FFFFFF; text-align:left; text-align:up;" | Table cells can include images. these are implemented by simply placing the image link (such as <nowiki>[[file:Pelinese Flag.png|150px]]</nowiki> into the cell field. The alignment of the image can be adjusted by the previously mentioned text-align property when it is applied to the cell; some examples of this are shown below.
|-
| colspan="2" style="text-align:center;" | [[file:Pelinese Flag.png|150px]]
| colspan="2" style="text-align:left;" | [[file:Sallodesian Flag.png|150px]]
| colspan="2" style="text-align:right;" | [[file:Flag of sedunn.png|150px]]
|-
|}

==Templates==
Most types of roleplay content pages would benefit from at least one template. This is typically an infobox template, which are named according to the convention “template:infobox (type here)”; searching for templates requires the inclusion of the “template:” prefix.

Many template implementation copies on TSPedia lack documentation for their available fields and other information necessary for their use. In instances where this is the case, usage information can often be found by asking wiki writers, visiting the corresponding template page on Wikipedia ([[Wikipedia:template:infobox country|this one]], for example), or (especially in the case of templates unique to TSPedia) by finding a TSPedia page that implements it and copying the template text.
===Country data templates===
Many pages on TSPedia, especially list page like [[List of countries by GDP (Pacifica)|this]], contain a specific template called a flag template or a country data template. This is a common template which can be used to automatically add links and small-sized, inline flags like these:
{{bulleted list
|{{flag|Pelinai}}
|{{flagicon|Pelinai}}
|{{flag|Pelinai|jack}}
}}
The easiest way to add a country data template for your nation is to create a page named “template:country data ((nation name here))”, copying the text from another country data template, and editing parameters such as the name and flag picture links as necessary.
===Infoboxes===
Most common page types benefit greatly from being anchored by a specific type of sidebar template called an infobox. These templates are boxes that function like the abstract of a paper: they provide an easy way for writers to quickly communicate a summary of key statistics and other information to readers, which becomes increasingly important with larger, more detailed pages. A variety of infoboxes tailored to different page subjects can be found on TSPedia by searching for them, and more are occasionally added on a by-request basis.
===List templates===
Some infobox templates are incompatible with list formatting methods like “<nowiki>{{*}}</nowiki>” (which appears as a {{*}}) and “<nowiki><br></nowiki>” (which produces a line break). For instances where this is the case, templates such as <nowiki>{{bulleted list}}, {{ordered list}}, and {{plainlist}}</nowiki> may be used instead. These have display styles, as shown below. For implementation details and more style options, refer to [[Wikipedia:Template:HTML lists|this Wikipedia page]].

{| class="wikitable"
|-
! Plain list
! Bulleted list
! Ordered list (decimal)
|-
| {{plainlist|
*item 1
*item 2
*item 3
}}

| {{bulleted list
| item 1
| item 2
| item 3
}}

| {{ordered list
| item 1
| item 2
| item 3
}}
|-
|}

==Connectivity==
[[File:Wiki guide dropdown sample.png|thumb|upright=0.8|A picture of the end of a wiki page, showing the dropdown box and categories.]]
If a roleplayer writes a wiki page and nobody finds it to read it, does the page really exist? Making sure that your page can be found is an important part of making it useful; for this purpose, connectivity aids like links, categories, and drop-down boxes exist.
===Links===
There are two maintenance pages on TSPedia which list pages that either are not linked to or do not link to anything; these are called orphaned pages and dead-end pages, respectively, and can be found by visiting the “special pages” section linked on the left-hand sidebar of TSPedia. Do not, under any circumstances whatsoever, add entries to this list; every page in TSPedia should link to and be linked to by other pages. Being linked to is especially critical for the visibility of highly specialized pages, such as “Orders, medals, and decorations of xyz”, which are unlikely to be specifically searched for by name.
<br>Links in roleplay pages typically go to TSPedia, like [[Pacifica (Pacifica)|this]], or to Wikipedia, like [[Wikipedia:Earth|this]]. Links are case-sensitive aside from the first letter, in a similar manner to the search box; links like [[Pacifica (Pacifica)]] will function, as will [[pacifica (Pacifica)]], but [[Pacifica (pacifica)]] will not. Adding a hashtag/pound sign to a link will cause it to point towards a specific header of a TSPedia or Wikipedia page as applicable, such as in the case of [[Pacifica (Pacifica)#Atmosphere]].
<br>Links that lead to nonexistent pages are [[Dummy red page|red]]; clicking a red link will prompt you to create the page. Red links are very common throughout TSPedia as a way to indicate that a particular page needs to be made, or that it is planned to be created in the future.
===Categories===
Category tags and category pages are a helpful method of linking together pages with a common theme or subject. Adding a category tag to a page and creating the red-linked page that it links to will automatically generate a list of all pages with the category tag on them; this provides a central directory where all pages pertaining to a specific topic can be viewed, as well as an up-to-date counter displaying the amount of pages in that category.
<br>While not all potential topics warrant having a category created for them, consider making categories for topics that currently possess a set of 8 or more pertinent pages. Typical candidates for categorization include roleplay nations with high wiki presence (e.g. the Anserisa, Pelinai, and Sedunn categories) and particular classes of pages with similar purpose (e.g. the “collaboration stubs (Pacifica)” category).
===Drop-down boxes===
Drop-down boxes are a specialized type of template and a powerful tool to organize particularly large systems of wiki pages centered around a common subject; the ability to create subsections within them makes it easy to organize large blocks of page links, and readers can more easily navigate such arranged repositories as well. They should generally be reserved for page systems numbering roughly 10 to 15 or more entries, and should be placed at the bottom of a page.
===Sidebar boxes===
The sidebar box is a convenient way to add a link block to the top of a page in an aesthetically pleasing manner. They are placed inside the article instead of at the bottom like a drop-down box; this increases their visibility in comparison to drop-down boxes, but can also visually clutter the top of the page if the sidebar box is particularly large and/or placed in combination with a large infobox.

==Canon-specific considerations==
===Quote boxes===
The [[Guide: Getting started in roleplay#A1-0_canon|Sector A1-0]] and [[Guide: Getting started in roleplay#Aurora_canon|Aurora]] canons, respectively TSPRP’s sci-fi and fantasy themed roleplays, both make extensive use of the quote box template as a header for their wiki pages due to the specific page writing style of the roleplayer [[user:Maverick|Maverick]]. Such use of a quote box in A1-0 and Aurora pages (particularly those pertaining to nations, species/races, and characters) is not mandatory, but can be considered to be a prevailing style norm.

==See also==
[[Guide: Getting started in roleplay]]

[[Category:Community guides]]