Template:Linux Command/doc: Difference between revisions
From HPC Wiki
Jump to:navigation
Jump to:search
(→Usage) |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template}} | {{Template}} | ||
<!-- Categories go at the bottom of this page. --> | <!-- Categories go at the bottom of this page. --> | ||
Template to render a single row in {{Tl|Linux Command Table}}. | |||
== Parameters == | == Parameters == | ||
{{Template Parameter Table|1= | {{Template Parameter Table|1= | ||
{{Template Parameter|1|Parameter name|required=yes}} | |||
{{Template Parameter|2|Parameter description|required=yes}} | |||
{{Template Parameter|wiki|Wikipage Link, appended to: <nowiki>https://www.wikipedia.org/wiki/</nowiki>|required=no}} | {{Template Parameter|wiki|Wikipage Link, appended to: <nowiki>https://www.wikipedia.org/wiki/</nowiki>|required=no}} | ||
{{Template Parameter|man|Man Page Link, appended to: <nowiki>http://man7.org/linux/man-pages/</nowiki>|required=no}} | {{Template Parameter|man|Man Page Link, appended to: <nowiki>http://man7.org/linux/man-pages/</nowiki>|required=no}} | ||
}} | }} | ||
| Line 18: | Line 19: | ||
<includeonly> | <includeonly> | ||
[[Category:Formatting templates]] | [[Category:Formatting templates]] | ||
Latest revision as of 15:22, 1 April 2017
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.
As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Template to render a single row in {{Linux Command Table}}.
Parameters
| Parameter name | Required? | Default value | Description |
|---|---|---|---|
Anonymous parameter 1 |
Yes | (n/a) | Parameter name |
Anonymous parameter 2 |
Yes | (n/a) | Parameter description |
wiki |
No | (n/a) | Wikipage Link, appended to: https://www.wikipedia.org/wiki/ |
man |
No | (n/a) | Man Page Link, appended to: http://man7.org/linux/man-pages/ |
Usage
See the template's testcases:
| Single command in table | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Wiki code | {{Linux Command Table|1=
{{Linux Command|ls|wiki=Ls|man=man1/ls.1.html|list directory contents}}
}}
| ||||||||
| Main version |
| ||||||||
| Sandbox version | Template:Linux Command Table/sandbox | ||||||||
| Three commands in table, one with no man link, one with no wiki link, one with no description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Wiki code | {{Linux Command Table|1=
{{Linux Command|ls|wiki=Ls|man=man1/ls.1.html|list directory contents}}
{{Linux Command|id|wiki=Id_(Unix)}}
{{Linux Command|df|wiki=Df_(Unix)|man=man1/report file system disk space usage}}
}}
| ||||||||||||||||
| Main version |
| ||||||||||||||||
| Sandbox version | Template:Linux Command Table/sandbox | ||||||||||||||||