Commit 0847ae48 authored by Jérôme Chauveau's avatar Jérôme Chauveau
Browse files

rename max-dumb-bundle as max-dumb-tei-bundle

parent e0e1594a
Loading
Loading
Loading
Loading
+5 −5
Changes for README.md: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -22,13 +22,13 @@ L'application est scindée en 2 blocs :
 - le cœur : déclaration des routes/fonctionnalités de base, accès aux sources xml et à la configuration, système de templating, traduction etc.
 - les bundles : chaque bundle ajoute une (ou des) fonctionnalité(s) à MaX.

Ce dépôt embarque `max-dumb-bundle`, un bundle de vocabulaire d'exemple de gestion de l'affichage de sources XML.
Ce dépôt embarque `max-dumb-tei-bundle`, un bundle de vocabulaire d'exemple de gestion de l'affichage de sources XML.

Les sources XML à afficher doivent être stockées dans une base nommée `max`.

## Bundle de vocabulaire
    
Un bundle de *vocabulaire* est spécialisé dans le rendu d'un vocabulaire XML. C'est le cas du `max-dumb-bundle`.
Un bundle de *vocabulaire* est spécialisé dans le rendu d'un vocabulaire XML. C'est le cas du `max-dumb-tei-bundle` (il affiche une table des matières et les sources brutes non transformées pour des sources XML-TEI/.
Ce type de bundle doit contenir :

 - une fonction xquery déclarée dans l'espace de nom du bundle et définie par `[ns]:doc-to-html($document as document-node(), $lang as xs:string)`
@@ -53,7 +53,7 @@ Exemple de configuration minimale :

```html
<!-- config.xml -->
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-bundle">
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-tei-bundle">
    <languages>
        <language>fr</language>
        <language>en</language>
@@ -94,7 +94,7 @@ Elles sont déclarées dans le fichier `src/main/core/routes.xqm` :
  - `autoroute/{$page}.xq` : si le fichier existe
  - sinon, `.max/basex/webapp/max/bundles/${bundle_vocabulaire}/autoroute/{$page}.xq` : si le fichier existe
  - sinon, exécute la fonction `${bundle_vocabulaire}:doc-to-html` du bundle de vocabulaire actif (transformation de la source `{$page}.xml`)
  Par exemple, si `max-dumb-bundle` est actif, la route `/fr/tdm.html` retourne le résultat de `.max/basex/webapp/max/bundles/max-dumb-bundle/autoroute/tdm.xq`
  Par exemple, si `max-dumb-tei-bundle` est actif, la route `/fr/tdm.html` retourne le résultat de `.max/basex/webapp/max/bundles/max-dumb-tei-bundle/autoroute/tdm.xq`
- `/sources.zip` : archive zip contenant les sources XML
- `/max-infos.html` : affiche les informations de configuration et d'environnement. (disponible uniquement en mode `dev`)

@@ -130,7 +130,7 @@ Elles sont déclarées dans le fichier `src/main/core/routes.xqm` :
#### Autoroute

Créer dans le dossier du bundle un fichier `autoroute/my_feature.xq`. Le résultat de cette XQuery est automatiquement disponible sur la route :
`/{$lang=[a-z]{2}}/my_feature.html`. Un exemple (tdm.xq) est disponible dans le `max-dumb-bundle`.
`/{$lang=[a-z]{2}}/my_feature.html`. Un exemple (tdm.xq) est disponible dans le `max-dumb-tei-bundle`.
Cette XQuery reçoit le paramètre `$lang` issu de la route courante.

#### Fonctionnalité avancée
+1 −1
Changes for config.xml.sample: 1 added line, 1 removed line.
Original line number Diff line number Diff line
<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-bundle">
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-tei-bundle">
    <languages>
        <language>fr</language>
        <language>en</language>
+1 −1
Changes for fixtures/config.xml: 1 added line, 1 removed line.
Original line number Diff line number Diff line
<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-bundle">
<configuration xmlns="http://certic.unicaen.fr/max/ns/1.0" env="dev" vocabulary-bundle="max-dumb-tei-bundle">
    <languages>
        <language>fr</language>
        <language>en</language>
+4 −4
Changes for src/main/bundles/max-dumb-tei-bundle/dumb-tei/dumb-tei.xqm: 4 added lines, 4 removed lines.
Original line number Diff line number Diff line
xquery version "3.0";

(:~
: MaX "dumb" bundle
: MaX "dumb-tei" bundle
:)
module namespace dumb = "https://certic.unicaen.fr/max/bundles/dumb";
module namespace dumb-tei = "https://certic.unicaen.fr/max/bundles/dumb-tei";

import module namespace templating = "https://certic.unicaen.fr/max/templating" at '../../../core/templating.xqm';
import module namespace database = "https://certic.unicaen.fr/max/database" at '../../../core/database.xqm';
import module namespace errors = "https://certic.unicaen.fr/max/errors" at '../../../core/errors.xqm';

declare function dumb:doc-to-html($document as document-node(), $lang as xs:string){
declare function dumb-tei:doc-to-html($document as document-node(), $lang as xs:string){
    (:generate random http link to an identified node in $document:)
    let $identifiers:= $document//*/@xml:id/string()
    let $n := count($identifiers)
@@ -37,7 +37,7 @@ declare
%output:html-version("5.0")
%output:encoding("UTF-8")
%rest:path("/{$lang=[a-z]{2}}/{$docPath=.+}/id/{$id}.html")
function dumb:id-to-html($lang as xs:string, $docPath as xs:string, $id as xs:string){
function dumb-tei:id-to-html($lang as xs:string, $docPath as xs:string, $id as xs:string){
   try {
    let $node := database:get-element-by-id($docPath || '.xml', $id)
    let $content := <div>
Loading