Skip to content

Commit 69b8960

Browse files
authored
standardized readme.md
1 parent a73e808 commit 69b8960

1 file changed

Lines changed: 79 additions & 59 deletions

File tree

README.md

Lines changed: 79 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,78 @@
1-
# GroupDocs.Conversion Cloud SDK for Java
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) [![GitHub license](https://img.shields.io/github/license/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java)](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java/blob/master/LICENSE)
22

3-
This repository contains GroupDocs.Conversion Cloud SDK for Java source code. This SDK allows you to work with GroupDocs.Conversion Cloud REST APIs in your Java applications.
3+
# Java SDK to Convert Documents in the Cloud
44

5-
## Requirements
5+
[GroupDocs.Conversion Cloud SDK for Java](https://products.groupdocs.cloud/conversion/java) wraps GroupDocs.Conversion RESTful APIs so you may integrate **Document Conversion** features in your own apps with zero initial cost.
6+
7+
GroupDocs.Conversion Cloud API allows the developers to convert between 50+ file formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument files, images & more.
8+
9+
## Document Conversion REST API
10+
11+
- Convert the whole document to the desired target format.
12+
- Convert specific document page(s) or a page range.
13+
- Auto-detect source document format without requiring the file extension.
14+
- Load source document with extended options, such as specify password for password-protected documents.
15+
- Load specific part of the document.
16+
- Show or hide document comments.
17+
- Obtain all supported conversion formats list.
18+
- Replace missing fonts with any other font.
19+
- Add text or image watermarks to any page.
20+
- Specify resolution and quality for resultant images.
21+
- Extract metadata & basic information about the source document.
22+
- Integrated storage API.
23+
24+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/conversion/developer-guide/) to know more about GroupDocs.Conversion REST API.
25+
26+
## Microsoft File Formats
27+
28+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
29+
**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
30+
**Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX\
31+
**Microsoft Project:** MPP, MPT\
32+
**Microsoft Outlook:** MSG, EML\
33+
**Microsoft Visio:** VSD, VDX, VSS, VSX, VST, VTX, VSDX, VDW, VSSX, VSTX, VSDM, VSTM, VSSM\
34+
**Microsoft OneNote:** ONE
35+
36+
## Other Formats
37+
38+
**Page Layout Formats:** PDF, XPS\
39+
**OpenDocument:** ODT, OTT, ODS, ODP, OTP, OTS, ODG\
40+
**CAD:** DXF, DWG, IFC, STL\
41+
**Images:** DCM, BMP, GIF, JPG, PNG, TIFF, WebP, DjVu, SVG, DNG, ICO\
42+
**Web:** HTML, MHT, MHTML\
43+
**Emails:** EML, EMLX\
44+
**eBooks:** EPUB, MOBI\
45+
**Metafile:** WMF, EMF\
46+
**LaTeX:** TEX\
47+
**Others:** TXT, RTF, CSV, TSV, XML
48+
49+
## Get Started with GroupDocs.Conversion Cloud SDK for Java
50+
51+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps as given below.
52+
53+
### Requirements
654

755
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
856

9-
## Installation
57+
### Installation
1058

11-
To install the API client library to your local Maven repository, simply execute:
59+
Simply execute the following to install the API client library to your local Maven repository.
1260

1361
```shell
1462
mvn install
1563
```
1664

17-
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
65+
Configure the settings of the repository and execute the following to deploy it to a remote Maven repository instead.
1866

1967
```shell
2068
mvn deploy
2169
```
2270

2371
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
2472

25-
### Maven users
73+
#### Maven
2674

27-
Add following repository and dependency to your project's POM
75+
Add following repository and dependency to your project's POM.
2876

2977
```xml
3078
<repository>
@@ -43,67 +91,39 @@ Add following repository and dependency to your project's POM
4391
</dependency>
4492
```
4593

46-
### Others
47-
48-
At first generate the JAR by executing:
49-
50-
mvn package
94+
#### Others
5195

52-
Then manually install the following JARs:
96+
First generate the JAR by executing `mvn package`, then manually install the following JARs.
5397

5498
* target/groupdocs-conversion-cloud-20.11.jar
5599
* target/lib/*.jar
56100

57-
## Getting Started
58-
59-
Please follow the [installation](#installation) instruction and execute the following Java code:
101+
## Convert DOCX to PDF in the Cloud
60102

61103
```java
62-
import com.groupdocs.cloud.conversion.client.*;
63-
import com.groupdocs.cloud.conversion.model.*;
64-
import com.groupdocs.cloud.conversion.model.requests.*;
65-
import com.groupdocs.cloud.conversion.api.InfoApi;
66-
67-
import java.util.*;
68-
69-
public class ApiExample {
70-
71-
public static void main(String[] args) {
72-
//TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
73-
String appSid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
74-
String appKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
75-
76-
Configuration configuration = new Configuration(appSid, appKey);
77-
78-
InfoApi api = new InfoApi(configuration);
79-
80-
try {
81-
GetSupportedCibversionTypesRequest request = new GetSupportedConversionTypesRequest();
82-
List<SupportedFormat> response = api.getSupportedConversionTypes(request);
83-
84-
for (SupportedFormat format : response) {
85-
System.out.println(format.getSourceFormat());
86-
}
87-
} catch (ApiException e) {
88-
System.err.println("Exception when calling FileApi#copyFile");
89-
e.printStackTrace();
90-
}
91-
}
92-
}
93-
```
104+
// Get application information from https://dashboard.groupdocs.cloud
105+
String MyAppKey = "";
106+
String MyAppSid = "";
94107

95-
## Licensing
108+
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
96109

97-
All GroupDocs.Conversion Cloud SDKs are licensed under [MIT License](LICENSE).
110+
// Create API instance
111+
ConvertApi apiInstance = new ConvertApi(configuration);
98112

99-
## Resources
113+
// Prepare convert settings
114+
ConvertSettings settings = new ConvertSettings();
115+
settings.setFilePath("WordProcessing/four-pages.docx");
116+
settings.setFormat("pdf");
117+
settings.setOutputPath("converted");
118+
119+
List<StoredConvertedResult> result = apiInstance.convertDocument(new ConvertDocumentRequest(settings));
120+
```
100121

101-
+[**Website**](https://www.groupdocs.cloud)
102-
+[**Product Home**](https://products.groupdocs.cloud/conversion)
103-
+[**Documentation**](https://docs.groupdocs.cloud/conversion)
104-
+[**Free Support Forum**](https://forum.groupdocs.cloud/c/conversion)
105-
+[**Blog**](https://blog.groupdocs.cloud/category/conversion)
122+
## GroupDocs.Conversion Cloud SDKs in Popular Languages
106123

107-
## Contact Us
124+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
125+
|---|---|---|---|---|---|---|
126+
| [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android) |
127+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Conversion-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-conversion-cloud) | [PIP](https://pypi.org/project/groupdocs-conversion-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_conversion_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-conversion-cloud) | |
108128

109-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/conversion).
129+
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/conversion/java) | [Documentation](https://docs.groupdocs.cloud/conversion/) | [Live Demo](https://products.groupdocs.app/conversion/total) | [API Reference](https://apireference.groupdocs.cloud/conversion/) | [Code Samples](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples) | [Blog](https://blog.groupdocs.cloud/category/conversion/) | [Free Support](https://forum.groupdocs.cloud/c/conversion) | [Free Trial](https://dashboard.groupdocs.cloud)

0 commit comments

Comments
 (0)