Bureaucrats, confirmed, Administrators
4,558
edits
Changes
restore three rows that were accidentally removed
{| class="wikitable sortable"
!#
!Extension
!What does it do? (explain functionality by role: regular-user, talk-editor, client-admin, or sysop)
!Example / Notes / Alternatives?
|-
|1
|[[mw:Extension:CirrusSearch|CirrusSearch]]
|Extends the core search for MediaWiki to be able to use [[Elasticsearch]]. Elasticsearch provides a much better search capability to all users of the wiki. In particular, it allows DCS to index documents (file uploads).
|CirrusSearch (Elasticsearch) is vital to the ability to index uploaded files
|-
|2
|[[mw:Extension:Elastica|Elastica]]
|Base Elasticsearch functionality by providing the Elastica library; required by CirrusSearch.
|Required as part of Search
|-
|3
|[[mw:Extension:Nuke|Nuke]]
|The Nuke extension makes it possible for sysops to [https://demo.qualitybox.us/wiki/Special:Nuke mass delete pages].
|Yes
|For whatever reason, the DCSNuke extension intercepts page requests for the Nuke special page. DCSNuke has no added functionality. The DCSNuke code is roughly equivalent to the REL1_20 release of Nuke; and the current Nuke extension offers more functionality. I thought that potentially the reason to use a cloned extension was to totally customize the interface language strings, but that's not the case<ref>meld <(curl https://raw.githubusercontent.com/debtcompliance/mediawiki/master/extensions/DcsNuke/i18n/en.json?token=AACV4LWLt32dJzNg2zqcDRP_QZ6ecfOvks5bDx4MwA%3D%3D) <(curl https://raw.githubusercontent.com/wikimedia/mediawiki-extensions-Nuke/master/i18n/en.json)</ref>. Remove DCSNuke.
'''DcsNuke is not just a clone, as described in the Github wiki Extensions page: it adds a new field for supplying a title pattern to select the deletion candidates by. Other criteria could be added later such as restricting to category.'''
The custom DcsNuke extension does not provide features different from the regular Nuke extension. The regular Nuke extension shall be included for DCS.
|-
|4
|[[mw:Extension:ParserFunctions|ParserFunctions]]
|Enhances the wikitext parser with helpful functions, mostly related to logic and string-handling.
|At the bottom of the Special:Version page, you'll see a list of "Parser Function Hooks" that includes the following custom parser functions defined by DCS extensions: '''amendments''', '''companycomments''', '''compliancechecklist''', '''loans''', '''loansinuse''', '''section'''. Many of the others are provided by the Parser Functions extension: if, ifeq, switch, ifexist, ifexpr, iferror, time, timel, expr, rel2abs, titleparts, len, pos, rpos, sub, count, replace, explode
|-
|5
|[[mw:Extension:Pipe_Escape|PipeEscape]]
|The Pipe Escape extension allows for pipe characters in parser function arguments (and template argument calls) avoid being interpreted as an argument delimiter. This is primarily for the purpose of using wiki tables (or parts thereof) inside parser function calls or templates.
|Included via DcsSetup
|-
|6
|[[mw:Extension:SimpleMathJax|SimpleMathJax]]
|The SimpleMathJax extension enables MathJax, a Javascript library, for typesetting TeX formula in MediaWiki inside math environments. This extension will load resources from cdnjs.cloudflare.com on all wiki pages that have math or chem tags.
|included by DcsSetup.php
|-
|7
|[[mw:Extension:WikiEditor|WikiEditor]]
|The WikiEditor extension provides an improved interface for editing wikitext. It is the wikitext editing interface that Wikipedia started using in 2010 for desktop users, and so it is sometimes called the "2010 wikitext editor".
|
|-
|8
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsamendments DcsAmmendments]
|Adds ammendments section to DCS loan pages. Sysop (only) can add/delete/edit/re-order (up/down) the ammendments; UX [https://github.com/debtcompliance/mediawiki/blob/master/extensions/DcsAmmendments/modules/dcsammendments.js implemented in JavaScript]. Extends the API with the same functions. Adds new log type: amendments; and logs all actions.
|https://clienttest.dm.dcstemporary.com/ARCA14:1.5_Time_References
|-
|9
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsbaskets DcsBaskets]
|This extension allows the utilization column of the Baskets tables to be edited directly using AJAX and saving values into 'basket' tables rather than in the traditional wiki-text revision tables.
|no
|"Baskets" can be found in the hierarchy list of the leftnav under the 'Compliance' folder. The page name, by convention, is 'Baskets' e.g. https://clienttest.dm.dcstemporary.com/Baskets This is really neat, and very advanced. However, now that Visual Editor is available, I'd suspect that the user experience of editing large tables in Visual Editor would be much better. '''Replace Baskets with Visual Editor'''
'''We've tested the Visual Editor and found it to be to "clunky" for practical use, that was a year or so back, but based on my own experience I think it would still be considered that way if it was tested again now'''
|-
|10
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcscommon DcsCommon]
|Cookie handling was [https://github.com/debtcompliance/mediawiki/commit/41b4c2a9af447c25143da7e39d959dae3affd0c8#diff-dfec3a4f5a263c72b06f5ceafcac3408 added on June 14, 2017]. The code (the cookie.js part) is from a project called [https://github.com/js-cookie/js-cookie/blob/master/src/js.cookie.js js-cookie]. So, we could update that code. Or, we could replace it with internal functions so we don't rely on 3rd party code. See the API documentation for [https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.cookie mw.cookie] (Does '''not''' use the $wgCookieSecure configuration variable since 'detect' could not work with
The 'common' extension creates a singleton instance of the DcsCommon class that does a bunch of things according to [https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcscommon notes in the wiki]. The permissions shouldn't really be hidden away in the class code. They should simply be in LocalSettings.php. onUserGetRights() is a big function. The 'self:cache' is mostly called in connection with 'isLocal'. Any true caching should just be offloaded to APC and memcache. Although there is no 'dcs' table in the database on dcsTemporary, the [https://github.com/debtcompliance/mediawiki/blob/master/extensions/DcsCommon/DcsCommon.php#L653 setData()] method is used throughout the codebase so should update [https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcscommon wiki] about where this data is stored.
'''set/getData is for storing arbitrary DCS data in the dcs db table. Agreed that this extension needs cleaning up.'''
|recent
|no
|pervasive
|-
|11
|[https://github.com/debtcompliance/mediawiki/wiki/Compliance-Checklist DcsComplianceChecklist]
|Provides a dropdown list of loans and responsibility terms by which the table can be filtered on the Checklist page (by convention). The parser function creates the page contents and form controls.
|e.g. https://clienttest.dm.dcstemporary.com/Checklist
|-
|12
|DcsComplianceChecklist2
|purpose?
|no
|no
|only used in the '''checktest''' subdomain, or when `wgLocalTesting`; intention is to use a timestamp condition. '''This is in progress, the requirements of the checklist are simpler now and version 2 is just about stripping out a bunch of obsolete functionality.'''
|-
|13
|[https://github.com/debtcompliance/mediawiki/tree/master/extensions/DcsEmailLink DcsEmailLink]
|Allows you to send a link to a page in the wiki. Activated by the "Email Link" item in the primary navigation across the top of the page. Similar to the "Email Page" extension by Aran, which is also used.
|visit any page
|-
|14
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsexportterms DcsExportTerms]
|Allows terms to be downloaded in Comma Separated Value (CSV) format. CSV is easily imported to a spreadsheet.
|Visit https://clienttest.dm.dcstemporary.com/Category:Terms and you will see a "Export Terms" action in the primary navigation across the top of the page.
|-
|15
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsfindtitle DcsFindTitle]
|helps to find a title regardless of case-sensitivity of the system.
|no
|integrates with the API, however I'm unsure where it's visible/usable to the user. I believe it's used from the Ruby side to create links that will match a wiki page even if there is a case mismatch. If you wish to navigate to https://clienttest.dm.dcstemporary.com/ARCA14:TOC but request https://clienttest.dm.dcstemporary.com/arca14:toc instead, you'll get a 404 Not Found error. If you request https://clienttest.dm.dcstemporary.com/arca14:toc?action=findtitle then you will be redirected to the proper article.
'''This uses ApiBeforeMain and APIAfterExecute hooks to modify the API query prop=info to make it case-insensitive.'''
|-
|16
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsgroupadmin DcsGroupAdmin]
|Leverages the DcsBlockPageAccess hook to allow/disallow access to files and namespaces.
|https://clienttest.dm.dcstemporary.com/Special:DcsGroupAdmin/equality
|-
|17
|[https://github.com/debtcompliance/mediawiki/tree/master/extensions/DcsJobAdmin DcsJobAdmin]
|See [https://github.com/debtcompliance/mediawiki/wiki/Background-jobs Background info on Background jobs]. Creates a Special Page [https://clienttest.dm.dcstemporary.com/Special:DcsJobAdmin Special:DcsJobAdmin] where you can start a new job; or view current and historical jobs. Each job type loads it's own form into the Admin page. The job runner extends the Maintenance class, and loops over running jobs to provide some progress reporting. It saves the most recent 10 jobs to a 'history' list.
According to [https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsjobadmin the documentation], it allows you to manage jobs. But, I'm wondering how much this is actually used? The job queue should be run automatically by cron, and the administrative user shouldn't have to worry about it really. If there is a usage pattern where job execution is time sensitive, there is a use for an Admin function; but I'm curious about the usage patterns that create large or numerous jobs. Otherwise, set wgJobRunRate to zero, and put it into cron `0 0 * * * root /usr/bin/php /var/www/example.com/www/w/maintenance/runJobs.php > /var/log/runJobs.log 2>&1`
'''These jobs aren't just the standard MW maintenance jobs, they're DCS-specific jobs that need to run in the background as they often need to do intensive manipulation of thousands of articles. The special page is the interface to these jobs allowing parameters to be set for them and stopping/starting/cancelling/pausing them etc, as well as getting feedback on their progress or errors etc.'''
|2018-05-25
|no
|
|-
|18
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsloanpages DcsLoanPages]
|creates "backlinks" which are links to content that contain a particular keyword or phrase found in a loan document. It also creates the <nowiki>"< Prev" and "Next >"</nowiki> navigation links (called 'breadcrumbs' in the code, but actually these are 'pager' links not breadcrumbs).
|no
|If you go to a page like https://clienttest.dm.dcstemporary.com/ARCA14:Agreement You will see a large section of content called '''Index to ARCA14 pages containing "Agreement""'' So, in other words, it's a list of links to pages of the ARCA14 loan that have the word "Agreement" in them. These links are created by the extension.
'''They wanted the backlinks at the bottom of the page not in a separate special page'''
|-
|19
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsnamespaces DcsNamespaces]
|Manages the segregation of loan documents into their own separate namespaces. Also provides some functionality around moving/deleting/renaming namespaces via the https://clienttest.dm.dcstemporary.com/Special:DcsNamespaces special page.
|e.g. https://clienttest.dm.dcstemporary.com/Special:DcsNamespaces
|-
|20
|DcsNuke
|purpose?
|no
|REPLACE with [[mw:Extension:Nuke|standard Nuke extension]]
'''See notes in Nuke above, this is not a replica of Nuke'''
|-
|21
|DcsSearch
|Extends the Elasticsearch backend with additional business logic, and new features and UX (saving search "favorites" and indexing link paths traversed in connection with a search query). See https://github.com/debtcompliance/mediawiki/wiki/Search-&-sorting
|e.g. See the "heart" symbol next to the search box which implements the "favorites" feature.
|-
|22
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcssection DcsSection]
|Allows for loan documents to be imported into the wiki as multiple articles. Creates a 'section reference' capability.
|
|-
|23
|DcsSection2
|purpose?
|no
|Unused - at least not on the development machine which is a clone of production.
'''There is a lot of obsolete and patched functionality in this extension, a version 2 was about to be started to strip all this out'''
|-
|24
|[https://github.com/debtcompliance/mediawiki/wiki/SSO-2017-specification DcsSingleSignOn]
|Create a master/slave relationship with the Ruby on Rails application as the authentication and group mangement source; with the MediaWiki application synchronizing user information into it's local database.
|For testing, you can access /wiki/extensions/dcs/DcsSingleSignOn/testLogin.php
|-
|25
|[https://github.com/debtcompliance/mediawiki/wiki#the-dcs-skin DcsSkin]
|Custom 'style' to match DCS website / frontend QAR app
|Skin by Aran Dunkley
|-
|26
|[https://github.com/debtcompliance/mediawiki/wiki/The-DcsTitle-class DcsTitle]
|Extends the regular MediaWiki title object class. Creates a custom cache of the TOC.
|yes
|-
|27
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcsuploadedfiles DcsUploadedFiles]
|Creates a special page listing all the files uploaded to loan documents orderd by loan namepsace then by article
|https://clienttest.dm.dcstemporary.com/Special:DcsUploadedFiles
|-
|28
|DcsUserDisable
|Adds 'enable/disable' links to the User list
|https://clienttest.dm.dcstemporary.com/Special:ListUsers Why not use the [https://clienttest.dm.dcstemporary.com/Special:Block Special:Block] functionality built into core?I believe it's every bit as accessible through the API and thus could be used from QAR.
|-
|29
|[https://github.com/debtcompliance/mediawiki/wiki/Extensions#dcswatchcomments DcsWatchComments]
|Adds subscription to talk pages.
|no
|When I view my normal [https://clienttest.dm.dcstemporary.com/Special:EditWatchlist MediaWiki 'WatchList'], I don't see any loan talk pages added. I only see my user page.
'''This functionality doesn't apply to the MW watchlist, it's on the Company Comments page'''
|-
|30
|[https://github.com/OrganicDesign/extensions/tree/master/MediaWiki/AjaxComments AjaxComments]
|
|
|-
|31
|[[mw:Extension:EmailPage|EmailPage]]
|Adds a special page that allows you to send the rendered HTML contents of a wiki page to a recipient (or list). Dependant on PHPMailer (5.2.23)
|Activated by the "Email" item in the primary navigation across the top of the page.
|-
|32
|[https://github.com/OrganicDesign/extensions/blob/master/MediaWiki/ExtraMagic/ExtraMagic_body.php ExtraMagic]
|Adds extra [[mw:Help:Magic_words|Magic Words]] and Parser functions.
|
|-
|-
|33
|[https://github.com/OrganicDesign/extensions/tree/master/MediaWiki/jQueryUpload jQueryUpload]
|
|
|-
|34
|[[mw:Extension:PdfBook|PdfBook]]
|The PdfBook extension composes a book from articles in a category, bullet list, or DPL query; and exports as a PDF file. Depends on [https://www.msweet.org/projects.php?Z1 HTMLDoc]
|
|-
|35
|[[mw:Extension:TreeAndMenu|TreeAndMenu]]
|Makes bullet lists into folder trees or dynamic drop-down menus.<br /><br />The drop-down menu functionality uses Son of Suckerfish which is 99% CSS, and the tree component is now using the FancyTree jQuery plugin rather than the dTree used in previous version of the TreeAndMenu extension. The new FancyTree has many options and plugins and is very extendable, please view the site and examples for more detail.
|-
|}
== Double Check ==
You can visit the "[https://clienttest.dm.dcstemporary.com/Special:Version Special:Version]" page of the wiki. This page shows you exactly what extensions and versions of software are installed and activated on your wiki.