9 Page templates

No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<bookshelf src="Book:Admin manual" />
<bookshelf src="Book:Admin manual" />
{{DISPLAYTITLE:Page templates}}
{{DISPLAYTITLE:Page templates}}
<section begin="training-intro" />


A page template applies a predefined content structure and layout to new pages. That way, certain page types can be applied during page creation to produce consistent sets of related pages.   
== Characteristics of a page template ==
<section eind="training-intro" />
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.   
==When to use page templates==
<section begin="training-intro" />


Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, or short manuals.<section end="training-intro" />
'''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 ==
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}}
Page templates that are installed by default can be deleted (1) from the page [[Manual:Extension/BlueSpicePageTemplates#Creating a page template|template manager]] .


When a page is created with a page template, the page becomes "detached" from the original page template. This means that subsequent changes to the template will not affect pages that have originally been created with that page template. This distinguishes page templates from regular [[Manual:Templates|templates]].
[[File:page template manager.png|alt=Page template manager|center|thumb|650x650px|Page template manager]]


===Characteristics of a page template===
Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the column ''Template'' (2).
<section begin="training" />
 
=== List of standard templates ===
{| class="wikitable" style="width:100%;"
!Page template
!Edition
!Description
|-
|Decision Matrix
|pro
|<span style="color: rgb(32, 33, 36)">Make an informed decision by comparing your options</span>
|-
|Event
|pro
|<span style="color: rgb(32, 33, 36)">Plan an event from beginning to end</span>
|-
|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
|}


*can be created by administrators
*can only be used for new pages
*based on templates in the ''Template'' namespaces
*can be limited to certain namespaces
*substitution of variables is possible
*can integrate with the extension ''Page Forms''
<section end="training" />
==Creating a page template==
==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''.
Administrators can create new page templates, as well as edit and remove existing ones in the ''Page templates'' manager, located under ''Global actions''.
Line 27: Line 71:
<br />
<br />


[[File:PageTemplates1a.png|Page template manager|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates1a.png|center|650x650px|alt=Page template manager|thumb]]{{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=}}
[[File:PageTemplates1a.png|Page template manager|center|650x650px|alt=Page template manager|thumb]]
A new page template can be created by clicking the "Plus" button above the template list.
[[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.  


===Template fields===
New page templates can be added via the "Plus" button above the templates list.
When creating or editing a page template, the following information needs to be provided before the page template can be saved:
 
When creating or editing a page template, '''all fields are required''':


*'''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 />[[File:PageTemplates2.png|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates2.png|alt=Creating a page template|center|450x450px|Creating a page template|thumb]]
<br />[[File:PageTemplates2.png|alt=Creating a page template|center|450x450px|Creating a page template|thumb]]
<br />
<br />


==Using page templates==
==Applying a page template==
A list of available templates appears when a user creates a new page. It is usually shown below the "Empty page" default template. Selecting one of these page templates will create the new page that is pre-filled with the content from the actual template page.
'''(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.


There are two important settings:
'''(4) Sort title:''' The sort titles show the grouping by tags or by namespaces, depending on the toggle setting.


*'''Assigning namespaces (in the page templates administration):''' Page templates can be linked to specific namespaces. If a namespace is not added here, the template will not be displayed in that namespace.
'''(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).


<br />
[[File:Manual:seitenvorlagenauswahl-en.png|alt=Screenshot of the page templates selection screen|center|thumb|750x750px|Applying a page template]]
[[File:Manual:PageTemplates3a.png|link=link=https://en.wiki.bluespice.com/wiki/File:PageTemplates3a.png|alt=|center|thumb|414x414px|Selecting a page template]]




A list of available templates to choose from is displayed below the default "Blank Page" template when a user creates a new page.  
== 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==
Line 59: Line 110:
In the [[Manual:Extension/BlueSpiceConfigManager#BlueSpicePageTemplates|Config manager]], you can change the following settings:
In the [[Manual:Extension/BlueSpiceConfigManager#BlueSpicePageTemplates|Config manager]], you can change the following settings:
{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
{{Box Links-en|Topic1=[[Reference:BlueSpicePageTemplates]]}}


[[en:{{FULLPAGENAME}}]]
 
[[de:Handbuch:Erweiterung/BlueSpicePageTemplates]]
[[de:Handbuch:Erweiterung/BlueSpicePageTemplates]]


[[Category:Organization]]
[[Category:Organization]]

Latest revision as of 16:05, 16 April 2024


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 (1) from the page template manager .

Page template manager
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 Template (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.


Page template manager
Page template manager
Page templates administration screenshot
Page templates administration
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.


Creating a page template
Creating a page template


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.

Screenshot of the page templates selection screen
Applying a page template


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.
    force the namespace of the template
    force the namespace of the template
  • 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.



To submit feedback about this documentation, visit our community forum.