php-doc-en/reference/ps/functions/ps-begin-page.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-begin-page" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_begin_page</refname>
  <refpurpose>Start a new page</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_begin_page</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>float</type><parameter>width</parameter></methodparam>
   <methodparam><type>float</type><parameter>height</parameter></methodparam>
  </methodsynopsis>
  <para>
   Starts a new page. Although the parameters <parameter>width</parameter>
   and <parameter>height</parameter> imply a different page size for each
   page, this is not possible in PostScript. The first call of
   <function>ps_begin_page</function> will set the page size for the whole
   document. Consecutive calls will have no effect, except for creating a new
   page. The situation is different if you intent to convert the PostScript
   document into PDF. This function places pdfmarks into the document which
   can set the size for each page indiviually. The resulting PDF document will
   have different page sizes.
  </para>
  <para>
   Though PostScript does not know different page sizes, pslib places
   a bounding box for each page into the document. This size is evaluated
   by some PostScript viewers and will have precedence over the BoundingBox
   in the Header of the document. This can lead to unexpected results when
   you set a BoundingBox whose lower left corner is not (0, 0), because the
   bounding box of the page will always have a lower left corner (0, 0)
   and overwrites the global setting.
  </para>
  <para>
   Each page is encapsulated into save/restore. This means, that most of the
   settings made on one page will not be retained on the next page.
  </para>
  <para>
   If there is up to the first call of <function>ps_begin_page</function> no
   call of <function>ps_findfont</function>, then the header of the PostScript
   document will be output and the bounding box will be set to the size of
   the first page. The lower left corner of the bounding box is set to (0, 0).
   If <function>ps_findfont</function> was called before, then the
   header has been output already, and the document will not have a valid
   bounding box. In order to prevent this, one should call
   <function>ps_set_info</function> to set the info field
   <literal>BoundingBox</literal> and possibly <literal>Orientation</literal>
   before any <function>ps_findfont</function> or
   <function>ps_begin_page</function> calls.
  </para>
  <note>
   <para>
    Up to version 0.2.6 of pslib, this function will always overwrite
    the BoundingBox and Orientation, if it has been set before with
    <function>ps_set_info</function> and <function>ps_findfont</function>
    has not been called before.
   </para>
  </note>
 </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>width</parameter></term>
     <listitem>
      <para>
       The width of the page in pixel, e.g. 596 for A4 format.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       The height of the page in pixel, e.g. 842 for A4 format.
      </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_end_page</function></member>
    <member><function>ps_findfont</function></member>
    <member><function>ps_set_info</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
-->