Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
en:plugins:formfiller [2024/06/01 21:54] – [Downloads] rmben:plugins:formfiller [2025/11/17 15:52] (current) – rmb
Line 1: Line 1:
 ====== FormFiller ====== ====== FormFiller ======
  
-==== Description ====+===== Description =====
 This plugin makes it possible to fill PDF forms with profile data and profile pictures of members, as well as any text and pictures. This plugin makes it possible to fill PDF forms with profile data and profile pictures of members, as well as any text and pictures.
  
Line 9: Line 9:
  
  
-==== Downloads ====+===== Downloads =====
 <WRAP download 60%> <WRAP download 60%>
-[[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=a760ac87-cb4a-4a26-b547-f35f399a130e|formfiller_3.3.1.zip]] - **(Admidio 4.3)** +[[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=aad26ad9-bfc7-4b2d-80e1-70ee88465902|formfiller_4.0.0.zip]] - **(Admidio 5.0)** 
 </WRAP> </WRAP>
  
-Older versions:\\ +Older versions:\\ 
 +[[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=a760ac87-cb4a-4a26-b547-f35f399a130e|formfiller_3.3.1.zip]] - (Admidio 4.3)\\  
 [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=8650da2f-42a9-45a2-9ecf-82bacadb0e6a|formfiller_3.2.0.zip]] - (Admidio 4.2)\\ [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=8650da2f-42a9-45a2-9ecf-82bacadb0e6a|formfiller_3.2.0.zip]] - (Admidio 4.2)\\
 [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=5b235b20-ff62-4d8d-8531-1d81d6bfec24|formfiller_3.1.0.zip]] - (Admidio 4.1)\\ [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=5b235b20-ff62-4d8d-8531-1d81d6bfec24|formfiller_3.1.0.zip]] - (Admidio 4.1)\\
