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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 288721 $ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-add-pdflink" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_add_pdflink</refname>
<refpurpose>Adds link to a page in a second pdf document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ps_add_pdflink</methodname>
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
Places a hyperlink at the given position pointing to a second pdf document.
Clicking on the link will branch to the document at the given page. The
first page in a document has number 1.
</para>
<para>
The hyperlink's source position is a rectangle with its lower left corner at
(<parameter>llx</parameter>, <parameter>lly</parameter>) and its upper
right corner at (<parameter>urx</parameter>, <parameter>ury</parameter>).
The rectangle has by default a thin blue border.
</para>
&ps.note.visible;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
Resource identifier of the postscript file
as returned by <function>ps_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>llx</parameter></term>
<listitem>
<para>
The x-coordinate of the lower left corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lly</parameter></term>
<listitem>
<para>
The y-coordinate of the lower left corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>urx</parameter></term>
<listitem>
<para>
The x-coordinate of the upper right corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ury</parameter></term>
<listitem>
<para>
The y-coordinate of the upper right corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The name of the pdf document to be opened when clicking on
this link.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>page</parameter></term>
<listitem>
<para>
The page number of the destination pdf document
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem>
<para>
The parameter <parameter>dest</parameter> determines how the document
is being viewed. It can be <literal>fitpage</literal>,
<literal>fitwidth</literal>, <literal>fitheight</literal>, or
<literal>fitbbox</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ps_add_launchlink</function></member>
<member><function>ps_add_locallink</function></member>
<member><function>ps_add_weblink</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->
|
