Шаблоны в XWiki

Редактировал(а) hrapitan 01.11.2023

Копии.svg

Очень нужная и важная особенность системы управления корпоративной базой знаний XWiki это шаблоны.

Шаблоны, это заранее созданные страницы, а возможно и целые "деревья" страниц.

При создании новой страницы пользователю предлагается на выбор создать страницу абсолютно "чистой" т.е. пустой или на основе одного из заранее подготовленных шаблонов.

На форме создания страницы есть два поля. В одном из них содержится перечень доступных на данный момент шаблонов (2) а поле выше (1) позволяет отфильтровать шаблоны, что бывает удобно если их много.

image-20221121140104-1.png

У некоторых шаблонов могут быть заданы специфичные иконки для быстрого поиска, а также описание позволяющее понять для чего предназначен тот или иной шаблон.

Как устроен механизм шаблонов?

Об этом подробно можно прочитать в документации на систему, но если упростить, то каждый шаблон состоит из двух страниц.

Одна страница - это само содержание шаблона. Т.е. проще говоря обычная страница которая предварительно заполнена как образец.

На такой странице могут быть размещены все такие же объекты, что и на обычной.

Рисунки, таблицы, различные макросы и т.д.

Вторая страница - служебная. Она описывает шаблон так, чтобы система понимала, что считать шаблоном и как его применять.

По сути, для того чтобы добавить в систему новый шаблон, все что необходимо это добавить страницу второго типа и указать что использовать в качестве шаблона, а также где.

Важной особенностью механизма шаблонов в Xwiki является то, что шаблон может быть доступен только в определенных разделах.
Это позволяет внести в систему большое количество шаблонов, но при этом не мешать другим пользователям.
Например, в разделе "Сотрудники" могут быть шаблоны "Анкета сотрудника", "Учетная карточка" а в разделе "Подразделение службы качества" шаблон "Регламент службы качества".
И при этом, данные шаблоны будут видны только в своих разделах.

Как же создать новый шаблон?

Предлагаем простую пошаговую инструкцию.

Войдите как администратор системы в раздел настроек (1) и перейдите в раздел шаблоны (2).

Введите имя нового шаблона (3).

Укажите при необходимости место расположения (4) и нажмите создать (5)

image-20221121141723-1.png

Вы попадете на страницу описания шаблона.

Это такая же обычная страница XWiki но со специальными добавками которые превращают ее в описание шаблона.

Напомним концепцию XWiki: Всё является страницей

Лучше если вы дадите этой странице понятное название. Например, если вы хотите сделать шаблон "Совещание" то страницу поставщика шаблона стоит назвать "Поставщик шаблона Совещание".

Но на деле название роли не играет, так что вы можете сделать свой вариант.

image-20221121143230-2.png

На странице описания шаблона нужно указать

1 - Название поставщика

2 - Название шаблона. Таким его увидит пользователь в списке шаблонов.

3 - Описание. Также для пользователя в списке.

4 - Иконка. Можно выбрать из большого списка подходящую.

5 - Разделы (страницы) где будет доступен данный шаблон. Т.е. когда пользователь будет вызывать диалог создания страницы находясь на одной их указанных здесь, данный шаблон будет доступен.

Если ничего не указать, то будет доступен везде.

6 - Страница образец. Содержание шаблона.

7 - Где будет возможным сохранить созданную страницу.

При правильном применении с (5) и (8) позволяет содержать вашу корпоративную энциклопедию в полном порядке.

Заполнив эти поля и сохранив страницу, вы тут же сделаете шаблон доступным для выбора.

Очень просто.

Для того чтобы вы могли проверить как это работает, мы добавили к данной странице шаблон и его поставщика с ограничением действия только на эту страницу.

image-20221121144057-3.png

Вывод: В XWiki добавлен прекрасный механизм шаблонов который позволяет легко и просто шаблонизировать самые ходовые документы вашей компании.


Кстати, XWiki поддерживает структурные шаблоны. Т.е. если вы в качестве шаблона выберите страницу с подчиненными, то при создании новой страницы по такому шаблону, все дерево будет также создано.
Это позволяет легко делать шаблоны например проектов.