Skip to content

Edition Configuration

Chiara Di Pietro edited this page Apr 5, 2020 · 13 revisions

Edition Configuration (edition_config.json) allows to set the configurations closely related to the digital edition, such as the title, the edition level(s), etc.

  • title: string, the main title of the digital edition. If you want to allow the translation of the title, use the proper key of the locale json file. If you leave it blank the default 'EVT Viewer' title will be shown.
  • badge: string
  • editionHome: string
  • availableEditionLevels: EditionLevel[]
    • Each edition level should be indicated as follows:
      {
        id: diplomatic' | 'interpretative' | 'critical'; 
        label: string;
        title?: string;
        disabled?: boolean;
      }
      
  • namedEntitiesLists: Partial<NamedEntitiesLists>
    • This parameter could be defined as follows (none of the parameter is mandatory).
      {
          persons: NamedEntitiesListsConfig; // for list of persons `<listPerson>`
          places: NamedEntitiesListsConfig; // for list of places `<listPlace>`
          organizations: NamedEntitiesListsConfig; // for list of organizations `<listOrg>`
          relations: NamedEntitiesListsConfig; // for list of relations `<listRelation>`
          events: NamedEntitiesListsConfig; // for list of events `<listEvent>`
      }
      
      where NamedEntitiesListsConfig is an object defined as follows:
      {
         defaultLabel: string;
         enabled: boolean;
      }
      

[WIP]