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

Commit 24494b4

Browse files
authored
Rewrited description, added new sections to README.md (#28)
1 parent c7435a6 commit 24494b4

File tree

1 file changed

+77
-17
lines changed

1 file changed

+77
-17
lines changed

README.md

Lines changed: 77 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,67 @@
44

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

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

1213

13-
## Description
14-
GroupDocs.Viewer is a native, simple, fully configurable and optimized web application which allows you to manipulate documents without requiring any other commercial application through GroupDocs APIs.
14+
## Document Viewer API for Java Spring
15+
[GroupDocs.Viewer for Java](https://products.groupdocs.com/viewer/java) API allows you to view over 90 document formats including **DOCX**, **PDF**, **PPT**, **XLS**, among many others without any additional dependencies. Thanks to its flexible configuration it can be configured to **view documents as images or as HTML5**.
1516

16-
**Note** Without a license application will run in trial mode, purchase [GroupDocs.Viewer for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Viewer for Java temporary license](https://purchase.groupdocs.com/temporary-license).
1717

18+
In order to demonstrate GroupDocs.Viewer for Java reach and powerful features we prepared a modern **document viewer** front-end web UI example. Which can be used as a standalone application or easily integrated into your project.
19+
20+
**Note:** without a license application will run in trial mode, purchase [GroupDocs.Viewer for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Viewer for Java temporary license](https://purchase.groupdocs.com/temporary-license).
21+
22+
23+
## Supported document Formats
24+
25+
| Family | Formats |
26+
| --------------------------- |:---------------------------------------------------------------------------------------------------------------------------------- |
27+
| Portable Document Format | `PDF` |
28+
| Microsoft Word | `DOC`, `DOCM` , `DOCX`, `DOT`, `DOTM`, `DOTX` |
29+
| Microsoft Excel | `XLS`, `XLSB`, `XLSM`, `XLSX`, `XLT`, `XLTM`, `XLTX` |
30+
| Microsoft PowerPoint | `PPT`, `POT`, `POTM`, `POTX`, `PPS`, `PPSM`, `PPSX`, `PPTM`, `PPTX` |
31+
| Microsoft Visio | `VSD`, `VDW`, `VDX`, `VSDX`, `VSS`, `VST`, `VSX`, `VTX` |
32+
| Microsoft Project | `MPP`, `MPT` |
33+
| Microsoft Outlook | `EML`, `EMLX`, `MSG` |
34+
| OpenDocument Formats | `ODT`, `ODP`, `ODS`, `OTT` |
35+
| Plain Text File | `TXT` |
36+
| Comma-Separated Values | `CSV` |
37+
| HyperText Markup Language | `HTML`, `MHT`, `MHTML`, `SVG` |
38+
| Extensible Markup Language | `XML`,`XML`, `XPS` |
39+
| AutoCAD Drawing File Format | `DGN`, `DWG`, `DXF` |
40+
| Image files | `BMP`, `CAL`, `DCX`, `DIB`, `EMF`, `GIF`, `JP2`, `JPG`, `MIL`, `MIL`, `PCD`, `PCT`, `PCX`, `PNG`, `PSD`, `RAS`, `TGA`,`TIFF`,`WMF` |
41+
| Electronic publication | `EPUB` |
42+
| Windows Icon | `ICO` |
43+
| Medical image files | `DCM` |
1844

1945
## Demo Video
20-
https://www.youtube.com/watch?v=NnZaMNUC6o0
2146

47+
<p align="center">
48+
<a title="Document viewer for JAVA " href="https://www.youtube.com/watch?v=NnZaMNUC6o0">
49+
<img src="https://raw.githubusercontent.com/groupdocs-viewer/groupdocs-viewer.github.io/master/resources/image/document-viewer-demo.gif" width="100%" style="width:100%;">
50+
</a>
51+
</p>
2252

2353
## Features
54+
- Responsive design
55+
- Zoom in/out documents without quality loss in HTML mode
56+
- Thumbnails
57+
- Smooth page navigation
58+
- Smooth document scrolling
59+
- Preload pages for faster document rendering
60+
- Multi-language support for displaying errors
61+
- Display two or more pages side by side (when zooming out)
62+
- Cross-browser support (Safari, Chrome, Opera, Firefox)
63+
- Cross-platform support (Windows, Linux, MacOS)
2464
- Clean, modern and intuitive design
2565
- Easily switchable colour theme (create your own colour theme in 5 minutes)
26-
- Responsive design
2766
- Mobile support (open application on any mobile device)
28-
- Support over 50 documents and image formats
67+
- Support over 50 documents and image formats including **DOCX**, **PDF**, **PPT**, **XLS**
2968
- HTML and image modes
3069
- Fully customizable navigation panel
3170
- Open password protected documents
@@ -34,15 +73,6 @@ https://www.youtube.com/watch?v=NnZaMNUC6o0
3473
- Upload documents
3574
- Print document
3675
- Rotate pages
37-
- Zoom in/out documents without quality loss in HTML mode
38-
- Thumbnails
39-
- Smooth page navigation
40-
- Smooth document scrolling
41-
- Preload pages for faster document rendering
42-
- Multi-language support for displaying errors
43-
- Display two or more pages side by side (when zooming out)
44-
- Cross-browser support (Safari, Chrome, Opera, Firefox)
45-
- Cross-platform support (Windows, Linux, MacOS)
4676

4777
## How to run
4878

@@ -94,9 +124,39 @@ docker run -p 8080:8080 --env application.hostAddress=localhost -v `pwd`/Documen
94124
## Open http://localhost:8080/viewer/ in your favorite browser.
95125
```
96126

97-
#### Configuration
98-
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`.
127+
### Configuration
128+
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`.
129+
130+
#### Viewer configuration options
131+
132+
| Option | Type | Default value | Description |
133+
| ---------------------- | ------- |:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------- |
134+
| **`filesDirectory`** | String | `DocumentSamples` | Files directory path. Indicates where uploaded and predefined files are stored. It can be absolute or relative path |
135+
| **`fontsDirectory`** | String | | Path to custom fonts directory. |
136+
| **`defaultDocument`** | String | | Absolute path to default document that will be loaded automaticaly. |
137+
| **`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 |
138+
| **`htmlMode`** | Boolean | `true` | HTML rendering mode. Set `false` to view documents in image mode. Set `true` to view documents in HTML mode |
139+
| **`zoom`** | Boolean | `true` | Enable or disable Document zoom |
140+
| **`search`** | Boolean | `true` | Enable or disable document search |
141+
| **`thumbnails`** | Boolean | `true` | Enable thumbnails preview |
142+
| **`rotate`** | Boolean | `true` | Enable individual page rotation functionality |
143+
| **`cache`** | Boolean | `true` | Set true to enable cache |
144+
| **`saveRotateState`** | Boolean | `true` | If enabled it will save chages made by rotating individual pages to same file. |
145+
| **`watermarkText`** | String | | Text which will be used as a watermark |
146+
147+
**Note**: you can also set the above options using environment variables. For example to set rendering to image mode set `application.viewer.htmlMode` environment variable to `false`
148+
149+
150+
## License
151+
The MIT License (MIT).
152+
153+
Please have a look at the LICENSE.md for more details
154+
155+
## GroupDocs Document Viewer on other platforms/frameworks
99156

157+
- JAVA DropWizard [Document Viewer](https://github.com/groupdocs-viewer/GroupDocs.Viewer-for-Java-Dropwizard)
158+
- .NET MVC [Document viewer](https://github.com/groupdocs-viewer/GroupDocs.Viewer-for-.NET-MVC)
159+
- .NET WebForms [Document viewer](https://github.com/groupdocs-viewer/GroupDocs.Viewer-for-.NET-WebForms)
100160

101161

102162
## Resources

0 commit comments

Comments
 (0)