As an anonymous user, you can only add new data. If you would like to also modify existing data, please create an account and indicate your languages on your user page.

User:Hiong3.eng5/OmegaWiki API Roadmap

From OmegaWiki
Jump to: navigation, search

OmegaWiki Roadmap

Current version: 1.0
Target version:1.1

Goal[edit]

Improve upon the current OmegaWiki API 1.0

This can be used by individual contributors, who have programming knowledge, to access the OmegaWiki database indirectly. Can also be used to create Firefox OS app.

Also create (long term goal):

  • accessOmegaWikiWebAPI.js
  • accessOmegaWikiWebAPI.php
  • accessOmegaWikiWebAPI.pl

with these module/class, it would be easier for people to use our API, these should use JSON format.

API action[edit]

v1.1 ow_get_dmid

description: get defined meaning (concept ) id.
parameters:
 ?

Milestone[edit]

  • 2014-02-30 Started Planning.

Bugs[edit]

1.0[edit]

  • ow_syntrans parameter part: any mispelling was ignored.
any mispelling must generate an error message.
correct values are syn and trans
  • ow_syntrans does not generate the dmid.
Problem: with javascript, it becomes hard to link the syntrans output to the proper concept.

Class/Modules[edit]

JavaScript[edit]

omegawiki-webapi-1.0.js

Class AccessOmegaWikiReadWebAPI, a read only webapi class used to access OmegaWiki.
Methods:
AccessOmegaWikiReadWebAPI.getExpress( spelling )
AccessOmegaWikiReadWebAPI.getDefine( definedMeaning, [] )
AccessOmegaWikiReadWebAPI.getSyntranslate(definedMeaning, [ lang: languageId, part:syn/trans e:expression] )

Perl[edit]

PHP[edit]