cvs: phpdoc /en/reference/strings/functions nl2br.xml
| From: | Kalle Sommer Nielsen | Date: | Thu, 14 Aug 2008 03:06:25 +0000 |
| Subject: | cvs: phpdoc /en/reference/strings/functions nl2br.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-2026@lists.php.net to get a copy of this message | ||
kalle Thu Aug 14 03:06:25 2008 UTC
Modified files:
/phpdoc/en/reference/strings/functions nl2br.xml
Log:
Document is_xhtml parameter for nl2br()
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/strings/functions/nl2br.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/strings/functions/nl2br.xml
diff -u phpdoc/en/reference/strings/functions/nl2br.xml:1.7
phpdoc/en/reference/strings/functions/nl2br.xml:1.8
--- phpdoc/en/reference/strings/functions/nl2br.xml:1.7 Wed Jun 20 22:25:29 2007
+++ phpdoc/en/reference/strings/functions/nl2br.xml Thu Aug 14 03:06:25 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.nl2br">
<refnamediv>
<refname>nl2br</refname>
@@ -11,6 +11,7 @@
<methodsynopsis>
<type>string</type><methodname>nl2br</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
+
<methodparam><type>bool</type><parameter>is_xhtml</parameter></methodparam>
</methodsynopsis>
<para>
Returns <parameter>string</parameter> with '<br />' inserted
@@ -30,6 +31,14 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>is_xhtml</parameter></term>
+ <listitem>
+ <para>
+ Whenever to use XHTML compatible line breaks or not (defaults to &true;)
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
@@ -41,6 +50,29 @@
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>using <function>nl2br</function></title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+echo nl2br("foo isn't\n bar");
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+foo isn't<br />
+ bar
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<para>
@@ -54,6 +86,12 @@
</thead>
<tbody>
<row>
+ <entry>5.3.0</entry>
+ <entry>
+ Added the <parameter>is_xhtml</parameter> parameter.
+ </entry>
+ </row>
+ <row>
<entry>4.0.5</entry>
<entry>
<function>nl2br</function> is now XHTML compliant. All older versions
@@ -67,29 +105,6 @@
</para>
</refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>using <function>nl2br</function></title>
- <programlisting role="php">
-<![CDATA[
-<?php
-echo nl2br("foo isn't\n bar");
-?>
-]]>
- </programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-foo isn't<br />
- bar
-]]>
- </screen>
- </example>
- </para>
- </refsect1>
-
<refsect1 role="seealso">
&reftitle.seealso;
<para>