XWiki Syntax Guide

Редактировал(а) Coluns 28.10.2022

XWiki Syntax 2.1 » Programming

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"/}}

FeatureXWiki Syntax 2.1Result
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Средство выбора вложенийРазработкаСредство выбора вложений на основе сетки.Глобально
attachmentSelectorВыбор вложенных файловРазработкаЭлемент управления свойствами объекта текущей страницы, в которой содержатся имена вложенных файлов текущей (или целевой) страницы. Позволяет загружать новые вложения и удалять существующие с целевой страницы. Если целевая страница не указана, то используется текущая. Свойства объекта сохраняются только для текущей страницы.Текущая Вики
blockblockBlocks to display linksГлобально
blogpostcreateBlog Post CreateThe Blog Post Create macro is used to insert a post creation form. The macro takes a blog descriptor document as parameter. The new blog posts will belongs to the blog specified in the parameter.Текущая Вики
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutТекущая Вики
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeТекущая Вики
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postТекущая Вики
blogPostLayoutImageBlog Post Layout ImageThis macro is used to display a full blog post with a thumbnail imageТекущая Вики
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkТекущая Вики
blogpostlistBlog post listThe BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates.Текущая Вики
blogsСписок всех блоговМакрос блогов используется для того, чтобы перечислять в реальном времени все блоги, доступные в вики.Текущая Вики
boxокноФорматированиеПоказать блок вокруг.Глобально
cacheКэшРазработкаКэширует контент.Глобально
calccalcsalesCALC MacroГлобально
chartГрафикСодержимоеПоказывает график полученный из различных источников данныхГлобально
childrenChildrenНавигацияDisplays a tree of children pages of the current pageТекущая Вики
cl-plate-adviceТабличка "Полезный совет"Информационные, табличкиОтображает табличку с полезным советомГлобально
cl-plate-helpТабличка "Информация о поддержке"Отображает табличку с информацией о способах обращения в поддержку.
Такие плашки удобно ставить на страницах с инструкциями по использованию системы.
Глобально
cl-plate-infoТабличка "Информация о разделе"Отображает табличку с информацией о текущей странице или разделе.Глобально
cl-plate-moderatorТабличка "Редактируется модератором"Элементы содержанияОтображает табличку с предупреждением о том, что страница редактируется модератором.Глобально
cl-plate-objectТабличка "Внимание объекты"Элементы содержанияОтображает табличку с предупреждением о наличии на странице скрытых объектов.Глобально
cl-plate-statusПлашка статусаЭлементы содержанияВыводит плашку статуса на страницу и позволяет менять статус.Глобально
cl-plate-todoТабличка "TODO"Элементы содержанияОтображает табличку с предупреждением о том, что страница требует доработки в дальнейшем.

