BookStack Code Mirror - website/blob - content/docs/user/page-templates.md

1 +++

2 title = "Page Templates"

3 date = "2022-11-24"

4 type = "user-doc"

5 slug = "page-templates"

6 +++

7

8 Within BookStack you can mark a page as a template so that its content

9 can easily be reused when editing and creating pages.

10 This can be super useful when you need to create many pages following

11 a similar format.

12

13 ## Creating a Page Template

14

15 A page template in BookStack is simply a normal page that has been marked as a template.

16 Start by creating/editing the page you want to use as a template.

17 Within the editor sidebar you should see a templates tab.

18 Within this tab you should find a "Page is a template" checkbox.

19 Simply check that option and save the page to make the page become a template.

20 If you don't see that checkbox, you likely lack the "Manage page templates" role system permission.

21

22 ![Page edit view showing the templates tab and mentioned checkbox](/images/docs/user/template_checkbox.png)

23

24 Note: Visibility of page templates are controlled via visibility of the page itself. If a user lacks permission to view the page marked as a template, it will not show as an available template for them.

25

26 ## Using Page Templates

27

28 Page templates can be accessed when creating or editing a page.

29 Within the editor sidebar you should see a templates tab.

30 If you have templates available they will be listed in this area.

31 A search bar will also show for easy searching of templates.

32

33 There are multiple ways to add a template into a page:

34

35 - Select the template box itself to replace the editor content with contents of the template.

36 - Select the up arrow of the template box to prepend its contents to the editor.

37 - Select the down arrow of the template box to append its contents to the editor.

38 - Drag the template box into the editor to insert its contents into the dragged location.

39

40 ![Dragging a template into the page editor](/images/docs/user/template_dragging.png)

41

42 Keep in mind that using a template simply copies its content at time-of-use, it is not

43 a "live" connection to the template page, and updating the template page won't affect pages that have previously used it as a template.