Line 23: Line 24:
 [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=e320bf42-1ec0-4ed4-8a4b-c5246eaaeb92|formfiller_2.0.2.zip]] - (Admidio 3.0)\\  [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=e320bf42-1ec0-4ed4-8a4b-c5246eaaeb92|formfiller_2.0.2.zip]] - (Admidio 3.0)\\ 
 [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=164d9f64-55f5-424b-9bfa-3c9d1fbef3eb|formfiller_1.0.3.zip]] - (since Admidio 2.4.4) [[https://www.admidio.org/intern/adm_program/modules/documents-files/get_file.php?file_uuid=164d9f64-55f5-424b-9bfa-3c9d1fbef3eb|formfiller_1.0.3.zip]] - (since Admidio 2.4.4)
-==== Information ====+===== Information =====
 Supported by: **[[http://forum.admidio.org/memberlist.php?mode=viewprofile&u=1506|rmb]] **\\  Supported by: **[[http://forum.admidio.org/memberlist.php?mode=viewprofile&u=1506|rmb]] **\\ 
  
-Plugin-Version:     **3.2.0**\\ +Plugin-Version:     **4.0.0**\\ 
  
-Required Admidio-Version:  **4.2**\\ +Required Admidio-Version:  **5.0**\\ 
  
-Supported databases:  **MySQL**\\ +Supported databases:  **MySQL, PostgreSQL**\\ 
  
 Supported languages: **German, English, French** Supported languages: **German, English, French**
Line 36: Line 37:
 License: **GPL 2** License: **GPL 2**
  
-==== Screenshots ====+===== Screenshots =====
 {{:de:plugins:formfiller:formfiller_01.png?300|}}   {{:de:plugins:formfiller:formfiller_01.png?300|}}  
 {{:de:plugins:formfiller:formfiller_02.png?300|}} {{:de:plugins:formfiller:formfiller_02.png?300|}}
  
-==== Installation ==== +===== Installation ===== 
-  * In the adm_plugins folder, create a new folder called formfiller +  * Unpack the file Formfiller_x.x.x into the folder adm_plugins 
-  * After that, copy all files (and folders) of the formfiller folder from the unzipped zip file to this folder. +  * Log in to Admidio 
-  * Then use the Admidio module menu to create a menu item for FormFiller with the following URL: /adm_plugins/formfiller/formfiller.php (When creating this menu item, it is strongly recommended to specify a role in the "Visible for" field).+  * Installing a plugin version < 4.0.0 
 +    * Create a menu item for FormFiller via the Admidio module menu with the following URL:\\ /adm_plugins/formfiller/formfiller.php 
 +    * The installation routine is executed the first time the plugin is started. 
 +  * Installing a plugin version >= 4.0.0 
 +    * To install, run the following PHP file:\\ <your-admidio-page>/adm_plugins/FormFiller/system/install.php
  
-==== Update ==== +===== Update ===== 
-  * First delete all files in the FormFiller plugin directory. +  * Update from plugin version 3.x to plugin version 3.y 
-  * Then copy all files (and folders) of the formfiller folder from the unzipped zip file to the plugin directory.+    * Replace all files in the existing plugin folder with the files of the new version. 
 +  * Update from plugin version 3.x to plugin version >= 4.0.0 
 +    * Delete the existing menu item via the Adminidio module menu 
 +    * To install, run the following PHP file:\\ <your-admidio-site>/adm_plugins/FormFiller/system/install.php
  
  
-==== History ====+===== History ===== 
 +//4.0.0 (16.11.2025)// 
 +  * [[https://github.com/rmbinder/FormFiller/issues?q=milestone%3Av4.0.0|All changes of this version on GitHub]] 
 + 
 +//3.3.1 (01.06.2024)// 
 +  * [[https://github.com/rmbinder/FormFiller/issues?q=milestone%3Av3.3.1|All changes of this version on GitHub]] 
 + 
 +//3.3.0 (16.01.2024)// 
 +  * [[https://github.com/rmbinder/FormFiller/issues?q=milestone%3Av3.3.0|All changes of this version on GitHub]] 
 //3.2.0 (18.02.2023)// //3.2.0 (18.02.2023)//
   * [[https://github.com/rmbinder/FormFiller/issues?q=milestone%3Av3.2.0|All changes of this version on GitHub]]   * [[https://github.com/rmbinder/FormFiller/issues?q=milestone%3Av3.2.0|All changes of this version on GitHub]]
Line 110: Line 127:
 [[https://www.admidio.org/dokuwiki/doku.php?id=de:plugins:formfiller#aenderungshistorie|For changes before version 2.1.1 please look at the german page]] [[https://www.admidio.org/dokuwiki/doku.php?id=de:plugins:formfiller#aenderungshistorie|For changes before version 2.1.1 please look at the german page]]
  
-==== Operation ==== +===== How it works ===== 
-Form Filler can either create single documents (with the profile data of an individual member) and also multiple document (with the profile data of several members). A distinction is made between form printing (solid XY coordinates) and label printing (relative XY coordinates).+FormFiller creates PDF documents containing member profile data, as well as any text or images. Members can be selected by name or from a predefined "Custom List". FormFiller distinguishes between form printing (fixed XY coordinates) and label printing (relative XY coordinates).
  
-=== Definition "single document" ===+=== Definition of the term "form printing" ===
  
-If via the user administration the profile of a member is called, all created configurations are displayed in list form below the menu item Form Filler. When clicking on a configuration formfiller reads the browser address line, extracts the user_id of the member and produces the data by this member a single PDF document.+Form printing in the sense of FormFiller means that a PDF form is filled using absolute XY coordinates. The X and Y values define the horizontal and vertical position in millimeters relative to the top left corner of the PDF form.
  
-{{:de:plugins:formfiller:link-in-menue-plugins-mit-konfigurationen.png?200}}+Example:\\ 
 +{{:de:plugins:formfiller:beispiel-xy-position.png?400}}
  
-In the above example, three configurations are displayed (standard form, envelope DL and address labels). These are also the sample configurations created in a new installation.+In the example above, the member's first name is written 60 millimeters to the right and 80 millimeters downwards, measured from the top left corner of the form. The last name is written 100 millimeters to the right and 80 millimeters downwards, also measured from the top left corner of the form.
  
-=== Definition "multiple document" ===+-> Last name and first name are on the same line (80 mm)\\ 
 +-> First name (at 60mm) comes before last name (at 100mm)
  
-Even the creation of multiple documents is possible with formfiller. Multiple Document means that the data of several members  can be used for filling a PDF document. You can create in a simple manner form letters or address labels.+Further information on this topic can be found in the "Configurations" section of this documentation.
  
-The menu item form filler module for multiple documents is called.+=== Definition of the term "label printing" ===
  
-{{:de:plugins:formfiller:standardansicht.png?400}}+Label printing using FormFiller means that the smallest X-coordinate of a line determines the start of the print. All other X-coordinates of a line are used solely for sorting.
  
-Click on the button "Generate PDF file" a multi-document with information of members that have been filtered based on list configuration and role will be generated. // (Note:. Evaluated in the list configuration are only conditions that are given to fields. Fields without condition is not important for this query.)// 
- 
-If "ListConfiguration" or "Role" is not assigned, the following error message appears: 
- 
-{{:de:plugins:formfiller:standardansicht-fehlende-listenkonfiguration.png?300}} 
-{{:de:plugins:formfiller:standardansicht-fehlende-rolle.png?300}} 
- 
-=== Definition "Print form" === 
- 
-Form pressure within the meaning of Form Filler means that the filling in a PDF form is performed using fixed XY coordinate. The details for X and Y define here the horizontal and vertical position in millimeters relative to the upper left corner of the PDF form. 
 Example:\\ Example:\\
-{{:de:plugins:formfiller:beispiel-xy-position.png?400}}+{{:de:plugins:formfiller:beispiel-umschlag-dl.png?400}}
  
-In the above example, the first name of the member is 60 millimeters and 80 millimeters to the right down, counted from the upper left corner of the form is written. The last name is 100 millimeters to the right and 80 mm downwards, also counted from the upper left corner of the form is written.+Using form printing, the printed image would look like this: (always referring to the top left corner of the form) 
 +  * Gender (title) at position 20, 30 (20 millimeters to the right and 30 millimeters down) 
 +  * First name at position 25, 30 (25 millimeters to the right and 30 millimeters down) 
 +  * Last name at position 26.30 (26 millimeters to the right and 30 millimeters down)
  
-⇒ Surname and first name are in the same row (80 mm)\\   +-> The surname would begin one millimeter to the right of the first name and almost completely overwrite it.
-⇒ First name (at 60mm) stands in front of Surname (bei 100mm)+
  
-Further information on this topic can be found in "Configurations" section in this document.+However, if label printing is enabled, the printed image will look like this: 
 +  * Gender First Name Last Name //(each separated by a space)//
  
-=== Definition "label printing" ===+-> The smallest X-coordinate in the example is 20, meaning the gender (= salutation) determines the start of the print at position 20,30 (20 millimeters to the right and 30 millimeters down, relative to the top left corner of the form). First name and last name are appended, each separated by a space.
  
-Label printing within the meaning of Form Filler means the smallest X coordinate of a line defines the start of printing. All other X-coordinate of a line used exclusively for sorting.+Further information on this topic can be found in the "Configurations" section of this documentation.
  
-Example:\\ +=== The Main Menu ===
-{{:de:plugins:formfiller:beispiel-umschlag-dl.png?400}}+
  
-With form printing, the printed image would appear as follows: (always relative to the upper left corner of the form) +To populate a PDF document, a data source and a form configuration must be selected in the main menu. Specifying a PDF file is optional.
-  * Gender (Informal) to position 20,30 (20 millimeters to the right and 30 mm downwards)  +
-  * First name at item 25,30 (25 millimeters to the right and 30 mm downwards) +
-  * Surname at position 26,30 (26 millimeters to the right and 30 mm downwards)+
  
-⇒ The last name here would begin a millimeter to the right of first name and this would almost completely overwrite it.+{{:de:plugins:formfiller:hauptmenue.png?400}}
  
-However, if label printing is set, the printed image is as follows: +The data source can be either a list configuration in conjunction with a role or individual users. 
-  * Gender first name last name // (each separated by a space)//+In the list configuration, only conditions specified for a field are evaluated. Fields without conditions are ignored.
  
-⇒ Smallest X coordinate in the example is 20, that is, gender (= Heading) determines the start of printing at position 20,30 (20 millimeters to the right and 30 mm downward, relative to the upper left corner of the form). First name and surname are, separately, added by a space.+{{:de:plugins:formfiller:hauptmenue-auswahl-listenkonfiguration-und-rolle.png?400|}} 
 +{{:de:plugins:formfiller:hauptmenue-auswahl-benutzer.png?400}}
  
-Further information on this topic can be found in "Configurations" section in this document.+The form configuration defines the various parameters for printing, including the XY coordinates of the profile fields to be printed, font size, font color, relationships, and the distinction between form and label printing.
  
-=== Menu settings ===+If no PDF file has been defined in a form configuration, a PDF document to be filled in can be selected via “PDF file (optional)”.
  
-The menu **settings** is selected via the Settings link, top right of the default view. It is divided into four menu items.+{{:de:plugins:formfiller:hauptmenue-auswahl-benutzer-mit-pdf-datei.png?400}}
  
-  * Configuration +=== Menu Preferences === 
-  * Options + 
-  * Plugin enable +The **Preferences** menu can be accessed via the button of the same name, which is only visible to administrators.
-  * Plugin information+
  
 {{:de:plugins:formfiller:standardansicht-einstellungen.png?300}} {{:de:plugins:formfiller:standardansicht-einstellungen.png?300}}
 {{:de:plugins:formfiller:menue-einstellungen.png?300}} {{:de:plugins:formfiller:menue-einstellungen.png?300}}
  
-=== Menu configurations === +=== Menu item Configurations-Edit === 
-Concerning configurations any number of PDF forms or label templates can be created. After a new installation three sample configurations are preset and filled with default values:+Any number of form configurations can be created via the editing function. After a new installation, three sample configurations are pre-configured and populated with default values:
  
-  * Sample Form+  * Sample form
   * Envelope DL   * Envelope DL
-  * mailing labels+  * Address labels
  
 {{:de:plugins:formfiller:beispielkonfiguration-musterformular.png?300}} {{:de:plugins:formfiller:beispielkonfiguration-musterformular.png?300}}
Line 193: Line 201:
 {{:de:plugins:formfiller:beispielkonfiguration-adressetiketten.png?300}} {{:de:plugins:formfiller:beispielkonfiguration-adressetiketten.png?300}}
  
-== Designation == +== Name == 
-The designation field is a mandatory field and to be filled ever. When displaying or editing the profile of a member this designation appears as a link. You can delete a configuration by deleting the contents of the field name, and then press the Save button.+The "Name" field is mandatory and must always be filled in.
  
-== Font, font style, font size and color == +== Font type, font style, font size and font color == 
-The font attributes set here (type, style, size and color) apply to all profile fields the same configuration.+The font attributes set here (type, style, size and color) apply to all profile fields of the same configuration.
  
 {{:de:plugins:formfiller:wahlmoeglichkeit-schriftart.png?200}} {{:de:plugins:formfiller:wahlmoeglichkeit-schriftart.png?200}}
Line 203: Line 211:
 {{:de:plugins:formfiller:wahlmoeglichkeit-schriftfarbe.png?200}} {{:de:plugins:formfiller:wahlmoeglichkeit-schriftfarbe.png?200}}
  
-== PDF-File == +== PDF form alignment, PDF form size, PDF form unit == 
-Concerning PDF file, a PDF form is selected and assigned to this configuration.+Parameters for the PDF file to be created. 
 + 
 +== PDF file == 
 +A PDF form can be selected via the PDF file and assigned to this configuration. 
 + 
 +Important note: PDF forms must not exceed PDF version 1.4. If an error message appears... 
 +//"This document (....pdf) probably uses a compression technique which is not supported by the free parser shipped with FPDI."//, then the PDF form was created in a higher version and with specific techniques that FormFiller cannot process.
  
 {{:de:plugins:formfiller:wahlmoeglichkeit-pdf-datei.png?200}} {{:de:plugins:formfiller:wahlmoeglichkeit-pdf-datei.png?200}}
  
-To enable Form Filler can access PDF forms, they must be uploaded beforehand in the Downloads section Admidio //(Hinweis: Die Auswahl für eine PDF-Datei wird erst am Bildschirm angezeigt, wenn mindestens eine Datei in den Downloads-Bereich hochgeladen wurde)//. Wird für eine Konfiguration kein PDF-Formular ausgewählt, so erzeugt FormFiller selbständig ein leeres Dokument im Format A4, hoch und der Einheit Millimeter.+In order for FormFiller to access PDF forms, these must first be uploaded to the Admidio download area. (Note: The selection for a PDF file will only be displayed on the screen once at least one file has been uploaded to the download area.) If no PDF form is selected for a configuration, FormFiller automatically creates a blank document based on the specified PDF form orientation, size, and unit (the default is portrait, A4, and millimeters).
  
 == Labels == == Labels ==
-To print labels the following information in the labels box are required: the number of columns, column spacing, number of lines, line spacing.+To print labels, the following information is required in the Labels field: number of columns, column spacing, number of rows, row spacing.
  
 Example:\\ Example:\\
 {{:de:plugins:formfiller:etikettendaten.png?500}}\\ {{:de:plugins:formfiller:etikettendaten.png?500}}\\
-Here the label printing would look like this: +The label printing would look like this: 
-  * 3 Labels across (3 colums), at a distance of 70 mm (column spacing) +  * 3 labels side by side (3 columns), spaced 70 mm apart (column spacing) 
-  * 7 Labels across (7 lines), at a distance of 25 mm (line spacing)+  * 7 labels one below the other (7 lines), spaced 25 mm apart (line spacing)
  
-If the labels field is filled, the XY position information of formfiller will be interpreted in another way: First formfiller sorts all profile fields using the position data after line (Y-coordinate) and column (X-coordinate). Then the smallest X coordinate of a line is determined. This smallest X coordinate defines the start of printing. All other X-coordinate on the same line used exclusively for sorting.+If the Labels field is populated, FormFiller interprets the XY position data as follows: First, FormFiller sorts all profile fields according to the position data by row (Y-coordinate) and column (X-coordinate). Then, the smallest X-coordinate in a row is determined. This smallest X-coordinate defines the start of the print run. All other X-coordinates in the same row are used solely for sorting purposes.
  
-Example:\\ +Example:\\
 {{:de:plugins:formfiller:beispiel-umschlag-dl.png?400}} {{:de:plugins:formfiller:beispiel-umschlag-dl.png?400}}
  
-Smallest X-coordinate for the row 30 in the above example is 20, that is print start of the line 30 is at position 20,30.+The smallest X-coordinate for line 30 in the example above is 20, i.e., the printing start of line 30 is at position 20,30. 
 + 
 +The profile fields are printed as follows:\ 
 +Title First Name Last Name 
 + 
 +Note: To write a single address label into a PDF document (e.g., a mail merge with invitations, where each invitation should have the member's address), the following values must be entered in the Labels field: 1,0,1,0. 
 + 
 +== Relationship == 
 +In addition to the profile data of a member, the profile data of a relationship can also be read (Note: Profile fields of a relationship are only available in the field selection after the form configuration has been saved, closed and reopened). 
 + 
 +{{:de:plugins:formfiller:beziehung-feldwahl.png?400}} 
 + 
 +In the following example, the relationship "spouse/partner" is selected and the partner's profile data is available in the configuration. 
 + 
 +{{:de:plugins:formfiller:beziehung-positionen.png?400}} 
 + 
 +In the main menu, the member and their spouse are selected as users. 
 + 
 +{{:de:plugins:formfiller:hauptmenue-auswahl-mit-partner.png?400}}
  
-The profile fields are printed as follows:\\  +The result of label printing could look like this: 
-Informal first name last name+{{:de:plugins:formfiller:adresse-dl-mit-partner-ohne-frankiervermerk.png?400}}
  
-Note: To write a single address label in a PDF document (for example, mail merge with invitations, with each individual invitation to have the address of the member) the following values are to be entered in the Labels box: 1,0,1,0.+It is also possible to print a postage stamp for Dialogpost (diagram mail). 
 +{{:de:plugins:formfiller:adresse-dl-mit-partner-und-frankiervermerk.png?400}}
  
-== Field selection == +== Field Selection == 
-Concerning Field selection any number of profile fields can be added to a configuration.\\+Any number of profile fields can be added to a configuration via field selection.
 {{:de:plugins:formfiller:wahlmoeglichkeit-feldwahl.png?300}} {{:de:plugins:formfiller:wahlmoeglichkeit-feldwahl.png?300}}
  
-To write the data of a profile image in a PDF document at least one X and one Y coordinate have to be specified. The details for X and Y define here the horizontal and vertical position in millimeters, based on the upper left corner of a form.+To write the data of a profile field into a PDF document, at least one X and one Y coordinate must be specified. The X and Y values define the horizontal and vertical position in millimeters, relative to the top left corner of a form.
    
 {{:de:plugins:formfiller:beispiel-xy-position.png?300}} {{:de:plugins:formfiller:beispiel-xy-position.png?300}}
  
-To highlight individual profile fields, further instructions can also be specified in addition to the X and Y coordinate. Several additional instructions here are separated by semicolons.+To highlight individual profile fields, additional instructions can be specified alongside the X and Y coordinates. Multiple additional instructions should be separated by semicolons.
  
-Syntax:\\ +The various parameters for the additional instructions:\\
-|Font:    |F=<Text>                                 |z.B. F=Arial       | +
-|Font style:   |A=B or I or U                      |z.B. A=B //(B for bold, I for itallic, U for underline, Multiple combinations are possible: A=BU corresponds to bold + underline)//    | +
-|Font size:  |S=<Size in Pixel>                       |z.B. S=20          | +
-|Font color:  |C=<RGB-Value>                             |z.B. C=0,0,255     | +
-|Gender:    |T=<Text for male>,<Text for female>   |z.B. T=Mr.,Mrs.  | +
-  +
- Example:\\ +
-|  **Profile Filed**  |  **Position and additional instructions**  |  **Signification**  | +
-|Surname         |10,20                                 |Surname at position 10,20     | +
-|Firstname           |10,40;S=7;F=Arial                     |Firstname at position 10,40 with Font style Arial 7pt     | +
-|Address          |40,20;C=255,102,255;A=BU              |Address at positon 40,20 with colir pink, underlined and bold  | +
-|Gender        |40,20,60,20;T=Mr.,Mrs.             |depends on the gender, is written the text "Lord" at position 40,20 or the text "Woman" at position 60,20 is written  |+
  
 +^ Parameter    ^Meaning                  ^Validity                                             ^ derived from                   ^Example                         ^Note |
 +^ F            |Font                     |                                                     | (F)ont                         |F=Arial |Possible values: Courier or Arial or Times or Symbol or ZapfDingbats|
 +^ A            | Font style              |                                                     | (A) attribute                  | A=B | Possible values: B (bold) or I (italic) or U (underline), multiple combinations are possible |
 +^ S            |Font size                |                                                     | (S)ize                         |S=16 |Font size in points|
 +^ C            |Font color               |                                                     | (C)olor                        |C=0,0,255 |Font color as RGB value (Red-Green-Blue)|
 +^ O            |Alignment                |No function when using parameters for a line break   | (O)rientation                  |O=C |Possible values: C (=centered) or R (=right-aligned)|
 +^ T            |Text                     |only for option/dropdown fields (e.g., gender)       | (T)ext                         |T=Mr,Mrs | |
 +^ {            |Pretext                  |                                                     | |{=Hello                        | |
 +^ }            |Posttext                 |                                                     | |}=,                            | |
 +^ D            |Date                     |only with additional field **Date**                  | (D)ate                         |D=dmy |Format parameter of the date() function|
 +^ V            | any text                |only with additional field **Text**                  | (V)alue                       | V=Note | |
 +^ L            |Image                    |only with additional field **profile photo**         | (L)ogo                         |L=PIC1234.jpg | |
 +^ LW           |Line width               |only for additional field **Line** or **Rectangle**  | (L)ine(W)idth                 |LW=0.5 | |
 +^ DC           | Character color         |only for additional fields **Line** or **Rectangle** | (D)raw(C)olor                 |DC=255,0,0 | Character color as RGB value (Red-Green-Blue) |
 +^ FC           | Fill color              |only for additional field **Rectangle**              | (F)ill(C)olor                | FC=0,100,100 | Fill color as RGB value (Red-Green-Blue) |
 +^ RS           | Rectangle style         |only for additional field **Rectangle**              | (R)ectangle(S)tyle | RS=D | Possible values: D (draw, with border) or F (fill, filled) or DF (draw and fill, filled with border) |
 +^ P            |Print on page...         |                                                     | (P)age |P=2 |Note: If the parameter P is used for a page that does not exist, the field will not be printed |
 +^ K            |KeyManager profile field |only for additional field **Text**                   | (K)eyManager |K=KEYNAME |The KeyManager plugin (key manager) does not have its own print routine. FormFiller provides an interface for creating key transfer documents via the parameter K. |
 +^ OI           |Index for pressure       |                                                     | (O)rder(I)ndex |OI=4 | |
 +^ OW           |Line spacing in mm       |                                                     | (O)rder(W)idth |OW=10 | |
 +^ WL           |Word length              |for all texts                                        | (W)ordwrap(L)ength |WL=35 |Used at line breaks |
 +^ CL           |character length         |for all texts                                        | (C)characterwrap(L)ength |CL=25 |used for line breaks |
 +^ WW           |Line spacing             |only in conjunction with WL or CL                    | (W)ordwrap(W)idth |WW=10 |Default setting: 5 |
 +^ WM           |max. number of lines     |only in conjunction with WL or CL                    | (W)ordwrap(M)ax |WM=3 |Default setting: 1 |
  
-//Special profile box Gender//+Use and effect of the print parameter "P" for single- and multi-page PDF files:\\ 
 +^       ^ FormFiller configuration contains print parameters for a single page (the parameter P=x is not used)    ^ FormFiller configuration contains print parameters for more than one page (the parameter P=x is used) | 
 +^ No PDF file is selected to write the data to. | The output file contains x pages corresponding to the number of addresses. Each page uses a blank DIN A4 page as the background. | A member's data is split across multiple pages according to parameter P. Each page uses a blank DIN A4 page as the background. | 
 +^ The PDF file to be processed consists of one page or multiple pages (e.g., an invitation in DIN A4 format or many postcards with online stamps). | The output file contains x pages corresponding to the number of addresses. The selected PDF file serves as the background. The data of the first member is printed on the first page of the PDF file. The data of the second member is printed on the second page of the PDF file, and so on. Once all pages of the PDF file are printed, the process starts again with the first page. Example: The data of 4 members are to be printed in a two-page PDF file. The data of the first member is printed on the first page of the PDF file. The data of the second member is printed on the second page of the PDF file. Then the process starts again with the first page. The data of the 3rd member is printed again on page 1, and the data of the 4th member is printed again on page 2. | The data of a member is split across multiple pages according to the parameter P. The selected PDF file serves as the background. Example: The data of 3 members are to be printed in A two-page PDF file is printed. Parameters P=1 and P=2 are used. Result: The data of the first member is printed on pages 1 and 2 according to the P parameters. For the second member, printing starts again on page 1. The data is printed on pages 1 and 2 according to the P parameters. The same applies to the third member.  |
  
-To identify the gender of a member in forms or to change the text "Mr" or "Mrs" to write on labels, there is a different syntax for the profile box Gender.+Examples:\\ 
 +^ Profile field            ^ Position and additional instructions                      ^ Meaning | 
 +|Last name                 |10,20                                                      |Last name in position 10,20 | 
 +|First name                |10,40;S=7;F=Arial                                          |First name at position 10,40 with Arial font in 7pt | 
 +|Address                   |40,20;C=255,102,255;A=BU                                    |Address at position 40,20 with pink font, underlined and in bold | 
 +|Gender                    |40,20,60,20;T=Mr,Mrs                                       |Depending on gender, the text "Mr" is written at position 40,20 or the text "Mrs" at position 60,20 |
  
-Syntax:\\  +**Special feature: Gender profile field** 
-X1,Y1,X2,Y2; T=<Text for male>,<Text for female> //(The "Text for male" is hereby issued to position X1, Y1, the "Text for female" at position X2, Y2.)//+ 
 +To indicate a member's gender in forms or to write "Mr." or "Mrs." on labels, there is a different syntax for the gender profile field. 
 + 
 +Syntax:\\ 
 +X1,Y1,X2,Y2; T=<Text for male>,<Text for female> //(The "text for male" is output at position X1,Y1, the "text for female" at position X2,Y2.)//
  
 or or
  
-X,Y; T=<Text for male>,<Text for female> //(Both the "Text for male", and the "Text for female" are output at position X, Y.)//+X,Y; T=<Text for male>,<Text for female> //(Both the "Text for male" and the "Text for female" are output at positions X,Y.)//
  
-Example:+Examples:
  
-1. Case:\\   +Case 1:\\ 
-In one form the following fields are available: {{:de:plugins:formfiller:herr-frau.png?100}}+The following fields are present in a form: {{:de:plugins:formfiller:herr-frau.png?100}}
  
-  * the rectangle of Male is located at coordinates 60,50 +  * The rectangle of male is located at coordinates 60,50 
-  * the rectangle of female located on coordinate 80,50+  * The rectangle of the female is located at coordinate 80,50
  
-Depending on the gender to be male or female marked with an X.+Depending on gender, male or female should be marked with an X.
  
-Syntax:\\ +Syntax:\\
 60,50,80,50;T=X,X 60,50,80,50;T=X,X
  
-Result:\\  +Result:\\ 
-If the member is male, so an X is written at position 60,50, the member is female, an X is written at position 80.50+If the member is male, an X is written at position 60, 50; if the member is female, an X is written at position 80, 50.
  
-2. Case:\\  +Case 2:\\ 
-For labels should, regardless of gender, the text "Mr." or "Mrs." be written at position 70,40.+For labels, the text "Mr." or "Mrs." should be written at position 70,40, depending on gender.
  
-Syntax:\\  +Syntax:\\ 
-70,40,70,40;T=Mr,Mrs //(In this case also, shorthand would be possible: 70,40;T=Mr,Mrs)//+70,40,70,40;T=Mr.,Mrs. //(In this case, the following shortened notation would also be possible: 70,40;T=Mr.,Mrs.)//
  
-Result:\\  +Result:\\ 
-If the member is male, so the text Lord at position 70,40 is written, the member is female, so women will be written at the same position of the text.+If the member is male, the text "Herr" is written at position 70,40; if the member is female, the text "Frau" is written at the same position.
  
  
-//The additional fields Date, profile photo and text//+**The additional fields Date, Profile Photo, Text, Line and Rectangle**
  
-In addition to the profile fields the current date, the profile picture of the member can be displayed (if any) as well as any text can be inserted into the PDF document.+In addition to the profile fields, the current date, the member's profile picture (if available), an image from the Admidio download area, any text, a line or even a rectangle can be inserted into the PDF document.
  
-Syntax:\\  +^ Field ^ Position and additional instructions ^ Meaning | 
-|  **Field**  |  **Position and additional instructions**  |  **Signification**  | +|Date |10.20 |Current date at position 10.20 | 
-|Date      |10,20                                 |Current date at position 10,20  | +|Date |10,40;D=d. FY |Current date in the format <day>. <month> <year> (=format parameter of the date() function) at position 10,40, e.g. November 12, 2017 | 
-|Date        |10,40;D=d. F Y                        |Current date in format <Day>. <Month> <Year> ( = from function date() ) at position 10,40  | +|Date |17,20;F=Arial;S=12 |Current date at position 17,20 in Arial 12 pt | 
-|Date        |17,20;F=Arial;S=12                    |Current date at position 17,20 in Arial 12 pt  | +|Profile photo |40,20 |The member's profile photo (if available) will be inserted at position 40,20 with 72 dpi. | 
-|Profile photo  |40,20                                 |The profile photo of the member (if any) will be added at position 40,20 with 72 dpi.  | +|Profile photo |40,20,30 |The member's profile photo will be inserted at position 40,20 with a width of 30 mm, maintaining the aspect ratio. | 
-|Profile photo  |40,20,30                              |The profile photo of the member is inserted at position 40,20 having a width of 30 mm, while maintaining the aspect ratio.  | +|Profile photo |40,20,0,50 |The member's profile photo will be inserted at position 40,20 with a height of 50 mm, maintaining the aspect ratio. | 
-|Profile photo  |40,20,0,50                            |The profile photo of the member is inserted at position 40,20 with a height of 50 mm, while maintaining the aspect ratio.  | +|Profile photo |40,20,30,50;L=image.jpg |The photo image.jpg from the Admidio download area will be inserted at position 40,20, if available, with a width of 30 mm and a height of 50 mm. | 
-|Profile photo  |40,20,30,50;L=image.jpg                |The photo image.jpg from the Downloads section Admidio, when available, inserted in position 40,20 having a width of 30 mm and a height of 50 mm.  | +|Text |10,20;V=Note |The text "Note" is inserted at position 10, 20 | 
-|Text        |10,20;V=Note                       |The text message is inserted at position 10,20  |+|Line |20,40,60,80;LW=0.5 |Line from position 20,40 to position 60,80 in line width 0.5 mm | 
 +|Rectangle |60,70,20,40;LW=2;RS=FD;DC=255,0,0;FC=0,255,255 |Rectangle at position 60,70 with width 20 and height 40, filled frame with frame width 2 mm, frame color 255,0,0 and fill color 0,255,255 |
  
-Supported image formats: +Supported image formats:
   * JPEG (Joint Photographic Experts Group)   * JPEG (Joint Photographic Experts Group)
-  * PNG (Portable Network Graphics)  +  * PNG (Portable Network Graphics) 
-  * GIF (Graphics Interchange Format) +  * GIF (Graphics Interchange Format)
  
-=== Menu Options === +**Dynamic Fields**
-Concerning Options preferences for displaying the created PDF documents can be set and uninstallation can be performed.+
  
-{{:de:plugins:formfiller:optionen.png?300}}+For dynamic fields (e.g. role memberships), the X and Y coordinates specify the position of the first line of the printout.
  
-== max. PDF-Display == +All subsequent lines are added dynamically (depending on the number of roles within a role membership). The line spacing in millimeters can be defined using the parameter OW=x (e.g., OW=10). The default setting is 5 mm.
-PDF display is the maximum number of pages that must have a PDF document (creation of multiple documents) so that it appears on the screen yet. Is the number of pages is greater, the download of the file is available immediately.+
  
-== Uninstall == +If further fields (profile fields, text, other dynamic fields) are to be printed after a dynamic field, the parameter OI=x (e.g., OI=1) must be used. OI=x defines the order of the rows. The X/Y coordinates of the field with the smallest OI value (e.g., OI=1) determine the starting point of the entire list.
-Concerning uninstall all created configuration files can be deleted. +
  
-{{:de:plugins:formfiller:deinstallation.png?300}} +Example: 
-{{:de:plugins:formfiller:deinstallation-hinweis.png?300}}+|Text |20,120;.........;OI=1;.........OW=10 | 
 +|Line | ...................;OI=2;.........;OW=8 | 
 +|Role Memberships |..........;OI=3;.............;OW=7 | 
 +|Last Name |.........................;OI=5;............... | 
 +|First name |....................;OI=4;.................. |
  
-=== Menu Enable Plugin === +In the example above, printing begins at position 20,120 with text. A line is drawn at position 20,130. The list of role memberships begins at position 20,138. Each role is printed 7 mm below the previous one. After all roles, the first name is printed first, followed by the last name.
-Selection of roles, their families may call the plugin. The plugin and the settings menu can be unlocked separately for specific roles.+
  
-{{:de:plugins:formfiller:pluginfreigabe.png?300}}+A sample configuration "Personalbogen.cfg" with the parameters OI and OW [[https://github.com/rmbinder/FormFiller/releases|is available here on GitHub under Release 2.3.3]]).
  
-Note: A selected role also requires at least one of the following permissions in the Admidio Rle Management :+//Notice:// 
 +The parameter OI=x can only be used with fields containing absolute coordinates (e.g., text at position X/Y or a line from position X/Y to position X2/Y2). OI=x does not work with rectangles or images, as X2 and Y2 are relative values for these.
  
-  * "Manage and assign roles" +**Line break**
-  * "Edit profile data of all users" +
-  * "Manage and organize registrations"+
  
-=== Menu Plugin information ===+Line breaks are available specifically for long texts. Using the parameters WL, CL, WW, and WM, it is possible to split a text into individual segments and output them one below the other. 
 +  * WL = Word length 
 +  * CL = character length 
 +  * WW = Line spacing (default: 5) 
 +  * WM = max. number of rows (default: 1).
  
-{{:de:plugins:formfiller:plugininformationen.png?300}}+Example 1:
  
-Here information about the version and the state of the plugin will be displayed.+-> ...;WL=15;WW=5;WM=3\\ 
 +-> A line break occurs after a maximum of 15 characters, without splitting individual words. The line spacing is 5 mm and a maximum of 3 lines are displayed.
  
-=== Storing the Configurations === +Neuhofen a.d. Krems\\ 
-All configuration data is stored in a table named adm_plugin_preferences in Admidio database. Should not exist this table, it is created.+becomes\\ 
 +Neuhofen a.d\\ 
 +Krems\\ 
 + 
 +Example 2: 
 + 
 +-> ...;CL=13;WW=5;WM=3\\ 
 +-> A line break occurs after 13 characters. The line spacing is 5 mm and a maximum of 3 lines are displayed. 
 + 
 +This is a sample text\\ 
 +becomes\\ 
 +This is a sam\\ 
 +ple text\\ 
 + 
 +=== Menu item Configuration-Sort === 
 +Here, configurations can be sorted alphabetically and by XY coordinates. 
 + 
 +=== Menu item Configurations-Export/Import === 
 +Configurations can be both exported and imported via export/import. 
 +(Example configurations are available at [[https://github.com/rmbinder/FormFiller/releases]]).\\ 
 +{{:de:plugins:formfiller:export_import.png?300}} 
 + 
 +=== Menu item System-Informations === 
 +Information about the version and status of the plugin is displayed here. 
 +{{:de:plugins:formfiller:plugininformation.png?300}} 
 + 
 +=== Menu item System-Options === 
 +The options menu allows you to configure settings for displaying the created PDF documents and to uninstall the program. 
 +{{:de:plugins:formfiller:optionen.png?300}} 
 + 
 +== Max. PDF display == 
 +Max. PDF display is the maximum number of pages a PDF document (when creating multiple documents) can have and still be displayed on the screen. If the number of pages exceeds this, the file will be offered for download immediately. 
 + 
 +== Additional PDF Sizes == 
 +In addition to the standard sizes A3, A4, etc., you can specify additional sizes for the PDF document to be generated. Separate multiple sizes with semicolons (e.g., 160x100; 120x60). 
 + 
 +=== Menu item System-Uninstallation == 
 +Uninstalling the plugin will delete all configuration data created by it.\\ 
 +{{:de:plugins:formfiller:deinstallation.png?300}} 
 +{{:de:plugins:formfiller:deinstallation-hinweis.png?300}}
  
-Currently, in this table, the following configurations plugins are stored: +=== Menu item Security-Access permission for preferences === 
-   * Membership fee +In addition to the "Administrator" role, other roles can be authorized to access the "Settings" module.
-   * Birthday list +
-   * Form Filler+
  
-The table entries of plugins Form Filler all begin here with the letters "PFF".+=== Saving the configuration === 
 +All configuration data is stored in a table named adm_plugin_preferences in the Admidio database. If this table does not exist, it will be created.
  
-=== File readme.txt === +The table entries of the FormFiller plugin all begin with the letters "PFF".
-Current information regarding update or reinstall the plugin are located in the file readme.txt.+
  
 === Examples === === Examples ===
-Below are some examples of filled formfiller PDF forms:+Below are some examples of PDF forms populated with FormFiller:
  
-|  Pattern of an instrument of accession:  |  The data filled application form:  |+| Sample membership application: | The completed membership application: |
 |{{:de:plugins:formfiller:beitrittserklaerung.png?400}}|{{:de:plugins:formfiller:beitrittserklaerung-ausgefuellt.png?400}}| |{{:de:plugins:formfiller:beitrittserklaerung.png?400}}|{{:de:plugins:formfiller:beitrittserklaerung-ausgefuellt.png?400}}|
  
-|  Pattern of a membership card:  |  The data filled membership card:  |+| Sample membership card: | The membership card filled with data: |
 |{{:de:plugins:formfiller:mitgliedsausweis.png?300}}|{{:de:plugins:formfiller:mitgliedsausweis-ausgefuellt.png?300}}| |{{:de:plugins:formfiller:mitgliedsausweis.png?300}}|{{:de:plugins:formfiller:mitgliedsausweis-ausgefuellt.png?300}}|
  
-|  Pattern of a SEPA Direct Debit Mandate:  |  The data filled SEPA direct debit mandate: |+| Sample SEPA Direct Debit Mandate: | The SEPA Direct Debit Mandate filled with data: |
 |{{:de:plugins:formfiller:sepa-lastschriftmandat.png?400}}|{{:de:plugins:formfiller:sepa-lastschriftmandat-ausgefuellt.png?400}}| |{{:de:plugins:formfiller:sepa-lastschriftmandat.png?400}}|{{:de:plugins:formfiller:sepa-lastschriftmandat-ausgefuellt.png?400}}|
  • en/plugins/formfiller.1717271687.txt.gz
  • Last modified: 2024/06/01 21:54
  • by rmb