Difference between revisions of "Manual:Extension/BlueSpicePageTemplates"

[quality revision][quality revision]
(Changed categories.)
m


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]

  • Listed as template choices when a page is created
  • Create an independent new page with pre-filled content
  • 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]

Page template manager
Wiki admins 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.

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

Template fields[edit | edit source]

Editing a template in the Page template manager
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


Using page templates[edit | edit source]

Available page templates when creating a new page
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.


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==
        

        *Listed as template choices when a page is created
            
            *Create an independent new page with pre-filled content
            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==
        
        [[File:PageTemplates1a.png|thumb|Page template manager]]Wiki admins can create new page templates, as well as edit and remove existing ones in the Page templates manager, located under "Global actions".{{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===
        

        [[File:PageTemplates2.png|thumb|Editing a template in the Page template manager]]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
        

        ==Using page templates==
        
        [[File:PageTemplates3a.png|thumb|Available page templates when creating a new page]]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.
        

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

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

        [[Category:Content]]
        
        [[Category:Organization]]
Line 7: Line 7:
 
==Characteristics==
 
==Characteristics==
  
*Listed as template choices when a page is created
+
*Just for new pages
*Create an independent new page with pre-filled content
+
*Can be limited to certain namespaces
*Based on templates in the ''Template'' namespaces
+
*Can force Namespaces
 +
*Based on templates in the "Template" namespaces
 +
*Integrates with "PageForms"
  
 
==Creating a page template==
 
==Creating a page template==

Attachments

Discussions