WikiTracer : WTPluginDraft

About :: Browse :: PageIndex :: RecentChanges :: RecentlyCommented :: Login/Register
Home

WT Plugin Data Format

Draft version: v0.4

This is a draft specification for the WT data format (validated against the WT XML Schema).

Sample response

See also

<?xml version="1.0" encoding="UTF-8"?>
<wt:rsp xmlns:wt="http://wikitracer.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://wikitracer.com http://wikitracer.com/xsd/0.4/wt.xsd">
    <ts>2009-07-17T12:20:29-05:00</ts>
    <wtformat>0.4</wtformat>
    <wtplugin>wt_wikkawiki_0.4</wtplugin>
    <wiki wid="1">
        <title>Wikka</title>
        <url>http://wikkawiki.org/</url>
        <engine_type>1</engine_type>
        <engine_version>1.1.6.0</engine_version>
        <age>
            <first_edit>2004-03-07T15:08:46-06:00</first_edit>
            <last_edit>2009-07-14T22:05:11-05:00</last_edit>
        </age>
        <pop>
            <users>4112</users>
            <admins>9</admins>
        </pop>
        <cont>
            <pages>1663</pages>
            <good>1663</good>
            <wanted>42</wanted>
            <orphaned>14</orphaned>
            <namespaces>-1</namespaces>
            <comments>4152</comments>
            <files>15</files>
            <edits anon="10000" user="9000" admin="660">19660</edits>
        </cont>
        <del>
            <pages>-1</pages>
            <users>-1</users>
        </del>
        <access>
            <anon_edit>1</anon_edit>
            <anon_readable_pages>1598</anon_readable_pages>
            <anon_writable_pages>0</anon_writable_pages>
            <user_readable_pages>1608</user_readable_pages>
            <user_writable_pages>1520</user_writable_pages>
        </access>
    </wiki>
</wt:rsp>


Data type specification

Note
Fields that are disabled or not available in the client wiki should have a -1 value. A value of 0 means that the field is enabled and the actual count is equal to zero.

System information


System information fields
nametyperequired?description
tsstringrequired ISO 8601 timestamp
wtpluginstringrequired wt plugin version
wtformatstringrequired wt plugin response format

Wiki information


Wiki information fields
nametyperequired?description
widintrequired WT Unique identifier of client wiki
titlestringrequired Name of client wiki
urlstringrequired Base URL of client wiki
engine_typeintrequired WT id for supported engine
engine_versionstringrequired engine version

Wiki data


Age (age)


age data fields
nametyperequired?description
first_edittimestampoptionalISO 8601 timestamp of the oldest edit in the wiki.
last_edittimestampoptionalISO 8601 timestamp of the most recent edit in the wiki at the time of the response.


Population (pop)


Population data fields
nametyperequired?description
usersintoptionalNumber of active registered users, including administrators
adminsintoptionalNumber of wiki admins, including moderators or users with other formal content managing roles

Content (cont)


Content data fields
nametyperequired?description
pagesintoptionalNumber of pages (including system or special pages)
goodintoptionalNumber of real content pages (excluding system or special pages)
wantedintoptionalNumber of WantedPages or missing pages linked to from other wiki pages
orphanedintoptionalNumber of OrphanedPages or pages not linked from any other wiki page
talkintoptionalNumber of talk pages
namespacesintoptionalNumber of available namespaces
commentsintoptionalNumber of comments
filesintoptionalNumber of files uploaded
editsintoptionalTotal number of edits
edits.anonintoptionalTotal number of edits by unregistered users (if any)
edits.userintoptionalTotal number of edits by registered users (if any)
edits.adminintoptionalTotal number of edits by superusers, including admins (if any)

Moderation (del)

Moderation data fields
nametyperequired?description
pagesintoptionalNumber of pages removed
usersintoptionalNumber of users banned

Access (access)

Access configuration fields
nametyperequired?description
anon_edit[0,1]optionalAnonymous editing allowed
anon_readable_pagesintoptionalNumber of pages readable to anonymous users
anon_writable_pagesintoptionalNumber of pages write-accessible to anonymous users
readable_pagesintoptionalNumber of pages readable to registered users
writable_pagesintoptionalNumber of pages write-accessible to registered users


CategorySpecs
flat flat threaded
Comments [Hide comments]
Comment by JavaWoman
2008-09-16 11:40:43
The response XML format could be considerably improved by not putting *content* in the response into *attributes*: a logically better design would put them as actual data elements as children of the parent they are now an attribute of.

This would also enable an alternative response format as JSON data.

(It would also help if this comment form didn't "lose" the page content it is a comment for - being able to refer to content you are commenting on is essential, imo.)
Comment by JavaWoman
2008-09-16 11:42:28
It would help even more if comments weren't formatted as italic text, because this is hard to read; italics should be limited to a a few words or short phrases.
Comment by DarTar
2008-09-16 12:39:17
fixed
Comment by DarTar
2008-09-16 12:35:58
Yes, I agree - the final draft will probably reduce the use of attributes to a minimum.

Re: the possibility of displaying the page on top of the comment form, you should drop a line to Brian, who's the author of this change ;)
Comment by JavaWoman
2008-09-16 11:44:47
I don't understand the "moderation" data. Why only delete? Reverts can be moderation, too. And I'm missing data about moderated files and comments.
Comment by DarTar
2008-09-16 12:40:45
The point is whether this data is logged and can be pulled from the wiki. It'd be great to add new moderation-related data but they'd need to be: (1) computable and (2) supported by a sufficient number of engines.
Comment by JavaWoman
2008-09-16 12:58:46
So start with what /could/ be logged, and then document for each wiki what actually is available
Comment by JavaWoman
2008-09-16 11:48:56
Content - total number of edits:
shouldn't this be broken down into page edits, comment edits and file edits?
Comment by DarTar
2008-09-16 12:43:09
At the moment, this refers to "page edits" as this is the only notion of an edit I know that is shared by all wikis. "Comments edits" are already taken into account by the content > comments field (assuming that comment editing is not allowed, to be checked on a per-engine basis). Same for "file edits" but I'm happy to add this if there's sufficient support from different engines.
Comment by JavaWoman
2008-09-16 13:01:09
Why shared by all wikis? WikiMedia at least has a concept of file edits, and (although different than our comments) editing comments as well (via talk pages).

This sounds too "lteral" to me, abstract it and you'll find more commonality, I'm sure. And you don't need data that is shared by all - just shared by some.
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.2095 seconds