XWiki Syntax Guide

Last modified by Administrator on 2021/07/06 18:37

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

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

Radeox macros cannot be used in XWiki Syntax 2.1. Thus they have been rewritten as Rendering macros.

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

Macros in this wiki

IdNameCategoryDescriptionVisibility
tocTable Of ContentsNavigationGenerates a Table Of Contents.Global
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
formulaFormulaContentDisplays a mathematical formula.Global
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
mentionUser MentionInsert a user mention.Current Wiki
asyncAsyncContentAsynchronous and cached execution of wiki content.Global
spaceindexSpace IndexDeprecatedLists documents in a space.Current Wiki
boxBoxFormattingDraw a box around provided content.Global
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
warningWarning MessageFormattingDisplays a warning message note.Global
messageSenderMessage SenderSocialA control that allows users to enter messages that are handled by the MessageStream module.Current Wiki
childrenChildrenNavigationDisplays a tree of children pages of the current pageCurrent Wiki
displayDisplayContentDisplay other pages into the current page.Global
translationTranslationContentDisplay a translation message.Global
contextContextDevelopmentExecutes content in the context of the passed documentGlobal
infoInfo MessageFormattingDisplays an info message note.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Current Wiki
rssRSSContentOutput latest feed entries from a RSS feed.Global
successSuccess MessageFormattingDisplays a success message note.Global
documentTreeDocument TreeNavigationDisplays the tree of XWiki documents.Current Wiki
templateTemplateDevelopmentInsert a template.Global
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsCurrent Wiki
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Current Wiki
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Current Wiki
activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Current Wiki
pythonPythonDevelopmentExecutes a python script.Global
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
contentContentContentAllows writing content in any wiki markupGlobal
scriptScriptDevelopmentExecute script in provided script language.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
officeOffice Document ViewerContentView office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.Global
galleryGalleryLayoutDisplays the images found in the provided content using a slide-show view.Global
dashboardDashboardLayoutA macro to define a dashboard.Global
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.Global
attachmentSelectorAttachment SelectorDevelopmentA control to be used for object properties of the current document that are supposed to contain the name of an attachment from the current (or target) document. Allows uploading new attachments, and deleting attachments from the target document.  If no target document is specified, the current document will be used. Object properties are only saved to the current document.Current Wiki
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Current Wiki
cacheCacheDevelopmentCaches content.Global
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
documentsDocumentsContentDisplays a list of documents in a LivetableCurrent Wiki
notificationsFiltersPreferencesNotifications Filters PreferencesNotificationsDisplay the preferences of the current user about notification filters.Current Wiki
velocityVelocityDevelopmentExecutes a Velocity script.Global
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
groovyGroovyDevelopmentExecute a groovy script.Global
footnoteFootnoteContentGenerates a footnote to display at the end of the page.Global
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
idIdNavigationAllows putting a reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to that location, for example in links.Global
includeIncludeContentInclude other pages into the current page.Global
Tags:
Created by Administrator on 2021/07/06 18:37
  

Schools

