Trainz/Templates

This page is in the Category:Trainz Admin where all tools and special guidelines for Trainz will now be found! Questions: Post to: FrankB
  • If you don't know how to do something... Ask! (Skype is frank.a.bartus for ease of speed and clear communications.) I've got 60-70,000 edits on nine WikiMedia projects like this and am a fair template coder.
  • External and internal link templates more suited to our Trainz needs and a comprehensive category system is mostly now in place! FrankB 20:56, 12 March 2014 (UTC)

The first section of this page contains in-line templates, the second special display templates, most of which make a box with data within.

Aside
  • The most useful templates for general editing are in the next section following Administration templates. This first group only occasionally come into play.

Administration templatesEdit

  • Placing {{Trainz-page|Previous|Next}} will link Trainz pages page to page with a optional cross-link to the N3v wiki. (pending fixups 2014-0310)
  • Placing {{Trainz-ref}} will auto-categorize a page to sub-category Category:Trainz references and such pages should also be incorporated into [[Trainz refernces|Trainz reference pages}} lists.
  • Placing {{Trainz-stub|date}} or {{TRS-sectstub|date}} on a page auto-categorizes it to Category:Trainz pages needing attention (stubs) and displays a message box warning readers the page is unfinished. ALL STUB auto-categorizing (maintenance) templates should have a date defined in yyyy-mmdd form, AND can take another parameter suggesting what needs done. (this need not display, some do, some don't, some do either. If they don't, the text you outline as the TO-DO List disappears into the bit bucket — until someone edits the section, then the list is there to read.
  • Place {{TRS-SubSubPg}} at page bottom when breaking a topic into multiple pages, the parent (sub-)page then should reference the sub-sub-page. In Wikibooks terms, the set parents and children are a Module. This auto-categorizes the page into a comprehensive list category:Trainz Sub-Sub-pages.
  • Place {{R from Trainz}} on redirect pages to other Trainz pages, including when moving a page (edit in after the move) to auto-categorize and list Trainz redirected pages or aliases (e.g. CM and CMP both redirect to the Content Manager page, Layout to Route, so useful to use redirects at times.) The template must be placed immediately after the page redirect instruction link and on the same line as in:
#redirect [[Trainz/Content Manager]] {{R from Trainz}}
as for CM and CMP are formulated
  • Place {{Trainz-cat|Purpose of the category page in some detail}} — use only on categories to demarcate and auto-categorize them as Trainz pages.
temp
whilst working out something started now missing.

temp section-1Edit

outline of category tree (temp here)

See also these Categories:

Volume parents

category:Trainz

Admin pages

temp section-2Edit

2014-0212 Wikibooks...
List of templates recently worked on (Latest Revision)
space tagging templates
  1. Template:Trainz-cat
  2. Template:FUN-top
  3. Template:Beginner links
  4. Template:FUN-beg
  5. Template:FUN-bot
  6. Template:FUN-end
  7. Template:TRS-page ??? moved n'est pas?
  8. Template:Tref-pg  ???
utility and auto-categorizing mix
  1. Template:Trainz-stub
  2. Template:TRS-style
  3. Template:TRS-SubSubPg
  4. Template:TRS-sectstub
  5. Template:Trainz-stub
  6. Template:FAB-todo
  7. Template:TL
  8. Template:TA
  9. Template:R from Trainz
  10. Template:Trainz-sect-stub
  11. Template:Trainz-admin
  12. Template:Trainz-ref-page
  13. Template:Trainz-ref
  14. Template:Trainz-Admin
  15. Template:Trainz-page - (Fabartus moved page Template:Trainz-ref-page to Template:Trainz-page: reusing title for another admin template, this makes both more 'useable' and intuitive') (current) [rollback more than 10 edits]
  16. Template:Tre
  17. Template:Col
  18. Template:TRSCat
  19. Template:TR
  20. Template:Kp
  21. Template:TG
  22. Template:TOL
  23. Template:Cen
  24. Template:N3V
  25. Template:Larger
  26. Template:Wp

Editorial Aid TemplatesEdit

These templates are used in-line to create links and display effects.

Simple linksEdit

Linking templates that include whitespace in the link forming parameter (the first part separated by '|' characters after the template name itself need to have UNDERSCORE characters instead of spaces.

  • Make sure to test such links, especially external links before thinking your job is done.
    • If you external link to another wiki such as Wikipedia or Trainzonline, and the link uses a redirected page name, formulate it to the proper full article name so it doesn't get disconnected if the page title gets changed.}}
  • and symbolically link externally as longform: {{plainlinks | {{{1}}} | {{{2}}} }} so is the same as the longer wikimarkup external link:
<span class="plainlinks"
>[http://online.ts2009.com/mediaWiki/index.php/Trainz-build {{{2}}}]
</span>
  • and literally form the link {{plain link|Trainz-build|Trainz-build tag version}}.
Internal simple links
  • {{TL|Content Manager|Content Manager}} will appear as Content Manager
    • and symbolically link to a subpage as longform: [[Trainz/{{{1}}} | {{{2}}} ]]
    • and literally form the link [[Trainz/ContentManager|Content Manager]] forming a link to a direct sub-page of the Trainz Main Page.

Similarly, {{TA}} forms a link to a sub-page off Trainz/AM&C AND {{TC}} forms a link to a sub-page off Trainz/Content Creation. But {{TR}} (references) and {{TG}} (glossary link) use an intermediate argument/pass parameter to modify the parsing.

Not-so simple linksEdit

In organizing to group pages, simple linking templates were contraindicated once pages needed several sub-page levels and breaking the project into volumes only eliminated at most one such level. This spawned a new breed of template, which has some 'filtering smarts' or complimnetary coding to generate the desired links.

  • {{TG|Ca_to_Ez|Content Manager Plus}} (links to major section title in the Trainz Glossary) will appear as Content Manager Plus
    • and symbolically link as longform: [[Trainz#{{{1}}} | {{{2}}} ]]
    • so is the same as the longer: [[Trainz/Glossary#Ca_to_Ez|Content Manager Plus]]
  • {{TR|R|Content Manager|p=Content Manager Plus}} will appear and link as Content Manager Plus
    • and symbolically link to a subpage as longform: [[Trainz_references/{{{1}}} | {{{2}}} ]]
    • so is the same as the longer: [[Trainz_references/{{{1}}} | {{{2}}} ]]
void hidden text follows
The next lines Are obsolescent...
so not current planning, error fixing will be in Trainz AM&C volume. Error fixing will likely be Trainz AM&C/Trainz_Error_Fixing.
void ends
  • {{Tws|Notepad++ in Trainz}} (Trainz Windows Application skills section title) will appear as Template:Tws
    • and symbolically link to a 'Notepad++ in Trainz' section of the reference page Trainz references/Windows_skills as longform: [[Trainz references/Windows_skills#{{{1}}} | {{{2}}} ]]
  • {{wp|Trainz|Trainz Article}} will appear as Trainz Article and symbolically link as longform:
[[w:Trainz|Trainz Article]] to a Wikipedia article.

plain linkEdit

{{plain link|full url of link|Pretty text}}

'Plain link' forms a full external link for use in-line with a 'pretty print' text replacement.

An example: The Trainz asset technology level is found in each assets' config.txt file and is called a "Trainz-build" tag number or sometimes the 'version number' which is strongly related to but different (it's directly dependent—since trainz-build tag value is defined by the code build of CCP when the asset is created. Both your actual software installed version (see titlebar of Post TS09-SP0 for this version number) and the asset's trainz-build are usually different) from the 'code build number or code version', which identifies the specific mix of software modules uniquely, also called the 'software build number' that is listed on each launcher screen.

P train grey.png

WARNING-1:

When making a offsite 'External' link, click on the address bar and CTRL+A then CTRL+C to capture the proper full UNICODED address string.
P train grey.png

Best Practices::

  • Further, ALWAYS: Nav-test an external link when finishing a section. Perhaps especially when using an template to link.
  • While link formation is different and somethings might work, even Wikimedia (Wikipedia) link formation should be tested. If for no other reason to test the spelling and see if the name used is a redirect page name, in which case the correct name should be used and if necessary pipe tricked to display your chosen phrase.
Further information: See the next warning messagebox below:

Notes about external linksEdit

P train grey.png

WARNING-2:

  • This link testing guideline is particularly important for links including punctuation characters or some non-English (still Western alphabets) titles, particularly known breakages occur in such as many N3V Wiki pages starting with and containing paired quotes. If there is no 'quote-less' redirect page to link on N3V's TrainzOnline, you are urged to create one.
Further information: See the messagebox below:

Editting, temp sectionEdit

LINKS CONTAINING THESE WILL NOT FORM A PROPER LINK as ASCII ' " ' characters in Wikimedia software parsing. The field breaks when one is encountered. Hoover your mouse tooltip over and compare:

able%22_container script-include-table_container]

and is the literal:

<span class="plain links">[http://online.ts2009.com/mediaWiki/index.php/%22script-include- able%22_container script-include-table_container]</span> (Full manual essence plain link would form)

{{Plain link|http://online.ts2009.com/mediaWiki/index.php/"script-include-table"_container|script-include-table_container}}


huh
  • but is the literal:

{{Plain link|http://online.ts2009.com/mediaWiki/index.php/"script-include-table"_container|script-include-table_container}}

  • Literally: {{Plain link|http://online.ts2009.com/mediaWiki/index.php/"script-include-table"_container|script-include-table_container}}
  • Literally: {{Plain link|http://online.ts2009.com/mediaWiki/index.php/%22script-include-table%22_container|script-include-table_container}}

...

  • Q.E.D., as described, those four extra characters in the link make a difference. Further, this advisory does not just apply to web links containing '"', but to other characters as well used in the international conventions (likely Unicode) of the World Wide Web. It has not been evaluated whether quote leading pagenames herein will even link properly, since this site uses Common.css and Common.js files and processes, whereas the N3V TrainzOnline Wiki does not.

TrainzLinkNeededEdit

{{TrainzLinkNeeded|Dead or missing url needing researched | Pretty text}}
'TrainzLinkNeeded' is meant to be replaced by 'Plain link' when a valid url is found. It can also be inserted as {{TrainzLinkNeededZ||Pretty Text}} where the double pipe fills in the url of the message page {{Trainz Link Needed}}, as an aid to both writers and readers. The template automatically categorizes pages to the maintenance tracking category Category:Trainz Links Fixups needed.

TrainzTipEdit

This template makes a tip box like this:
Example code: {{TrainzTip|...Some description of the lack or needs or just to flag where work}}
P train grey.png
...Some description of the lack or needs or just to flag where work
need I say more? // FrankB
The below templates are standard MetaWiki general purpose templates ported into Wikibooks. FrankB 17
55, 21 June 2013 (UTC) says I'll likely workup a customized version of some for Trainz so if you want something soon, drop me a note. For now, use the in-page template {{FAB-todo|Some description of the lack or needs or just to flag where work is needed— so perhaps someone else can pick it up before you can return!}}

Wikibooks Standard TemplatesEdit

While use of these templates is not discouraged, they assume you will be back later to edit again and continue the work since they do not place pages into a Trainz Maintenance sub-cat.

TODOEdit

{{TODO|Text of task}}
Flag pages or sections that need some work with: {{TODO|Some text describing the task.}}
Clipboard

To do:
Some text describing the task.

Use with some caution as it adds a link to the page in the Wikibooks-wide TODO category.

InfoEdit

{{Info|Some interesting information}}

Provide some supplemental information set off with: {{info|Some interesting information}}

WarningEdit

{{Warning|Something to worry about or be careful of}}

Warn the reader of something they might do wrong with dire consequences with: {{warning|Text of the warning.}}

DangerEdit

{{Danger}}

Warn the reader of something they might do that could have catastrophic results with: {{mbox|type=warning|msg=This action may cause irreparable harm to your installation!}}

This message box is using an invalid "type=warning" parameter and needs fixing.

ExampleEdit

{{example}}

Visually set off an example with {{example|Text with markup for the example}}

Example
Example:

This is a sample example

CodeEdit

Set off sections of code, particularly for scripts. Wikibooks has an extensive set of enhanced templates for code markup with documentation. If the example is short, preface each line with a space to achieve a fast page wide emphasizing presentation

XML Example

.

IncompleteEdit

{{Incomplete module}} Flag a page as a work in progress with: {{Incomplete module}}

Page to page linkingEdit

For now...
Use the standard Wikibooks template {{chapter navigation}} template so with Previous page= 'Installation Under Microsoft Windows' and next page= 'Installing Service Packs' the template, which goes on the page bottom above the page category and will look like:

{{chapter navigation|Installation Under Microsoft Windows|Installing Service Packs}} and {{navigation|Installation Under Microsoft Windows|Installing Service Packs}} and display both top and bottom (Look here in those two places)

Installation Under Microsoft Windows · Installing Service Packs



Last modified on 31 March 2014, at 17:58