software-mentions icon indicating copy to clipboard operation
software-mentions copied to clipboard

add content and paragraph to example in doc/annotation_schema.md

Open jameshowison opened this issue 2 years ago • 1 comments

On doc/annotation_schema.md

the example is

    "software-name": {
        "rawForm": "ClustalW",
        "normalizedForm": "ClustalW",
        "wikidataId": "Q866737",
        "wikipediaExternalRef": 1976990,
        "lang": "en",
        "confidence": 0.7827,
        "offsetStart": 31,
        "offsetEnd": 39,
        "boundingBoxes": [{
            "p": 4,
            "x": 439.144,
            "y": 111.378,
            "w": 36.0176,
            "h": 8.0517
        }]
    }

but the discussion underneath mentions context and paragraph with offsets into those for software-name, version, publisher and url.

Could the example given include context and (potentially) paragraph?

jameshowison avatar Sep 12 '23 15:09 jameshowison

The excerpt here is for the sub-structure "chunk" fields, one of software-name, version, publisher, url and language.

context and paragraph are fields outside these sub-structures. They are present in the mention part of the example:

{
    "type": "software",
    "software-type": "...",
    "wikidataId": "...",
    "wikipediaExternalRef": ...,
    "lang": "...",
    "confidence": ...,
    "software-name": {...},
    "version": {...},
    "publisher": {...},
    "url": {...},
    "language": {...},
    "context": "...",
    "paragraph": "...",
    "references": [{
            "label": "(Jones, 1999)",
            "normalizedForm": "Jones, 1999",
            "refKey": 24
        }],
    "mentionContextAttributes": {...},
    "documentContextAttributes": {...}
}

Does it clarify ?

kermitt2 avatar Sep 16 '23 21:09 kermitt2