mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
160 lines
4.6 KiB
XML
160 lines
4.6 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-add-note" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ps_add_note</refname>
|
|
<refpurpose>Adds note to current page</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ps_add_note</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>contents</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>title</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>icon</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>open</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Adds a note at a certain position on the page. Notes are like little
|
|
rectangular sheets with text on it, which can be placed anywhere on
|
|
a page. They
|
|
are shown either folded or unfolded. If unfolded, the specified icon
|
|
is used as a placeholder.
|
|
</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>contents</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The text of the note.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>title</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The title of the note as displayed in the header of the note.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>icon</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The icon shown if the note is folded. This parameter can be set
|
|
to <literal>comment</literal>, <literal>insert</literal>,
|
|
<literal>note</literal>, <literal>paragraph</literal>,
|
|
<literal>newparagraph</literal>, <literal>key</literal>, or
|
|
<literal>help</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>open</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>open</parameter> is unequal to zero the note will
|
|
be shown unfolded after opening the document with a pdf viewer.
|
|
</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_pdflink</function></member>
|
|
<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
|
|
-->
|
|
|