Wiki source code of Template Provider Fields
Last modified by Eleni Cojocariu on 2026/10/13 18:15
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | This page describes every field of the template provider form, in the order the form shows them. [[Create a Page Template>>doc:documentation.xs.admin.page-templates.create-page-template.WebHome]] shows where the form is, and [[Page Templates>>doc:documentation.xs.admin.page-templates.WebHome]] explains when to restrict a template's locations. | ||
| 2 | |||
| 3 | |=Field |=Values |=Default |=What it does | ||
| 4 | |Provider Name|Free text|Required|Names the provider page and identifies it in the list of available template providers in the administration section. Your users never see it. | ||
| 5 | |Template Name|Free text, or a translation key|Required|The entry your users pick in the creation wizard. A translation key is resolved in the user's language. | ||
| 6 | |Description|Free text, or a translation key|Empty|The line shown under the entry in the wizard, to say what the template is for. | ||
| 7 | |Icon|The name of an icon in the wiki's icon theme|##file-white##|The icon shown next to the entry in the wizard. | ||
| 8 | |List of locations where the template must be available|One or more locations|Empty, which offers the template from anywhere in the wiki|Where the template is offered in the creation wizard. This is the visibility restriction. | ||
| 9 | |Template to use|A page|Required|The page copied into every page created from this provider, content and objects alike. A page that has children brings its whole hierarchy: see [[Use a Page Hierarchy as a Template>>doc:documentation.xs.admin.page-templates.page-hierarchy-template.WebHome]]. | ||
| 10 | |Creation Restrictions|One or more locations|Empty, which lets the template create pages anywhere in the wiki|Where the template is allowed to create pages. It also prefills the wizard's destination field: a destination already inside one of the restrictions is left as it is, any other one is moved to the first restriction. | ||
| 11 | |Creation Restrictions as Suggestions|Checkbox|Unchecked|When checked, the creation restrictions are no longer enforced. They only supply the destination prefilled on the creation screen, and the user may still choose a parent outside them. | ||
| 12 | |Terminal Page|Yes, No, or left unset|No, including when the field is left unset|Whether the pages created from this provider are [[terminal>>doc:documentation.xs.user.base.page.nested-pages.relations.WebHome]]. An advanced user sees the wizard's "Terminal Page" checkbox preset to this value and may still change it; a regular user is not shown the checkbox at all, so the provider decides on its own. | ||
| 13 | |Action on create|Edit, Save and Edit, Save and View|Edit, including when the field is left unset|What the Create button does once a title and a location have been entered:((( | ||
| 14 | * **Edit** opens the new page in the editor, and the page only exists once you save it there. | ||
| 15 | * **Save and Edit** saves the new page with the template's content first, then opens it in the editor. | ||
| 16 | * **Save and View** saves the new page with the template's content, then shows it. | ||
| 17 | ))) |
