View on GitHub


A digital repository providing a single platform to house your teaching and learning, research, media, and library content.


Discoverability Guide

Table of Contents

Search Engine Optimization

Search engine optimization, commonly referred to as SEO, is the process of increasing a website’s search ranking so it appears more times in search results and thus increases the number of visitors to the site. Search engines are used to discover content and information, so ensuring that your content is correctly optimized for search engines is vital if you wish people to be able to discover your website.

This guide is divided into three sections: openEQUELLA Configuration, Increasing Discoverability and Google Scholar. The first section provides information on how to configure your openEQUELLA instance in order to optimize its discoverability through common search engines, such as Google. The second section contains guidelines on steps that can be performed to increase your openEQUELLA instance’s presence and discoverability on the web. The third section covers the requirements for content inclusion in Google Scholar.

openEQUELLA Configuration

In order to ensure that your content is publically discoverable, it will need to have appropriate security permissions set in order to allow it to be discovered. That is, DISCOVER_ITEM and VIEW_ITEM privileges set to ‘Everyone’.

Google cannot access your content if these permissions are not set, even if you have auto-login turned on, as the Googlebot does not store cookies and will always be redirected to the login page.

Use scripting to configure description meta tag information

To customize or ensure that Google displays the correct description for your resources in its search results, you can use the description meta tag to inform Google of the correct text. This can be achieved with scripting by going to the Admin Console Collection Definitions Display, and adding a new Scripting item summary display template.

In the Pre-load Javascript section, you can use the ‘meta’ script object to add custom meta tags, for example:

meta.add("description", xml.get("/item/description"));

This will add a new description meta tag to the page with the content of the items /item/description field. Now when Google indexes your page it will use this meta tag for the description it shows to users.

Consider adding a Google +1 button or a Facebook Like button to allow users to easily share and recommend your content to other people. Both can be easily added using a scripting display template (described above), and the sample code provided by Facebook and Google, located at and

For example, the following will add both a Google +1 button and a Facebook Like button to the resource summary when added to the HTML Markup section of the scripting display template:

<script type="text/javascript">
  (function() {
    var po = document.createElement("script");
    po.type = "text/javascript";
    po.async = true;
    po.src = "";
    var s = document.getElementsByTagName("script")[0];
    s.parentNode.insertBefore(po, s);

<div id="fb-root"></div>
  (function(d, s, id) {
    var js,
      fjs = d.getElementsByTagName(s)[0];
    if (d.getElementById(id)) return;
    js = d.createElement(s); = id;
    js.src = "//";
    fjs.parentNode.insertBefore(js, fjs);
  })(document, "script", "facebook-jssdk");

<!-- Place this tag where you want the +1 button to render -->
<g:plusone annotation="inline"></g:plusone>
<br /><br />

<!-- Place this tag where you want the Like button to render -->

Try to ensure that your resources have titles that correctly identify their content to other users, and are short and to the point, otherwise they will be truncated or only a section of it will be shown in Google’s search results.

Increasing Discoverability

In order for your site to have the greatest chance of being discovered, we recommend that you sign up and add your openEQUELLA site to Google Webmaster Tools (

Once you have created an account, you will need to log in and add the site URL to Google Webmaster, then follow these recommendations in order to maximize the amount of content that Google will find.

a. Go to the Diagnostics page, then the Fetch as Googlebot tool. This allows you to enter in a URL that Google can use as a starting point.

b. openEQUELLA provides a URL located at which will produce a list of all the resources that are accessible. Enter this URL and press Fetch.

c. After a short wait the Fetch Status will change to Success, and there will be a Submit to index link. Click this then select the ‘URL and all linked pages’ option to submit the URLs. Google will now use the page as a starting point, and from there it will be able to find all of the available content in your openEQUELLA repository.

These are just a few basic guidelines to help you start getting your openEQUELLA instance discoverable on the web, but are by no means an exhaustive or guaranteed method of driving traffic to your site. The references listed below contain further information and suggestions for optimizing your site for search engines and increasing discoverability.

Google Scholar

Google has published a list of guidelines that must be met in order for articles to be included in the Google Scholar search results. openEQUELLA can adhere to these guidelines and this document will demonstrate how this can be achieved. The full guidelines are available at

To be included in Google Scholar, the following must be met:

The bibliographic data has to be provided in the form of meta tags which can be added in EQEULLA via scripting.

Google scholar can read a variety of different tag schemas including Highwire Press tags (citation_title), Eprints tags (eprints.title), BE Press tags (bepress_citation_title) and PRISM tags (prism.title). Dublic core tags can also be used (DC.title) although these can be ambiguous and are not recommended for journal papers. In this guide we will be configuring openEQUELLA to output Highwire Press tags as this is the schema that Google uses for its examples.

The following tags are required and if they are not present then your content will not be included by Google Scholar:

The other tags are not required but provide more information for Google Scholar to correctly index your content:

Once added to the display template, openEQUELLA will generate the meta tags and add them to the item summary in the correct format and position.

Your articles should also adhere to the recommended layout, which includes having the title as the largest font on the page, and making the abstract clearly visible (e.g. a paragraph of text underneath a heading of “Abstract”). This can also be easily achieved using the Markup section of a scripting display template.

Once your repository adheres to the Google Scholar guidelines it can take up to six months for the changes to be reflected in the search results. If your repository is not automatically picked up by Google Scholar you can manually submit it by going to the following URL: and filling out the required forms.


Adding a site to Google

Webmaster Guidelines

Search Engine Optimization Starter Guide

Google Scholar Inclusion Guidelines