Template:ORP-top/doc



Typical page BG color set up by this header template is this background color


 * below is default appearance with typesetter's text


 * The Template base appearance

To the right are two standard default options:
 * The top box in the right margin is known as the beginner's links table &mdash; The Trainz community has been in existence since 1998 and Trainz has such a broad breadth of topics plus the cultural fact that the rail terminology, practices and experiences varies quite widely among nations and even between a nation's rail subcultures &mdash; to minimize confusion and promote maximal understanding there are two term defining glossaries:


 * The first one is called Glossary &mdash; which is used often to provide some detailed short topic coverage's a few paragraphs long.


 * And the reference which is a glossary aimed at terminology and brief explanations.


 * Both provide many page section anchors allowing text to reference a topic with a section link so as to keep article pages from getting bogged down when covering other related technical matters.


 * In between are four Hotkey (keyboard shortcut) links to reference pages and one for Mouse oriented operations. The bottom hotkey reference, 'HKeys-WIN' is actually covering standard Windows hotkeys, for many of those are useful in editing and modifying various digital data elements.


 * The other three specialize for commands/actions with Hotkey links inside a specific major Trainz software module: Content Manager ('HKeys-CM'), Driver ('HKeys-DVR'), and Surveyor ('HKeys-SUR'). This table and the accompanying TOC are common to all Trainz pages. Both can be suppressed individually as needed and shown below.


 * The next box down in the margin is a width-constrained Table of Contents aligning with the margins of the beginner's links table. Some of the titles listed here are contrived to show a TOC with an appreciable length.

Some text, will be set off like seen in the appearance of the following  (that is in code tags)

Purpose

 * This template is used with ORP-bot to set off Trainz reference oriented and organized Wiki pages about intermediate, or advanced topics, categorized in Trainz reference classed topics on the Wiki. It can be linked up, down, left and right as part of serialized tutorial, topic to topic. It controls the presence of the box templates discussed above. Various combinations of parameters can generate standardized alternative titles and secondary titles.  The latter indicate a special knowledge base area, or the topic is shared between two book divisions.


 * The Template like the other formatting templates has a multi-fold mission:
 * 1) open the  statement on Trainz Wikibook pages. (formatting the page style)  This help page now displays the page background color common to Wikibook reference pages, subpage grouped under Trainz\refs which acts as the references TOC and page index.
 * 2) The 'no' or  or   parameters can be used to suppress the assertion of the beginner links table and the encapsulated 'auto-TOCright'.
 * 3) The 'noTOC' parameter can be used to suppress the assertion of the encapsulated 'auto-TOCright' but still allow the beginner links table to manifest.
 * 4) The both or refs2 parameter gates (enables) the second template heading message enabled by passing the auxiliary message boilerplate control parameters:


 * Title lines:Are provided with stock book section titles, but each may be overwritten:
 * 1) alttitle1 and alttitle2 pass override messages if desired; Define them with the new message line, or other conditions being met, they both provide stock messages.
 * 2) placeholder parameters 1-4 or equivalently 'p', 'n', 'h', 'rh' are for page to page threading, meaning previous, next, home, and reference head (down) obviating the need to return to a TOC page, and then navigate to a follow on topic in a series. Further, the prev, 'n'ext, and local h'eader page parameters allow threading of pages with an alternative to branch down. The final 'rh' and '4' parameters are defaulted to Trainz, the books Table of Contents, unless defined.

Setting AM&C control

 * with 'no' parameter defined as well to suppress help navtable

title Section 2.1

 * Setting FUN=1 & both=1 switches:(without both, get only the top header line)

title Section 3

 * setting IT=1 & both=1 switch:(without both, get only the top header line)

title Section 4 CC message

 * setting CC=1 & both=1 switch:(without both, get only the top header line)

Also
The goal is to set and use the same control on a page by standard switches, which as seen above by duplicate headers, results in identical messages (currently) &mdash;BUT DOES NOT result in the same auto-categorization (groups of pages) in the paired footer templates which close the formatting in these header templates.