r112934 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r112933‎ | r112934 | r112935 >
Date:10:41, 3 March 2012
Author:van-de-bugger
Status:deferred
Tags:
Comment:
README updated.
Modified paths:
  • /trunk/extensions/HidePrefix/README (modified) (history)

Diff [purge]

Index: trunk/extensions/HidePrefix/README
@@ -1,22 +1,67 @@
22 <!-- README -->
33
4 -== Purpose ==
 4+== What? ==
55
6 -The `HidePrefix' extension hides prefix in links and page titles.
 6+The HidePrefix extension hides prefix in links and page titles.
77
8 -For example, wikitext `[[Help:How to]]' normally results in link `Help:How to'. If this extension is
9 -enabled, result will be just `How to' without `Help:' prefix.
 8+For example, wikitext `[[Help:FAQ]]' normally results in link `Help:FAQ'. If this extension is
 9+enabled, result will be just `FAQ' without the `Help:' prefix.
1010
11 -Links to pages with the same name but in different namespaces can be distinguished by tooltips.
 11+The same is about page titles. Page `FAQ' in `Help' namespace normally has `Help:FAQ' title. If this
 12+extension is enabled, visible page title will be just `FAQ' without the `Help:' prefix.
1213
13 -Again, article `How to' in `Help' namespece normally has `Help:How to' page title. If this extension
14 -is enabled, visible page title will be just `How to', without `Help:' prefix.
 14+== Why? ==
1515
16 -Pages with the same name in different namespaces can be distinguished by its namespace tab.
 16+I as a user do not care too much about namespace of the link target page. To me there is no big
 17+difference between `Help:FAQ' and `Manual:FAQ' (especially if one of them is a redirection to
 18+another). But both these prefixes looks ugly to me.
1719
 20+Namespace of target is often clear from context. If you see `Author: User:Van de Bugger' it is clear
 21+that `User:Van de Bugger' is a link to her/his personal page. Moreover, actually it does not matter
 22+whether that page is in `User' namespace or not. But again, the prefix looks very ugly, so many
 23+wikieditors use `[[User:Van de Bugger|Van de Bugger]]' to suppress the prefix.
 24+
 25+Prefixes look especially ugly if there is a long list of links with the same prefix. For example,
 26+look at the list of Extensions used on Wikimedia. More than 100 occurrences of prefix `Extension:'
 27+just clutter the screen and does not add any value. (BTW, did you notice that I had to use
 28+`[[:Category:Extensions used on Wikimedia|Extensions used on Wikimedia]]' to suppress ugly
 29+`Category:' prefix?)
 30+
 31+Thus, If I want to hide the ugly prefix so often, why should I hide it at every link manually? Let
 32+me write an extension which will hide the prefix in all the links. Everywhere.
 33+
 34+BTW, prefix is hidden in link text, but it is still available — if one hovers the mouse cursor over
 35+the link, tooltip will show full target page title, including prefix.
 36+
 37+Almost the same reasoning is applicable to page title. The prefix looks ugly and does not add any
 38+value to reader, because just above the page title (at least, in Vector skin) there are namespace
 39+tabs, and the leftmost tab shows the namespace name.
 40+
 41+== Download ==
 42+
 43+ svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/HidePrefix
 44+
 45+== Installation ==
 46+
 47+To install this extension, add the following to LocalSettings.php:
 48+
 49+ require_once( "$IP/extensions/HidePrefix/HidePrefix.php" );
 50+
1851 == License ==
1952
20 -GNU Affero General Public License, version 3 or any later version. See `AGPL-3.0.txt' file for the
 53+GNU Affero General Public License, version 3 or any later version. See AGPL-3.0.txt file for the
2154 full license text.
2255
 56+== See also ==
 57+
 58+* Extension HideNamespace — This extension allows drop prefix in page title and provides control
 59+ (e. g. hide prefix only in pages of specific namespace, or control prefix visibility from within
 60+ page content), but it does not affect links.
 61+
 62+== Links ==
 63+
 64+* Extension page: http://www.mediawiki.org/wiki/Extension:HidePrefix
 65+* Author page: http://www.mediawiki.org/wiki/User:Van_de_Bugger
 66+* License page: http://www.gnu.org/licenses/agpl.html
 67+
2368 <!-- end of file -->

Status & tagging log