Difference between revisions of "Manual:Extension/BlueSpicePageTemplates"

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


What is a page template?[edit | edit source]

A page template allows you to apply a predefined content structure to new pages. Thus, certain page types can be created, which are initially always the same structure. This is especially useful for frequently used content formats such as logs, 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[edit | edit source]

  • Just for new pages
  • Can be limited to certain namespaces
  • Can force Namespaces
  • Based on templates in the "Template" namespaces
  • Integrates with "PageForms"

Creating a page template[edit | edit source]

Wiki admins 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

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 needs to be provided:

  • Name - the name of the template
  • Description - a short description of the template
  • Namespace - list of the namespace where the template is active
  • Template - page from the Template namespace from which to pull the data
Screenshot: update page template settings


Using page templates[edit | edit source]

A list of available templates appears when a user creates a new page. It is shown below the "Empty page" default template. Selecting one of these page templates will create the new page that is prefilled with the content that is transcluded from the actual template page:

Screenshot: selecting a page template


Configuration[edit | edit source]

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

  • Force target namespace: The page template is always created in the target namespace, no matter what namespace is provided during page creation.
  • Hide default templates: Hides the default Empty page template.


Related info

{{DISPLAYTITLE:Page template}}
        

        ==What is a page template?==
        

        A page template allows you to apply a predefined content structure to new pages. Thus, certain page types can be created, which are initially always the same structure. This is especially useful for frequently used content formats such as logs, 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==
        

        *Just for new pages
        
        *Can be limited to certain namespaces
        
        *Can force Namespaces
        
        *Based on templates in the "Template" namespaces
        
        *Integrates with "PageForms"
        

        ==Creating a page template==
        
        Wiki admins can create new page templates, as well as edit and remove existing ones in the Page templates manager, located under "Global actions":
        

        [[File:PageTemplates1a.png|Page template manager|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates1a.png|center|650x650px|border]]{{Box Note|boxtype=note|Note text=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===
        
        When creating or editing a page template, the following information needs to be provided:
        

        *'''Name''' - the name of the template
        
        *'''Description''' - a short description of the template
        
        *'''Namespace''' - list of the namespace where the template is active
        
        *'''Template''' - page from the Template namespace from which to pull the data
        

        [[File:PageTemplates2.png|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates2.png|alt=Screenshot: update page template settings|border|center|650x650px]]
        <br />
        

        ==Using page templates==
        
        A list of available templates appears when a user creates a new page. It is shown below the "Empty page" default template. Selecting one of these page templates will create the new page that is prefilled with the content that is transcluded from the actual template page:
        

        [[File:PageTemplates3a.png|Available page templates when creating a new page|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates3a.png|alt=Screenshot: selecting a page template|center|650x650px|border]]
        

        ==Configuration==
        
In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:
            

            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
        

        {{Box Links-en|Topic1=[[Reference:BlueSpicePageTemplates]]}}
        

        [[en:{{FULLPAGENAME}}]]
        
        [[de:Handbuch:Erweiterung/BlueSpicePageTemplates]]
Line 38: Line 38:
 
==Configuration==
 
==Configuration==
  
 +
In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:
  
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}

Attachments

Discussions