cvs: phpdoc /en/functions rtfm.xml

From: Date: Fri, 27 Apr 2001 08:52:38 +0000
Subject: cvs: phpdoc /en/functions rtfm.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969335153@lists.php.net to get a copy of this message
hholzgra Fri Apr 27 01:52:38 2001 EDT Modified files: /phpdoc/en/functions rtfm.xml Log: documentation for the optional 'topic' parameter Index: phpdoc/en/functions/rtfm.xml diff -u /dev/null phpdoc/en/functions/rtfm.xml:1.4 --- /dev/null Fri Apr 27 01:52:38 2001 +++ phpdoc/en/functions/rtfm.xml Fri Apr 27 01:52:38 2001 @@ -0,0 +1,60 @@ + <reference id="ref.rtfm"> + <title>RTFM functions</title> + <titleabbrev></titleabbrev> + + <partintro> + <para> + </para> + </partintro> + + <refentry id="function.rtfm"> + <refnamediv> + <refname>rtfm</refname> + <refpurpose>Point user to FAQ and Manual</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef> <function>rtfm</function></funcdef> + <paramdef>string + <parameter><optional>topic</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Just a simple but configurable pointer to the FAQ and Manual. + FAQ and Manual URLs are configurable via + <parameter>rtfm.faq_url</parameter> and + <parameter>rtfm.manual_url</parameter>, which default to + <ulink url="&url.php.faq;">&url.php.faq;</ulink> and + <ulink url="&url.php.manual;">&url.php.manual;</ulink>. + </para> + <para> + With the optional parameter the function will create a lookup + link for the given <parameter>topic</parameter>. This defaults + to <literal>http://php.net/</literal> with the topic appended + and may be configured via <parameter>rtfm.manref_url</parameter>. + </para> + </refsect1> + </refentry> + + </reference> + +<!-- 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 +sgml-parent-document:nil +sgml-default-dtd-file:"../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> +

« previous php.doc (#969335153) next »