Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Use this 2.5 version of the Glossary tool Help file to make changes for 2.6. Confluence will track your changes for subsequent review.

Glossary: Overview

The Glossary tool provides definitions for terms in matrices and wizards, including matrix row and column names in matrices. By doing so, it , wizard page names, and descriptions for cells or pages. In particular, using the Glossary tool in conjunction with a matrix compensates for the limited space allowed for matrix row and column names. Within matrix cells and wizard pages, glossary entries also apply to terms in cell or page names and descriptions.

When participants move the mouse over a row or column name in a matrixglossed term, Sakai displays a short definition or explanation that has been entered via the Glossary tool. When participants click on the name, it hyperlinks to more extensive information of the site organizer's choosing. Site organizers that has been entered via a rich text editor. CIG Coordinators (including site organizers and others) often use these hyperlinks to provide detailed information on such as objectives, outcomes, or standards represented by each criterionmatrix row; a complete list of campus activities for each categorymatrix level; or an extensive grouping of resources to develop each a particular skill.

If you are a system administrator or an instructorCIG Coordinator, the Glossary tool allows you to create the short and long definitions and explanations described above for matrices or wizards within a portfolio site. If you are a system administrator, you may also make glossary terms global. In this case, the terms will be displayed in all sites that use the Glossary tool in this Sakai instance.This use the Glossary tool in Portfolio Admin to define terms in matrices and wizards across sites within a Sakai instance using the Glossary Tool in the Portfolio Admin site.

The Glossary tool also allows you to manage glossary terms in other ways. You may:

  • Change glossary terms.
  • Delete glossary terms.
  • Use a glossary created in one site in another site by exporting it from the first site and importing to the other site.
  • Change Glossary glossary tool permissions for all users in any given role.
  • The Glossary tool is usually located in the Guide category on the in a portfolio web site.

To access the Glossary tool, click the Launch launch button for Glossary. Sakai displays the Glossary home page.

...

  • To see the long definition or description of a term, click the term itself. Sakai displays the longer hyperlinked definition in a separate window. To close the window, click Close.
  • To display the first page of terms, click First.
  • To display the previous page of terms, click Previous.
  • To display the next page of terms, click Next.
  • To display the last page of terms, click Last.

Adding a Glossary Term

To add a term to the glossary, access the Glossary tool and follow these steps:1.

  1. If you do not see the Glossary tool menu bar, click the Reset button.

...

  1. Click the Add link on the menu bar. Sakai displays the Add Glossary Term screen.

...

  1. In the Term box, enter the term you need to define.

...

  1. In the Short Description box, enter a brief definition of the term.

...

  1. In the Long Description box, enter a longer definition or description, or add more extensive information to help participants fully understand the term. Use the icons and

...

  1. pull-down lists to format the text as appropriate.

...

  1. Click the Add Term button. Sakai adds the term to the glossary and displays it in the list on the home page. The new term and the short definition you entered for it are displayed in the list.

...

  1. Or, to return to the home page without adding the term, click Cancel.

Changing a Glossary Term

To change a glossary term or either of its definitions, access the Glossary tool and follow these steps:1.

  1. If you do not see the Glossary tool menu bar, click the Reset button.

...

  1. Click the Edit link next to the term you want to change. Sakai displays the Edit Glossary Term screen.

...

  1. Change entries in the Term, Short Description, and Long Description boxes, as needed. Use the icons and

...

  1. pull-down lists to format text for the long description

...

  1. as appropriate.

...

  1. Click the Save Changes button. Sakai makes the changes and displays the list on the home page. The revised term and its short definition are displayed there.

...

  1. Or, to return to the home page without changing the glossary entry, click Cancel.

Deleting a Glossary Term

To delete a term from the glossary, access the Glossary tool and follow these steps:1.

  1. If you do not see the Glossary tool home page, click the Reset button.

...

  1. Click the Delete link next to the term you want to remove. Sakai deletes the term from the list.

Sakai does not display a warning message before deleting the term. Instead, Sakai immediately removes the term from the list.

...

If you are a system administrator, you may publish a glossary term globally (that is, for all sites in aSakaiinstancea Sakai instance). To do so, log in and follow these steps:1.

  1. Click the Administration folder at the top of the screen.

...

  1. Select the

...

  1. Portfolio Admin site.

...

  1. Access the Glossary tool. Sakai displays the Glossary tool home page.

...

  1. Add the term as instructed above. Because you are working in the

...

  1. Portfolio Admin site, Sakai makes this term available to all sites.

Exporting and Importing a Glossary

If you own more than one site, you may want to use the same glossary in two or more of them. To do so, first export the glossary to your desktop as a compressed file first and then import it to the other site(s) where you plan to use it. When you import a glossary, you will be asked whether you want to replace any existing term with the imported term or ignore the imported term whenever a duplicate term is included in the import.

Exporting a Glossary

To export a glossary as a compressed file, access the Glossary tool on the appropriate site and follow these steps:1.

  1. If you do not see the Glossary tool menu bar, click the Reset button.

...

  1. Click the Export link on the menu bar. Sakai displays the Opening File window.

...

  1. Follow the instructions.
  2. The glossary will be exported to your desktop as a compressed file.

Importing a Glossary

To import a compressed glossary file, access the site to which you want to import it and follow these steps:1.

  1. Add the file to Resources.

...

  1. Access the Glossary tool. If you do not see the Glossary tool menu bar, click the Reset button.

...

  1. Click the Import link on the menu bar. Sakai displays the Import Glossary Terms screen.

...

  1. Click the Select file... link. Sakai displays the Select Item screen.

...

  1. Select the compressed file for the glossary.

...

  1. Under "When a term being imported exists," click to indicate whether you want the system to use the term being imported or ignore that term and use the existing term instead.

...

  1. To import the file, click Import. Sakai imports the file, adds the terms to the glossary, and displays the Glossary home page. Or, to return to the home page without importing the file, click Cancel.

Changing Permissions

All participants who work with a matrix are permitted to display view glossary definitions for row and column names. However, permissions to add, delete, change, and export glossary terms can be restricted by role, just as they can in other tools in Sakai.

To assign permissions, access the Glossary tool and follow these steps:1.

  1. If you do not see the Glossary tool menu bar, click the Reset button.

...

  1. Click the Permissions link on the menu bar. Sakai displays this screen:

...

  1. Referring to the table below, click boxes to select the appropriate permissions for users in each role.

    Permission

    Description

    Delete

    Users in this role may delete glossary terms.

    Add

    Users in this role may add and import glossary terms.

    Edit

    Users in this role may change glossary terms and their definitions.

    Export

    Users in this role may export a zip file of glossary terms.

...

  1. To save the permissions settings, click

...

  1. Save. Sakai saves the settings and displays the Glossary home page. Or, to return to that screen without saving your changes, click

...

  1. Cancel.