XWiki Syntax Guide

Редактировал(а) Дмитрий Копотев 2022/12/04 02:22

XWiki Syntax 2.1: Programming

Macros

2.0 Macros

There is only one kind of macro in XWiki Syntax 2.1, which is called by the syntax: {{macroname param1="value1" ... paramN="valueN"}}...{{/macroname}}. For macros without content there's a short notation: {{macroname param1="value1" ... paramN="valueN"/}}

Feature	XWiki Syntax 2.1	Result
Rendering Macro with a content	{{code language="java"}} System.out.println("Hello World!"); {{/code}}	System.out.println("Hello World!");
Rendering Macro without content	{{include reference="Space.Page"/}}	The referenced page is included in the current page

For the full list of available macros check the Extensions wiki.

Macros in this wiki

ID	Название	Категории	Описание	Видимость
toc	Содержание	Навигация	Генерирует "Содержание".	Глобально
iconPicker	Icon Picker	Разработка	Выберите значок в наборе значков XWiki.	Текущая Вики
wikimacrocontent	WikiMacro Content	Разработка	Display editable content of a wikimacro.	Глобально
example	Example	Форматирование	Shows an example and its source code.	Текущая Вики
mention	Упоминание Пользователя	Notifications	Вставьте упоминание пользователя.	Текущая Вики
async	Асинхронный макрос	Содержимое	Выполнить асинхронно и / или кэшировать содержимое макроса.	Глобально
spaceindex	Страницы раздела	Устаревшие	Список страниц в разделе.	Текущая Вики
box	окно	Форматирование	Показать блок вокруг.	Глобально
spaces	Разделы	Устаревшие	Показать все разделы wiki.	Текущая Вики
error	Сообщение об ошибке	Форматирование	Показать сообщение об ошибке.	Глобально
attachmentGalleryPicker	Средство выбора вложений	Разработка	Средство выбора вложений на основе сетки.	Глобально
video	Video	Содержимое	Display in your wiki page any video from Youtube, Dailymotion, Google Video or Vimeo.

Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported.

The video macro can also plays a DASH video (Dynamic Adaptive Streaming over HTTP).|Текущая Вики