AbleTwoShine (CA)
Academy Of Classical Christian Studies (OK)
Acton Boxborough (MA)
Advanced Technologies (NV)
Albuquerque Academy (NM)
Alexander W Dreyfoos School Of The Arts (FL)
American (CA)
American Heritage Boca Delray (FL)
American Heritage Broward (FL)
Amplus Academy (NV)
Apple Valley (MN)
Appleton North (WI)
Aragon (CA)
Archbishop Mitty (CA)
Ardrey Kell (NC)
Ardsley (NY)
Arizona College Prep (AZ)
Astor Redhead Academy (CA)
Athenian (CA)
Auburn (AL)
Ayala (CA)
Bagel Academy (AL)
Bartlesville (OK)
BASIS Independent Silicon Valley (AL)
BASIS Peoria (AZ)
Basis Shavano (TX)
Beckman (CA)
Bellarmine (CA)
Bentonville West (AR)
Bergen County (NJ)
Bergen County Debate Club (NJ)
Bishops (CA)
Blue Springs South (MO)
Blue Valley (KS)
Boise Senior (ID)
Borah Senior (ID)
Brentwood School (CA)
Bridgeland (TX)
Bronx Science (NY)
Brookfield East (WI)
Brookline (MA)
Brophy College Prep (AZ)
Buhler (KS)
Burbank Senior (CA)
Byram Hills (NY)
Byron Nelson (TX)
Cabot (AR)
Caddo Magnet (LA)
Canyon Crest (CA)
Cardinal Gibbons (FL)
Carmel (IN)
Carmel Valley Independent (CA)
Carnegie Vanguard (TX)
Carrollwood Day (FL)
Cary Academy (NC)
Cassville (MO)
Catonsville (MD)
Central Valley (WA)
Century (ID)
Challenge Early College (TX)
Chaminade (NY)
Champion (TX)
Charlotte Latin School (NC)
Chattahoochee (GA)
Chelmsford (MA)
Cheyenne East (WY)
Christmas Independent (NY)
Christopher Columbus (FL)
Claudia Taylor Johnson (TX)
Clear Brook (TX)
Clear Lake (TX)
Clear Springs (TX)
Clements (TX)
Cogito Debate (CA)
College Park (TX)
Cooper City (FL)
Coppell (TX)
Crean Lutheran (CA)
Cupertino (CA)
Cypress Bay (FL)
Cypress Falls (TX)
Cypress Independent (TX)
Cypress Woods (TX)
Decatur (GA)
Denver East (CO)
Diamond Bar (CA)
Dougherty Valley (CA)
Dr Phillips (FL)
Dripping Springs (TX)
DSST Byers (CO)
DTHS (LA)
Dublin (CA)
Dulles (TX)
Durango (CO)
Durham Academy (NC)
Dwight Englewood (NJ)
Eagan (MN)
Eden Prairie (MN)
Edgemont (NY)
Edina (MN)
Edmond North (OK)
Elkins (TX)
Evergreen Valley (CA)
Fairmont Prep (CA)
Fairview (CO)
Flintridge Prep (CA)
Flower Mound (TX)
Fort Lauderdale (FL)
Freehold Township (NJ)
Fremont (CA)
Fullerton Union (CA)
Garland (TX)
Geffen (CA)
George Washington (CO)
Golden State Academy (CA)
Grapevine (TX)
Green River (WY)
Greenhill (TX)
Guyer (TX)
H S Two (CA)
Hamilton (AZ)
Harker (CA)
Harrison (NY)
Harvard Westlake (CA)
Hawken (OH)
Hebron (TX)
Heights (TX)
Hempstead (IA)
Highland (ID)
Holy Cross (LA)
Holy Ghost (PA)
Homestead (WI)
Honor (CA)
Houston Memorial (TX)
Hunter College (NY)
Immaculate Heart (CA)
Indian Springs (AL)
Interlake (WA)
Iowa City West (IA)
Irma Rangel YWLS (TX)
Irvington (CA)
Isidore Newman (LA)
Jackson (WY)
James Bowie (TX)
James Logan (CA)
Jenks (OK)
Jordan (TX)
Joshi Plat (MN)
Keller (TX)
Kelly Walsh (WY)
Kenston (OH)
Kent Denver (CO)
King (FL)
La Salle College (PA)
Lake Highland (FL)
Lake Oswego Senior (OR)
Lakeville (MN)
Lander Valley (WY)
Langham Creek (TX)
Lassiter (GA)
LC Anderson (TX)
LD Bell (TX)
Leland (CA)
Lexington (MA)
LHP (FL)
Liberty (OH)
Lincoln (OR)
Lincoln East (NE)
Lincoln North Star (NE)
Lincoln Southeast (NE)
Lincoln Southwest (NE)
Little Rock Central (AR)
Littleton (CO)
Livingston (NJ)
LNU (CA)
Los Altos (CA)
Lovejoy (TX)
Loveless Academic Magnet Program (AL)
Loyola (CA)
Loyola Blakefield (MD)
Lubbock (TX)
Lynbrook (CA)
Mahtomedi (MN)
Marcus (TX)
Marlboro (NJ)
Marlborough (CA)
Marquette University (WI)
Martin Luther King (CA)
Martinsburg (WV)
McDowell (PA)
McMillen (TX)
McNeil (TX)
Mercer Island (WA)
Midlothian (TX)
Midtown (GA)
Millard North (NE)
Millard South (NE)
Millburn (NJ)
Milpitas (CA)
Milton Academy (MA)
Minnetonka (MN)
Mission San Jose (CA)
Mission Vista (CA)
ModernBrain (CA)
Monta Vista (CA)
Montgomery (NJ)
Montgomery Academy (AL)
Montville (NJ)
MOORE (OK)
Mount Pleasant (TX)
Mount Vernon (WA)
Mountain House (CA)
Mountain View (AZ)
Nashua South (NH)
Needham (MA)
Neenah (WI)
New Trier (IL)
Newark Science (NJ)
Newman Smith (TX)
Newport (WA)
Newtown (CT)
North Allegheny (PA)
North Mecklenburg (NC)
Northern Valley (NJ)
Northland Christian (TX)
Northview (GA)
Northwood (CA)
Notre Dame San Jose (CA)
Nova Academy (CA)
NSU (FL)
NSU University School (FL)
OA Independent (CA)
Oak Ridge (CA)
Ogando Independent (XX)
Olathe East (KS)
Olympia (FL)
Omaha Central (NE)
Orange County School Of The Arts (CA)
Orange Lutheran (CA)
Oregon Episcopal School (OR)
Oxford (CA)
Park City (UT)
Parkway (LA)
Pasadena (TX)
Peachtree Ridge (GA)
Peninsula (CA)
Perry (AZ)
Phillips Exeter (NH)
Pine View (FL)
Plano East (TX)
Plano Independent (TX)
Plano West (TX)
Pocatello (ID)
Portola (CA)
Presentation (CA)
Princeton (NJ)
Proof (CA)
Prospect (CA)
Providence (NC)
Ramsay (AL)
Redlands (CA)
Ridge (NJ)
Ridge Point (TX)
Riverwood (GA)
Rock Springs (WY)
Roeper School (MI)
Rosemount (MN)
Round Rock (TX)
Royse City (TX)
Sage (CA)
Salado (TX)
Sam Barlow (OR)
Sammamish (WA)
San Angelo Central (TX)
San Mateo (CA)
Sandra Day Oconnor Independent (TX)
Saratoga (CA)
Scarsdale (NY)
Scripps Ranch (CA)
Sequoia (CA)
Sequoyah (GA)
Seven Lakes (TX)
Sharon (MA)
Shawnee Mission South (KS)
Sidwell (DC)
Silver Creek (CA)
Sky View (UT)
SLC West (UT)
Solebury (PA)
South Eugene (OR)
Southlake Carroll (TX)
Springfield Catholic (MO)
St Agnes (TX)
St Croix Prep (MN)
St Josephs (WV)
St Michael Albertville (MN)
St Thomas Aquinas (KS)
Stanford OHS (CA)
Stockdale (CA)
Strake Jesuit (TX)
Stratford (TX)
Strath Haven (PA)
Stuyvesant (NY)
Summit (NJ)
Syosset (NY)
Taft (CA)
Taravella (FL)
Tays (TX)
Tempe Prep (AZ)
Test School (AL)
Teurlings Catholic (LA)
Texas Academy Of Mathematics And Science (TX)
The Meadows (NV)
The Woodlands (TX)
Thomas Jefferson (VA)
Thunder Basin (WY)
Tom Glenn (TX)
Traber Robinson McLoughlin (MN)
Trinity Prep (FL)
Troy (CA)
Troy Independent (CA)
Tuloso Midway (TX)
Union (OK)
Unionville (PA)
University (CA)
Valley (IA)
Valley International (CA)
Valor Christian (CO)
Vandegrift (TX)
Verona Area (WI)
Vestavia Hills (AL)
Village (TX)
Walt Whitman (MD)
Wenatchee (WA)
West Broward (FL)
West Des Moines Valley (IA)
West Ranch (CA)
West Windsor Plainsboro North (NJ)
Westford (MA)
Westlake (TX)
Weston Erdmann (MN)
Westridge School (CA)
Westside (TX)
Westwood (TX)
Wichita East (KS)
William B Travis (TX)
William G Enloe (NC)
William P Clements (TX)
William Walker Indepedent (TX)
William Walker Independent (TX)
Wilson (DC)
Windward (CA)
Winston Churchill (TX)
Wyoming Virtual Academy (WY)
Yerba Buena (CA)
Yorktown (VA)
Youth Voices (IL)