Template:Jfr header/doc

This is a documentation subpage for Template:Jfr header.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Jfr header.

For pages that belong to the Framework namespace:

• {{jfr_header}} creates a page header
• {{jfr_footer}} creates a page footer

consisting of links to related articles and reference information.

Features

The default links in this header are

Should the following subpages exist on the page where the template is used, they will be added to the navigation:

Examples

Packages may list all the articles that provide example code for the member classes

Classes may simply put source snippets an usage examples

Tutorials

Packages may list all tutorials for the member classes

Classes may list Tutorials where this class is used, explicitely or as a supplemental

Changes

Packages should provide changes in their class members

Classes should provide information about changed behaviour of class members

See Project:Building a Reference for more information.

Parameters

Parameter Name	Parameter Description	req./opt.
{{{pack}}}	name of package th page in used on	Required.
{{{treeview}}}	set this to no to disable the inline category tree view of Category:Framework which is rendered as a right-floating box	Optional

Known issues

The template was supposed to display a CategoryTree of "Catgory:Framework" but it had to be taken out: the floating output and layout of <categorytree> interferes and overlaps with contents from "JWhatver" pages. {{#ifeq: n{{{treeview|}}}o|no|<nowiki/> |<div class="floatright toc"><div class="toctitle" style="padding:0.2ex 1em">'''Package categories'''</div> <categorytree mode=categories>Framework</categorytree></div> }}

Stylesheet

div#jfr-header
#jfr-header ol
#jfr-header ol li
#jfr-header ol li span
#jfr-header ol li span a
#jfr-header ol li strong
 
div#jfr-footer
#jfr-footer ol
#jfr-footer ol li
#jfr-footer ol li span
#jfr-footer ol li span a
#jfr-footer ol li strong