Trove on your site

Adding a Trove search widget to your website

Trove search is easy to add to your own website. Just copy and paste the code below into the HTML of your web page.

<!--Start Trove Search -->
  <iframe src="http://trove.nla.gov.au/static/searchbox/search_s.html" name="trovesearchframe" scrolling="no" marginwidth="0" marginheight="0" frameborder="0" style="width: 11em; height: 7em;">
    <a href="http://trove.nla.gov.au">Search Trove</a>
  </iframe>
<!--End Trove Search -->

You will then have your own fully functional Trove search box that looks like this (try it, it works!):

Customising your Trove search widget

You can customise Trove search widget by adding extra parameters and limits to the 'src=' URL in the code.

For example, to search in a particular Trove zone – say, Pictures, photos and objects – add a question mark, then the zone tab name, like this:

 src="http://trove.nla.gov.au/static/searchbox/search_s.html?tab=picture"

The zone tab names are: book, picture, article (for the Journals, articles and datasets zone), newspaper, music, map, collection (for the Diaries, letters, archives zone), website, people, list.

You can also add limits to focus the search even more.

For example, to search within a single newspaper title – say, The Sydney Morning Herald (http://nla.gov.au/nla.news-title35) – add a further title number limit ('&l-title=') to the end of the 'src=' URL, plus the title number of the newspaper:

You can find the newspaper title number at the end of the title's URL on the Newspaper Titles page.

Here is what the customised URL for searching The Sydney Morning Herald would look like in the code:

<!--Start Trove Search -->
  <iframe src="http://trove.nla.gov.au/static/searchbox/search_s.html?tab=newspaper&l-title=35"
name="trovesearchframe" scrolling="no" marginwidth="0" marginheight="0"
frameborder="0" style="width: 15em; height: 7em;">
    <a href="http://trove.nla.gov.au">Search Trove</a>
  </iframe>
<!--End Trove Search -->

You can also use other available limits using the pattern '&l-<limit name>=<limit value>'. The general limit names are: format, availability, decade, year, language, and australian.

For other supported limits for particular zones, refer to the List of supported facets in the Trove API guide.

Widget instructions for content partners

Widgets can be created and configured on our widgets web page

Choose the type of widget you want to create by clicking on one of the tabs under the 'Choose a widget type' heading.

Summary widgets display the details of one or more newspapers, or those for a particular state.

Newspaper navigator widgets show a filterable list of state newspapers.

Usage summary widgets show usage statistics for particular papers.

You can see examples of all the different types of widgets in the examples section.

Select the criteria the widgets should use to filter titles

You can select one title, multiple titles or all the titles from a particular state. To select all the titles from a state, check the tick box next to the desired state. If you would like to select a custom set of titles then click on the newspaper list box located under the list of states, and then select the titles you wish to add to the widget.

Add a heading and any other credit type information to the widget by filling in the 'Heading' and 'Credits' fields located under the Newspaper title drop down list. These options are really useful for users as it allows them to add information about their organisation

Customise the widget. You can choose to customise the appearance of the widget, you might want to use the colours of your organisation or just use colours you like. You can customise the colours of the heading and credit fields as well as the background colour, text colour and title colour.

Click on the 'Apply' button located at the bottom of the widget configuration settings.

A preview of the widget will then be displayed and code generated that you can insert into a web page. Code for a script and for an iframe will be generated.

Decide where on your website you would like to display your widget(s). You might choose a public facing page for a navigation or summary widget, and an internal site for a usage widget. There is no right or wrong answer, you can place the widgets wherever you like! Copy the code and paste it into your webpage.

Widget instructions for developers

One of the reasons we developed the newspaper widgets is to demonstrate to developers what can be done with the Trove API.

If you are interested in contributing to the code or building on what we have already done then

The code can be downloaded from github, detailed technical instructions can be found on the github site;

Submit a contact us request and ask us for a Trove API key and/or a Google Analytics key;

We love hearing about how people are using Trove's API, get in contact with us and let us know what you're working on;

Check out our application gallery to see what other developers have built with Trove's API.