General Actions:
Log-in
Register
Home ▼: Wiki Index
»
Space: XWiki
»
Page: XWikiSyntax
default
Page Actions:
Export ▼: Export as PDF Export as RTF Export as HTML
More actions ▼: Print preview View Source
Welcome to bytebang » XWiki Syntax Guide

# XWiki Syntax Guide

Last modified by Administrator on 2014/06/29 19:30
Attachments (0) · Information

XWiki Syntax 2.1 » Editing » Images

## XWiki Syntax 2.1: Images

### 2.1 Images

Feature | XWiki Syntax 2.1 | Result
--- | --- | ---
Image from attachment on current page | `image:img.png` |
Image from attachment on another page | `image:Space.Page@img.png` |
Image with parameters | `[[image:img.png||width="25" height="25"]]` |
Images located at URL | `image:http://some/url/img.png` |
Prepackaged Icons | `image:icon:accept` |

## XWiki Syntax 2.1 Image Specification

The part in `( )` is required, while the parts in `{ }` are optional.

The full format of an image is either `image: (reference)` or `[[image: (reference) {||parameters}]]`

- `image:` A required string identifying the resource as image.
- `reference`: The reference to the image that shall be displayed in one of the following forms:
  - URL: Any URL to an image in the form of `protocol://path/imageName`. Example: `http://domain.org/path/img.png`
  - Attachment reference in the form `{{{wikiName:} space.} page@} (imageName)`
    - `wikiName`: An optional string containing the name of a virtual wiki. The image reference will point to an image attached to a page inside that virtual wiki. Example: mywiki
    - `space`: An optional wiki Space name. If no space is specified the current space is used. Example: Main
    - `page`: An optional string containing the name of the wiki page to which the referenced image is attached. Example: WebHome
    - `imageName`: A required string containing the name of the image attached to a page as it is stored in the wiki.
  - Icon reference in the form ``(icon:)` (iconName)`. Example: `icon:accept`
    - `icon:` A required string identifying the image reference as an icon from the XWiki Icon Set.
    - `iconName`: A required string identifying the icon referenced. Example: `accept`
  - Data URI in the form ``(data:)` (content)`. Example: ``data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==``
    - `data:` A required string identifying the image as being specified inline using the Data URI scheme.
    - `content`: The encoded image. Example: ``image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==``
- `parameters`: An optional list of space-separated parameters passed to the image. Example: `width="800" height="600" alt="img.png" title="My nice image"`
  - HTML attributes: All attributes defined by the HTML standard will be added to the rendered HTML `<img>` tag.
    - `style`: CSS style information that should be applied to the image. Examples: `style="float:right;height:50"` (image on right side, height 50 px), `style="display:block;margin-left:auto;margin-right:auto;width:80%"` (image centered, width 80% of block width), `style="vertical-align:bottom"` (text starts at bottom of picture)
    - `height`: A parameter that defines the height of the displayed image. The value should be presented either in pixel (example: `height="80"`) or in pixel related to the height of the block containing the image (example: `height="40%"`).
    - `width`: A parameter that defines the width of the displayed image. The value should be presented either in pixel (example: `width="80"`) or in pixel related to the width of the block containing the image (example: `width="40%"`).
    - `title`: A parameter that defines the title the displayed image which will be visible when hovering the mouse trigger over the image, for instance. Example: `title="My nice image"`
    - `alt`: A parameter that defines which text should be displayed if the browser is not able to display the image. Since this is a required HTML attribute XWiki will use the file name instead if the `alt` parameter is not defined. Example: `alt="img.png"`
    - More: A more in depth explanation on the HTML `<img>` tag including more attributes can be reviewed on w3.org.
  - `queryString`: Allows queries to be passed to the server when creating the download link for the referenced image. Example: `queryString="width=100&height=800&keepAspectRatio=true"` (`keepAspectRatio=true` will fail if the `width` and `height` parameters are specified in addition to `queryString`!)

Tags:
Created by Administrator on 2014/06/29 19:30

- Attachments (0)
- Information

(c) 2026, by bytebang e.U. - Impressum - Datenschutz / Nutzungsbedingungen
-