Changes for page Print-Service-Plugin

From 4.5 to 4.6 From 10.1 to 10.2

From version 4.6

edited by gru
on 02.09.2021, 08:10

Change comment: There is no comment for this version

To version 10.1

edited by awa
on 14.06.2022, 13:52

Change comment: Add changelog

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.gru
++XWiki.awa

Content

@@ -92,7 +92,7 @@
  Translated with www.DeepL.com/Translator (free version)
--==== Uninstall ====
++=== Uninstall ===
  To uninstall the Print Server, open a command line (cmd) with administrative privileges and execute the following commands:
@@ -117,6 +117,7 @@
  In order for the plugin to be available in {{formcycle/}} as an action in the workflow, it must be deployed in the System Plugin section of the management interface. Instructions for installing plugins can be found [[here>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]].
  If the old version of the print service plugin (phantom plugin) was already installed, the following procedure is recommended for installation:
++
  * Disable the phantom plugin
  * Delete the phantom plugin
  * Upload new print service plugin
@@ -132,10 +132,18 @@
  This completes the setup of the print service plugin and it is available as an action in the [[workflow processing>>doc:Formcycle.Designer.Workflow.WebHome]].
--=== Troubleshooting ===
++== Troubleshooting ==
--==== Command npm install leads to timeout ====
++=== Command npm not found ===
++Under Windows it is possible that after the NodeJS installation the environment variables are not set correctly and so npm install cannot be executed. This was also the case if the default path under C:/Programs was not used during the NodeJS installation. So check in the path if these are existing. The following must be done for this:
++
++* Call up the environment variables via Control Panel > System > Advanced System Settings > Environment Variables button.
++* In Path you should find the following entries: {{info}}C:\Users\{username}\AppData\Roaming\npm;C:\Program Files\nodejs{{/info}}
++* Confirm everything with Ok. The console then be opened again with admin rights.
++
++=== Command npm install leads to timeout ===
++
  If the npm install command does not work due to a proxy, then the general proxy setting is not sufficient. Therefore, the following must be executed via console:
  {{code language="none"}}
@@ -152,20 +152,18 @@
  More information can also be found here: http://www.fladi.de/2014/02/06/howto-npm-hinter-einem-proxy-verwenden/
--==== Printing does not work ====
++=== Printing does not work ===
  If printing via {{formcycle/}} is not possible, the cause could be that the print service is not reachable. This can be solved by the loopback URL. Under System > General > Loopback URL, loopback base URL: {{code language="none"}}http://localhost:<port>/formcycle{{/code}}
--==== PDF is printed, but the message 404 appears ====
++=== PDF is printed, but the message 404 appears ===
  In this case the print service works correctly because a PDF is already created. It must be checked whether the loopback URL is entered correctly so that the URL to the print service is resolved correctly.
--==== Downloading Chromium fails ====
++=== Downloading Chromium fails ===
  The following error message appears on the console after running "npm install":
--{{code language="none"}}
--Error: unable to verify the first certificate
--{{/code}}
++{{code language="none"}}Error: unable to verify the first certificate{{/code}}
  The described steps are only a workaround and the environment variables should be set back to the default values after the successful installation!
@@ -178,20 +178,23 @@
  To use this plugin, go to the workflow processing configuration, click on new action and select this plugin. The following options are used to configure the plugin action:
--; **File name**
++; File name
  : File name of the created PDF document.
--; **Print mode**
++; Print mode
  : Input elements as text: Input elements are converted into plain text fields and the form is adapted to the width of the page.
