Посібник із синтаксису XWiki

Остання зміна 2024/05/06 14:59 автором Ashterix

Синтаксис XWiki 2.1: Програмування

Макроси

2.0 Macros

У синтаксисі XWiki є лише один тип макросу 2.1, який викликається за допомогою синтаксису: {{macroname param1="value1" ... paramN=" valueN"}}...{{/macroname}}. Для макросів без вмісту є коротке позначення: {{macroname param1="value1" ... paramN="valueN"/}}

Функція	Синтаксис XWiki 2.1	Результат
Виконання макросу з вмістом	{{code language="java"}} System.out.println("Hello World!"); {{/code}}	System.out.println("Hello World!");
Виконання макросу без вмісту	{{include reference="Space.Page"/}}	Сторінка, на яку посилається, включена до поточної сторінки

Повний список доступних макросів див. у Extensions wiki.

Макроси в цій вікі

ID	Назва	Категорії	Опис	Видимість
activity	Діяльність	Notifications	Макрос Діяльність надає інформацію про нещодавні дії користувачів даної XWiki. В перелік входять дії створення, редагування та видалення сторінок, а також коментарі, прикріплення та примітки.	Поточна Wiki
async	Асинхронний макрос	Вміст	Виконувати асинхронно та/або кешувати вміст макросу.	Глобально
attachmentGalleryPicker	Вибір вкладень	Розробка	Засіб вибору вкладень на основі сітки.	Глобально
attachmentSelector	Вибір вкладених файлів	Розробка	Елемент керування, який буде використано для властивостей об’єктів поточної сторінки, які мають містити назву вкладення з поточної (або заданої) сторінки. Дозволяє завантаження нових вкладень і їх видалення із зазначеної сторінки. Якщо не задано жодної сторінки, буде використано поточну сторінку. Властивості об’єкта зберігаються лише на поточній сторінці.	Поточна Wiki
box	Рамка	Форматування	Малює рамку навколо заданого вмісту.	Глобально
cache	Кеш	Розробка	Кеш контент.	Глобально
chart	Графік	Вміст	Зображає графіки, згенеровані з різних джерел даних	Глобально
children	Children	Навігація	Displays a tree of children pages of the current page	Поточна Wiki
code	Код	Форматування	Підсвічує кольором фрагменти коду із різних мов програмування	Глобально
comment	Коментар	Розробка	Дозволяє додавати коментарі до джерела контенту. Цей макрос нічого не виводить.	Глобально
container	Контейнер	Макет	Макрос для того, щоб охопити декілька груп і додати декорації, наприклад як у макеті.	Глобально
content	Content	Вміст	Allows writing content in any wiki markup	Глобально
context	Контекст	Розробка	Виконує вміст у контексті документів, що передаються	Глобально
dashboard	Інформаційна панель	Макет	Макрос для визначення заповнення інформації панелі гаджетами.	Глобально
display	Показати	Вміст	Показати інші сторінки у поточній.	Глобально
displayIcon	Icon	Вміст	Display an icon.	Глобально
documents	Сторінки	Вміст	Відображає список сторінок в Livetable	Поточна Wiki
documentTree	Дерево сторінок	Навігація	Показує дерево сторінок XWiki.	Поточна Wiki
error	Повідомлення про помилку	Форматування	Показує примітку з помилкою.	Глобально
example	Приклад	Форматування	Показує приклад і його вихідний код.	Поточна Wiki
faq	FAQ		Lists FAQ entries	Поточна Wiki
footnote	Виноска	Вміст	Створює виноску для зображення в кінці сторінки.	Глобально
gallery	Галерея	Макет	Показує зображення, знайдені за наданим контентом, за допомогою перегляду слайдів.	Глобально
groovy	Groovy	Розробка	Виконати скрипт groovy.	Глобально
highlight	Highlight	Вміст	highlight.JS integration	Поточна Wiki
html	HTML	Розробка	Вставка в сторінку коду HTML або XHTML.	Глобально
iconPicker	Вибір піктограм	Розробка	Виберіть піктограму із набору піктограм XWiki.	Поточна Wiki
id	Id	Навігація	Дозволяє створити закладку для посилання на сторінці. В HTML, наприклад, це називається "якір" (Anchor). Він дозволяє вказувати на це місце, наприклад в посиланнях.	Глобально
include	Включити	Вміст	Включати інші сторінки до поточної сторінки.	Глобально
info	Інформаційне повідомлення	Форматування	Показує примітку з інформацією.	Глобально
liveData	Динамічні Дані	Вміст	Відобразити динамічні списки даних.	Глобально
mention	Згадування користувача	Notifications	Вставити згадку про користувача.	Поточна Wiki
menu	Меню	Навігація	Відображає меню, створене з використанням простого вікі-синтаксису (вкладені списки та посилання).	Глобально
messageSender	Відправник повідомлення	Social	Керування, яке дозволяє користувачам вводити повідомлення, які обробляються модулем MessageStream.	Поточна Wiki
notifications	Сповіщення	Notifications	Показувати сповіщення про події, що відбулися у вікі.	Поточна Wiki
notificationsApplicationsPreferences	Notifications Applications Preferences	Notifications	Показати налаштування поточного користувача щодо додатків сповіщень.	Поточна Wiki
notificationsAutoWatchPreferences	Notifications Auto Watch Preferences	Notifications	Display the preferences of the current user about auto watched pages.	Поточна Wiki
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Поточна Wiki
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Поточна Wiki
notificationsFiltersPreferences	Notifications Filters Preferences (deprecated)	Notifications	Display the preferences of the current user about notification filters. This macro is now deprecated in favor of Custom Notifications Filters Preferences or System Notifications Filters Preferences.	Поточна Wiki
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Поточна Wiki
office	Переглядач документів Office	Вміст	Переглядати офісні файли (doc, ppt, xls, odt, odp, ods тощо) на вікі-сторінках, не завантажуючи та не імпортуючи їх.	Глобально
pdftoc	PDF Table of Contents	Внутрішній	Generates the table of contents for the PDF export.	Глобально
putFootnotes	Вставити виноски	Вміст	Зображує виноски зі сторінки. Якщо таких немає, всі виноски будуть показані у кінці сторінки.	Глобально
python	Python	Розробка	Виконує скрипт python.	Глобально
script	Скрипт	Розробка	Виконує скрипт написаний вказаною мовою.	Глобально
spaceindex	Індекс простору	Застарілий	Список сторінок у просторі.	Поточна Wiki
spaces	Простори	Застарілий	Показує всі простори цієї вікі.	Поточна Wiki
spoiler	spoiler			Глобально
success	Повідомлення про успіх	Форматування	Показує примітку про успіх.	Глобально
tagcloud	Хмара тегів	Вміст	Показує хмару тегів у цій вікі або у вказаному просторі, якщо такі є.	Поточна Wiki
template	Шаблон	Розробка	Додати шаблон.	Глобально
toc	Зміст	Навігація	Створює зміст.	Глобально
translation	Переклад	Вміст	Показати переклад повідомлень.	Глобально
tree	Дерево	Навігація	Відображає ієрархію дерева, визначену вмістом макросу або вихідним параметром.	Поточна Wiki
uiextension	Розширення UI	Розробка	Додати розширення UI.	Глобально
uiextensions	Розширення UI	Розробка	Додати розширення UI.	Глобально
useravatar	Аватар користувача	Вміст	Дозволяє показувати аватар конкретного користувача.	Глобально
velocity	Velocity	Розробка	Виконує скрипт Velocity.	Глобально
warning	Повідомлення із попередженням	Форматування	Показує примітку з попередженням.	Глобально
wikimacrocontent	WikiMacro Content	Розробка	Display editable content of a wikimacro.	Глобально
wikimacroparameter	WikiMacro Parameter	Розробка	Display editable parameter of a wikimacro.	Глобально
wikis	Вікі	Навігація	Список усіх вікі	Поточна Wiki
workspaces	Робочі простори (застарілі)	Застарілий	Застарілий макрос, який не слід використовувати тут з причин сумісності. Будь ласка, використовуйте замість цього макрос "wikis".	Поточна Wiki

HTML

2.0 HTML

У синтаксисі XWiki 2.1 HTML або XHTML потрібно вводити за допомогою HTML макроса.

Синтаксис XWiki 2.1	Результат
{{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}}	HTML

Скрипти

2.0 Scripts

XWiki підтримує кілька мов сценаріїв.

Функція	Синтаксис XWiki 2.1
Скрипт Velocity	(( {{velocity}} #set ($var = "whatever") {{/velocity}} )))
Скрипт Groovy	{{groovy}} def var = "whatever" {{/groovy}}