Такие плашки удобно ставить на странице который находятся в стадии активной проработки как сигнал другим пользователям о том, что контент на странице может в скором времени измениться.
Глобально
codeКодФорматированиеПодсвеченные части кода различных языков программированияГлобально
colunsMacroHideExtraСкрыть раздел информации о страницеАдминистрирование, Форматирование, ColunsДанный макрос скрывает нижнюю часть документа с вкладками Комментарии, Вложения, История, Информация о странице если текущий пользователь не Администратор.
Также скрываются ярлыки из меню страницы, которые позволяют увидеть данную информацию.
Глобально
commentКомментарийРазработкаПозволяет вставлять комментарии в контент. Этот макрос ничего не выводит в текст страницы.Глобально
containerКонтейнерМакетМакрос для объединения нескольких групп и добавления декораций, как на выходе.Глобально
contentСодержимоеСодержимоеПозволяет создавать контент в любой вики-разметкеГлобально
contextКонтекстРазработкаИсполняет содержимое в контексте переданных документовГлобально
dashboardПанель управленияМакетМакрос для заполнения главной панели гаджетами.Глобально
diagramДиаграммаСодержимоеПозволяет редактировать и отображать диаграммы.Текущая Вики
displayПоказать страницуСодержимоеПоказать другие страницы в текущей.Глобально
displayIconIconСодержимоеDisplay an icon.Глобально
documentsСтраницыСодержимоеПоказывает список страниц в таблице LivetableТекущая Вики
documentTreeДерево страницНавигацияОтображает дерево страниц XWiki.Текущая Вики
errorСообщение об ошибкеФорматированиеПоказать сообщение об ошибке.Глобально
exampleExampleФорматированиеShows an example and its source code.Глобально
faqFAQLists FAQ entriesТекущая Вики
footnoteСноскаСодержимоеГенерирует сноску внизу страницы.Глобально
galleryГалереяМакетПоказать изображения, найденные в указанном контенте в режиме слайд-шоу.Глобально
glossaryglossaryНавигацияLists all the Glossary Entries located under the current page, in a tableТекущая Вики
glossaryEntriesglossaryEntriesНавигацияLists all glossary entries from a glossary, as a listГлобально
glossaryReferenceGlossaryReferenceНавигацияReferences a glossary entryГлобально
groovyGroovyРазработкаВыполнить groovy-скрипт.Глобально
htmlHTMLРазработкаВставить HTML или XHTML-код на страницу.Глобально
iconFont Awesome iconIconsInserts a Font Awesome iconТекущая Вики
iconPickerIcon PickerРазработкаВыберите значок в наборе значков XWiki.Текущая Вики
idIDНавигацияПозволяет положить ссылку/расположение на страницу. Например, в HTML это называется якорями. Это позволяет указать расположение, например, в ссылках.Глобально
includeВключитьСодержимоеВключить другие страницы в текущую.Глобально
infoИнформационное сообщениеФорматированиеПоказать информационное сообщение.Глобально
jwplayerJW PlayerСодержимоеJW Player - это встраиваемый медиаплеер с открытым исходным кодом для веб-сайтов, поддерживающий многие распространенные аудио и видео форматы.Текущая Вики
liveDataЖивые данныеСодержимоеОтображает динамические списки данных.Глобально
mentionУпоминание ПользователяNotificationsВставьте упоминание пользователя.Текущая Вики
menuМенюНавигацияОтображает меню, созданное с использованием простого синтаксиса вики (вложенные списки и ссылки).Глобально
messageSenderОтправитель сообщенияSocialЭлемент управления, который позволяет пользователям вводить сообщения, которые обрабатываются модулем Лента активности(MessageStream).Текущая Вики
notificationsУведомленияNotificationsОтображать уведомления о событиях, произошедших в вики.Текущая Вики
notificationsApplicationsPreferencesНастройки Приложений УведомленийNotificationsОтображение предпочтений текущего пользователя в отношении приложений уведомлений.Текущая Вики
notificationsAutoWatchPreferencesНастройки уведомлений АвтонаблюденияNotificationsОтображение предпочтений текущего пользователя в отношении Автонаблюдения за страницами.Текущая Вики
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Текущая Вики
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Текущая Вики
notificationsFiltersPreferencesNotifications Filters Preferences (deprecated)NotificationsDisplay 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.
Текущая Вики
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Текущая Вики
officeПросмотрщик документов OfficeСодержимоеПросмотреть вложения Office(doc, ppt, xls, odt, odp, ods и т.д.) внутри wiki-страниц, без скачивания и импортирования.Глобально
pdfPDF Object EmbedThis macro allows embedding a PDF file in a wiki page using the <object> tag.Глобально
pdftocPDF Table of ContentsВнутреннийGenerates the table of contents for the PDF export.Глобально
pdfviewerpdfviewercontentPDF Viewer based on Mozilla pdf.jsТекущая Вики
plantumlPlantUMLСодержимоеConvert various text input formats into diagram images using PlantUML.Глобально
putFootnotesВставить сноскиСодержимоеОтображать все сноски на странице. Если они отсутствуют, по умолчанию все сноски отображаются в конце страницы.Глобально
pythonPythonРазработкаВыполнить python-скрипт.Глобально
redmineRedmine TicketListet Tickets vom Redmine Ticketsystem in einer Tabelle auf.Глобально
rssRSSСодержимоеВывести последние записи из RSS-потока.Глобально
scriptСкриптРазработкаИсполнить скрипт в соответствующем интерпретаторе языка.Глобально
showhideshowhidecontentShow Hide MacroТекущая Вики
sortable_tablesSorteable TablesMakes all tables in the content of the current page sortable.Текущая Вики
spaceindexСтраницы разделаУстаревшиеСписок страниц в разделе.Текущая Вики
successСообщение об успешном событииФорматированиеВыводит сообщение об успешном завершении.Глобально
sumsumsalesSUM MacroГлобально
summarysummarysalesSummary MacroГлобально
tagcloudОблако теговСодержимоеОтображать облако тегов для этой вики или указанного раздела, если имеется.Текущая Вики
templateШаблонРазработкаВставить шаблон.Глобально
tocСодержаниеНавигацияГенерирует "Содержание".Глобально
tooltipTooltipТекущая Вики
translationПереводСодержимоеОтобразить перевод сообщения.Глобально
treeДеревоНавигацияОтображает древовидную иерархию, определенную содержимым макроса или параметром источника.Текущая Вики
uiextensionРасширение UIРазработкаВставить расширение UI.Глобально
uiextensionsРасширения UIРазработкаВставить UI расширения.Глобально
useravatarАватар пользователяСодержимоеРазрешить показывать аватар для определенного пользователя.Глобально
velocityVelocityРазработкаИсполняет Velocity-скрипт.Глобально
videoVideoСодержимое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ПредупреждениеФорматированиеПоказывает предупреждение.Глобально
wikimacrocontentWikiMacro ContentРазработкаDisplay editable content of a wikimacro.Глобально
wikimacroparameterWikiMacro ParameterРазработкаDisplay editable parameter of a wikimacro.Глобально
wikisВикиНавигацияСписок всех викиТекущая Вики
workspacesРабочие пространства (устаревшее)УстаревшиеУстаревший макрос, который не следует использовать здесь из соображений совместимости. Пожалуйста, используйте вместо этого макрос "Вики".Текущая Вики
xcarouselXCarousel MacroDisplay a carousel.Текущая Вики

HTML

2.0 HTML

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

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

Scripts

2.0 Scripts

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