XWiki Syntax Guide

Última modificação por xcape em 2021/04/15 15:33

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	Name	Categorias	Description	Visibilidade
activity	Fluxo de Atividade	Notifications	Informa sobre o fluxo de atividades recentes dos usuários da wiki atual. Lista os eventos criar, editar e remover de páginas, comentários, anexos e anotações.	Current Wiki
async	Macro assíncrona	Conteúdo	Execute de forma assíncrona e/ou armazene em cache o conteúdo da macro.	Global
attachmentGalleryPicker	Attachment Picker	Desenvolvimento	Grid based attachment picker.	Global
attachmentSelector	Selecionador de Anexos	Desenvolvimento	Um controle a ser usado por propriedades de objetos do documento atual que deveriam conter o nome de um anexo de um documento destino. Permite subir novos anexos ou removê-los do documento destino. Se nenhum documento destino for informado, o documento atual será usado. As propriedades dos objetos, no entanto, são salvas somente no documento atual.	Current Wiki
box	Caixa	Formatação	Desenha uma caixa em volta de qualquer conteúdo.	Global
cache	Cache	Desenvolvimento	Faz cache de conteúdo.	Global
chart	Gráfico	Conteúdo	Permite exibir uma gráfico gerado de diversas fontes de dados	Global
children	Children	Navegação	Displays a tree of children pages of the current page	Current Wiki
code	Código	Formatação	Realça pedaços de código de várias linguagens de programação	Global
comment	Comentário	Desenvolvimento	Permite inserir comentários no fonte do conteúdo. Essa macro não exibe nada.	Global
container	Container	Disposição	Uma macro para englobar múltiplos grupos e adicionar elementos decorativos.	Global
content	Content	Conteúdo	Allows writing content in any wiki markup	Global
context	Contexto	Desenvolvimento	Executa um documento no contexto de outro documento informado	Global
dashboard	Painel de Controle	Disposição	Uma macro para definir um painel principal a ser preenchido como outros painéis.	Global
display	Exibir Página	Conteúdo	Exibir outras páginas na página atual.	Global
displayIcon	Icon	Conteúdo	Display an icon.	Global
documents	Documentos	Conteúdo	Mostra uma lista de documentos em uma tabela dinâmica	Current Wiki
documentTree	Page Tree	Navegação	Displays the tree of XWiki pages.	Current Wiki
error	Mensagem de Erro	Formatação	Mostar uma mensagem de erro.	Global
example	Example	Formatação	Shows an example and its source code.	Current Wiki
footnote	Rodapé	Conteúdo	Gera nota de rodapé para exibir no final da página.	Global
gallery	Galeria	Disposição	Mostra as imagens encontradas em determinado conteúdo usando visualização de slides.	Global
groovy	Groovy	Desenvolvimento	Executar um script Groovy.	Global
html	HTML	Desenvolvimento	Insere código HTML ou XHTML na página.	Global
iconPicker	Icon Picker	Desenvolvimento	Select an icon within the XWiki icon set.	Current Wiki
id	Id	Navegação	Permite colocar uma referência/localização numa página. Em HTML por exemplo isso é chamado âncora. Permite apontar para aquela localização em links por exemplo.	Global
include	Incluir Página	Conteúdo	Insere outras páginas na página atual.	Global
info	Mensagem de Informação	Formatação	Exibe uma mensagem de informação.	Global
liveData	Live Data	Conteúdo	Display dynamic lists of data.	Global
mention	User Mention	Notifications	Insert a user mention.	Current Wiki
menu	Menu	Navegação	Exibe um menu criado usando sintaxe wiki simples (listas e links aninhados).	Global
messageSender	Envia Mensagens	Social	Um conttrole que permite aos usuários enviar mensagens que vão ser tratadas pelo módulo MessageStream.	Current Wiki
notifications	Notifications	Notifications	Display notifications about events happened on the wiki.	Current Wiki
notificationsApplicationsPreferences	Notifications Applications Preferences	Notifications	Display the preferences of the current user about notification applications.	Current Wiki
notificationsAutoWatchPreferences	Notifications Auto Watch Preferences	Notifications	Display the preferences of the current user about auto watched pages.	Current Wiki
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Current Wiki
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Current 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.	Current Wiki
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Current Wiki
office	visualizador de Documentos Office	Conteúdo	Visualiza documentos office anexos (doc, ppt, xls, odt, odp, ods etc.) nas páginas da wiki sem precisar baixar ou importar os documentos.	Global
pdftoc	PDF Table of Contents	Interno	Generates the table of contents for the PDF export.	Global
putFootnotes	Coloque notas de rodapé	Conteúdo	Exibe todas as notas de rodapé da página. Se estiverem ausentes, todas as notas de rodapé serão exibidas por padrão no final da página.	Global
python	Python	Desenvolvimento	Executar um script Python.	Global
script	Script	Desenvolvimento	Executa um script na linguagem informada.	Global
spaceindex	Índice do Espaço	Descontinuado	Lista os documentos em um espaço.	Current Wiki
spaces	Espaços	Descontinuado	Mostra todos os espaços na wiki atual.	Current Wiki
success	Mensagem de Sucesso	Formatação	Exibe uma mensagem de sucesso.	Global
tagcloud	Nuvem de Marcadores	Conteúdo	Mostrar nuvem de marcadores da wiki atual ou de um espaço informado, se os marcadores existirem.	Current Wiki
template	Template	Desenvolvimento	Insert a template.	Global
toc	Índice	Navegação	Gerar Índice no documento.	Global
translation	Translation	Conteúdo	Display a translation message.	Global
tree	Tree	Navegação	Displays a tree hierarchy defined by the macro content or the source parameter.	Current Wiki
uiextension	UI Extension	Desenvolvimento	Insert a UI extension.	Global
uiextensions	UI Extensions	Desenvolvimento	Insert UI extensions.	Global
useravatar	Avatar de Usuário	Conteúdo	Permite exibir o avatar de um determinado usuário.	Global
velocity	Velocity	Desenvolvimento	Executa um script Velocity.	Global
warning	Mensagem de Aviso	Formatação	Exibe uma mensagem de aviso.	Global
wikimacrocontent	WikiMacro Content	Desenvolvimento	Display editable content of a wikimacro.	Global
wikimacroparameter	WikiMacro Parameter	Desenvolvimento	Display editable parameter of a wikimacro.	Global
wikis	Wikis	Navegação	Listar todas as wikis	Current Wiki
workspaces	Espaços de trabalho (Legado)	Descontinuado	Macro obsoleta que não deve ser usada aqui por motivos de compatibilidade. Em vez disso, use a macro "wikis".	Current Wiki

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

Roteiros

2.0 Scripts

XWiki suporta diversas linguagens de script.

Recurso	Sintaxe do XWiki 2.1
Script Velocity	{{velocity}} #set($var = "tanto faz") {{/velocity}}
Script Groovy	{{groovy}} def var = "tanto faz" {{/groovy}}