Paradise 14 Wiki:Style Guide - Revision history

imported>KindaNice: improving readability for page layout recommendations

2026-01-02T04:12:59Z

improving readability for page layout recommendations

← Older revision		Revision as of 04:12, 2 January 2026
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.

	[[SS14:Contributing\|Go back to the main contributing page]]		[[SS14:Contributing\|Go back to the main contributing page]]

	~~{{TOC\|depth~~=~~5}}~~		== Page layout ==
			=== Title ===
	=~~= General~~ ==		'''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.
	=== ~~Page title~~ ===
	'''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.		Titles for other pages (category, template) should follow '''Sentence case''' - only the first letter is capitalized.
Line 13:		Line 11:

	=== Callout/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 ===		=== 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) ===		=== 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.		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		# Sections of X
Line 36:		Line 34:
	[[File:Content1.png\|alt=Content1\|center]]		[[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.		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 ===
	'''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.		* Headings should typically follow a logic of Heading for large sweeping topics.
	* Sub-heading 1 for subsections of headings.		* Sub-heading 1 for subsections of headings.
	* Sub-heading 2 for subsections of sub-heading 1 sections....etc.		* 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 ===
	'''Paragraphs should sit under each respective heading.'''		'''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.		* 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.		* 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 ==		== Images ==

imported>KindaNice at 16:50, 9 September 2025

2025-09-09T16:50:37Z

← Older revision		Revision as of 16:50, 9 September 2025
Line 36:		Line 36:
	[[File:Content1.png\|alt=Content1\|center]]		[[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 ~~[[Category:Guides~~\|Guides ~~category]]~~ should be added to pages that have such recommendations.		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.

	=== Headings ===		=== Headings ===

imported>KindaNice: /* Content */ add correct usage of Guides category

2025-09-09T16:46:48Z

Content: add correct usage of Guides category

← Older revision		Revision as of 16:46, 9 September 2025
Line 22:		Line 22:

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

	However '''department pages''' follow a guideline of:		However '''department pages''' follow a guideline of:
Line 35:		Line 35:

	[[File:Content1.png\|alt=Content1\|center]]		[[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 [[Category:Guides\|Guides category]] should be added to pages that have such recommendations.

	=== Headings ===		=== Headings ===

imported>Aliser: smooth-render → smooth (easier)

2025-05-21T03:22:49Z

smooth-render → smooth (easier)

← Older revision		Revision as of 03:22, 21 May 2025
Line 56:		Line 56:

	=== Enabling smooth rendering ===		=== Enabling smooth rendering ===
	To enable smooth rendering, add {{c\|smooth~~-render~~}} class, for instance:		To enable smooth rendering, add {{c\|smooth}} class, for instance:<syntaxhighlight lang="mediawiki">
			[[File:UI_before_menu.png\|class=smooth]]
			</syntaxhighlight>Produces:

	~~{{sthl\|mw=1\|i=1\|<nowiki>[[File:UI_before_menu.png\|class=smooth-render]]</nowiki>}}~~		[[File:UI_before_menu.png\|class=smooth]]

	~~Produces:~~

	[[File:UI_before_menu.png\|class=smooth~~-render~~]]

	== Videos ==		== Videos ==

imported>Aliser: added a backlink to the main contributing page, removed see also

2025-03-15T22:24:37Z

added a backlink to the main contributing page, removed see also

← Older revision		Revision as of 22:24, 15 March 2025
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 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.

	~~For formatting, see the~~ [[~~Wiki Formatting~~]] ~~guide.~~		[[SS14:Contributing\|Go back to the main contributing page]]

	{{TOC\|depth=5}}		{{TOC\|depth=5}}
Line 71:		Line 71:
	=== Making framed gifs ===		=== 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}}.		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}}.

	~~== See also ==~~
	* [[Contributing:Guide]]


	[[Category:Contributing]]		[[Category:Contributing]]

imported>Aliser: added stuff from Contributing:Style guide; changed cat For maintainers → Contributing

2025-03-15T22:09:18Z

added stuff from Contributing:Style guide; changed cat For maintainers → Contributing

← Older revision		Revision as of 22:09, 15 March 2025
Line 52:		Line 52:
	* Supporting images should be used frequently and to aid in the explanation of what you're talking about and how to use something.		* Supporting images should be used frequently and to aid in the explanation of what you're talking about and how to use something.

	[[Category:~~For maintainers~~]]		== 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-render}} class, for instance:

			{{sthl\|mw=1\|i=1\|<nowiki>[[File:UI_before_menu.png\|class=smooth-render]]</nowiki>}}

			Produces:

			[[File:UI_before_menu.png\|class=smooth-render]]

			== 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}}.

			== See also ==
			* [[Contributing:Guide]]


			[[Category:Contributing]]

imported>Aliser: restructured a bit

2025-03-15T22:04:06Z

restructured a bit

← Older revision		Revision as of 22:04, 15 March 2025
Line 5:		Line 5:
	{{TOC\|depth=5}}		{{TOC\|depth=5}}

	= Page title =		== General ==
			=== Page title ===
	'''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.		'''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.

Line 20:		Line 21:
	'''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 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.

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

Line 44:		Line 45:
	The way you should use headings is generally going to be determined by how you're going to break down a subject.		The way you should use headings is generally going to be determined by how you're going to break down a subject.

	==== Paragraphs ====		=== Paragraphs ===
	'''Paragraphs should sit under each respective heading.'''		'''Paragraphs should sit under each respective heading.'''

imported>UpAndLeaves: UpAndLeaves moved page Wiki Style Guide to SS14:Style Guide: To fit with MediaWiki standards

2024-10-27T21:07:55Z

UpAndLeaves moved page Wiki Style Guide to SS14:Style Guide: To fit with MediaWiki standards

← Older revision	Revision as of 21:07, 27 October 2024
(No difference)

imported>Soupki: /* Page Warnings */ Minor text fix

2024-10-03T20:25:58Z

Page Warnings: Minor text fix

← Older revision		Revision as of 20:25, 3 October 2024
Line 11:		Line 11:
	[[File:Page-title.png\|alt=Page-title\|center]]		[[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 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]].

imported>Soupki: Added a style-guide for contributors and maintainers of the wiki

2024-10-03T20:24:43Z

Added a style-guide for contributors and maintainers of the wiki

@@ Line 1: / Line 1: @@
-{{unfinished}}
+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 the wiki is styled: how certain elements should look and behave.
+For formatting, see the [[Wiki Formatting]] guide.
-For formatting, see the [[Wiki Formatting]] guide.
+{{TOC|depth=5}}
-== Page title ==
+= Page title =
-Titles of content pages (i.e. regular pages) should follow [https://en.wikipedia.org/wiki/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.
 [[Category:For maintainers]]