Link Search Menu Expand Document

Collection Settings

This section of “_config.yml” provides important values to CollectionBuilder used to generate your site content and pull in images.

metadata:

  • The filename without the extension of your metadata CSV file.
  • Metadata specified in this value will drive the browsing features and item page generation–this is the true heart of your CollectionBuilder project!
    metadata: boxing
    

GH users: At this point you can skip to the Additional Variables section.


Required Settings for CONTENTdm

cdm-collection-id:

  • The “collection alias” of your CONTENTdm collection
  • The alias is a path assigned by CONTENTdm and can be found in CONTENTdm Admin on the Collections > Profile page, or by looking at the URL of the collection on the web. For example “https://cdm17254.contentdm.oclc.org/digital/collection/ui_ep/search” the collection alias is given after “/collection/”, so would be ui_ep.
    cdm-collection-id: boxing
    

cdm-url:

  • The full url for your public CONTENTdm instance (with NO trailing slash!).
  • Generally these follow the pattern “https://cdm” + a number + “.contentdm.oclc.org”, although custom domains should also work. However, your CDM admin interface url (starting with “server”, e.g. https://server12345.contentdm.oclc.org) will not work.
    cdm-url: https://cdm12345.contentdm.oclc.org
    

Required Settings for StandAlone

objects:

  • Provide the location of the digital objects folder
  • If using local folder, use the directory name with proceeding slash. If using an external web location, provide full URL to the folder containing the objects.
  • example using local folder –>
    objects: /objects
    
  • example using external location –>
    objects: https://www.lib.uidaho.edu/digital/objects/hjccc
    

Optional Page Generation Settings

CollectionBuilder-CONTENTdm and -CSV use a custom Jekyll plugin to generate individual HTML pages for each item (row) in your metadata CSV. By default, the “CollectionBuilder Page Generator” plugin needs no additional configuration–it will automatically use the value set in metadata to generate pages.

In advanced use cases, you may want to tweak the CB defaults or generate pages from more than one data file. The values under the page_gen key can be used to customize page generation.

For details, please see “docs/plugins.md” in the project template you are using.