Template Project: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(99 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{old references}}
[[File:Api_tools_geo.png|thumb|right|400px|[[Template]] in relation to [[Source]]s and [[Geo Plugin]]s]]
{{learned|file=TemplateLogo1.jpg|what a template is|about project templates in the Tygron Engine|about the available default project templates in the Tygron Engine|how to make a project template|how you can share your project template within your domain}}
A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same [[Indicators]] and [[Actions]]. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.


==What is a template==
==Which elements are transferred to a new project==
tem·plate
In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.
noun \ˈtem-plət\


: computers : a computer document that has the basic format of something (such as a business letter, chart, graph, etc.) and that can be used many different times
===Elements that ''are transferred'' to a new project===
* [[Indicator]]s
* [[Stakeholder]]s
* [[Overlay]]s and their settings, such as the grid size
* New [[Functions]]/changes in [[function values]]
* New [[Terrain Type]]s/changes in terrain types
* [[Global]]s
* [[Action Menu]]s
* New/changed [[Upgrade Type]]s
* [[WFS]] connections in the [[Geo Data Wizard]]
* [[Geo Plugin]]s


: ''From http://www.merriam-webster.com''
===Elements that are ''not transferred'' to a new project===
* [[Area]]s, [[Building]]s, [[Neighborhood]]s, [[Network]]s,[[Plot]]s, [[Terrain]]s, [[Zone]]s
:These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
* [[Measure]]s
:Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
* [[Cinematics]]
:A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
* [[Panel]]s
: Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.  


==Using templates in the Tygron Engine==
===Transferred elements that rely on spatial data===
: In the Tygron engine it is possible to take the project elements only from an existing project - [[Stakeholders]], [[Indicators]], [[Actions]], etc - and transpose these over to a new area. This is very convenient in case a similar spatial issue is at hand on different locations. This functionality also enables the user to make elaborate predefined actions or custom indicators, which can easily be transposed as a project template to another area.
* [[Overlay]]s
: Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the [[Rainfall Overlay]], such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, ''are'' transferred from the template.


==Default templates in the Tygron Engine==
===Template settings===
'' Also See: [[Climategame]] and [[Bedrijventerrein]].''
[[File:Template_settings_panel.png|right|500px]]


[[File:TemplateDefault1.jpg|300px|right]]<br>
{{Editor location|Template}}


In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template. Changes made are stored in [[Geo Option]] items.


: There are two default templates available in the Tygron Engine: [[Climategame]] and [[Bedrijventerrein]]. For more information about those specific templates see their respective articles.
<br clear=all>


==How to add your own template==
{{article end
[[File:TemplateCheckBox1.jpg|300px|right]]
|howtos=
: Projects can easily be set as a template, to be used as base for next projects. Once a project has been set as template it is added to the list of available templates. Setting a project as a template can only be done by users with [[Account_management#Domain_Admin|Domain Administrator]] rights. By default the template is not shared with other users within your domain. Please refer to the next paragraph about making templates available for the domain.
* [[How to create a Template Project]]
: '''Setting a project as a template makes the project read only!'''
* [[How to share a Template Project with other users in your domain]]
* [[How to base a new Project on a Template Project]]
|videos={{video|gallery=
{{video|link=https://youtu.be/VZrazrmgYZM|description=Video tutorial on using Template Projects.}}
}}
}}


{{Editor steps|title=set a project as template|Log in with Domain Admin rights|Select "Options"|Select "Projects"| Highlight project to be made a template| Check box named "Template (project becomes read only)"}}
{{editor tools nav}}
 
[[Category:Project Metadata]]
==Sharing your template with other users in your domain==
[[File:TemplatePermissions1.jpg|right|300px]]
: When a project has been made a project template, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. No write permissions remain (project cannot be edited anymore) and only the creator can read the template by default. In order to change the read permissions, so that other users within the same domain can also use the template, the creator can change the permissions of the original project in the editor.
 
{{Editor steps|title=share the template with other users in your domain|Load in the editor the template project to be shared with the domain|Select "File" when in main view|Select "Permissions"| Change the entry for "Other users in domain" to "Read"|Save project}}

Latest revision as of 14:45, 28 September 2023

Template in relation to Sources and Geo Plugins

A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same Indicators and Actions. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.

Which elements are transferred to a new project

In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.

Elements that are transferred to a new project

Elements that are not transferred to a new project

These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.

Transferred elements that rely on spatial data

Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the Rainfall Overlay, such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, are transferred from the template.

Template settings

Template settings panel.png
Editor → Tools (Ribbon tab) → Template (Ribbon bar)

In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template. Changes made are stored in Geo Option items.


How-to's

Videos

Video tutorial on using Template Projects.
Editor ribbon icon tools.pngTools
Tools
Building style • Environment • Cinematics • Screenshot • Free Cam • Web Interface • API Overview • Triggers • Template • Geo Plugins • Debug Info
Environment
Sun angle • Solar Panels • Lighting • Weather
Cinematics
Special Effects • Particle Emitters
Screenshot
GIF animation • Video recording
Geo Plugins
Error Logs • Geo Links • Geo Options • Sources
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://previewsupport.tygron.com/w/index.php?title=Template_Project&oldid=55578"