Your first PDF form with Scribus

From Scribus Wiki
Revision as of 08:03, 14 January 2011 by Malex (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Other languages: Polski (pl) - Português (br) - Deutsch (de)

This article is part of the HOWTOs series.
Installation Usage PDF issues Imposition Other


Requirements:   
Operating System:   any supported system  
Scribus Version:   stable 1.3.3.10 or above
PDF forms skills:   novice
PDF viewer:   Adobe Reader 7 or newer
Browser:   any that supports Adobe Reader plug-in,
  preferrably Firefox


Introduction

edit
  1. Your first PDF form with Scribus
  2. How to create an e-Mail PDF Survey Form
  3. Your second PDF form with Scribus
  4. Enhance PDF forms with JavaScript

One of the biggest advantages of Scribus is its ability to create PDF forms with embedded JavaScript scripts. Usually, PDF forms are filled out by users on their computers and then printed out locally. Information in a PDF form may also be submitted online to a remote location for further processing. However, this online submission works only when using the Acrobat Reader plugin, not when using the standalone Acrobat Reader application.

There are still some issues around creating PDF forms in Scribus that need to be addressed to make Scribus a fully featured PDF forms tool. For example, there is an issue with the behaviour of radio buttons(see this list of bugs and feature requests related to PDF forms).

Nevertheless, Scribus already is a useful PDF forms tool for many people, and it is becoming better at an incredible pace. Enjoy!

Creating PDF forms

Its rather simple to create a new form with Scribus. We start with clicking on the "New Document" icon or choosing New from the File menu.

New document dialog in Scribus 1.3.3.*

Let us turn on the grid first (menu View>Show Grid), it will help us to correctly locate our form fields on the page. We need some text frames to make a nice title and field descriptions - a few clicks on the text frame icon (that one right to the arrow) and all the text frames are there in no time.


Pdf form howto grid menu.png


Having filled our frames with text, we can change their properties with the Properties palette, which can be found in the Windows menu.


Pdf form howto properties.png


Now we can start adding form elements: some text fields and one button for submitting our form to an URL. To add a field simply click on the arrow on the right side of the OK icon and select a type from the displayed options: button, text field, check box, combo box, and list box.


Pdf form howto pdf form elements.png


The current active element of the form has a red frame border; you can select an element in choosing the Select icon (the one with an arrow, left to the text frame icon) and clicking on the item to be chosen.


Ulica.png


The right click on an element activates a new context menu. We choose Pdf Options > Field Properties and define field names (we will need the field names in our PHP script, to which we'll send the form), types (e.g., number, time, date), and actions to be performed on different events (Mouse Enter, Mouse Exit, On Blur, and so on).


Field properties appearance1.png


Here we are defining the No field as a number. Acrobat Reader won't accept anything else as a valid entry, then.


Field properties format1.png


To change the existing tab order of your form fields, simply open the Properties palette, click on the X,Y,Z tab, and change the level of the selected field.


Pdf form howto field tab order.png


Here, we are defining a custom validation script for the Name field - after changing the field contents there will be a beep sound and an alert will be showed (not very sophisticated, I know, but it still demonstrates the possibilities of PDF). Scribus has its own simple text editor, which enables us to save the script to a separate file. Custom scripts can be defined not only on the form field level, but document wide too (Edit > JavaScripts).


Js validate script.png


After saving the script and closing the editor, the script contents is shown in the Field Properties.


Field properties validate.png


We have still to define, to which URL the form contents will be sent (there is a simple PHP script at the destination address, which will format and display the received form data). We choose in the button properties as the action type Submit form and enter the address of our PHP script: scribus_test.php. We match the Submit Data as HTML option to end with (the other option would be the FDF data, but this is a very different story) and we are done now.


Field action.png


The only thing else to do is to export the document to PDF: menu File > Export... > Save as PDF.... We select PDF 1.3 as the file format and save the file.


Pdf form howto pdf export.png


Now it is time to launch Acrobat Reader and and see what you have done. Acrobat Reader 7 finally delivers the capability to display Unicode characters inside form fields -- great news for all non English native speakers. Both Name and Street fields contain characters outside of the Latin-1 font set. The No field contains a default value of 15 that has been put into it eaerlier -- in Scribus, just right click onto the form field, choose Edit text... from the context menu and type your default value.


Acroread unicode.png

Configuring browsers for viewing PDF forms

If you are a happy owner of a relatively recent edition of Firefox, Mozilla, or Netscape, you are best suited to view PDF forms with your browser. Since neither Opera nor Konqueror has been capable of submitting PDF forms, let's focus on Mozilla family. The only thing to do is to tell Firefox, where the Acrobat Reader plug-in is located. For Linux:

  1. Create a symbolic link to $your_installation_directory/Acrobat7.0/Browser/intellinux/nppdf.so 
     to your Mozilla plugins directory, e.g. in Gentoo Linux /usr/lib/MozillaFirefox/plugins
  2. Ensure a copy of acroread is in your PATH.

For using Firefox plug-ins with other operating systems, refer to Mozilla Plugindoc site.


Testing and downloading sample files

  • Sample PDF form (made with Scribus) -- Open this form in your browser and click on the Submit button. If your browser is configured for working with Adobe Reader, you should get a responce from a PHP script.

Final word

My very own impression: Scribus as a tool for working with PDF forms seems to be more comfortable in use than Adobe Acrobat 5.0 (the only version, I've worked with). It's a lot easier to layout documents with Scribus, since Acrobat only allows you to edit existing documents, but not to create a new document from scratch. Scribus provides us with the full control over the final results and allows us much more freedom in changing the document's layout. More over, Scribus files can be edited even with a simple text editor, since its file format is entirely XML based.


Other information sources


(c)

The content of this page is available under the Creative Commons Attribution-ShareAlike Licence and Free Documentation Licence

If you alter, transform, or build upon this work, you may distribute the resulting work either under one or under both of the abovementioned licences.