mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
126 lines
4 KiB
XML
126 lines
4 KiB
XML
<?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-set-info" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ps_set_info</refname>
|
|
<refpurpose>Sets information fields of document</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ps_set_info</methodname>
|
|
<methodparam><type>resource</type><parameter>p</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>val</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets certain information fields of the document. This fields will be shown
|
|
as a comment in the header of the PostScript file. If the document is
|
|
converted to pdf this fields will also be used for the document
|
|
information.
|
|
</para>
|
|
<para>
|
|
The <literal>BoundingBox</literal> is usually set to the value given to the
|
|
first page. This only works if <function>ps_findfont</function> has not
|
|
been called before. In such cases the BoundingBox would be left unset
|
|
unless you set it explicitly with this function.
|
|
</para>
|
|
<para>
|
|
This function will have no effect anymore when the header of the postscript
|
|
file has been already written. It must be called before the first page
|
|
or the first call of <function>ps_findfont</function>.
|
|
</para>
|
|
</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>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the information field to set. The values which can be
|
|
set are <literal>Keywords</literal>, <literal>Subject</literal>,
|
|
<literal>Title</literal>, <literal>Creator</literal>,
|
|
<literal>Author</literal>, <literal>BoundingBox</literal>, and
|
|
<literal>Orientation</literal>. Be aware that some of them has a
|
|
meaning to PostScript viewers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value of the information field. The field
|
|
<literal>Orientation</literal> can be set to either
|
|
<literal>Portrait</literal> or <literal>Landscape</literal>. The
|
|
<literal>BoundingBox</literal> is a string consisting of four numbers.
|
|
The first two numbers are the coordinates of the lower left corner of
|
|
the page. The last two numbers are the coordinates of the upper
|
|
right corner.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Up to version 0.2.6 of pslib, the BoundingBox and Orientation
|
|
will be overwritten by <function>ps_begin_page</function>,
|
|
unless <function>ps_findfont</function> has been called before.
|
|
</para>
|
|
</note>
|
|
</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_findfont</function></member>
|
|
<member><function>ps_begin_page</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
|
|
-->
|
|
|