Skip to content
This repository has been archived by the owner on Feb 15, 2023. It is now read-only.

Authoring

distobj edited this page Jan 25, 2012 · 12 revisions

Exhibit Authoring

Data

When authoring a Backstage-hosted Exhibit, the data link must be the URL returned from the data upload service as described in the HTTP Interface. Also, unlike with Scripted mode, there can be a maximum of one data link. And finally, the type and charset attributes are unused on the link; only rel and href are required.

Scripts

The Backstage server also self-hosts the Exhibit 3.0 Scripted scripts so you can link to those directly rather than to some separate Exhibit hosting server like api.simile-widgets.org. It is recommended that your Exhibit and Backstage scripts be loaded in one script line like this:

<script src="http://myhost:8181/backstage/exhibit/api/exhibit-api.js?autoCreate=false&backstage=http://myhost:8181/backstage/api/backstage-api.js"></script>

Export

By invoking HTTP GET on the data link URL, Backstage exports uploaded datasets in HTML+RDFa. The intent of this feature is to provide an endpoint where search engines can index the content of an Exhibit; a feature not currently possible using Scripted mode. At the moment - before we've tested the new export code with search engines - the exact mechanism for associating this data with an exhibit so that the search engines report the Exhibit in the results rather than exported data, is unclear, but it is anticipated that an author would use a new link element in the document head like this:

<link rel="alternate" href="http://myhost:8181/backstage/data/my-data-slug" />

Note that the data link URL will by default return the first 20 items. You can attach a limit parameter specifying the number of items you'd like exported, e.g. http://myhost:8181/backstage/data/my-data-slug?limit=100

NOTE

The Backstage server is not intended to host your authored HTML. As an author, you need to place your HTML on your own web server, and modify it according to the instructions above. For this reason, don't expect anything useful to result from visiting Backstage URLs (on port 8181) in your browser.

The "Export" feature above is obviously an exception, but it's not the HTML you're probably expecting. It's just the unstructured data in a crude form suitable primarily for search engines with no means of customization.

Clone this wiki locally