Intel Web APIs Registry Widget Documentation and Examples

This widget provides an easy way for sites that follow and discuss Web APIs to embed the Intel Web APIs registry. The Intel Web APIs registry contains a list of Intel's Web APIs, widgets and Mashups.
This widget is running on the Intel Web APIs home page.

Contents

Embedding the widget in your page

Here is the HTML & JavaScript to get the widget up and running.

  <div id="IntelWebAPIs_div"></div>
  <script type="text/javascript" 
    src="/sites/whatif/webapis/IntelWebAPIsRegistry.js"></script>
  <script type="text/javascript">
    (function(){
      var webApiRegistryCtrl = new IntelWebAPIsRegistryWidget('IntelWebAPIs_div',{'statusbar':false});
    })();
  </script>

This HTML & JavaScript changes how many columns are displayed using the 'maxcolumns' configuration option.

  <div id="IntelWebAPIs_div"></div>
  <script type="text/javascript" 
    src="/sites/whatif/webapis/IntelWebAPIsRegistry.js"></script>
  <script type="text/javascript">
    (function(){
        var webApiRegistryCtrl = new IntelWebAPIsRegistryWidget('IntelWebAPIs_div',
          {'maxcolumns':1,'statusbar':false});
    })();
  </script>

Accessing the Intel Web API Registry data directly

You can add a script node to your page as follows and then access the data through a JavaScript Object. This javascript object is the same data that is available in the JSON data below.


  <script type="text/javascript" 
    src="/sites/whatif/webapis/IntelWebAPIsRegistryData.js"></script>
  <script type="text/javascript">
    (function(){
        var regDataObj = new IntelWebAPIsRegistryData();
        //do something with regDataObj or inspect in a DOM debug tool
        //window.check_this_stuff = regDataObj;
    })();
  </script>

You can also access the JSON data directly. This might be useful from server side PHP code or even stand alone app code can can handle JSON.

  /sites/whatif/webapis/intelwebapis_reg.json

This is the data that is available as JSON or through IntelWebAPIsRegistryData.js:

  registry_data = {
    'version'   : string, // format major.minor.patch, ex: '1.0.0'
    'language'  : string, // language ex: en-us

    //array of strings
    //unique identifier of the api or widget or mashup in the registry
    //for each name in this array there is a key 
    //with the same value in the details object below
    'names'     : [
      string,
      //more names ...
    ],

    //details object : each key in this object matches a name in the names
    //array above.
    'details'   : {
      'entry_name' : {                // unique identifier of this entry - same as value in names array.
        'uid'           : string,     // unique identifier of this entry - 
                                      //   same as name 'string_name' of this object
        'type'          : string,     // type of this entry: api|widget|mashup
        'friendly_name' : string,     // friendly text name of entry
        'friendly_desc' : string,     // long description of entry
        'version'       : string,     // major.minor.patch_string
        'add_date'      : string,     // date formated as '02/09/2010'
        'update_date'   : string,     // date formated as '02/09/2010'
        'website'       : string,     // url for website of this entry
        'license'       : string,     // url of the license / terms of entry
        // archive object:
        // contains paths to plugin archives for OS/plugin type combinations
        'archive' : {
          'win32-npapi' :'./api/cpu/cpu-win32-npapi.iwa',
          'win32-ie'    :'./api/cpu/cpu-win32-ie.iwa',
          'mac'         :''
        },
        'imgs' : {
          'thumb'       : string,     // file name of thumbnail for this entry    - relative to website url
          'screenshot'  : string,     // file name of screen shot for this entry  - relative to website url
        }        
        //more entries ...
      },
    }
  }

Browser and Device Compatibility

The table below lists compatability notes for browser and operating system combinations. This widget is currently beta quality.

BrowserOperating SystemNotes
Firefox 3.5.x, 3.6.x Windows (XP, Vista, Win 7) Seems to be working well.
Chrome 4.0.x.y Windows (XP, Vista, Win 7) Seems to be working well.
Opera v 10.x Windows (XP, Vista, Win 7) Seems to be working well.
Internet Explorer 8.x (compatibility view OFF) Windows (XP, Vista, Win 7) Seems to be working well.
Safari 4.0.x Windows (XP, Vista, Win 7) Seems to be working well.
Firefox, Chrome, Safari Linux, MacOS Not tested yet - but "should work" ;) More to be done here in the future.



See it working in this page!
Tags:
For more complete information about compiler optimizations, see our Optimization Notice.