From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Mon, 1 Feb 2010 18:04:17 +0000 (+0000)
Subject: Fixes to OutputPage's documentation
X-Git-Tag: 1.31.0-rc.0~37989
X-Git-Url: http://git.cyclocoop.org/%40spipnet%40?a=commitdiff_plain;h=777a4482e64c356f98dafe506326426fe8ee35cb;p=lhc%2Fweb%2Fwiklou.git

Fixes to OutputPage's documentation
* action=raw -> action=render
* escape tags in setPageTitle()'s documentation so that it's displayed correctly (not treated as real tags)
---

diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index 0bc1bd702b..f883a2dd49 100644
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -257,7 +257,7 @@ class OutputPage {
 	/**
 	 * Set whether the output should only contain the body of the article,
 	 * without any skin, sidebar, etc.
-	 * Used e.g. when calling with "action=raw".
+	 * Used e.g. when calling with "action=render".
 	 *
 	 * @param $only Boolean: whether to output only the body of the article
 	 */
@@ -451,10 +451,10 @@ class OutputPage {
 	}
 
 	/**
-	 * "Page title" means the contents of <h1>. It is stored as a valid HTML fragment.
-	 * This function allows good tags like <sup> in the <h1> tag, but not bad tags like <script>.
-	 * This function automatically sets <title> to the same content as <h1> but with all tags removed.
-	 * Bad tags that were escaped in <h1> will still be escaped in <title>, and good tags like <i> will be dropped entirely.
+	 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
+	 * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
+	 * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
+	 * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
 	 */
 	public function setPageTitle( $name ) {
 		# change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"