Guide du développeur

De Notix - Logiciel documentaire de gestion de notices bibliographiques.

Page en cours de rédaction ou de modification !
Image:InProgress_tip.png
La présente page est actuellement en cours de rédaction ou de modification.
Adressez-vous à la personne en charge pour toute proposition ou modification.
Auteur / Éditeur : JohanCwiklinski

Sommaire

Conventions d'écriture

La présente documentation décrit le schéma XML des bases Notix. Vous rencontrerez les termes suivants :

  • balise : le nom de la balise
  • attribut : le nom de l'attribut pour la balise
  • obligatoire : la balise doit obligatoirement être présente à cet endroit
  • optionnel : la balise est optionnelle
  • unique : la balise ne peut être présente qu'une seule fois dans la partie du document
  • répétable : la balise peut être présente à plusieurs reprises dans la partie du document
  • mots :
  • code :
  • cvs : valeurs séparées par des virgules
  • ligne :
  • texte formaté :
  • booléen : la valeur d'un champ booléen est soit true, soit false
  • phrase :

Pour obtenir plus de détails sur les différentes propriétés listées ici, référez-vous au manuel de l'administrateur Notix au format PDF, ou à l'aide en ligne sur votre installation de Notix : http://localhost:8080/notix/aide_admin.html

Schémas RDFS des bases

