File: fdf-add-doc-javascript.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (76 lines) | stat: -rw-r--r-- 2,011 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/fdf.xml, last change in rev 1.12 -->
<refentry id='function.fdf-add-doc-javascript'>
 <refnamediv>
  <refname>fdf_add_doc_javascript</refname>
  <refpurpose>Adds javascript code to the FDF document</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>bool</type><methodname>fdf_add_doc_javascript</methodname>
   <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>script_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>script_code</parameter></methodparam>
  </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. It is strongly
   suggested to use '\r' for linebreaks within <parameter>script_code</parameter>.
  </para>
  <para>
   <example>
    <title>Adding JavaScript code to a FDF</title>
    <programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_create();
fdf_add_doc_javascript($fdf, "PlusOne", "function PlusOne(x)\r{\r  return x+1;\r}\r");
fdf_save($fdf);
?>
]]>
    </programlisting>
    <simpara>will create a FDF like this:</simpara>
    <screen>
<![CDATA[
%FDF-1.2
%
1 0 obj
<< 
/FDF << /JavaScript << /Doc [ (PlusOne)(function PlusOne\(x\)\r{\r  return x+1;\r}\r)] >> >> 
>> 
endobj
trailer
<<
/Root 1 0 R 

>>
%%EOF
]]>
    </screen>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->