Skip to main content

Smallsite Design

Online editing help

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.

The basic formatting inline elements are:
#ElementExampleDescription
aTexttextPlain unformatted text. The only element that can start or end with a space, or just be all spaces
bEmphasisemText needing to stand out slightly from the rest to indicate that it is something to be noted
cStrongstrongText to be properly noticed as being important. A stronger version of emphasis
dSubscriptsubText that qualifies its adjacent text in a subordinate way, as defined by the context. Typically used as a subclass identifier
eSuperscriptsupText that qualifies its adjacent text in a superior way, as defined by the context. Typically used as power notation in numeric statements
fDeletedelIndicates text that has been, or is to be, removed
gInsertinsIndicates text that has been, or is to be, inserted
hSelectselIndicates the current selection
iKeykeyKey on a keyboard
jMarkmarkHighlighted text, with a choice of colours
kBdobdoElement 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
lBreakbreak
here
Force a new line
mSoft hypheneventuallyOptional 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.

The code formatting inline elements are:
#ElementExampleDescription
aComment// CommentCode text to be ignored by the compiler or interpreter
bFunctionstr_splitName of a function
cIdentifier$firstCellIdentifier for a constant or variable
dKeywordfunctionKeyword of special meaning to the compiler or interpreter
eTag<html>For HTML or XML tag
fCommentaryCommentaryNon-code commentary on the line of code
gKeyboardkbdIndicates text typed by a user
hVariablevarIndicate 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.

The inline rich text elements are:
#ElementExampleDescription
aQuoteqSolitary or outer quotes, as defined by the Quotes pattern defined for the current Locale
bSubquoteqsInner quotes, as defined by the Quotes pattern defined for the current Locale
cSamplesampUseful for sample text or labels
dCodecodeFor 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.

The functional inline elements are:
#ElementExampleDescription
aLinkGlossaryHypertext link – the fundamental enabler for navigating between pages on the worldwide web
bCitationThe ProphetName 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
cFilefileFile for download. The file must be Embeddable to download
dIconSmallsite Design's SD iconShow an icon
eMailpollie@govSpecial 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
fTimeFormatted date or time, with a choice of formats, calendars and timezones. Time format is yyyy-mm-dd-hh-mm-ss
gValueABNShows 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.


Manage         Help   Powered by: Smallsite Design©Patanjali Sokaris         art-a  3  0  2022-05-11-10-25-03