warning	Предупреждение	Форматирование	Показывает предупреждение.	Глобально
messageSender	Отправитель сообщения	Social	Элемент управления, который позволяет пользователям вводить сообщения, которые обрабатываются модулем Лента активности(MessageStream).	Текущая Вики
children	Children	Навигация	Displays a tree of children pages of the current page	Текущая Вики
workspaces	Рабочие пространства (устаревшее)	Устаревшие	Устаревший макрос, который не следует использовать здесь из соображений совместимости. Пожалуйста, используйте вместо этого макрос "Вики".	Текущая Вики
display	Показать страницу	Содержимое	Показать другие страницы в текущей.	Глобально
translation	Перевод	Содержимое	Отобразить перевод сообщения.	Глобально
context	Контекст	Разработка	Исполняет содержимое в контексте переданных документов	Глобально
pdftoc	PDF Table of Contents	Внутренний	Generates the table of contents for the PDF export.	Глобально
info	Информационное сообщение	Форматирование	Показать информационное сообщение.	Глобально
tree	Дерево	Навигация	Отображает древовидную иерархию, определенную содержимым макроса или параметром источника.	Текущая Вики
liveData	Живые данные	Содержимое	Отображает динамические списки данных.	Глобально
rss	RSS	Содержимое	Вывести последние записи из RSS-потока.	Глобально
success	Сообщение об успешном событии	Форматирование	Выводит сообщение об успешном завершении.	Глобально
documentTree	Дерево страниц	Навигация	Отображает дерево страниц XWiki.	Текущая Вики
template	Шаблон	Разработка	Вставить шаблон.	Глобально
notificationsAutoWatchPreferences	Настройки уведомлений Автонаблюдения	Notifications	Отображение предпочтений текущего пользователя в отношении Автонаблюдения за страницами.	Текущая Вики
chart	График	Содержимое	Показывает график полученный из различных источников данных	Глобально
panel	Panel		Panel Macro	Глобально
container	Контейнер	Макет	Макрос для объединения нескольких групп и добавления декораций, как на выходе.	Глобально
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Текущая Вики
tagcloud	Облако тегов	Содержимое	Отображать облако тегов для этой вики или указанного раздела, если имеется.	Текущая Вики
activity	Активность	Notifications	Макрос Активность предоставляет информацию о последней активности пользователей XWiki. Перечисляет события создания, редактирования и удаления страниц, а также добавления комментариев, вложений и аннотаций.	Текущая Вики
python	Python	Разработка	Выполнить python-скрипт.	Глобально
comment	Комментарий	Разработка	Позволяет вставлять комментарии в контент. Этот макрос ничего не выводит в текст страницы.	Глобально
html	HTML	Разработка	Вставить HTML или XHTML-код на страницу.	Глобально
content	Содержимое	Содержимое	Позволяет создавать контент в любой вики-разметке	Глобально
script	Скрипт	Разработка	Исполнить скрипт в соответствующем интерпретаторе языка.	Глобально
useravatar	Аватар пользователя	Содержимое	Разрешить показывать аватар для определенного пользователя.	Глобально
office	Просмотрщик документов Office	Содержимое	Просмотреть вложения Office(doc, ppt, xls, odt, odp, ods и т.д.) внутри wiki-страниц, без скачивания и импортирования.	Глобально
gallery	Галерея	Макет	Показать изображения, найденные в указанном контенте в режиме слайд-шоу.	Глобально
uiextension	Расширение UI	Разработка	Вставить расширение UI.	Глобально
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Текущая Вики
uiextensions	Расширения UI	Разработка	Вставить UI расширения.	Глобально
dashboard	Панель управления	Макет	Макрос для заполнения главной панели гаджетами.	Глобально
putFootnotes	Добавить сноску	Содержимое	Показать определенные сноски. Если не определены, будут показаны все сноски в конце страницы.	Глобально
wikis	Вики	Навигация	Список всех вики	Текущая Вики
attachmentSelector	Выбор вложенных файлов	Разработка	Элемент управления свойствами объекта текущей страницы, в которой содержатся имена вложенных файлов текущей (или целевой) страницы. Позволяет загружать новые вложения и удалять существующие с целевой страницы. Если целевая страница не указана, то используется текущая. Свойства объекта сохраняются только для текущей страницы.	Текущая Вики
notificationsApplicationsPreferences	Настройки Приложений Уведомлений	Notifications	Отображение предпочтений текущего пользователя в отношении приложений уведомлений.	Текущая Вики
cache	Кэш	Разработка	Кэширует контент.	Глобально
menu	Меню	Навигация	Отображает меню, созданное с использованием простого синтаксиса вики (вложенные списки и ссылки).	Глобально
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Текущая Вики
documents	Страницы	Содержимое	Показывает список страниц в таблице Livetable	Текущая Вики
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.	Текущая Вики
notifications	Уведомления	Notifications	Отображать уведомления о событиях, произошедших в вики.	Текущая Вики
velocity	Velocity	Разработка	Исполняет Velocity-скрипт.	Глобально
wikimacroparameter	WikiMacro Parameter	Разработка	Display editable parameter of a wikimacro.	Глобально
groovy	Groovy	Разработка	Выполнить groovy-скрипт.	Глобально
footnote	Сноска	Содержимое	Генерирует сноску внизу страницы.	Глобально
jwplayer	JW Player	Содержимое	JW Player - это встраиваемый медиаплеер с открытым исходным кодом для веб-сайтов, поддерживающий многие распространенные аудио и видео форматы.	Текущая Вики
code	Код	Форматирование	Подсвеченные части кода различных языков программирования	Глобально
id	ID	Навигация	Позволяет положить ссылку/расположение на страницу. Например, в HTML это называется якорями. Это позволяет указать расположение, например, в ссылках.	Глобально
include	Включить	Содержимое	Включить другие страницы в текущую.	Глобально

HTML

2.0 HTML

In XWiki Syntax 2.1 HTML or XHTML must be entered by using the HTML macro.

XWiki Syntax 2.1	Result
{{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}}	HTML

Scripts

2.0 Scripts

XWiki supports several scripting languages.

Feature	XWiki Syntax 2.1
Velocity script	{{velocity}} #set ($var = "whatever") {{/velocity}}
Groovy script	{{groovy}} def var = "whatever" {{/groovy}}

Теги: