Difference between revisions of "Template:Man/doc"

From blackwiki
Jump to navigation Jump to search
imported>EdC~enwiki
imported>EdC~enwiki
(→‎Parameters: Sources)
Line 22: Line 22:
 
# 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. For a list of subpages see [[Special:prefixindex/Template:man/]].)
+
# Source (the name of a [[Wikipedia:Subpages|subpage]] in the [[Template:Man]] [[namespace]] e.g. [[Template:Man/FreeBSD|FreeBSD]]. Leave blank for the current [[Template:Man/default|default]].)
 
# Page description
 
# Page description
 
# Style parameter; currently <code>inline</code> omits the attribution.
 
# Style parameter; currently <code>inline</code> omits the attribution.
 +
 +
===Available sources===
 +
Remove the "Man/" prefix when using as a parameter.  Note: the ''doc'' and ''format'' entries are internal templates, not sources.
 +
{{Special:prefixindex/Template:man/}}
  
 
==Hacking==
 
==Hacking==

Revision as of 23:30, 8 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|||inline}} printf
{{man|3|printf|FreeBSD}} printf(3) – FreeBSD 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 e.g. FreeBSD. Leave blank for the current default.)
  4. Page description
  5. Style parameter; currently inline omits the attribution.

Available sources

Remove the "Man/" prefix when using as a parameter. Note: the doc and format entries are internal templates, not sources.

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 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.