Difference between revisions of "Template:Man/doc"

From blackwiki
Jump to navigation Jump to search
imported>EdC~enwiki
imported>EdC~enwiki
Line 20: Line 20:
 
# Manual section
 
# Manual section
 
# Manual page name
 
# Manual page name
# Source (the name of a [[Wikipedia:Subpages|subpage]] in the [[Template:Man]] [[namespace]]; defaults to die.net i.e. [[Template:Man/die.net]])
+
# Source (the name of a [[Wikipedia:Subpages|subpage]] in the [[Template:Man]] [[namespace]]; defaults to die.net. For a list of subpages see [[Special:prefixindex/Template:man/]].)
 
# Page description
 
# Page description
 
# Source description
 
# Source description

Revision as of 21:17, 1 January 2007

Template:Template doc page viewed directly To be used for inserting manual page links into articles on Unix topics.

Usage

Examples

In Out
{{man|3|printf}} printf – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group
{{man|3|printf|die.net}} printf(3) – Linux Library Functions Manual
{{man|3|printf||formatted output conversion|Linux Programmer's Manual}} printf: formatted output conversion – System Interfaces Reference, The Single UNIX Specification, Issue 7 from The Open Group

Parameters

  1. Manual section
  2. Manual page name
  3. Source (the name of a subpage in the Template:Man namespace; defaults to die.net. For a list of subpages see Special:prefixindex/Template:man/.)
  4. Page description
  5. 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.