Last edited 2 years ago
by WikiSysop

3 Page templates

No edit summary
Tag: 2017 source edit
(Changed categories.)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
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.   
<bookshelf src="Book:Administration" />
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 support consistent formatting throughout the knowledge base.   
<section eind="training-intro" />
<section eind="training-intro" />
==When to use page templates==
==When to use page templates==
<section begin="training-intro" />
<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" />
Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, customer information, or short manuals.<section end="training-intro" />


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]].  
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 [[templates]].  


===Characteristics of a page template===
===Characteristics of a page template===
<section begin="training" />
<section begin="training" />


*can be created by administrators
Page templates:
*can be added to the page template collection by administrators
*can only be used for new pages
*can only be used for new pages
*based on templates in the ''Template'' namespaces
*are based on pages that are located in the ''Template'' namespace
*can be limited to certain namespaces
*can be limited to certain namespaces
*substitution of variables is possible
*can integrate with forms
*can integrate with the extension ''Page Forms''
<section end="training" />
<section end="training" />


== Standard page templates ==
== Standard page templates ==
Page templates that are installed by default can be deleted from the page template manager (1).
[[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).
=== List of standard templates ===
=== List of standard templates ===
{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
Line 69: Line 63:
|Track and update your to-dos
|Track and update your to-dos
|}
|}
=== Removing a standard page template ===
Page templates that are installed by default can be deleted from {{Global actions}}''Global actions > Management > Page templates''.
[[File:page_template_manager.png|link=https://knowledgebase-2-0-helpdesk.bluespice.cloud/wiki/File:page_template_manager.png|alt=Page template manager|none|thumb|750x750px|Deleting a page template from the Page templates administration (1).]]
When you delete a page template here, it is only removed from the selection of templates during page creation. The actual template page still resides in the ''Template'' namespace and can be added back later.
Instead of deleting a template, its content can be adjusted directly in the template namespace. To do this, click on the template link in the column ''Template'' (2).


==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''.
Any knowledge base user with edit rights can add a new page template in the template namespace. {{Messagebox|boxtype=important|icon=|Note text=By default, the Template namespace does not have visual editing activated.  


<br />
If you want to create page templates in visual editing mode, adjust the settings for this namespace in the [[Namespace manager]].|bgcolor=}}To add the template to the Page template administration, however, you need admin permissions.{{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=}}<br />To add a page template to the list of available page templates:


[[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=}}
# '''Go''' to the Page templates administration.
A new page template can be created by clicking the "Plus" button above the template list.
# '''Click''' the ''Plus''-button above the template list.
# '''Save''' the template after completing all template fields (all fields are required).


===Template fields===
===Template fields===
Line 86: Line 88:
*'''Template''' - page in the ''Template'' namespace from which to pull the content.
*'''Template''' - page in the ''Template'' namespace from which to pull the content.


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


==Using page templates==
==Using page templates==
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.
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.
[[File:Page templates list.png|alt=Page template selection during article creation|none|thumb|650x650px|Page template selection during article creation]]


There are two important settings:
There are two important settings:
Line 96: Line 99:
*'''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.
*'''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.
*'''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).
*'''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: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.
You can also [[Manual:Extension/BlueSpicePageTemplates/Customizing|customize the look-and-feel of this page]].
==Configuration==
In the [[Manual:Extension/BlueSpiceConfigManager#BlueSpicePageTemplates|Config manager]], you can change the following settings:
{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
[[Category:Administration]]
[[Category:Administration]]
[[Category:Feature]]

Latest revision as of 11:34, 30 September 2022

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 support consistent formatting throughout the knowledge base.

3.1 When to use page templates

Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, customer information, or short manuals.

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 templates.

3.1.1 Characteristics of a page template

Page templates:

  • can be added to the page template collection by administrators
  • can only be used for new pages
  • are based on pages that are located in the Template namespace
  • can be limited to certain namespaces
  • can integrate with forms

3.2 Standard page templates

3.2.1 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

3.2.2 Removing a standard page template

Page templates that are installed by default can be deleted from Global actions > Management > Page templates.

Page template manager
Deleting a page template from the Page templates administration (1).

When you delete a page template here, it is only removed from the selection of templates during page creation. The actual template page still resides in the Template namespace and can be added back later.

Instead of deleting a template, its content can be adjusted directly in the template namespace. To do this, click on the template link in the column Template (2).

3.3 Creating a page template

Any knowledge base user with edit rights can add a new page template in the template namespace.

Important!By default, the Template namespace does not have visual editing activated. If you want to create page templates in visual editing mode, adjust the settings for this namespace in the Namespace manager.

To add the template to the Page template administration, however, you need admin permissions.

Note:Every page template depends on an actual page in the namespace Template. This template must exist before creating a page template.


To add a page template to the list of available page templates:

  1. Go to the Page templates administration.
  2. Click the Plus-button above the template list.
  3. Save the template after completing all template fields (all fields are required).

3.3.1 Template fields

When creating or editing a page template, the following information needs to be provided before the page template can be saved:

  • Name - the name of the page template
  • Description - a short description of the page template
  • 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.


Creating a page template
Adding a page template


3.4 Using page templates

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.

Page template selection during article creation
Page template selection during article creation

There are two important settings:

  • 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.
  • 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).