Template:ORP-bot/doc


 * The above is the corresponding top of page template with default output shown.
 * This is the bottom template with the same navigation links


 * Purpose
 * 1) This template is used with ORP-top to set off Wiki reference pages, and especially those that are based on or adapted from the portions of freeware (Public Domain) assets used as examples or from the N3V TrainzOnline Wiki which need an attribution to the . Use of this template will assert those message properly on the page bottoms of reference pages.


 * 2) Auto-categorize the page, with consistent easy 'switch' parameters to change modes and mixes of categories, which switching is consistent among the various bottom templates in the divisions of the Wikibook.

Usage

 * Use after ORP-top for any page copied or largely derived from the TrainzOnline Wiki you must use ORP-bot to do the same auto-category &mdash; and more importantly acknowledge CC-by-SA-2.5 licensing for materials quoting the N3V wiki AND link the url of the source page using url=FULLPATH captured using on your address bar.
 * Be sure to test any and every off-site url, including Wikipedia links.


 * Use on pages that are
 * 1) augmented Trainz Online Wiki sourced pages, and for
 * 2) general reference pages to be listed in  page.
 * 3) This includes especially the 'dated' pages classed as appendixes by subpages, and things that are not directly parts of Trainz modeling, such as articles on file types (e.g. s).

Parameters and their effects
When these parameters are defined, they have the described effect:
 * 1)   (evaluate as  ) acts as a pipetrick for categories linked in by the template.
 * 2) both - adds auto-category 'trainz references' and 'trainz reference pages', the one also getting appendix pages.
 * 3) both - also adds Hidden auto-category 'both trainz fundamentals & refs' iff FUN is defined.
 * 4) cat1, cat2, cat3 - add optional categories, not normally in the auto-categories.
 * 5) AM&C - adds auto-category 'trainz am&c'
 * 6) CC - adds auto-category 'trainz content configuration'
 * 7) FUN  - adds auto-category 'trainz fundamentals pages'
 * 8) inhibit suppresses the reference auto-categories
 * 9) IT   - adds auto-category 'introductory trainz'
 * 10) nomsg -  suppresses the auto-footer CC-by-SA message box AND negates any input via  parameter |url=.
 * 11) nourl -  suppresses auto-categorization to a trapping list category, listing pages without the link to source parameter |url=.
 * 12) refs2- same as both for ONLY this template, it's native function in the other Footer templates&mdash;which are AM&C-bot, TRScc-bot, FUN-bot, PI-bot, IT-bot, TUT-bot&mdash;is to express the two references auto-categories also be asserted on such classed page topics.
 * 13) TBKR - adds and identifies pages Fundamental to all intermediate and basic Trainz Knowledge.
 * 14) url - must be defined for pages sourced in whole or in part from the TrainzOnline wiki. It should also be used for source materials used from Third Party fansites used with permission and adapted to the wiki.

All the footer templates will also always auto-categorize the hidden categories:
 * 1) *   All Trainz sub-pages
 * 2) *   All Trainz pages


 * this page auto-includes the below template box message as the page footer.


 * it will pass the link parameter URL=weblink or url=weblink to the footer template which then looks like this:


 * The above mode (with url linked to the source page on the TrainzOnline Wiki) must be used if the page is adapted from the 'N3V Wiki.


 * The parameter AM&C if defined will auto-categorize the page to category:Trainz AM&C as well as the default auto-category: category:Trainz reference pages


 * The parameter IT if defined will auto-categorize the page to category:Introductory Trainz as well.


 * It will also auto-categorize the page to the category:Trainz references a category name shared with the Trainz Wiki (for ease of page portability and consistency).


 * It can be given the  default parameter to alter the sort order of the reference page as listed in that category. (see example below)

Options

 * 1) Defining   Adds an link to the TrainzOnline  page and auto-adds the page to Wikibook Trainz' category: Category:Trainz Asset KIND.
 * 2) Defining   - Will do no message box footer when it's not needed.
 * 3) Defining   - Will suppress all auto-categories, including the All pages and All Trainz subpages lists. This is meant strictly for tags on Category pages.
 * 4) Defining   - Will do no category:Trainz reference pages and  category:Trainz references auto-categories but does list the pages in all trainz pages and all trainz sub-pages
 * 5) define  '| cat1=', '| cat2=', or '|cat3=' some plain-bare-cat-names to add those categories to the page; 'bare & plain' means... without either "Category:" namespace, nor square-brackets ( or ) both of which are automatically formatted with a page pipetrick. . The auto pipe tricking is to the  sort order. (See: Magic word). Other sort orders require blocking categorization and then explicit adds of such category and sort-pipetrick as are needed.
 * Lastly, this template closes a HTML block initiated by ORP-top. They should be used together as a pair top and bottom of each page.

Examples & differences of pipe tricking with : category, just like FUN-bot.
 * 1)  will list the page under the A pages, after both any page 'Aeroplane' and after 'Aardvark'.


 * Sorting Difference:  will list the page under the A pages, before any page 'Aeroplane' but after 'Aardvark'.
 * Otherwise if no pipe trick is specified, the page will default sort to the value calculated by CHAPTERNAME, which evaluates as the sub-page 'Page title' after the slash in.
 * This is except in rare case exactly what is desired, so only need be given.

Examples
 Contrasting category logic Examples : 1. on  will alphabetize the article under 'K', just as a normal  line would do. (i.e. explicit declaration, not using the template auto-category) 2. on a page  will not auto-categorize the page at all, allowing parameters cat1, cat2, cat3 to override normal categorization. In normal operation, these parameters will define additional categories, not replacements of suppressed auto-categories. 3. on KIND Engine will alphabetize the article under Engine to the secondary category, just as a normal 2nd  long form would do, as well as the normal default category:Trainz references. Inhibit affects only the default if defined, so up to three alternative categories (cat1=, cat2= & cat3=) can be specified for odd categorizations.
 * 1) The simple single term place-defined parameter,  on  will alphabetize the article under 'Engine', while
 * 2)  on  would wrongly alphabetize the article under 'KIND'&mdash; a form to be avoided with KINDs pages  (the same as  for general pages would sort)  such pages ought have alphabetization under their 'enumerated name' of 'KIND data type'  forms. A rationale alternative would be to sort by subject, in this example Sound is the key thought, so  is quite justifiable.
 * 3)  on  will alphabetize the article under 'Engine'. In the given example, Engine has no 'different' effect, so the same result as case 1.