| Index: trunk/extensions/XMLRC/README |
| — | — | @@ -0,0 +1,48 @@ |
| | 2 | +XMLRC is designed to push notifications about changes on the wiki to listeners, |
| | 3 | +in a way that makes it easy to process this information. To this end, XMLRC |
| | 4 | +sends UDP-packets containing XML formated notifications. The XML contains |
| | 5 | +<rc>-tags exactly like those generated by the web API when asked to list |
| | 6 | +recentchanges. This way, anyone interested in changes on the wiki can simply |
| | 7 | +listen to these notifications instead of constantly polling the web API. |
| | 8 | + |
| | 9 | +Detailed documentation is available at |
| | 10 | +<http://www.mediawiki.org/wiki/Extension:XMLRC>. |
| | 11 | + |
| | 12 | +XMLRC itself will only emit UDP packets, but it comes with some extra components |
| | 13 | +that allow the use of XMPP for transport: |
| | 14 | + |
| | 15 | +* A UDP to XMPP bridge, udp2xmpp.py, located in the directory 'bridge'. See |
| | 16 | +<http://www.mediawiki.org/wiki/Extension:XMLRC/udp2xmpp.py> for details. |
| | 17 | +* XMPP client library, aware of the extra RC data in the XMPP messages, |
| | 18 | +rcclient.py, located in the directory 'client'. See |
| | 19 | +<http://www.mediawiki.org/wiki/Extension:XMLRC/rcclient.py> for details. |
| | 20 | +* A UDP generator for testing, rc2udp.py, located in the directory 'generator'. |
| | 21 | +See <http://www.mediawiki.org/wiki/Extension:XMLRC/rc2udp.py> for details. |
| | 22 | + |
| | 23 | +TODO: |
| | 24 | +* Add a utility to easily create MUC rooms for publishing RC events |
| | 25 | +* Add support for XMPP PubSub, which is more suitable for this application than |
| | 26 | + MUC. However, PubSub is complex, not supported by all servers and only by a |
| | 27 | + few client libraries. |
| | 28 | +* Implement service that allows arbitrary queries to the MediaWiki API via |
| | 29 | + Jabber (using iq requests, perhaps?) |
| | 30 | +* use an XML namespace on the <rc> tag, see bugzilla:24781 |
| | 31 | +* improve support for nested tags in rcclient.RecentChange |
| | 32 | + |
| | 33 | + |
| | 34 | + |
| | 35 | +Copyright (c) 2010, Wikimedia Deutschland; Author: Daniel Kinzler |
| | 36 | +All rights reserved. |
| | 37 | + |
| | 38 | + This program is free software: you can redistribute it and/or modify |
| | 39 | + it under the terms of the GNU General Public License as published by |
| | 40 | + the Free Software Foundation, either version 3 of the License, or |
| | 41 | + (at your option) any later version. |
| | 42 | + |
| | 43 | + This program is distributed in the hope that it will be useful, |
| | 44 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
| | 45 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| | 46 | + GNU General Public License for more details. |
| | 47 | + |
| | 48 | + You should have received a copy of the GNU General Public License |
| | 49 | + along with this program. If not, see <http://www.gnu.org/licenses/>. |