Inline Notes Plugin

Annotation plugin for adding Inline Notes in text content. Please use this plugin only if you understand that the added text in some situations may follow the article from the Writer to the presentation layer.

Disclaimer

IMPORTANT: Please note that the Inline Notes plugin stores the inline text in the article NewsML document, as part of the article content, using the INS tag.
INS tags are not removed in standard workflows, like sending an article to the Public content repository.

If you are using the plugin for notes that you don't want to publish, our recommendation is NOT to use the Inline Notes plugin.

If your use case needs the function, we strongly recommend you to make sure your presentation layer removes all INS tags before publishing to the public.

Naviga Web and the App Platform can both be configured to remove INS tags from the content before showing it. But there may also be existing customer specific occasions where the complete article document is sent in a request payload. Older versions of Everyware and apps do not have built-in support for removing INS tags. If you start using the Inline Notes plugin in an existing presentation setup, you need to consult Naviga for help.

Please also note that inline notes automatically will be removed in the new Naviga doc (JSON) version of the content item, available via the CCA and DAPI APIs.

Plugin Configuration

{
    "id": "io.infomaker.inlinenotes",
    "name": "im-inlinenotes",
    "url": "https://plugins.writer.infomaker.io/v1/infomaker/im-inlinenotes/{PLUGIN_VERSION}/index.js",
    "style": "https://plugins.writer.infomaker.io/v1/infomaker/im-inlinenotes/{PLUGIN_VERSION}/style.css",
    "enabled": true,
    "mandatory": false
}

Output

A inline note is found inline as an <ins>-element in the content text element.

<idf xmlns="http://www.infomaker.se/idf/1.0" dir="ltr" xml:lang="en-US">
    <group type="body">
      <element id="paragraph-4225b6447937c83a459a106e3f5acf59" type="body">
        This is some body text <ins id="inlinenote-9e79b09857f90f5b0a474945e21a8188" username="pelle.plutt@infomaker.io" creationdate="2019-03-22T13:43:43.309Z">And this is a comment</ins>.
      </element>
    </group>
</idf>