Difference between revisions of "Template:Man/doc"

From blackwiki
Jump to navigation Jump to search
imported>EdC~enwiki
imported>EdC~enwiki
Line 26: Line 26:
 
==Hacking==
 
==Hacking==
 
===Writing sources===
 
===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.
+
A source takes three parameters:
 +
#Manual section
 +
#Manual page name
 +
#Output selector: <code>attrib</code> for attribution, <code>url</code> for URL to page.
 +
See [[Template:Man/die.net]] for an example.
  
 
===Internals===
 
===Internals===

Revision as of 21:58, 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|||inline}} printf
{{man|3|printf|die.net}} printf(3) – Linux Library Functions Manual
{{man|3|printf||formatted output conversion}} 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. Style parameter; currently inline omits the attribution.

Hacking

Writing sources

A source takes three parameters:

  1. Manual section
  2. Manual page name
  3. Output selector: attrib for attribution, url for URL to page.

See Template:Man/die.net for an example.

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.