Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
3ace committed May 30, 2024
1 parent 08c163b commit 3eb0d73
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions annotations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@ document contents, without changing the original document contents.
Support for creating annotations in UniPDF is through the unipdf/annotator package.
The annotator package creates the Annotation object and also an appearance stream, which is required to make
the annotation look the same in all viewers.

UniPDF's model package has support for all types of PDF annotations, whereas the annotator currently supports Square,
Circle, Line annotations. Support for more annotation types will be added over time. If you need support for an
unsupported annotation, please create an issue in this repository.
Circle, Ellipse, Ink, Line, and File attachment annotations. Support for more annotation types will be added over time.

If you need support for an unsupported annotation, please create an issue in this repository.

The examples in this folder illustrate a few capabilities for creating ellipse, lines, rectangles.
The examples in this folder illustrate a few capabilities for creating ellipse, file attachment, ink, lines, rectangles, and text annotation.

## Examples

- [pdf_annotate_add_ellipse.go](pdf_annotate_add_ellipse.go) adds a circle/ellipse annotation to a specified location on a page.
- [pdf_annotate_add_file.go](pdf_annotate_add_file.go) adds a file attachment annotation placed in certain position in a page.
- [pdf_annotate_add_ink.go](pdf_annotate_add_ink.go) adds an ink annotation to a specified location on a page.
- [pdf_annotate_add_line.go](pdf_annotate_add_line.go) adds a line with arrowhead between two specified points on a page.
- [pdf_annotate_add_rectangle.go](pdf_annotate_add_rectangle.go) adds a rectangle annotation to a specified location on a page.
Expand Down

0 comments on commit 3eb0d73

Please sign in to comment.