Notix stocke chaque base créée sous forme d'un schéma RDFS. La structure de ce fichier ressemble à cela :

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xml:lang="fr">
    <rdf:Description>
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#">Revue de presse</rdfs:label>
        <notix:display xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">TITRE</notix:display>
        <notix:brief xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">TITRE,MEDIA,DATE_PUBLI</notix:brief>
        <rng:start xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="record"/>
        </rng:start>
        <notix:suggest xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">NOM_BASE</notix:suggest>
        <notix:unicity xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">TITRE,MEDIA,DATE_PUBLI</notix:unicity>
        <notix:baseType xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">Notice</notix:baseType>
        <notix:color xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix">Rose</notix:color>
    </rdf:Description>
    <rdf:Property xml:id="NOM_BASE">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Base]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="NOM_BASE">
            <rng:value><![CDATA[Revue de presse]]></rng:value>
        </rng:element>
        <xf:hint xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA[Revue de presse]]></xf:hint>
        <xf:help xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA[Valeur fixée automatiquement.]]></xf:help>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Nom de la base de cette notice.]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="DATE_CREAT">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Date de création]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="DATE_CREAT">
            <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="creation" type="date"/>
        </rng:element>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Date automatique de création de cette notice.]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="UTIL_CREAT">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Saisie par]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="UTIL_CREAT">
            <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="createur" type="Name"/>
        </rng:element>
    </rdf:Property>
    <rdf:Property xml:id="UTIL_MAJ">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Modifiée par]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="UTIL_MAJ">
            <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="utilisateur" type="Name"/>
        </rng:element>
    </rdf:Property>
    <rdf:Property xml:id="DATE_MAJ">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Date de mise à jour]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="DATE_MAJ">
            <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="modification" type="date"/>
        </rng:element>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Date automatique de mise à jour de cette notice.]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="TITRE">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Titre]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="TITRE">
            <rng:data/>
        </rng:element>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Titre de l'article]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="DATE_PUBLI">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Date de publication]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="DATE_PUBLI">
            <rng:data type="date"/>
        </rng:element>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Date de publication de l'article]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="HEURE">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Heure de diffusion]]></rdfs:label>
        <rng:optional xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="HEURE">
                <rng:data/>
            </rng:element>
        </rng:optional>
        <dc:description xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Zone optionnelle, pour les scripts, de format MM:HH]]></dc:description>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Heure de diffusion de l'article]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="AUTEUR">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Auteur]]></rdfs:label>
        <rng:zeroOrMore xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="AUTEUR">
                <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:suggest="true">
                    <rng:param name="pattern"><![CDATA[[A-Z- ]+(, [A-Z][^\(\(]+)?]]></rng:param>
                </rng:data>
            </rng:element>
        </rng:zeroOrMore>
        <xf:hint xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA["AUTEUR, Prénom", ex : "LA FONTAINE, Jean de"]]></xf:hint>
        <xf:help xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA[Le formulaire vous suggère des noms d'auteurs déjà enregistrés pour ce catalogue.
Tapez les premières lettres du nom, vous verrez apparaître des valeurs déjà inscrites.
Cliquez celle qui vous convient. Vous pouvez aussi ajouter une nouvelle valeur, en respectant
le motif "NOM, Prénom".]]></xf:help>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Nom du(des) journaliste(s), auteur(s) du document.]]></dc:title>
        <notix:index xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" name="AUTEUR_MOT" type="word">
            <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Index mots auteur]]></rdfs:label>
            <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Rechercher un auteur par mots]]></dc:title>
        </notix:index>
        <dc:description xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[ Auteur physique
***************

Ce champ comporte les informations relatives au nom du ou des personne(s) physique(s), auteur(s) du
document.


DURAND, Paul
	Le nom et le prénom sont écrits selon la règle suivante : le nom de famille en majuscules, le prénom en minuscules
	accentuées, initiales en majuscules, séparés par une virgule et un espace.
DURAND, P.
	Si le document ne comporte que l’initiale du prénom, l’inscrire, suivie d’un point
DURAND, J -P .
	Si les initiales du prénom sont celles d’un prénom composé, les relier par un tiret et les
	faire suivre d’un point
DURAND
    Ne pas réduire un prénom à son initiale, s’il est indiqué en entier dans le document
	Si le document ne comporte pas le prénom de l’auteur, on ne reporte rien. L’écriture du nom de
	l’auteur se conforme strictement à ce qui est porté sur l’ouvrage.
LI YENG KIM
	Quand, pour certains noms étrangers, la distinction nom-prénom n’est pas possible, écrire tout en
	majuscules.
LA FONTAINE, Jean de
	Les particules (d’, de, des, du) sont écrites à la suite du prénom, en minuscules. On tiendra compte de
	l’usage du pays où réside l’auteur.
]]></dc:description>
    </rdf:Property>
    <rdf:Property xml:id="MEDIA">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Source]]></rdfs:label>
        <rng:element xmlns:rng="http://relaxng.org/ns/structure/1.0" name="MEDIA">
            <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:suggest="true"/>
        </rng:element>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Nom du média d'où l'article est extrait.]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="MOT_CLE">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Mots-clés]]></rdfs:label>
        <rng:oneOrMore xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="MOT_CLE">
                <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:base="Revuepressemotscles"/>
                <rng:attribute name="xlink:href" ns="http://www.w3.org/1999/xlink">
                    <rng:data type="anyURI">
                        <rng:param name="pattern"><![CDATA[Revuepressemotscles-.*]]></rng:param>
                    </rng:data>
                </rng:attribute>
            </rng:element>
        </rng:oneOrMore>
        <xf:hint xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA[Chercher un concept dans la table des mots-clés.]]></xf:hint>
        <dc:description xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Les mots-clés reflètent le ou les sujets principaux traités dans l'article.
Ils sont sélectionnés dans la table des mots clés. ]]></dc:description>
        <xf:help xmlns:xf="http://www.w3.org/2002/xforms"><![CDATA[Pour décrire le contenu de cet article, il suffit de l'attacher à un concept 
de la table des mots-clés. ]]></xf:help>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Le ou les sujets principaux traités dans l'article.]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="TEXTE">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Texte]]></rdfs:label>
        <rng:zeroOrMore xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="TEXTE">
                <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="fulltext" type="anyURI"/>
            </rng:element>
        </rng:zeroOrMore>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Document attaché]]></dc:title>
    </rdf:Property>
    <rdf:Property xml:id="DOC_ORIG">
        <rdfs:label xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"><![CDATA[Document orignal]]></rdfs:label>
        <rng:oneOrMore xmlns:rng="http://relaxng.org/ns/structure/1.0">
            <rng:element name="DOC_ORIG">
                <rng:data xmlns:notix="http://portail.documentation.equipement.gouv.fr/ns/notix" notix:type="fulltext" type="anyURI"/>
            </rng:element>
        </rng:oneOrMore>
        <dc:title xmlns:dc="http://purl.org/dc/elements/1.1/"><![CDATA[Fichier original au format PDF]]></dc:title>
    </rdf:Property>
