Hyrax Customization user manual

Web page customization

Hyrax's public "face" is the web pages that are produced by servlets running in the Tomcat servlet engine. Almost all of these pages can be completely customized by the site administrator by editing a combination of HTML, XSLT, and CSS files.

Where to make the changes

All of the default versions of the HTML, XSLT, and CSS files come bundled with Hyrax in the $CATALINA_HOME/webapps/opendap/docs directory. You can make changes there, but installing new versions of the OLFS software will overwrite your modifications.

However, if the docs directory is copied (preserving its structure) to $CATALINA_HOME/content/opendap/ (creating the directory $CATALINA_HOME/content/opendap/docs), then Hyrax will serve the files from the new location.

Warning

Do NOT remove files from this new directory (Or the old one for that matter). Each file, in its location, is required by Hyrax. You can make changes to the files but you should not rename or remove them.

Nothing inside the $CATALINA_HOME/content directory is (automatically) changed when installing new versions of Hyrax.

The rest of these instructions are written with the assumption that a copy of the docs directory has been made as described above.

What to change

HTML Files

The HTML files provide the static content of a Hyrax server.

File		Location		Description
index.html		$CATALINA_HOME/content/opendap/docs		The documentation web page for the top level of Hyrax. As shipped it contains a description of Hyrax and links to documentation and funders. The contents.html pages (aka the OPeNDAP directories) links to this document.
error400.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates a Bad Request error (Associated with an HTML status of 400)
error403.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates a Forbidden error. (Associated with an HTML status of 403)
error404.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates a Not Found error. (Associated with an HTML status of 404)
error500.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates an Internal Server Error. (Associated with an HTML status of 500)
error501.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates an Not Implemented. (Associated with an HTML status of 501)
error502.html		$CATALINA_HOME/content/opendap/docs		Contains the default error page that Hyrax will return when the client request generates an Bad Gateway. (Associated with an HTML status of 502)

CSS Files

File		Location		Description
contents.css		$CATALINA_HOME/content/opendap/docs/css		The contents.css style sheet provides the default colors and fonts used in the Hyrax site. It is referenced by all of the HTML and XSL files to coordinate the visual aspects of the site.
thredds.css		$CATALINA_HOME/content/opendap/docs/css		The thredds.css style sheet provides the default colors and fonts used by the THREDDS component of Hyrax.