У межах бази знань ви можете виявити, що бажаєте включити один і той самий блок вмісту в декілька статей. Ви можете скопіювати та вставити цей вміст до кількох сторінок, але потім, якщо цей вміст потрібно змінити, вам доведеться оновити його кілька разів на різних сторінках. Використовуючи теги включення, ви можете включати в статті інші сторінки, а також включати окремі блоки вмісту з інших сторінок.
Огляд
Деякі нюанси, які варто врахувати при повторному використанні вмісту сторінки за допомогою тегів включення:
Дозволи застосовуються до включень, тому вміст буде включений лише зі сторінок, в яких поточний користувач має дозвіл на перегляд. Це пов'язано з тим, що включення не є очевидними або прозорими при перегляді сторінки, тому користувач може легко поділитися вмістом з обмеженим доступом з не привілейованим користувачем, не звертаючи уваги на налаштування дозволів.
Включення працюють до трьох рівнів вкладеності, обмежених для забезпечення продуктивності системи та уникнення проблем рекурсії.
Включений вміст не буде індексований як шуканий вміст для сторінок, в які вони включені.
Включений вміст не буде відображатися в тексті попереднього перегляду.
Додавання тегів
Для включення вмісту сторінки у іншу сторінку ви можете використовувати наступний синтаксис:
{{@page_id}} або {{@page_id#content_id}} .
Ось деякі приклади використання:
{{@5}} - Включає весь вміст сторінки з ідентифікатором ‘5’.
{{@10#bkmrk-copyright-year}} - Включає вміст елемента з ідентифікатором bkmrk-copyright-year на сторінці з ідентифікатором ‘10’.
Ви просто вводите це у редакторі сторінок, і коли сторінка буде у режимі перегляду, вміст буде динамічно відображатися. Це означає, що ви можете оновлювати вміст і зміни будуть відображатися на будь-якій сторінці, на яку включено цей вміст.
Отримання тегів
Знаходження ідентифікатора сторінки може бути складним, тому швидкий і простий спосіб знайти теги включення вбудовано в базу знань. Перегляньте сторінку з вмістом, який ви хочете повторно використовувати. Використовуйте мишку, щоб виділити деякий вміст, який ви хочете використовувати знову, і ви побачите спливаюче вікно.
За замовчуванням воно містить пряме посилання на цей вміст. Якщо ви натиснете значок посилання зліва, воно зміниться на показ тегу включення для цього вмісту. Просто скопіюйте це та вставте на іншу сторінку. Видаліть # та ідентифікатор вмісту, щоб включити весь вміст сторінки замість одного блоку.
Примусове використання ідентифікаторів вмісту
При включенні конкретного блоку вмісту використовується ідентифікатор блоку (частина після символа #). За замовчуванням вони генеруються базою знань при збереженні сторінки. Якщо ви використовуєте редактор WYSIWYG, ідентифікатор залишиться таким самим, поки блок не буде видалено або переформатовано. У редакторі Markdown він змінюється при кожному збереженні на основі вмісту, тому, хоча він може залишитися таким самим, існує велика ймовірність зміни ID. Тому рекомендується примусово вказувати ID, якщо ви використовуєте вміст для включення.
Редактор WYSIWYG
У редакторі WYSIWYG ви можете примусово вказати ID, перейшовши до перегляду вихідного коду і додавши його вручну:
Редактор Markdown
У редакторі Markdown ви можете просто вставити HTML з ідентифікатором, щоб забезпечити, що він не буде змінюватися:
# Old Content
Text
# Revised with ID
<p id="bkmrk-include-copyright-text">Text</p>Пошук сторінки по тегу
У деяких випадках ви можете стикнутися з тегом включення і бажати знайти сторінку, вміст якої було включено. Це можна зробити, використовуючи прямі посилання на сторінки бази знань, які мають формат https://your_hurma.hurma.work/wiki/link/<page_id>.
Візьміть числовий ідентифікатор (розташований після символу @, але перед # у разі його наявності) з тегу включення, а потім використовуйте його як <page_id> у зазначеному форматі URL, і вас перенаправлять на джерело сторінки.
Технічні нюанси використання тегів
База знань намагається бути розумною з включеннями, щоб належним чином обробляти різні типи вмісту та відповідати правилам HTML. Нижче наведено деякі рішення, які база знань приймає при розборі включень:
Якщо включено конкретний розділ, база знань отримає та включить внутрішній вміст цього розділу в більшості випадків, окрім випадків, коли розділ потрібно використовувати як ціле, у такому разі весь блок буде використовуватися як ціле. Приклади цього включають таблиці, списки та блоки коду.
Якщо включені цілі блоки, цілі сторінки або діапазони вмісту, база знань намагатиметься структурувати вміст для уникнення вкладених абзаців, які є недійсними в HTML і можуть викликати проблеми, коли браузери намагаються автоматично виправити їх. Якщо це буде доцільно, буде зроблено спробу визначити точне місцезнаходження, хоча в деяких випадках вміст може бути переміщено до/після розділу, до якого він включений.
Ідентифікатори секцій вмісту будуть дубльовані після розбору включень, що може призвести до динамічної зміни ідентифікаторів вмісту сторінки після завантаження вмісту сторінки.