Internationalizations

You can use the Internationalizations page to configure the default language for Anthology Student and modify or rename labels and messages for the items associated with a language. For example, you can change the name of a field to make it more specific.

When Internationalization is configured, Anthology Student displays a globe icon Internationalization icon on the command bar to show the list of languages configured and the language in use. You can select the icon and select a language from the list.

US English is set as the default language and locale in Anthology Student.

To change form labels and messages, follow this process.

  1. Download a Portable Object (.po) file from Anthology Student.
  2. Use a text editor to edit the .po file to change any respective labels (msgstr).
  3. Save the modified .po file.
  4. Upload the modified .po file and save the changes in Anthology Student.

An example of a label change is provided under Upload customized PO file.

System-defined Locales

Anthology Student 25.2 0 introduces the following system-defined locales:

  • English (United States)
  • Spanish (Latin America)
  • French (Canada)

Anthology maintains the translations for the system-defined locales. The system-defined locales automatically update the resource files after each system upgrade. Any interface elements introduced by an upgrade will have been translated in the system-defined resource files and don't require translations by the customer. For more information, refer to Download System Resource File.

The system-defined resource files cannot be edited by customers. To customize translations, customers must create a copy of the locale and apply their own changes. With each release, customers must update their customized PO/JSON/Resx files to reflect new translations. If the customized files are not updated, the system will display strings from the default locale.

Institutions can continue to define their own locales using the existing functionality. Whenever institutions define a locale, they can download and upload PO files as they have been doing in previous versions of Anthology Student. If the translation is not available, the system will fall back to the English (United States) locale.

Prerequisites

You must have System - Settings - Internationalization - Manage authorization.

To customize and modify the label names, the system administrator must set the Use Data Dictionary for Form LabelsClosed Choose "Yes" if you want to use the legacy Data Dictionary setup for your form labels. To change these labels, edit them directly in the Data Dictionary through Anthology Student's legacy interface. If you select "No," only internationalization resources (when set up) will be used. For customizing English and Spanish labels, download the PO file, update the label text, and then upload it back to the Anthology Student web app. By default, this option is set to "No." Keep in mind, this setting prevents editing label names within the web app's Data Dictionary; you can only use labels previously updated in the legacy Data Dictionary tables. After adjusting this general setting, give yourself time to review the results and remember to clear the cache. Note: UI labels in the help system are based on those found in the system's default English internationalization file. option to No (Select the Settings tile > expand System > select General.) and then clear the cache. You must log out, log in again, and then navigate to Internationalizations to customize label names.

Access Method

Select the Settings tile > expand System > select Internationalizations.

Procedure to Add or Edit Items

  1. If you want to:

    • Add a new list item, select the New button on the toolbar

    • Edit an existing list item, select the name in the list

  2. Review, specify, or change the following values.

    ActiveClosed Specifies whether the associated record is active.

    Active Resource FileClosed This column indicates whether the locale is reading the UI labels from a Custom PO file or System PO file. If you create a new locale and do not upload a PO file, the column will display the value "System". When you upload a new PO file, the value will change to "Custom".

    Date Added Closed The date when the item or person was added or the status change was entered.

    Date ModifiedClosed The date when the item was changed. On some pages, the date also includes the timestamp.

    DefaultClosed The associated record is set as the default. For example, the default address, the default enrollment.

    LocaleClosed Indicates the language that you want to set as the default language. The en-US locale is defined and active by default. It may not be deactivated, but additional locales may be defined and set as the default. The default locale is loaded in the absence of a user-specific language preference.

    Modified ByClosed The name or user ID of the person who changed the item.

    NameClosed The name of the item (e.g., data set, batch, job, process, task, person, organization, entity, file).

    System DefinedClosed This column indicates whether the locale is system-defined (Yes) or user-defined (No).

  3. Take the appropriate action.

    Action Steps to follow
    Download the PO file

    1. Select the Download button in the grid toolbar. Anthology Student displays the Download .po file dialog.

    2. Select the Download button. Anthology Student displays the Save As dialog.

    3. Browse to the appropriate location and save the PO fileClosed Indicates a Portable Object (PO) file, which is an industry standard file that includes the message key (msgid) and value (msgstr) specific to a given language..

    The downloaded PO file is saved in the database. The file is not removed when an upgrade occurs.
    Upload a customized PO file

    You can customize the PO file.

    The PO file includes a header that identifies the application, the language, and a msgid/msgstr entry for every user-facing string used in Anthology Student. Some entries include only msgid and msgstr pairs, and others include additional msgctxt entries. Entries with msgctxt include the default English value in the msgstr entry. These values are there to help the translator and should be replaced with the proper translated term.

    Example:

    The following entry in the PO file changes the student profile label from “Alien Number” to “International ID”.

    #:Cmc.Nexus.Common.Contracts.dll\Cmc.Nexus.Common.EntityResources.resourcesmsgctxt "Cmc.Nexus.Common.Contracts"

        msgid "StudentEntity_AlienNumber_DisplayName"                                    
        msgstr "Alien Number"  < label string to change to “International ID”

    You can upload the customized PO file.

    1. Select the Upload button in the grid toolbar. Anthology Student displays the Upload .po file dialog.

    2. Browse to the appropriate location and select the PO file.

    3. Select the Upload button. Anthology Student confirms that the Internationalization records were saved, followed by a second message stating that the Gettext file was processed successfully. You must log out and log in to view the updated value.

    When a PO file is uploaded (saved), Anthology Student updates the corresponding UI labels. When the PO file is downloaded later, the file will be just as uploaded and is, therefore, suitable for further translation work.
    Download System Resource File

    1. Select the record in which the System Defined value is set to Yes.

    2. Select the Download System Resource File button in the grid toolbar. Anthology Student downloads the resource file that is translated and maintained by Anthology.

    3. In the Download .po file dialog, select the Download button. Anthology Student displays the Save As dialog.

    4. Browse to the appropriate location and save the PO fileClosed Indicates a Portable Object (PO) file, which is an industry standard file that includes the message key (msgid) and value (msgstr) specific to a given language..

    The downloaded PO file is saved in the database. The file is updated when an upgrade occurs.

  4. If you want to save and: 

    • Continue making changes, select the Save button

    • Close, select the Save & Close button

    • Add another item to the list, select the Save & New button

Delete or Deactivate Internationalizations

You can use the Internationalizations page to delete and deactivate configured locales.

  • Deleting an item permanently removes it. No record of deleted list items is maintained in Anthology Student.
  • Deactivating an item keeps a record of it in Anthology Student (preferred). It can no longer be assigned to a student or record but remains assigned as it was previously.

If an item: 

  • Is not associated with a student or record, you can delete or deactivate it
  • Is associated with a student or record, you can only deactivate it
  • Is associated with Automated Awarding, you cannot delete or deactivate it

Procedure to Delete Items

  1. Highlight the item in the list.
  2. Select the Delete button on the toolbar.

The item is:

  • Removed from the list on the page, and the list is redisplayed
  • No longer available to select on the forms that contain the list

Procedures for Deactivating Items

There is more than one method for deactivating an item.

Method Procedure Result
Using a toolbar button
  1. Highlight one item in the list.
  2. Select the Deactivate button on the toolbar.

The item: 

  • Remains displayed in the list with No in the Active column

  • Is no longer available to select on the forms that contain the list

Editing the item
  1. Select the name of the item in the list.
  2. In the Active drop-down, select No.
  3. Select the Save and Close button.

Because the item is not removed, you can also make it active again by selecting the Activate button.