Help:Wiki editor's guide

This page contains various tips that can help you contribute to the wiki.

Reporting wiki issues

Unlike on most wikis, talk pages on the postmarketOS wiki are disabled, and all wiki-related discussion takes place in the postmarketOS/wiki repo on the postmarketOS GitLab. If you find an issue with something on the wiki, and you can't fix it yourself, or if you'd like to discuss something before making a change, open an issue there.

Reporting pages to delete

Pages that should be deleted can be added to the table on Pages needing deletion.

Getting to know MediaWiki syntax

The postmarketOS wiki is powered by MediaWiki - the same software that powers e.g. Wikipedia.

A complete guide to MediaWiki syntax can be found on their wiki: Help:Formatting. The following is a brief summary of the most commonly used formatting syntax:

Common MediaWiki formatting syntax
Formatting	Syntax	Result
Italics	`''Italicized text''`	Italicized text
Bold	`'''Bold text'''`	Bold text
Wiki page link	[[Devices]] [[PINE64 PinePhone (pine64-pinephone)\|Example]]	Devices Example
External link	[https://postmarketos.org] [https://postmarketos.org link label]	[1] link label
Adding a page to a category	`[[Category:Guide]]` (place at the bottom of your page)	-
Headers	== Level 2 == Section under level-2 heading! === Level 3 === Section under level-3 heading! ==== Level 4 ==== Section under level-4 heading!	Level 2 Section under level-2 heading! Level 3 Section under level-3 heading! Level 4 Section under level-4 heading!
Unordered lists	* This is a list. * Second bullet point. ** This one is indented.	This is a list. Second bullet point. This one is indented.
Ordered lists	# This is a list. # Second bullet point. ## This one is indented.	This is a list. Second bullet point. This one is indented.
Codeblock with syntax highlighting	<syntaxhighlight lang="python"> for i in range(10): print(i) </syntaxhighlight>	for i in range(10): print(i)
Comment	<!-- This is a comment -->

Setting up your user page

You can go to your user page by clicking on your username in the top right corner of the navbar.

When you sign up, the contents of the biography you provided when creating your account are added to your user page. While you're editing your user page, there's a few things that are worth including:

Adding your owned devices

In order to appear in "Users owning this device" sections on device wiki pages, you will need to add the {{Owns device}} template to your user page. To do this, add the following to the end of your wiki page:

<div style="display: none;"> <!-- this prevents empty space showing up where the templates would be added -->
{{Owns device|Device_name_(device-codename)}}
{{Owns device|Device_name_2_(device-codename2)|Notes}}
...
</div>

Add as many "Owns device" templates as you need. Replace Device_name... with the name of your device's wiki page (replace spaces with underscores). If you want, you can also include notes (as seen in the second example).

In order to show the devices you own on your user page, add the following template wherever you'd like the table to be displayed:

{{My devices}}

Adding userboxes

There are various userboxes - small colorful boxes with fun information about you - that you can add to your wiki page. See PostmarketOS:Templates#Userboxes for a visual guide.

To add userboxes to your profile, wrap them in a {{Userbox container| ... }}:

{{Userbox container|
  {{User ports|9001}}
  {{User main device|PINE64 PinePhone (pine64-pinephone)}}
}}

This will make them stick together and float to the right side of the page.

Creating and editing articles

To create a new article, type its name into the search box. Then, click the red link with the name next to the "Create the page" label.

Editing device pages

Device pages have a device infobox that contains information about the status of the device they describe. The data on the Devices page is automatically generated from the data in the infobox.

For more information about editing and creating these pages, see Help:Device Page and Template:Infobox device.

Query tables

You may notice that on some pages, e.g. chipset pages or the Devices page, there are automatically generated tables based on a database query.

The postmarketOS wiki uses an extension named Cargo to provide support for such tables. For more information about using Cargo, see its documentation (e.g. the Quick start guide or the Querying data guide).

Subpages

The standard way to create a subpage is to:

Create a new page named Pagename/Subpage, where Pagename is the name of the main page, and Subpage is the name of the subpage you want to create.
Add the {{Subpages|Pagename}} template to the top of the page (this makes a link to the previous page show up).

You can also nest subpages (e.g. Pagename/Subpage/Subsubpage), in which case to show the full link tree at the top, use {{Subpages|Pagename|Subpage}}.

Adding the {{Subpages|...}} template is not needed under user pages.
On user pages, MediaWiki's default support for subpages is enabled, which means the navigation appears automatically. On non-user-pages, subpages are disabled, since they would interfere with any wiki pages with / in the title, which is used pretty often; thus, the {{Subpages|...}} template is a manual workaround to get the links to appear. See Help:Subpages for the relevant MediaWiki documentation.