Jump to content

PostmarketOS:Templates

From postmarketOS Wiki

MediaWiki allows us to define custom templates, which can then be included in other wiki pages. When creating a new one, please add it below, and use the "Template:Template" at the top of the new template. Check existing templates for reference. An automatically generated list of templates can be found here.

Available templates

  • Bc - Puts text in a bold code block
  • Button - Representation of pressing a button or sequence of buttons in order
    • ButtonCombo - Representation of multiple buttons pressed simultaneously
  • App - format several standard properties of an app, used in Applications by category
  • AppAntifeature / Appaf - describe properties of an app that do not adhere to postmarketOS' principles, used in Applications by category
  • Hc - block code with header (can be used for listing the contents of a file, with the file location on top)
  • Icon box - simple box with icon
  • Side box - smaller simple box without icon
  • Infobox - on the top right of every device / user interface article
  • Based-on-SoC - sidebox that directs to SoC page for common information
  • Syslog - short explanation on how to read relevant syslog entries
  • Userbox - userbox template
  • Latest stable release - outputs the version number of the latest stable release
  • Erase data warning - Shows a warning that all data will be erased (unlocking bootloader)
  • PrevNext - Used to chain pages together
  • Lemmy - links to a post in the PostmarketOS community on Lemmy
  • Subpage of - lists pages that this page is a subpage of
  • GetSingleValue - Returns the first argument as is, for internal use (ex: cargo_query)
  • FirstNonEmpty - Returns the first non-blank found from multiple inputs

Wiki links

Main page

Repository links

Page information

  • Work-in-progress page - Shows a WIP warning for the page
  • Stub - Marks a page as needing significant expansion
  • Outdated - Indicates a significant amount of information is outdated
  • Todo - Indicates a specific task to complete

Section information

  • See also - "see also" note placed under section headers
  • Hint - Shows a highlighted box for hints
  • Note - Shows a highlighted box for notes
  • Notice - Shows a highlighted box for important notes
  • Warning - Shows a highlighted box for warnings

Device ownership

Package links

  • Device package - link to the device package in the postmarketOS repository
  • Firmware package - link to the firmware package for the device in the postmarketOS repository
  • Kernel package - link to the kernel package for the device in the postmarketOS repository
  • Infobox package - combines the three templates above into an infobox
  • Aport - links to the Alpine Linux package search page for a given package
  • Pmaport - links to the postmarketOS package search page for a given package
  • Flathub - link to a package on Flathub

Userboxes

Userboxes are small boxes that can be included on a user page.

Adding userboxes

  • Userbox container - makes userboxes within it float to the right, and automatically fill all available space on mobile:
{{Userbox container|
  {{User ports|9001}}
  {{User main device|PINE64 PinePhone (pine64-pinephone)}}
}}

Available userboxes

Template Purpose Usage Preview
User main device Shows the user's main device {{User main device|Wiki link}}
Linux This user's main device is a PINE64 PinePhone (pine64-pinephone).
User ports Shows the amount of devices you ported {{User ports|amount}}
♻ This user has ported postmarketOS to 2 devices.
User mainline Shows the amount of devices you mainlined {{User mainline|amount}}
♻ This user mainlined 2 devices.
User mainline attempts "This user is currently trying to mainline a device." {{User mainline attempts}}
Linux This user is currently trying to mainline a device.
User Mastodon Links to the user's Mastodon profile {{User Mastodon|@username|homeserver}}
Mastodon logo This user's Mastodon profile is @username
User Fediverse Links to the user's Fediverse profile {{User Fediverse|@username|homeserver}}
Fediverse logo This user's Fediverse profile is @username
User Matrix Links to the user's Matrix profile {{User Matrix|@username:homeserver.org}}
User GitLab Links to the user's GitLab profile {{User GitLab|username}}
GitLab logo This user's gitlab.com GitLab profile is @username.
{{User GitLab|username|gitlab.postmarketos.org}}
pmOS logo This user's pmOS GitLab profile is @username.
{{User GitLab|username|gitlab.alpinelinux.org}}
Alpine Linux logo This user's Alpine GitLab profile is @username.
{{User GitLab|username|gitlab.freedesktop.org}}
pmOS logo This user's freedesktop GitLab profile is @username.
User SourceHut Links to the user's SourceHut profile {{User SourceHut|username}}
SourceHut logo This user has a SourceHut profile.
User IRC Shows your IRC nick (optional) and server. {{Template:User IRC|IRC domain|Username (optional)}}

irc

This user is on irc.example.org as nickname.
User Website Shows a link to your personal website. Note: Do not place http:// or https:// {{User Website|postmarketos.org}}
Web globe This user has a personal website.
User Blog Shows a link to your blog. Note: Do not place http:// or https:// {{User Blog|postmarketos.org/blog}}
Web globe This user has a blog.

See also