npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

aping-plugin-wikipedia

v0.5.0

Published

Wikipedia plugin for apiNG

Downloads

4

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 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