[Docs] Update First Page Web to Print (#20)

* update-firstPage-docStructure * removeLinkToAnotherDoc
pimcore · Apr 25, 2023 · 6846b83 · 6846b83
1 parent 649c67f
commit 6846b83
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -2,44 +2,22 @@
 title: Web to Print Module
 ---
 
-
 # Pimcore Web to Print Module
 
 Adds the ability to create web-to-print documents in Pimcore and to convert them into a PDF.
 
-## Document Types
-This bundle introduces 2 new document types:
-
-| Type           | Description                                                                                                                                                 | 
-|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [PrintPage](./doc/01_Print_Documents.md#printpage)      | Like pages, but specialized for print (PDF preview, rendering options, ...)                                                                                 | 
-| [PrintContainer](./doc/01_Print_Documents.md#printcontainer) | Organizing print pages in chapters and render them all together.                                                                                            | 
-
-## Available PDF Processors
-
-| Name           | Description                                                                                                                                                 | 
-|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [Chromium](https://www.chromium.org/Home/)      | Convert to PDF by installing the Chromium binary or by using a dockerized chromium (via websocket)                                                                              | 
-| [Gotenberg](https://gotenberg.dev/) | A Docker service with Chromium and LibreOffice support   | 
-| [PDF Reactor](https://www.pdfreactor.com/) | A REST/SOAP solution, please visit the official website for further information                                                                                          | 
-
- > For details on how to install and configure these processors, please see [Additional Tools Installation](https://github.com/pimcore/pimcore/blob/11.x/doc/23_Installation_and_Upgrade/03_System_Setup_and_Hosting/06_Additional_Tools_Installation.md) page in the Core.
-
-### Installation
-After installing the bundle and the required dependencies of the processor you wish to use, you need to configure the settings under *Settings >  Web-to-Print*. 
-There you will find detailed notes about the options and settings available. depending on which processor you will use. 
-
-### Uninstallation
-Uninstalling the bundle does not clean up `printpages` or `printcontainers`. Before uninstalling make sure to remove or archive all dependent documents.
-You can also use the following command to clean up you database. Create a backup before executing the command. All data will be lost.
-
-```bash
- bin/console pimcore:document:cleanup printpage printcontainer
-```
+## Features in a Nutshell
 
-### Best Practice
+- Add web2print support for generating PDFs to Pimcore.
+- Add new Pimcore-specific Document types to create print documents with Pimcore Documents (and all related concepts and features).
+- Allow creating single pages and whole catalogs with chapters, subchapters and table of contents.
+- Integrate different adapters to render documents to PDFs: Chromium, Gotenberg, PDF reactor.
 
-- [Events and PDFX Conformance](./doc/90_Web2Print_Extending_Config_for_PDFX_conformance.md)
+## Documentation Overview
+* [Installation](./doc/00_Installation.md)
+* [Document Types and Available PDF Processors](./doc/01_Doc_Types_and_Available_Processors.md)
+* [Print Documents](./doc/02_Print_Documents.md)
+* [Extending PDF Creation Config for PDF/X Conformance](./doc/90_Web2Print_Extending_Config_for_PDFX_conformance.md)
 
 ## Contributing and Development
 

diff --git a/doc/00_Installation.md b/doc/00_Installation.md
@@ -0,0 +1,14 @@
+# Installation
+
+## Installation Process
+After installing the bundle and the required dependencies of the processor you wish to use, you need to configure the settings under *Settings >  Web-to-Print*. 
+There you will find detailed notes about the options and settings available. depending on which processor you will use. 
+
+## Uninstallation
+Uninstalling the bundle does not clean up `printpages` or `printcontainers`. Before uninstalling make sure to remove or archive all dependent documents.
+You can also use the following command to clean up you database. Create a backup before executing the command. All data will be lost.
+
+```bash
+ bin/console pimcore:document:cleanup printpage printcontainer
+```
+
diff --git a/doc/01_Doc_Types_and_Available_Processors.md b/doc/01_Doc_Types_and_Available_Processors.md
@@ -0,0 +1,18 @@
+# Document Types and Available PDF Processors
+## Document Types
+This bundle introduces 2 new document types:
+
+| Type           | Description                                                                                                                                                 | 
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [PrintPage](./doc/01_Print_Documents.md#printpage)      | Like pages, but specialized for print (PDF preview, rendering options, ...)                                                                                 | 
+| [PrintContainer](./doc/01_Print_Documents.md#printcontainer) | Organizing print pages in chapters and render them all together.                                                                                            | 
+
+## Available PDF Processors
+
+| Name           | Description                                                                                                                                                 | 
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Chromium](https://www.chromium.org/Home/)      | Convert to PDF by installing the Chromium binary or by using a dockerized chromium (via websocket)                                                                              | 
+| [Gotenberg](https://gotenberg.dev/) | A Docker service with Chromium and LibreOffice support   | 
+| [PDF Reactor](https://www.pdfreactor.com/) | A REST/SOAP solution, please visit the official website for further information                                                                                          | 
+
+ > For details on how to install and configure these processors, please see [Additional Tools Installation](https://github.com/pimcore/pimcore/blob/11.x/doc/23_Installation_and_Upgrade/03_System_Setup_and_Hosting/06_Additional_Tools_Installation.md) page in the Core.
diff --git a/doc/01_Print_Documents.md → doc/02_Print_Documents.md b/doc/01_Print_Documents.md → doc/02_Print_Documents.md