Phonemos User Guide

Phonemos Pandoc Format

The export is in the pandoc format. This document describes the specific classes and attributes used by Phonemos in the export. Those can be used in Pandoc templates to achive the desired styling.

Phonemos Widget
Example

Pandoc Element

Classes

Attributes

Status

Example

Span

Class: status

Additional Classes (one of):

  • color-neutral

  • color-purple

  • color-blue

  • color-red

  • color-yellow

  • color-green

None

Mention

@Mario Siegenthaler

Span: contains the user name

Class: user-mention

  • id: id of the user

  • email: email of the user

Date

Nov 16, 2024

Span

Class: date

None

Panel

Example

Div

Class: panel

Additional Classes (one of):

  • info

  • note

  • top

  • warning

  • error

  • success

Breakout bases classes:

  • breakout-none

  • breakout-wide

  • breakout-full-width

  • breakout-centered

None

Table

Table

Class: table

Additional Classes (one-of):

  • wide for expanded tables

  • full-width for full width tables

 





None

TableHeader

TableCell

<none>

Class:

  • cell for regular cells

  • head for heading cells (grey background in Phonemos)

  • color: <hex value>

    • background color of the cell (e.g. #e6fcff)

NamedSection

depending on the hide Attribute:

  • false: content blocks are output as-is (without a wrapper)

  • true: nothing is output

Note: Named sections are also output as Meta information (see below)

None

Paragraph

Para wrapped in a Div if any attribute is present, otherwise a plain Para

  • align

    • center: Align the paragraph to the center

    • end: Align the paragraph to the right (on left-to-right writing)

  • indent: value is a number of how many levels to ident the paragraph (tab stops)

Task

Div

Class: task

Content: Plain Block with 4 Spans of the following classes (in this order). Separated by space

  • completed

  • description

  • task-line-separator

  • due-date

  • assignee

  • id: Id of the task (UUID(

On the Spans:

  • completed

    • value: true or false (true when completed)

  • due-date

    • set: true or false (true when a due date was set)

  • assignee

    • set: true or false (true when a due date was set)

ActionButton

Span

Class: button

None

 

Issue Tracking Reference

WIKI-1234

Span

Class: issue-tracking-reference

  • issueKey: Issue Key, e.g. “WIKI-123”

Meta

Phonemos provides the following information

Meta Name

Type and Content

Remarks

id

MetaString

UUID

ID of the exported root object

url

MetaString

URL (e.g. https://my.phonemos.cloud/o/xxx)

URL of the exported root object in Phonemos

title

MetaString

Page Title (Object Name)

revision

MetaString

A number, e.g. “25”

Number of the exported revision (root object)

date

MetaString

ISO date format at UTC, e.g. “2025-01-25”

Creation date of the exported revision (root object)

dateTime

MetaString

ISO date time format at UTC e.g. “2025-01-25T12:13:14.567Z”

Creation timestamp of the exported revision (root object)

topicId

MetaString

UUID

Id of the topic the exported objects belong to

topicTitle

MetaString

Title of the topic the exported objects belong to

topicUrl

MetaString

URL (e.g. https://my.phonemos.cloud/o/xxx)

URL of the topic the exported objects belong to

siteId

MetaString

UUID

Id of the Phonemos site that the exported objects belong to

siteTitle

MetaString

Title of the Phonemos site that the exported objects belong to

siteUrl

MetaString

URL (e.g. https://my.phonemos.cloud/o/xxx)

URL of the Phonemos site that the exported objects belong to

exportDate

MetaString

ISO date format at UTC, e.g. “2025-01-25”

Time of the start of the export

exportDateTime

MetaString

ISO date time format at UTC e.g. “2025-01-25T12:13:14.567Z”

Time of the start of the export

author

MetaString

Display Name of the User, e.g. “Mario Siegenthaler”

Creator of the exported revision (root object)

authorUser

MetaMap:

  • id: User-ID, a uuid (MetaString)

  • displayName: Display Name (Meta String)

  • email: MetaString

same as author

exportBy

MetaString

Display Name of the User, e.g. “Mario Siegenthaler”

User that exported the content

exportByUser

MetaMap:

  • id: User-ID, a uuid (MetaString)

  • displayName: Display Name (Meta String)

  • email: MetaString

User that exported the content

field-uuid

where uuid is the ID of the Metadata Field

Depending on the type of the data field:

  • Text => MetaString: Content of the text field

  • Date => MetaString: ISO-Date (e.g. 2025-01-25)

  • Instant => MetaString: ISO-Timestamp (e.g. 2025-01-25T12:13:14.567Z)

  • Numeric => MetaString: The Number converted to a string (e.g. “25.12”)

  • Single Label => MetaString: The label (e.g. “In Progress”)

  • MultiLabel => MetaList[MetaString]: e.g. [“Blue”, “House”]

  • SingleSelect => MetaString: Label of the chosen Option (e. g. “In Progress”)

  • MultiSelect => MetaList[MetaString]: e.g. [“Blue”, “House”]

  • User => MetaMap:

    • id: MetaString - User-ID, a uuid

    • displayName: Display Name (Meta String)

    • email: MetaString

  • Link => MetaMap:

    • label: MetaString - Link label (e.g. “Phonemos”)

    • href: MetaString - Link target (e.g. “https://www.phonemos.com”)

section-xxx

where xxx is the user-defined name of the section

MetaBlock

Complete, unchanged Content of the named section

Can be used for things like addresses when you format a letter (special positioning) or special layout elements like a sidebar in a CV.