An export plugin for TILE
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md Updating the readme - setting TILE installation as optional informati… Jan 21, 2011
export1.0.js
exportJSONXML.js Adding JS files Jan 20, 2011

README.md

TILE Export Plugin

Author: Grant Dickie
MITH, 2011

exportJSONXML.js is code taken from the web to transform a generic JSON object into XML.

These instructions assume:

  • You've already loaded the TILE source and are somewhat familiar with it
  • You are familiar with HTML, CSS, and the jQuery javascript API (www.jquery.com)

How the Plugin Works

TILE's PluginController object will go through and initialize each plugin at the start of the engine construction. The Plugin Controller is a private object that can be accessed through the TILE_ENGINE object in tile1.0.js. During the TILE constructor call, PluginController calls the start() function of your plugin and passes an instance of engine to it. Using engine, your code can grab the current JSON session data with engine.getJSON() and start setting up preliminary data.

A variable id is given to identify the plugin from other plugins in PluginController.

In the case of the Export plugin, the start() is used to create the Export Plugin's HTML and attach it to the tag. Then, multiple callbacks and HTML data are parsed out, so that when a user clicks the X, it closes the dialog, or when they click on Export to JSON XML, it actually does this. More about the different functions are listed in the API.

loadJSON() is used by PluginController to send new data to plugins. This is called every time an object is added to the JSON session, or when a new image is being displayed (e.g. A user clicks Prev or Next in the Image Tagger toolbar). If you're plugin needs to have up-to-date data from the JSON session, then use this function and the passed engine variable to get that updated data.

API

  • export1.0.js is a wrapper for TILE. It includes a start() and loadJSON() functions, which are standard for TILE plugin wrappers.

start(engine {Object})
Sets up the necessary elements and function calls. Gets passed engine by default, which is the public version of the TILE source code. (See TILE_ENGINE API for more details)

loadJSON() Not used

transformTEI(xml {String}) Takes passed XML string and parses it into TEI. Returns string representing TEI-formatted XML.

useScript(file {String})

  • exportJSONXML.js includes functionality for changing a JSON Object into an XML string, retaining the JSON Objects hierarchy and tags.

json2xml(obj) Takes a JSON Object obj and outputs an XML string.

Extra: Installing into TILE

I. For including into TILE source:
Make sure to include the necessary header files for TILE, which are for jQuery, the jQuery UI, the jQuery UI ColorPicker plugin, and the TILE 1.0 source: NOTE: Paths are relative to the example shown here, for the actual TILE source, you will use different paths

<!-- CSS styles -->
<link rel="stylesheet" href="style.css" type="text/css" media="screen, projection" charset="utf-8">
<!-- Necessary JS files -->
<script type="text/javascript" language="javascript" src="jquery-1.4.2.min.js"></script>
<script type="text/javascript" language="javascript" src="tile1.0.js"></script>
<script type="text/javascript" src="plugins/colorpicker/js/colorpicker.js"></script>
<script type="text/javascript" src="plugins/colorpicker/js/eye.js"></script>
<script type="text/javascript" src="plugins/colorpicker/js/utils.js"></script>

After adding all of the necessary files into the header, make sure to include

<script type="text/javascript" language="javascript" src="export1.0.js"></script>
<script type="text/javascript" language="javascript" src="exportJSONXML.js"></script>

After adding the necessary files, you will need to insert the Export dialog plugin into the instance of TILE that you are instantiating somewhere in the HTML body or in another script area in the header. Inside export1.0.js, there is a TILE wrapper called ExportTile. The API for this wrapper is listed in the API section of this readme. You need to somehow insert this wrapper into TILE and we do this by adding ExportTile to the TILE_ENGINE constructor in the toolSet array, as shown here:

<script type="text/javascript">
	// Insert the plugin into the TILE_ENGINE toolSet parameter
	var engine=new TILE_ENGINE({toolSet:[ExportTile]});

</script>