Commit 80856446 authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

dev bundle : update routes and readme

parent f65d7281

README.md

+2 −3
Original line number Diff line number Diff line
@@ -90,7 +90,7 @@ Exemple de configuration minimale : 
Il contient le serveur BaseX. C'est un dossier (caché) purement technique dans lequel l'utilisateur n'aura pas (et ne devra pas) intervenir.





## Lien symbolique dans un environnement de développement

## Lien symbolique dans un environnement de développement du core



- `.max/basex/webapp/max/` pointe vers  `src/main`
@@ -110,8 +110,7 @@ Elles sont déclarées dans le fichier `src/main/core/routes.xqm` : 
  - 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-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

- `/about.html` : affiche les informations de configuration et d'environnement (disponible uniquement en mode `dev`)

- `/doc/functions.html` : documentation API XQuery de MaX (disponible uniquement en mode `dev`)





## Organisation d'un corpus numérique

src/main/bundles/max-dev/README.md

+11 −2
Original line number Diff line number Diff line 
Bundle max-dev

====



Fonctionnalités actives uniquement en environnement "dev".



```xml

<configuation env="dev"...>...</configuration>

```



## Routes

- `/dev.html` : affiche les informations de configuration et d'environnement (disponible uniquement en mode `dev`)

- `/doc/functions.html` : documentation API XQuery de MaX (disponible uniquement en mode `dev`)
 
 No newline at end of file
 
- `/bundles/max-dev/index.html` : affiche les informations de configuration et d'environnement

- `/bundles/max-dev/doc.html` : documentation API XQuery de MaX
 
 No newline at end of file

src/main/bundles/max-dev/max-dev.xqm

+3 −3
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ declare 
%rest:GET

%output:method("html")

%output:html-version('5')

%rest:path("/max-dev/about.html")

%rest:path("/bundles/max-dev/index.html")

function max-dev:index() as element(){

    if(conf:is-dev-mode())

    then
@@ -94,7 +94,7 @@ function max-dev:index() as element(){ 
            <section>

                <h2>Documentation</h2>

                <div>

                    <a href="/doc/functions.html">Consulter l'API XQuery de MaX</a>

                    <a href="/bundles/max-dev/doc.html">Consulter l'API XQuery de MaX</a>

                </div>

            </section>

        </body>
@@ -112,7 +112,7 @@ declare 
%rest:GET

%output:method("html")

%output:html-version('5')

%rest:path("/max-dev/doc.html")

%rest:path("/bundles/max-dev/doc.html")

function max-dev:functions-documentation(){

    if(conf:is-dev-mode())

    then

src/main/bundles/max-dev/post-render.xq

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ declare variable $html external; 
if(conf:is-dev-mode())

then

let $devLink :=<a

    style="position: fixed; bottom :5px; left: 5px; background-color: #333; padding: 2px 5px; color: white" href="/max-dev/about.html">?</a>

    style="position: fixed; bottom :5px; left: 5px; background-color: #333; padding: 2px 5px; color: white" href="/bundles/max-dev/index.html">?</a>

return

    copy $c := $html

    modify (