Template:ORP-bot/doc

From Wikibooks, open books for an open world
Jump to: navigation, search
logo
Trainz Annotated References
TOC | BeginningsFun | AM&C | Creation | InBook Refs ORP Refs:  • Index • Containers • Kinds • Tags | Appendixes  • Vers
Loupe light.svg
 Glossary
 HKeys-CM
 HKeys-DVR
 HKeys-SUR
 HKeys-WIN
 Mouse use
 Notations
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 CC-BY-SA 2.0 License. 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[edit]

  • 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 — 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 CTRL+A+CTRL-C 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 References TOC 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. texture.txt files).

Parameters and their effects[edit]

When these parameters are defined, they have the described effect:  

  1. |1= or |something (evaluate as {{{1}}}) 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.
    1. both - also adds Hidden auto-category 'Both Trainz fundamentals & refs' iff FUN is defined.
  3. cat1, cat2, cat3 - add optional categories, not normally in the auto-categories.
  4. AM&C - adds auto-category 'Trainz AM&C'
  5. CC - adds auto-category 'Trainz content configuration'
  6. FUN - adds auto-category 'Trainz fundamentals pages'
  7. inhibit suppresses the reference auto-categories
  8. IT - adds auto-category 'Introductory Trainz'
  9. nomsg - suppresses the auto-footer CC-by-SA message box AND negates any input via parameter |url=.
  10. nourl - suppresses auto-categorization to a trapping list category, listing pages without the link to source parameter |url=.
  11. refs2- same as both for ONLY this template, it's native function in the other Footer templates—which are {{AM&C-bot}}, {{TRScc-bot}}, {{FUN-bot}}, {{PI-bot}}, {{IT-bot}}, {{TUT-bot}}—is to express the two references auto-categories also be asserted on such classed page topics.
  12. TBKR - adds and identifies pages Fundamental to all intermediate and basic Trainz Knowledge.
  13. 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:

    • All Trainz sub-pages
    • 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.

  • 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 {{{1}}} default parameter to alter the sort order of the reference page as listed in that category. (see example below)

Options[edit]

  1. Defining {{{nomsg|}}} - Will do no message box footer when it's not needed.
  2. Defining {{{noautocat|}}} - Will suppress all auto-categories, including the All pages and All Trainz subpages lists. This is strictly for tags on Category pages
  3. Defining {{{inhibit|}}} - 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
  4. define '| cat1=', '| cat2=', or '|cat3=' some-cat-names to add those categories to the page without either "Category:" namespace, nor '[[' or ']]' allowed. (their provided free of charge along with the default pipe tricking to the {{SUBPAGENAME}} (See: Magic word).

  • Lastly, this template closes a <div style=" ..."> 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 {{{1}}}:

  1. {{ORP-bot|After}} will list the page under the A pages, after both any page 'Aeroplane' and after 'Aardvark'.

category, just like {{FUN-bot}}.

  • Sorting Difference: {{ORP-bot|ABC}} 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 [[Trainz references/Page title or description]].
  • This is except in rare case exactly what is desired, so only {{ORP-bot}} need be given.

Examples[edit]

Contrasting category logic Examples:

  1. {{ORP-bot}} on kind engine will alphabetize the article under 'K', just as a normal [[category:Trainz reference pages|{{CHAPTERNAME}}]] line would do. (i.e. explicit declaration, not using the template auto-category)
  2. {{ORP-bot|inhibit=1}} on kind engine will not auto-categorize the page at all, allowing parameters cat1, cat2, cat3 to override normal categorization.
    1. {{ORP-bot|Engine}} on kind steam-engine will alphabetize the article under 'Engine', while
    2. {{ORP-bot|KIND Engine}} on kind enginesound will alphabetize the article under 'KIND'a form to be avoided with KINDs pages
       • which ought have alphabetization under their 'kind-name' of 'KIND kind-name' NAMCON forms.
    3. {{ORP-bot|Engine}} on kind engine will alphabetize the article under 'Engine'. In the given example, Engine has no 'different' effect, so the same result as case 2.
  3. {{ORP-bot|cat1=category-name|Engine}} on KIND Engine will alphabetize the article under Engine to the secondary category, just as a normal 2nd [[category:category-name|Engine]] 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.

See also[edit]

  • Use {{AM&C-top}}-{{AM&C-bot}} for beginner to intermediate topics, particular those regarding Assets -- Managing or simple methods of creation.
  • Use instead {{TRScc-top}}-{{TRScc-bot}} for Content Creation topics requiring use of advanced skills, or for advanced techniques in general.
  • The schema suggests 'Third Level of knowledge' is in the pages of the Trainz/references, Such as Trainz/config.txt files, Trainz/AM&C/config.txt file, and Trainz/references/config.txt file, where each is of increasing technical knowledge exposition. Any 'Trainz/AM&C/config.txt file' page would indicate secret knowledge unknown to me--but is possible such a progression might be needed in concocting assets! Such topics would begin 'organizationally' in the /AM&C pages in any event, so would still only be three levels of topic exposition.