Template:Cite api

[edit] Template documentation

[edit] Usage

You can copy the following template and fill in the arguments, as explained below. Note that the arguments the same as for {{cite web}} except for path and version. See the "Examples" section for more concise templates for specific API documentations.

{{cite api
|url=
|path=
|title=
|version=
|accessdate={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}
|accessdaymonth=
|accessmonthday=
|accessyear=
|author=
|last=
|first=
|authorlink=
|coauthors=
|date=
|year=
|month=
|format=
|work=
|publisher=
|pages=
|language=
|doi=
|archiveurl=
|archivedate=
|quote=
}}

[edit] Required parameters

url

If the documentation is available on the web, the full url to the documentation. Please do not wikilink it.

http://www.perl.com/doc/manual/html/pod/perlre.html

path

Path to the documentation. If the documentation can be installed in different folders, provide a relative path.

Unix manual page:

man grep

Windows SDK:

ms-help://MS.PSDKXPSP2.1033/script56/html/js56jsgrpRegExpSyntax.htm

Relative path in composite file with own protocol (used as an example only, normally you should cite the original file):

mk:@MSITStore:msidiff.chm::/diff_90.html#SEC90

Old style Windows help file:

vb.hlp

Note that you can't specify a path to a specific page in this case, so make sure the title (e.g. "VarType function") is searchable in the index.

title

Title of the document.

Regular Expression Syntax

version

Version of the documentation cited.

Note: the Windows SDK doesn't seem to have one.

For producing a wikilinked date of retrieval:

accessdate

Full date when item was accessed, in ISO 8601 YYYY-MM-DD format, for example "accessdate = 2008-06-15". Must not be wikilinked.

For producing a non-wikilinked date of retrieval:

accessdaymonth

Month and day when item was accessed, for example "accessmonthday = May 10", and year when item was accessed, for example "accessyear = 2005". Produces: Retrieved on May 10, 2006.

accessmonthday

Month and day when item was accessed, for example "accessmonthday = 10 May", and year when item was accessed, for example "accessyear = 2005". Produces: Retrieved on 10 May 2006.

accessyear

[edit] Optional parameters

author

Author, if known.

last

Last name of the author of the documentation, if known.

Wall

first

First name of the author of the documentation, if known.

Larry

authorlink

Works either with author or with last & first to link to the appropriate wikipedia article. Does not work with URLs.

coauthors

Coauthors, if known.

date

Full date of publication, preferably in ISO 8601 YYYY-MM-DD format, e.g. 2006-02-17. May be wikilinked.

year

Year of publication, works with month:

month

Name of the month of publication. If you also have the day, use date instead. Must not be wikilinked.

format

Format, e.g. PDF. HTML implied if not specified.

work

The title of the documentation. Must include what software or hardware that the documentation is about.

Perl manpages

Platform SDK for Windows XP SP2

publisher

The publisher of the documentation - normally the same as the publisher of the software or hardware.

O’Reilly Media

Microsoft

pages

pp. 5–7: first page and optional last page. This is for listing the pages relevant to the citation, not the total number of pages in the book. This is especially useful for PDF format, where the page can be linked to with the #page=number anchor tagged on the end of the URL:

pages = [http://www.example.org/file.pdf#page=123 p. 123]

language

The language the documentation is written in, if not English.

doi

A digital object identifier for the document, such as 10.1038/news070508-7

Doilabel

If the doi contains some characters that must be escaped, use "doilabel" for the unescaped version. See {{doi}}: "id" is equivalent to "doi" and "label" is "doilabel"

archiveurl

URL of the archive location of the item (requires archivedate)

archivedate

Date when the item was archived (requires archiveurl), in ISO 8601 YYYY-MM-DD format, e.g. 2006-02-17. Must not be wikilinked; it will be linked automatically.

quote

Relevant quote from online item.

[edit] Examples

Regular Expression Syntax ms-help://MS.PSDKXPSP2.1033/script56/html/js56jsgrpRegExpSyntax.htm Platform SDK for Windows XP SP2. Microsoft. Retrieved on 2007-05-21. “\nml Matches octal escape value nml when n is an octal digit (0-3) and m and l are octal digits (0-7).”

{{cite api
|url=
|path=
|title=
|accessdate={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}
|work=Platform SDK for Windows XP SP2
|publisher=Microsoft
|archiveurl=
|archivedate=
|quote=
}}

Note that it's impossible to find out when a page was written, or by whom. There appears to be no relation between the URL of a page and the path in the SDK itself.