Feature request: handle visibility of source images with respect to legal information

[nikobeer]

Use case: Often digital facsimila are provided by institutions/private owners with special restrictions concerning (research) usage and/or (online) publication. So when source images are used to compile an (Edirom) edition theses images can be used 'internally' but cannot be published together with the final edition. To prevent projects to manipulate the final data set (deleting all references to the source in question) it would be helpful to encode legal status of these images within the MEI file and to enable Edirom-Online to be able deal with this information.

[nikobeer]

Maybe that's also interesting for other projects…? (@bwbohl & @riedde)

[nikobeer]

So how we do it:

1. Encode legal status in MEI file:

<pubStmt>
    <availability type="facsimile">
        <accessRestrict>granted</accessRestrict>
        <useRestrict>notPublic</useRestrict>
    </availability>
</pubStmt>

2. Provide a cache file where this information is gathered on (rwa) data set installation:

<mei xmlns="http://www.music-encoding.org/ns/mei" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sources-notPublic" meiversion="4.0.1">
    <meiHead>
        <fileDesc>
            <titleStmt>
                <title>RWA Online Cache File sources-notPublic</title>
            </titleStmt>
            <pubStmt>
                <respStmt/>
            </pubStmt>
            <sourceDesc>
                <source corresp="source_ID_A"/>
                <source corresp="source_ID_B"/>
                <source corresp="source_ID_…"/>
            </sourceDesc>
        </fileDesc>
    </meiHead>
    <music/>
</mei>

3. Make it work in Edirom-Online…

[nikobeer]

Side idea: If legal status of source images changes in future, we want to be able to show these images without changing the whole data set.

[nikobeer]

So in the Annotations View we want to replace the actual source preview image with a generic image to signal to the user/viewer that images of the source in question are currently(!) not available because of legal reasons.

[nikobeer]

Yeah! Already done:

What we do:
Find out where we are ($env). If we are "internal" ('dev' or 'stage') show everything. Else if our cache file is present and the currently processed sourceID is not referenced there, show image(s). If neither is true reroute image URL to our generic SourceImageIsRestricted.jpg file.

[nikobeer]

And done for Annotation Tool Tips…

[riedde]

Thank you @nikobeer! This might be a nice feature to have also at the upstream repo.