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

Updated description added sections #33

Merged
merged 18 commits into from
Apr 30, 2019
Merged

Updated description added sections #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
bd07a45
updated description added sections
egorovpavel Apr 24, 2019
e0fe5be
updated features images
egorovpavel Apr 24, 2019
f1ec18b
minor changes
egorovpavel Apr 24, 2019
0625c43
minor changes
egorovpavel Apr 24, 2019
29d6320
minor changes
egorovpavel Apr 24, 2019
22e9bb9
minor changes
egorovpavel Apr 24, 2019
194258c
minor changes
egorovpavel Apr 24, 2019
414569b
minor changes
egorovpavel Apr 24, 2019
a04f8be
minor changes
egorovpavel Apr 24, 2019
1baf1ac
minor changes
egorovpavel Apr 24, 2019
b2376b4
minor changes
egorovpavel Apr 24, 2019
f54b046
minor changes
egorovpavel Apr 24, 2019
cf0b58a
minor changes
egorovpavel Apr 24, 2019
b73a7a3
minor changes
egorovpavel Apr 24, 2019
0a0e809
README updated
egorovpavel Apr 29, 2019
c05a902
disabled failed JDK tests
egorovpavel Apr 29, 2019
892e2e0
copy updated
egorovpavel Apr 30, 2019
0762ae4
copy updated
egorovpavel Apr 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ jdk:
- oraclejdk9
- openjdk8
#- oraclejdk11
- openjdk10
- openjdk11
#- openjdk10
#- openjdk11
services:
- docker
jobs:
Expand Down
126 changes: 103 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,71 @@
![Alt text](https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/banner.png "GroupDocs.Annotation")
![Groupdocs document & pdf annotator](https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/banner.png "GroupDocs.Annotation")
# GroupDocs.Annotation for Java Dropwizard Example
###### version 1.12.17

