MediaWiki/extensions: Difference between revisions

    From Consumerium development wiki R&D Wiki
    (List of possible extension types borrowed from http://www.mediawiki.org/wiki/Template:Extension#type under that clauses of GFDL)
    (changing link to use mw:Extension:Goes_here to utilize the new interwiki symbol "mw" which links to mediawiki.org)
    Line 1: Line 1:
    = Types of extensions =
    = Implementation types of extensions =
     
    implementation type


    The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.
    The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.
    Line 37: Line 35:


    Extensions currently installed on this [[development wiki]]. Also applicable to the implementation wiki.
    Extensions currently installed on this [[development wiki]]. Also applicable to the implementation wiki.
    * <tt>[http://www.mediawiki.org/wiki/Extension:SpamBlacklist Extension:SpamBlacklist]</tt> - [[regex]]es against spammers - installed and working.
    * <tt>[[mw:Extension:SpamBlacklist Extension:SpamBlacklist]]</tt> - [[regex]]es against spammers - installed and working.
    * <tt>[http://www.mediawiki.org/wiki/Extension:ConfirmEdit Extension:ConfirmEdit]</tt> - installed and working.
    * <tt>[[mw:Extension:ConfirmEdit Extension:ConfirmEdit]]</tt> - installed and working.


    Listing extensions that could be useful for the [[implementation wiki]]
    Listing extensions that could be useful for the [[implementation wiki]]
    Line 45: Line 43:


    == A ==
    == A ==
    * http://www.mediawiki.org/wiki/Extension:AJAX_Poll - enables embedding AJAX based polls
    * [[mw:Extension:AJAX_Poll]] - enables embedding AJAX based polls
    * http://www.mediawiki.org/wiki/Extension:AccessPostgres - Enables reading and writing values from/to a postgres database to/from articles
    * [[mw:Extension:AccessPostgres]] - Enables reading and writing values from/to a postgres database to/from articles
    * http://www.mediawiki.org/wiki/Extension:AmMap - Allows embedding interactive AmMap flash maps
    * [[mw:Extension:AmMap]] - Allows embedding interactive AmMap flash maps
    * http://www.mediawiki.org/wiki/Extension:Approved_Revs - an extension that lets administrators mark a certain revision of a page as "approved".
    * [[mw:Extension:Approved_Revs]] - an extension that lets administrators mark a certain revision of a page as "approved".
    * http://www.mediawiki.org/wiki/Extension:Arrays - Allows parser functions that manipulate arrays
    * [[mw:Extension:Arrays]] - Allows parser functions that manipulate arrays


    === ArticleFeedback - ( stars of maximum stars ) for reviews ===
    === ArticleFeedback - ( stars of maximum stars ) for reviews ===
    * http://www.mediawiki.org/wiki/Extension:ArticleFeedback - allows users to rate articles. '''This could potentially be used for [[reviews]] and/or [[voting]]'''
    * [[mw:Extension:ArticleFeedback]] - allows users to rate articles. '''This could potentially be used for [[reviews]] and/or [[voting]]'''


    === ArticleFeedbackv5 - could be used to collect feedback to a company ===
    === ArticleFeedbackv5 - could be used to collect feedback to a company ===


    * http://www.mediawiki.org/wiki/Extension:ArticleFeedbackv5 - for collecting user feedback about articles '''This could potentially be used to collect the [[feedback]] which then needs to be delivered to the [[business]]es.'''
    * [[mw:Extension:ArticleFeedbackv5]] - for collecting user feedback about articles '''This could potentially be used to collect the [[feedback]] which then needs to be delivered to the [[business]]es.'''


    * http://www.mediawiki.org/wiki/Extension:ArticleToCategory2 - Adds a textbox to category-pages to streamline adding pages to categories
    * [[mw:Extension:ArticleToCategory2]] - Adds a textbox to category-pages to streamline adding pages to categories


    * http://www.mediawiki.org/wiki/Extension:AuthorProtect - Allows the author of an article to protect it against editing by others. Could be useful for [[voting]] pages.he  
    * [[mw:Extension:AuthorProtect]] - Allows the author of an article to protect it against editing by others. Could be useful for [[voting]] pages.he  


    * http://www.mediawiki.org/wiki/Extension:AutoCategoryInclude - Checks for categories and includes templates ( without messy wikitext ) into pages based on the categories. '''Could be very useful for constructing infoboxen on company / product pages.'''
    * [[mw:Extension:AutoCategoryInclude]] - Checks for categories and includes templates ( without messy wikitext ) into pages based on the categories. '''Could be very useful for constructing infoboxen on company / product pages.'''


    * http://www.mediawiki.org/wiki/Extension:AutoLanguage - Displays a page in the language specified in a user preference. Looks very old and maybe not up-to-date but '''the source should be interesting reading for anyone looking to implement many languages in one wiki.'''
    * [[mw:Extension:AutoLanguage]] - Displays a page in the language specified in a user preference. Looks very old and maybe not up-to-date but '''the source should be interesting reading for anyone looking to implement many languages in one wiki.'''


    == B ==  
    == B ==  
    === BADI Pages Created Links ( automatically color outgoing links with colors for "exists" and "doesn't exist ===
    === BADI Pages Created Links ( automatically color outgoing links with colors for "exists" and "doesn't exist ===
    * http://www.mediawiki.org/wiki/Extension:BADI_Pages_Created_Links - Allows display of links in toolbox to other wiki or wiki-like sites whereby '''links will be colored differently depending on whether the page there has been created yet or not'''. Status determined by response code or Last-Modified HTTP HEAD requests.
    * [[mw:Extension:BADI_Pages_Created_Links]] - Allows display of links in toolbox to other wiki or wiki-like sites whereby '''links will be colored differently depending on whether the page there has been created yet or not'''. Status determined by response code or Last-Modified HTTP HEAD requests.


    === Back Links Functions ( constructing the voting machinery probably can use at least functions from this===
    === Back Links Functions ( constructing the voting machinery probably can use at least functions from this===
    * http://www.mediawiki.org/wiki/Extension:BackLinksFunctions - This does what it's name says. The code is ancient, but will be '''essential reading to anyone developing a voting system where votes are kept in wiki pages'''
    * [[mw:Extension:BackLinksFunctions]] - This does what it's name says. The code is ancient, but will be '''essential reading to anyone developing a voting system where votes are kept in wiki pages'''


    === BrokenLinks ===
    === BrokenLinks ===
    * http://www.mediawiki.org/wiki/Extension:BrokenLinks
    * [[mw:Extension:BrokenLinks]]


    They on BrokenLinks:
    They on BrokenLinks:
    Line 82: Line 80:
    ::Obviously very useful for housekeeping the links to businesses.
    ::Obviously very useful for housekeeping the links to businesses.


    * http://www.mediawiki.org/wiki/Extension:BucketVoting - The bucket voting extension to mediawiki allows people to distribute a number of votes between a number of options, so they can vote based on how important things are to them. This is known as [[w:cumulative voting]].
    * [[mw:Extension:BucketVoting]] - The bucket voting extension to mediawiki allows people to distribute a number of votes between a number of options, so they can vote based on how important things are to them. This is known as [[w:cumulative voting]].


    == C ==
    == C ==
    Line 88: Line 86:
    === Common Locale Data Repository ===
    === Common Locale Data Repository ===


    * http://www.mediawiki.org/wiki/Extension:CLDR - The CLDR extension contains local language names for different languages, countries, and currencies extracted from [[w:Common Locale Data Repository]] data.
    * [[mw:Extension:CLDR]] - The CLDR extension contains local language names for different languages, countries, and currencies extracted from [[w:Common Locale Data Repository]] data.


    Useable to fetch proper localized string for [[countries]], [[areas]], [[languages]] and currencies
    Useable to fetch proper localized string for [[countries]], [[areas]], [[languages]] and currencies


    === Call - ablility to pass variables to pages ===
    === Call - ablility to pass variables to pages ===
    * http://www.mediawiki.org/wiki/Extension:Call - ability to pass variables to templates to generate dynamic wiki pages
    * [[mw:Extension:Call]] - ability to pass variables to templates to generate dynamic wiki pages


    === CategoryCloud and CategoryTagCloud - 2 competing [[w:tag cloud]] implementations ) ===
    === CategoryCloud and CategoryTagCloud - 2 competing [[w:tag cloud]] implementations ) ===
    * http://www.mediawiki.org/wiki/Extension:CategoryCloud - Create a [[w:tag cloud]] from category data
    * [[mw:Extension:CategoryCloud]] - Create a [[w:tag cloud]] from category data
    * http://www.mediawiki.org/wiki/Extension:CategoryTagCloud - Creates topic clouds from category data
    * [[mw:Extension:CategoryTagCloud]] - Creates topic clouds from category data




    === CategoryIndex - Using keys ( external to articles ) to make category associations ( [[Parser function]] ) ===
    === CategoryIndex - Using keys ( external to articles ) to make category associations ( [[Parser function]] ) ===
    * http://www.mediawiki.org/wiki/Extension:CategoryIndex
    * [[mw:Extension:CategoryIndex]]


    They on CategoryIndex:
    They on CategoryIndex:
    Line 111: Line 109:


    === CategoryIntersection - where are the other set operations ? ===
    === CategoryIntersection - where are the other set operations ? ===
    * http://www.mediawiki.org/wiki/Extension:CategoryIntersection - Maintains a table with hash values for category intersections within a page to allow searching category intersections
    * [[mw:Extension:CategoryIntersection]] - Maintains a table with hash values for category intersections within a page to allow searching category intersections


    === CategoryOnUpload ===
    === CategoryOnUpload ===
    * http://www.mediawiki.org/wiki/Extension:CategoryOnUpload -  
    * [[mw:Extension:CategoryOnUpload]] -  


    They on Extension:CategoryOnUpload:
    They on Extension:CategoryOnUpload:
    Line 125: Line 123:
    === Create_Page ([[parser function]], [[user interface]] )===
    === Create_Page ([[parser function]], [[user interface]] )===


    [http://www.mediawiki.org/wiki/Extension:Create_Page Extension:Create_Page]
    [[[mw:Extension:Create_Page]]


    They on Create_Page:
    They on Create_Page:
    Line 136: Line 134:


    === NewArticleTemplates ===
    === NewArticleTemplates ===
    * http://www.mediawiki.org/wiki/Extension:NewArticleTemplates  
    * [[mw:Extension:NewArticleTemplates]]


    They on NewArticleTemplates:
    They on NewArticleTemplates:

    Revision as of 15:45, 10 May 2012

    Implementation types of extensions

    The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.

    • mw:parser - catchall for uncategorized parser extensions. If you have written a parser extension, please use one of the following more specific types:
      • mw:link - customized link markup, e.g. mw:...
      • mw:parser function - custom parameterized template markup, e.g. {{#name: ... }}
      • mw:tag - custom XML tag markup, e.g. <tagname>...</tagname>
      • mw:variable - custom unparameterized template markup, e.g. {{NAME}}
      • mw:extended syntax - Extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables).
    • mw:access - catchall for user access extensions, that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:
      • mw:user activity - extensions that monitor user activity (logins, logouts, new user creation, etc.)
      • mw:user identity - extensions that create and delete users, and/or verify the identity of a user
      • mw:user rights - extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use the rights parameter)
    • interface - catchall for uncategorized user interface extensions.
      • mw:media - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers.
      • mw:mywiki - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
      • mw:notify - extensions that email users, broadcast messages and provide other forms of community notification
      • mw:page action - extensions that enhance or modify page actions. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (use user rights) or logs (use user activity).
      • mw:search - extensions that search through and select articles for users.
      • mw:skin - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
      • mw:ajax - extensions that use Ajax programming techniques.
      • mw:special - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Manual:Special pages for more information.
    • mw:other
      • mw:api - extensions that add a new API module or extend a core API module.
      • mw:hook - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension


    Current

    Extensions currently installed on this development wiki. Also applicable to the implementation wiki.

    Listing extensions that could be useful for the implementation wiki

    Planned

    A

    ArticleFeedback - ( stars of maximum stars ) for reviews

    ArticleFeedbackv5 - could be used to collect feedback to a company

    • mw:Extension:AutoCategoryInclude - Checks for categories and includes templates ( without messy wikitext ) into pages based on the categories. Could be very useful for constructing infoboxen on company / product pages.
    • mw:Extension:AutoLanguage - Displays a page in the language specified in a user preference. Looks very old and maybe not up-to-date but the source should be interesting reading for anyone looking to implement many languages in one wiki.

    B

    BADI Pages Created Links ( automatically color outgoing links with colors for "exists" and "doesn't exist

    • mw:Extension:BADI_Pages_Created_Links - Allows display of links in toolbox to other wiki or wiki-like sites whereby links will be colored differently depending on whether the page there has been created yet or not. Status determined by response code or Last-Modified HTTP HEAD requests.

    Back Links Functions ( constructing the voting machinery probably can use at least functions from this

    • mw:Extension:BackLinksFunctions - This does what it's name says. The code is ancient, but will be essential reading to anyone developing a voting system where votes are kept in wiki pages

    BrokenLinks

    They on BrokenLinks:

    Special Page which checks all links in table _externallinks and reports on those that return an HTTP response 4xx or 5xx

    Us on BrokenLinks:

    Obviously very useful for housekeeping the links to businesses.
    • mw:Extension:BucketVoting - The bucket voting extension to mediawiki allows people to distribute a number of votes between a number of options, so they can vote based on how important things are to them. This is known as w:cumulative voting.

    C

    Common Locale Data Repository

    Useable to fetch proper localized string for countries, areas, languages and currencies

    Call - ablility to pass variables to pages

    • mw:Extension:Call - ability to pass variables to templates to generate dynamic wiki pages

    CategoryCloud and CategoryTagCloud - 2 competing w:tag cloud implementations )


    CategoryIndex - Using keys ( external to articles ) to make category associations ( Parser function )

    They on CategoryIndex:

    This extensions allows you to create categories of pages where the page is added with key value, which can be displayed on the lists of parties or categories used to select subset of pages from category.

    Us on CategoryIndex:

    Perhaps this could be utilized to enter datas for many pages in single pages and also propagated to all languages

    CategoryIntersection - where are the other set operations ?

    CategoryOnUpload

    They on Extension:CategoryOnUpload:

    Dropdown menu when uploading images to add the image to a category

    Us on Extension:CategoryOnUpload:

    Makes it easier and faster to categorize a file you are uploading to the file upload wiki.

    Create_Page (parser function, user interface )

    [[[mw:Extension:Create_Page]]

    They on Create_Page:

    ...

    Us on Create_Page:

    Trivial. Adds a textbox where you can enter the name of the new article. Maybe if chained with #NewArticleTemplates it might provide some ease of use to the end-consumer

    N

    NewArticleTemplates

    They on NewArticleTemplates:

    ...

    Us on NewArticleTemplates:

    Obviously does what it says. Enables per-namespace pre-loadable ( into the edit box ) texts for new articles i.e. we can have a skeleton for creating a new product, brand, company, area, country and NGO etc. no need to copy-paste. Whether the template given for an article can be given if not all things are split into separate namespaces is possible is not know.



    List of possible extension types borrowed from http://www.mediawiki.org/wiki/Template:Extension#type under that clauses of GFDL