Extension:Flow

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Flow

Release status: beta

2013-08-21 Flow prototype.png
Implementation Notify
Description Discussion and collaboration software
Author(s) Brandon Harris, Erik Bernhardson, Matthias Mullie, Andrew Garrett, Benny Situ, Shahyar Ghobadpour, Matthew Flaschen
Latest version beta
MediaWiki 1.25+
PHP 5.3.6+
Database changes Yes
License GPL
Download
Hooks used
LoadExtensionSchemaUpdates

ApiTokensGetTokenTypes
MediaWikiPerformAction
OldChangesListRecentChangesLine
SkinTemplateNavigation::Universal
Article::MissingArticleConditions
SpecialWatchlistGetNonRevisionTypes
UserGetReservedNames
ResourceLoaderGetConfigVars
ContribsPager::reallyDoQuery
ContributionsLineEnding
AbuseFilter-computeVariable

Translate the Flow extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Phabricator:

Open tasks · Report a bug

See Flow for an overview of what this extension is planned to address over time.

See Flow/MVP for a summary of what the December 2013 implementation does, or try it.

Installing[edit | edit source]

Caution! Caution: This is in Beta and still under active development. You may want to drop into #wikimedia-corefeaturesconnect to discuss before installing.

The easiest way to install Flow is to use the MediaWiki-Vagrant appliance and enable its flow role.

To install the extension manually:

  • Download and extract the tarball in your extensions/ folder. It should generate a new folder called Flow directly inside your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Flow/Flow.php";
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Note Note: Running "update.php" will leave temporary /tmp/mw-UIDGeneratorUUID-UID-xx files that MediaWiki may be unable to open (bug 53791). If you get a "Permission denied" error upon first visiting a Flow board you have to delete these files.

Dependencies[edit | edit source]

Verifying installation[edit | edit source]

Visit one of the pages you enabled for Flow (see #Configuration) and try adding a topic and editing its header.

Configuration[edit | edit source]

Here are some settings you need to make in LocalSettings.php.

Subject to change

You configure a wiki page to show its Flow board in place of regular page content. $wgFlowOccupyPages specifies Flow-enabled pages (use spaces, not underscores, in page titles). $wgFlowOccupyNamespaces specifies Flow-enabled namespaces (by number). For example:

 $wgFlowOccupyPages = array ( 'Talk:Main Page', 'Mywiki talk:WikiProject Flow', 'Talk:Flow QA' );
 $wgFlowOccupyNamespaces = array( NS_USER_TALK );

This is not intended to be a permanent solution, it is targeted to the needs of the initial limited rollout.

"maximum function nesting level of '100' reached, aborting"[edit | edit source]

If you get this error, you need to set xdebug.max_nesting_level = 200, probably in /etc/php5/apache2/php.ini .[1]

"Exception Caught: CAS is not implemented in Xyz"[edit | edit source]

Flow invokes $cache->cas() and some cache implementations including CACHE_ACCEL (APCBagOStuff) don't implement CAS. You probably need to use a different cache, for example install memcached and set $wgMainCacheType = CACHE_MEMCACHED;.

Permissions[edit | edit source]

Users must have the core edit permission to perform any write action in Flow. Many wikis only grant this permission to the 'user' (logged-in) or 'autoconfirmed' group.

Flow defines many actions such as edit-post and delete-topic (see the list in FlowActions.php). The permissions vary depending on whether the post is your own and whether it has been moderated. For example, by default users can edit their own posts, but only users in the 'sysop' group have the flow-edit-post permission to edit anyone's post. You can override which groups have which permissions and what permissions are required for each Flow action; see Manual:User rights for an overview of permissions.

Migrating existing pages[edit | edit source]

$wgFlowOccupyNamespaces does not affect subpages. So before or after setting this, you can use Special:MovePage to move the existing content of a talk page to an /Archive subpage without leaving a redirect, and in the header section of its Flow board, add a link to it, e.g.

Previous discussion is at [[SomeNamespace talk:Some Page/Archive]]

Flow adds a Topic: namespace, see Extension default namespaces#Flow. You can visit Special:PrefixIndex/Topic: to see if there are existing pages that conflict with this; if so run the maintenance script maintenance/namespaceDupes.php.

Architecture[edit | edit source]

See Flow/Architecture.

Spam[edit | edit source]

See Extension:Flow/Spam for more information on how to fight spam in Flow.

Moderation[edit | edit source]

See Extension:Flow/Moderation for more information on moderation in Flow.