Paradise 14 Wiki:Style Guide: Difference between revisions

Latest revision as of 04:12, 2 January 2026

This page describes how our wiki pages should look, read, and reference each other. All relative examples will be pulled from the science department page.

Go back to the main contributing page

Page layout

Title

The page title sits at the top of the page. You don't need to add the title as a header when editing the page. Titles of content pages (i.e. regular pages) should follow Title Case - first letter of each word is capitalized, except some words like "over", "a", etc.

Titles for other pages (category, template) should follow Sentence case - only the first letter is capitalized.

Callout/Warnings

This banner should be at the top of the page. Some pages can be volatile, or a contributor could be actively working on changes. If you need to state a custom banner any reason use Template:Callout. If you prefer to use premade templates though there is Template:Important and Template:Unfinished.

Preamble

The preamble precedes the first header section of a page. If a page requires an introduction to the information, then put that introduction in the preamble.

Table of Contents (TOC)

The table of contents displays below the preamble, and before the first header. The TOC is included automatically on pages with more than three section headings<ref>https://www.mediawiki.org/wiki/Manual%3aTable_of_contents</ref>, and by default will be floating left and show all headers. Parameters on the Template:TOC can be used to change location and header depth.

Content

Most pages will follow their own logical breakdown of the content within.

However department pages follow a guideline of:

Sections of X
Jobs of X
System 1
System 2
System X...
Equipment
Guides

While a lot of content on this wiki will be written from the perspective of players in the game, there should be a distinction between factual information about the game and guides (or other recommendations) made by a specific player that explain how to play. The Template:Cat should be added to pages that have such recommendations, but note that categories don't significantly affect how pages are displayed.

Headings

Headings appear below the TOC and organize content on the page. Headings can be nested.

Headings should typically follow a logic of Heading for large sweeping topics.
Sub-heading 1 for subsections of headings.
Sub-heading 2 for subsections of sub-heading 1 sections....etc.

Paragraphs

Paragraphs should sit under each respective heading. Headings that don't have an associated paragraph should be avoided or rewritten.

Context paragraphs should provide an overview about what you're going to talk about in depth later.
Content/Depth Paragraphs should provide a clear and in depth explanation of how a system works to the best of your ability.
Supporting images should be used to show relevant in-game sprites and menu screens.

Images

Template:Callout

Enabling smooth rendering

To enable smooth rendering, add Template:C class, for instance:<syntaxhighlight lang="mediawiki"> </syntaxhighlight>Produces:

Videos

Videos are added the same way images do. This is provided by EmbedVideo extension.

For more info, including various new options, see https://github.com/StarCitizenWiki/mediawiki-extensions-EmbedVideo

Making framed gifs

Since videos do not support Template:C image mode, an template was made specifically for making gifs from videos in Template:C-like appeareance. See Template:T.

@@ Line 1: / Line 1: @@
-This page describes how the wiki is styled: how certain elements should look and behave. For all relative examples, I will be using the [[Science Department|science department]] page.
+This page describes how our wiki pages should look, read, and reference each other. All relative examples will be pulled from the [[Science Department|science department]] page.
-For formatting, see the [[Wiki Formatting]] guide.
+[[SS14:Contributing|Go back to the main contributing page]]
-{{TOC|depth=5}}
+== Page layout ==
+=== Title ===
-= Page title =
+'''The page title sits at the top of the page.''' You don't need to add the title as a header when editing the page. Titles of content pages (i.e. regular pages) should follow [[wikipedia:Title_case|Title Case]] - first letter of each word is capitalized, except some words like "over", "a", etc.
-'''The page title should sit at the top of the page.''' Titles of content pages (i.e. regular pages) should follow [[wikipedia:Title_case|Title Case]] - first letter of each word is capitalized, except some words like "over", "a", etc.
 Titles for other pages (category, template) should follow '''Sentence case''' - only the first letter is capitalized.
 [[File:Page-title.png|alt=Page-title|center]]
