Text formating (Wiki-Syntax)
Formating Text
With openforms you can influence the outward appearance of your continuous text.
- If you want to change the appearance of one word, write the formating command in front of the word you want to change. Separate the command and the word by a colon.
- If you want to change the appearance of a larger section of the text, put the section in square brackets.
- The following table displays possible formats
| Formate | Command | Example (input) | Example (output) |
|---|---|---|---|
| Bold | f: | This text is written in f:bold | This text is wrriten in bold |
| Cursive | k: | This text is written in k:cursive | This text is written in cursive |
| Superscript | sup: | This text is written in sup:superscript | This text is written in superscript |
| Subscript | sub: | This text is written in sub: subscript | This text is written in subscript |
| del: | This text is del:crossed out | This text is | |
Formated | pre: | pre:
__ _____
/ _| | ___|
___ _ __ ___ _ __ | |_ ___ _ __ _ __ ___ ___ |___ \
/ _ \ | '_ \ / _ \| '_ \ | _| / _ \ | '__|| '_ ` _ \ / __| \ \
| (_) || |_) || __/| | | || | | (_) || | | | | | | |\__ \ /\__/ /
\___/ | .__/ \___||_| |_||_| \___/ |_| |_| |_| |_||___/ \____/
| |
|_|
| __ _____
/ _| | ___|
___ _ __ ___ _ __ | |_ ___ _ __ _ __ ___ ___ |___ \
/ _ \ | '_ \ / _ \| '_ \ | _| / _ \ | '__|| '_ ` _ \ / __| \ \
| (_) || |_) || __/| | | || | | (_) || | | | | | | |\__ \ /\__/ /
\___/ | .__/ \___||_| |_||_| \___/ |_| |_| |_| |_||___/ \____/
| |
|_| |
| Format several words | [command:…] | [f:This section is written in bold] | This section is written in bold |
| No line brake | nobr: | [nobr:This text will always displayed in one line and not break at spaces] |
Structuring Texts
You can structure and organize continuous texts.
- When structuring a continuous text it is important to leave an empty row both before and after the structured textblock.
- The order initiating structuring is always entered followed by a space.
- The following table shows some possible structures.
| Format | Command | Example (input) | Example (output) |
|---|---|---|---|
| Bullets | * | This is a continuous text * one * two and another continuous text. | This is a continuous text
|
| Lists | # | This is a continuous text # one # two and another continuous text. | This is a continuous text
|
| Forced Empty Row | br: | This is a continuous text<return> br: br: and another continuous text. | This is a continuous text and another continuous text. |
| Subheadings | ! | This is a continuous text, followed by a ! subheading and another continuous text. | This is a continuous text, followed by a subheading and another continuous text. |
| Citations | z: | This is a continuous text [z:and this is a citation] | This is a continuous text and this is a citation |
| Source Texts | code: | This is a continuous text [code:and this is a source excerpt] | This is a continuous textand this is a source excerpt |
| Next paragraph after an image. | clear: | This is a continuous text clear: and another continuous text |
|
| Horizontal Line | hr: | This is a continuous text hr: and another continuous text | This is a continuous text and another continuous text |
Please note that you can also structure a text by creating a new standard paragraph for each section.
Semantic Labeling
By using semantic labeling you can capture more information than is visible in the text. This applies especially to footnotes, comments and citations.
- When entering it, put two # sympols behind the characteristic word, the explain it.
- The entire term is set into square brackets.
- The following table displays possible semantic labels.
- In order to test the function, please move your cursor above the labelled word.
| Format | Command | Example (input) | Example (output) |
|---|---|---|---|
| Abbreviation | abbr: | Please move your cursor above the following [abbr:abbreviation##Explenation of abbreviation]. | Please move your cursor above the following abbreviation. |
| Definition | dfn: | Please move your cursor above the following[abbr:definition##Explenation of definition]. | Please move your cursor above the following definition. |
| Acronym | acronym: | Please move your cursor above the following [abbr:Akronym##Explenation of acronyms]. | Please move your cursor above the following acronym. |
With x-html_tag you may generate arbitrary inline HTML-Tags. e.g to support project specific HTML5 Tags.
Tables and Overviews
You can display a set of facts or figures systematically in tables. The data to be displayed is set in columns and rows
- Tables start with the tab: command, followed by a line break.
- All following lines each represent a row with columns. Columns are separated using a separator mark, with a space before and after the separator mark.
- To clearly separate a table-block from the rest of the text of you place a blank line before and after the table-block.
- In case the table should contain a heading at the top, enter tab:spaltig. Should the left table culumn be a heading, enter tab:zeilig. (Unfortunately the commands splatig and zeilig are not localized.)
| Formatting | Command | Example Input | Example Output | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Index | def: := | def: FRG := German UK := English | FRG German UK English | |||||||||
| Table | tab: | | tab: | Colour | Flavor Apples | red | sourish Peas | yellow | sweet |
| |||||||||
| Cell Blocking | nbsp: | tab: nbsp: | pieces Apples | 10 br: (20) Peas | 3 br: (6) |
| |||||||||
| Table | tab: | | tab: | Colour | Flavor Apples | red | sourish Peas | yellow | sweet |
| |||||||||
| Molded horizontal cells | |< | tab: | Colour | Flavor Apples | red | sourish Peas gone! |< |< |
| |||||||||
| Molded vertical cells | |^ | tab: | Colour | Flavor Apples | red | sourish Cherries |^| sourish |
| |||||||||
Please note it is more clear to add a new text paragraph element for each block (in this case the table-block).
Links and References inside text
Inside the text you can place links to external web sites or a document or image inside the system.
- A reference is set by entering a reference command and a path to the location of the referenced target.
- The description for a references follows after the path, separated by two # symbols
- The whole phrase is set in square brackets.
- Possible link- and reference-commands are shown in the table below
| Formatting | Command | Example Input | Example Output |
|---|---|---|---|
| Internal Reference (1) | doc: | Additional Information in [doc:/acme.com/en/Content##Content] Additional Information in [doc:reference-context##Content] | Additional Information in Content |
| External Reference | https: | Visit us at [https://www.salient.de##Salient] | Visit us at Salient |
| E-Mail (2) | mailto: | For further questions, please contact [mailto:service@salient.de##salient] | For further questions, please contact salient |
| Popup | popup;pixel-width;pixel-height | Additional Information in [doc:/acme.com/en/Content##Content##popup;500;600] | Additional Information in Content |
| Modal | modal;pixel-width;pixel-height | Additional Information in [doc:/acme.com/en/Content##Content##modal;500;600] | Additional Information in Content |
| New Window | _blank;pixel-width;pixel-height | Additional Information in [doc:/acme.com/en/Content##Content##_blank;500;600] | Additional Information in Content |
| Media Asset | media: | media:/Media/Picture##Description##80 |
|
Please note that links and references placed by this technique are not updated if the target document or asset is being moved. Therefore it is recommended to use paragraphs like the reference-paragraph instead.
(1) The use of absolute internal paths is problematic. If the target document has been moved, this link will no longer be valid. As of openforms version 5.50, it ist possible to use reference context key defined in the 'Known Links' attribute of the current paragraph or version.
(2) It is also possible to preset a mail body: [mailto:address##label##subject##body].