https://github.com/umd-lib/umd-lib-aspace-theme
ArchivesSpace plugin for UMD Libraries theme elements
https://github.com/umd-lib/umd-lib-aspace-theme
Last synced: over 1 year ago
JSON representation
ArchivesSpace plugin for UMD Libraries theme elements
- Host: GitHub
- URL: https://github.com/umd-lib/umd-lib-aspace-theme
- Owner: umd-lib
- Created: 2017-04-13T15:17:29.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T13:41:56.000Z (over 1 year ago)
- Last Synced: 2025-01-10T09:25:58.504Z (over 1 year ago)
- Language: HTML
- Size: 707 KB
- Stars: 1
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# umd-lib-aspace-theme
ArchivesSpace plugin for UMD Libraries theme elements, and customizations to
stock ArchivesSpace files.
## UMD Customizations
Sections modified by UMD customizations in overridden ArchivesSpace files, are
delineated by comments `UMD Customization` / `End UMD Customization`.
Customizations are described in:
* [ArchivesSpace Customizations - Staff Interface](docs/StaffInterfaceCustomizations.md)
* [ArchivesSpace Customizations - Public Interface](docs/PublicInterfaceCustomizations.md)
## Web Analytics
The Matomo Web analytics tracker has been integrated into the default page
layout.
The tracker is activated by specifying the following parameters in the
ArchivesSpace "AppConfig" object, for retrieval in the ERB templates.
If they are not provided the tracker will not be added to the layout.
* `AppConfig[:matomo_analytics_url]` - The Matomo URL for the site
* `AppConfig[:matomo_analytics_site_id]` - The Matomo site id
## Environment Banner
Per the SSDR policy specified in
an environment banner should be shown on all non-production systems.
The display of the environment banner is handled by the
UMDLibEnvironmentBannerHelper module, which uses one of two mechanisms to
determine the banner to display:
* Environment variables
* Hostname/Rails environment
The environment variables, if specified, take precedence over the hostname
banner.
### Environment variables
The text and color of the banner can be controlled by the following environment
variables:
* ENVIRONMENT_BANNER - The text to display
* ENVIRONMENT_BANNER_BACKGROUND - The background color of the banner, expressed
as a CSS color (i.e., "#ff0000" for red).
* ENVIRONMENT_BANNER_FOREGROUND - The foreground (text) color of the banner,
expressed as a CSS color (i.e., "#ff0000" for red).
* ENVIRONMENT_BANNER_ENABLED - optional parameter. If set to "false" the banner
will not be displayed.
## Hostname/Rails environment
Determines the banner to display based on the hostname or Rails environment.
Sets the banner to the following environments:
* Local - if hostname matches "local" or Rails.env.development?, or
Rails.env.vagrant? return true
* Development - if hostname matches "dev"
* Staging - if hostname matches "stage"
A hostname matches if the first segment of the hostname ends with the given
string, i.e. "foo-dev.example.com", "foo-dev", and "dev" all match for
"Development".
## Running the Tests
The ArchivesSpace plugin test runner can be used to run the tests:
```bash
$ build/run frontend:test:plugin
```