BoilerRoom

From Aeon Garden Software Wiki
Jump to: navigation, search

Download

Version Release Date Location Known Compatibility[1]
1.23 (Latest) 2013 December 21 http://sw.aeongarden.com/download/BoilerRoom-1.23.zip MediaWiki 1.17 to 1.21
1.22 2013 November 13 http://sw.aeongarden.com/download/BoilerRoom-1.22.zip MediaWiki 1.17 to 1.21
1.21[2] 2013 October 21 http://sw.aeongarden.com/download/BoilerRoom-1.21.zip MediaWiki 1.17 to 1.21 (but see note below)
1.2[2][3] 2013 May 5 http://sw.aeongarden.com/download/BoilerRoom-1.2.zip MediaWiki 1.17 to 1.21 (but see note below)
1.1 2012 July 29 http://sw.aeongarden.com/download/BoilerRoom-1.1.zip MediaWiki 1.17 to 1.19
1.01 2012 February 8 http://sw.aeongarden.com/download/BoilerRoom-1.01.zip MediaWiki 1.16.5 to 1.18
1.0 2011 November 4 http://sw.aeongarden.com/download/BoilerRoom-1.0.zip MediaWiki 1.16.5 to 1.17
0.93 2011 September 25 http://sw.aeongarden.com/download/BoilerRoom-0.93.zip MediaWiki 1.16.5 to 1.17
0.92 2011 September 14 http://sw.aeongarden.com/download/BoilerRoom-0.92.zip MediaWiki 1.16.5 to 1.17
0.91 2011 September 11 http://sw.aeongarden.com/download/BoilerRoom-0.91.zip MediaWiki 1.16.5 to 1.17
0.9 2011 September 5 http://sw.aeongarden.com/download/BoilerRoom-0.9.zip MediaWiki 1.16.5 to 1.17
  1. There is a good chance BoilerRoom versions 1.01 and earlier are compatible with MediaWiki versions before 1.16.5, but this has not been tested. Compatibility has been tested up to versions 1.21 for the latest version.
  2. 2.0 2.1 Important note: These old versions have a critical bug that prevents editing when there are no articles in the Boilerplate namespace. If you are using these versions, upgrading to version 1.22 or later is strongly recommended.
  3. Versions 1.2 and earlier are incompatible with MediaWiki's built-in preloading features, preventing them from working. This makes these versions incompatible with similar extensions like CreateBox and InputBox. This was fixed in 1.21.

Description

BoilerRoom is a extension that allows you to create boilerplate article text, like document templates in a word processor, and easily load them in the edit textbox when using the source editing feature.

More technically speaking, it is a dynamic text preloading extension which has the ability to load text from boilerplate pages into the edit textbox of new pages. With AJAX enabled on the server and JavaScript enabled on the user's browser, boilerplate text can even be loaded onto existing pages. The extension provides a boilerplate selector on edit pages for this purpose. It also allows you to create input boxes on wiki pages that allow users to input a title and open a new page for editing with the boilerplate text preloaded into the edit box.

BoilerRoom is different in its approach from similar extensions in that it was designed to allow the creation of boilerplate text without any need for text escaping. It deliberately does not respect <includeonly>, <onlyinclude>, and <noinclude> tags, instead providing its own mechanism through the special behavior of the provided <boilerplate> tag. This behavior simplifies certain situations, such as creating boilerplates for templates, where unusual escape mechanisms like <include<includeonly>only> would be necessary to achieve the same effect. Other <boilerplate> tags can be even placed inside without any need for an escape mechanism.

Installation

  1. Extract this extension to the extensions subdirectory of your MediaWiki installation directory. It should be contained in a BoilerRoom subdirectory within extensions.
  2. If your wiki has custom namespaces using the indexes 450 and 451, add the following line to LocalSettings.php (changing xxx to an unused even index, ensuring that the following index is also unused):
    $wgbrNamespaceIndex = xxx;
  3. Add the following lines to LocalSettings.php. Due to the unique nature of the <boilerplate> tag used by this extension, it is advisable to include this line before any other extension includes to prevent unexpected interactions (but make sure it is placed after the $wgbrNamespaceIndex line if that is needed):
    require_once( "{$IP}/extensions/BoilerRoom/BoilerRoom.php" );

Note: Versions 0.92 and earlier used namespace indexes 300 and 301 as the defaults. If you are upgrading from those versions and you were using the default, you should add the following line before the require_once line:

$wgbrNamespaceIndex = 300;

Alternatively, if you are comfortable manipulating the database directly, you can update the namespace indexes of the page. Another option is to create a temporary custom namespace at index 300 and move them to new Boilerplate namespace manually.

