From 26d4a6e1cfe42f8185b6011f126d7d199d57cc9a Mon Sep 17 00:00:00 2001 From: Farzad Hayat Date: Thu, 12 Dec 2024 14:27:48 +1100 Subject: [PATCH] DOC-2600: update all document converters to new API doc links (#3561) --- modules/ROOT/pages/docx-to-html-converter-api.adoc | 2 +- modules/ROOT/pages/exportpdf.adoc | 2 +- modules/ROOT/pages/exportword.adoc | 2 +- modules/ROOT/pages/html-to-docx-converter-api.adoc | 2 +- modules/ROOT/pages/html-to-pdf-converter-api.adoc | 8 ++++---- modules/ROOT/pages/importword.adoc | 2 +- .../configuration/exportpdf_converter_options.adoc | 2 +- .../configuration/exportword_converter_options.adoc | 2 +- .../configuration/importword_converter_options.adoc | 2 +- .../export-to-pdf/export-to-pdf-api-usage.adoc | 2 +- .../export-to-pdf/export-to-pdf-autorization.adoc | 2 +- .../export-to-pdf/export-to-pdf-fonts.adoc | 4 ++-- ...rom-word-and-export-to-word-api-usage-on-premises.adoc | 2 +- ...-word-and-export-to-word-autorization-on-premises.adoc | 2 +- 14 files changed, 18 insertions(+), 18 deletions(-) diff --git a/modules/ROOT/pages/docx-to-html-converter-api.adoc b/modules/ROOT/pages/docx-to-html-converter-api.adoc index cb2a034337..01fb3b7ddb 100644 --- a/modules/ROOT/pages/docx-to-html-converter-api.adoc +++ b/modules/ROOT/pages/docx-to-html-converter-api.adoc @@ -50,4 +50,4 @@ These configuration options enhance the flexibility and control users have over == Docx to HTML Converter API Reference -> Explore the comprehensive API documentation at link:https://exportdocx.converter.tiny.cloud/docs#section/Import-from-Word[Docx to HTML Converter API Reference documentation.^] \ No newline at end of file +> Explore the comprehensive API documentation at link:https://exportdocx.api.tiny.cloud/docs#section/Import-from-Word[Docx to HTML Converter API Reference documentation.^] \ No newline at end of file diff --git a/modules/ROOT/pages/exportpdf.adoc b/modules/ROOT/pages/exportpdf.adoc index 877faa52bf..ba5d317d26 100644 --- a/modules/ROOT/pages/exportpdf.adoc +++ b/modules/ROOT/pages/exportpdf.adoc @@ -84,4 +84,4 @@ include::partial$commands/{plugincode}-cmds.adoc[] == API Reference -> Explore the comprehensive API documentation for the {pluginname} Premium plugin at https://exportpdf.converter.tiny.cloud/docs[Export to PDF.^] \ No newline at end of file +> Explore the comprehensive API documentation for the {pluginname} Premium plugin at https://exportpdf.api.tiny.cloud/docs[Export to PDF.^] \ No newline at end of file diff --git a/modules/ROOT/pages/exportword.adoc b/modules/ROOT/pages/exportword.adoc index 5e838c78ae..337ead2c32 100644 --- a/modules/ROOT/pages/exportword.adoc +++ b/modules/ROOT/pages/exportword.adoc @@ -85,4 +85,4 @@ include::partial$commands/exportword-cmds.adoc[][leveloffset=+1] == API Reference -> Explore the comprehensive API documentation for the {pluginname} Premium plugin at link:https://exportdocx.converter.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word.^] \ No newline at end of file +> Explore the comprehensive API documentation for the {pluginname} Premium plugin at link:https://exportdocx.api.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word.^] \ No newline at end of file diff --git a/modules/ROOT/pages/html-to-docx-converter-api.adoc b/modules/ROOT/pages/html-to-docx-converter-api.adoc index 114db73d98..89c20a3c70 100644 --- a/modules/ROOT/pages/html-to-docx-converter-api.adoc +++ b/modules/ROOT/pages/html-to-docx-converter-api.adoc @@ -41,4 +41,4 @@ Examples on how you can use the API to convert an HTML document with custom styl == HTML to Docx Converter API Reference -> Explore the comprehensive API documentation at link:https://exportdocx.converter.tiny.cloud/docs#section/Export-to-Word[HTML to Docx Converter API Reference documentation.^] \ No newline at end of file +> Explore the comprehensive API documentation at link:https://exportdocx.api.tiny.cloud/docs#section/Export-to-Word[HTML to Docx Converter API Reference documentation.^] \ No newline at end of file diff --git a/modules/ROOT/pages/html-to-pdf-converter-api.adoc b/modules/ROOT/pages/html-to-pdf-converter-api.adoc index a566d242c9..3beeff4ac2 100644 --- a/modules/ROOT/pages/html-to-pdf-converter-api.adoc +++ b/modules/ROOT/pages/html-to-pdf-converter-api.adoc @@ -27,9 +27,9 @@ The {servicename} is a powerful tool that seamlessly integrates advanced documen Tailor your PDF documents to suit your needs: -* **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. -* **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. -* **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. +* **Custom CSS Styling:** Apply link:https://exportpdf.api.tiny.cloud/docs#section/General/CSS[custom CSS^] styles to your PDFs for brand consistency and enhanced presentation. +* **Header and Footer Options:** Add link:https://exportpdf.api.tiny.cloud/docs#section/PDF-options/Header-and-footer[headers, footers^], and other branding elements to your PDF documents for a professional touch. +* **Page Formatting:** Control page settings such as orientation, link:https://exportpdf.api.tiny.cloud/docs#section/PDF-options/Margins[margins^], and link:https://exportpdf.api.tiny.cloud/docs#section/PDF-options/Page-format[page size] to optimize readability. == Ideal for Various Use Cases @@ -40,4 +40,4 @@ Tailor your PDF documents to suit your needs: == PDF Converter API Reference -> Explore the comprehensive API documentation at link:https://exportpdf.converter.tiny.cloud/docs[PDF Converter API Reference documentation.^] \ No newline at end of file +> Explore the comprehensive API documentation at link:https://exportpdf.api.tiny.cloud/docs[PDF Converter API Reference documentation.^] \ No newline at end of file diff --git a/modules/ROOT/pages/importword.adoc b/modules/ROOT/pages/importword.adoc index 2161f65a97..1cc96ed00c 100644 --- a/modules/ROOT/pages/importword.adoc +++ b/modules/ROOT/pages/importword.adoc @@ -83,4 +83,4 @@ include::partial$commands/importword-cmds.adoc[] == API Reference -> Explore the comprehensive API documentation for the {pluginname} Premium plugin at link:https://importdocx.converter.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word.^] \ No newline at end of file +> Explore the comprehensive API documentation for the {pluginname} Premium plugin at link:https://importdocx.api.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word.^] \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/exportpdf_converter_options.adoc b/modules/ROOT/partials/configuration/exportpdf_converter_options.adoc index 2bc109177d..806eea7d6b 100644 --- a/modules/ROOT/partials/configuration/exportpdf_converter_options.adoc +++ b/modules/ROOT/partials/configuration/exportpdf_converter_options.adoc @@ -39,4 +39,4 @@ tinymce.init({ [NOTE] The `exportpdf_service_url` option must be configured for the {pluginname} plugin to work. -> For comprehensive details regarding the `exportpdf_converter_options`, please refer to the https://exportpdf.converter.tiny.cloud/docs[API documentation^] available for the {pluginname} Premium plugin. \ No newline at end of file +> For comprehensive details regarding the `exportpdf_converter_options`, please refer to the https://exportpdf.api.tiny.cloud/docs[API documentation^] available for the {pluginname} Premium plugin. \ No newline at end of file diff --git a/modules/ROOT/partials/configuration/exportword_converter_options.adoc b/modules/ROOT/partials/configuration/exportword_converter_options.adoc index 54233db596..9ca4223cad 100644 --- a/modules/ROOT/partials/configuration/exportword_converter_options.adoc +++ b/modules/ROOT/partials/configuration/exportword_converter_options.adoc @@ -65,4 +65,4 @@ tinymce.init({ [NOTE] To use this option, the Export to Word plugin requires the `exportword_service_url` option to be configured. -> For comprehensive details regarding the `exportword_converter_options`, please refer to the link:https://exportdocx.converter.tiny.cloud/v2/convert/docs#section/Export-to-Word[API documentation^] available for the {pluginname} Premium plugin. +> For comprehensive details regarding the `exportword_converter_options`, please refer to the link:https://exportdocx.api.tiny.cloud/v2/convert/docs#section/Export-to-Word[API documentation^] available for the {pluginname} Premium plugin. diff --git a/modules/ROOT/partials/configuration/importword_converter_options.adoc b/modules/ROOT/partials/configuration/importword_converter_options.adoc index c91576b76d..5e8ff26dd5 100644 --- a/modules/ROOT/partials/configuration/importword_converter_options.adoc +++ b/modules/ROOT/partials/configuration/importword_converter_options.adoc @@ -39,4 +39,4 @@ tinymce.init({ ---- [NOTE] -For more information on the available converter options, refer to the link:https://importdocx.converter.tiny.cloud/v2/convert/docs#section/Import-from-Word/Configuration[Import from Word API documentation]. \ No newline at end of file +For more information on the available converter options, refer to the link:https://importdocx.api.tiny.cloud/v2/convert/docs#section/Import-from-Word/Configuration[Import from Word API documentation]. \ No newline at end of file diff --git a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-api-usage.adoc b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-api-usage.adoc index 6f7b93f9e4..f79a093ec6 100644 --- a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-api-usage.adoc +++ b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-api-usage.adoc @@ -7,7 +7,7 @@ The API is available on `+http://localhost:[port]+` (by default the `port` is `8 [NOTE] The REST API documentation is available at `+http://localhost:[port]/docs+`. -Alternatively, refer to the specifications in link:https://exportpdf.converter.tiny.cloud/docs[https://exportpdf.converter.tiny.cloud/docs^]. +Alternatively, refer to the specifications in link:https://exportpdf.api.tiny.cloud/docs[https://exportpdf.api.tiny.cloud/docs^]. If the authorization for the API is enabled, provided an authorization token. More instructions can be found in the xref:individual-export-to-pdf-on-premises.adoc#authorization[authorization] section. diff --git a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-autorization.adoc b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-autorization.adoc index 6bcf161084..eba8d6e67b 100644 --- a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-autorization.adoc +++ b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-autorization.adoc @@ -91,7 +91,7 @@ axios.post( 'http://localhost:8080/v1/convert', data, config ) `SECRET_KEY` it’s the key which has been passed to the {pluginname} On-Premises instance -Please refer to the link:https://exportpdf.converter.tiny.cloud/docs[{pluginname} REST API documentation] to start using the service. +Please refer to the link:https://exportpdf.api.tiny.cloud/docs[{pluginname} REST API documentation] to start using the service. [NOTE] If API clients like Postman or Insomnia are used, then set the JWT token as an `Authorization` header in the `Headers` tab. Do not use the built-in token authorization as this will generate invalid header with a `Bearer` prefix added to the token. \ No newline at end of file diff --git a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-fonts.adoc b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-fonts.adoc index f950c20157..648b948eee 100644 --- a/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-fonts.adoc +++ b/modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-fonts.adoc @@ -5,7 +5,7 @@ During document writing, the possibility of using many different fonts can be ve Using the appropriate font can change the appearance of the document and emphasize its style. -{pluginname} Converter allows link:https://exportpdf.converter.tiny.cloud/docs#section/Web-Fonts[Web Fonts^] to be used, which provided the integrator with the ability to use standard operating system fonts or use custom fonts without the need to import them using CSS. +{pluginname} Converter allows link:https://exportpdf.api.tiny.cloud/docs#section/Web-Fonts[Web Fonts^] to be used, which provided the integrator with the ability to use standard operating system fonts or use custom fonts without the need to import them using CSS. Below is a list of the basic fonts included in the image: @@ -31,7 +31,7 @@ However, additional fonts can be added to {pluginname} Converter in two ways: ** See Use Windows fonts in PDF Converter section. [NOTE] -The fonts inside the mounted volume will be installed on the docker image operating system. Only the `.ttf` and `.otf` font formats are supported. If other font formats are used, these will need to be converted to the supported format prior or use fonts such as link:https://exportpdf.converter.tiny.cloud/docs#section/Web-Fonts[Web Fonts^]. +The fonts inside the mounted volume will be installed on the docker image operating system. Only the `.ttf` and `.otf` font formats are supported. If other font formats are used, these will need to be converted to the supported format prior or use fonts such as link:https://exportpdf.api.tiny.cloud/docs#section/Web-Fonts[Web Fonts^]. [TIP] Ensure that the converted fonts can be installed and used on your local machine first, before installing them on the docker container. diff --git a/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-api-usage-on-premises.adoc b/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-api-usage-on-premises.adoc index 0fb62308f1..425460082d 100644 --- a/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-api-usage-on-premises.adoc +++ b/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-api-usage-on-premises.adoc @@ -10,6 +10,6 @@ The API is available on `+http://localhost:[port]+` (by default the port is 8080 [NOTE] The REST API documentation is available at `+http://localhost:[port]/v2/convert/docs+`. -Alternatively you can check specification in our public resources for link:https://importdocx.converter.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word^] and the link:https://exportdocx.converter.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word^] plugins. +Alternatively you can check specification in our public resources for link:https://importdocx.api.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word^] and the link:https://exportdocx.api.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word^] plugins. If you have the authorization for the API enabled, you should provide an authorization token. More instructions you can find in the authorization section. \ No newline at end of file diff --git a/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc b/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc index 18861d092d..093bc075ec 100644 --- a/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc +++ b/modules/ROOT/partials/individually-licensed-components/import-from-word-and-export-to-word/import-from-word-and-export-to-word-autorization-on-premises.adoc @@ -63,7 +63,7 @@ axios.post( 'http://localhost:8080/v2/convert/html-docx', data, config ) `SECRET_KEY`: This is the key what has been passed to the {pluginname} On-Premises instance. -Please refer to the link:https://importdocx.converter.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word^] and the link:https://exportdocx.converter.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word^] REST API documentation to start using the service. +Please refer to the link:https://importdocx.api.tiny.cloud/v2/convert/docs#section/Import-from-Word[Import from Word^] and the link:https://exportdocx.api.tiny.cloud/v2/convert/docs#section/Export-to-Word[Export to Word^] REST API documentation to start using the service. [NOTE] If API clients like Postman or Insomnia are used, then set the JWT token as an `Authorization` header in the `Headers` tab. Do not use the built-in token authorization as this will generate invalid header with a `Bearer` prefix added to the token. \ No newline at end of file