Template:Trainz Image

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.

Calling template arguments: with some planned parameters not yet incorporated 2016-05-21:

{{Trainz Image
  |  CC=  |  CM=  | DIR= | DVR=  |  ED= | FIX=  | GEN= 
  |  icons=  |inhibit=   | LIC=  |MENU= |NEXT=  |  no=
  | noauto=  |nonote=  | notodd= | odd= |OTHER= |   P=
  |  PREV =  |   SES=  |   SUR=  |textmix=
  |   TXT =  |version= |   VID=  |  WIN  =
| ALT-CM-MSG  = | ALT-GUI-MSG = | ALT-ED-MSG  = | ALT-GUI-MSG = 
| ALT-MENU-MSG= | ALT-VID-MSG = | ALT-WIN-MSG =
}}

{{Trainz Image
  |inhibit={{{inhibit|}}}
  |    CC={{{CC|}}}
  |    CM={{{CM|}}}
  |   DIR={{{DIR|}}}
  |   DVR={{{DVR|}}}
  |    ED={{{ED|}}}
  |   FIX={{{FIX|}}}
  |   LIC={{{LIC|}}}
  |    no={{{no|}}}
  |  MENU={{{MENU|}}}
  |noauto={{{noauto|}}}
  |nonote={{{nonote|}}}
  |notodd={{{notodd|}}}<!-- for passing to {TRS-WIN-note} --->
  |   odd={{{odd|}}}
  | OTHER={{{OTHER|}}}
  | icons={{{icons|}}}
  |     P={{{P|}}}
  |   SES={{{SES|}}}
  |   SUR={{{SUR|}}}
  |   TXT={{{TXT|}}}
  | textmix={{{textmix|}}}
  |version={{{version|}}}
  |   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-DIR-MSG|}}}
  |ALT-ED-MSG ={{{ALT-ED-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|}}}
}}

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Trainz Image/doc.

Overview

The purpose of this template is to make it as simple and easy as possible to upload supporting images for Trainz Tutorials. Notice, please, all parameters are UPPERCASE alphabetic mnemonic short abbreviations, save about a handful of display suppression or auto-category suppression parameters.

Note: The assumption has been made that most uploads will be by {{self|cc-by-3.0}} AND the upload process will automatically add this to the page already, but this may also be altered by defining the parameter LIC=licence-template-name if desired. (as is the case for the below demonstration examples).

Further, the template has been altered with messaging outputs to satisfy the Permissions criteria in the the upload wizard input sequence; this mode is entered by defining the 'P' parameter anything: (e.g. | P = 1). When and if P is defined, it acts the same to suppress the Licensing templates, which is handled by an different part of the upload wizard.

The below output messages do no auto-categorization of this usage page: Instead the no and inhibit parameters are set, the first suppressing the assertion of the {{self|CC-by-SA-3.0}} template here on the usage page; the second suppressing non-Panoramic auto-categorization (most of which this page is discussing).

as is noauto (to prevent THIS page from being categorized as a Panoramic illustration).
The no and P parameters suppresses Automatic licensing output templates, but presents the other messages. The examples below do not define P, but do suppress license templates using the no parameter.

This template 'Trainz Image' Makes a variety of automatic boilerplate licensing messages for Trainz Wikibooks tutorial's for both in-GUI screenshots showing panorama views in the Run-time GUIs Driver or Surveyor, or supporting applications used to support digital modeling for the various Trainz releases over 2001-2024.
• With properly set parameters, the template will also support the showcase Railyard utility in Trainz,
• but also Trainz support/maintenance Windows or OS-X applications classed as acceptable general Freeware or other 3rd party or open source software acceptable to WikiMedia Foundation.

No description yet available.

The template automatically sets the following categories: Trainz images / Trainz panoramas / and other apropos refined categories by it's pass parameters. See list section below.

Usage

{{Trainz Image |inhibit= |ALT-MSG= |sort= |CM= |DVR
SUR= |WIN= |Other= |icons= |GIMP
(value)= |BLEN
(value)= |PAINT.NET
(value)= |text= |13= }}

This template may be used alone or by transclusion by using the near name suffixed equivalent templates (listed at the page bottom) which do additional auto-categorization.

Template parameters

