PeerPublisher

From Extension Collaborative Wiki

Contents 1 Introduction 1.1 The Problem 1.2 A Solution 2 Methodology 2.1 Assumptions 3 Implementation 3.1 Installation 3.2 Configuration 3.3 Using the Dump Filter 3.4 Using the Import Utility 3.5 Uninstallation 4 Notes 4.1 ToDo

Introduction

From the makers of BettaMeta comes PeerPublisher.

The Problem

A non-public wiki is being used to create content that will be published to a public web site. To facilitate marking pages as having been review and available for publishing, a user-friendly tool is needed.

A Solution

A MediaWiki extension that adds a publish status toolbox and a publish tab that features one-button publishing.

Methodology

1. Create new table to hold data (peerpub), indexed by the page_id of the associated page. A new publishing status toolbox appears and a publish tab appears as well. The publish tab features one-button publishing.

Publishing is on a page revision basis. Future revisions must be re-published.

Assumptions

Implementation

A MediaWiki extension has been created and made available.

Get your PeerPublisher fix today!

• browse source
• svn checkout https://sourcecode.extension.org/svn/MediaWiki/PeerPublisher/trunk

Installation

In LocalSettings.php:

include_once('extensions/PeerPublisher/PeerPublisher.php');

If your MediaWiki user has CREATE privileges, then no additional steps are necessary.

Configuration

MediaWiki 1.6 and newer

none.

You may override the default CSS file to change the display to your liking. Just define PEERPUBLISHER_CSS as a URL to your modified CSS file. eg.

define('PEERPUBLISHER_CSS', 'http://mywiki/styles/meta.css');

You may also enable the theme preview button. Just define PEERPUBLISHER_PREVIEW_THEME as a valid theme name. eg.

define('PEERPUBLISHER_PREVIEW_THEME', 'simple');

Using the Dump Filter

1. Be sure you have a properly configured MediaWiki AdminSettings.php file
2. Run the following command:

$ cd /path/to/mediawiki
$ /path/to/php maintenance/dumpBackup.php --quiet --full \
  --plugin=DumpPublishedFilter:extensions/PeerPublisher/PeerPublisher.php  \
  --filter=published > filename.xml

The --full option is required to get all the revisions to pass thru the filter.

Using the Import Utility

1. Be sure you have a properly configured MediaWiki AdminSettings.php file
2. Run the following command:

$ cd /path/to/mediawiki
$ /path/to/php -d include_path='./maintenance' \
  extensions/PeerPublisher/importPublished.php filename.xml

Import errors are sent to $wgEmergencyContact with a from address of $wgPasswordSender. Additionally, script will exit with the following status codes:

• 0 - no errors
• 1 - import failed
• 2 - invalid command line arguments

Results of a successful import can be viewed in the Special:Recentchanges page. Pages newly published are flagged as uploaded and pages unpublished are flagged as deleted.

Uninstallation

With WikiSysop privileges you may add the following to the URL in the address bar and POST the page:

 ?action=nomopubby

If your MediaWiki user has DROP privileges, then no additional steps are necessary.

There is no additional prompting or verification for using this feature. This will blow away any and all of your publish metadata. You have been warned.

Notes

• 2007.05.08 - 0.6.0 - changed preview feature
• 2007.03.23 - 0.5.1 - fix import bug
• 2007.03.06 - 0.5.0 - copy clean-up, unpublish if page moved
• 2007.02.27 - 0.4.1 - fix import logging, handle DPL page updates
• 2007.02.22 - 0.4.0 - mw 1.9 api updates, remove docs
• 2006.10.18 - 0.3.0 - fix html output error
• 2006.08.29 - 0.2.9 - change deprecated 1.7 api call, fix publish comment on pages where no talk page existed, import only changed revisions, set revision timestamp to import time
• 2006.08.09 - 0.2.8 - MW 1.7 updates, fix page links in specialpage
• 2006.07.21 - 0.2.7 - change define for preview theme for consistency
• 2006.07.20 - 0.2.6 - add theme preview option
• 2006.06.26 - 0.2.5 - update docs and clean-up import script
• 2006.06.23 - 0.2.4 - added import/export scripts
• 2006.06.22 - 0.2.3 - fix logic bug in edit counts
• 2006.06.21 - 0.2.2 - add DumpFilter subclass for use with dumpBackup.php script
• 2006.06.13 - 0.2.1 - output clean-up, new special page
• 2006.06.02 - 0.2.0 - new one-button publishing version

ToDo

Finish Special:PeerPublisher stats page.