Difference between revisions of "Manual:Extension/BlueSpicePageTemplates"

[unchecked revision][quality revision]
m
(Tag: 2017 source edit)
 

What is BlueSpicePageTemplates?[edit | edit source]

BlueSpicePageTemplates offers creating new pages using predefined templates to set basic page structure.

Usage

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.

When to use page templates[edit | edit source]

Page template manager Editing a template in the Page template manager Available page templates when creating a new pageCreating template pages

Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, 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.

Characteristics of a page template[edit | edit source]

Every page template depends on an actual page in namespace Template (NS_TEMPLATE) to provide the content that will be inserted into new pages when created using this page template. This must exist before creating a page template.

Creating page templates
  • 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

Creating a page template[edit | edit source]

Wiki admins Administrators can create new page templates, as well as edit and remove existing ones in the Page template templates manager. It is located in the left navigation, in "Global actions" tab, under "Management" section. From here, when selected, page template can be edited by clicking on the "wrench" icon, or deleted by clicking on the "X" icon. New templates can be created using , located under Global actions.


Page template manager
Page template manager

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

A new page template can be created by clicking the "Plus" button above the template list.

Template fields[edit | edit source]

When creating or editing a page template, the following information need needs to be inserted. 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 using this template will be offeredthe template is active. If the template should be available on all pages, select (all) from the list.
  • Template - page from in the Template namespace from which to pull the data fromcontent.

Creating a page template
Creating a page template


Using page templates

when creating new pages

[edit | edit source]

Once the page template can be saved, it can be used when creating new pages in namespaces that the template is set for.

List of availble templates to choose from will appear when creating new 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 prefilled pre-filled with the content of from the actual template page in Template namespace that choosen page template is related to.

Tips for working with page templates

.

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


Selecting a page template
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.

Configuration[edit | edit source]

  • PageTemplates are particularly good for designing structures for minutes and logs, but they are also excellent for typical business or product data for marketing, sales and product management.

See also[edit | edit source]

Reference page for this extension.

In the Config manager, you can change the following settings:


  • Force target namespace:
  • Hide default templates: Hides the default Empty page template.


Related info


Attachments

Discussions