Site Configuration - VTUL/dlp-access GitHub Wiki

Metadata Schema

Field Type Required RExample
analyticsID String UA-4094890-21
assetBasePath String https://img.cloud.lib.vt.edu/sites/html/iawa
browseCollections Map X Contains filter and values. see browseCollections
contact List X see contact
displayedAttributes Map X see displayedAttributes
groups List X see SiteAdmin Groups
homePage Map X see homePage
searchPage Map X see searchPage
siteColor String #c52a1d
siteId String X Site unique id: iawa
siteName String X International Archive of Women in Architecture
sitePages Map Contains about and terms. see sitepages
siteTitle String X IAWA

browseCollections

Field Type Required Example
filter Map X see filter
sort List X see sort

filter

Field Type Required Example
field String X subject
values List(String) X All

sort

Field Type Required Example
direction String X asc
field String X title

contact

Field Type Required Example
cityStateZip String X Blacksburg, VA 24061
department String X University Libraries (0434)
email String X [email protected]
group String X Special Collections and University Archives
phone String X (540) 231-4442
streetAddress String X 560 Drillfield Drive
title String X Community Collections Archivist

displayedAttributes

Field Type Required Example
item List X see item
collection List X see collection

item

Field Type Required Example
field List X identifier
label List X Identifier

collection

Field Type Required Example
field List X size
label List X Size

homePage

Field Type Required Example
collectionHighlights List see collectionHighlights
featuredItems List see featuredItems
homeStatement Map X see homeStatement
sponsors List see sponsors
staticImage Map X see staticImage
mediaSection Map see mediaSection

collectionHighlights

Field Type Required Example
img String X https://img.cloud.lib.vt.edu/sites/images/iawa/highlight1.jpg
itemCount String X 51
link String X /search?q=&field=description&view=Gallery&category=archive&resource_type=Travel+sketche
title String X Travel sketches by IAWA architects

featuredItems

Field Type Required Example
cardTitle String X Altar, church interior, n.d. Elevation (Ms1992-028)
link String X https://iawa.lib.vt.edu/archive/4610h699
src String X https://img.cloud.lib.vt.edu/sites/images/iawa/featured_item1.jpg

homeStatement

Field Type Required Example
heading String X Welcome
statement String X A visual exhibit ...

sponsors

Field Type Required Example
alt String X Council on Library and Information Resources
img String X https://img.cloud.lib.vt.edu/sites/images/iawa/sponsor1.png
link String X https://www.clir.org/

staticImage

Field Type Required Example
altText String X [Modern-style living room in grayscale], n.d. Watercolor (Ms1994-016)
showTitle Boolean X true
src String X https://img.cloud.lib.vt.edu/sites/images/iawa/cover_image.jpg

mediaSection

Field Type Required Example
link String X https://lib.vt.edu/
mediaEmbed String X <iframe src="">...</iframe>
text Boolean X The University Libraries ...
title String X Welcome to the University Libraries at Virginia Tech

searchPage

Field Type Required Example
facets List X see facets

facets

Field Type Required Example
label String X Category
name String X Category
values List(String) X ["collection","archive"]

sitePages

  1. about

    Field Type Required Example
    component String AboutPage
    data_url String about.html
    local_url String /about
    text String About

  2. terms (Optional)

    Field Type Required Example
    component String PermissionsPage
    data_url String terms.html
    local_url String /permissions
    text String Permissions
    assets Map See assets

assets

Field Type Required Example
download String X https://digitalsc.lib.vt.edu/files/thumbnails/spec_forms/PubPermission.doc

History

Field Type Required Example
field String X
userid String X
tid String X record unique id
event String X changed content

Examples

⚠️ **GitHub.com Fallback** ⚠️