Guía de Sintaxis XWiki

Última modificación por dFa el 2024/09/06 09:03

Sintaxis XWiki 2.1: Programación

Macros

2.0 Macros

Solo hay una clase de macros en la Sintaxis XWiki 2.1, se invocan con la sintaxis: {{nombredemacro parám1="valor1" ... parámN="valorN"}}...{{/nombredemacro}}. Hay una notación abreviada para macros in contenido: {{nombredemacro parám1="valor1" ... parámN="valorN"/}}

Funcionalidad	Sintaxis XWiki 2.1	Resultado
Renderizando una macro con contenido	{{code language="java"}} System.out.println("¡Hola mundo!"); {{/code}}	System.out.println("¡Hola mundo!");
Renderizando una macro sin contenido	{{include reference="Espacio.Página"/}}	Se incluye la página referenciada en la página en curso

La macros Radeox no se pueden utilizar en la Sintaxis XWiki 2.1. Así tiene que reescribirse como macros de renderizado.

La lista completa de macros disponibles está en la wiki de Extensiones.

Macros en esta wiki

Id	Nombre	Categories	Descripción	Visibilidad
activity	Actividad	Notifications	La macro de actividad provee información acerca de las actividades recientes realizadas por los usuarios dentro de la instancia de XWiki. Lista los eventos de creación, edición y borrado de las páginas, así como los de los comentarios, adjuntos y anotaciones.	Wiki actual
async	Macro asíncrona	Contenido	Ejecutar asincrónicamente y/o cachear el contenido de la macro.	Global
attachmentGalleryPicker	Attachment Picker	Desarrollo	Grid based attachment picker.	Global
attachmentSelector	Selector de adjuntos	Desarrollo	Un control que se utilizará para las propiedades de objeto de la página actual que se supone que contienen el nombre de un archivo adjunto de la página actual (o de destino). Permite cargar nuevos archivos adjuntos y eliminarlos de la página de destino. Si no se especifica ninguna página de destino, se utilizará la página actual. Las propiedades de los objetos sólo se guardan en la página actual.	Wiki actual
box	Caja	Formato	Dibujar una caja alrededor del contenido provisto.	Global
cache	Caché	Desarrollo	Contenido cacheado.	Global
chart	Gráfica	Contenido	Muestra una gráfica generados desde fuentes de datos variadas	Global
children	Children	Navegación	Displays a tree of children pages of the current page	Wiki actual
code	Código	Formato	Resalta los trozos de código de varios lenguajes de programación	Global
comment	Comentario	Desarrollo	Permite poner comentarios en el contenido fuente. Esta macro no produce nada.	Global
container	Contenedor	Maquetación	Una macro para rodear múltiples grupos y añadirles decoración, tal como distribución.	Global
content	Contenido	Contenido	Permite escribir contenido en cualquier formato wiki	Global
context	Contexto	Desarrollo	Ejecuta el contenido en el contexto del documento pasado	Global
dashboard	Panel de control	Maquetación	Macro para definir un panel de control que rellenar con gadgets.	Global
display	Mostrar	Contenido	Muestra otras páginas en la página actual.	Global
displayIcon	Icon	Contenido	Display an icon.	Global
documents	Documentos	Contenido	Muestra una lista de páginas en una 'Livetable'	Wiki actual
documentTree	Jerarquía de páginas	Navegación	Muestra la jerarquía de páginas de XWiki.	Wiki actual
error	Mensaje de error	Formato	Muestra una nota de error.	Global
example	Example	Formato	Shows an example and its source code.	Wiki actual
footnote	Nota al pie	Contenido	Genera una nota al pie que muestra al final de la página.	Global
gallery	Galería	Maquetación	Mostrar las imágenes encontradas en el contenido que se provea usando una vista de presentación de diapositivas.	Global
groovy	Groovy	Desarrollo	Ejecuta un script groovy.	Global
html	HTML	Desarrollo	Inserta código HTML o XHTML en la página.	Global
iconPicker	Selector de iconos	Desarrollo	Selecciona un icono dentro del conjunto de iconos de XWiki.	Wiki actual
id	Id	Navegación	Permite incluir una referencia/ubicación en una página. En HTML esto se llama Anchor. Permite apuntar a esa ubicación, por ejemplo en un enlace.	Global
include	Incluir	Contenido	Incluye otras páginas en la página actual.	Global
info	Mensaje Informativo	Formato	Muestra una nota informativa.	Global
liveData	Live Data	Contenido	Display dynamic lists of data.	Global
mention	Mención de usuario	Notifications	Añade una mención de usuario.	Wiki actual
menu	Menú	Navegación	Muestra un menú creado utilizando una sintaxis wiki simple (listas anidadas y enlaces).	Global
messageSender	Remitente del mensaje	Social	Un control que permite a los usuarios introducir mensajes que son gestionados por el módulo MessageStream.	Wiki actual
missingLicenseMessage	Missing License Message		Display an error message when the extension does not have a valid license.	Global
notifications	Notificaciones	Notifications	Muestra notificaciones sobre eventos ocurridos en el wiki.	Wiki actual
notificationsApplicationsPreferences	Configuración de notificaciones de aplicaciones	Notifications	Muestra las preferencias del usuario actual sobre las notificaciones de las aplicaciones.	Wiki actual
notificationsAutoWatchPreferences	Preferencias de notificaciones de autovigilancia	Notifications	Mostrar las preferencias del usuario en curso sobre las páginas vistas automáticamente.	Wiki actual
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Wiki actual
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Wiki actual
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.	Wiki actual
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Wiki actual
office	Office Document Viewer	Contenido	Mostrar el contenido de los adjuntos (doc, ppt, xls, odt, odp, ods etc.) dentro de las páginas sin necesidad de descargarlos o importarlos.	Global
pdftoc	PDF Table of Contents	Interno	Generates the table of contents for the PDF export.	Global
pdfviewer	PDF Viewer		View PDF attachments inside wiki pages without downloading or importing them.	Global
putFootnotes	Poner nota al pie	Contenido	Muestra las notas al pie si las hay. Si no está, todas las notas al pie se muestran al final de la página.	Global
python	Python	Desarrollo	Ejecuta un script en python.	Global
script	Script	Desarrollo	Ejecutar un script en el lenguaje de script provisto.	Global
showhide	showhide	content	Show Hide Macro	Wiki actual
spaceindex	Índice del espacio	Obsoleto	Lista los documentos en un espacio.	Wiki actual
spaces	Espacios	Obsoleto	Muestra todos los espacios en este wiki.	Wiki actual
success	Mensaje de éxito	Formato	Muestra una nota de mensaje de éxito.	Global
tagcloud	Nube de etiquetas	Contenido	Muestra la nube de etiquetas de este wiki o del espacio especificado, si las hay.	Wiki actual
template	Plantilla	Desarrollo	Añadir una plantilla.	Global
toc	Tabla de contenidos	Navegación	Genera una tabla de contenidos.	Global
translation	Traducción	Contenido	Mostrar un mensaje de traducción.	Global
tree	Árbol	Navegación	Muestra una jerarquía de árbol definida por el contenido de la macro o el parámetro fuente.	Wiki actual
uiextension	UI Extension	Desarrollo	Insert a UI extension.	Global
uiextensions	UI Extensions	Desarrollo	Insert UI extensions.	Global
useravatar	Avatar	Contenido	Permite mostrar el avatar de un usuario concreto.	Global
velocity	Velocity	Desarrollo	Ejecuta un script en Velocity.	Global
warning	Mensaje de advertencia	Formato	Muestra una nota de advertencia.	Global
wikimacrocontent	WikiMacro Content	Desarrollo	Display editable content of a wikimacro.	Global
wikimacroparameter	WikiMacro Parameter	Desarrollo	Display editable parameter of a wikimacro.	Global
wikis	Wikis	Navegación	Mostrar todas las wikis	Wiki actual
workspaces	Espacios de trabajo ("Legacy", en desuso)	Obsoleto	Macro obsoleta que no debería utilizarse aquí por razones de compatibilidad. Por favor, utiliza la macro "wikis" en su lugar.	Wiki actual

HTML

2.0 HTML

En la Sintaxis XWiki 2.1, se debe utilizar la macro HTML para añadir HTML o XHTML.

Sintaxis XWiki 2.1	Resultado
{{html}}<b>bold</b>{{/html}}	bold

En la Sintaxis XWiki 2.1, por defecto, la macro HTML no interpreta la Sintaxis XWiki (otras macros incluidas puesto que también es Sintaxis XWiki). Para activarla, utiliza {{html wiki="true"}} .

Scripts

2.0 Scripts

En la Sintaxis XWiki 1.0 era posible añadir scripts Velocity directamente en cualquier lugar de la página, lo que podía provocar problemas, por ejemplo, cuando el usuario introducía contenido Velocity de forma involuntaria. También desperdiciaba mucho rendimiento en páginas que no necesitan contenido Velocity. Hay también otras limitaciones técnicas. Así que en la Sintaxis XWiki 2.1 los scripts Velocity se deben añadir con la macro velocity. Lo mismo aplica al añadir scripts Groovy.

Funcionalidad	Sintaxis XWiki 2.1
Script Velocity	{{velocity}} #set ($var = "lo que sea") {{/velocity}}
Script Groovy	{{groovy}} def var = "lo que sea" {{/groovy}}