Plugins

Syntax/Embeddings

Embeddings are additions to the standard markdown syntax in An Otter Wiki. They provide capabilities beyond basic markdown, such as special layout elements, enhanced features, and entirely new functionality.
Embeddings are an experimental feature and subject to change.

Usage

An embedding starts with {{EmbeddingName and ends with }}. Between the opening and closing braces you can pass options and args.

Options are key-value pairs separated by | in the form |key=value. Each option starts with a | followed by the key, an = and the value.

Args are any remaining lines that are not options. They form the body content of the embedding and can contain regular markdown.

{{EmbeddingName
|option1=value1
|option2=value2
args content (markdown)
}}

Escaping: Use \| to include a literal | in a key, value, or args. Use \= to include a literal = in a key.

AttachmentList

Display attachments to the current page as list.
{{AttachmentList
|caption=Attachments
|filter=*
|format=full/details/minimal
|icons=true/false
}}

With format you can decide what is displayed in the table: minimal shows only the filenames, details shows filename, date and size, full shows all information.

AttachmentSizeDateAuthorComment
example.pdf110.0KiB2026-03-08 11:26AnonymousAdded AttachmentList documentation.

DataTable

The DataTable Embedding is for turning markdown tables into datatables that can be paginated, search and sorted.
{{datatable
|paging=false
|perPage=42
|searchable=false
|sortable=true
|fixedHeight=True
|caption=Python Stable
| Version | Released   |
| -------:| ---------- |
|    3.13 | 2024-10-07 |
|    3.12 | 2023-10-02 |
|    3.11 | 2022-10-24 |
|    3.10 | 2021-10-04 |
|     3.9 | 2020-10-05 |
|     3.8 | 2019-10-14 |
|     3.7 | 2018-06-27 |
|     3.0 | 2008-12-03 |
}}
Version Released
3.13 2024-10-07
3.12 2023-10-02
3.11 2022-10-24
3.10 2021-10-04
3.9 2020-10-05
3.8 2019-10-14
3.7 2018-06-27
3.0 2008-12-03

CSV attachments can also be rendered as datatables:
{{datatable
|src=data.csv
|delimiter=;
|quotechar="
|header=true
|columns=1,3
|headers=Name,Score
|caption=My Data
}}

Options specific to CSV:

  • src: filename of a CSV attachment on the page
  • delimiter field delimiter, default ;
  • quotechar character used to quote fields, default "
  • header use first row as column headers (default true)
  • columns comma-separated list of columns to include, given as 1-based indices (1 = first column) or header names
  • column0 same as columns, but using 0-based indices (0 = first column); ignored if columns is set
  • headers comma-separated list of column header labels (overrides CSV headers)

Excerpt

Shows the intro or one section of another page, e.g. on an overview page, with a link to the page it comes from. Edits to that page show up straight away.

{{Excerpt|page=Shaun Oldfield}}
{{Excerpt|page=Shaun Oldfield|section=Summary}}
  • page is found like a link: the short name is enough (Shaun Oldfield for Cast/Shaun Oldfield) and case doesn't matter. When several pages share the name, use the full one.
  • Without section, the intro is shown: the text before the first heading (not counting the page title).
  • section is the text of a heading, case doesn't matter. The section includes its subsections, the heading itself isn't shown.
  • Infoboxes and other embeddings in the excerpt are left out.
  • Renaming the heading or the page breaks the excerpt, the page then shows an error saying what's missing.

Figure

A container for emphasizing content blocks (code, tables, images, etc.) with an optional caption — similar to a LaTeX figure.
{{Figure
|caption=Figure 1: Example Python code
|align=center/left/right
|width=100%
|height=300px
|style=additional inline css
```python
#!/usr/bin/env python
print("Hello, World!")
```
}}
#!/usr/bin/env python
print("Hello, World!")
Figure 1: Example Python code

ImageFrame

Display images in frames on the wiki page.
{{ImageFrame
|caption=An Otter Wiki Logo
|width=30%
|position=right/left
|float=right/left
|text-align=center/left/right/justify
|style=custom css
[![](/static/img/otter.png)](/static/img/otter.png)
}}

Use |src= to embed an attachment directly, with an optional |alt= text:

{{ImageFrame
|caption=An Otter Wiki Logo
|src=otter.png
|alt=The Otter Wiki logo
}}

Use an absolute path to embed an attachment from another page:

{{ImageFrame
|src=/OtherPage/otter.png
}}

External images can be embedded via a full URL:

{{ImageFrame
|src=https://example.com/image.png
|alt=Description
}}
An Otter Wiki Logo

Include

Include (transclude) the content of another page, or a single section of it, into the current page. The included content is rendered inline, seamlessly.
{{include|src=Some/Page}}
{{include|src=Some/Page|section=installation}}
{{include|src=/Absolute/Page|section=installation|children=false|heading=false}}

