No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<bookshelf src="Book:Admin manual" /> | <bookshelf src="Book:Admin manual" /> | ||
{{DISPLAYTITLE:Page templates}} | {{DISPLAYTITLE:Page templates}} | ||
A page template applies a predefined content structure and layout to new pages. | == Characteristics of a page template == | ||
A page template applies a predefined content structure and layout to new pages. Page templates are useful for frequently used content formats such as meeting minutes, reference pages or process descriptions, for example. | |||
Page templates are useful for frequently used content formats such as meeting minutes, reference pages | |||
'''The following characteristics are typical for a page template:''' | |||
*it can only be activated by administrators | |||
*the underlying content itself can be created by any editor in the template namespace | |||
*it can only be used for the initial creation of a page | |||
*it can also contain (standard) templates | |||
*it creates a prefilled page | |||
*it can be restricted to certain namespaces | |||
*it can be grouped ("tagged") with other templates | |||
*it can contain categories | |||
*it can be applied using different page creation mechanisms, such as the New-button, an [[Manual:Extension/InputBox|inputbox]], or a [[mediawikiwiki:Extension:Page_Forms/Linking_to_forms#Preloading_data|page form]]. | |||
== Standard page templates == | == Standard page templates == | ||
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}} | {{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}} | ||
| Line 29: | Line 21: | ||
[[File:page template manager.png|alt=Page template manager|center|thumb|650x650px|Page template manager]] | [[File:page template manager.png|alt=Page template manager|center|thumb|650x650px|Page template manager]] | ||
Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the column''Vemplate'' (2). | |||
Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the column ''Vemplate'' (2). | |||
=== List of standard templates === | === List of standard templates === | ||
| Line 80: | Line 71: | ||
<br /> | <br /> | ||
[[File:PageTemplates1a.png|Page template manager| | [[File:PageTemplates1a.png|Page template manager|center|650x650px|alt=Page template manager|thumb]] | ||
[[File:Page templates administration.png|alt=Page templates administration screenshot|center|thumb|650x650px|Page templates administration]] | |||
{{Messagebox|boxtype=note|icon=|Note text=Every page template depends on an actual page in the namespace Template. This template must exist before creating a page template.|bgcolor=}} | |||
When a page template is selected, it can be edited by clicking the "wrench" icon or deleted by clicking the "X" icon. | |||
New page templates can be added via the "Plus" button above the templates list. | |||
When creating or editing a page template, '''all fields are required''': | |||
When creating or editing a page template, | |||
*'''Name''' - the name of the page template | *'''Name''' - the name of the page template | ||
*'''Description''' - a short description of the page template | *'''Description''' - a short description of the page template | ||
*'''Tags-''' allows the grouping of similar templates. (If no classification is desired, you can enter ''Untagged'' as a value here, for example). | |||
*'''Namespace''' - a list of the namespace where the template is active. If the template should be available on all pages, select ''(all)'' from the list. | *'''Namespace''' - a list of the namespace where the template is active. If the template should be available on all pages, select ''(all)'' from the list. | ||
*'''Template''' - page in the ''Template'' namespace from which to pull the content. | *'''Template''' - page in the ''Template'' namespace from which to pull the content. '''Important!''' The namespace prefix <code>Template:</code> must be explicitly provided in the field. | ||
<br />[[ | <br />[[File:PageTemplates2.png|alt=Creating a page template|center|450x450px|Creating a page template|thumb]] | ||
<br /> | <br /> | ||
== | ==Applying a page template== | ||
'''(1) Blank page:''' When creating a new page, the page templates are displayed for selection. A blank page can be created by default. This option can be deactivated in the [[Manual:Extension/BlueSpicePageTemplates#Configuration|configuration manager.]] | |||
'''(2) Filter field:''' The templates can be filtered here. This field is independent of the T''ags/Namespaces'' toggles. | |||
'''(3) Tags/namespaces toggle:''' Here you can switch between tag-based and namespace-based sorting. | |||
'''(4) Sort title:''' The sort titles show the grouping by tags or by namespaces, depending on the toggle setting. | |||
'''(5) Assignment to tag/namespace:''' Depending on the setting of the toggle, the tags (when sorted by namespaces) or namespaces (when sorted by tags) are displayed here as additional possible filter criteria. | |||
[[File:Manual:seitenvorlagenauswahl-en.png|alt=Screenshot of the page templates selection screen|center|thumb|750x750px|Applying a page template]] | |||
== Namespace manager == | |||
The PageTemplates option for a namespace must be activated in the [[Manual:Extension/BlueSpiceNamespaceManager|Namespace manager]] so that the associated templates are automatically displayed when a new page is created in that namespace (e.g., if the "+" button is used to create the page). | |||
==Configuration== | ==Configuration== | ||
Revision as of 15:10, 6 July 2023
Characteristics of a page template
A page template applies a predefined content structure and layout to new pages. Page templates are useful for frequently used content formats such as meeting minutes, reference pages or process descriptions, for example.
The following characteristics are typical for a page template:
- it can only be activated by administrators
- the underlying content itself can be created by any editor in the template namespace
- it can only be used for the initial creation of a page
- it can also contain (standard) templates
- it creates a prefilled page
- it can be restricted to certain namespaces
- it can be grouped ("tagged") with other templates
- it can contain categories
- it can be applied using different page creation mechanisms, such as the New-button, an inputbox, or a page form.
Standard page templates
is available from BlueSpice 4.2.
Page templates that are installed by default can be deleted from the page template manager (1).
Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the columnVemplate (2).
List of standard templates
| Page template | Edition | Description |
|---|---|---|
| Decision Matrix | pro | Make an informed decision by comparing your options |
| Event | pro | Plan an event from beginning to end |
| Guideline | pro | Create a code of conduct or other guideline |
| How-to Article | free, pro | Step-by-step instructions for completing a task |
| Management Meeting Minutes | pro | Create minutes for a regular management meeting |
| Meeting Agenda | free | Create a generic meeting agenda with minutes |
| Request for Comments | pro | Ask for feedback about an important decision that needs to be made |
| Status Report | pro | Stakeholder über den derzeitigen Stand eines Projekts informieren |
| To-do List | free, pro | Track and update your to-dos |
Creating a page template
Administrators can create new page templates, as well as edit and remove existing ones in the Page templates manager, located under Global actions.
Note:Every page template depends on an actual page in the namespace Template. This template must exist before creating a page template.
When a page template is selected, it can be edited by clicking the "wrench" icon or deleted by clicking the "X" icon.
New page templates can be added via the "Plus" button above the templates list.
When creating or editing a page template, all fields are required:
- Name - the name of the page template
- Description - a short description of the page template
- Tags- allows the grouping of similar templates. (If no classification is desired, you can enter Untagged as a value here, for example).
- Namespace - a list of the namespace where the template is active. If the template should be available on all pages, select (all) from the list.
- Template - page in the Template namespace from which to pull the content. Important! The namespace prefix
Template:must be explicitly provided in the field.
Applying a page template
(1) Blank page: When creating a new page, the page templates are displayed for selection. A blank page can be created by default. This option can be deactivated in the configuration manager.
(2) Filter field: The templates can be filtered here. This field is independent of the Tags/Namespaces toggles.
(3) Tags/namespaces toggle: Here you can switch between tag-based and namespace-based sorting.
(4) Sort title: The sort titles show the grouping by tags or by namespaces, depending on the toggle setting.
(5) Assignment to tag/namespace: Depending on the setting of the toggle, the tags (when sorted by namespaces) or namespaces (when sorted by tags) are displayed here as additional possible filter criteria.
Namespace manager
The PageTemplates option for a namespace must be activated in the Namespace manager so that the associated templates are automatically displayed when a new page is created in that namespace (e.g., if the "+" button is used to create the page).
Configuration
In the Config manager, you can change the following settings:
- Force target namespace: The page is always created in the target namespace that is associated with the template, even if the user provided a different namespace prefix. In the screenshot below, the user wants to create the page "NewPage" and then selects a template for the QM namespace. The page is, therefore, created as "QM:NewPage" if this setting is activated.
- Hide default templates: Hides the default Empty page template.
- Hide template if the page is not to be created in the target namespace: Depending on the namespace prefix of the page to be created, templates that are associated with other namespaces will not be shown to the user for selection.
