Category:Template

From Alpine Linux
Revision as of 22:49, 22 December 2023 by Zcrayfish (talk | contribs) (→‎Brief description of the templates: Added an extra line break to make it more clear what section the [expand] button affects.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Templates

Templates are a special kind of article that are supposed to only be used as part of other articles.

Please do not experiment with the template as you could ruin all pages using it. If you want to edit a template, copy the text to Template:Sandbox, edit and test it there, and copy it back when it works.

Brief description of the templates

!
Magic word used to escape vertical bars "|" in wikitext; particuarly inside template arguments

=
Magic word used to escape the equal sign "=" in wikitext; particular inside template arguments

AlpineLatest
Prints the latest stable version (3.20.3, released 6 September 2024) of alpine. Surprisingly useful, can be with other wiki features to dynamically generate URLs and all kinds of fun shenanigans

Box
a generic box with adjustable colors

Box BLUE
a blue box

Box GREEN
a green box

Box RED
a red box

Box YELLOW
a yellow box

Cat

Contents of /etc/issue

Used to the potential text inside a hypothetical file

Citation needed
Used to the right of a statement that desperately needs a source/documentation. Also a popular [citation needed] meme from wikipedia.

Clear
Used to aid the flow of text near/around floating images

Cmd
Used to stylize command (in block form), such as:

killall firefox && \
apk del firefox

Codeline
Used to stylize code, can be used inline: <!DOCTYPE html><title>This is valid HTML5</title>

Define
Used to make definition lists (such as the one you are reading now) or to document programs' command line arguments.

Delete
This is used to start a proposal to have a page deleted. It is used on the 1st line of normal pages and the 2nd line of redirect pages. Typically this is not a fast process. Use the comment field of this template to make a very concise reason the page should be deleted; then, if possible, make a longer argument on the article's talk page. If a consensus (or no objections) are reached after a reasonable amount of time, be sure that the page is orphaned (i.e. other pages no longer link to it).

Deref
I am unsure what this template does, but it is important, help documenting it is appreciated

Done
Typically used in tasks lists or on talk pages to mark a task or action of some kind as completed. ✔️ Done

Draft
This template should be added at the beginning of articles or sections that are unfinished.

Expand
This template should be added at the beginning of incomplete or "placeholder" pages or sections. You can explain in the first argument what material is still missing.

Hint
Avoid using. Used to define abbreviations or acronyms (the template is misnamed). e.g.: HTML

Historical
First line on articles which we are keeping only for historical curiosity. In modern times, these pages are almost completely useless, but still interesting to see where we've been and how far we've come.

Ic
Inline code or inline command. cat /dev/urandom is not a recommended method of scrolling your terminal emulator.

If
Obsolete template for conditionals. DO NOT USE. The #if magic keyword should always be used instead.

Ifeq
Obsolete template for conditionals. DO NOT USE. The #ifeq magic keyword should always be used instead.

Ifn
Probably obsolete. Use with caution. Check and see if its function can be duplicated with a magic word instead.

Ifz
Probably obsolete. Use with caution. Check and see if its function can be duplicated with a magic word instead.

Insecure url
As part of an active effort to rewrite all URLs on the wiki to use a secure connection, we place this to the right of URLs that can't be upgraded. e.g. due to server misconfiguration🔓

Issue
Make a link to an issue on gitlab #275

Key
Used to indicate keys on the keyboard: AltSysRqREISUB

Lb
Used to escape left curly brackets in wiki markup: {{

Main
Used under a section heading to indicate that the topic of the section has an associated article

Merge
Used to nominate an article for merging with another article

Month
Used to convert a numerical month to the month's name. Not localized. Often should be combined with the #formatdate magic keyword in order to respect the user's date preference.

Move
Used to propose moving an article.

NNews
Cool looking template as-seen in the Older News article. No modern usages yet, but it still looks good.

Note
Note: This is a note box template

Obsolete
Used to mark an article or section as obsolete. Depending on the nature of the material in question, redirecting to a superseding article, marking the article as historic, or nominating the article for deletion may be appropriate.

Path
Used to stylize file/directory paths on the wiki, can be used inline: /dev/null

pkg
Used to link to APK information on pkg, can be used inline, and often combined with cmd or ic template: apk add nano

Rb
Used to escape right curly brackets in wiki markup: }}

Retired
Added to user pages when it is know that the user is never going to edit the wiki again for whatever reason:
Retired
This user is no longer active on the Alpine Linux Wiki.
User has gone fishing.

Sandbox
Template that anyone can edit for testing purposes.

Style
Used to mark an article or section which needs wikimarkup or style improvements. e.g. if a user has typed HTML or markdown instead of wikitext into an article

Template
This template is used at the top of the section of templates; it prints a message if a user loads the template page explaining that said page is not a regular article.

Text art
Apparently intended for ASCII art on the wiki, but never used.

Tip
Tip: Tip Box. "Don't believe everything you read on the internet." - Abraham Lincoln

TOC left
Used near the top of an article to cause the table of contents box to be on the left

TOC right
Used near the top of an article to cause the table of contents box to be on the right

Todo
Todo: Adds a note about tasks that need to be done in an article/section

Unsigned
Subst'd below unsigned talk page comments.

Warning
Warning: This is a warning template.