Difference between revisions of "Extension:LiquidThreads"
(Removed links to local video file and set to commons.wikimedia.org location.) |
|||
Line 1: | Line 1: | ||
+ | {{notice|The current version of this extension (2.0) is '''no longer actively maintained'''. WMF provides no support to Wikimedia wikis using it and requests of install on new Wikimedia projects are [[bugzilla:19699|on hold]].<br />Development of [[LiquidThreads 3.0|Version 3.0]] is '''on hold''' at the moment.}} | ||
+ | {{shortcut|LQT}} | ||
+ | {{update}} | ||
+ | {{expand}} | ||
{{Extension | {{Extension | ||
|name = LiquidThreads | |name = LiquidThreads | ||
− | |status = | + | |status = experimental |
|type1 = Page action | |type1 = Page action | ||
|type2 = Special | |type2 = Special | ||
+ | |type3 = api | ||
|author = David McCabe, Andrew Garrett | |author = David McCabe, Andrew Garrett | ||
|username = | |username = | ||
− | |image = | + | |image = LiquidThreads sample screenshot.jpg <!-- image needs updating --> |
− | |version = 2. | + | |version = 2.2-alpha [https://git.wikimedia.org/commitdiff/mediawiki%2Fextensions%2FLiquidThreads/99a9c23dd885fa5786158cabd9496bdcaa92c222] |
− | |update = | + | |update = 2014-03-28 |
− | |mediawiki = 1. | + | |mediawiki = 1.23+ |
+ | |php= 5.3.0+ | ||
+ | |needs-updatephp = yes | ||
|download = {{WikimediaDownload|LiquidThreads}} | |download = {{WikimediaDownload|LiquidThreads}} | ||
− | |readme = | + | |readme = {{git file|project=mediawiki/extensions/LiquidThreads|branch=340289fe14a8940f27bb6b55efc801bd847230fe|file=README|text=README}} |
|changelog = | |changelog = | ||
|license = GPL v2 | |license = GPL v2 | ||
− | |description = LiquidThreads | + | |description = LiquidThreads extension implements a structured discussion system for MediaWiki. |
|parameters = $egLqtNamespaceNumbers | |parameters = $egLqtNamespaceNumbers | ||
|rights = | |rights = | ||
− | |example = | + | |example = |
|hook1 = BeforeWatchlist | |hook1 = BeforeWatchlist | ||
|hook2 = ChangesListInsertArticleLink | |hook2 = ChangesListInsertArticleLink | ||
Line 26: | Line 33: | ||
|hook8 = SkinTemplateOutputPageBeforeExec | |hook8 = SkinTemplateOutputPageBeforeExec | ||
|hook9 = SpecialMovepageAfterMove | |hook9 = SpecialMovepageAfterMove | ||
+ | |hook10 = PageContentLanguage | ||
+ | |bugzilla = LiquidThreads | ||
}} | }} | ||
− | ''' | + | '''LiquidThreads''' (LQT) is an extension for MediaWiki that implements a threaded discussion page system. |
− | == | + | == History == |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The original code was developed by David McCabe under sponsorship from the [[Summer of Code 2006|Google Summer of Code 2006]], [http://col.org the Commonwealth of Learning], and [http://wikia.com Wikia]. However, David McCabe is no longer involved with this project. | |
− | + | ||
− | + | The original LiquidThreads code was substantially improved and augmented by [[User:Werdna|Andrew Garrett]] at the Wikimedia Foundation since May 2009. The latest stable release of the LiquidThreads extension is LQT 2.0, described on this page. LQT 2.0 is the version currently being used on several Wikimedia wikis, and was used in the strategic planning process. | |
− | # | + | |
− | + | In January 2011, work on [[LiquidThreads 3.0]] was begun at the Wikimedia Foundation. LQT 3.0 was being developed, with Andrew Garrett as the lead developer, but is now suspended. Development of LQT3 can be tracked [https://git.wikimedia.org/log/mediawiki%2Fextensions%2FLiquidThreads.git/refs%2Fheads%2Flqt-updates in this branch]; the last commits to LQT3 (lqt-updates) branch were in September 2011. Development by the Foundation has been discontinued. | |
+ | |||
+ | == User documentation == | ||
+ | To activate LiquidThreads on a specific page on a wiki where LiquidThreads is ''opt-in'', add | ||
+ | <tt><nowiki>{{#useliquidthreads:1}}</nowiki></tt> | ||
+ | to the page's source code. To deactivate LiquidThreads on a specific page on a wiki where LiquidThreads is ''opt-out'' add | ||
+ | <tt><nowiki>{{#useliquidthreads:0}}</nowiki></tt> | ||
+ | to the page's source code. | ||
+ | |||
+ | * '''[[/FAQ|FAQ]]''' and | ||
+ | * '''[[Help:Extension:LiquidThreads|Extension help]]''' page. | ||
+ | Comprehensive user documentation will be developed when LiquidThreads has a finalised (or remotely stable) interface. | ||
==Rationale== | ==Rationale== | ||
− | Wiki discussion pages have some advantages over web and Usenet forums | + | Wiki discussion pages have some advantages over web and Usenet forums: |
− | + | *They allow use of the entire wiki syntax, from images to links to [[transclusion]]s. | |
− | + | *It is possible to refactor entire discussion pages. | |
+ | But web forums offer many more advantages over the MediaWiki talk page model: | ||
*Threads can be displayed in different views: flat, nested, sorted by date, subject, etc. | *Threads can be displayed in different views: flat, nested, sorted by date, subject, etc. | ||
*The user only needs to click a "Reply" button or link in order to respond to a comment. Manual indentation is not required. Quotations from the source comment can be inserted automatically. | *The user only needs to click a "Reply" button or link in order to respond to a comment. Manual indentation is not required. Quotations from the source comment can be inserted automatically. | ||
− | *Comments are automatically signed and dated. Avatars are possible. | + | *Comments are automatically signed and dated. |
+ | *Avatars are [[/Avatar storage|possible]] (but not yet created). | ||
*The user can watch individual threads or be notified about responses in threads. | *The user can watch individual threads or be notified about responses in threads. | ||
*Comments and threads can be displayed individually, without the surrounding page. | *Comments and threads can be displayed individually, without the surrounding page. | ||
Line 55: | Line 72: | ||
*Search for author, subject, date, etc. is possible | *Search for author, subject, date, etc. is possible | ||
*Individual threads can have categories. | *Individual threads can have categories. | ||
− | *It is relatively easy to manage related discussions in a subject-specific forum, whereas MediaWiki talk pages always follow the "one discussion page per | + | *It is relatively easy to manage related discussions in a subject-specific forum, whereas MediaWiki talk pages always follow the "one discussion page per subject page" model. |
+ | LiquidThreads aims to unite the advantages of both forum types, and to add some unique discussion features to boot. | ||
+ | |||
+ | ==Installation== | ||
− | LiquidThreads | + | '''Prerequisites:''' LiquidThreads currently requires the [[Extension:WikiEditor|WikiEditor]] extension to be already installed. See [[bugzilla:38654|bug 38654]]. |
+ | To be able to properly search threads, [[Extension:Lucene-search]] must also be installed from Wikimedia's operations/debs/lucene-search-2.git repository. | ||
− | = | + | {{ExtensionInstall |
− | + | |db-update=1 | |
+ | }} | ||
− | == | + | ===Installing without command prompt access=== |
+ | Some individuals may not have command prompt access. However, if you have access through phpMyAdmin, substitute these steps for step #4 above: | ||
− | LiquidThreads | + | #Download [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/LiquidThreads/lqt.sql lqt.sql]. |
+ | #In phpMyAdmin, click the database you're using for mediawiki along the left side | ||
+ | #On the next screen, click the "SQL" tab at the top. | ||
+ | #At "Location of the text file", choose one of the files, select compression "None", and click the bottom "Go" button. | ||
+ | #:If your phpMyAdmin screen has only a text field and no text file chooser, click the "SQL" button in the left-side column, under the phpMyAdmin logo, and click the "import files" tab in the new window that opens. | ||
+ | #:If you encounter the error message <code>#1071 - Specified key was too long; max key length is 1000 bytes </code>, abbreviate line 35 of lqt.sql to <code>CREATE INDEX thread_article_title ON /*$wgDBprefix*/thread (thread_article_namespace, thread_article_title);</code> (in other words, remove <code>, thread_sortkey</code>). Remove the new tables and import the file again. | ||
+ | #:If your database uses table prefixes, you have to add them manually. You can do so after the new tables have been created. | ||
+ | == API == | ||
+ | [[/API|API documentation]] | ||
− | + | ==Notes== | |
− | + | <references/> | |
− | + | {{info|1=This extension does not work if your LocalSettings.php contains the following two parameter settings: <code>$wgEnableAPI = false;</code> and <code>$wgEnableWriteAPI = false;</code>}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | == Example == | |
− | + | * [[LiquidThreads Test Page|Test Page]] for playing around with the Liquid Threads interface. | |
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==See also== | ==See also== | ||
− | *[[v:THREADNAV]] - | + | * [[Flow]] |
− | *[[Extension:AWC's Forum]] - allows the display of a standalone forum within MediaWiki. | + | * [[v:THREADNAV]] - Wikiversity development on structured and threaded discussions using wiki-syntax for structures and [[Manual:NavFrame|NavFrames]] JavaScript for display. Last activity was 2007. |
+ | * [[Extension:AWC's Forum]] - allows the display of a standalone forum within MediaWiki. | ||
+ | * [[Extension:Reflect]] - implements a novel augmentation of threaded comments. | ||
+ | * [[User:Inquisitor_Ehrenstein/LQTavatar]] – Forum style LQT templates for including avatars and full forum style signatures. | ||
+ | * [[Extension:DiscussionThreading]] - A more light-weight solution that will still allow editing the discussion page like a wiki page (still works with MW 1.22x) | ||
==External links== | ==External links== | ||
− | + | * [[Extension:LiquidThreads/Sites using this extension|Sites using this extension]] | |
− | + | * [[bugzilla:19699|Bugzilla ticket for LiquidThreads deployment]] | |
− | + | * [[w:Wikipedia:LiquidThreads|English Wikipedia]] LiquidThreads article | |
− | + | * [[commons:Category:LiquidThreads|Wikimedia Commons]] LiquidThreads pictures | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | * | ||
− | + | {{OnWikimedia}} | |
− | |||
− | + | {{Languages}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Category:Discussion and forum extensions]] | [[Category:Discussion and forum extensions]] | ||
+ | [[Category:Summer of Code 2006]] |
Latest revision as of 07:25, 12 May 2014
Template:Notice Template:Shortcut
Needs Update
This page has not been updated in a long time - needs attention from some expert on the subject
LiquidThreads Release status: experimental | |||
---|---|---|---|
220px | |||
Implementation | Page action, Special page, API | ||
Description | LiquidThreads extension implements a structured discussion system for MediaWiki. | ||
Author(s) | David McCabe, Andrew Garrett | ||
Latest version | 2.2-alpha [1] (2014-03-28) | ||
MediaWiki | 1.23+ | ||
PHP | 5.3.0+ | ||
Database changes | yes | ||
License | GPL v2 | ||
Download | Template:Git file | ||
| |||
Check usage and version matrix; code metrics | |||
Bugs: list open list all report |
LiquidThreads (LQT) is an extension for MediaWiki that implements a threaded discussion page system.
Contents
History
The original code was developed by David McCabe under sponsorship from the Google Summer of Code 2006, the Commonwealth of Learning, and Wikia. However, David McCabe is no longer involved with this project.
The original LiquidThreads code was substantially improved and augmented by Andrew Garrett at the Wikimedia Foundation since May 2009. The latest stable release of the LiquidThreads extension is LQT 2.0, described on this page. LQT 2.0 is the version currently being used on several Wikimedia wikis, and was used in the strategic planning process.
In January 2011, work on LiquidThreads 3.0 was begun at the Wikimedia Foundation. LQT 3.0 was being developed, with Andrew Garrett as the lead developer, but is now suspended. Development of LQT3 can be tracked in this branch; the last commits to LQT3 (lqt-updates) branch were in September 2011. Development by the Foundation has been discontinued.
User documentation
To activate LiquidThreads on a specific page on a wiki where LiquidThreads is opt-in, add
{{#useliquidthreads:1}}
to the page's source code. To deactivate LiquidThreads on a specific page on a wiki where LiquidThreads is opt-out add
{{#useliquidthreads:0}}
to the page's source code.
- FAQ and
- Extension help page.
Comprehensive user documentation will be developed when LiquidThreads has a finalised (or remotely stable) interface.
Rationale
Wiki discussion pages have some advantages over web and Usenet forums:
- They allow use of the entire wiki syntax, from images to links to transclusions.
- It is possible to refactor entire discussion pages.
But web forums offer many more advantages over the MediaWiki talk page model:
- Threads can be displayed in different views: flat, nested, sorted by date, subject, etc.
- The user only needs to click a "Reply" button or link in order to respond to a comment. Manual indentation is not required. Quotations from the source comment can be inserted automatically.
- Comments are automatically signed and dated.
- Avatars are possible (but not yet created).
- The user can watch individual threads or be notified about responses in threads.
- Comments and threads can be displayed individually, without the surrounding page.
- Old comments are archived automatically and invisibly, with permanent links easily available.
- Search for author, subject, date, etc. is possible
- Individual threads can have categories.
- It is relatively easy to manage related discussions in a subject-specific forum, whereas MediaWiki talk pages always follow the "one discussion page per subject page" model.
LiquidThreads aims to unite the advantages of both forum types, and to add some unique discussion features to boot.
Installation
Prerequisites: LiquidThreads currently requires the WikiEditor extension to be already installed. See bug 38654. To be able to properly search threads, Extension:Lucene-search must also be installed from Wikimedia's operations/debs/lucene-search-2.git repository.
Installing without command prompt access
Some individuals may not have command prompt access. However, if you have access through phpMyAdmin, substitute these steps for step #4 above:
- Download lqt.sql.
- In phpMyAdmin, click the database you're using for mediawiki along the left side
- On the next screen, click the "SQL" tab at the top.
- At "Location of the text file", choose one of the files, select compression "None", and click the bottom "Go" button.
- If your phpMyAdmin screen has only a text field and no text file chooser, click the "SQL" button in the left-side column, under the phpMyAdmin logo, and click the "import files" tab in the new window that opens.
- If you encounter the error message
#1071 - Specified key was too long; max key length is 1000 bytes
, abbreviate line 35 of lqt.sql toCREATE INDEX thread_article_title ON /*$wgDBprefix*/thread (thread_article_namespace, thread_article_title);
(in other words, remove, thread_sortkey
). Remove the new tables and import the file again. - If your database uses table prefixes, you have to add them manually. You can do so after the new tables have been created.
API
Notes
Example
- Test Page for playing around with the Liquid Threads interface.
See also
- Flow
- v:THREADNAV - Wikiversity development on structured and threaded discussions using wiki-syntax for structures and NavFrames JavaScript for display. Last activity was 2007.
- Extension:AWC's Forum - allows the display of a standalone forum within MediaWiki.
- Extension:Reflect - implements a novel augmentation of threaded comments.
- User:Inquisitor_Ehrenstein/LQTavatar – Forum style LQT templates for including avatars and full forum style signatures.
- Extension:DiscussionThreading - A more light-weight solution that will still allow editing the discussion page like a wiki page (still works with MW 1.22x)
External links
- Sites using this extension
- Bugzilla ticket for LiquidThreads deployment
- English Wikipedia LiquidThreads article
- Wikimedia Commons LiquidThreads pictures
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. |
Language: | [[::Extension:LiquidThreads|English]] |
---|
- GPL licensed extensions
- Experimental extensions
- Pages with broken file links
- Page action extensions
- Special page extensions
- API extensions
- Extensions in Wikimedia version control
- BeforeWatchlist extensions
- ChangesListInsertArticleLink extensions
- MediaWikiPerformAction extensions
- PageHistoryBeforeList extensions
- SkinTemplateTabAction extensions
- SkinTemplateTabs extensions
- SkinTemplateOutputPageBeforeExec extensions
- SpecialMovepageAfterMove extensions
- PageContentLanguage extensions
- All extensions
- Extensions used on Wikimedia
- Discussion and forum extensions
- Summer of Code 2006