[PHP-DOC] cvs: phpdoc /it/functions fdf.xml From: Luca Perugini (l.perugini <email protected>)
Date: 08/31/00

perugini Thu Aug 31 09:33:10 2000 EDT

  Modified files:
    /phpdoc/it/functions fdf.xml
  Log:
  Sync with en tree.
  
  
Index: phpdoc/it/functions/fdf.xml
diff -u phpdoc/it/functions/fdf.xml:1.2 phpdoc/it/functions/fdf.xml:1.3
--- phpdoc/it/functions/fdf.xml:1.2 Sat Jun 24 00:38:44 2000
+++ phpdoc/it/functions/fdf.xml Thu Aug 31 09:33:10 2000
@@ -6,16 +6,12 @@
 
    <simpara>
     Forms Data Format (FDF) is a format for handling
- forms within PDF documents. You should read the documentation at <ulink url="http://partners.adobe.com/asn/developer/acrosdk/forms.html">http://partners.adobe.com/asn/developer/acrosdk/forms.html>
- for more information on what FDF is and how it is used in general.</simpara>
+ forms within PDF documents. You should read the documentation at
+ <ulink url="&spec.pdf.fdf;">&spec.pdf.fdf;</ulink>
+ for more information on what FDF is and how it is used in general.
+ </simpara>
 
    <note><simpara>
- Currently Adobe only provides a libc5 compatible version for Linux. Tests
- with glibc2 resulted in a segmentation fault. If somebody is able to
- make it work, please comment on this page.
- </simpara></note>
-
- <note><simpara>
     If you run into problems configuring php with fdftk support, check
     whether the header file FdfTk.h and the library libFdfTk.so are at
     the right place. They should be in fdftk-dir/include and
@@ -25,23 +21,36 @@
 
    <simpara>
     The general idea of FDF is similar to HTML forms. The diffence is
- basically the format how filled in data is transmitted to the server when
- the submit button is pressed (this
- is actually the Form Data Format) and the format of the form itself
- (which is the Portable Document Format, PDF). Processing the FDF data is
- one of the features provided by the fdf functions. But there is more.
- One may as well take an existing PDF form and populated the input fields
- with data without modifying the form itself. In such a case one would
- create a FDF document (<function>fdf_create</function>) set the values
- of each input field (<function>fdf_set_value</function>) and associate
- it with a PDF form
+ basically the format how data is transmitted to the server when the submit
+ button is pressed (this is actually the Form Data Format) and the format
+ of the form itself (which is the Portable Document Format, PDF).
+ Processing the FDF data is one of the features provided by the fdf
+ functions. But there is more. One may as well take an existing PDF form
+ and populated the input fields with data without modifying the form
+ itself. In such a case one would create a FDF document
+ (<function>fdf_create</function>) set the values of each input field
+ (<function>fdf_set_value</function>) and associate it with a PDF form
     (<function>fdf_set_file</function>). Finally it has to be sent to the
- browser with
- MimeType application/vnd.fdf. The Acrobat reader plugin of your
- browser recognizes the MimeType, reads the associated PDF form and
- fills in the data from the FDF document.</simpara>
-
+ browser with MimeType <literal>application/vnd.fdf</literal>. The Acrobat
+ reader plugin of your browser recognizes the MimeType, reads the
+ associated PDF form and fills in the data from the FDF document.
+ </simpara>
+
    <simpara>
+ If you look at an FDF-document with a text editor you will find a
+ catalogue object with the name <literal>FDF</literal>. Such an object may
+ contain a number of entries like <literal>Fields</literal>,
+ <literal>F</literal>, <literal>Status</literal> etc..
+ The most commonly used entries are <literal>Fields</literal> whicht points
+ to a list of input fields, and <literal>F</literal> which contains the
+ filename of the PDF-document this data belongs to. Those entries are
+ referred to in the FDF documention as /F-Key or /Status-Key.
+ Modifying this entries
+ is done by functions like <function>fdf_set_file</function> and
+ <function>fdf_set_status</function>. Fields are modified with
+ <function>fdf_set_value</function>, <function>fdf_set_opt</function> etc..
+ </simpara>
+ <simpara>
     The following examples shows just the evaluation of form data.</simpara>
    <simpara></simpara>
     <example>
@@ -428,6 +437,111 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.fdf-set-flags">
+ <refnamediv>
+ <refname>fdf_set_flags</refname>
+ <refpurpose>Sets a flag of a field</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>fdf_set_flags</function></funcdef>
+ <paramdef>int <parameter>fdf_document</parameter></paramdef>
+ <paramdef>string <parameter>fieldname</parameter></paramdef>
+ <paramdef>int <parameter>whichFlags</parameter></paramdef>
+ <paramdef>int <parameter>newFlags</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ The <function>fdf_set_flags</function> sets certain flags
+ of the given field <parameter>fieldname</parameter>.
+ </para>
+ <para>
+ See also <function>fdf_set_opt</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.fdf-set-opt">
+ <refnamediv>
+ <refname>fdf_set_opt</refname>
+ <refpurpose>Sets an option of a field</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>fdf_set_opt</function></funcdef>
+ <paramdef>int <parameter>fdf_document</parameter></paramdef>
+ <paramdef>string <parameter>fieldname</parameter></paramdef>
+ <paramdef>int <parameter>element</parameter></paramdef>
+ <paramdef>string <parameter>str1</parameter></paramdef>
+ <paramdef>string <parameter>str2</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ The <function>fdf_set_opt</function> sets options
+ of the given field <parameter>fieldname</parameter>.
+ </para>
+ <para>
+ See also <function>fdf_set_flags</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.fdf-set-submit-form-action">
+ <refnamediv>
+ <refname>fdf_set_submit_form_action</refname>
+ <refpurpose>Sets an javascript action of a field</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>fdf_set_submit_form_action</function></funcdef>
+ <paramdef>int <parameter>fdf_document</parameter></paramdef>
+ <paramdef>string <parameter>fieldname</parameter></paramdef>
+ <paramdef>int <parameter>trigger</parameter></paramdef>
+ <paramdef>string <parameter>script</parameter></paramdef>
+ <paramdef>int <parameter>flags</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ The <function>fdf_set_submit_form_action</function> sets a submit form
+ action for the given field <parameter>fieldname</parameter>.
+ </para>
+ <para>
+ See also <function>fdf_set_javascript_action</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.fdf-set-javascript-action">
+ <refnamediv>
+ <refname>fdf_set_javascript_action</refname>
+ <refpurpose>Sets an javascript action of a field</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>fdf_set_javascript_action</function></funcdef>
+ <paramdef>int <parameter>fdf_document</parameter></paramdef>
+ <paramdef>string <parameter>fieldname</parameter></paramdef>
+ <paramdef>int <parameter>trigger</parameter></paramdef>
+ <paramdef>string <parameter>script</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ The <function>fdf_set_javascript_action</function> sets a javascript
+ action for the given field <parameter>fieldname</parameter>.
+ </para>
+ <para>
+ See also <function>fdf_set_submit_form_action</function>.
+ </para>
+ </refsect1>
+ </refentry>
  </reference>
 
 <!-- Keep this comment at the end of the file
@@ -440,7 +554,7 @@
 sgml-indent-step:1
 sgml-indent-data:t
 sgml-parent-document:nil
-sgml-default-dtd-file:"../manual.ced"
+sgml-default-dtd-file:"../../manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil