Template:Module page box/doc

From Angelina Jordan Wiki
Revision as of 01:21, 7 September 2025 by Dcljr (talk | contribs) (mention other template, which must be used with this one)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a subpage documenting Template:Module page box. To change the template, edit that page; to change the template's documentation (seen below), edit this one.

Documentation

A call to this template (inside an <includeonly>…</includeonly> element, as shown below) should be included in the first line of every module documentation subpage. It should follow the call to {{doc subpage}} and category link that should also be there. (This template's functionality wasn't added to that template so it could be edited freely without causing a ton of jobs to be added to the job queue. There are great many pages that call {{doc subpage}}, but far fewer need to call this one.)

To see what its output looks like (a box with a message beginning "The code for this module"), go to Module:Example.

See Template:Doc for more information about creating documentation subpages.

Usage

  • <noinclude>{{doc subpage}}[[Category:Module documentation]]</noinclude><includeonly>{{module page box}}</includeonly>

This is the entire line that should appear at the top of every module documentation subpage, including the call to this template at the end.

The following template call must be included on the same page so the link provided by this template to jump down to the module code will work:

  • <includeonly>{{end of module documentation}}[[Category:Modules]]</includeonly>

See also