Template:List Template

From All About Ayrshire
Jump to: navigation, search

Documentation: List Template

The List Template template is used in the creation of the static templates that are part of the Navboxes at the bottom of pages, such as Template:A1-A99 and Template:Crossings of the River Wey. As it is a component of all of these static templates, it is one of the most highly-dependant templates, and editing it will have a massive effect on the job queue and may cause the Wiki and the entire website to run slowly. Please do not make test edits on this template, but on the sandbox version instead. It should be noted that any changes made to this template will NOT automatically work their way through to the Navboxes! This template has the settings for stand-alone use of templates based upon this one, whilst Template:List Template dpl2 (and its sandbox version) have the settings for use in the Navboxes.

The template should also not be used on its own.

The template supports two different appearances. The first type includes a title and a simple list function, whilst the second type includes the title, and then groups within the list with their headings. The two types should not be mixed, as the result will not be an attractive look! Currently, the template supports up to FIVE groups.

{{ List Template
| title = <title>
| content = <content>
| width = <width>
| group1 = <group1>
| list1 = <list1>
| group2 = <group2>
| list2 = <list2>
..<extra group and list items up to the maximum number>
}}

<title> - The text within the title bar
<content> - The text for use when there is a single group of items to appear in the template. Do not mix this item with group/list items.
<width> - Use to specify a wider group titles column. Default value is 100, and the template only accepts values between 100 and 250.
<group1> - For use when separating groups of content - the title of the first group. Requires a matching list item.
<list1> - For use when separating groups of content - the text for use within the first group of items, usually a list of links.
<group2> - For use when separating groups of content - the title of the second group. Requires a matching list item.
<list2> - For use when separating groups of content - the text for use within the second group of items, usually a list of links


NOTE: <groupx> and <listx> items MUST be used together. Use of one without the other will give unwanted results.