Configuration

$wgbrNamespaceIndex
Sets the index at which the Boilerplate namespace will be created.
As of version 0.93, this is 450 by default. The Boilerplate talk namespace will be created at the following index, which is 451 by default.
In earlier versions, this was 300 by default, with the Boilerplate talk namespace being created at 301 by default.
$wgbrUseLargeSelector
Available in 1.0, this option allows you to use a large version of the four-button selector that appears above the standard toolbar rather than to the right of it by setting this option to true. This option has no effect for users using the advanced toolbars from the WikiEditor extension.

Overview

BoilerRoom is a dynamic text preloading extension that has the ability to load text from boilerplate pages into the edit textbox of new pages. With AJAX enabled on the server and Javascript enabled on the user's browser, boilerplate text can even be loaded on existing pages. The extension provides a boilerplate selector on edit pages for this purpose. It also allows you to create input boxes on wiki pages that allow users to input a title and open a new page for edit with the boilerplate text preloaded into the edit box.

BoilerRoom is different in its approach from similar extensions in that it was designed to allow the creation of boilerplate text without any need for text escaping. It deliberately does not respect <includeonly>, <onlyinclude>, and <noinclude> tags, instead providing its own mechanism through the special behavior of the provided <boilerplate> tag. This behavior simplifies certain situations, such as creating boilerplates for templates, where unusual escape mechanisms like <include<includeonly>only> would be necessary to achieve the same effect. Even other <boilerplate> tags can be place inside without any need for an escape mechanism.

Usage

For usage instructions, refer to pages from the manual as listed below.

Version History

Version Release Date Changes
1.23 2013 December 21 Fixed error causing odd characters to appear at the bottom of edit page.
1.22 2013 November 13 Fixed error that occurs when BoilerRoom is installed with no boilerplates in the Boilerplate namespace.
1.21 2013 October 21 Corrected conflict with built-in preloading feature, making InputBox and CreateBox compatible.
1.2 2013 May 5 Now works with the WikiEditor toolbar. Additional refactoring to improve coding practices.
1.1 2012 July 29 Moderate refactoring to improve compatibility with future MediaWiki versions.
1.01 2012 February 18 Patches for MediaWiki 1.18 compatibility issues.
1.0 2011 November 4 Added small selector option and insert at cursor functionality.
0.93 2011 September 25 Default namespace index changed to the apparently unused value of 450.
0.92 2011 September 14 Input validation for the BoilerRoomBox greatly improved.
0.91 2011 September 11 Changed <boilerroom> to <boilerplate>.
0.9 2011 September 5 Initial beta release.

Known issues

Unusual text appearing at bottom of edit pages (fixed in 1.23)

In versions 1.20 to 1.22, a minor issue was inadvertently introduced that causes the characters /*]]>*/ to appear at the bottom of edit pages. This is merely a cosmetic error that has no known effect on wiki functionality and has been fixed in version 1.23.

Error when editing when no boilerplates are available (fixed in 1.22)

Some recent versions of BoilerRoom, including 1.21, cause an error when open pages for editing if there are no pages in the Boilerplate namespace.

The easiest way to fix this is to install version 1.22 or later.

If this isn't an option, you can work around it by performing the following steps:

  1. Temporarily uninstall BoilerRoom by adding a # to beginning of the line containing require_once( "{$IP}/extensions/BoilerRoom/BoilerRoom.php" ); in LocalSettings.php.
  2. Temporarily add the following lines below it:
  3. define("NS_BOILERPLATE", isset( $wgbrNamespaceIndex ) ? $wgbrNamespaceIndex : 450);
    define("NS_BOILERPLATE_TALK", isset( $wgbrNamespaceIndex ) ? $wgbrNamespaceIndex + 1 : 451);
        
    $wgExtraNamespaces[NS_BOILERPLATE] = "Boilerplate";
    $wgExtraNamespaces[NS_BOILERPLATE_TALK] = "Boilerplate_talk";
    
    
  4. Now, navigate to the wiki and create any page in the Boilerplate namespace (any page beginning with "Boilerplate:").
  5. Return to LocalSettings.php and remove the lines and # you added in step 1 and 2 to reinstall BoilerRoom.

Overrides built-in preloading feature (fixed in 1.21)

Versions of BoilerRoom before 1.21 currently prevent the built-in text preloading feature of MediaWiki from working correctly. This affects extensions like InputBox and CreateBox that use this feature. This issue has been corrected in version 1.21.

Selectors don't clear floats (fixed in 1.0)

There is a simple workaround for this issue. Paste the following CSS into MediaWiki:Common.css on your wiki:

.boilerRoomFieldSet {
  clear: both;
}