Adding labels

In addition to editing the text that appears in your site, you can add your own labels to the Instrument Detail and Request Inspection widgets.

To add labels to the Instrument Detail widget, edit CIVICS_INSTRUMENT_DETAIL_en_US.xml in the downloaded zip file. For the Request Inspection widget, edit CIVICS_REQUEST_INSPECTION_en_US.xml.

These files include <string-group> elements that contain generic labels, each of which is defined in a child <string> element. For example, for Building Permits, CIVICS_INSTRUMENT_DETAIL_en_US.xml includes a string group called BUILDING_GENERIC_LABELS.

The text attribute of each generic label string is blank. Use this attribute to specify the label that you want to display. If you don't enter any text, then the label will not be displayed.

The key attribute of a string indicates where the label will appear.

This table describes the position in the Request Inspection widget that is indicated by each key in CIVICS_REQUEST_INSPECTION_en_US.xml:

Key Position
ABOVE_RECORD_SEARCH Above the record search field.
ABOVE_REQUEST_DETAILS Above the inspection request details.

This table describes the position in the Instrument Detail widget that is indicated by each key in CIVICS_INSTRUMENT_DETAIL_en_US.xml:

Key Position
ABOVE_AP_SR_TYPE Above the application or service request type at the top of the widget.
ABOVE_ATTACHMENTS Above the Attachments control.
ABOVE_DETAIL_PAGES Above the details for an application or service request.
ABOVE_EDITABLE_INFO Above the application or service request information that is displayed at the top of the widget.
ABOVE_LOGS Above the Logs control.
ABOVE_NEEDS_ACTION Above the Status Check control, which appears when the user clicks NEEDS ACTION for an application record.
ABOVE_RELATED_RECORDS Above the Related Records control.
ALL_TAB_CONDITIONS Above the Conditions control for applications.
ALL_TAB_FEES Above the Fees control for applications.
ALL_TAB_HEARINGS Above the Hearings control for applications.
ALL_TAB_INSPECTIONS Above the Inspections control for applications.
ALL_TAB_PLANNING_CONDITIONS Above the Planning Conditions control for applications.
ALL_TAB_REVIEWS Above the Reviews control for applications.
BELOW_ATTACHMENTS Below the Attachments control.
BELOW_DETAIL_PAGES Below the details for an application or service request.
BELOW_EDITABLE_INFO Below the application or service request information that is displayed at the top of the widget.
BELOW_LOGS Below the Logs control.
BELOW_NEEDS_ACTION Below the Status Check control, which appears when the user clicks NEEDS ACTION for an application record.
BELOW_RELATED_RECORDS Below the Related Records control.
END_ALL_TAB Below the controls that show the supporting information for an application record (fees, reviews, inspections, and so on).