Difference between revisions of "Template:Man/doc"
Jump to navigation
Jump to search
imported>EdC~enwiki |
imported>EdC~enwiki |
||
| Line 3: | Line 3: | ||
To be used for inserting [[manual page]] links into articles on [[Unix]] topics. | To be used for inserting [[manual page]] links into articles on [[Unix]] topics. | ||
| − | Usage | + | ==Usage== |
:{|class="wikitable" | :{|class="wikitable" | ||
|- | |- | ||
| Line 16: | Line 16: | ||
|} | |} | ||
| − | Parameters | + | ===Parameters=== |
# Manual section | # Manual section | ||
# Manual page name | # Manual page name | ||
| Line 22: | Line 22: | ||
# Page description | # Page description | ||
# Source description | # Source description | ||
| + | |||
| + | ==Hacking== | ||
| + | ===Writing sources=== | ||
| + | See [[Template:Man/die.net]] for an example. A source takes two parameters, the manual section and manual page name, and returns an URL to the manual page. | ||
| + | |||
| + | ===Internals=== | ||
| + | [[Template:man]] handles choosing the default source. [[Template:man/format]] actually formats the link and descriptions into a nice-looking link+auxilia in Unix style. | ||
<includeonly> | <includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | <!-- ADD CATEGORIES BELOW THIS LINE --> | ||
| − | + | [[Category:External link templates|{{PAGENAME}}]] | |
| + | [[Category:Computing templates|{{PAGENAME}}]] | ||
<!-- ADD INTERWIKIS BELOW THIS LINE --> | <!-- ADD INTERWIKIS BELOW THIS LINE --> | ||
</includeonly> | </includeonly> | ||
Revision as of 17:41, 1 January 2007
Template:Template doc page viewed directly To be used for inserting manual page links into articles on Unix topics.
Usage
In Out {{man|3|printf}} – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group {{man|3|printf|die.net}} – Linux Library Functions Manual {{man|3|printf||formatted output conversion|Linux Programmer's Manual}} : formatted output conversion – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group
Parameters
- Manual section
- Manual page name
- Source (the name of a subpage in the Template:Man namespace; defaults to die.net i.e. Template:Man/die.net)
- Page description
- Source description
Hacking
Writing sources
See Template:Man/die.net for an example. A source takes two parameters, the manual section and manual page name, and returns an URL to the manual page.
Internals
Template:man handles choosing the default source. Template:man/format actually formats the link and descriptions into a nice-looking link+auxilia in Unix style.