Parameter	Description		Default	Status
`inhibit`	inhibits most auto categories	inhibits auto-categorization of mode switched auto-categorization, used to display how-to here and in calling templates using this as common sub-template.	off	optional
`ALT-MSG`	some alternative text to change default message (Also effects messages for DVR and/or SUR mode parameters when true cases).		empty	optional
`sort`	always lowercase	Pipetrick sort parameter, Defaults to magic word SUBPAGENAME	{{SUBPAGENAME}}	optional
`CM`	invokes CM autocat and message	Content Manager module is a Windows Application.	empty	optional
`DVR SUR`	Driver module screen shot or SURVEYOR screen shot. Both have differing auto-cats and both auto-express icons message and cat.	Driver or Surveyor run-time module screenshot or part of one. (Common How-To image type, qualify as Panoramic views under Australian copyright law so exempt from Copyright protections save for icons.)	empty	optional
`WIN`	MS Windows Applications	freeware Windows Apps (e.g. GIMP, PAINT.NET, Notepad++, etc.) should be used to define this value as will have subordinate auto-categories.	empty	optional
`Other`	Other switch allows a free form declaration for composite images depicting a mix of images.		empty	optional
`icons`	icon limitations	The image contains images of Trainz Icons which are copyrighted by N3V Games or Auran Holdings Ltd. When a CM or SUR GUI, icons message will auto-express. Displays a message and auto-cat.	none	optional
`GIMP (value)`	WIN=GIMP	Auto-cat for Trainz GIMP images supporting digital model creation or alteration.	parent cat	optional
`BLEN (value)`	WIN=BLEN	Auto-cat for Trainz BLENDER images supporting digital model creation or alteration.	parent cat	optional
`PAINT.NET (value)`	WIN=PAINT.NET	Auto-cat for Trainz PAINT.NET images supporting digital model creation or alteration.	parent cat	optional
`text`	editor	Text only image supporting Trainz asset value maintenance or creation. Like WIN, `\| editor=Notepad++` uses a dedicated sub-categorization. Other freeware editors TBDL as well.	empty	optional
`13`			empty	optional

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: no user group specified

Purpose

Set CMshot=true if the view is of Trainz Content Manager HowTo tutorial pages.
Define '|inhibit=yes' when the Trainz topic image is non-panoramic (i.e. NOT one showing virtual surrounds inside the Trainz generated Virtual Worlds).
1. Setting his 'message' control is unnecessary when '|CMshot=yes' or WINap=yes is defined.
2. For Railyard screenshots, set '|inhibit=yes' (and optionally for Windows Applications (WINap=true) like Content Manager views)
3. If Trainz icons are present or should also be set true.
4. Use '|altCMshot-msg=some alternative text to change default message in CMshot true views
Use inhib=anything or inhibit=anything to suppress all Trainz category auto-categorization and suppress {{FoP-Australia}} claim of Panoramic view license.
1. Also assert noauto to suppress categorization to several possible non-Trainz generic categories.
Define SUR or SURshot if the Screenshot is in Trainz Surveyor or DVR if a view in Trainz Driver.
For website screenshots in the many Trainz societies, or Auran http and https prefixed urls define WEB or |website=yes.
Use '|WINap=yes' when the screenshot is not of Trainz software, such edits of b:Trainz/config.txt files or "Error Fixing" views in Notepad++, image processing in GIMP or IrfanView, Blender views and so forth.
1. Define '|WINap=yes' when the view is of some other 'Not-In-Virtual-World applications program or software package.
2. In general, such programs should be cropped or processed to mask icons unless the application is open source or freeware, such as using Notepad++ views vice Windows Notepad.
3. Some common Trainz maintenance utility programs which can be used freely without masking or cropping are screenshots of: Blender, GIMP, IrfanView, and other Public Domain/open source works such as Open Office.
4. Cropping or masking Desktop and Windows folder views is unnecessary for tutorials images since Microsoft has now licensed Wikimedia foundations use of such iconography for educational uses.

Trainz Content Manager Sshots

'CM' defined

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

This is a view of the Trainz Windows run-time module Content Manager, the Trainz Launcher, Loader, Main or Options Menus or one of their sub-Menus or API's or part of one showing relevant tutorial information, and possibly of OTHER Windows OS applications or folders used to manipulate and maintain Trainz self-defining digital models in conjunction with Content Manager's management, organization, and maintenance of Assets.

As each extensible Trainz installation quickly has unique contents, such Content Manager entries that may be listed on screen from the owners local Trainz database are of educational value but with no intrinsic artistic merit. Any such list is ordered by user selectable Content Manager Search settings and the column selected to order the list, whether organized ascending or descending.

Trainz Driver Sshots

'DVR' defined: In addition, this mode would assert a Australian Panoramic view license

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

This view is of Driver, the Trainz 'play and interact' inside a Virtual World module.

The momentary visual is of a run-time image running under the software of the game engine used to render the virtual model railroad's virtual world. The controls depicted are the w:Graphical user interface of the Trainz Railroad simulator, their Freeware component assets, objects, rolling stock and scripts used to generate virtual reality maps, and which components are available as built-in assets of by download to any party possessing a legally registered copy of the copyrighted run-time software. Use of any icons depicted is restricted to educational purposes, and used with the express permission of the copyright owners, Auran Holdings, Pty. Ltd., Gold Coast, Queensland, Australia.
The image on this page represents less than 1/20th of 1 second (a single Frame) of a rendering of a three-dimensional (3D) Virtual space in the complex Trainz run-time computer simulations; excepting a static scene, even the uploading user is unlikely to be able to re-create the image exactly.
This GUI screenshot is a panorama image allowed free use under Australian copyright laws.

