Module:Navlists/doc

This is the documentation page for Module:Navlists

Uses Lua:

Module:Documentation

This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage

Customizing display

Overrides exist to customize the output in special cases:

{{documentation|heading=}} - change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories. It also reduces server resources by circumventing a technical limitation of templates.

Module:Navlists

This module generates lists of page links from one or more categories, optionally including subcategories (recursively).

Functions

listFromCategory: Returns a dot-separated list of pages from a category.

1 – Category name (without the Category: prefix).
separator (optional) – String used to separate items. Default: • .

Basic usage

{{#invoke:Navlists|listFromCategory|Characters}}

Returns all pages in Category:Characters and its subcategories.

Custom separator

{{#invoke:Navlists|listFromCategory|Characters|separator=, }}

Notes

Redirects are excluded.
The function detects and avoids category loops.
Subcategories are detected recursively.
You can create wrapper templates (e.g., Template:NavlistMainCast) for use in navboxes.