Element: Inline
Inline elements contain the text for rich text elements, and provide formatting or other functionality.
Formatting△
Formatting inline elements provide simple visual styling of text.
| # | Element | Example | Description |
|---|---|---|---|
| a | Text | text | Plain unformatted text. The only element that can start or end with a space, or just be all spaces |
| b | Emphasis | em | Text needing to stand out slightly from the rest to indicate that it is something to be noted |
| c | Strong | strong | Text to be properly noticed as being important. A stronger version of emphasis |
| d | Subscript | sub | Text that qualifies its adjacent text in a subordinate way, as defined by the context. Typically used as a subclass identifier |
| e | Superscript | sup | Text that qualifies its adjacent text in a superior way, as defined by the context. Typically used as power notation in numeric statements |
| f | Delete | Indicates text that has been, or is to be, removed | |
| g | Insert | ins | Indicates text that has been, or is to be, inserted |
| h | Select | sel | Indicates the current selection |
| i | Key | key | Key on a keyboard |
| j | Mark | mark | Highlighted text, with a choice of colours |
| k | Bdo | bdo | Element to force a rendering direction on text. Options are auto (default), ltr and rtl. The example is set to rtl instead of its natural Latin script direction of ltr |
| l | Break | break here | Force a new line |
| m | Soft hyphen | eventually | Optional hyphen to specify where in a word to wrap around if there is not enough space on the line. Options are Simple, Armenian and Mongolian |
Text elements can have anywhere from 1 to 600 characters, which should be enough for plain paragraphs. If really wanting more text in a rich text element, just append one or more Text elements as required.
Code△
Code inline elements provide some text colouring for highlighting syntax in code examples.
| # | Element | Example | Description |
|---|---|---|---|
| a | Comment | // Comment | Code text to be ignored by the compiler or interpreter |
| b | Function | str_split | Name of a function |
| c | Identifier | $firstCell | Identifier for a constant or variable |
| d | Keyword | function | Keyword of special meaning to the compiler or interpreter |
| e | Tag | <html> | For HTML or XML tag |
| f | Commentary | Commentary | Non-code commentary on the line of code |
| g | Keyboard | kbd | Indicates text typed by a user |
| h | Variable | var | Indicate non-literal placeholder text |
The elements that can include them are Code, Sample and Program.
Inline rich text△
Inline rich text elements behave like inline elements, but contain other inline elements.
| # | Element | Example | Description |
|---|---|---|---|
| a | Quote | q | Solitary or outer quotes, as defined by the Quotes pattern defined for the current Locale |
| b | Subquote | qs | Inner quotes, as defined by the Quotes pattern defined for the current Locale |
| c | Sample | samp | Useful for sample text or labels |
| d | Code | code | For code snippets |
Code, Sample or the Program block element can included any of the Code elements.
Functional△
Functional inline blocks, while styled, provide additional functionality, such as with links.
| # | Element | Example | Description |
|---|---|---|---|
| a | Link | Glossary | Hypertext link – the fundamental enabler for navigating between pages on the worldwide web |
| b | Citation | The Prophet | Name of a work, optionally with a URL or Locale. For a detailed citation, mark as a Citation, but use a Footnote for the link and details. While not technically correct, it can be used to refer to a control or label on a form or page |
| c | File | file | File for download. The file must be Embeddable to download |
| d | Icon | Show an icon | |
| e | pollie@gov | Special link to open the default email client. Optional Subject and Body. The Body may have blank lines and any paragraph without ending punctuation will have a full stop added | |
| f | Time | Formatted date or time, with a choice of formats, calendars and timezones. Time format is yyyy-mm-dd-hh-mm-ss | |
| g | Value | ABN | Shows one of the Values of the Settings page, including the password for the gu guest account, if any |
Link, File and Mail allow styling to make them look like buttons, with differing font and background colours for their passive and active states, making them good for calls to action.
Inserting inline△
While inline elements can be inserted by the normal process for blocks, they can also be inserted directly into the text of another inline element with specially formatted text.
When in any inline text field, type in text in the form ~code~text~^,
where code is the letter or name of the desired element and text is the text to be contained by the element. The inline name and codes are listed at the bottom of the page and there is a Tag link to it above the field.
Multiple elements can be inserted at the same time. If all the text in a field is included, the required element completely replaces the current one rather than being inserted in between its children.
Inline rich text (IRT) elements do not have text of their own, but contain inline elements that do. They have their own scope, so text inside one of their inline children cannot be converted into one of the IRT's siblings. An inline element would have to be inserted after them as per standard element creation.