aping-plugin-wikipedia
v0.5.0
Published
Wikipedia plugin for apiNG
Downloads
3
Maintainers
Readme
apiNG-plugin-wikipedia is a wikipedia API plugin for apiNG.
Information
- Supported apiNG models:
social
- This plugin supports the
get-native-data
parameter - Used promise library: angular-wikipedia-api-factory (included in distribution files)
Documentation
- INSTALLATION
- Get file
- Include file
- Add dependency
- Add plugin
- USAGE
- Models
- Requests
1. INSTALLATION
I. Get file
Install via either bower, npm, CDN (jsDelivr) or downloaded files:
bower install apiNG-plugin-wikipedia --save
npm install aping-plugin-wikipedia --save
- use CDN file
- download apiNG-plugin-wikipedia.zip
II. Include file
Include aping-plugin-wikipedia.min.js
in your apiNG application
<!-- when using bower -->
<script src="bower_components/apiNG-plugin-wikipedia/dist/aping-plugin-wikipedia.min.js"></script>
<!-- when using npm -->
<script src="node_modules/aping-plugin-wikipedia/dist/aping-plugin-wikipedia.min.js"></script>
<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/aping.plugin-wikipedia/latest/aping-plugin-wikipedia.min.js"></script>
<!-- when using downloaded files -->
<script src="aping-plugin-wikipedia.min.js"></script>
III. Add dependency
Add the module jtt_aping_wikipedia
as a dependency to your app module:
angular.module('app', ['jtt_aping', 'jtt_aping_wikipedia']);
IV. Add the plugin
Add the plugin's directive aping-wikipedia="[]"
to your apiNG directive and configure your requests
<aping
template-url="templates/social.html"
model="social"
items="20"
aping-wikipedia="[{'search':'germany'}]">
</aping>
2. USAGE
I. Models
Supported apiNG models
| model | content | support | max itemsper request | (native) default itemsper request |
|----------|---------|---------|--------|---------|
| social
| articles | full | 500
| 10
|
support:
- full: the source platform provides a full list with usable results
- partly: the source platfrom provides just partly usable results
II. Requests
Every apiNG plugin expects an array of requests as html attribute.
Get Article by Name
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| title
| Association football
| | Existing wikipedia page | no |
| language
| de
| en
| Shorthandle of existing wikipedia project | yes |
Sample requests:
[{'title':'International System of Units'}, {'title':'Metrication in the United States'}]
[{'title':'Metrologie', 'language':'de'}]
Search Articles
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| search
| soccer
| | Text to search | no |
| textSearch
| true
| false
| Search in title and content | yes |
| items
| 25
| 10
| Items per request (0
-500
) | yes |
| language
| de
| en
| Shorthandle of existing wikipedia project | yes |
Sample requests:
[{'search':'fc bayern'}, {'search':'read madrid'}]
[{'search':'ozean', 'textSearch':'true', 'items':20, 'language':'de' }]
Licence
MIT