aping-plugin-wikipedia

Wikipedia plugin for apiNG

Usage no npm install needed!

<script type="module">
  import apingPluginWikipedia from 'https://cdn.skypack.dev/aping-plugin-wikipedia';
</script>

README

apiNG

Join the chat at https://gitter.im/JohnnyTheTank/apiNG npm version Bower version

apiNG-plugin-wikipedia is a wikipedia API plugin for apiNG.

Information

Documentation

  1. INSTALLATION
    1. Get file
    2. Include file
    3. Add dependency
    4. Add plugin
  2. USAGE
    1. Models
    2. Requests

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

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 items
per request
(native) default items
per 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