Skip to content

Files Configuration

Chiara Di Pietro edited this page Dec 6, 2022 · 8 revisions

File Configuration (file_config.json) allows to set the path(s) to the file(s) of the digital edition.

  • editionUrls: string[]. String array which holds the list of paths to the XML file(s) of your encoded edition. Each path can point either to an internal folder or to an external online resource.
  • editionImagesSource: { manifest: { value: string; enable: boolean; }; graphics: { value: string; enable: boolean; }}. Indicate the source to be used to retrieve images. If you have a manifest, indicate the IIIF path to manifest.json as value and set manifest.enable to true. If you want to use information encoded within your XML <graphic> element, indicate the attribute in which path to file is encoded and set graphics.enable to true. If both manifest.enable and graphic.enable are set to false, images path will be guessed starting from pages ids, as it was for EVT1 and EVT2.
  • manifestURL: string. Allows to write the URL of an IIIF manifest.json file to publish a digital facsimile.
  • logoUrl: string. You can add a custom logo that will appear before the edition title: just indicate the path to it; it can be a URL or a relative path: we suggest that you put it into data and point to it (f.i. "logoUrl": "data/icons/myLogo.jpg"). If you don't want a logo at all just leave an empty string "logoUrl": "".
  • imagesFolderUrl?: string. Path to the folder containing all images. Optional.
  • configurationUrls?: { edition: string; ui: string; editorialConventions: string; }. Paths to the other configuration files. Optional.

[WIP]