Template:Reffunc

From NetHackWiki
Jump to navigation Jump to search

This template basically combines <ref> tags with what Template:Function does in analogy to Template:Refsrc.

Similar to Template:Function, this template may be used for any element of the source code which has an anchor on the referenced page and not only functions.

It may be used as follows:

{{reffunc|objnam.c|fruitname}}

The above will produce this footnote:[1]

You may optionally specify a different version:

{{reffunc|objnam.c|fruitname|version=SLASH'EM 0.0.7E7F2}}

This will produce this reference:[2]

You may also specify a comment:

{{reffunc|objnam.c|fruitname|comment=This function is referenced for example purposes}}

The produced reference will look like this:[3]

To suppress display of the file name, specify a third positional parameter:

{{reffunc|objnam.c|fruitname|x}}

The reference will then look like this:[4]

A name parameter may be specified to be able to reference the same function from multiple locations in the text without duplicating reference texts, like this:

{{reffunc|objnam.c|fruitname|name=fruitname}} [some text in between...] <ref name='fruitname'/>

The result will look like this:[5] [some text in between...] [5]

(The name given doesn't have to be the same as the function name; using the same name might be a good idea to avoid confusion, however.)

References

  1. fruitname in objnam.c
  2. fruitname in objnam.c in SLASH'EM 0.0.7E7F2
  3. fruitname in objnam.c: This function is referenced for example purposes
  4. fruitname
  5. 5.0 5.1 fruitname in objnam.c