Options:

  • src: path of the page to include. Relative to the current page unless it starts with / (absolute from the wiki root).
  • section: the anchor slug of the heading to include, matched the same way heading links ([[Page#anchor]]) are generated, independent of the heading level. If omitted the whole page is included.
  • children: include sub-sections of the section (default true). With children=false only the content directly under the heading is included.
  • heading: include the section's own heading line (default true).

Limitations:

  • Relative links and attachments (e.g. ![](image.png)) in the included content resolve against the including page, not the source page, so they may break. Use absolute paths (/Source/Page/image.png) in content that is meant to be included.
  • Headings from included content do not appear in the including page's table of contents.
  • Combining a stateful embedding such as DataTable with an include on the same page may leave the page's own DataTable uninitialised. Put such embeddings on separate pages.
  • Includes are limited to a nesting depth of 8, and include cycles (a page including itself, directly or indirectly) are detected and reported instead of being expanded.

InfoBox

An element for displaying structured data in a document.
{{InfoBox
|caption=Some Caption
|position=right/left
|float=right/left
|width=35%
|text-align=justify
|style=additional inline css
|Random Key=Value
|Answer=42
|Homepage=[otterwiki.com](https://otterwiki.com)
Lorem _ipsum_ dolor sit **amet**, consectetur
adipiscing elit.
```python
#!/usr/bin/env python
markdown=True
```
}}

Note: On small screens the box automatically expands to full width regardless of the width option. The optional |style= allows additional inline CSS overrides.

Some Caption
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
#!/usr/bin/env python
markdown=True
Random KeyValue
Answer42
Homepageotterwiki.com

InfoboxDefinition

Defines the infobox named after the page: the page Infobox/Ship defines {{Ship}}. Infobox names use only letters and spaces.

{{InfoboxDefinition
title: name
image: image
caption: imagecaption

- class: Class
- crew: Crew size

[History]
- launched: Launched

[Links]
- twitter: Twitter | link: https://x.com/{value} | text: @{value}
}}
  • title:, image: and caption: name the fields used for the infobox title, image and image caption. These are the defaults. Without a title the page name is shown.
  • - field: Label adds a field, in the order listed.
  • [Heading] starts a new section with that heading. Fields before the first heading have no heading.
  • | link: https://...{value} shows the value as a link, {value} is replaced with what was entered. | text: ... sets the link text, it defaults to the value.
  • | spoiler always hides the value behind a spoiler bar, editors don't need to write ||. The bar has the same size whatever the value, so it doesn't give away its length.
  • | default: text shows the field on every infobox, with that text when the page leaves it empty. Together with | spoiler the field's presence gives nothing away: - deathDate: Date of death | spoiler | default: Alive as of the latest episode

InfoboxList

Lists every page using an infobox, sorted by page name.

{{InfoboxList|type=Character}}

Only list pages whose field contains a text (case-insensitive):

{{InfoboxList
|type=Cast
|field=appears in
|contains=Season 1
}}

Infoboxes

Field names are case-insensitive. Empty fields are hidden, so fields you don't need can be left empty or left out. Values can contain markdown, [[WikiLinks]] and <br />. A | inside a value (e.g. [[Page|Text]]) must be written as \|. image is the filename of an attachment of the page, or /Other Page/file.png. The infoboxes are defined on the Infobox/ pages, see Special.

Cast

{{Cast
 | name         = 
 | image        = 
 | imagecaption = 
 | pronouns     = 
 | appears in   = 
 | characters   = 
 | twitter      = 
}}

Character

{{Character
 | name         = 
 | image        = 
 | imagecaption = 
 | trueName     = 
 | aliases      = 
 | relatives    = 
 | affiliations = 
 | occupation   = 
 | charType     = 
 | charClass    = 
 | pronouns     = 
 | height       = 
 | weight       = 
 | portrayedBy  = 
 | appearsIn    = 
 | twitter      = 
}}

Inline spoiler

Wrap text in || to hide it behind a black bar until it is clicked. Clicking again hides it again. Works in paragraphs, tables and infobox fields:

Rriot is ||killed by the Unwilds|| in episode 52.

{{Character
 | name      = Rriot
 | deathDate = ||Episode 52||
}}

The text directly inside the || must not start or end with a space. Write \|\| for two literal bars.

Spoilers are only hidden on the page. Search results, the page source and the history show the text.

PageIndex

Display a page index listing pages below the current page, optionally filtered by a glob pattern.
{{PageIndex
|src=*
|style=pageindex/list
|toc=true/false
|toggle=true/false
}}

Options:

  • src: glob pattern to filter pages by title (default *, matches all pages)
  • style: pageindex for the default letter-grouped layout, list for a plain unordered list (default pageindex)
  • toc: show page headings (default false; for style=list headings are rendered as nested sublists)
  • toggle: show the toggle for the page headings (default true, ignored for style=list)

Pages nested in a category, such as Cast/Shaun, can be linked by their short name:

[[Shaun]]
  • This works as long as there is no page called just Shaun. If there is, the link goes there as usual.
  • When several pages are called Shaun, say Cast/Shaun and Characters/Shaun, the link goes to a page listing them and is shown with a dotted underline. Write [[Shaun|Cast/Shaun]] to link to one of them.
  • Moving a page to another category doesn't break short links to it. Changing its short name does, even with update backlinks ticked, as only links with the full page name are updated.

SpecialPages

Lists the pages that configure the wiki, grouped by section. These pages are hidden from the sidebar.

{{SpecialPages}}

Video

Embed a video player that supports video and audio playback in your document, or embed a YouTube video by providing a YouTube URL.
{{Video
|width=10%
|muted=false/true
|controls=true/false
|autoplay=false/true
|loop=false/true
|src=/full/path/to/video.mp4
/alternative/full/path/to/video.mp4
}}

YouTube URLs (youtube.com/watch?v=… or youtu.be/…) are rendered as embedded iframes:

{{Video
|width=100%
|muted=false/true
|controls=true/false
|autoplay=false/true
|loop=false/true
https://www.youtube.com/watch?v=dQw4w9WgXcQ
}}