</rdf:RDF>

rdf:Description

Description.

  • balise : rdf:Description
  • obligatoire
  • unique

rdfs:label

Nom.

  • balise : rdfs:label
  • optionnel
  • unique
  • mots

notix:display

Propriété par défaut.

  • balise  : notix:display
  • optionnel
  • unique
  • code

notix:suggest

Suggestion par défaut.

  • balise : notix:suggest
  • optionnel
  • unique
  • csv

notix:brief

Format court

  • balise : notix:brief
  • obligatoire
  • unique
  • csv

notix:unicity

Clé de doublon.

  • balise : notix:unicity
  • obligatoire
  • unique
  • csv

dc:title

Titre.

  • balise : dc:title
  • optionnel
  • unique
  • ligne

notix:prefrtf

Modèle RTF par défaut.

  • balise : notix:prefrtf
  • optionnel
  • unique

dc:description

Description

  • balise : dc:description
  • optionnel
  • unique
  • texte formaté

notix:thesaurus

  • balise : notix:thesaurus
  • optionnel
  • unique

notix:thesaurus

Consultation thésaurus.

  • balise : notix:thesaurus
  • optionnel
  • unique
@consultation
  • attribut : consultation
  • booléen
  • obligatoire
  • unique

notix:relations

Relations.

  • balise : notix:relations
  • obligatoire
  • unique
<notix:relations>
  <notix:relation code="DE">{nom du champ des descripteurs}<notix:relation>
  <notix:relation code="TG">{nom du champ des génériques}<notix:relation>
  <notix:relation code="TS">{nom du champ des spécifiques}<notix:relation>
  <notix:relation code="VA">{nom du champ des voir aussi}<notix:relation>
  <notix:relation code="EP">{nom du champ des synonymes}<notix:relation>
  <notix:relation code="EM">{nom du champ des employer}<notix:relation>
  <notix:relation code="NA">{nom du champ des notes d'application}<notix:relation>
<notix:relations>

notix:exportbase

Base pour l'export.

  • balise : notix:exportbase
  • optionnel
  • unique

rdf:Property

  • balise : rdf:Property
  • obligatoire
  • répétable

@xml:id

Identifiant de la propriété.

  • attribut xml:id
  • obligatoire
  • unique

rdfs:label

Nom.

  • balise : rdfs:label
  • obligatoire
  • unique
  • mots

dc:title

Titre.

  • balise : dc:title
  • optionnel
  • unique
  • phrase

dc:description

Documentation.

  • balise : dc:description
  • optionnel
  • unique
  • texte formaté

xforms:help

Aide.

  • balise : xforms:help
  • optionnel
  • unique
  • texte formaté

xforms:hint

Astuce.

  • balise : xforms:hint
  • optionnel
  • unique
  • phrase

@notix:suggest

Suggestion.

  • attribut : @notix:suggest
  • optionnel
  • unique
  • booléen

@notix:unicity

Unicité.

  • attribut : @notix:unicity
  • optionnel
  • unique
  • booléen

notix:lien-thesaurus

Assistant.

  • balise : notix:lien-thesaurus
  • optionnel
  • unique
@base

Nom de la base.

  • attribut : base
  • unique
  • obligatoire
@saisie
  • attribut : saisie
  • unique
  • optionnel
  • booléen
@recherche
  • attribut : recherche
  • unique
  • optionnel
  • booléen

Contraintes

rng:optional

rng:oneOrMore

rng:zeroOrMore

Types de données (à compléter et à revoir)

rng:data

Ligne de texte.

@type="text"
@notix:type="pre"
@type="date"

Date au format ISO.

rng:param

Motif <rng:param>[A-Z- ]+(, [A-Z][^\(\(]+)?</rng:param>

rng:text

Texte.

rng:value

Valeur fixe.

rng:choice

Liste de choix.

rng:externalRef

Référence à une liste d'autorité.

@href
  • attribut : href
  • unique
  • obligatoire

<rng:data notix:base="base"! notix:property="champ"? notix:open="true"?>

Lien vers une notice dans une base.

===== @notic

Outils personnels