cu-mkp / editioncrafter

Software for the development of EditionCrafter, digital critical edition publication tool
https://cu-mkp.github.io/editioncrafter/
MIT License
8 stars 3 forks source link

Configuring with multiple documents #69

Closed ajolipa closed 8 months ago

ajolipa commented 9 months ago

In this PR

Adds the option to configure the EditionCrafter component to accept multiple documents, by setting the variorum prop to true and passing in an object with document IDs as keys as the documentInfo object.

For example, a variorum configuration could look like

<EditionCrafter config={{
    documentName: 'FHL_007548733_TAOS_BAPTISMS_BATCH_2 and eng-415-145a',
    variorum: true,
    documentInfo: {
      FHL_007548733_TAOS_BAPTISMS_BATCH_2: {
        documentName: 'Taos Baptisms Batch 2',
        transcriptionTypes: {
          translation: 'Translation',
          transcription: 'Transcription',
        },
        iiifManifest: 'https://cu-mkp.github.io/editioncrafter/taos-baptisms-example/iiif/manifest.json',
      },
      eng_415_145a: {
        documentName: 'Eng 415-145a',
        transcriptionTypes: {
          'eng-415-145a': 'Transcription',
        },
        iiifManifest: 'https://cu-mkp.github.io/bic-editioncrafter-data/eng-415-145a/iiif/manifest.json',
      },
    },
  }}
  />

This results in the following behavior, including the ability to unlock the two panes from each other and view a folio from one document on one side and another document on the other side: image image image

Notes and future work

NickLaiacona commented 9 months ago

This is a great start, very exciting! Some UI feedback:

ajolipa commented 9 months ago

Implemented the bullet points suggested above; @NickLaiacona go ahead and re-review whenever you have a chance!

NickLaiacona commented 9 months ago

@ajolipa looks great! only one comment here - when you are not in variorum mode and looking at the grid view, you just see the grid icon but nothing beside it. Could we display the name of the document there, not as a drop down but just a label?

ajolipa commented 9 months ago

@NickLaiacona Implemented the document name display for the non-variorum grid mode. Look it over when you get a chance!

NickLaiacona commented 8 months ago

@ajolipa this looks good - one last nit on this PR - could you remove the "View All" option from the drop down? I think it will just confuse folks.

ajolipa commented 8 months ago

@NickLaiacona Just did a push that should address these most recent concerns; let me know how it looks.