Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions reference/ps/book.xml
Original file line number Diff line number Diff line change
@@ -1,37 +1,35 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Author: Uwe Steinmann <steinm@php.net> -->

<book xml:id="book.ps" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.ps">
<?phpdoc extension-membership="pecl" ?>
<title>PostScript document creation</title>
<titleabbrev>PS</titleabbrev>

<!-- {{{ preface -->
<preface xml:id="intro.ps">
&reftitle.intro;
<para>
<simpara>
This module allows to create PostScript documents. It has many
similarities with the pdf extension. Actually the API is almost
identical and one can in many cases just replace the prefix of
each function from pdf_ to ps_. This also works for functions which
has no meaning in the PostScript document (like adding hyperlinks)
but will have an effect if the document is converted to PDF.
</para>
<para>Documents created by this extension are sometimes even superior
</simpara>
<simpara>Documents created by this extension are sometimes even superior
to documents created with the pdf extension, because pslib's text
rendering functions can handle kerning, hyphenation and ligatures
which results in much better output of boxed text.
</para>
</simpara>
</preface>
<!-- }}} -->

&reference.ps.setup;
&reference.ps.constants;
&reference.ps.reference;

</book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -52,4 +50,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8 changes: 3 additions & 5 deletions reference/ps/configure.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="ps.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ps.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;ps">&url.pecl.package;ps</link>.
</para>
</simpara>
</section>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
100 changes: 47 additions & 53 deletions reference/ps/functions/ps-add-bookmark.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-add-bookmark" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ps-add-bookmark">
<refnamediv>
<refname>ps_add_bookmark</refname>
<refpurpose>Add bookmark to current page</refpurpose>
Expand All @@ -16,79 +16,74 @@
<methodparam choice="opt"><type>int</type><parameter>parent</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>open</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds a bookmark for the current page. Bookmarks usually appear in
PDF-Viewers left of the page in a hierarchical tree. Clicking on a
bookmark will jump to the given page.
</para>
</simpara>
&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>text</parameter></term>
<listitem>
<para>
The text used for displaying the bookmark.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent</parameter></term>
<listitem>
<para>
A bookmark previously created by this function which
is used as the parent of the new bookmark.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open</parameter></term>
<listitem>
<para>
If <parameter>open</parameter> is unequal to zero the bookmark will
be shown open by the pdf viewer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<simpara>
Resource identifier of the postscript file
as returned by <function>ps_new</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<simpara>
The text used for displaying the bookmark.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent</parameter></term>
<listitem>
<simpara>
A bookmark previously created by this function which
is used as the parent of the new bookmark.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open</parameter></term>
<listitem>
<simpara>
If <parameter>open</parameter> is unequal to zero the bookmark will
be shown open by the pdf viewer.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The returned value is a reference for the bookmark. It is only used if
the bookmark shall be used as a parent. The value is greater zero if
the function succeeds. In case of an error zero will
be returned.
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ps_add_launchlink</function></member>
<member><function>ps_add_pdflink</function></member>
<member><function>ps_add_weblink</function></member>
</simplelist>
</para>
<simplelist>
<member><function>ps_add_launchlink</function></member>
<member><function>ps_add_pdflink</function></member>
<member><function>ps_add_weblink</function></member>
</simplelist>
</refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -109,4 +104,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

128 changes: 61 additions & 67 deletions reference/ps/functions/ps-add-launchlink.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-add-launchlink" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ps-add-launchlink">
<refnamediv>
<refname>ps_add_launchlink</refname>
<refpurpose>Adds link which launches file</refpurpose>
Expand All @@ -18,92 +18,87 @@
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Places a hyperlink at the given position pointing to a file program
which is being started when clicked on. The hyperlink's source position
is a rectangle
with its lower left corner at (llx, lly) and its upper right corner at
(urx, ury). The rectangle has by default a thin blue border.
</para>
</simpara>
&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 path of the program to be started, when the link is clicked on.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<simpara>
Resource identifier of the postscript file
as returned by <function>ps_new</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>llx</parameter></term>
<listitem>
<simpara>
The x-coordinate of the lower left corner.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lly</parameter></term>
<listitem>
<simpara>
The y-coordinate of the lower left corner.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>urx</parameter></term>
<listitem>
<simpara>
The x-coordinate of the upper right corner.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ury</parameter></term>
<listitem>
<simpara>
The y-coordinate of the upper right corner.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<simpara>
The path of the program to be started, when the link is clicked on.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ps_add_locallink</function></member>
<member><function>ps_add_pdflink</function></member>
<member><function>ps_add_weblink</function></member>
</simplelist>
</para>
<simplelist>
<member><function>ps_add_locallink</function></member>
<member><function>ps_add_pdflink</function></member>
<member><function>ps_add_weblink</function></member>
</simplelist>
</refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -124,4 +119,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

Loading
Loading