How to add a Disclaimer to a Template Project
Revision as of 12:02, 22 September 2023 by Rudolf@tygron.nl (talk | contribs)
When offering up a Template Project to other Users in the same Domain, or when preparing to offer one to the broader Tygron Community, adding in information about the purpose, intent, options, liabilities and warnings of using it may be useful or even mandatory. For this purpose, the Tygron Platform allows for configuring a Disclaimer. This is a message which will be displayed to a user when creating a new Project based on the template, and which will need to be explicitly accepted before the Template is actually accessed.
How to add a Disclaimer to a Template Project:
- Ensure the Template Project to which the Disclaimer is to be added is writable.
- Open the Template Project in the editor.
- Go to Tools → Template.
- Find the Disclaimer input field and enter the Disclaimer text.
Notes
- The Disclaimer is displayed during the creation of a new Project, when a Template Project with a Disclaimer is selected for use.
- The Disclaimer is only displayed when creating a new Project via the Tygron Client. Using a Template Project with a Disclaimer programmatically via the API will not explicitly present the Disclaimer.
- The Disclaimer is not carried over to the new Project. If a Template Project A is used to create a Template Project B, which is then itself also turned into a Template Project, using Template Project B to create a new Project will not display a Disclaimer, unless one is explcitly set for B as well.
- The Disclaimer is not part of the Project Data, but of the Project Metadata. This means that when changing the Disclaimer in the Editor it is changed immediately and does not rely on saving the Project. Changing the Disclaimer and then closing the Editor without saving will still result in a changed Disclaimer.