Extension:AkAPI

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
AkAPI

Release status: beta

Implementation API, Search
Description Extends the SMW (Semantic MediaWiki) API with support for #ak queries
Author(s) Hermann S. (Pixilabtalk)
Latest version 1.0 (2012-07-12)
License GPLv3
Download AkAPI_1.0.zip
Parameters

$wgAkAPI_ActionName

Translate the AkAPI extension if possible

Check usage and version matrix; code metrics

The AkAPI extension allows you to retrieve information from SMW in XML-Format such as:

  • 1. A list of Attributes used in a Wiki-Category
  • 2. A list of Attributes used on a Wiki-Page
  • 3. A list of Attribute-Values for a certain Attribute
  • 4. Possibility to search for pages using attributes and attribute-values.

Usage[edit | edit source]

Please read the explanation in your API-description.

Usage-Example
  • api.php?action=ak&cat=CATEGORY&get=attributes
  • api.php?action=ak&sub=PAGE&get=attributes
  • api.php?action=ak&get=ATTRIBUTE
  • api.php?action=ak&get=[[ATTRIBUTE1::VALUE1]][[ATTRIBUTE2::VALUE2]]||[[ATTRIBUTE3::VALUE3]]
  • Type cat=YOUR_CATEGORY to get all attributes for a certain category.
  • Type sub=YOUR_PAGE to get all attributes for a certain page.
  • Type get=ATTRIBUTE to get all attribute-values for a certain attribute.
  • Type get=[[ATTRIBUTE1::VALUE1]][[ATTRIBUTE2::VALUE2]]||[[ATTRIBUTE3::VALUE3]] to start an attribute-based search.

Dependencies[edit | edit source]

This extension depends on Semantic MediaWiki to work. Versions: 1.5-1.7.1 of Semantic MediaWiki are supported.

Source Code[edit | edit source]

AkAPI can also be downloaded over a GIT-Repository at http://code.google.com/p/tk-pixilab-mediawiki-akapi