1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-28 01:12:20 +01:00
Files
archived-doc-es/reference/ps/functions/ps-add-note.xml
2014-09-05 20:55:10 +00:00

163 lines
4.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<!-- 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>Añadir una nota a la página actual</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>
Añade una nota en una cierta posición del página. Las notas son como pequeñas
hojas rectangulares con texto dentro que pueden ser colocadas en cualquer lugar de
una página.
Se muestran tanto plegadas como desplegadas. Si están desplegadas se utiliza el
icono especificado como marcador de posición.
</para>
&ps.note.visible;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
El identificador de recursos del fichero postscript,
como el devuelto por la función <function>ps_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>llx</parameter></term>
<listitem>
<para>
La coordenada x de la esquina inferior izquierda.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lly</parameter></term>
<listitem>
<para>
La coordenada y de la esquina inferior izquierda.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>urx</parameter></term>
<listitem>
<para>
La coordenada x de la esquina superior derecha.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ury</parameter></term>
<listitem>
<para>
La coordenada y de la esquina superior derecha.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
<para>
El texto de la nota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
El título de la nota a mostrar en la cabecera de la nota.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>icon</parameter></term>
<listitem>
<para>
El icono mostrado si la nota está plegada. Este parámetro puede ser establecido
a <literal>comment</literal>, <literal>insert</literal>,
<literal>note</literal>, <literal>paragraph</literal>,
<literal>newparagraph</literal>, <literal>key</literal>, o
<literal>help</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open</parameter></term>
<listitem>
<para>
Si <parameter>open</parameter> es distinto de cero, la nota se
mostrará desplegada después de abrir el documento con un visualizador de pdf.
</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
-->