Extension:DiscussionTools
Appearance
The Discussion Tools extension is a set of tools to enhance discussion pages. As of 2024, it is being built by the Editing team as part of the talk pages project.
User documentation is at Help:DiscussionTools.
Some features can be disabled on individual pages and sections as described at Help:DiscussionTools/Magic words and markup.
Features
[edit]Dependencies
[edit]Optional dependencies
[edit]- Extension:Echo - Enables topic subscriptions and user pinging.
- Extension:Thanks - Enables comment thanking.
- Extension:MobileFrontend - Enables mobile support.
Installation
[edit]This extension comes with MediaWiki 1.40 and later, so you do not need to download it. The remaining configuration instructions must still be followed.
- Install the dependencies.
- Download and move the extracted
DiscussionToolsfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'DiscussionTools' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Also in LocalSettings.php, ensure that you have a timezone set and $wgFragmentMode set to
html5. - Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
[edit]| Setting name | Default value | Description |
|---|---|---|
$wgDiscussionToolsBeta | false | Make DiscussionTools a beta feature. |
$wgDiscussionTools_visualenhancements | 'default' | Override availability of DiscussionTools visual enhancements. Possible values: 'default', 'available', 'unavailable' |
$wgDiscussionTools_visualenhancements_reply_icon_languages | [ 'ar' => true, 'zh' => true, 'yue' => true, 'ja' => true, 'nod' => true, ] | A dictionary of language codes which will receive an icon in their enhanced reply-button treatment, due to translation being very short. (T323537) Language fallbacks will be checked unless a language is explicitly set to false. (T352289) Normalized language codes are lower case. |
$wgDiscussionToolsAutoTopicSubEditor | 'any' | Editor which triggers automatic topic subscriptions. Either 'discussiontoolsapi' for edits made using DiscussionTools’ API (e.g. reply and new topic tools), or 'any' for any editor. |
$wgDiscussionToolsTalkPageParserCacheExpiry | 0 | Override $wgParserCacheExpireTime for discussion pages, regardless of DiscussionTools enablement. |
$wgDiscussionToolsReplyIndentation | 'invisible' | Reply indentation syntax to use: 'invisible' (use <dl><dd> tags to output : in wikitext) or 'bullet' (use <ul><li> tags to output * in wikitext). |
$wgDiscussionToolsShowFeedbackLinks | false | MW 1.40+ Show "Share feedback about this feature" links in the footer of reply tool and new topic tool. |
$wgDiscussionToolsTimestampFormatSwitchTime | '2022-07-12' | Date on which the internal timestamp format has changed (T304595), in ISO 8601 format. |
$wgDiscussionToolsConflictingGadgetName | 'convenientDiscussions' | Internal name of the Convenient Discussions gadget, which conflicts with the reply tool. Reply tool will be unavailable when the user has this gadget enabled. |
API
[edit]Editing
[edit]| Action | Description | Internal? |
|---|---|---|
| discussiontoolscompare | Get information about comment changes between two page revisions. | |
| discussiontoolsedit | Post a message on a discussion page. | |
| discussiontoolsfindcomment | Find a comment by its ID or name. | |
| discussiontoolspageinfo | Returns metadata required to initialize the discussion tools. | |
| discussiontoolspreview | Preview a message on a discussion page. |
Subscriptions
[edit]| Action | Description | Internal? |
|---|---|---|
| discussiontoolsgetsubscriptions | Get the subscription statuses of given topics. | |
| discussiontoolssubscribe | Subscribe (or unsubscribe) to receive notifications about a topic. |
Special pages
[edit]Integration with other extensions
[edit]DiscussionTools can integrate with PlaceNewSection to put the location of where added new topics will begin to be placed.
It can also integrate with AutoModerator to enable community-configured reversion of Machine Language-scored bad edits.
See also
[edit]- Extension:DiscussionTools/How it works – technical information
- Convenient Discussions – another tool for discussions, incompatible with DiscussionTools
| This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |
Categories:
- Stable extensions
- User interface extensions
- MIT licensed extensions
- Extensions in Wikimedia version control
- ApiMain::moduleManager extensions
- BeforeCreateEchoEvent extensions
- BeforeDisplayNoArticleText extensions
- BeforePageDisplay extensions
- ChangeTagsListActive extensions
- DiscussionToolsAddOverflowMenuItems extensions
- EchoGetBundleRules extensions
- EchoGetEventsForRevision extensions
- GetActionName extensions
- GetBetaFeaturePreferences extensions
- GetDoubleUnderscoreIDs extensions
- GetPreferences extensions
- ListDefinedTags extensions
- LoadExtensionSchemaUpdates extensions
- OutputPageBeforeHTML extensions
- OutputPageParserOutput extensions
- ParserAfterTidy extensions
- ParserOutputPostCacheTransform extensions
- RecentChange save extensions
- ResourceLoaderGetConfigVars extensions
- RevisionDataUpdates extensions
- SidebarBeforeOutput extensions
- SkinTemplateNavigation::Universal extensions
- All extensions
- Extensions bundled with MediaWiki 1.40
- Extensions used on Wikimedia
- Extensions included in Canasta
- Extensions available as Debian packages
- Extensions included in Miraheze
- Extensions included in MyWikis
- Extensions included in wiki.gg
- Discussion and forum extensions
- Extensions with VisualEditor support
- Talk pages project
