CVS update: phpdoc/functions

Date: Sunday June 27, 1999 @ 21:26 Author: jim Update of /repository/phpdoc/functions In directory php:/tmp/cvs-serv16579 Modified Files: fdf.sgml Log Message: Update link to FDF information. Various text cleanups. Index: phpdoc/functions/fdf.sgml diff -u phpdoc/functions/fdf.sgml:1.3 phpdoc/functions/fdf.sgml:1.4 --- phpdoc/functions/fdf.sgml:1.3 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/fdf.sgml Sun Jun 27 21:26:21 1999 @@ -5,27 +5,27 @@ <partintro> <simpara> - This is a first attempt to implement Forms Data Format - (FDF) support in PHP. You can read the documentation at <ulink - url="http://beta1.adobe.com/ada/acrosdk/forms.html">http://beta1.adobe.com/ada/acrosdk/forms.html</ulink> + Forms Data Format (FDF) is a format for handling + forms within PDF documents. You can read the documentation at <ulink + url="http://partners.adobe.com/asn/developer/acrosdk/main.html">http://partners.adobe.com/asn/developer/acrosdk/main.html</ulink> for more information on what FDF is and how it is used in general. </partintro> <refentry id="function.fdf-open"> <refnamediv> - <refname>FDF_open</refname> - <refpurpose>Opens a new fdf document</refpurpose> + <refname>fdf_open</refname> + <refpurpose>Open a new FDF document</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>pdf_open</function></funcdef> + <funcdef>int <function>fdf_open</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_open</function> function opens - a new fdf document. If the parameter <parameter>filename</parameter> + The <function>fdf_open</function> function opens + a new FDF document. If the parameter <parameter>filename</parameter> is '.' the file is read from stdin. <para> @@ -36,28 +36,28 @@ <refentry id="function.fdf-close"> <refnamediv> - <refname>FDF_close</refname> - <refpurpose>Closes the fdf document</refpurpose> + <refname>fdf_close</refname> + <refpurpose>Close an FDF document</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>void <function>pdf_close</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <funcdef>void <function>fdf_close</function></funcdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_close</function> function closes the fdf document. + The <function>fdf_close</function> function closes the FDF document. <para> - See also <function>FDF_open</function>. + See also <function>fdf_open</function>. </refsect1> </refentry> <refentry id="function.fdf-create"> <refnamediv> - <refname>FDF_create</refname> - <refpurpose></refpurpose> + <refname>fdf_create</refname> + <refpurpose>Create a new FDF document</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -66,30 +66,30 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_create</function> creates a new - fdf document. + The <function>fdf_create</function> creates a new + FDF document. <para> - See also <function>FDF_close</function>, - <function>FDF_save</function>, - <function>FDF_open</function>. + See also <function>fdf_close</function>, + <function>fdf_save</function>, + <function>fdf_open</function>. </refsect1> </refentry> <refentry id="function.fdf-save"> <refnamediv> - <refname>FDF_save</refname> - <refpurpose>Saves a fdf document</refpurpose> + <refname>fdf_save</refname> + <refpurpose>Save a FDF document</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>pdf_save</function></funcdef> + <funcdef>int <function>fdf_save</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_save</function> function saves - a fdf document. If the parameter <parameter>filename</parameter> + The <function>fdf_save</function> function saves + a FDF document. If the parameter <parameter>filename</parameter> is '.' the file is written to stdout. <para> @@ -100,96 +100,96 @@ <refentry id="function.fdf-get-value"> <refnamediv> - <refname>FDF_get_value</refname> - <refpurpose>Gets the value of a field</refpurpose> + <refname>fdf_get_value</refname> + <refpurpose>Get the value of a field</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>fdf_get_value</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> <paramdef>string <parameter>fieldname</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_get_value</function> function returns the + The <function>fdf_get_value</function> function returns the value of a field. <para> - See also <function>FDF_set_value</function>. + See also <function>fdf_set_value</function>. </refsect1> </refentry> <refentry id="function.fdf-set-value"> <refnamediv> - <refname>FDF_get_value</refname> - <refpurpose>Sets the value of a field</refpurpose> + <refname>fdf_get_value</refname> + <refpurpose>Set the value of a field</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>void <function>fdf_get_value</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> <paramdef>string <parameter>fieldname</parameter></paramdef> <paramdef>string <parameter>value</parameter></paramdef> <paramdef>int <parameter>isName</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_set_value</function> function sets the + The <function>fdf_set_value</function> function sets the value of a field. The last parameter determines if the field value is to be converted to a PDF Name (<parameter>isName</parameter> = 1) or set to a PDF String (<parameter>isName</parameter> = 0). <para> - See also <function>FDF_get_value</function>. + See also <function>fdf_get_value</function>. </refsect1> </refentry> <refentry id="function.fdf-next-field-name"> <refnamediv> - <refname>FDF_next_field_name</refname> - <refpurpose>Next field name</refpurpose> + <refname>fdf_next_field_name</refname> + <refpurpose>Get the next field name</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>fdf_next_field_name</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> <paramdef>string <parameter>fieldname</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_next_field_name</function> function returns the + The <function>fdf_next_field_name</function> function returns the name of the field string after the field in parameter <parameter>fieldname</parameter> or the field name of the first field if the second paramter is NULL. <para> - See also <function>FDF_set_field</function>, - <function>FDF_get_field</function>. + See also <function>fdf_set_field</function>, + <function>fdf_get_field</function>. </refsect1> </refentry> <refentry id="function.fdf-set-ap"> <refnamediv> - <refname>FDF_set_ap</refname> - <refpurpose>Sets the appearence of a field</refpurpose> + <refname>fdf_set_ap</refname> + <refpurpose>Set the appearance of a field</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>void <function>fdf_set_ap</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> - <paramdef>string <parameter>fieldname</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> + <paramdef>string <parameter>field_name</parameter></paramdef> <paramdef>int <parameter>face</parameter></paramdef> <paramdef>string <parameter>filename</parameter></paramdef> - <paramdef>int <parameter>pagenr</parameter></paramdef> + <paramdef>int <parameter>page_number</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_set_ap</function> function sets the + The <function>fdf_set_ap</function> function sets the appearance of a field (i.e. the value of the /AP key). - The possible values of the parameter <parameter>face</parameter> + The possible values of <parameter>face</parameter> are 1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP. </refsect1> @@ -197,86 +197,86 @@ <refentry id="function.fdf-set-status"> <refnamediv> - <refname>FDF_set_status</refname> - <refpurpose>Sets the value of the /STATUS key</refpurpose> + <refname>fdf_set_status</refname> + <refpurpose>Set the value of the /STATUS key</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>void <function>fdf_set_status</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> <paramdef>string <parameter>status</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_set_status</function> sets the value + The <function>fdf_set_status</function> sets the value of the /STATUS key. <para> - See also <function>FDF_get_status</function>. + See also <function>fdf_get_status</function>. </refsect1> </refentry> <refentry id="function.fdf-get-status"> <refnamediv> - <refname>FDF_get_status</refname> - <refpurpose>Gets the value of the /STATUS key</refpurpose> + <refname>fdf_get_status</refname> + <refpurpose>Get the value of the /STATUS key</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>fdf_get_status</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_get_status</function> returns the value + The <function>fdf_get_status</function> returns the value of the /STATUS key. <para> - See also <function>FDF_set_status</function>. + See also <function>fdf_set_status</function>. </refsect1> </refentry> <refentry id="function.fdf-set-file"> <refnamediv> - <refname>FDF_set_file</refname> - <refpurpose>Sets the value of the /F key</refpurpose> + <refname>fdf_set_file</refname> + <refpurpose>Set the value of the /F key</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>void <function>fdf_set_file</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_set_file</function> sets the value + The <function>fdf_set_file</function> sets the value of the /F key. <para> - See also <function>FDF_get_file</function>. + See also <function>fdf_get_file</function>. </refsect1> </refentry> <refentry id="function.fdf-get-file"> <refnamediv> - <refname>FDF_get_file</refname> - <refpurpose>Gets the value of the /F key</refpurpose> + <refname>fdf_get_file</refname> + <refpurpose>Get the value of the /F key</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>fdf_get_file</function></funcdef> - <paramdef>int <parameter>fdf document</parameter></paramdef> + <paramdef>int <parameter>fdf_document</parameter></paramdef> </funcsynopsis> <para> - The <function>FDF_set_file</function> returns the value + The <function>fdf_set_file</function> returns the value of the /F key. <para> - See also <function>FDF_set_file</function>. + See also <function>fdf_set_file</function>. </refsect1> </refentry>