Skip to content
This repository was archived by the owner on Jul 26, 2021. It is now read-only.

Commit 74c9ee3

Browse files
egorovpavelegorovpavel
authored
Updated description added sections (#33)
2 parents 60cd85f + 0762ae4 commit 74c9ee3

File tree

2 files changed

+105
-25
lines changed

2 files changed

+105
-25
lines changed

‎.travis.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ jdk:
55
- oraclejdk9
66
- openjdk8
77
#- oraclejdk11
8-
- openjdk10
9-
- openjdk11
8+
#- openjdk10
9+
#- openjdk11
1010
services:
1111
- docker
1212
jobs:

‎README.md‎

Lines changed: 103 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,71 @@
1-
![Alt text](https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/banner.png "GroupDocs.Annotation")
1+
![Groupdocs document & pdf annotator](https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/banner.png "GroupDocs.Annotation")
22
# GroupDocs.Annotation for Java Dropwizard Example
33
###### version 1.12.17
44

55
[![Build Status](https://travis-ci.org/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard.svg?branch=master)](https://travis-ci.org/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard)
66
[![Maintainability](https://api.codeclimate.com/v1/badges/4d0833612964debe5cf8/maintainability)](https://codeclimate.com/github/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard/maintainability)
7+
[![GitHub license](https://img.shields.io/github/license/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard.svg)](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard/blob/master/LICENSE)
78

89
## System Requirements
910
- Java 8 (JDK 1.8)
1011
- Maven 3
1112

1213

13-
## Description
14-
You asked, we delivered!
15-
Welcome our new and improved GroupDocs.Annotation UI - native, simple, fully configurable and optimized Java document Annotation application.
14+
## Annotate & write on document with Java Dropwizard
1615

17-
Thanks to powerful and flexible [GroupDocs.Annotation for Java](https://products.groupdocs.com/Annotation/java) API, over 50 document formats are supported.
16+
**GroupDocs.Annotations for Java** is a powerful library that provides flexible API which allows you to **annotate PDF**, DOCX, PPT, XLS, and over 90 document formats without external dependencies and/or additional document conversions such us (DOCX to PDF or PPT to PDF). With GroupDocs.Annotation API you can write on documents using various annotation tools such as arrow annotation, text annotation or even draw on a document with help of freehand annotation drawing tool.
1817

19-
**Note** Without a license application will run in trial mode, purchase [GroupDocs.Annotation for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Annotation for Java temporary license](https://purchase.groupdocs.com/temporary-license).
18+
With GroupDocs.Annotation for Java Dropwizard application, you can annotate and **write on document** using our modern and responsive web UI interface. Thanks to flexible and highly customizable configuration it can be used as standalone application or can be integrated into your project within few simple steps.
19+
20+
21+
**Note:** without a license application will run in trial mode, purchase [GroupDocs.Annotation for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Annotation for Java temporary license](https://purchase.groupdocs.com/temporary-license).
2022

2123

2224
## Demo Video
23-
https://www.youtube.com/watch?v=TVb7GwSNDqw
2425

26+
<p align="center">
27+
<a title="Document annotation for JAVA " href="https://www.youtube.com/watch?v=TVb7GwSNDqw">
28+
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/document-annotation-demo.gif" width="100%" style="width:100%;">
29+
</a>
30+
</p>
31+
32+
33+
## Features
34+
<p>
35+
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Text_annotation.png?v=1" align="left" width="430"/>
36+
<br/><br/><br/>
37+
<b>Text annotation</b>
38+
<div>Add text annotations in any document. Specify font size, set colors, add comments and collaborate.</div>
39+
<br/><br/><br/><br/>
40+
</p>
41+
<br/>
42+
<p>
43+
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Free-hand-annotation.png?v=1" align="left" width="430"/>
44+
<br/><br/><br/>
45+
<b>Freehand Drawing</b>
46+
<div>Draw on a document using a freehand drawing tool. Easily highlight specific areas on your document page.</div>
47+
<br/><br/><br/>
48+
</p>
49+
<br/>
50+
<p>
51+
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Blackout-annotation.png?v=1" align="left" width="430"/>
52+
<br/><br/><br/>
53+
<b>Blackout & Redaction</b>
54+
<div>Blackout and redact sensitive or personally identifiable information on your document.</div>
55+
<br/><br/><br/><br/>
56+
</p>
57+
<br/>
58+
<p>
59+
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Collaborate-annotation.png?v=1" align="left" width="430"/>
60+
<br/><br/><br/>
61+
<b>Comments</b>
62+
<div>Collaborate and comment on any annotation. Start a discussion right in a document without database dependency/integration.</div>
63+
<br/><br/><br/><br/><br/><br/>
64+
</p>
65+
<hr/>
66+
67+
### More features
2568

26-
## Features
2769
- Clean, modern and intuitive design
2870
- Easily switchable colour theme (create your own colour theme in 5 minutes)
2971
- Responsive design
@@ -36,19 +78,19 @@ https://www.youtube.com/watch?v=TVb7GwSNDqw
3678
- Download annotated documents
3779
- Upload documents
3880
- Annotate document with such annotation types:
39-
* Text
40-
* Area
41-
* Point
42-
* TextStrikeout
43-
* Polyline
44-
* TextField
45-
* Watermark
46-
* TextReplacement
47-
* Arrow
48-
* TextRedaction
49-
* ResourcesRedaction
50-
* TextUnderline
51-
* Distance
81+
* **Text** – highlights and comments selected text
82+
* **Area** – marks an area with a rectangle and adds notes to it
83+
* **Point** – sticks comments to any point in a document
84+
* **TextStrikeout** – marks text with a strikethrough styling
85+
* **Polyline** – draws shapes and freehand lines
86+
* **TextField** – adds rectangle with a text inside
87+
* **Watermark** - Horizontal textual watermark
88+
* **TextReplacement** – replaces original text with user’s text
89+
* **Arrow** – draws an arrow on a document
90+
* **TextRedaction** – fills black rectangle with fixed position (used if you want to hide some text)
91+
* **ResourcesRedaction** – fills black rectangle with fixed position
92+
* **TextUnderline** – marks text with a underline styling
93+
* **Distance** – measures a distance between objects in a document
5294
- Draw annotation over the document page
5395
- Add comment or reply
5496
- Print document
@@ -91,7 +133,7 @@ java -jar annotation-1.12.17.jar configuration.yaml
91133
```
92134

93135
#### Docker image
94-
Use [docker](https://www.docker.com/) image.
136+
Use [docker](https://hub.docker.com/u/groupdocs) image.
95137

96138
```bash
97139
mkdir DocumentSamples
@@ -100,9 +142,47 @@ docker run -p 8080:8080 --env application.hostAddress=localhost -v `pwd`/Documen
100142
## Open http://localhost:8080/annotation/ in your favorite browser.
101143
```
102144

103-
#### Configuration
145+
## Configuration
104146
For all methods above you can adjust settings in `configuration.yml`. By default in this sample will lookup for license file in `./Licenses` folder, so you can simply put your license file in that folder or specify relative/absolute path by setting `licensePath` value in `configuration.yml`.
105147

148+
### Annotation configuration options
149+
150+
| Option | Type | Default value | Description |
151+
| ---------------------------------- | ------- |:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------- |
152+
| **`filesDirectory`** | String | `DocumentSamples` | Files directory path. Indicates where uploaded and predefined files are stored. It can be absolute or relative path |
153+
| **`fontsDirectory`** | String | | Path to custom fonts directory. |
154+
| **`defaultDocument`** | String | | Absolute path to default document that will be loaded automaticaly. |
155+
| **`preloadPageCount`** | Integer | `0` | Indicate how many pages from a document should be loaded, remaining pages will be loaded on page scrolling.Set `0` to load all pages at once |
156+
| **`textAnnotation`** | Boolean | `true` | Enable/disable Text annotation |
157+
| **`areaAnnotation`** | Boolean | `true` | Enable/disable Area annotation |
158+
| **`areaAnnotation`** | Boolean | `true` | Enable/disable Point annotation |
159+
| **`pointAnnotation`** | Boolean | `true` | Enable thumbnails preview |
160+
| **`textStrikeoutAnnotation`** | Boolean | `true` | Enable/disable TextStrikeout annotation |
161+
| **`polylineAnnotation`** | Boolean | `true` | Enable/disable Polyline annotation |
162+
| **`textFieldAnnotation`** | Boolean | `true` | Enable/disable TextField annotation |
163+
| **`watermarkAnnotation`** | Boolean | `true` | Enable/disable Watermark annotation |
164+
| **`textReplacementAnnotation`** | Boolean | `true` | Enable/disable TextReplacement annotation |
165+
| **`arrowAnnotation`** | Boolean | `true` | Enable/disable Arrow annotation |
166+
| **`textRedactionAnnotation`** | Boolean | `true` | Enable/disable TextRedaction annotation |
167+
| **`resourcesRedactionAnnotation`** | Boolean | `true` | Enable/disable ResourcesRedaction annotation |
168+
| **`textUnderlineAnnotation`** | Boolean | `true` | Enable/disable TextUnderline annotation |
169+
| **`distanceAnnotation`** | Boolean | `true` | Enable/disable Distance annotation |
170+
| **`downloadOriginal`** | Boolean | `true` | Enable/disable original document downloading |
171+
| **`downloadAnnotated`** | Boolen | `true` | Enable/disable signed document downloading |
172+
| **`zoom`** | Boolean | `true` | Enable/disable zoom |
173+
| **`fitWidth`** | Boolean | `true` | Enable/disable fit width. Set true to zoom document pages fit width |
174+
175+
## License
176+
The MIT License (MIT).
177+
178+
Please have a look at the LICENSE.md for more details
179+
180+
## GroupDocs Annotation on other platforms & frameworks
181+
182+
- JAVA Spring [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Java-Spring)
183+
- .NET MVC [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-.NET-MVC)
184+
- .NET WebForms [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-.NET-WebForms)
185+
106186
## Resources
107187
- **Website:** [www.groupdocs.com](http://www.groupdocs.com)
108188
- **Product Home:** [GroupDocs.Annotation for Java](https://products.groupdocs.com/Annotation/java)

0 commit comments

Comments
 (0)