BUG#463 Strip first leading blank from preformatted text in output
[lhc/web/wiklou.git] / includes / Metadata.php
index f6ed8c2..4b1c6bc 100644 (file)
@@ -1,5 +1,6 @@
 <?php
-/* Metadata.php -- provides DublinCore and CreativeCommons metadata
+/**
+ * Metadata.php -- provides DublinCore and CreativeCommons metadata
  * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
  * 
  *  This program is free software; you can redistribute it and/or modify
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * @author Evan Prodromou <evan@wikitravel.org>
+ * @package MediaWiki
  */
 
-define("RDF_TYPE_PREFS", "application/rdf+xml,text/xml;q=0.7,application/xml;q=0.5,text/rdf;q=0.1");
+/**
+ *
+ */
+define('RDF_TYPE_PREFS', "application/rdf+xml,text/xml;q=0.7,application/xml;q=0.5,text/rdf;q=0.1");
 
 function wfDublinCoreRdf($article) {
        
@@ -60,7 +67,10 @@ function wfCreativeCommonsRdf($article) {
        ccEpilogue();
 }
 
-/* private */ function rdfSetup() {
+/**
+ * @private
+ */
+function rdfSetup() {
        global $wgOut, $wgRdfMimeType, $_SERVER;
        
        $rdftype = wfNegotiateType(wfAcceptToPrefs($_SERVER['HTTP_ACCEPT']), wfAcceptToPrefs(RDF_TYPE_PREFS));
@@ -76,7 +86,10 @@ function wfCreativeCommonsRdf($article) {
        }
 }
 
-/* private */ function dcPrologue($url) {
+/**
+ * @private
+ */
+function dcPrologue($url) {
        global $wgOutputEncoding;
        
        $url = htmlspecialchars( $url );
@@ -90,14 +103,20 @@ function wfCreativeCommonsRdf($article) {
 ";
 }
 
-/* private */ function dcEpilogue() {
+/**
+ * @private
+ */
+function dcEpilogue() {
        print "
   </rdf:Description>
 </rdf:RDF>
 ";
 }
 
-/* private */ function dcBasics($article) {
+/**
+ * @private
+ */
+function dcBasics($article) {
        global $wgLanguageCode, $wgSitename;
        
        dcElement('title', $article->mTitle->getText());
@@ -126,7 +145,10 @@ function wfCreativeCommonsRdf($article) {
        dcRights($article);
 }
 
-/* private */ function ccPrologue() {
+/**
+ * @private
+ */
+function ccPrologue() {
        global $wgOutputEncoding;
        
        echo "<" . "?xml version='1.0'  encoding='{$wgOutputEncoding}' ?" . ">
@@ -137,63 +159,90 @@ function wfCreativeCommonsRdf($article) {
 ";
 }  
 
-/* private */ function ccSubPrologue($type, $url) {
+/**
+ * @private
+ */
+function ccSubPrologue($type, $url) {
        $url = htmlspecialchars( $url );
        echo "  <cc:{$type} rdf:about=\"{$url}\">\n";
 }  
 
-/* private */ function ccSubEpilogue($type) {
+/**
+ * @private
+ */
+function ccSubEpilogue($type) {
        echo "  </cc:{$type}>\n";
 }  
 
-/* private */ function ccLicense($terms) {
+/**
+ * @private
+ */
+function ccLicense($terms) {
        
        foreach ($terms as $term) {
                switch ($term) {
                case 're':
-                       ccTerm('permits', "Reproduction"); break;
+                       ccTerm('permits', 'Reproduction'); break;
                case 'di':
-                       ccTerm('permits', "Distribution"); break;
+                       ccTerm('permits', 'Distribution'); break;
                case 'de':
-                       ccTerm('permits', "DerivativeWorks"); break;
+                       ccTerm('permits', 'DerivativeWorks'); break;
                case 'nc':
-                       ccTerm('prohibits', "CommercialUse"); break;
+                       ccTerm('prohibits', 'CommercialUse'); break;
                case 'no':
-                       ccTerm('requires', "Notice"); break;
+                       ccTerm('requires', 'Notice'); break;
                case 'by':
-                       ccTerm('requires', "Attribution"); break;
+                       ccTerm('requires', 'Attribution'); break;
                case 'sa':
-                       ccTerm('requires', "ShareAlike"); break;
+                       ccTerm('requires', 'ShareAlike'); break;
                case 'sc':
-                       ccTerm('requires', "SourceCode"); break;                
+                       ccTerm('requires', 'SourceCode'); break;                
                }
        }
 }
 
-/* private */ function ccTerm($term, $name) {
+/**
+ * @private
+ */
+function ccTerm($term, $name) {
        print "    <cc:{$term} rdf:resource=\"http://web.resource.org/cc/{$name}\" />\n";
 }
 
-/* private */ function ccEpilogue() {
+/**
+ * @private
+ */
+function ccEpilogue() {
        echo "</rdf:RDF>\n";
 }
 
-/* private */ function dcElement($name, $value) {
+/**
+ * @private
+ */
+function dcElement($name, $value) {
        $value = htmlspecialchars( $value );
        print "    <dc:{$name}>{$value}</dc:{$name}>\n";
 }
 
-/* private */ function dcDate($timestamp) {
-       return substr($timestamp, 0, 4) . "-" 
-               . substr($timestamp, 4, 2) . "-" 
+/**
+ * @private
+ */
+function dcDate($timestamp) {
+       return substr($timestamp, 0, 4) . '-'
+               . substr($timestamp, 4, 2) . '-'
                . substr($timestamp, 6, 2);
 }
 
-/* private */ function dcReallyFullUrl($title) {
+/**
+ * @private
+ */
+function dcReallyFullUrl($title) {
        return $title->getFullURL();
 }
 
-/* private */ function dcPageOrString($name, $page, $str) {
+/**
+ * @private
+ */
+function dcPageOrString($name, $page, $str) {
        $nt = Title::newFromText($page);
        
        if (!$nt || $nt->getArticleID() == 0) {
@@ -203,20 +252,29 @@ function wfCreativeCommonsRdf($article) {
        }
 }
 
-/* private */ function dcPage($name, $title) {
+/**
+ * @private
+ */
+function dcPage($name, $title) {
        dcUrl($name, dcReallyFullUrl($title));
 }
 
-/* private */ function dcUrl($name, $url) {
+/**
+ * @private
+ */
+function dcUrl($name, $url) {
        $url = htmlspecialchars( $url );
        print "    <dc:{$name} rdf:resource=\"{$url}\" />\n";
 }
 
-/* private */ function dcPerson($name, $id, $user_name="", $user_real_name="") {
+/**
+ * @private
+ */
+function dcPerson($name, $id, $user_name='', $user_real_name='') {
        global $wgLang;
 
        if ($id == 0) {
-               dcElement($name, wfMsg("anonymous"));
+               dcElement($name, wfMsg('anonymous'));
        } else if ( !empty($user_real_name) ) {
                dcElement($name, $user_real_name);
        } else {
@@ -224,14 +282,16 @@ function wfCreativeCommonsRdf($article) {
                if( empty( $user_name ) ) {
                        $user_name = User::whoIs($id);
                }
-               dcPageOrString($name, $wgLang->getNsText(NS_USER) . ":" . $user_name, wfMsg("siteuser", $user_name));
+               dcPageOrString($name, $wgLang->getNsText(NS_USER) . ':' . $user_name, wfMsg('siteuser', $user_name));
        }
 }
 
-/* Takes an arg, for future enhancement with different rights for
- different pages. */
-
-/* private */ function dcRights($article) {
+/**
+ * Takes an arg, for future enhancement with different rights for
+ * different pages.
+ * @private
+ */
+function dcRights($article) {
        
        global $wgRightsPage, $wgRightsUrl, $wgRightsText;
        
@@ -246,7 +306,10 @@ function wfCreativeCommonsRdf($article) {
        }
 }
 
-/* private */ function ccGetTerms($url) {
+/**
+ * @private
+ */
+function ccGetTerms($url) {
        global $wgLicenseTerms;
        
        if (isset($wgLicenseTerms)) {
@@ -257,7 +320,10 @@ function wfCreativeCommonsRdf($article) {
        }
 }
 
-/* private */ function getKnownLicenses() {
+/**
+ * @private
+ */
+function getKnownLicenses() {
        
        $ccLicenses = array('by', 'by-nd', 'by-nd-nc', 'by-nc', 
                             'by-nc-sa', 'by-sa');
@@ -283,11 +349,11 @@ function wfCreativeCommonsRdf($article) {
        
        /* Handle the GPL and LGPL, too. */
        
-       $knownLicenses["http://creativecommons.org/licenses/GPL/2.0/"] =
+       $knownLicenses['http://creativecommons.org/licenses/GPL/2.0/'] =
                array('de', 're', 'di', 'no', 'sa', 'sc');
-       $knownLicenses["http://creativecommons.org/licenses/LGPL/2.1/"] = 
+       $knownLicenses['http://creativecommons.org/licenses/LGPL/2.1/'] = 
                array('de', 're', 'di', 'no', 'sa', 'sc');
-       $knownLicenses["http://www.gnu.org/copyleft/fdl.html"] = 
+       $knownLicenses['http://www.gnu.org/copyleft/fdl.html'] = 
                array('de', 're', 'di', 'no', 'sa', 'sc');
        
        return $knownLicenses;