Skip to content

Edition Configuration

Jump to bottom
Chiara Di Pietro edited this page Oct 6, 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.

Edition main information

  • title: string. Choose a title for your 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 title from <titleStmt> or, if this is empty, the default 'EVT Viewer' title will be shown.
  • badge: string
  • editionHome: string. If you specify an external web site there will be a link pointing to it.
  • 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 put the empty string "logoUrl": "".

Edition levels

  • availableEditionLevels: EditionLevel[]. Select which edition levels you want to be available in your edition. You can deactivate a view mode both by deleting it and by setting to true the property disabled (the latter being the suggested method).
    • Each edition level should be indicated as follows: 
      {
  id: diplomatic' | 'interpretative' | 'critical'; 
  label: string;
  title?: string;
  disabled?: boolean;
}

Named entities

  • namedEntitiesLists: Partial<NamedEntitiesLists>. Customize the list of available named entities to be highlighted and to be shown among entities lists, by changing the default list label (to be shown when no <head> is defined for the list) and/or by deleting/deactivating one or more element in the list. EVT can work only with list of person (<listPerson>), list of places (<listPlace>), list of organizations (<listOrg>), list of events (<listEvent>) and list of relations (<listRelation>). If you need a new kind of named entity to be handled just notify the EVT Development Team.
    • 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;
}
  • entitiesSelectItems: EntitiesSelectItemGroup[]. Customize the list of available entities to be highlighted by adding a new element in this list: for each element you should define a tagName, which is the XML tag that identify the entity, a label that will be shown in the selector and a color that will be used to highlight the entity within the text. If you don’t need an entity that is already inserted in this list you can delete it or just use the property disabled set to true (suggested choice).
    • Each item group should be defined as follows: 
      {
    label: string;
    items: EntitiesSelectItem[];
    disabled?: boolean;
}
    • And each item should be defined as follows: 
      {
    label: string;
    value: string;
    color?: string;
    disabled?: boolean;
}
      the value will be used to identify the items to be selected, thus you should indicate the tag name and eventual attributes in the form tagName[attribute='value'] (e.g. "persName[type='episcopus']"). Multiple values should be divided by a comma (e.g. "placeName,geogName").

[ WIP ]

Connect with us

User feedback is very much appreciated: please send all comments, suggestions, bug reports, etc. to [email protected]. See other details of our project in our web site http://evt.labcd.unipi.it/.

Clone this wiki locally