php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

fdf: fix XML to get remove of useless wrapping para tags (#5117)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-16 05:45:04 +00:00
committed by GitHub
parent 1ad8299bbc
commit 399153faa0
29 changed files with 815 additions and 960 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
reference/fdf/functions/fdf-add-doc-javascript.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.fdf-add-doc-javascript' xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-add-doc-javascript">
<refnamediv>
<refname>fdf_add_doc_javascript</refname>
<refpurpose>Adds javascript code to the FDF document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -16,42 +16,40 @@
</methodsynopsis>
<para>
Adds a script to the FDF, which Acrobat then adds to the doc-level scripts
of a document, once the FDF is imported into it.
of a document, once the FDF is imported into it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script_name</parameter></term>
<listitem>
<para>
The script name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script_code</parameter></term>
<listitem>
<para>
The script code. It is strongly suggested to use <literal>\r</literal>
for linebreaks within the script code.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script_name</parameter></term>
<listitem>
<para>
The script name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script_code</parameter></term>
<listitem>
<para>
The script code. It is strongly suggested to use <literal>\r</literal>
for linebreaks within the script code.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -63,10 +61,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Adding JavaScript code to a FDF</title>
<programlisting role="php">
<example>
<title>Adding JavaScript code to a FDF</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_create();
@@ -74,11 +71,11 @@ fdf_add_doc_javascript($fdf, "PlusOne", "function PlusOne(x)\r{\r return x+1;\r
fdf_save($fdf);
?>
]]>
</programlisting>
<simpara>
will create a FDF like this:
</simpara>
<screen>
</programlisting>
<simpara>
will create a FDF like this:
</simpara>
<screen>
<![CDATA[
%FDF-1.2
%âãÏÓ
@@ -94,13 +91,11 @@ trailer
>>
%%EOF
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/fdf/functions/fdf-close.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-close" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-close">
<refnamediv>
<refname>fdf_close</refname>
<refpurpose>Close an FDF document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,14 +41,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_open</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_open</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/fdf/functions/fdf-create.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-create" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-create">
<refnamediv>
<refname>fdf_create</refname>
<refpurpose>Create a new FDF document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -13,7 +13,7 @@
<void/>
</methodsynopsis>
<para>
Creates a new FDF document.
Creates a new FDF document.
</para>
<para>
This function is needed if one would like to populate input fields in a
@@ -35,10 +35,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Populating a PDF document</title>
<programlisting role="php">
<example>
<title>Populating a PDF document</title>
<programlisting role="php">
<![CDATA[
<?php
$outfdf = fdf_create();
@@ -53,24 +52,20 @@ fpassthru($fp);
unlink("outtest.fdf");
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_close</function></member>
<member><function>fdf_save</function></member>
<member><function>fdf_open</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_close</function></member>
<member><function>fdf_save</function></member>
<member><function>fdf_open</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/fdf/functions/fdf-errno.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-errno" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-errno">
<refnamediv>
<refname>fdf_errno</refname>
<refpurpose>Return error code for last fdf operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -35,14 +35,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_error</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_error</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

41
reference/fdf/functions/fdf-error.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-error" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-error">
<refnamediv>
<refname>fdf_error</refname>
<refpurpose>Return error description for FDF error code</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,41 +20,36 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
An error code obtained with <function>fdf_errno</function>.
If not provided, this function uses the internal error code set by the
last operation.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
An error code obtained with <function>fdf_errno</function>.
If not provided, this function uses the internal error code set by the
last operation.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error message as a string, or the string
Returns the error message as a string, or the string
<literal>no error</literal> if nothing went wrong.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_errno</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_errno</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

79
reference/fdf/functions/fdf-get-ap.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-ap" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-ap">
<refnamediv>
<refname>fdf_get_ap</refname>
<refpurpose>Get the appearance of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,49 +17,47 @@
</methodsynopsis>
<para>
Gets the appearance of a <parameter>field</parameter> (i.e. the value of
the /AP key) and stores it in a file.
the /AP key) and stores it in a file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>face</parameter></term>
<listitem>
<para>
The possible values are <constant>FDFNormalAP</constant>,
<constant>FDFRolloverAP</constant> and <constant>FDFDownAP</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The appearance will be stored in this parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>face</parameter></term>
<listitem>
<para>
The possible values are <constant>FDFNormalAP</constant>,
<constant>FDFRolloverAP</constant> and <constant>FDFDownAP</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The appearance will be stored in this parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -70,7 +68,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

89
reference/fdf/functions/fdf-get-attachment.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-attachment" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-attachment">
<refnamediv>
<refname>fdf_get_attachment</refname>
<refpurpose>Extracts uploaded file embedded in the FDF</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,50 +17,48 @@
<para>
Extracts a file uploaded by means of the "file selection" field
<parameter>fieldname</parameter> and stores it under
<parameter>savepath</parameter>.
<parameter>savepath</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>savepath</parameter></term>
<listitem>
<para>
May be the name of a plain file or an existing directory in which the
file is to be created under its original name. Any existing file under
the same name will be overwritten.
</para>
<note>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
There seems to be no other way to find out the original filename but
to store the file using a directory as
<parameter>savepath</parameter> and check for the basename it was
stored under.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>savepath</parameter></term>
<listitem>
<para>
May be the name of a plain file or an existing directory in which the
file is to be created under its original name. Any existing file under
the same name will be overwritten.
</para>
<note>
<para>
There seems to be no other way to find out the original filename but
to store the file using a directory as
<parameter>savepath</parameter> and check for the basename it was
stored under.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -83,10 +81,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Storing an uploaded file</title>
<programlisting role="php">
<example>
<title>Storing an uploaded file</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_open_string($HTTP_FDF_DATA);
@@ -94,13 +91,11 @@
echo "The uploaded file is stored in $data[path]";
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/fdf/functions/fdf-get-encoding.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-encoding" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-encoding">
<refnamediv>
<refname>fdf_get_encoding</refname>
<refpurpose>Get the value of the /Encoding key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,15 +42,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_encoding</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_encoding</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/fdf/functions/fdf-get-file.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-file" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-file">
<refnamediv>
<refname>fdf_get_file</refname>
<refpurpose>Get the value of the /F key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,15 +41,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_file</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_file</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/fdf/functions/fdf-get-status.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-status" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-status">
<refnamediv>
<refname>fdf_get_status</refname>
<refpurpose>Get the value of the /STATUS key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,15 +41,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_status</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_status</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

73
reference/fdf/functions/fdf-get-value.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-value" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-value">
<refnamediv>
<refname>fdf_get_value</refname>
<refpurpose>Get the value of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,37 +21,35 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>which</parameter></term>
<listitem>
<para>
Elements of an array field can be retrieved by passing this optional
parameter, starting at zero. For non-array fields, this parameter will
be ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>which</parameter></term>
<listitem>
<para>
Elements of an array field can be retrieved by passing this optional
parameter, starting at zero. For non-array fields, this parameter will
be ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -63,15 +61,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_value</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_value</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

39
reference/fdf/functions/fdf-get-version.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-get-version" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-get-version">
<refnamediv>
<refname>fdf_get_version</refname>
<refpurpose>Gets version number for FDF API or file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,19 +20,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -40,22 +38,19 @@
<para>
Returns the version as a string. For the current FDF toolkit 5.0 the API
version number is <literal>5.0</literal> and the document version number
is either <literal>1.2</literal>, <literal>1.3</literal> or
is either <literal>1.2</literal>, <literal>1.3</literal> or
<literal>1.4</literal>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_version</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_version</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

67
reference/fdf/functions/fdf-next-field-name.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-next-field-name" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-next-field-name">
<refnamediv>
<refname>fdf_next_field_name</refname>
<refpurpose>Get the next field name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,28 +21,26 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string. If not given, the first field will
be assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string. If not given, the first field will
be assumed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Detecting all fieldnames in a FDF</title>
<programlisting role="php">
<example>
<title>Detecting all fieldnames in a FDF</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_open($HTTP_FDF_DATA);
@@ -68,22 +65,18 @@ for ($field = fdf_next_field_name($fdf);
}
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_get_value</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_get_value</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

59
reference/fdf/functions/fdf-open-string.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-open-string" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-open-string">
<refnamediv>
<refname>fdf_open_string</refname>
<refpurpose>Read a FDF document from a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>fdf_data</parameter></methodparam>
</methodsynopsis>
<para>
Reads form data from a string.
Reads form data from a string.
</para>
<para>
You can use <function>fdf_open_string</function> together with
@@ -24,20 +24,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_data</parameter></term>
<listitem>
<para>
The data as returned from a PDF form or created using
<function>fdf_create</function> and
<function>fdf_save_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_data</parameter></term>
<listitem>
<para>
The data as returned from a PDF form or created using
<function>fdf_create</function> and
<function>fdf_save_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -49,10 +47,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Accessing the form data</title>
<programlisting role="php">
<example>
<title>Accessing the form data</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_open_string($HTTP_FDF_DATA);
@@ -60,25 +57,21 @@ $fdf = fdf_open_string($HTTP_FDF_DATA);
fdf_close($fdf);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_open</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save_string</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_open</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save_string</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

59
reference/fdf/functions/fdf-open.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-open" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-open">
<refnamediv>
<refname>fdf_open</refname>
<refpurpose>Open a FDF document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -13,7 +13,7 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Opens a file with form data.
Opens a file with form data.
</para>
<para>
You can also use <function>fdf_open_string</function> to process the
@@ -23,20 +23,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the FDF file. This file must contain the data as returned from
a PDF form or created using <function>fdf_create</function> and
<function>fdf_save</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the FDF file. This file must contain the data as returned from
a PDF form or created using <function>fdf_create</function> and
<function>fdf_save</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -48,10 +46,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Accessing the form data</title>
<programlisting role="php">
<example>
<title>Accessing the form data</title>
<programlisting role="php">
<![CDATA[
<?php
// Save the FDF data into a temp file
@@ -65,25 +62,21 @@ $fdf = fdf_open("test.fdf");
fdf_close($fdf);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_open_string</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_open_string</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

61
reference/fdf/functions/fdf-save-string.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-save-string" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-save-string">
<refnamediv>
<refname>fdf_save_string</refname>
<refpurpose>Returns the FDF document as a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,10 +41,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving FDF as a string</title>
<programlisting role="php">
<example>
<title>Retrieving FDF as a string</title>
<programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_create();
@@ -56,9 +53,9 @@ fdf_close($fdf);
echo $str;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
%FDF-1.2
%âãÏÓ
@@ -79,25 +76,21 @@ trailer
>>
%%EOF
]]>
</screen>
</example>
</para>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_open_string</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_open_string</function></member>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

61
reference/fdf/functions/fdf-save.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-save" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-save">
<refnamediv>
<refname>fdf_save</refname>
<refpurpose>Save a FDF document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,29 +20,27 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
If provided, the resulting FDF will be written in this parameter.
Otherwise, this function will write the FDF to the default PHP output
stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
If provided, the resulting FDF will be written in this parameter.
Otherwise, this function will write the FDF to the default PHP output
stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,17 +52,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save_string</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_close</function></member>
<member><function>fdf_create</function></member>
<member><function>fdf_save_string</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

93
reference/fdf/functions/fdf-set-ap.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-ap" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-ap">
<refnamediv>
<refname>fdf_set_ap</refname>
<refpurpose>Set the appearance of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,57 +17,55 @@
<methodparam><type>int</type><parameter>page_number</parameter></methodparam>
</methodsynopsis>
<para>
Sets the appearance of a field (i.e. the value of the
Sets the appearance of a field (i.e. the value of the
<literal>/AP</literal> key).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_name</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>face</parameter></term>
<listitem>
<para>
The possible values <constant>FDFNormalAP</constant>,
<constant>FDFRolloverAP</constant> and
<constant>FDFDownAP</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>page_number</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_name</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>face</parameter></term>
<listitem>
<para>
The possible values <constant>FDFNormalAP</constant>,
<constant>FDFRolloverAP</constant> and
<constant>FDFDownAP</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>page_number</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -78,7 +76,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

57
reference/fdf/functions/fdf-set-encoding.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-encoding" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-encoding">
<refnamediv>
<refname>fdf_set_encoding</refname>
<refpurpose>Sets FDF character encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,33 +20,31 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding name. The following values are supported:
"<literal>Shift-JIS</literal>", "<literal>UHC</literal>",
"<literal>GBK</literal>" and "<literal>BigFive</literal>".
</para>
<para>
An empty string resets the encoding to the default
<literal>PDFDocEncoding/Unicode</literal> scheme.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding name. The following values are supported:
"<literal>Shift-JIS</literal>", "<literal>UHC</literal>",
"<literal>GBK</literal>" and "<literal>BigFive</literal>".
</para>
<para>
An empty string resets the encoding to the default
<literal>PDFDocEncoding/Unicode</literal> scheme.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -57,7 +55,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

89
reference/fdf/functions/fdf-set-file.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-file" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-file">
<refnamediv>
<refname>fdf_set_file</refname>
<refpurpose>Set PDF document to display FDF data in</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -16,43 +16,41 @@
</methodsynopsis>
<para>
Selects a different PDF document to display the form results in then the
form it originated from.
form it originated from.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
Should be given as an absolute URL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target_frame</parameter></term>
<listitem>
<para>
Use this parameter to specify the frame in which the document will be
displayed. You can also set the default value for this parameter using
<function>fdf_set_target_frame</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
Should be given as an absolute URL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target_frame</parameter></term>
<listitem>
<para>
Use this parameter to specify the frame in which the document will be
displayed. You can also set the default value for this parameter using
<function>fdf_set_target_frame</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -64,10 +62,9 @@
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Passing FDF data to a second form</title>
<programlisting role="php">
<example>
<title>Passing FDF data to a second form</title>
<programlisting role="php">
<![CDATA[
<?php
/* set content type for Adobe FDF */
@@ -89,23 +86,19 @@
fdf_close($fdf);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_get_file</function></member>
<member><function>fdf_set_target_frame</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_get_file</function></member>
<member><function>fdf_set_target_frame</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

81
reference/fdf/functions/fdf-set-flags.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-flags" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-flags">
<refnamediv>
<refname>fdf_set_flags</refname>
<refpurpose>Sets a flag of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,41 +22,39 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whichFlags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newFlags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whichFlags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newFlags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -68,15 +66,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_opt</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_opt</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

81
reference/fdf/functions/fdf-set-javascript-action.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-javascript-action" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-javascript-action">
<refnamediv>
<refname>fdf_set_javascript_action</refname>
<refpurpose>Sets an javascript action of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,41 +22,39 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trigger</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trigger</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -68,15 +66,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_submit_form_action</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_submit_form_action</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/fdf/functions/fdf-set-on-import-javascript.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.fdf-set-on-import-javascript' xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-on-import-javascript">
<refnamediv>
<refname>fdf_set_on_import_javascript</refname>
<refpurpose>Adds javascript code to be executed when Acrobat opens the FDF</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,16 +19,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_add_doc_javascript</function></member>
<member><function>fdf_set_javascript_action</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_add_doc_javascript</function></member>
<member><function>fdf_set_javascript_action</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

95
reference/fdf/functions/fdf-set-opt.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-opt" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-opt">
<refnamediv>
<refname>fdf_set_opt</refname>
<refpurpose>Sets an option of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -23,48 +23,46 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>element</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str1</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str2</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>element</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str1</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str2</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -76,15 +74,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_flags</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_flags</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

51
reference/fdf/functions/fdf-set-status.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-status" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-status">
<refnamediv>
<refname>fdf_set_status</refname>
<refpurpose>Set the value of the /STATUS key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,26 +22,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>status</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>status</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,15 +51,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_get_status</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_get_status</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

95
reference/fdf/functions/fdf-set-submit-form-action.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-submit-form-action" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-submit-form-action">
<refnamediv>
<refname>fdf_set_submit_form_action</refname>
<refpurpose>Sets a submit form action of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -23,48 +23,46 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trigger</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>trigger</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>script</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -76,15 +74,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_set_javascript_action</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_set_javascript_action</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

55
reference/fdf/functions/fdf-set-target-frame.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-target-frame" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-target-frame">
<refnamediv>
<refname>fdf_set_target_frame</refname>
<refpurpose>Set target frame for form display</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -14,34 +14,32 @@
<methodparam><type>string</type><parameter>frame_name</parameter></methodparam>
</methodsynopsis>
<para>
Sets the target frame to display a result PDF defined with
Sets the target frame to display a result PDF defined with
<function>fdf_save_file</function> in.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>frame_name</parameter></term>
<listitem>
<para>
The frame name, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>frame_name</parameter></term>
<listitem>
<para>
The frame name, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,15 +51,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_save_file</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_save_file</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

99
reference/fdf/functions/fdf-set-value.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-value" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-value">
<refnamediv>
<refname>fdf_set_value</refname>
<refpurpose>Set the value of a field</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,53 +22,51 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
This parameter will be stored as a string unless it is an array. In
this case all array elements will be stored as a value array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isName</parameter></term>
<listitem>
<note>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
In older versions of the FDF toolkit last parameter determined if the
field value was to be converted to a PDF Name (= 1) or set to a PDF
String (= 0).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fieldname</parameter></term>
<listitem>
<para>
Name of the FDF field, as a string.
The value is no longer used in the current toolkit version 5.0. For
compatibility reasons it is still supported as an optional parameter,
but ignored internally.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
This parameter will be stored as a string unless it is an array. In
this case all array elements will be stored as a value array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isName</parameter></term>
<listitem>
<note>
<para>
In older versions of the FDF toolkit last parameter determined if the
field value was to be converted to a PDF Name (= 1) or set to a PDF
String (= 0).
</para>
<para>
The value is no longer used in the current toolkit version 5.0. For
compatibility reasons it is still supported as an optional parameter,
but ignored internally.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -80,16 +78,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_get_value</function></member>
<member><function>fdf_remove_item</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_get_value</function></member>
<member><function>fdf_remove_item</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

57
reference/fdf/functions/fdf-set-version.xml
View File

@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-set-version" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-version">
<refnamediv>
<refname>fdf_set_version</refname>
<refpurpose>Sets version number for a FDF file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -24,29 +24,27 @@
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
The version number. For the current FDF toolkit 5.0, this may be
either <literal>1.2</literal>, <literal>1.3</literal> or
<literal>1.4</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
The version number. For the current FDF toolkit 5.0, this may be
either <literal>1.2</literal>, <literal>1.3</literal> or
<literal>1.4</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -58,15 +56,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fdf_get_version</function></member>
</simplelist>
</para>
<simplelist>
<member><function>fdf_get_version</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml