Skip to content

dcsr-datumo/KnoraBulkStandoffImport

BranchesTags

Repository files navigation

How to create a standoff mapping and test with bulk import

Using Lumieres Lausanne ontology as example to manage xml encoding:

<span class="sic" data-corr="voici l'adaptation" title="voici l'adaptation">Adaptation éditoriale</span>

Knora docs:

Create standoff mapping

  1. Preapre ontology for standoff tags into file lumieres-lausanne-standoff.ttl:
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix xml: <http://www.w3.org/XML/1998/namespace> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix knora-base: <http://www.knora.org/ontology/knora-base#> .
@prefix salsah-gui: <http://www.knora.org/ontology/salsah-gui#> .
@prefix lumieres-lausanne: <http://www.knora.org/ontology/0113/lumieres-lausanne#> .
@base <http://www.knora.org/ontology/0113/lumieres-lausanne> .

##########################################################
# <span class="" data-corr="" title=""></span
##########################################################
lumieres-lausanne:StandoffEditionTag rdf:type owl:Class ;
    rdfs:subClassOf knora-base:StandoffTag,
                   [
                      rdf:type owl:Restriction ;
                      owl:onProperty lumieres-lausanne:standoffEditionTagHasFix ;
                      owl:cardinality "1"^^xsd:nonNegativeInteger
                   ] ,
                   [
                      rdf:type owl:Restriction ;
                      owl:onProperty lumieres-lausanne:standoffEditionTagHasTitle ;
                      owl:cardinality "1"^^xsd:nonNegativeInteger
                   ] ;
    rdfs:label "Represents an edition fix in a TextValue"@en.


lumieres-lausanne:standoffEditionTagHasFix rdf:type owl:DatatypeProperty ;
                  knora-base:subjectClassConstraint lumieres-lausanne:StandoffEditionTag ;
                  knora-base:objectDatatypeConstraint xsd:string .

lumieres-lausanne:standoffEditionTagHasTitle rdf:type owl:DatatypeProperty ;
                  knora-base:subjectClassConstraint lumieres-lausanne:StandoffEditionTag ;
                  knora-base:objectDatatypeConstraint xsd:string .
  1. Copy default Knora HTML standoff mapping (webapi/_test_data/test_route/texts/mappingForStandardHTML.xml) into file manuscript-mapping.xml

(copy schema for validation: webapi/src/main/resources/mappingXMLToStandoff.xsd)

  1. Add at the end of manuscript-mapping.xml the mapping for <span> with its attributes:
<?xml version="1.0" encoding="UTF-8"?>
<mapping ns:noNamespaceSchemaLocation="mappingXMLToStandoff.xsd"
  xmlns:ns="http://www.w3.org/2001/XMLSchema-instance">

[mappingForStandardHTML.xml mapping elements]

<mappingElement>
        <tag>
            <name>span</name>
            <class>sic</class>
            <namespace>noNamespace</namespace>
            <separatesWords>true</separatesWords>
        </tag>
        <standoffClass>
            <classIri>http://www.knora.org/ontology/0113/lumieres-lausanne#StandoffEditionTag</classIri>
            <attributes>
                <attribute>
                    <attributeName>data-corr</attributeName>
                    <namespace>noNamespace</namespace>
                    <propertyIri>http://www.knora.org/ontology/0113/lumieres-lausanne#standoffEditionTagHasFix</propertyIri>
                </attribute>
                <attribute>
                    <attributeName>title</attributeName>
                    <namespace>noNamespace</namespace>
                    <propertyIri>http://www.knora.org/ontology/0113/lumieres-lausanne#standoffEditionTagHasTitle</propertyIri>
                </attribute>
            </attributes>
        </standoffClass>
</mappingElement>

</mapping>
  1. Create description file of this mapping manuscript-mapping.json:
{
  "knora-api:mappingHasName": "manuscript-mapping",
  "knora-api:attachedToProject": {
    "@id": "http://rdfh.ch/projects/0113"
  },
  "rdfs:label": "Manuscript Standoff Mapping",
  "@context": {
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "knora-api": "http://api.knora.org/ontology/knora-api/v2#"
  }
}

Add standoff mapping to Knora

Using an existing Knora server having the LL ontology installed:

  1. Load lumieres-lausanne-standoff.ttl in graphdb (into http://www.knora.org/ontology/0113/lumieres-lausanne)
$ ./load-standoff-onto.expect http://localhost:7200

(Restart Knora)

  1. Load the mapping:
$ curl -u admin_test@unil.ch:test -X POST -F json=@manuscript-mapping.json -F xml=@manuscript-mapping.xml  http://localhost:3333/v2/mapping
{
  "@id": "http://rdfh.ch/projects/0113/mappings/manuscript-mapping",
  "@type": "http://api.knora.org/ontology/knora-api/v2#XMLToStandoffMapping",
  "http://api.knora.org/ontology/knora-api/v2#attachedToProject": {
    "@id": "http://rdfh.ch/projects/0113"
  },
  "rdfs:label": "Manuscript Standoff Mapping",
  "@context": {
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
    "owl": "http://www.w3.org/2002/07/owl#",
    "xsd": "http://www.w3.org/2001/XMLSchema#"
  }
}
  1. Create a ttl representation of the mapping to load at project ontology intialization:

(dasch-swiss/dsp-api#1212)

PREFIX knora-base: <http://www.knora.org/ontology/knora-base#>
Construct {
    ?mapping ?p ?o .
    ?mapping knora-base:hasMappingElement ?mEle .
    ?mEle ?pp ?oo .
    ?oo ?ppp ?ooo .
}
FROM <http://www.knora.org/data/0113/lumieres-lausanne>
Where {
    BIND(<http://rdfh.ch/projects/0113/mappings/manuscript-mapping> as ?mapping)
    ?mapping ?p ?o .

    OPTIONAL {
        ?mapping knora-base:hasMappingElement ?mEle .
    	OPTIONAL {
        	?mEle ?pp ?oo .
    		OPTIONAL {
        		?oo ?ppp ?ooo .
            }
        }
    }
}

Prepare bulk import

  1. Get ontology schema:
$ wget http://localhost:3333/v1/resources/xmlimportschemas/http%3A%2F%2Fwww.knora.org%2Fontology%2F0113%2Flumieres-lausanne -O LL-schema.zip
  1. Unzip downloaded file:
$ unzip LL-schema.zip
Archive:  LL-schema.zip
  inflating: p0113-lumieres-lausanne.xsd
  inflating: knoraXmlImport.xsd
  1. Create data file (data.xml) with rich text data containing <span> tag:
<?xml version="1.0" encoding="UTF-8"?>
<knoraXmlImport:resources xmlns="http://api.knora.org/ontology/0113/lumieres-lausanne/xml-import/v1#"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.knora.org/ontology/0113/lumieres-lausanne/xml-import/v1# p0113-lumieres-lausanne.xsd"
    xmlns:p0113-lumieres-lausanne="http://api.knora.org/ontology/0113/lumieres-lausanne/xml-import/v1#"
    xmlns:knoraXmlImport="http://api.knora.org/ontology/knoraXmlImport/v1#">

    <User id="id_gfaucherand">
        <knoraXmlImport:label>gfaucherand</knoraXmlImport:label>
        <isKnoraUser knoraType="uri_value">http://rdfh.ch/users/lumieres-lausanne-gfaucherand</isKnoraUser>
        <userHasName knoraType="richtext_value">Gilles Faucherand</userHasName>
    </User>

    <Person id="id_Mirabeau_Victor_de_Riqueti_marquis_de_1715_1789_">
        <knoraXmlImport:label>Mirabeau, Victor de Riqueti, marquis de (1715 - 1789)</knoraXmlImport:label>
        <hasCivilStatus knoraType="richtext_value">Fils Jean Antoine Riqueti de Mirabeau (1666-1737) et de Françoise née de Castellane (1695-1769). M. épouse en 1743 Marie Geneviève née de Vassan. M. a onze enfants, dont Honoré Gabriel.</hasCivilStatus>
        <hasName knoraType="richtext_value">Mirabeau, Victor de Riqueti, marquis de</hasName>
        <hasNationality knoraType="hlist_value">http://rdfh.ch/lists/0113/00d89c99ca01</hasNationality>
        <hasOldId knoraType="richtext_value">269</hasOldId>
        <hasPlaceBirth knoraType="richtext_value">Pertuis</hasPlaceBirth>
        <hasPlaceDeath knoraType="richtext_value">Argenteuil</hasPlaceDeath>
        <hasReligion knoraType="hlist_value">http://rdfh.ch/lists/0113/b921967c9e01</hasReligion>
        <isApproximateBeginDate knoraType="boolean_value">false</isApproximateBeginDate>
        <isApproximateEndDate knoraType="boolean_value">false</isApproximateEndDate>
        <isModern knoraType="boolean_value">false</isModern>
        <mayHaveBiography knoraType="boolean_value">true</mayHaveBiography>
        <noticeIsCreated knoraType="boolean_value">true</noticeIsCreated>
        <noticeIsValid knoraType="boolean_value">true</noticeIsValid>
        <personHasDate knoraType="date_value">GREGORIAN:1715-10-5 CE:1789-7-13 CE</personHasDate>
    </Person>

    <Contribution id="id_mirabeau_auteur">
        <knoraXmlImport:label>mirabeau-auteur</knoraXmlImport:label>
        <contributionHasSequenceNumber knoraType="int_value">1</contributionHasSequenceNumber>
        <hasContributionType knoraType="hlist_value">http://rdfh.ch/lists/0113/154349a29401</hasContributionType>
        <isContributor>
            <Person knoraType="link_value" target="id_Mirabeau_Victor_de_Riqueti_marquis_de_1715_1789_" linkType="ref"></Person>
        </isContributor>
    </Contribution>

    <BibliographicNotice id="id_biblio1">
        <knoraXmlImport:label>biblio1</knoraXmlImport:label>
        <bibliographicNoticeHasTitle knoraType="richtext_value">Sans titre [Lettre à Marc Charles Frédéric de Sacconay, 28 octobre 1731]</bibliographicNoticeHasTitle>
        <hasContribution>
            <Contribution knoraType="link_value" target="id_mirabeau_auteur" linkType="ref"></Contribution>
        </hasContribution>
        <hasDocumentType knoraType="hlist_value">http://rdfh.ch/lists/0113/2240f647af01</hasDocumentType>
        <hasLanguage knoraType="hlist_value">http://rdfh.ch/lists/0113/384d693b9a01</hasLanguage>
        <hasLiteratureType knoraType="hlist_value">http://rdfh.ch/lists/0113/eddfe26c9601</hasLiteratureType>
        <hasManuscriptType knoraType="hlist_value">http://rdfh.ch/lists/0113/2a4929fe9701</hasManuscriptType>
        <hasOldId knoraType="richtext_value">4478</hasOldId>
        <hasPages knoraType="richtext_value">1</hasPages>
        <hasShortTitle knoraType="richtext_value">Lettre à Marc Charles Frédéric de Sacconay</hasShortTitle>
        <hasSubjectKeyword knoraType="hlist_value">http://rdfh.ch/lists/0113/25f56e083701</hasSubjectKeyword>
        <hasTranscription>
            <Transcription knoraType="link_value" target="id_Sans_titre_Lettre_Marc_Charles_Fr_d_ric_de_Sacconay_28_octobre_1731_" linkType="ref"></Transcription>
        </hasTranscription>
        <hasWritingDate knoraType="date_value">GREGORIAN:1731-10-28 CE</hasWritingDate>
        <hasWritingPlace knoraType="richtext_value">Besançon</hasWritingPlace>
    </BibliographicNotice>

    <Transcription id="id_Sans_titre_Lettre_Marc_Charles_Fr_d_ric_de_Sacconay_28_octobre_1731_">
        <knoraXmlImport:label>Sans titre [Lettre à Marc Charles Frédéric de Sacconay, 28 octobre 1731]</knoraXmlImport:label>
        <hasDiffusionType knoraType="boolean_value">true</hasDiffusionType>
        <hasOldId knoraType="richtext_value">169</hasOldId>
        <hasReleaseDate knoraType="date_value">GREGORIAN:2016-12-25 CE</hasReleaseDate>
        <hasReviewer>
            <User knoraType="link_value" target="id_gfaucherand" linkType="ref"></User>
        </hasReviewer>
        <hasScope knoraType="hlist_value">http://rdfh.ch/lists/0113/f3daeff3af01</hasScope>
        <hasStatus knoraType="hlist_value">http://rdfh.ch/lists/0113/58a79cbaaf01</hasStatus>
        <transcriptionHasCreator>
            <User knoraType="link_value" target="id_gfaucherand" linkType="ref"></User>
        </transcriptionHasCreator>
        <transcriptionHasText knoraType="richtext_value" mapping_id="http://rdfh.ch/projects/0113/mappings/manuscript-mapping">
            <text xmlns="">
                <p>
                    <span class="sic" data-corr="voici l'adaptation" title="voici l'adaptation">Adaptation éditoriale</span>
                </p>
            </text>
        </transcriptionHasText>
    </Transcription>
</knoraXmlImport:resources>

Launch bulk import

$ curl -u admin_test@unil.ch:test -X POST -d @data.xml http://localhost:3333/v1/resources/xmlimport/http%3A%2F%2Frdfh.ch%2Fprojects%2F0113

Hack Salsah 1 to render correctly the new standoff mapping

By default, rich text property are edited in Salsah with CKEditor configured to manage the default Knora HTML standoff mapping.

  1. Add Source button to CKEditor toolbar by patching the file jquery.htmleditor.js:194:
        { name: 'tools', items: [ 'Maximize', 'Source' ] }
  1. Allow CKEditor to accept <span> tag and its attributes by patching the file jquery.htmleditor.js:145:
var filter =
  ' p em strong strike u sub sup hr h1 h2 h3 h4 h5 h6 pre table tbody tr td ol ul li cite blockquote code; a[!href](salsah-link); span(sic)[data-corr,title] ';

FIXME: (Salsah issue) this configuration should be created on the fly by getting the mapping associated to the value (Knora provides the possibility to have one mapping per value!)

  1. FIXME: (Salsah issue) on save, Salsah/CKEditor should write text values with the mapping_id of the value and not with the default provided by Knora (probably hardcoded)

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published