Template:FUN-bot/doc
Appearance
This page is part of Wikibooks Trainz Wikibook Administration. • It lists a template which may be useful editing Trainz. Trainz specific (special purpose) templates will be found in or under Category:Trainz Templates, which also lists/links to this Help page. |
This is a documentation subpage for Template:FUN-bot It contains usage information, categories and other content that is not part of the original template page. |
|
|||
|
- Purpose —this page is used in pairs with the above type template to style link and, in the case of this template, properly group articles into autocategories if given the same switches as the header template.
Usage
[edit source]- Purpose
- This template is used with {{FUN-top}} to set off Trainz Beginner oriented and organized Wiki pages from intermediate topics, content creation, and Trainz reference classed topics on the Wiki.
- It will also auto-categorize the page to the category:Trainz fundamentals pages, or with divisions, Introductory pages depending upon page counts to be determined by article counts. The provisional controls ID, IR, IS, IT, and TBKR should be defined the same as any page header and if auto-categorization is needed, the presence of these switches will gate any new subcategories.
- Given any of the above, currently they act as if defining the parameter 'IT', so the pages are therefore auto-categorized into category:Introductory Trainz instead of Trainz fundamentals pages.
- Parameter 'ref2' or 'both' also asserts the auto-category: Trainz references for use on pages like how to set up Trainz topics, that have a valid life in appendices or references as well.
- It can be given the
{{{1}}}
default parameter to alter the sort order of the reference page as listed in that category.
pipetrick Examples on a theoretical page title: "Session editing in Surveyor":
{{FUN-bot||ABC}}
('|ABC' is called a pipe trick) will list the page under the A pages, before any page 'Aeroplane' but after 'Aardvark'.{{FUN-bot|editing}}
('|editing' is called a pipe trick) will list the page under the 'E' pages, before any page 'Errors' but after 'Ears'.
- Sorting Difference:
{{FUN-bot|ABC}}
will list the page under the A pages, before any page 'Aeroplane' but after 'Aardvark'.
Contrasting Examples:
{{FUN-bot}}
on H will alphabetize the article under 'H'... ([[Category:Trainz fundamentals pages|{{PAGENAME}}]]
){{FUN-bot|inhibit=yes}}
on Driver will not categorize the page at all.{{FUN-bot|Engine}}
on Surveyor will alphabetize the article under 'E'.{{FUN-bot|cat=category-name|Engine}}
on Session will alphabetize the article under E, but not on the default category 'Trainz fundamentals pages' just as a normal[[category:category-name|Engine]]
line would do.
See also
[edit source]The switches above give this Template sufficient scope for most forseen threaded topic groups of topics pages. When they are inappropriate, then these headers present a different mix of switches and messages:
- {{AM&C-top}} - Similar role, but for the intermediate topics—intro content and operations and skills building group of page topic types.
- {{FUN-top}} - Fundamentals and other basic instruction pages focused mainly on general knowledge or the beginning Trainzer's many learning curves.
- {{TRScc-top}} - Content Creation topics pages such as those on advanced techniques
- {{ORP-top}} - Used both for Trainz references (& TOC references) — augmented materials sourced from the N3V Wiki, Pages more suitable to the Appendixes (TOC Appendixes and for topics intersecting AM&C areas for which a category listing (in references) is also desired (so define the AM&C switch parameter).
- Trainz Footer templates
- {{AM&C-bot}} - Similar role, but for the intermediate topics—intro content and operations and skills building group of page topic types.
- {{FUN-bot}} - Fundamentals and other basic instruction pages focused mainly on general knowledge or the beginning Trainzer's many learning curves.
- {{ORP-bot}} - Used both for Trainz references (& TOC references) — augmented materials sourced from the N3V Wiki, Pages more suitable to the Appendixes (TOC Appendixes and for topics intersecting AM&C areas for which a category listing (in references) is also desired (so define the AM&C switch parameter).
- {{TRScc-bot}} - Content Creation topics pages such as those on advanced techniques.