Extension:SmartComments

MediaWiki extensions manual

SmartComments Release status: beta
Author(s)	Youri van den Bogert, Erwin Oord, Robin van der Wiel Yvar Nanlohij
Maintainer(s)	ArchiXL
Latest version	2.0.0 (31 October 2024)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.39
PHP	7.4
Database changes	Yes
Tables	sic_anchor sic_data sic_diff_table
License	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Added rights add-inlinecomments, manage-inlinecomments
Hooks used LoadExtensionSchemaUpdates BeforePageDisplay SkinTemplateNavigation::Universal ResourceLoaderGetConfigVars SMW::Property::initProperties SMW::Store::BeforeDataUpdateComplete SMWStore::updateDataBefore ParserCacheSaveComplete MediaWikiServices ArticleDeleteAfterSuccess ResourceLoaderRegisterModules

The SmartComments extension enables wiki users to post inline comments attached to text fragments on wiki pages, comparable to posting review comments in Microsoft Word and other word processors.

Installation

• Download and move the extracted SmartComments folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SmartComments
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'SmartComments' );
  

• Run the MediaWiki update.php maintenance script to add the database tables
• Manage user permissions if needed (see below)
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Updating to v2.0.0

If you had SmartComments previously installed, and now migrating to 2.0.0, follow the steps described here.

Usage

Usage is fairly straightforward. Users can post comments by selecting a text fragment on any wiki page and entering comment text in the popup window. Commented text on a wiki page is highlighted in light yellow. Upon clicking such a text fragment, the posted comment is displayed on the right edge of the page. Users can reply to posted comments.

In addition to posting and viewing comments, users with the "manage-inlinecomments" permission can delete other users' comments and toggle comments' status between "open" and "completed". Comments can be managed from the page on which they have been posted or from the "Special:SmartComments" special page.

SemanticMediaWiki

If SemanticMediaWiki has been installed, comments are (additionally) available as subobjects on the page where they have been posted and can be queried accordingly.

Version history

• 2.0.0 - 13 October 2024 - Several improvements, see release page for more information
• 1.5.5 - 25 September 2024 - Fixed bug where you could select everything in the page (now only limited to the #mw-content-text div)
• 1.5.4 - 18 July 2024 - (SpecialPage)
  • Removed the use of SMW\HtmlTabs and created custom tabs
• 1.5.3 - 17 July 2024 - Removed hard requirement of SemanticMediaWiki in extension.json
• 1.5.2 - 2 July 2024 - Several improvements on the admin page (Special:SmartComments)
• 1.5.1 - 25 June 2024 - Fixed missing i18n-strings and replaced deprecated SMW hooks
• 1.5.0 - 31 May 2024 - Allow comments to be made on HTML selections
• 1.4.4 - 3 May 2024 - Initial version (beta release)

See also

• Extension:InlineComments