Skip to content

Commit 124892b

Browse files
kemister85ltroutonShiridiGandham
authored
DOC-2440: Document Converters Self-Hosted Advert Pages. (#3323)
* DOC-2440: Document Converters SService. * DOC-2438: `Docx to HTML` and `HTML to Docx` converter api documentation. (#3381) * DOC-2438: Docx to HTML and HTML to Docx converter api documentation. * Update modules/ROOT/pages/html-to-docx-converter-api.adoc Co-authored-by: ltrouton <[email protected]> * Update modules/ROOT/pages/html-to-docx-converter-api.adoc * Update modules/ROOT/pages/docx-to-html-converter-api.adoc * Update modules/ROOT/pages/docx-to-html-converter-api.adoc --------- Co-authored-by: ltrouton <[email protected]> * DOC-2439: Export to PDF Standalone Service. (#3338) * DOC-2439: Export to PDF Standalone Service. * DOC-2439: RE-write, removal of curl examples, and more simplified documentation. * DOC-2439: add demo, restructure nav.adoc, update content. * DOC-2439: Remove index.html page, add raw demo and update placeholder content. * DOC-2439: fix container alignment and margins. * Update modules/ROOT/pages/html-to-pdf-converter-api.adoc * Update modules/ROOT/pages/html-to-pdf-converter-api.adoc Link update * Update modules/ROOT/pages/html-to-pdf-converter-api.adoc Update link text. * Update modules/ROOT/pages/html-to-pdf-converter-api.adoc Open link in new tab. * DOC-2439: Copy edits, and replacing string with variables. * DOC-2439: remove Options Available for HTML to PDF Conversion, Demo and Export to PDF Plugin reference and rename the API Reference to PDF Converter API reference. --------- Co-authored-by: shirqa <[email protected]> * DOC-2440: console error fix. --------- Co-authored-by: ltrouton <[email protected]> Co-authored-by: shirqa <[email protected]>
1 parent 2612ac1 commit 124892b

File tree

6 files changed

+153
-0
lines changed

6 files changed

+153
-0
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,10 +311,13 @@
311311
**** xref:mediaembed-server-integration.adoc[Integrate Enhanced Media Embed Server]
312312
*** xref:advtable.adoc[Enhanced Tables]
313313
*** xref:exportpdf.adoc[Export to PDF]
314+
**** xref:html-to-pdf-converter-api.adoc[HTML to PDF Converter API]
314315
*** xref:exportword.adoc[Export to Word]
316+
**** xref:html-to-docx-converter-api.adoc[HTML to DOCX Converter API]
315317
*** xref:footnotes.adoc[Footnotes]
316318
*** xref:formatpainter.adoc[Format Painter]
317319
*** xref:importword.adoc[Import from Word]
320+
**** xref:docx-to-html-converter-api.adoc[DOCX to HTML Converter API]
318321
*** xref:editimage.adoc[Image Editing]
319322
*** xref:inline-css.adoc[Inline CSS]
320323
*** xref:linkchecker.adoc[Link Checker]
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= Docx to HTML Converter API
2+
:navtitle: Docx to HTML Converter API
3+
:description: The DOCX to HTML converter provides an API for converting Microsoft Word .docx and .dotx files to HTML, allowing users to import content from Word documents directly into their web applications.
4+
:description_short: The DOCX to HTML converter provides an API for converting Microsoft Word .docx and .dotx files to HTML.
5+
:keywords: service, exportword, export to docx, export to word, html to docx converter api
6+
:pluginname: Import from Word
7+
:servicename: Docx to HTML Converter API
8+
9+
[NOTE]
10+
This is a premium feature. link:https://www.tiny.cloud/contact/[Contact us] to purchase a license or to learn more about our tailored offers. Note that any documents generated without authentication will be watermarked.
11+
12+
== Overview
13+
14+
The {servicename} provides an API for converting Microsoft Word `.docx` and `.dotx` files to HTML, allowing users to import content from Word documents directly into their web applications. This feature ensures that the imported content retains its original formatting, making it an essential tool for users who require high fidelity in document conversion.
15+
16+
== Key Features
17+
18+
* **High Fidelity Conversion**: Ensures that the content from Word documents is imported with accurate formatting, including styles, lists, tables, images, and hyperlinks.
19+
* **Seamless Integration**: Easily integrates with a WYSIWYG editor, allowing users to convert Word documents directly within their existing content management workflows.
20+
* **API Accessibility**: Accessible via a simple REST API, making it easy to incorporate into various applications and services.
21+
* **Support for Complex Documents**: Handles complex Word documents with multiple sections, headers, footers, and different page layouts.
22+
* **Customization Options**: Provides options to customize the conversion process to meet specific needs.
23+
24+
[[options]]
25+
== Flexible Configuration Options
26+
27+
=== Formatting Customization
28+
29+
* **Custom CSS**: Apply custom CSS to the converted content for consistent styling.
30+
* **Formatting**: Allows which Word styles and formatting are output alongside the document.
31+
* **Document properties**: Set document size and margins in pixels.
32+
33+
=== Output Options
34+
35+
* **Output Format**: Content is returned as a JSON object for easier integration into applications such as:
36+
** **HTML Content**: Provides the converted HTML, ready for web use.
37+
** **Document Information**: Offers document size and margin details for precise layout control.
38+
39+
These configuration options enhance the flexibility and control users have over the import process, making it adaptable to various needs and use cases.
40+
41+
[[ideal-use-cases]]
42+
== Ideal for Various Use Cases
43+
44+
* **Corporate Documentation**: Organizations can seamlessly import Word documents into their web-based content management systems, preserving formatting and styles.
45+
* **Academic Publishing**: Researchers and educators can easily convert and publish their Word documents on educational platforms or academic journals' websites.
46+
* **Legal Document Management**: Law firms can streamline the review and editing of Word documents while preserving essential formatting elements.
47+
* **Content Creation and Blogging**: Bloggers can import their drafts directly into their blogging platform, saving time on reformatting.
48+
* **Online Learning Platforms**: Instructors can import educational materials directly from Word, improving the learning experience for students.
49+
* **Government and Public Services**: Government agencies can import documents into their web platforms, ensuring they are accessible in a consistent and professional manner.
50+
51+
== Docx to HTML Converter API Reference
52+
53+
> Explore the comprehensive API documentation at link:https://exportdocx.converter.tiny.cloud/docs#section/Import-from-Word[Docx to HTML Converter API Reference documentation.^]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
= Export to Word Standalone Service
2+
:navtitle: Export to Word Standalone Service
3+
:description: The Export to Word service feature, provides the ability to generate a .docx Word files directly without the need for an editor.
4+
:description_short: Generate a Word file directly from standalone application.
5+
:keywords: service, exportword, export to Word
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
= HTML to Docx Converter API
2+
:navtitle: Export to Word Standalone Service
3+
:description: The Export to Microsoft Word feature collects the HTML generated with the tinymce.editor.getContent() method and combines it with the default editor content styles along with the styles provided in the configuration.
4+
:description_short: Generate a .docx file directly from any application.
5+
:keywords: service, exportword, export to docx, export to word, html to docx converter api
6+
:pluginname: Export to Word
7+
:servicename: HTML to Docx Converter API
8+
9+
[NOTE]
10+
This is a premium feature. link:https://www.tiny.cloud/contact/[Contact us] to purchase a license or to learn more about our tailored offers. Note that any documents generated without authentication will be watermarked.
11+
12+
== Overview
13+
14+
The {servicename} allows developers to convert HTML content into DOCX files seamlessly. It is designed to integrate effortlessly into your applications, providing high-quality document conversions with ease.
15+
16+
== Key Features
17+
18+
- **HTML to DOCX Conversion**: Transform HTML content into DOCX files with precision, maintaining the structure and styling.
19+
- **Customizable Outputs**: Tailor the DOCX output to match your requirements, including custom headers, footers, and styles.
20+
- **High Performance**: Engineered for efficiency, ensuring fast and reliable document conversions.
21+
- **Ease of Integration**: Simple RESTful API interface that can be integrated into any application or workflow.
22+
23+
[[options]]
24+
== Flexible Configuration Options
25+
26+
You can customize the DOCX output by specifying various options in your request:
27+
28+
- **Headers and Footers**: Add custom headers and footers to your DOCX documents.
29+
- **Styles**: Define custom styles for different HTML elements to ensure your documents look exactly as desired.
30+
- **Page Format**: Select from a wide range of page formats, including Letter, Legal, Tabloid, and A4, ensuring your documents look perfect every time.
31+
32+
== Ideal for Various Use Cases
33+
34+
Examples on how you can use the API to convert an HTML document with custom styles and a header and footer.
35+
36+
* **Legal Document Automation**: Automate the generation of legal documents by converting pre-defined HTML templates into standardized DOCX files, complete with custom headers, footers, and styling.
37+
* **Dynamic Report Generation**: Generate dynamic reports from HTML data, allowing for consistent formatting and styling across all generated documents.
38+
* **Educational Material Distribution**: Convert HTML-based educational content into DOCX files for easy distribution and offline access by students.
39+
* **Newsletter Archiving**: Archive HTML newsletters as DOCX files, preserving the layout and design for future reference.
40+
41+
42+
== HTML to Docx Converter API Reference
43+
44+
> Explore the comprehensive API documentation at link:https://exportdocx.converter.tiny.cloud/docs#section/Export-to-Word[HTML to Docx Converter API Reference documentation.^]
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
= HTML to PDF Converter API
2+
:navtitle: Export to PDF Standalone Service
3+
:description: The HTML to PDF Converter API service feature, provides the ability to generate a PDF files directly without the need for an editor.
4+
:description_short: Generate a .pdf file directly from any application.
5+
:keywords: service, exportpdf, export to pdf, HTML to PDF Converter API
6+
:pluginname: Export to PDF
7+
:servicename: HTML to PDF Converter API
8+
9+
[NOTE]
10+
This is a premium feature. link:https://www.tiny.cloud/contact/[Contact us] to purchase a license or to learn more about our tailored offers. Note that any documents generated without authentication will be watermarked.
11+
12+
== Overview
13+
14+
The {servicename} is a powerful tool that seamlessly integrates advanced document conversion capabilities into developers workflows. This API allows for the efficient conversion of HTML content into PDF documents, catering to a wide range of use cases.
15+
16+
=== Key Features
17+
18+
* **Versatile Document Conversion**: Convert HTML content into high-quality PDF documents, providing flexibility for various document needs.
19+
* **Preprocessing Capabilities**: Pre-process content before conversion, such as resolving merge tags, ensuring fully customized and ready-to-use PDF documents.
20+
* **Customizable Output**: Tailor the appearance and structure of the converted PDFs with customizable output xref:html-to-pdf-converter-api.adoc#options[options], including page sizes, margins, and formatting.
21+
* **Scalability**: Handle large volumes of PDF documents with consistent performance and reliability, supporting business growth and varying demands.
22+
* **Ease of Integration**: Integrate the API into existing workflows easily with comprehensive documentation and straightforward API endpoints.
23+
* **Security and Compliance**: Ensure secure document conversion processes that adhere to data protection standards and industry regulations, crucial for handling sensitive information.
24+
25+
[[options]]
26+
== Flexible Configuration Options
27+
28+
Tailor your PDF documents to suit your needs:
29+
30+
* **Custom CSS Styling:** Apply link:https://exportpdf.converter.tiny.cloud/docs#section/General/CSS[custom CSS^] styles to your PDFs for brand consistency and enhanced presentation.
31+
* **Header and Footer Options:** Add link:https://exportpdf.converter.tiny.cloud/docs#section/PDF-options/Header-and-footer[headers, footers^], and other branding elements to your PDF documents for a professional touch.
32+
* **Page Formatting:** Control page settings such as orientation, link:https://exportpdf.converter.tiny.cloud/docs#section/PDF-options/Margins[margins^], and link:https://exportpdf.converter.tiny.cloud/docs#section/PDF-options/Page-format[page size] to optimize readability.
33+
34+
== Ideal for Various Use Cases
35+
36+
* **Aggregating Content from Multiple Sources**: Combine content from various editors into a single cohesive PDF document, simplifying content management for organizations using multiple tools.
37+
* **Centralized Document Management**: Store generated PDF documents centrally for better organization and accessibility, facilitating team collaboration and efficient document retrieval.
38+
* **Preprocessing and Customization**: Pre-process content to resolve merge tags and customize PDF document formatting, ensuring that the final output meets specific requirements and is ready for immediate use.
39+
* **Large-Scale Document Processing**: Utilize the API’s scalability to handle large volumes of PDF documents, maintaining consistent performance and reliability, essential for growing businesses.
40+
41+
== PDF Converter API Reference
42+
43+
> Explore the comprehensive API documentation at link:https://exportpdf.converter.tiny.cloud/docs[PDF Converter API Reference documentation.^]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
= Import from Word Standalone Service
2+
:navtitle: Import from Word Standalone Service
3+
:description: The Import from Word service feature lets you import .docx (Word document) or .dotx (Word template) files into standalone application.
4+
:description_short: Import a Word file directly into a standalone application while preserving formatting and rich media.
5+
:keywords: service, importword, Import from Word

0 commit comments

Comments
 (0)