Template:Trainz Image-AR

This page is part of Wikibooks b:Trainz Wikibook Administration.
■It lists a template which is useful supporting The various Trainz Wikibooks' needs here on the Commons. Trainz specific (special purpose) templates will be found in or under Category:Trainz templates, which also lists/links to this Help page.

English: ;Purpose

This template provides proper 'quick cite' licenses for one of a variety of image types used in the various Trainz Wikibooks Projects and appropriate auto-categorization; controlled by pass parameters such as CM, SUR,... WIN and the optional license override {{{LIC|}}} are defined. Its main function is to license, and message in a uniform consistent easy to use manner, for Trainz Wikibook editors are hobbyists (who may not be assumed from academic backgrounds), but have diverse interest in Railroads, model railroads, and are volunteering to share their knowledge with diverse others.

General parameters

{{Trainz Image-AR
  |inhibit={{{inhibit|}}}
  |   CAT=alternative subcategory of [[Category:Trainz Asset Maintenance]] by replacement such that [[Category:{{{CAT|Trainz Asset Maintenance}}}]] is categorized by this template instead. 
  |    CC={{{CC|}}}
  |    CM={{{CM|}}}
  |   DVR={{{DVR|}}}
  |    ED={{{ED|}}}
  |   FIX={{{FIX|}}}
  |icons={{{icons|}}}
  |inhibit={{{inhibit|}}}
  |   LIC={{{LIC|}}}
  |  MENU={{{MENU|}}}
  |    no={{{no|}}}
  |noauto={{{noauto|}}}
  |nonote={{{nonote|}}}
  | OTHER={{{OTHER|}}}
  |     P={{{P|}}}
  |   SES={{{SES|}}}
  |   SUR={{{SUR|}}}
  |textmix={{{textmix|}}}
  |   TXT={{{TXT|}}}
  |   VID={{{VID|}}}
  |   WIN={{{WIN|}}}
  |  PREV={{{PREV|}}}
  |  NEXT={{{NEXT|}}}
  |     1={{{1|}}} <!-- author's tagging --->
<!-- For cases when boilerplate messages are inappropriate and need rewording --->
  | ALT-CM-MSG ={{{ALT-CM-MSG|}}}
  |ALT-GUI-MSG ={{{ALT-GUI-MSG|}}}
  |ALT-MENU-MSG={{{ALT-MENU-MSG|}}}
  |ALT-VID-MSG ={{{ALT-VID-MSG|}}}
  |ALT-WIN-MSG ={{{ALT-WIN-MSG|}}}
}}

Where only a few mode parameters should generally be defined.

It can and perhaps, should best be placed as the permissions parameter data when uploading or by post editing, in which case the P parameter should be set ('| P=1'):

example1: A Wikibook threaded tutorial sub-page has many images, and are defined with 'xxxtut-NN' string prefixes to page names, so using that prefix (xxx='CM') as a sort parameter, and assuming this one is an image of Trainz's Content Manager (CM), and the default {{CC-BY-SA-3.0}} is less desired than that shown, such a tagging would be formed:

| permissions= {{Trainz_Image-AR|CM=1|LIC={{CC-BY-SA-2.5}}|sort=CMtut-15|P=1}}
Just as easily, Surveyor (SUR), Driver (DVR), editor, or Windows App (WIN) could be defined instead of CM, or several in the case where the tutorial shows overlapping Windows on the screenshot. Each class of image generates specific auto-categories placing the image in the apropos Trainz Images sub-category. Note these are additive in most cases, not exclusionary.

example2: The short default form is most likely to be the common usage:

| permissions= {{Trainz_Image-AR|SUR=1|sort=SURTut-05|P=1}}

example3: Both the above would categorize to the 'theoretical' root Category:Trainz Asset Maintenance, but by expressing the optional Category parameter CAT, as in:

| CAT=Trainz tutorial-SURtut-05 , the categorization for the upload wizard can be better organized:
| permissions= {{Trainz Image-AR|DVR=1|sort=DVRTut-22|VID=1|CAT=Trainz tutorial-DVRtut-22}} under the Trainz tutorial-DVRtut-22 presumed sub-category, which must needs be independently set up.

Note: In the above, the | VID= true also cross-categorizes that tutorial to a multimedia tracking category—the image is written into a Wikibook tutorial about a specific technique or making a specific point (say 'key-steps detailing' or a final look of a completed process); as does a co-produced linked YouTube video title covering the same educational points, so the viewers can see text exposition and a still to study details.

Last but not least: The template family has provision to sequentially link File namespace pages in said tutorials, using the PREV and NEXT parameters. These inputs should receive only the filename as from the uploaders drop and drag, (or text note support of the upload, as suggested as process in the Wikibook Admin How-To pages) into the upload wizard, no brackets nor File prefix applied.

Most of the template content expresses only when and if installed in a File page. The template by default auto-categorizes the page to Category:Trainz Asset Maintenance, or preferentially, to a sub-category grouping some related images using the | CAT= Sub-category name to link there instead.
All tagged images can specify an alphabetical group with {{{sort|}}} as sort parameters, as illustrated above for tutorials.
The template {{Trainz Image}} is passed parameters for customization of the appropriate messages and licenses. The usage for that template call and it's parameters show in the colorized block below.

For additional usage and How-To on defining these parameters, see: Template:Trainz Image/doc.

related templates

{{Trainz Image}} — Used for general screenshots 'In-World' panoramic scenes or asset profiling views, Menus and other Simulator specific TRAINZ GUI screens, menus, or Windows based displayed pages. Auto-categories: Conditionally: Category:Trainz panoramas (Edit Discussion links Page history) or unconditionally Category:Trainz images (Edit Discussion links Page history), which is a catch-all category.
1. Most of the other templates will call this template with appropriate parameters defined for correct auto-categories, so if using one of the below, don't also place this template!.
2. Template can also be used to categorize images of support and maintenance software screenshots if another Windows application by cropping or when freeware. Define '|CMshot=yes' and see the template help for further parameter settings needed when the view is of some other 'Not-In-Virtual-World applications program or software package.
3. Template used, when not an in-world view should express the inhibit switch so Panorama copyright disclaimer is not presented. Rule of thumb: If the view 'isn't scenic' in Surveyor or b:Driver, then set |inhibit=yes!
{{Trainz Image-AG}} — Used for screenshots, usually in Windows, or windows applications involving ASSET GENERATION, (but NOT for Trainz Error Fixing). Auto-category: Category:Trainz Asset Generation (Edit Discussion links Page history)
{{Trainz Image-AM}} — Used for screenshots, usually in Windows, or Windows applications involving ASSET MAINTENANCE (Non-Fixing alterations using Trainz filetypes Editing techniques). Category:Trainz Asset Maintenance (Edit Discussion links Page history). Example, upgrading a local error-free asset to compliance from v1.x—v2.x to v2.5—v2.9 or beyond.
{{Trainz Image-AR}} — Used for screenshots, usually in Windows, or windows applications involving ASSET REPAIRS (i.e. so called Trainz Error Fixing). Category:Trainz Asset Repairing (Edit Discussion links Page history)
{{Trainz Image-USE}} — Used for screenshots, including 'In-World' panoramic scenes such as using a Trainz tool in Surveyor, applying a technique or discussing tool or pane options, uses, and such imagery for educational illustration of tutorial text. Auto-category: Category:Trainz Use Tutorials (Edit Discussion links Page history)

Template:Trainz Image-AR

Navigation menu

Search