EXT: conn_w2p¶

TS Example Configuration¶

A rendering configuration consists of two hierarchical configuration types. A base configuration and one or multiple single configurations.

Base Configuration¶

The base configuration defines general options such as the used language, paper-size, templates for content rendering and the included stylesheets for screen display and print output (which are subsequently used in the PDF rendering process).

Additionally permissions for this specific base configuration in frontend and backend are defined through usergroups.

You can find examples for the needed template file and the stylesheets in the sub-directory “resources/examples“ of the conn_w2p extension.

Single Configuration¶

A single configuration is always dependent on a base configuration.

The single configuration is the real definition of rendered content.This is achieved by adding contents to the configuration.

The content-types correspond with a specific rendering library which takes care of set-up of content data-element as well as final rendering of HTML content.

Default settings for resolution and colorspace are also defined in the single configuration.

The downloads inside a single configuration resemble the finished rendering jobs and are attached through a callback mechanism controlled by the w2pservice.

pi1/class.tx_connw2p_pi1.php¶

lib/class.tx_connw2p_element.php¶

lib/class.tx_connw2p_document.php¶

lib/class.tx_connw2p_page.php¶

lib/class.tx_connw2p_contentelement.php¶

lib/class.tx_connw2p_data.php¶

mod1¶

mod2/index.php¶

renderlib/class.tx_connw2p_renderinterface.php¶

renderlib/class.tx_connw2p_render_pdf.php¶

renderlib/class.tx_connw2p_render_page.php¶

renderlib/class.tx_connw2p_render_toc.php¶

resources¶

static¶

filechecksum.php¶

w2p.php¶

plugin.tx_connw2p_lib TS constants¶

plugin.tx_connw2p_lib.w2pPid = 1

plugin.tx_connw2p_lib.userPid = 2

plugin.tx_connw2p_lib.loginEnabled = 0

plugin.tx_connw2p_pi1TS constants¶

plugin.tx_connw2p_pi1 {
  templateFile = fileadmin/templates/w2p.html
}

plugin.tx_connw2p_pi1 {
  loginTemplateFile = fileadmin/templates/w2plogin.html
}

plugin.tx_connw2p_pi1 TS configuration¶

plugin.tx_connw2p_pi1.loginPid = 1

Creating a base configuration¶

The base configuration defines, as the name suggests, the basic properties of a document you want to render.Those include the page size as well as a bleed setting, the language for the rendered document, HTML template to use, general CSS stylesheets and stylesheets for print (which get applied upon rendering) and the permission settings for frontend and backend through usergroups.

Base configuration with assigned values

Backend module¶

The Web2Print backend module provides an easy way to handle the different single configurations of a given base configuration.

After selecting the data source (base configuration) all available single configurations are displayed as well as final versions of documents rendered with these single configurations.

Web2Print backend module view

Backend module in TYPO3 navigation

Creating a single configuration¶

Each base configuration can have various single configurations with different content or settings. The original idea was to have the possibility of creating different versions of the same document.

Inside a single configuration the actual content of the document is defined.This is done by adding different content types to the document and specifying the required properties.The default resolution and colorspace is also set in the single configuration.

Basic single configuration, already filled with content and rendering results (downloads)

Adding content to the single configuration¶

Content is added to a single configuration through the IRRE area “Contents”.

The extension already has some basic content rendering libraries providing the following types:

Downloads in a single configuration¶

Download in single configuration (finished rendering)

Each single configuration contains an IRRE area called “Downloads”. This is where all the finished renderings are present.The Downloads itself are read only and represent the settings of the finished rendering. The URL points to the rendered PDF document on the w2pservice rendering server.

Previewing content¶

Web2Print rendering panel

Content preview is done in the frontend part of the extension.After logging in using a previously created frontend (Web Site) user and assigning a group with appropriate rights, you can select the single configuration you want to preview.After configuration selection the default values for resolution and colorspace are loaded and the first page is displayed.The navigation part allows navigation through pages as well as defining how much pages should be displayed at once.Additionally it is possible to disable the bleed which was set in the base configuration, for example to render a RGB version for web view only.The rendering section defines settings for the rendering process, the most important being the resolution and colorspace of the resulting PDF file. By default the rendering is only in preview mode, where watermarks are placed in the document.To render without watermarks the “Final Version” checkbox has to be set. In this mode special limits apply.Beneath is a list of the last rendered documents. Rendering panel may be hidden to provide better overview of content

Preview of table of contents in demo setup

Preview of commerce content

Starting the rendering process¶

After checking the content in preview, the rendering process itself is started by selecting the desired resolution and colorspace settings and the page-range to render. If only the current page should be rendered a simple click on the button “Render current page” is sufficient.If the document shall be printed later on, selecting “Final Version” is recommended to get a resulting document without watermarks. It should be mentioned, that for the demo license limits apply to rendering final versions of a document.

After invoking the rendering, continuous status queries through JavaScript provide the current status to the user.The possible status values are: