XWiki Syntax Guide
Редактировал(а) superadmin 2023/07/27 06:32
XWiki Syntax 2.1 » Programming » Macros
XWiki Syntax 2.1: 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 |
Macros in this wiki
| ID | Название | Категории | Описание | Видимость |
|---|---|---|---|---|
| activity | Активность | Notifications | Макрос Активность предоставляет информацию о последней активности пользователей XWiki. Перечисляет события создания, редактирования и удаления страниц, а также добавления комментариев, вложений и аннотаций. | Текущая Вики |
| async | Асинхронный макрос | Содержимое | Выполнить асинхронно и / или кэшировать содержимое макроса. | Глобально |
| attachmentGalleryPicker | Средство выбора вложений | Разработка | Средство выбора вложений на основе сетки. | Глобально |
| attachmentSelector | Выбор вложенных файлов | Разработка | Элемент управления свойствами объекта текущей страницы, в которой содержатся имена вложенных файлов текущей (или целевой) страницы. Позволяет загружать новые вложения и удалять существующие с целевой страницы. Если целевая страница не указана, то используется текущая. Свойства объекта сохраняются только для текущей страницы. | Текущая Вики |
| block | block | Blocks to display links | Глобально | |
| blogpostcreate | Blog Post Create | The 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. | Текущая Вики | |
| blogPostLayoutCards | Cards Blog Post Layout | This macro is used to display a blog post using the 'Cards' layout | Текущая Вики | |
| blogPostLayoutCompact | Blog Post Layout Compact | This macro is used to display a full blog post in a compact mode | Текущая Вики | |
| blogPostLayoutFull | Blog Post Layout Full | This macro is used to display a full blog post | Текущая Вики | |
| blogPostLayoutImage | Blog Post Layout Image | This macro is used to display a full blog post with a thumbnail image | Текущая Вики | |
| blogPostLayoutLink | Blog Post Layout Link | This macro is used to display a blog post as a simple link | Текущая Вики | |
| blogpostlist | Blog post list | The BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates. | Текущая Вики | |
| blogs | Список всех блогов | Макрос блогов используется для того, чтобы перечислять в реальном времени все блоги, доступные в вики. | Текущая Вики | |
| box | окно | Форматирование | Показать блок вокруг. | Глобально |
| cache | Кэш | Разработка | Кэширует контент. | Глобально |
| calc | calc | sales | CALC Macro | Глобально |
| chart | График | Содержимое | Показывает график полученный из различных источников данных | Глобально |
| children | Children | Навигация | 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-todo | Табличка "TODO" | Элементы содержания | Отображает табличку с предупреждением о том, что страница требует доработки в дальнейшем. Такие плашки удобно ставить на странице который находятся в стадии активной проработки как сигнал другим пользователям о том, что контент на странице может в скором времени измениться. | Глобально |
| code | Код | Форматирование | Подсвеченные части кода различных языков программирования | Глобально |
| colunsMacroHideExtra | Скрыть раздел информации о странице | Coluns, Форматирование, Администрирование | Данный макрос скрывает нижнюю часть документа с вкладками Комментарии, Вложения, История, Информация о странице если текущий пользователь не Администратор. Также скрываются ярлыки из меню страницы, которые позволяют увидеть данную информацию. | Текущая Вики |
| comment | Комментарий | Разработка | Позволяет вставлять комментарии в контент. Этот макрос ничего не выводит в текст страницы. | Глобально |
| container | Контейнер | Макет | Макрос для объединения нескольких групп и добавления декораций, как на выходе. | Глобально |
| content | Содержимое | Содержимое | Позволяет создавать контент в любой вики-разметке | Глобально |
| context | Контекст | Разработка | Исполняет содержимое в контексте переданных документов | Глобально |
| dashboard | Панель управления | Макет | Макрос для заполнения главной панели гаджетами. | Глобально |
| diagram | Diagram | Содержимое | Displays a diagram. | Текущая Вики |
| display | Показать страницу | Содержимое | Показать другие страницы в текущей. | Глобально |
| displayIcon | Icon | Содержимое | Display an icon. | Глобально |
| documents | Страницы | Содержимое | Показывает список страниц в таблице Livetable | Текущая Вики |
| documentTree | Дерево страниц | Навигация | Отображает дерево страниц XWiki. | Текущая Вики |
| error | Сообщение об ошибке | Форматирование | Показать сообщение об ошибке. | Глобально |
| example | Example | Форматирование | Shows an example and its source code. | Текущая Вики |
| footnote | Сноска | Содержимое | Генерирует сноску внизу страницы. | Глобально |
| gallery | Галерея | Макет | Показать изображения, найденные в указанном контенте в режиме слайд-шоу. | Глобально |
| glossaryEntries | glossaryEntries | Навигация | Lists all glossary entries from a glossary, as a list | Глобально |
| glossaryReference | GlossaryReference | Навигация | References a glossary entry | Глобально |
| groovy | Groovy | Разработка | Выполнить groovy-скрипт. | Глобально |
| html | HTML | Разработка | Вставить HTML или XHTML-код на страницу. | Глобально |
| icon | Font Awesome icon | Icons | Inserts a Font Awesome icon | Текущая Вики |
| iconPicker | Icon Picker | Разработка | Выберите значок в наборе значков XWiki. | Текущая Вики |
| id | ID | Навигация | Позволяет положить ссылку/расположение на страницу. Например, в HTML это называется якорями. Это позволяет указать расположение, например, в ссылках. | Глобально |
| include | Включить | Содержимое | Включить другие страницы в текущую. | Глобально |
| info | Информационное сообщение | Форматирование | Показать информационное сообщение. | Глобально |
| jwplayer | JW Player | Содержимое | JW Player - это встраиваемый медиаплеер с открытым исходным кодом для веб-сайтов, поддерживающий многие распространенные аудио и видео форматы. | Текущая Вики |
| liveData | Живые данные | Содержимое | Отображает динамические списки данных. | Глобально |
| mention | Упоминание Пользователя | Notifications | Вставьте упоминание пользователя. | Текущая Вики |
| menu | Меню | Навигация | Отображает меню, созданное с использованием простого синтаксиса вики (вложенные списки и ссылки). | Глобально |
| messageSender | Отправитель сообщения | Social | Элемент управления, который позволяет пользователям вводить сообщения, которые обрабатываются модулем Лента активности(MessageStream). | Текущая Вики |
| 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-страниц, без скачивания и импортирования. | Глобально |
| PDF Object Embed | This macro allows embedding a PDF file in a wiki page using the <object> tag. | Глобально | ||
| pdftoc | PDF Table of Contents | Внутренний | Generates the table of contents for the PDF export. | Глобально |
| pdfviewer | pdfviewer | content | PDF Viewer based on Mozilla pdf.js | Текущая Вики |
| putFootnotes | Вставить сноски | Содержимое | Отображать все сноски на странице. Если они отсутствуют, по умолчанию все сноски отображаются в конце страницы. | Глобально |
| python | Python | Разработка | Выполнить python-скрипт. | Глобально |
| redmine | Redmine Ticket | Listet Tickets vom Redmine Ticketsystem in einer Tabelle auf. | Глобально | |
| rss | RSS | Содержимое | Вывести последние записи из RSS-потока. | Глобально |
| script | Скрипт | Разработка | Исполнить скрипт в соответствующем интерпретаторе языка. | Глобально |
| sortable_tables | Sorteable Tables | Makes all tables in the content of the current page sortable. | Текущая Вики | |
| spaceindex | Страницы раздела | Устаревшие | Список страниц в разделе. | Текущая Вики |
| success | Сообщение об успешном событии | Форматирование | Выводит сообщение об успешном завершении. | Глобально |
| sum | sum | sales | SUM Macro | Глобально |
| summary | summary | sales | Summary Macro | Глобально |
| tabs | Tabbed view renderer | Creates tabbed view for content areas wrapped into <div /> with unique id (see macro home for details) | Текущая Вики | |
| tagcloud | Облако тегов | Содержимое | Отображать облако тегов для этой вики или указанного раздела, если имеется. | Текущая Вики |
| template | Шаблон | Разработка | Вставить шаблон. | Глобально |
| toc | Содержание | Навигация | Генерирует "Содержание". | Глобально |
| tooltip | Tooltip | Текущая Вики | ||
| translation | Перевод | Содержимое | Отобразить перевод сообщения. | Глобально |
| tree | Дерево | Навигация | Отображает древовидную иерархию, определенную содержимым макроса или параметром источника. | Текущая Вики |
| 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. | Глобально |