[![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)
[![Maintainability](https://api.codeclimate.com/v1/badges/4d0833612964debe5cf8/maintainability)](https://codeclimate.com/github/groupdocs-annotation/GroupDocs.Annotation-for-Java-Dropwizard/maintainability)
[![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)

## System Requirements
- Java 8 (JDK 1.8)
- Maven 3


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

Thanks to powerful and flexible [GroupDocs.Annotation for Java](https://products.groupdocs.com/Annotation/java) API, over 50 document formats are supported.
**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.

**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).
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.


**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).


## Demo Video
https://www.youtube.com/watch?v=TVb7GwSNDqw

<p align="center">
<a title="Document annotation for JAVA " href="https://www.youtube.com/watch?v=TVb7GwSNDqw">
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/document-annotation-demo.gif" width="100%" style="width:100%;">
</a>
</p>


## Features
<p>
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Text_annotation.png?v=1" align="left" width="430"/>
<br/><br/><br/>
<b>Text annotation</b>
<div>Add text annotations in any document. Specify font size, set colors, add comments and collaborate.</div>
<br/><br/><br/><br/>
</p>
<br/>
<p>
<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"/>
<br/><br/><br/>
<b>Freehand Drawing</b>
<div>Draw on a document using a freehand drawing tool. Easily highlight specific areas on your document page.</div>
<br/><br/><br/>
</p>
<br/>
<p>
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Blackout-annotation.png?v=1" align="left" width="430"/>
<br/><br/><br/>
<b>Blackout & Redaction</b>
<div>Blackout and redact sensitive or personally identifiable information on your document.</div>
<br/><br/><br/><br/>
</p>
<br/>
<p>
<img src="https://raw.githubusercontent.com/groupdocs-annotation/groupdocs-annotation.github.io/master/resources/image/Collaborate-annotation.png?v=1" align="left" width="430"/>
<br/><br/><br/>
<b>Comments</b>
<div>Collaborate and comment on any annotation. Start a discussion right in a document without database dependency/integration.</div>
<br/><br/><br/><br/><br/><br/>
</p>
<hr/>

### More features

## Features
- Clean, modern and intuitive design
- Easily switchable colour theme (create your own colour theme in 5 minutes)
- Responsive design
Expand All @@ -36,19 +78,19 @@ https://www.youtube.com/watch?v=TVb7GwSNDqw
- Download annotated documents
- Upload documents
- Annotate document with such annotation types:
* Text
* Area
* Point
* TextStrikeout
* Polyline
* TextField
* Watermark
* TextReplacement
* Arrow
* TextRedaction
* ResourcesRedaction
* TextUnderline
* Distance
* **Text** – highlights and comments selected text
* **Area** – marks an area with a rectangle and adds notes to it
* **Point** – sticks comments to any point in a document
* **TextStrikeout** – marks text with a strikethrough styling
* **Polyline** – draws shapes and freehand lines
* **TextField** – adds rectangle with a text inside
* **Watermark** - Horizontal textual watermark
* **TextReplacement** – replaces original text with user’s text
* **Arrow** – draws an arrow on a document
* **TextRedaction** – fills black rectangle with fixed position (used if you want to hide some text)
* **ResourcesRedaction** – fills black rectangle with fixed position
* **TextUnderline** – marks text with a underline styling
* **Distance** – measures a distance between objects in a document
- Draw annotation over the document page
- Add comment or reply
- Print document
Expand Down Expand Up @@ -91,7 +133,7 @@ java -jar annotation-1.12.17.jar configuration.yaml
```

#### Docker image
Use [docker](https://www.docker.com/) image.
Use [docker](https://hub.docker.com/u/groupdocs) image.

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

#### Configuration
## Configuration
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`.

### Annotation configuration options

| Option | Type | Default value | Description |
| ---------------------------------- | ------- |:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------- |
| **`filesDirectory`** | String | `DocumentSamples` | Files directory path. Indicates where uploaded and predefined files are stored. It can be absolute or relative path |
| **`fontsDirectory`** | String | | Path to custom fonts directory. |
| **`defaultDocument`** | String | | Absolute path to default document that will be loaded automaticaly. |
| **`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 |
| **`textAnnotation`** | Boolean | `true` | Enable/disable Text annotation |
| **`areaAnnotation`** | Boolean | `true` | Enable/disable Area annotation |
| **`areaAnnotation`** | Boolean | `true` | Enable/disable Point annotation |
| **`pointAnnotation`** | Boolean | `true` | Enable thumbnails preview |
| **`textStrikeoutAnnotation`** | Boolean | `true` | Enable/disable TextStrikeout annotation |
| **`polylineAnnotation`** | Boolean | `true` | Enable/disable Polyline annotation |
| **`textFieldAnnotation`** | Boolean | `true` | Enable/disable TextField annotation |
| **`watermarkAnnotation`** | Boolean | `true` | Enable/disable Watermark annotation |
| **`textReplacementAnnotation`** | Boolean | `true` | Enable/disable TextReplacement annotation |
| **`arrowAnnotation`** | Boolean | `true` | Enable/disable Arrow annotation |
| **`textRedactionAnnotation`** | Boolean | `true` | Enable/disable TextRedaction annotation |
| **`resourcesRedactionAnnotation`** | Boolean | `true` | Enable/disable ResourcesRedaction annotation |
| **`textUnderlineAnnotation`** | Boolean | `true` | Enable/disable TextUnderline annotation |
| **`distanceAnnotation`** | Boolean | `true` | Enable/disable Distance annotation |
| **`downloadOriginal`** | Boolean | `true` | Enable/disable original document downloading |
| **`downloadAnnotated`** | Boolen | `true` | Enable/disable signed document downloading |
| **`zoom`** | Boolean | `true` | Enable/disable zoom |
| **`fitWidth`** | Boolean | `true` | Enable/disable fit width. Set true to zoom document pages fit width |

## License
The MIT License (MIT).

Please have a look at the LICENSE.md for more details

## GroupDocs Annotation on other platforms & frameworks

- JAVA Spring [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-Java-Spring)
- .NET MVC [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-.NET-MVC)
- .NET WebForms [Document & PDF annotator](https://github.com/groupdocs-annotation/GroupDocs.Annotation-for-.NET-WebForms)

## Resources
- **Website:** [www.groupdocs.com](http://www.groupdocs.com)
- **Product Home:** [GroupDocs.Annotation for Java](https://products.groupdocs.com/Annotation/java)
Expand Down