mark_annotation¶
- class atlas_doc_parser.marks.mark_annotation.AnnotationType[source]¶
Valid values for the
annotationTypeattribute.
- class atlas_doc_parser.marks.mark_annotation.MarkAnnotationAttrs(id: str = REQ, annotationType: str = REQ)[source]¶
Attributes for
MarkAnnotation.- Parameters:
id – Required. Unique identifier for the annotation.
annotationType – Required. The type of annotation, currently only
"inlineComment"is supported.
- class atlas_doc_parser.marks.mark_annotation.MarkAnnotation(type: str = 'annotation', attrs: MarkAnnotationAttrs = REQ)[source]¶
Marks text with an inline annotation (comment).
The annotation mark is used to associate inline comments with specific text ranges in Confluence pages. When users highlight text and add a comment, the highlighted text is wrapped with this mark containing a unique
idthat links to the comment.