Trainz SURVEYOR module Sshots

'SUR' defined: In addition, this mode would assert a Australian Panoramic view license

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

This view is of Surveyor, the Trainz Virtual World building module.

The momentary visual is of a run-time image running under the software of the w:Graphical user interface's pages used to create, program, organize, manipulate, place or view the Trainz Railroad simulator virtual model railroads, their Freeware component assets, objects, rolling stock and scripts used to generate virtual reality maps, and which components are available as built-in assets of by download to any party possessing a legally registered copy of the copyrighted run-time software.
The image on this page represents less than 1/20th of 1 second (a single Frame) of a rendering of a three-dimensional (3D) Virtual space in the complex Trainz run-time computer simulations; excepting a static scene, even the uploading user is unlikely to be able to re-create the image exactly.
This GUI screenshot is a panorama image allowed free use under Australian copyright laws.

WINDOWS Apps appearances

Generic Windows non-text-editor applications: not otherwise handled by having a freeware category

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

The Windows Application depicted is Open Source or Freeware, or held to be a trivial part of the educational information (message)in the view, and so it is legally held, as well, to possess no intrinsic artistic merit worthy of copyright protections.
Microsoft copyrighted Windows Applications Icons have a blanket screenshot permission on this Wiki, when used for educational purposes, with restrictions to use of such images for educational purposes.

WINap GIMP appearance

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

The Windows Application depicted is Open Source or Freeware, or held to be a trivial part of the educational information (message)in the view, and so it is legally held, as well, to possess no intrinsic artistic merit worthy of copyright protections.
Microsoft copyrighted Windows Applications Icons have a blanket screenshot permission on this Wiki, when used for educational purposes, with restrictions to use of such images for educational purposes.

WINap PAINT.NET appearance

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

The Windows Application depicted is Open Source or Freeware, or held to be a trivial part of the educational information (message)in the view, and so it is legally held, as well, to possess no intrinsic artistic merit worthy of copyright protections.
Microsoft copyrighted Windows Applications Icons have a blanket screenshot permission on this Wiki, when used for educational purposes, with restrictions to use of such images for educational purposes.

WINap Notepad++ appearance

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

This text image is of Notepad++, a Text Editor used to build or adjust configuration files for Trainz assets. The view is depicting data, showing it's manipulation, or the use of the Windows Editor as a tool to inspect such a file. The Text Editor is shown depicting, manipulating, or using one of the many such Trainz texture.txt or config.txt configuration files for tutorial purposes.

The Windows Application depicted is Open Source or Freeware, or held to be a trivial part of the educational information (message)in the view, and so it is legally held, as well, to possess no intrinsic artistic merit worthy of copyright protections.
Microsoft copyrighted Windows Applications Icons have a blanket screenshot permission on this Wiki, when used for educational purposes, with restrictions to use of such images for educational purposes.

WINap Notepad++ & CM appearance

   Permission to use this image, if Trainz modules User Interface icons are present is restricted to educational uses.

I, the copyright holder of this work, hereby publish it under the following license:

This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.

You are free:

to share – to copy, distribute and transmit the work
to remix – to adapt the work

Under the following conditions:

attribution – You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
share alike – If you remix, transform, or build upon the material, you must distribute your contributions under the same or compatible license as the original.

1. This image may be of the Trainz Content Manager modules (CM or CMP) or other Microsoft Windows 'applications program' which has a customizable appearance affected by user preferences, including the Windows Desktop Themes.

2. The appearance of this image is and will almost certainly not be the same as another's installation running the software under a different set of customized settings, should anyone load a similar task.

This text image is of Notepad++, a Text Editor used to build or adjust configuration files for Trainz assets. The view is depicting data, showing it's manipulation, or the use of the Windows Editor as a tool to inspect such a file. The Text Editor is shown depicting, manipulating, or using one of the many such Trainz texture.txt or config.txt configuration files for tutorial purposes.
This is a view of the Trainz Windows run-time module Content Manager, the Trainz Launcher, Loader, Main or Options Menus or one of their sub-Menus or API's or part of one showing relevant tutorial information, and possibly of OTHER Windows OS applications or folders used to manipulate and maintain Trainz self-defining digital models in conjunction with Content Manager's management, organization, and maintenance of Assets.

As each extensible Trainz installation quickly has unique contents, such Content Manager entries that may be listed on screen from the owners local Trainz database are of educational value but with no intrinsic artistic merit. Any such list is ordered by user selectable Content Manager Search settings and the column selected to order the list, whether organized ascending or descending.

The Windows Application depicted is Open Source or Freeware, or held to be a trivial part of the educational information (message)in the view, and so it is legally held, as well, to possess no intrinsic artistic merit worthy of copyright protections.
Microsoft copyrighted Windows Applications Icons have a blanket screenshot permission on this Wiki, when used for educational purposes, with restrictions to use of such images for educational purposes.

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)

TEMPORARY cat checks debugging: Category:Trainz Check Licensing