XWiki Syntax Guide

Редактировал(а) Андрей Ганьков 2020/03/30 16:10

XWiki Syntax : Programming

Macros

1.0 Macros

There are two kinds of macros in XWiki Syntax 1.0:

Velocity macros (called using the #macroname(param1 ... paramN) syntax)
Radeox macros (called using the {macroname:param1=value1|...|paramN=valueN} syntax)

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

Feature	XWiki Syntax 1.0
Velocity Macro	#info("Some text")
Radeox Macro	{code:java} java content {code}

2.0 Macros

There is only one kind of macro in XWiki Syntax , 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	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	Название	Категории	Описание	Видимость
activity	Активность	Notifications	Макрос Активность предоставляет информацию о последней активности пользователей XWiki. Перечисляет события создания, редактирования и удаления страниц, а также добавления комментариев, вложений и аннотаций.	Текущая Вики
async	Асинхронный макрос	Содержимое	Выполнить асинхронно и / или кэшировать содержимое макроса.	Глобально
attachmentGalleryPicker	Средство выбора вложений	Разработка	Средство выбора вложений на основе сетки.	Глобально
attachments	Attachments		Displays the list of attachments for a given document using a live table.	Текущая Вики
attachmentSelector	Выбор вложенных файлов	Разработка	Элемент управления свойствами объекта текущей страницы, в которой содержатся имена вложенных файлов текущей (или целевой) страницы. Позволяет загружать новые вложения и удалять существующие с целевой страницы. Если целевая страница не указана, то используется текущая. Свойства объекта сохраняются только для текущей страницы.	Текущая Вики
box	окно	Форматирование	Показать блок вокруг.	Глобально
cache	Кэш	Разработка	Кэширует контент.	Глобально
chart	График	Содержимое	Показывает график полученный из различных источников данных	Глобально
children	Children	Навигация	Displays a tree of children pages of the current page	Текущая Вики
code	Код	Форматирование	Подсвеченные части кода различных языков программирования	Глобально
column	Column		declares a column in a columned section	Глобально
comment	Комментарий	Разработка	Позволяет вставлять комментарии в контент. Этот макрос ничего не выводит в текст страницы.	Глобально
container	Контейнер	Макет	Макрос для объединения нескольких групп и добавления декораций, как на выходе.	Глобально
content	Содержимое	Содержимое	Позволяет создавать контент в любой вики-разметке	Глобально
context	Контекст	Разработка	Исполняет содержимое в контексте переданных документов	Глобально
dashboard	Панель управления	Макет	Макрос для заполнения главной панели гаджетами.	Глобально
display	Показать страницу	Содержимое	Показать другие страницы в текущей.	Глобально
displayIcon	Icon	Содержимое	Display an icon.	Глобально
documents	Страницы	Содержимое	Показывает список страниц в таблице Livetable	Текущая Вики
documentTree	Дерево страниц	Навигация	Отображает дерево страниц XWiki.	Текущая Вики
error	Сообщение об ошибке	Форматирование	Показать сообщение об ошибке.	Глобально
example	Example	Форматирование	Shows an example and its source code.	Текущая Вики
footnote	Сноска	Содержимое	Генерирует сноску внизу страницы.	Глобально
gallery	Галерея	Макет	Показать изображения, найденные в указанном контенте в режиме слайд-шоу.	Глобально
groovy	Groovy	Разработка	Выполнить groovy-скрипт.	Глобально
html	HTML	Разработка	Вставить HTML или XHTML-код на страницу.	Глобально
iconPicker	Icon Picker	Разработка	Выберите значок в наборе значков XWiki.	Текущая Вики
id	ID	Навигация	Позволяет положить ссылку/расположение на страницу. Например, в HTML это называется якорями. Это позволяет указать расположение, например, в ссылках.	Глобально
include	Включить	Содержимое	Включить другие страницы в текущую.	Глобально
info	Информационное сообщение	Форматирование	Показать информационное сообщение.	Глобально
jwplayer	JW Player	Содержимое	JW Player - это встраиваемый медиаплеер с открытым исходным кодом для веб-сайтов, поддерживающий многие распространенные аудио и видео форматы.	Текущая Вики
liveData	Живые данные	Содержимое	Отображает динамические списки данных.	Глобально
mention	Упоминание Пользователя	Notifications	Вставьте упоминание пользователя.	Текущая Вики
menu	Меню	Навигация	Отображает меню, созданное с использованием простого синтаксиса вики (вложенные списки и ссылки).	Глобально
messageSender	Отправитель сообщения	Social	Элемент управления, который позволяет пользователям вводить сообщения, которые обрабатываются модулем Лента активности(MessageStream).	Текущая Вики
missingLicenseMessage	Missing License Message	Внутренний	Display an error message when the extension does not have a valid license.	Глобально
notifications	Уведомления	Notifications	Отображать уведомления о событиях, произошедших в вики.	Текущая Вики
notificationsApplicationsPreferences	Настройки Приложений Уведомлений	Notifications	Отображение предпочтений текущего пользователя в отношении приложений уведомлений.	Текущая Вики
notificationsAutoWatchPreferences	Настройки уведомлений Автонаблюдения	Notifications	Отображение предпочтений текущего пользователя в отношении Автонаблюдения за страницами.	Текущая Вики
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Текущая Вики
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Текущая Вики
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.	Текущая Вики
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Текущая Вики
office	Просмотрщик документов Office	Содержимое	Просмотреть вложения Office(doc, ppt, xls, odt, odp, ods и т.д.) внутри wiki-страниц, без скачивания и импортирования.	Глобально
pdftoc	PDF Table of Contents	Внутренний	Generates the table of contents for the PDF export.	Глобально
poll	Poll		Displays the results of a poll.	Текущая Вики
pollsrecent	Recent Polls		Displays the N most recent polls.	Текущая Вики
putFootnotes	Вставить сноски	Содержимое	Отображать все сноски на странице. Если они отсутствуют, по умолчанию все сноски отображаются в конце страницы.	Глобально
python	Python	Разработка	Выполнить python-скрипт.	Глобально
script	Скрипт	Разработка	Исполнить скрипт в соответствующем интерпретаторе языка.	Глобально
section	Section		A macro to enclose columned text	Глобально
success	Сообщение об успешном событии	Форматирование	Выводит сообщение об успешном завершении.	Глобально
tagcloud	Облако тегов	Содержимое	Отображать облако тегов для этой вики или указанного раздела, если имеется.	Текущая Вики
template	Шаблон	Разработка	Вставить шаблон.	Глобально
toc	Содержание	Навигация	Генерирует "Содержание".	Глобально
tooltip	Tooltip			Текущая Вики
translation	Перевод	Содержимое	Отобразить перевод сообщения.	Глобально
tree	Дерево	Навигация	Отображает древовидную иерархию, определенную содержимым макроса или параметром источника.	Текущая Вики
uiextension	Расширение UI	Разработка	Вставить расширение UI.	Глобально
uiextensions	Расширения UI	Разработка	Вставить UI расширения.	Глобально
useravatar	Аватар пользователя	Содержимое	Разрешить показывать аватар для определенного пользователя.	Глобально
velocity	Velocity	Разработка	Исполняет Velocity-скрипт.	Глобально
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	Предупреждение	Форматирование	Показывает предупреждение.	Глобально
wikimacrocontent	WikiMacro Content	Разработка	Display editable content of a wikimacro.	Глобально
wikimacroparameter	WikiMacro Parameter	Разработка	Display editable parameter of a wikimacro.	Глобально
wikis	Вики	Навигация	Список всех вики	Текущая Вики
workspaces	Рабочие пространства (устаревшее)	Устаревшие	Устаревший макрос, который не следует использовать здесь из соображений совместимости. Пожалуйста, используйте вместо этого макрос "Вики".	Текущая Вики

HTML

1.0 HTML

It is possible to enter HTML markup directly in the text in XWiki Syntax 1.0.

XWiki Syntax 1.0	Result
<abbr title="HyperText Markup Language">HTML</abbr>	HTML

2.0 HTML

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

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

Scripts

1.0 Scripts

In XWiki Syntax 1.0 it was possible to enter Velocity scripts anywhere directly in the page. This can lead to issues for example when the user was involuntarily entering Velocity content. It is also performance hungry for pages not requiring Velocity content. There are several other technical limitations. Same goes for entering Groovy scripts.

Feature	XWiki Syntax 1.0
Velocity script	#set ($var = "whatever")
Groovy script	<% def var = "whatever" %>

2.0 Scripts

XWiki supports several scripting languages.

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