How to change the text on the Sign In page

Task Description

This document describes how to change the text on your museum's Sign In (aka login or log-in) page.

This task involves editing a message bundle properties file. This file contains many of the text labels that are displayed on various CollectionSpace pages.

Prerequisites

This work requires knowledge of how to:

• Make new directories, copy files, and perform similar tasks in your operating system.
• Run commands at your operating system's command prompt.
• Edit text files.

In addition, if you have not already done so:

• Create a tenant for your museum. (A tenant is a space or partition on a CollectionSpace system for your museum or collection, within which you'll make most or all of your configuration changes.)
  • Creating your new tenant
• Read about how to make configuration changes in the User Interface (UI) layer.
  • Configuring CollectionSpace's User Interface (UI) Layer - An Overview

Layers involved

To carry out this task, you will need to make changes in the following CollectionSpace layer(s):

• User Interface (UI)

Procedure

In order to change the text that is displayed on the left-side column of the Sign In (index.html) page, you will need to modify a "message bundle" properties file.

Find your tenant folder

(Or instead see Finding your tenant folder.)

Find the message bundle file for your tenant

• Within your tenant folder, find the bundle/core-messages.properties-overlay file.
  • If this file and/or folder doesn't exist:
    • If needed, create a new folder within your tenant folder, named bundle
    • Create a new file within the bundle folder, named core-messages.properties-overlay

• Afterwards, you will then have this folder/file structure:

Edit the message bundle file for your tenant

• Edit the core-messages.properties-overlay file in your favorite text editor.

• Create or edit text labels and their values for the relevant area(s) in the core-messages.properties-overlay file. You only need to create or edit the labels whose values you wish to change from the defaults. These labels' names correspond to the names for the HTML classes seen above, but without the csc- prefix. For example, you may wish to edit any or all of the following labels:
  • login-current - The Heading for the Sign In page.
  • login-current-info - The Leading paragraph. A high-level introduction.
  • login-current-details - Secondary paragraph. Additional information.
  • login-login-* - Log in details. Useful for detailing current log in procedures, default passwords (only on demonstration or evaluation systems), or anything to do with accounts.
  • login-rologin-* - Log in details for a secondary account. For CollectionSpace, this is used for a read-only account (hence "rologin").
  • login-details-footer-* - Trailing paragraph for additional information. Currently unused in the default Core tenant.

See the example below for what these text labels look like in the sample Lifesci tenant that ships with CollectionSpace.

If you want to keep some of the default text on the Sign In page "as is," simply don't include their text labels in your core-messages.properties-overlay file. To delete any text, create the relevant text label, but give it an empty value (i.e. nothing after the colon (':') separator).

Here's an example of a core-messages.properties-overlay file that:

• Changes the heading (login-current).
• Changes the Leading paragraph (login-current-info).
• Deletes (aka blanks or empties out) the Secondary paragraph (login-current-details):

(Optional) Add new text to the Sign In page

You can add additional areas of text to the Sign In page by creating values in these two files, both within your tenant folder:

• bundles/core-messages.properties-overlay
  • Add a new name: value pair, such as:

• html/index.html
  • Reference this new name string in some new HTML structure on that page, such as a new <span> tag. Its class="" attribute must begin with csc- and be followed by your text label's name; e.g.

Copy your changes to the CollectionSpace server

(Or instead see Configuring CollectionSpace's User Interface (UI) Layer - An Overview.)

Test

After following the procedure above, use your favorite web browser for the following steps:

• If you are not already logged into your museum (tenant) on your CollectionSpace system:
  • Visit your museum's (tenant's) Sign In (login) page. For details, see the Test section of Creating your new tenant.
  • Verify that the text for the Sign In page is updated.

If it doesn't work

If the test change doesn't appear, make sure that:

• You've reloaded the relevant page in your web browser to see your changes.
• You've edited the correct file.
• In that file, you've changed the text associated with the correct HTML class.
• You've copied (deployed) the changes in your tenant folder to your CollectionSpace server.
• You've either restarted the cspace server or set up your server to automatically

See Also

• Adding New Fields to the User Interface
• HTML Field Templates
• HTML Field Level Templates
• How to rename a field

Example

CollectionSpace comes with a sample lifesci tenant which includes an example of custom Sign In page text.

The lifesci core-messages.properties-overlay file has an example of custom text for the different text labels. (The example below is from a previous version of CollectionSpace and is subject to change):