User:SwifT/Wiki Tips

From Gentoo Wiki
Jump to: navigation, search

My personal collection of wiki tips for documentation development.

Formatting

Acknowledging developers from gentoo.org

CODE Use comma-separated when needed
{{Migrated|originalauthors=nightmorph}}

Tables

Table example:

My resources
Left Right
CODE Above table example
{| class="table table-striped table-condensed" style="text-align: left;" 
|- 
! colspan=2 | My resources
|-
| Left
| Right
|}

Boxes

Tip
This is a Tip.
Warning
This is a Warning.
Note
This is a Note.
Important
This is an Important.

Listings

user $Cmd
{{Cmd|command|output=...}}
root #RootCmd
{{RootCmd|rootcommand|output=...}}
user $Invocation
{{Invocation|command|output=...}}>
root #RootInvocation
{{RootInvocation|rootcommand|output=...}}

Transclusion and semantics

Defining a parameter

To define a parameter, the following can be used:

CODE Adding a parameter to a page
[[parametername::parametervalue]]

Next, go to the defined parameter page (Parameter:Parametername) and use the proper editing (through the form) to set the right type.

Referring to a parameter

Regular referral

To just include it in text:

CODE Including parameter value
{{#show: [[Pagename]] |? parametername}}

Referral from a parent page

If the parameter is from the parent page, then use BASEPAGENAME:

CODE Including parameter from a parent page
((#show: {{BASEPAGENAME}} |? parametername}}

Meta information

Discussing changes

In order to discuss a change, on the Talk page, create an open discussion like so:

CODE Discussion template
{{InfoBox stack
|{{InfoBox talk open}}
}}

Currently open discussions are categorized under.

To end, use InfoBox talk done.