Template:Refs

From Hollow Knight Wiki
Jump to navigation Jump to search
[view] [edit] [history] [refresh]Documentation

A template that generates a "References" section.

Usage

This template is used to display the list of references at the end of an article. To use, simply type {{Refs}} at the end of an article.

You can customize the divider on top of the section by using Template:Hr and Template:Reflist's parameters:

  • {{Refs}}: generates a "references" section.
  • {{Refs|hr=<hr>}}: where <hr> is any of the following values:
    • small: changes the divider to a smaller, gradient-only variant.
    • ss: changes the divider to a Silksong version.
    • false: removes the divider.
  • type changes the type of reference:
    • type=code makes a reference list for all the source code (marked as <ref group=Source>).
    • type=note makes a reference list for all the notes on the page (marked as <ref group=Note>).

You can also use the margin parameter to set a custom margin for the divider, the showonmobile parameter to hide it on mobile, the columns parameter to set a specific amount of columns in which the references list will be divided to, and the colwidth parameter to set the width of said columns.

To put all references inside a scrollbox, set the scrollbox parameter to either 1, yes, or true.

Examples

Using this testing[1] sentence, view examples[2] of how the refs page works[3].

{{Refs}}

Gives:


References

  1. As in, example
  2. or showcases
  3. or functions, in other words


With a regular reference,[1] a reference with a note,[Note 1], and a reference with source code,[Source 1], use hr=small, like so:

{{Refs}}
{{Refs|hr=small|type=code}}
{{Refs|hr=small|type=note}}

To get


References

  1. Regular ref test

Code References

  1. Test code

Notes

  1. Test note
{{Refs|hr=small}}

Gives:


References


{{Refs|hr=ss}}

Gives:


References


{{Refs|margin=96px 0}}

Gives:


References


{{Refs|showonmobile=false}}

Gives:

References


{{Refs|scrollbox=true}}

Gives:


References


{{Refs|columns=2}}

Gives:


References


{{Refs|columns=2|colwidth=200px}}

Gives:


References

[view] [edit] [history] [refresh]The above documentation is transcluded from Template:Refs/doc.