Current Release

This documentation covers the latest release of VIVO, version 1.10.x.
If you are able to help contribute to this documentation, please contact sysadmin at duraspace dot org
Looking for another version? See all documentation.

Skip to end of metadata
Go to start of metadata

Overview

VIVO uses Freemarker templates to create its web pages.  These templates can be modified to alter VIVO's appearance.  Most VIVO sites alter VIVO's default appearance.  VIVO has a "Site Info" capability that allows a few presentation elements to be modified from the Site Admin menu.  Modifying other elements involves creating a theme and modifying that theme.  Here we describe simple modifications that most sites want to make before they go into production.  For a detailed description of theming and templates, see Creating a custom theme

Customization

The method described below is a customization of VIVO. This customization will be lost in an upgrade, or code refresh unless you preserve it and reapply the customization after an upgrade. A method for preserving customizations during an upgrade can be found here: Preserving Customizations During Build. It is best to plan ahead to preserve customizations.

Create a Theme

VIVO comes with a standard theme, called wilma.  wilma is in the folder in vivo/installer/webapp/target/vivo/themes.  

To create a new theme, choose a name for your new theme.  In these examples below we will call the new theme fred.  

Copy the wilma directory and its contents to a new directory called fred.  fred must also be in vivo/installer/webapp/target/vivo/themes.

Your new theme will contain CSS files, image files, and Freemarker templates.

Run the Maven install to deploy your new theme to the Tomcat container. Restart the VIVO Tomcat process. You can then go to the Site Admin page and choose Site Information, to select your theme as the current one.

Modify Header with Logo

Now that you have a theme, we can modify the templates in the theme to change VIVO's look.  Let's start with the header.  You can replace VIVO's default logo ("VIVO: connect * share * discover") with your organization's logo.  VIVO will look best if your logo has a height of 59px.

  1. Add your logo to fred/images
  2. Edit fred/css/wilma.css to replace the VIVO logo with your logo. Find h1.vivo-logo and change the URL of the background image to the name of your logo in images.
  3. Build VIVO with Maven and restart Tomcat.
  4. Check to see that your logo is in place

Modify Footer

The footer for VIVO can be found in fred/templates/footer.ftl.  You may want to change it's look, or merely change where VIVO sends people for Support (by default, VIVO send people to the VIVO web site – you may have a preferred location, or mail address for support.

  1. Edit fred/templates/footer.ftl to specify a URL for Support.  Find menu_contactus and change the href in the anchor tag to point at the desired Support location – this could be a mailto:emailaddress or a URL for your a support web site.
  2. Build VIVO with Maven and restart Tomcat
  3. Check to see that your support link is in place

Add Your Colors

Most sites have one or more colors that are used throughout their site and are identified with their organization as part of their branding program.  You may want to check with your institution regarding their branding and identify two colors by RGB code that should be used in your VIVO.  One color will be used for headings and should be dark enough for use as a text color on a white background.  A second color will be used for a background color to replace VIVO's blue.

  1. Identify your headings color and your background color
  2. Edit fred/css/wilma.css
  3. Replace h2, h3, h4, h5, h6 colors with your headings color.  Find each of the corresponding color assertions for these headings and change them to the color you prefer for headings.  
    1. You may also wish to change the colors for "Index" and "Login" at the top of the page.  The default is white, which works well on a dark background.  But if your background color is light (see below), you may want to make these the same as your headings color.  The style elements are named ul#header-nav
    2. Similarly, you may wish to change the colors for "Terms of Service" and such as the bottom of the page, to make them the same as your headings color.  The elements are named ul#footer-nav
  4. Replace the background color with your background color.  VIVO uses a background color and a background image to create the wavy lines in its header.  To replace the background color and the wavy lines with your background color, find and replace the background in the body tag, with 

    background: #xxxxxx center 0 no-repeat;
    where #xxxxxx is the RGB hex code for your background color

  5. Build VIVO with Maven and restart Tomcat
  6. Check to see that your colors are in place

Additional Theming

There is no end to what can be done with theming and VIVO's templates.  For examples of sites that have customized their VIVO with a local theme, and for more information on theming, see Creating a custom theme

Experimental Theming

New in VIVO 1.10 is the beta tenderfoot theme.  This beta theme is based on Bootstrap and provides a responsive experience on devices of various screen sizes.  To try tenderfoot, select tenderfoot in Site Admin → Site Information.  To create a custom version of tenderfoot, follow the instructions above for creating a theme, starting with tenderfoot rather than wilma.  Note that tenderfoot is a beta theme and may not have all the features needed for production.

  • No labels