Inlines allow an iCM user to embed content into an article they are writing.
The standard selection of inline types include links to other articles within iCM, links to documents and other items in the iCM Media Library, external links, images and a script inline which can be used to embed JavaScript, HTML fragments and other third party embedding code like YouTube videos.
For a full description of the standard inlines supported by the sites, see Inlines - Standard Behaviour.
Creating an Inline Type
To create a new inline definition, click "Create an inline type" in the action panel.
Remember that as well as creating an inline in iCM, your site code will need to be updated so that it knows what to do with your inline.
Properties
Inlines have four properties.
| Property | Description |
|---|---|
| Name | The name, visible in iCM |
| Icon | The icon is visible within iCM. Choose a 17x17 *.gif or *.png image to use as an icon for the inline type. (The *.png type is only available from iCM 10.0.4.0.) |
| Block | If required, check the "Block" option to close any open block HTML element before the inline. This allows an inline to be defined that creates self-contained blocks of HTML |
| Pattern | Use the "Create" button to create your inline pattern (see below) Once an inline is in use it's not possible to delete the pattern |
Users
This tab lists all of the current user who have access to the inline. You can add groups and users form here, which has the same effect as editing users via the iCM Groups and Users section.
Inline Patterns
Inline patterns are complicated. Look at an existing pattern and compare it to the HTML inserted into the article editor to get a better understanding of how they work.
| Argument | Description |
|---|---|
| Fixed Text | The fixed text argument creates a fixed piece of text that will appear within the inline without any need to prompt the article author for any input. It is generally used to build the arguments for a full inline pattern |
| Select Text | The select text argument prompts the article author to select pre-defined options from a drop-down list. For example, external links could be given the options _blank or _self |
| Text Prompt | The text prompt argument prompts the article author to enter a piece of text into the inline |
| Numeric Prompt | The numeric prompt argument prompts the article author to enter a numeric value |
| Content Prompt | The content prompt lets the article author select an item from the iCM content library to embed into their article |
Example
This example shows a standard document link inline.
The pattern entered in the Inline Type Definition.
The inline dialogue in the article editor.
And the text visible in the HTML view of the article editor.
<p><span data-icm-arg2="6" data-icm-arg2name="Test PDF document 1" data-icm-arg4="An Alternative Title" data-icm-arg6="_self" data-icm-inlinetypeid="2">Type=media;MediaID=6;Title=An Alternative Title;Target=_self;</span></p>
Standard Inline Types
The inline types supported by your site are described in the Inlines - Standard Behaviour section of the site framework documentation.
Share this page
