Difference between revisions of "Template:Man/doc"
Jump to navigation
Jump to search
imported>EdC~enwiki (→Parameters: Sources) |
imported>EdC~enwiki (→Available sources: Use table) |
||
| Line 27: | Line 27: | ||
===Available sources=== | ===Available sources=== | ||
| − | + | Please add to this table as you write new sources! | |
| − | {{ | + | :{|class="wikitable" |
| + | !Source!!Example!!Result | ||
| + | |- | ||
| + | |[[/die.net|die.net]]<ref>Current default</ref>||{{tlx|man|1|man|die.net}}||{{man|1|man|die.net}} | ||
| + | |- | ||
| + | |''[[/default|default]]''<ref>Redirects to the current default</ref>||{{tlx|man|1|man}}||{{man|1|man}} | ||
| + | |- | ||
| + | |[[/FreeBSD|FreeBSD]]||{{tlx|man|1|man|FreeBSD}}||{{man|1|man|FreeBSD}} | ||
| + | |- | ||
| + | |[[/Linux|Linux]]||{{tlx|man|1|man|Linux}}||{{man|1|man|Linux}} | ||
| + | |- | ||
| + | |[[/OpenBSD|OpenBSD]]||{{tlx|man|1|man|OpenBSD}}||{{man|1|man|OpenBSD}} | ||
| + | |} | ||
| + | |||
| + | <references/> | ||
==Hacking== | ==Hacking== | ||
Revision as of 23:49, 12 February 2007
Template:Template doc page viewed directly To be used for inserting manual page links into articles on Unix topics.
Contents
Usage
Examples
In Out {{man|3|printf}}– System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group {{man|3|printf|||inline}}{{man|3|printf|FreeBSD}}– FreeBSD Library Functions Manual {{man|3|printf||formatted output conversion}}: 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 e.g. FreeBSD. Leave blank for the current default.)
- Page description
- Style parameter; currently
inlineomits the attribution.
Available sources
Please add to this table as you write new sources!
Source Example Result die.net[1] {{man|1|man|die.net}}– Linux User Commands Manual default[2] {{man|1|man}}– Commands & Utilities Reference, The Single UNIX Specification, Issue 7 from The Open Group FreeBSD {{man|1|man|FreeBSD}}– FreeBSD General Commands Manual Linux {{man|1|man|Linux}}– Linux User's Manual – User Commands OpenBSD {{man|1|man|OpenBSD}}– OpenBSD General Commands Manual
Hacking
Writing sources
A source takes three parameters:
- Manual section
- Manual page name
- Output selector:
attribfor attribution,urlfor URL to page.
See Template:Man/die.net for an example.
Internals
Template:man handles choosing the default source and calling it for URL and attribution; the default source is Template:man/default, which is a template redirect currently to Template:man/die.net. Template:man/format actually formats the link and descriptions into a nice-looking link+auxilia in Unix style.