We are currently on Tridion Docs 14 SP3, with Collective Spaces. We would like to programmatically highlight and annotate predefined phrases in a publication, or create comments, I saw a blurb about being able to find, update and delete annotations in SP1, and talks about more improvements in the future, and am having a hard time figuring out how I can create annotations using the API in SP3, any suggestions would be helpful.
Thanks in advance for any assistance in this matter.
Hi Akheil,
You found the right API call, that would certainly allow you to create topic level annotations. That is relatively easy.
The same API call is used by Draft Space and Review Space to create phrase level annotations. The annotation addressing logic however is considered private by Fonto SDK so far to my knowledge. I've created a simple example once in ISHRemote (hope you don't mind :)), see https://github.com/RWS/ISHRemote/blob/master/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Annotation/AddIshAnnotation.Tests.ps1#L109
The annotation addressing logic is quite complex as we do support Annotation Position Recovery - so suppose extra characters or paragraphs were added in between topic revisions we still do a very good attempt to have the Annotation float next to the new location. Even undocumented it is still a contract within Tridion Docs as you can imagine that our database is filling up with annotation addresses as we speak.
If you have a clear use case on why you would need the addressing logic public, I will be happy to bring it to that team.
Hope this helps,
Dave
Hi Akheil,
You found the right API call, that would certainly allow you to create topic level annotations. That is relatively easy.
The same API call is used by Draft Space and Review Space to create phrase level annotations. The annotation addressing logic however is considered private by Fonto SDK so far to my knowledge. I've created a simple example once in ISHRemote (hope you don't mind :)), see https://github.com/RWS/ISHRemote/blob/master/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Annotation/AddIshAnnotation.Tests.ps1#L109
The annotation addressing logic is quite complex as we do support Annotation Position Recovery - so suppose extra characters or paragraphs were added in between topic revisions we still do a very good attempt to have the Annotation float next to the new location. Even undocumented it is still a contract within Tridion Docs as you can imagine that our database is filling up with annotation addresses as we speak.
If you have a clear use case on why you would need the addressing logic public, I will be happy to bring it to that team.
Hope this helps,
Dave
Translate
