About glossaries in ICE

A Glossary can be created using a simple definition table in a document stored within a package. Other documents within the same package can use the glossary, if desired. Only one glossary can be used per package.

In the html version of a document using the glossary, words or terms defined in the glossary are presented with an asterisk and their definitions show as hovered text.

1 How do I add a glossary to my ICE package?

1.1 Edit default.css

Add the following styles to skin/default.css

/* footnotes / glossary as tooltips */

span.footnote {

    position: relative;

}

a.footnote {

    vertical-align: super;

}

span.footnote span.footnote-text, div.glossary-def {

    display: none;

}

span.footnote:hover{

    z-index: 500;

}

span.footnote:hover span.footnote-text {

    background: #fff9d8;

    border: 1px solid gray;

    color: black;

    font-style: normal;

    font-weight: normal;

    display: inline;

    left: -1em;

    padding: 0.5em;

    position: absolute;

    top: 0.75em;

    width: 250px;

    z-index: 501;

}

span.glossary-term {

    position: relative;

}

span.glossary-mark{

    color: blue;

}

div.glossary-def-hover {

    background: #fff9d8;

    border: 1px solid gray;

    color: black;

    font-style: normal;

    font-weight: normal;

    display: Block;

    left: -1em;

    padding: 0.5em;

    position: relative;

    top: 0.75em;

    width: 250px;

    z-index:  501;   

}

1.2 Glossary.js

Glossary.js is required for the glossary to show it's hover definitions, it should be present in the default skin folder so running ICE will be sufficient. The file is located at: http://ice.usq.edu.au/svn/ice/trunk/apps/ice/fake.skin/glossary.js

1.3 Create a glossary definition document

1. Create a new document in an ICE package that contains a definition table.

   For example.

   ICEtext	Integrated Content Environment
   htmltext	http://en.wikipedia.org/wiki/HTML

2. In file view, change the options for the document render so that the Use as glossary is ticked.

   

3. Render the document

How does my document display the glossary terms?

1. Create and save a new document.

2. In file view, change the options for the document render so that the Use glossary terms is ticked.

   

3. If your new document contains the terms defined in the glossary they will show an asterisk (*) next to them. Hovering with a mouse will show the definition.

4. We have added ICE and html to this page so the hover definitions can be viewed.