...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.js"></script> <script type="text/javascript" src="//vocabs.andsardc.orgedu.au/apps/assets/vocab_widget/js/vocab_widget_v2.js"></script> <link rel="stylesheet" type="text/css" href="//vocabs.andsardc.orgedu.au/apps/assets/vocab_widget/css/vocab_widget_v2.css" /> |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script type="text/javascript" src="//vocabs.andsardc.orgedu.au/assets/core/lib/qtip2/jquery.qtip.js"></script> <link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/qtip2/2.2.1/basic/jquery.qtip.min.css" media="screen" /> |
| Note |
|---|
The code generated for tree mode by the Widget Explorer requires qTip2. When incorporating the results of the Widget Explorer, make sure to include the content from both of the code blocks given above. |
...
Add widget input and initialisation code into your HTML document’s <body>...</body> section. The input/initialisation code selects the vocabulary, input mode, and other parameters. Write the code yourself, based on the instructions in the following sections, or use the Widget Explorer to generate it for you.
| Note |
|---|
You can combine the two approaches: use the Widget Explorer to generate boilerplate input/initialisation code, then customise it to suit your needs. |
...
| Property | Defaults | Description | ||||||
|---|---|---|---|---|---|---|---|---|
api_key | "public" | The API key you have previously been issued. Please request an API key by emailing | ||||||
mode | "" |
| ||||||
repository | "" |
| ||||||
max_results | 100 | At most, how many results should be returned? Note: the vocabulary's SISSVoc configuration may override this option by applying a lower (but not a higher) maximum limit. At present, the SISSVoc configuration of most vocabularies specifies a maximum limit of 200 results. | ||||||
cache | true | Cache SISSVoc responses? | ||||||
error_msg | "ANDS Vocabulary Widget ↵ | Message title to display (via a JavaScript alert() call) when an error is encountered. Set to false to suppress such messages | ||||||
endpoint | "https://vocabs.andsardc.orgedu.au/↵ | Location (absolute URL) of the "back end" of the widget (an interface to SISSVoc that generates responses in JSONP). |
...
status:OKif all good, something else (most likelyERROR) if notmessage: description of the underlying system call by default, or information on status when something went wronglimit: the maximum number of records requesteditems: an array of SISSVoc vocabulary items:definition: item descriptionlabel: item labelabout: item definition / URLbroader: parent term (if it exists)narrower: child terms (if they exist, otherwise boolean false)count: frequency of use among ARDC registry objects (experimental; requires endpoint to be set to"http://researchdata.ands.orgedu.au/apps/vocab_widget/proxy/"; works best on ANZSRC-FOR, not so well on RIF-CS)
count: the number of items returned
