Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
|
serveurscrutari:config:sources [2017/01/17 17:12] vincent |
serveurscrutari:config:sources [2022/09/11 11:53] (Version actuelle) vincent |
||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| ====== Fichier sources.xml : définir les sources de données ====== | ====== Fichier sources.xml : définir les sources de données ====== | ||
| - | Le fichier de configuration //sources.xml// est un fichier essentiel puisque c'est lui qui liste les sources de données du moteur Scrutari. L'absence de ce fichier n'entrainera d'erreur, simplement le moteur tournera à vide ! | + | Le fichier de configuration //sources.xml// est un fichier essentiel puisque c'est lui qui liste les sources de données du moteur Scrutari. L'absence de ce fichier n'entraine pas d'erreur, simplement le moteur tourne à vide ! |
| - | Chaque source de données est identifiée par un nom qui doit être unique, ne contenir que des minuscules (sans acccent), des chiffres ou le tiret bas //_//. Pour chaque source, il faut indiquer au moins une URL qui peut être de deux types : | + | La tâche qui incombe aux sources de données est de les fournir au format ScrutariData. Pour cela, elles doivent mettre à disposition une URL où télécharger ces données au format ScrutariData (sur le même principe que les URL de syndication). Il y a deux manières de mettre à disposition ces données : |
| - | * Soit il s'agit directement de l'URL d'un fichier au format ScrutariData et dans ce cas il faut également indiquer la fréquence (en nombre de jours de mise à jour) | + | * soit en indiquant directement l'URL de téléchargement (voir ci-dessous l'élément !!<scrutaridata-url>!!) |
| - | * Soit il s'agit de l'URL d'un fichier qui suit le format des [[serveurscrutari:config:scrutariinfo|fichiers d'information]] | + | * soit en indiquant l'URL d'un fichier appelé « fiche d'information » qui sert d'intermédiaire, notamment en indiquant le ou les URLs nécessaires pour construire les données au format ScrutariData (voir son [[serveurscrutari:config:scrutariinfo|format exact]] et ci dessous l'élément !!<info-url>!!) |
| + | |||
| + | Le choix entre ces deux manières dépend de la source. Un fichier d'information est particulièrement utile quand les données sont importantes et que leur génération peut prendre du temps. | ||
| + | |||
| + | Au niveau du fichier de configuration //sources.xml//, une source de données est identifiée par un nom unique et peut combiner plusieurs URLs (fichiers au format ScrutariData ou fichiers d'information) comme le montre l'exemple ci-dessous : | ||
| - | Pointer directement vers un fichier au format ScrutariData est plus simple. En revanche, un fichier d'information donne plus de possibilités, en particulier celles de tronçonner les données en plusieurs fichiers. | ||
| Ligne 14: | Ligne 17: | ||
| ===== Structure du format XML ===== | ===== Structure du format XML ===== | ||
| - | L'élément racine est l'élément !!<sources>!! qui contient un seul type d'élément : l'élément !!<source>!! qui a un attribut obligatoire !!@name!! et qui peut contenir soit des éléments !!<info-url>!!, soit des éléments !!<scrutaridata-url>!! ; ces deux éléments doivent avoir comme valeur une URL valide et un élément //<scrutaridata-url>// peut posséder un attribut !!@freq!! qui indique la fréquence de mise à jour en nombre de jours (la valeur par défaut est « 1 » ce qui signifie que le fichier sera vérifié tous les jours. | + | L'élément racine est l'élément !!<sources>!! qui contient un seul type d'élément : l'élément !!<source>!!. Celui-ci a un attribut obligatoire, !!@name!!, qui est le nom identifiant la source (il doit être unique et n'être composé que des minuscules (sans accent), des chiffres ou le tiret bas //_//). |
| + | |||
| + | L'élément //<source>// contient des éléments !!<info-url>!! et des éléments !!<scrutaridata-url>!! ; ces deux éléments doivent avoir comme valeur une URL valide et un élément //<scrutaridata-url>// peut posséder un attribut !!@freq!! qui indique la fréquence de mise à jour en nombre de jours (la valeur par défaut est « 1 » ce qui signifie que le fichier sera vérifié tous les jours). | ||
| - | L'élément //<source>// peut également posséder un élément !!<uri>!! (indiquant l'URI de la base à utiliser en lieu et place de l'URI indiqué par le fichier au format ScrutariData) ou plusieurs éléments !!<alias>!! (permettant d'indiquer des anciens URI équivalents à l'URI actuel). Voir ci-dessous. | + | L'élément //<source>// peut également posséder un élément !!<uri>!! (indiquant l'URI de la base à utiliser en lieu et place de l'URI indiqué par le fichier au format ScrutariData) ou plusieurs éléments !!<alias>!! (permettant d'indiquer des anciens URI équivalents à l'URI actuel). Voir les exemples et ci-dessous. |
| ==== Exemple ==== | ==== Exemple ==== | ||
| - | L'exemple suivant est le fichier de configuration de la Coredem en mars 2014 | + | L'exemple suivant est extrait de la configuration de la Coredem en juillet 2017 |
| <code xml> | <code xml> | ||
| Ligne 28: | Ligne 33: | ||
| <source name="irenees"> | <source name="irenees"> | ||
| <info-url>http://bases.basedefiches.net/irenees/pub/scrutari/coredem.scrutari-info.xml</info-url> | <info-url>http://bases.basedefiches.net/irenees/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="dph"> | ||
| - | <info-url>http://bases.basedefiches.net/dph/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="irg"> | ||
| - | <info-url>http://bases.basedefiches.net/irg/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="eclm"> | ||
| - | <info-url>http://bases.basedefiches.net/fph/pub/scrutari/eclm_coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="chinaeuropa"> | ||
| - | <info-url>http://base.china-europa-forum.net/xml/scrutari/coredem.scrutari-info.xml</info-url> | ||
| </source> | </source> | ||
| - | <source name="terrecitoyenne"> | ||
| - | <info-url>http://terre-citoyenne.org/fileadmin/scrutari/AITC/scrutari-entete.xml</info-url> | ||
| - | </source> | ||
| - | <source name="sitecoredem"> | ||
| - | <info-url>http://scrutari.coredem.info/infos/xml/sitecoredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="fngm"> | ||
| - | <info-url>http://scrutari.coredem.info/infos/php/info.php?base=fngm</info-url> | ||
| - | </source> | ||
| - | <source name="lexicommon"> | ||
| - | <info-url>http://lexicommon.coredem.info/spip.php?page=scrutari_entete&id_exportscrutari=1</info-url> | ||
| - | </source> | ||
| - | <source name="arga"> | ||
| - | <info-url>http://bases.basedefiches.net/gouvafrique/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="cafolis"> | ||
| - | <info-url>http://www.cafolis.org/cgi-bin/scrutari/HEAD</info-url> | ||
| - | </source> | ||
| <source name="rsp"> | <source name="rsp"> | ||
| <info-url>http://bases.basedefiches.net/rsp/pub/scrutari/coredem.scrutari-info.xml</info-url> | <info-url>http://bases.basedefiches.net/rsp/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | + | <alias>base:/e17a05b0-c45e-11d8-9669-0800200c9a66/rsp</alias> |
| - | <source name="premiermai"> | + | |
| - | <info-url>http://bases.basedefiches.net/premiermai/pub/scrutari/coredem.scrutari-info.xml</info-url> | + | |
| </source> | </source> | ||
| - | <source name="ire"> | + | <source name="agter"> |
| - | <info-url>http://scrutari.i-r-e.org/bdf/sitecoredem.scrutari-info.xml</info-url> | + | |
| - | </source> | + | |
| - | <source name="edd"> | + | |
| - | <info-url>http://scrutari.coredem.info/infos/php/info.php?base=edd</info-url> | + | |
| - | </source> | + | |
| - | <source name="aei"> | + | |
| - | <info-url>http://scrutari.coredem.info/infos/xml/aei.scrutari-info.xml</info-url> | + | |
| - | </source> | + | |
| - | <source name="culturemedia"> | + | |
| - | <info-url>http://scrutari.coredem.info/infos/xml/culturemedia.scrutari-info.xml</info-url> | + | |
| - | </source> | + | |
| - | <source name="vecam"> | + | |
| - | <info-url>http://vecam.org/spip.php?page=scrutari-entete</info-url> | + | |
| - | </source> | + | |
| - | <source name="partagedeseaux"> | + | |
| - | <info-url>http://www.partagedeseaux.info/spip.php?page=scrutari-entete</info-url> | + | |
| - | </source> | + | |
| - | <source name="modop"> | + | |
| - | <info-url>http://bases.basedefiches.net/modop/pub/scrutari/coredem.scrutari-info.xml</info-url> | + | |
| - | </source> | + | |
| - | <source name="cetim"> | + | |
| - | <info-url>http://scrutari.coredem.info/infos/php/info.php?base=cetim</info-url> | + | |
| - | </source> | + | |
| - | <source name="agter_bdf"> | + | |
| <info-url>http://bases.basedefiches.net/agter/pub/scrutari/coredem.scrutari-info.xml</info-url> | <info-url>http://bases.basedefiches.net/agter/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="bienscommuns"> | ||
| - | <info-url>http://scrutari.coredem.info/infos/php/info.php?base=bienscommuns</info-url> | ||
| - | </source> | ||
| - | <source name="socioeco"> | ||
| - | <info-url>http://bases.basedefiches.net/ess/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="aitec"> | ||
| - | <info-url>http://aitec.reseau-ipam.org/spip.php?page=scrutari_entete&id_exportscrutari=1</info-url> | ||
| - | </source> | ||
| - | <source name="soletcivilisation"> | ||
| - | <info-url>http://bases.basedefiches.net/soletcivilisation/pub/scrutari/coredem.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="coredem_passerelles"> | ||
| - | <info-url>http://www.coredem.info/scrutari-info_passerelles.xml</info-url> | ||
| - | </source> | ||
| - | <source name="veblen"> | ||
| - | <info-url>http://www.veblen-institute.org/spip.php?page=scrutari_entete&id_exportscrutari=1</info-url> | ||
| - | </source> | ||
| - | <source name="ritimo"> | ||
| - | <info-url>http://www.ritimo.org/spip.php?page=scrutari_entete&id_exportscrutari=1</info-url> | ||
| - | </source> | ||
| - | <source name="alimenterre"> | ||
| - | <info-url>http://scrutari.coredem.info/csvconversion/alimenterre/ressources.scrutari-info.xml</info-url> | ||
| - | </source> | ||
| - | <source name="alliancesud"> | ||
| - | <info-url>http://www.alliancesud.ch/multimedia/spip.php?page=scrutari_entete&id_exportscrutari=1</info-url> | ||
| - | </source> | ||
| - | <source name="agter_spip"> | ||
| <info-url>http://www.agter.asso.fr/spip.php?page=scrutari_entete&id_exportscrutari=2</info-url> | <info-url>http://www.agter.asso.fr/spip.php?page=scrutari_entete&id_exportscrutari=2</info-url> | ||
| </source> | </source> | ||
| - | <source name="globalchance"> | + | <source name="coredem"> |
| - | <info-url>http://www.global-chance.org/spip.php?page=scrutari_info</info-url> | + | <uri>base:/coredem.info/core</uri> |
| + | <alias>base:/7121aba0-5232-11e1-b86c-0800200c9a66/passerelles</alias> | ||
| + | <alias>base:/e17a05b0-c45e-11d8-9669-0800200c9a66/sitecoredem</alias> | ||
| + | <scrutaridata-url freq="1">http://www.coredem.info/spip.php?page=scrutaridata_passerelles</scrutaridata-url> | ||
| + | <info-url>http://docs.fichotheque.net/coredem/scrutari/sitecoredem.scrutari-info.xml</info-url> | ||
| </source> | </source> | ||
| - | <source name="infogm"> | + | <source name="comedie"> |
| - | <info-url>http://scrutari.coredem.info/infos/php/info.php?base=infogm</info-url> | + | <scrutaridata-url freq="1">http://www.comedie.org/scrutari/comedie.scrutari-data.php</scrutaridata-url> |
| </source> | </source> | ||
| </sources> | </sources> | ||
| Ligne 145: | Ligne 69: | ||
| <info-url>http://www.agter.asso.fr/spip.php?page=scrutari_entete&id_exportscrutari=2</info-url> | <info-url>http://www.agter.asso.fr/spip.php?page=scrutari_entete&id_exportscrutari=2</info-url> | ||
| </source> | </source> | ||
| + | </code> | ||
| + | |||
| + | et l'exemple de la Coredem avec l'utilisation des deux éléments à la fois : | ||
| + | |||
| + | <code xml> | ||
| + | <source name="coredem"> | ||
| + | <scrutaridata-url freq="1">http://www.coredem.info/spip.php?page=scrutaridata_passerelles</scrutaridata-url> | ||
| + | <info-url>http://docs.fichotheque.net/coredem/scrutari/sitecoredem.scrutari-info.xml</info-url> | ||
| + | </source> | ||
| </code> | </code> | ||
| Ligne 155: | Ligne 88: | ||
| //<uri>// et //<alias>// ont la même syntaxe : leur texte doit être un URI de base valide (l'indication du protocole base: n'est pas obligatoire). | //<uri>// et //<alias>// ont la même syntaxe : leur texte doit être un URI de base valide (l'indication du protocole base: n'est pas obligatoire). | ||
| + | |||
| + | Voici ci-dessous l'exemple de la source Coredem qui fusionne les listes des revues Passerelles et la liste des sites membres de la Coredem. Initialement, ces deux données étaient gérées comme deux sources différentes avec des URI de bases distinctes. Le nouvel URI est //base:/coredem.info/core//. | ||
| + | |||
| + | <code xml> | ||
| + | <source name="coredem"> | ||
| + | <uri>base:/coredem.info/core</uri> | ||
| + | <alias>base:/7121aba0-5232-11e1-b86c-0800200c9a66/passerelles</alias> | ||
| + | <alias>base:/e17a05b0-c45e-11d8-9669-0800200c9a66/sitecoredem</alias> | ||
| + | <scrutaridata-url freq="1">http://www.coredem.info/spip.php?page=scrutaridata_passerelles</scrutaridata-url> | ||
| + | <info-url>http://docs.fichotheque.net/coredem/scrutari/sitecoredem.scrutari-info.xml</info-url> | ||
| + | </source> | ||
| + | </code> | ||
| Ligne 172: | Ligne 117: | ||
| </code> | </code> | ||
| - | ===== Améliorer et remplacer les méta-données du source ===== | + | ===== Améliorer et remplacer les méta-données de la source ===== |
| Il arrive que les méta-données d'une source sont peu remplies et pourraient être enrichies. Il est possible d'indiquer dans la configuration du moteur des méta-données destinées à compléter voire remplacer celles d'une source. | Il arrive que les méta-données d'une source sont peu remplies et pourraient être enrichies. Il est possible d'indiquer dans la configuration du moteur des méta-données destinées à compléter voire remplacer celles d'une source. | ||
| Ligne 180: | Ligne 125: | ||
| L'exemple suivant montre le contenu du fichier //base-metadata/ritimo.xml// indiquant l'icone à utiliser pour la source de nom « ritimo ». | L'exemple suivant montre le contenu du fichier //base-metadata/ritimo.xml// indiquant l'icone à utiliser pour la source de nom « ritimo ». | ||
| - | <code> | + | <code xml> |
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <base-metadata> | <base-metadata> | ||
