XWiki

https://www.xwiki.org/xwiki/bin/view/Documentation/
Admin
XWiki is an enterprise-ready open-source wiki platform that allows teams to collaborate, share...
Tokens:6,840,858
Snippets:52,810
Trust Score:9.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### Adding a standard 'home' icon

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/icons/displayicon-macro?language=en&rev=10.2

Wiki syntax example that displays the 'home' icon from the current icon theme. The 'name' parameter is required; other parameters are optional.

```wiki
{{displayIcon name="home"/}}
```

--------------------------------

### Wiki Editor: Icon Macro Syntax

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/icons/add-icon-wysiwyg-editor?language=en&rev=18.1

Use this syntax in the Wiki editor to display an icon. The example shows the 'pencil' icon, but you can specify any icon name.

```plaintext
Use the {{displayIcon name="pencil"/}} button above
```

--------------------------------

### Specify properties from other classes in liveTable source

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/livedata/display-data/sources

Shows how to include properties from another class by passing a <property>_class source parameter. The example uses tags_class=XWiki.TagClass to add the tags property from the XWiki.TagClass class.

```xwiki
{{liveData properties="doc.location,doc.title,tags" source="liveTable" sourceParameters="tags_class=XWiki.TagClass&translationPrefix=platform.index."/}}
```

--------------------------------

### Get field value with Velocity

Source: https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/DataModel/Computed%20Pseudofield?showLastAuthors=true&viewer=code

Sets a variable to the value of the 'source' field of an object and outputs it. This is the basic example used as a starting point for the subsequent substring examples.

```velocity
{{velocity}}
#set($source=$object.getValue('source'))  
$source  
{{/velocity}}  
{{/code}}  
```

--------------------------------

### init.sql example for MySQL

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/installation/methods/install-xwiki-docker/docker-compose/required-files?showLastAuthors=true&viewer=code

SQL executed when the database starts for the first time. Grants all privileges on all databases to the xwiki user.

```sql
grant all privileges on *.* to xwiki@'%'
```

--------------------------------

### Start Jetty

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/installation/methods/install-xwiki-war/configure-servlet-container/configure-jetty?language=en&rev=3.1

Start Jetty from the JETTY_BASE directory. XWiki initializes and connects to the configured relational database when Jetty deploys the webapp.

```shell
java -jar <JETTY_HOME>/start.jar

```

--------------------------------

### Static data V3: Helper Macros

Source: https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/FrontendResources/AutoSuggestWidget?viewer=code

Uses helper Velocity macros picker_import and suggestInput. The example is incomplete in the source, showing only the data setup and macro definition start.

```none
{{velocity output="false"}}
#set ($countries = [
 {'name': 'France', 'code': 'fr'},
 {'name': 'Germany', 'code': 'de'},
 {'name': 'Romania', 'code': 'ro'}
])

#macro (countryPicker_displayOptions $selectedValues)
```

--------------------------------

### curl command to install an extension via the /jobs REST endpoint

Source: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiRESTfulAPI

Use this curl command to start an extension installation job asynchronously. It sends a PUT request to the /jobs endpoint with the jobType=install and async=false parameters, using the installjobrequest.xml file as the request body. The example installs the XWiki OIDC module version 1.28.

```bash
curl -i --user "Admin:admin" -X PUT -H "Content-Type: text/xml" "http://localhost:8080/xwiki/rest/jobs?jobType=install&async=false" --upload-file installjobrequest.xml
```

--------------------------------

### Example `man` catalog entry after installation

Source: https://www.xwiki.org/xwiki/bin/view/documentation/extensions/dev/llm/mcp-server/create-mcp-tool?viewer=content

Shows the expected catalog entry that appears in the `man` output once the tool is discovered and registered on the next request after installation, without restarting XWiki.

```text
Search & Navigation
    my_tool           A one-line summary for the man catalog.

```

--------------------------------

### Start XWiki container (xwiki:stable-mariadb-tomcat)

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/installation/methods/install-xwiki-docker/docker-run/run-xwiki-mariadb-tomcat?language=en&rev=1.15

Starts the XWiki container with the specified network, port mapping, volume, and database environment variables.

```bash
docker run --net=xwiki-nw --name xwiki -p 8080:8080 \
-v /my/path/xwiki:/usr/local/xwiki \
-e DB_USER=xwiki \
-e DB_PASSWORD=xwiki \
-e DB_DATABASE=xwiki \
-e DB_HOST=mysql-xwiki \
xwiki:stable-mariadb-tomcat
```

--------------------------------

### Deploy and start XWiki demo on AWS using CDK

Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/XWiki%20Installation%20on%20AWS/Deployment%20Using%20CDK%20Code?language=en&rev=2.1

Clones the repository, installs dependencies, deploys the demo CDK stack, and starts the built-in XWiki. Requires a key-pair named 'test' and AWS CLI configured with root privileges, as the setup will fail otherwise.

```bash
git clone https://github.com/xwiki-contrib/aws.git
```

```bash
cd aws
```

```bash
cd xwiki-demo-cdk
```

```bash
npm install
```

```bash
cdk deploy
```

```bash
cd xwikihome && cd xwiki-platform-distribution-flavor-jetty-hsqldb-13.1 
```

```bash
chmod +x ./start_xwiki.sh && ./start_xwiki.sh
```

--------------------------------

### Example: Download .env for XWiki 17

Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/installation/methods/install-xwiki-docker/docker-compose/run-xwiki-postgresql-tomcat?language=en&rev=1.66

Example of downloading the .env file for XWiki cycle version 17. Replace the version number with your desired version.

```bash
wget https://raw.githubusercontent.com/xwiki/docker-xwiki/master/17/postgres-tomcat/.env
```
Tokens:
Raw