-=== Page Warnings ===
+=== Callout/Warnings ===
-'''This banner should sit below the page title.''' Many pages can be highly volatile or considered a WIP. If you need to state a custom banner any reason use [[Template:Callout]]. If you prefer to use premade templates though there is [[Template:Important]] and [[Template:Unfinished]].
+'''This banner should be at the top of the page.''' Some pages can be volatile, or a contributor could be actively working on changes. If you need to state a custom banner any reason use [[Template:Callout]]. If you prefer to use premade templates though there is [[Template:Important]] and [[Template:Unfinished]].
 === Preamble ===
-'''The preamble should sit below the title of the page.''' If a page requires an introduction to the information then introduce a preamble.
+'''The preamble precedes the first header section of a page.''' If a page requires an introduction to the information, then put that introduction in the preamble.
 === Table of Contents (TOC) ===
-'''The table of contents should sit after the preamble.''' The TOC can be edited using [[Template:TOC]]. Generally, keep the TOC floating left and keep the depth between 3-4. If you absolutely need the depth to be longer, then you can but it can easily be overwhelmingly large if above 4.
+'''The table of contents displays below the preamble, and before the first header.''' The TOC is included automatically on pages with more than three section headings<ref>https://www.mediawiki.org/wiki/Manual%3aTable_of_contents</ref>, and by default will be floating left and show all headers. Parameters on the [[Template:TOC]] can be used to change location and header depth.
-== Content ==
+=== Content ===
 Most pages will follow their own logical breakdown of the content within.
-However '''department pages''' follow a guideline of:
+However '''[[Departments|department pages]]''' follow a guideline of:
 # Sections of X
@@ Line 34: / Line 33: @@
 [[File:Content1.png|alt=Content1|center]]
+While a lot of content on this wiki will be written from the perspective of players in the game, there should be a distinction between factual information about the game and guides (or other recommendations) made by a specific player that explain how to play. The {{cat|Guides}} should be added to pages that have such recommendations, but note that categories don't significantly affect how pages are displayed.
 === Headings ===
-'''Headings should sit below both the TOC and their authoritative headings (i.e. Subheading 1 should sit under Heading)'''.
+'''Headings appear below the TOC and organize content on the page. Headings can be nested.'''
 * Headings should typically follow a logic of Heading for large sweeping topics.
@@ Line 42: / Line 43: @@
 * Sub-heading 2 for subsections of sub-heading 1 sections....etc.
-The way you should use headings is generally going to be determined by how you're going to break down a subject.
+=== Paragraphs ===
+'''Paragraphs should sit under each respective heading.''' Headings that don't have an associated paragraph should be avoided or rewritten.
-==== Paragraphs ====
-'''Paragraphs should sit under each respective heading.'''
 * Context paragraphs should provide an overview about what you're going to talk about in depth later.
 * Content/Depth Paragraphs should provide a clear and in depth explanation of how a system works to the best of your ability.
-* Supporting images should be used frequently and to aid in the explanation of what you're talking about and how to use something.
+* Supporting [[SS14:Formatting#Images|images]] should be used to show relevant in-game sprites and menu screens.
+== Images ==
+{{Callout|Info|All images on the wiki are rendered with '''pixelated''' mode by default.}}
+=== Enabling smooth rendering ===
+To enable smooth rendering, add {{c|smooth}} class, for instance:<syntaxhighlight lang="mediawiki">
+[[File:UI_before_menu.png|class=smooth]]
+</syntaxhighlight>Produces:
+[[File:UI_before_menu.png|class=smooth]]
+== Videos ==
+Videos are added the same way images do. This is provided by '''EmbedVideo''' extension.
+For more info, including various new options, see https://github.com/StarCitizenWiki/mediawiki-extensions-EmbedVideo
+=== Making framed gifs ===
+Since videos do not support {{c|frame}} image mode, an template was made specifically for making gifs from videos in {{c|frame}}-like appeareance. See {{t|EmbedVideo Gif Frame}}.
-[[Category:For maintainers]]
+[[Category:Contributing]]