Variable descriptions

• Data Repo default or collection
  • data_base
  • media_base
  • xslt override template url_builder
  • es_pathand es_index
• Collection
  • shortname
• API
  • es_path and es_index
• Orchid site
  • production/development

Data Repo default or collection

location

• /data
  • /config/public.yml [prod]
  • /config/private.yml [dev]
  • /collection/Project_Name/config/public.yml [prod]
  • /collection/Project_Name/config/private.yml [dev]

data_base

• example: http://cdrhmedia.unl.edu

Location of data (html, tei, etc.)

Application will append /data/ to url; can be the same as cdrh_media.

Generally passed to index scripts to build link to html, tei, and other data.

media_base

• example: http://cdrhmedia.unl.edu

Location of the media (audio, video).

Linking to all media except images in api and html.

url_builder XSLT template

• private.yml only
• override template via xsl file, store location in:
  • /config/public.yml
    • to change for all projects
  • /collection/Project_Name/config/private.yml
    • to change for only one project
  • example: https://github.com/CDRH/data/blob/master/scripts/xslt/cdrh_to_html/lib/cdrh.xsl#L115

The default XSLT scripts build an IIIF url based from media_base.

Local override: Store file outside repo, reference location from /Project_Name/config/private.yml." Used to link to page images in html.

es_path and es_index

• private.yml only
• example es_path: http://localhost:9200
• example es_index: cdrhapi

Location of elasticsearch instance and index.

Used to post to index.

Collection

location

• /data
  • /collection/Project_Name/config/public.yml [prod]
  • /collection/Project_Name/config/private.yml [dev]

shortname

• example: Project_Name

Shortname, or ""slug"" of the project.

Generally the same as the folder name in /data/collections and stored in public.yml.

Used to build URL's in index and HTML scripts.

API

location:

• /rails/api
  • /config/config.yml

es_path and es_index

• example es_path: http://localhost:9200
• example es_index: cdrhapi

location of elasticsearch index and index name.

Orchid Powered Site

location:

• /rails/Project_Name

  • /config/config.yml

• production or development

• example production or development: http://localhost:3000 or http://localhost:3000/collection/Project_Name

Location of API.

Folder Structure	url after base(added by scripts)	localhost base	cdrhdev base	cdrh prod base
📁 data	/data	http://localhost:9999	http://cdrhdev1.unl.edu/media	http://cdrhmedia.unl.edu
📁 collections	/data/Project_Name	http://localhost:9999	http://cdrhdev1.unl.edu/media	http://cdrhmedia.unl.edu
📁 iiif
symlinks for each project
data/collections/Project_Name -> Project_Name
[iiif server] (default url)
📁 media	root	http://localhost:9999	http://cdrhdev1.unl.edu/media	http://cdrhmedia.unl.edu
📁 images	/images	http://localhost:9999	http://cdrhdev1.unl.edu/media	http://cdrhmedia.unl.edu
📁 Project_Name (optional)	/images/Project_Name	http://localhost:9999	http://cdrhdev1.unl.edu/media	http://cdrhmedia.unl.edu
symlink
data/collections -> data
📁 rails
📁 API
[elasticsearch instance]	root	http://localhost:9200	http://localhost:9200	http://localhost:9200
[rails/api]	root	http://localhost:3000	http://cdrhdev1.unl.edu/api/v1	http://cdrhapi.unl.edu
📁 Project_Name
[rails/orchid]	root	http://localhost:3001	http://cdrhdev1.unl.edu/Project_Name	http://Project_Name.unl.edu