--; **Print mode**
--: Web view: No changes are made to the form and it is converted so that it looks as closely as it does in a web browser as possible.
--; **Zoom factor**
--: Factory by which the form is scaled. Use this to magnify or scale down very large or very small forms.
--; **User groups**
++; Print mode
++: By default, are form fields such as input fields and select fields are converted to plain text. If you choose to disable this conversion, no changes are made to the form and it is printed so that it looks as closely as it does in a web browser as possible.
++; Zoom factor
++: Scale factor for the form. Use this to magnify or scale down very large or very small forms.
++; Blank form
++: Can be used to create PDF documents that can be printed out and filled out manually with a pen. When enabled, all form field values are cleared and all hidden fields are shown. In addition, the maximum number of element repetitions are created.
++; User groups
  : A virtual user is created when opening the form with Selenium. Select the user groups here to which this virtual user should belong to. Form elements can be configured to be displayed or editable only for certain user groups.
--; **URL parameter**
++; URL parameter
  : Additional URL parameters added to the URL used when opening the form with Selenium. You can use URL parameters to [[prefill form fields>>Formcycle.Designer.Form.URLParameter]] or access them from within JavaScript.
  == CSS-Anpassungen für Druckbild ==
++
  === Input elements ===
  To optimize the form for printing, form elements of type [[input field>>Formcycle.Designer.Form.FormElements.Input]], [[text area>>Formcycle.Designer.Form.FormElements.Textarea]] und [[select>>Formcycle.Designer.Form.FormElements.Selection]] (Drop-Down) may be converted to plain text fields, if the print mode is set to Input elements as text.
@@ -227,6 +227,29 @@
  }
  {{/code}}
++=== Avoid page break ===
++
++The default setting for printing is that a page break is inserted after each page of the form:
++
++{{code language="css"}}
++@media print {
++    .CXPage:not(:first-child ), .page-break {
++        display: block !important;
++        page-break-before: always;
++    }
++}
++{{/code}}
++
++In order to avoid breaks, the following rule needs to be defined in the CSS tab of the form:
++
++{{code language="css"}}
++@media print {
++    .CXPage:not(:first-child ) {
++        page-break-before: avoid;
++    }
++}
++{{/code}}
++
  === Usage of other fonts ===
  ==== Technical requirements ====
@@ -256,3 +256,40 @@
  Fonts sometimes have very tightly defined license terms and are priced differently depending on their intended use. It should be noted that fonts for creating PDFs must be embedded in them, which for many commercial fonts requires a different license than for delivery via a web server for the purpose of displaying a web page in a web browser.
  In fonts of type //TrueType// and //OpenType// information about the embeddability of the font can be stored directly. Depending on what is configured there, a font may not be embeddable and will instead be rendered by the //Print-Service-Plugin// only as a vector graphic in the created PDF documents.
++
++== Changelog
++
++=== 4.2.0
++
++* feature: New option //blank form//
++* change: When an element is marked as hidden during print in the form designer (advanced -> Word and PDF export options), the element is now hidden when the print service is used as well. This feature requires at least {{formcycle/}} version 7.0.14.
++* change: Applicable only when //print mode// is set to //dynamic//: When an input field did not have a value, its placeholders was shown instead. This was changed so that no value is shown when the input field does not have a value.
++* change: Applicable only when //print mode// is set to //dynamic//:  When a select field displayed as a dropdown menu did not have a value, the text //Please select// was shown instead. This was changed so that no text is shown anymore when the select field does not have a value.
++
++=== 4.1.2
++
++* Added note regarding //$.xutil.onPrint// to the plugin UI.
++
++=== 4.1.1
++
++* Requires at least {{formcycle/}} 7.0.4.
++* change: Note regarding required field is not shown anymore.
++* fix: Show the date format immediately
++
++=== 4.1.0
++
++* Added a new option for selecting the workflow state used during printing. When no state is selected, the current state of the form record is used as in previous version.
++* Configured user groups are saved correctly.
++
++=== 4.0.2
++
++* feature: Added a new timeout option that defaults to 30 seconds. When the print service cannot be reached, the workflow may never complete otherwise.
++
++=== 4.0.1
++
++* fix: The PDF document tha was created was not attached to the form record (only for the new workflow action).
++
++=== 4.0.0
++
++* Adjustments for {{formcycle/}} version 7.
++