Viral Analytics: Embedding Voyeur in Other Sites

This page is for a manual on how to embed analytics. Tentative outline:

Voyeur Plugins

Voyeur is designed to function as a standalone environment (voyeurtools.org) or as a set of more independent modules that can be embedded into remote sites (much like a YouTube clip). Technically, this is done using an iFrame tagA tag, also called an element, is characteristically used within HTML and XML to apply characteristics (such as headings, paragraphs or user-defined categories) or metadata to a document, usually a text. HTML and XML tags generally appear in matching pairs of an opening and a closing tag, with text in between. All text within a tag pair is modified by that tag, and one tag pair may be nested inside another. In the case of HTML, tags are used to format a text directly, or as a delimiter for CSS formatting to the text within that tag. An HTML paragraph tag: < p >< /p > In the case of XML, tags may be also be used as a delimiter for CSS formatting to the text within that tag, but its primary purpose is to apply metadata to that text. Ex: < book format="hardcover" >< /book > Both HTML and XML tags may be modified with attribute/value pairs. In the above example, format="hardcover" is the attribute/value pair modifying the tag < book >. Return to Glossary. that creates a sandbox within your page where Voyeur can do its thing (JavascriptJavaScript is a scripting language often used to create interactive features in a web site. In the TAPoRware and Voyant toolsets, JavaScript is used to generate interactive graphs and other dynamic output elements. For more information, see the Wikipedia. Return to Glossary. security limits the interaction that's possible between your page and Voyeur).

The Voyeur plugins essentially allow you, as a site administrator, to define options to allow the user to view tool results, based on the the current content (the current page) or more specific content based on your content management system (all the WordPress posts with a given tagA tag, also called an element, is characteristically used within HTML and XML to apply characteristics (such as headings, paragraphs or user-defined categories) or metadata to a document, usually a text. HTML and XML tags generally appear in matching pairs of an opening and a closing tag, with text in between. All text within a tag pair is modified by that tag, and one tag pair may be nested inside another. In the case of HTML, tags are used to format a text directly, or as a delimiter for CSS formatting to the text within that tag. An HTML paragraph tag: < p >< /p > In the case of XML, tags may be also be used as a delimiter for CSS formatting to the text within that tag, but its primary purpose is to apply metadata to that text. Ex: < book format="hardcover" >< /book > Both HTML and XML tags may be modified with attribute/value pairs. In the above example, format="hardcover" is the attribute/value pair modifying the tag < book >. Return to Glossary., for instance).

Currently the content is fetched once, based on the URLA URL (Uniform Resource Locator), sometimes called a web address, is used to locate and identify web content. For more information, see the Wikipedia. Return to Glossary., indexed, and stored in Voyeur so that subsequent requests are faster. We don't currently have an easy way to update or purge a corpus, but that will come.

The Voyeur plugins below should be considered alpha code – use at your own risk and expect changes (but please do use! :).

Drupal Plugin

Please note:

  • we intend to release the Voyeur Drupal Plugin through the Drupal modules site, but while we do some initial testing, it will only be available via GitHub
  • this plugin was designed specifically for Drupal 6.x. Other versions have not been used or tested

To install the Voyeur Drupal Plugin from GitHub:

  • Navigate to http://github.com/mcds/Voyeur-Drupal-Plugin and at the top-right of the page, click on 'Downloads'. Download the plugin source files as whatever format you like.
  • Extract the source files and copy the contents of the folder 'mcds-Voyeur-Drupal-Plugin-xxxxxxx' to a new folder entitled 'voyeur' in Drupal > sites > all > modules. (If this folder structure does not yet exist, create it.)
  • Log into your Drupal installation and navigate to Administer > Site building > Modules. Check the 'Enabled' box next to the module and then click the 'Save Configuration' button at the bottom.
  • To change Voyeur specific settings, navigate to Administer > Site configuration > Voyeur module settings.
  • For more information, consult the readme included with the Voyeur package. There is also a good article on installing Drupal modules here: http://drupal.org/getting-started/install-contrib/modules.
  • For bug reports and feature requests, please leave a comment at http://hermeneuti.ca/voyeur/plugins/drupal

OJS Plugin

To install the Voyeur OJS Plugin from Git:

  • Navigate to http://github.com/mcds/Voyeur-OJS-Plugin and at the top-right of the page, click on 'Downloads'. Download the plugin source files as whatever format you like.
  • Extract the source files and copy the contents of the folder 'mcds-Voyeur-OJS-Plugin-xxxxxxx' to a new folder entitled 'voyeur' in OJS > plugins > generic.
  • Log into the administrative panelWeb frameworks like the TAPoR Portal organize information into panels (sometimes called portlets or coplets.) These can me minimized, maximized and closed using the three buttons in the upper left-hand corner of the panel. With Voyant you can export panels of results and place them into other web sites. Return to Glossary. within your OJS installation and click on 'Journal Manager' for the journal you would like to install Voyeur within.
  • Under 'Management Pages' find 'System Plugins' and then find the Voyeur plugin. Click 'enable'. Then click 'settings' to adjust Voyeur specific settings.
  • For more information, consult the readme included with the Voyeur package.
  • For bug reports and feature requests, please leave a comment at http://hermeneuti.ca/voyeur/plugins/ojs

 

WordPress Plugin

Please note: we intend to release the Voyeur WordPress Plugin through the WordPress widgets site (which will facilitate future upgrades of the plugin), but at the moment, as we do some preliminary testing, we will release the plugin through GitHub.

To install the Voyeur Wordpress Plugin from GitHub:

  • Navigate to http://github.com/mcds/Voyeur-WordPress-Plugin and at the top-right of the page, click on 'Downloads'. Download the plugin source files as whatever format you like.
  • Extract the source files and copy the contents of the folder 'mcds-Voyeur-WordPress-Plugin-xxxxxxx' to a new folder entitled 'voyeurWP' in Wordpress > wp-content > plugins.
  • Log into the administrative panelWeb frameworks like the TAPoR Portal organize information into panels (sometimes called portlets or coplets.) These can me minimized, maximized and closed using the three buttons in the upper left-hand corner of the panel. With Voyant you can export panels of results and place them into other web sites. Return to Glossary. within your Wordpress installation and click on 'Plugins'. Find the Voyeur plugin and enable it.
  • Add the Voyeur widget within the widgets menu in the administrative panelWeb frameworks like the TAPoR Portal organize information into panels (sometimes called portlets or coplets.) These can me minimized, maximized and closed using the three buttons in the upper left-hand corner of the panel. With Voyant you can export panels of results and place them into other web sites. Return to Glossary.. (Appearance > Widgets) (This is achieved by clicking and dragging the Voyeur widget across to the panelWeb frameworks like the TAPoR Portal organize information into panels (sometimes called portlets or coplets.) These can me minimized, maximized and closed using the three buttons in the upper left-hand corner of the panel. With Voyant you can export panels of results and place them into other web sites. Return to Glossary.. For more information, please see http://support.wordpress.com/widgets/)
  • Adjust Voyeur specific settings within the widget panelWeb frameworks like the TAPoR Portal organize information into panels (sometimes called portlets or coplets.) These can me minimized, maximized and closed using the three buttons in the upper left-hand corner of the panel. With Voyant you can export panels of results and place them into other web sites. Return to Glossary..
  • For more information, consult the readme included with the Voyeur package.
  • For bug reports and feature requests, please leave a comment at http://hermeneuti.ca/voyeur/plugins/wordpress