User:PerfektesChaos/js/versionControl

JavaScript which automatically maintains lists with resource version identification.

The list ist formatted as JavaScript source code. By loading into some context the content is directly available then somewhere else.

Usage

Just load the js file within your user script:

mw.loader.load("//wiki.riteme.site/w/index.php?title="
               + "User:PerfektesChaos/js/versionControl/r.js"
               + "&action=raw&ctype=text/javascript",
               "text/javascript");

Standard execution will be performed automatically.

All articles (typically JavaScript or CSS) are checked whether the corresponding list entry is still up to date. If not, the list script will be modified automatically after all, within some 15 or 10 seconds.

In order to get permission for editing it is necessary to be logged in when executing the script.

Loading and execution may be linked to the situation of viewing some resources in the list. This happens immediately after saving the resource. Unfortunatey, there is no after-save-hook in the editing process.

The script is designed to be used across wiki domains. Within the same wiki a query for revision ID via API would be straight, which is denied for cross site security reasons.

Format

1. Every entry is one array with three elements:
   1. Path to article (resource)
      • Currently and by default it points to a sub page of the current user.
   2. Revision ID revid or curid of the latest resource version.
   3. Time stamp (ISO 8601)
2. The list of entries is stored as an array.
3. The first entry of this array is an array with one element, a string. It is set to the most recent update of the list.

mw.libs.versionControl.proj.enwiki.PerfektesChaos.rv = [
["Fri, 11 Mar 2011 19:06:55 GMT"],
["js/versionControl/d.js",418336805,"2011-03-11T19:02:06Z"],
["js/versionControl/r.js",418337480,"2011-03-11T19:06:50Z"],
... ];

Example

• versionControl.js

Configuration

All variables have default values, but may be adjusted to particular requirements.

For user specification an application object ist to be defined (best before mw.loader.load) by:

mw.libs.versionControl  =  { opt:  { store:  "User:Usy/vc.js",
                                     signer: "Usy",
                                     symbol: "myVersions"
                                   }
                           };

.opt.store

Location of the list script.

Default: User:wgUserName/versionControl.js

.opt.signer

Nickname for the hosting user.

Default: wgUserName

.opt.symbol

Name of a particular global variable which has to be declared as an object (that includes Array) in advance.

Default: see VersionInfo

VersionInfo

Current version information is available as object at

• .proj[DBNAME][Nick].rv

• DBNAME – wgDBname, like enwiki
• Nick – .opt.signer

• ….rv is just the Array read from stored list page.

Codes

ResourceLoader

Module ID:

• user:PerfektesChaos/versionControl

Sources

• r.js – compressed code for loading
• d.js – commented code for reading by human beings

[ German page ]