Extension:SecureWidgets
 Release status: stable |
|
|---|---|
| Implementation | Parser function |
| Description | Provides secure inclusion of widgets |
| Author(s) | Jean-Lou Dupont |
| Last version | 1.0.1 |
| MediaWiki | 1.11, 1.12 (probably works with earlier versions too) |
| License | No license specified |
| Download | SVN See SVN ($Id: SecureWidgets.doc.wikitext 1158 2008-05-20 20:43:01Z jeanlou.dupont $) |
| Check usage and version matrix; stats | |
Securely allows a wiki to have widgets.
Contents |
Features[edit]
- List of available widgets: Extension:SecureWidgets#Widget_List
- User-Friendly:
- Comprehensive error messages, with help page links and examples
- Parameter type-checking[clarify]
Usage[edit]
{{#widget:widget-name|optional-parameters}}
- Default-value can be specified in widget templates
- Widget code is cached (in the transcache database table)
Example[edit]
{{#widget:Gliffy|id=1422053}}
Widget List[edit]
The list of available widgets is available as an RSS feed. The widget name is in the entry title; e.g.:
Widget:Gliffy - version 1.0.0
So this widget's name is Gliffy and it is added by typing {{#widget:Gliffy ...}}
| Widgets as of November 24, 2010 | |
|---|---|
| Name | Description |
| Addthis | |
| Diigo | |
| Diigo TagRolls | |
| Feed | |
| Feedburner | |
| Flickr | |
| Freshshoutbox | |
| Gliffy | |
| Googleppt | |
| Gravatar | |
| Gtalk | |
| Jskit_ratings | |
| Labpixies | |
| Mindmeister | |
| Ohloh | |
| Quimble | |
| Skype | |
| Slideshare | |
| Whos_amung_us | |
| Widgetbox | |
| Yahoo_im | |
| Youtube | |
Widget Namespace[edit]
One can use Extension:ManageNamespaces to add and manage the Widget namespace. This is entirely optional.
Widget Creation[edit]
The extension allows for user-generated widgets provided that one configures the Widget namespace.
Parameters[edit]
Parameters are provided through the escape sequence:
- {@{parameter-name}@} when only a parameter can be specified
- {@{parameter-name|type}@} when a parameter and its type are specified
- {@{parameter-name|type|default-value}@} when a parameter, its type and a default-value are specified
Example Template[edit]
<includeonly>
<!-- Gliffy Widget For Mediawiki by Jean-Lou Dupont -->
<script src="http://www.gliffy.com/diagramEmbed.js" type="text/javascript"></script>
<script type="text/javascript"> gliffy_did = "{@{id|integer}@}"; embedGliffy(); </script>
</includeonly>
Dependency[edit]
- Extension:ExtensionManager of version >= 2.0.1
- Automatically resolved if using PEAR
Installation[edit]
See the Mediawiki Extension table entry "download" above.[2]
LocalSettings.php[edit]
Extension:ExtensionManager: See footnote[3]
- Add the following to LocalSettings.php, if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)[3]:
require_once( "$IP/extensions/SecureWidgets/SecureWidgets.php" );
- Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.
PEAR[edit]PEAR is a repository of PHP software code.
require 'MediaWiki/SecureWidgets/SecureWidgets.php';
Upgrades through PEAR[edit]Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.
or use the force method:
PEAR Web Frontend[edit]For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here. |
RSS feed[edit]
To keep up-to-date with this channel, use the following RSS feed__
.
Notes[edit]
Other Extensions From the same author[edit]
Consult User Jldupont's page.
- ↑ For Widgets created on your wiki, an editor with admin rights must protect the page to prevent editing. Widget pages are not protected by default.
- ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
- ↑ 3.0 3.1 3.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed. - ↑ Modifications to
LocalSettings.phpis only necessary if not using Extension:ExtensionManager
History[edit]
| Release | Notes |
|---|---|
| 1.0.0 | Initial Release |
| 1.0.1 | Widget Feed address change |
