Commit 901535d2 authored by Anne Goloubkoff-Duponchel's avatar Anne Goloubkoff-Duponchel
Browse files

Merge branch 'pdn/doc' into ag/doc 

merge des branches
parents ae549785 5e031bf1

documentation/docs/index.md

+2 −2
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ MaX, pour Moteur d’Affichage XML, est un moteur d’affichage qui permet la c 
 * **couche métier** : RestXQ / XQuery / XSLT,

 * **couche présentation** : HTML / CSS / Javascript.



 ![Alt text](images/schemaMax.png)

 ![Schéma représentant MaX](images/schemaMax.png)
@@ -48,7 +48,7 @@ Pour afficher une page d’une édition hébergée par MaX, le cœur applicatif 


* requêtage,

* transformation XSL,

* génération de page HTML,

* génération de pages HTML,

* exécution des plugins éventuels.



<br/>

documentation/docs/layout.md

+6 −3
Original line number Diff line number Diff line
@@ -4,7 +4,8 @@ 


Le template de mise en page par défaut se trouve dans **ui/templates/[tei ou ead].html**.



Il est possible de remplacer cette mise en page en créant son propre template dans `editions/[projectId]/ui/templates/template.html`.

Il est possible de remplacer cette mise en page en créant son propre template dans `editions/[edition]/ui/templates/template.html`.





Le template contient des références à des variables qui seront remplacées par le contenu correspondant à l’affichage. Les paramètres disponibles sont :
@@ -27,10 +28,12 @@ Le template contient des références à des variables qui seront remplacées pa 


<br/>



Il peut être également pratique, dans certains cas, de faire référence à un template qui se trouve dans une autre édition. Dans ce cas, il est possible d'ajouter dans mon-edition\_config\_inc.xml un élément ``<template file="chemin-vers-mon-template"/>``





Il peut être également pratique, dans certains cas, de faire référence à un template autrement nommé ou qui se trouve dans une autre édition. Dans ce cas, il est possible d’ajouter dans mon-edition\_config\_inc.xml un élément :



```

<template file="le/chemin/vers/le/templateCustomisé.html"/>

```



````xml

<!-- Exemple de template -->

tools/max.sh

+42 −10
Original line number Diff line number Diff line
@@ -5,6 +5,25 @@ DIRECTORY=$(cd `dirname $0` && pwd) 
MAX_PLUGINS_DIR=$DIRECTORY/../plugins

BASEX_CLIENT_BIN="basexclient"

BASEX_BIN="basex"

DEMO_RELEASE_URL="https://git.unicaen.fr/chauveau/max-tei-demo/-/archive/v1.0/max-tei-demo-v1.0.zip"



dependency_test(){

  result=$(command -v $1)

  if [ -z $result ]

  then

      echo 'Dependency '$1' not satisfied - please install it first'

      exit -1

  else

      echo 'Dependency '$1' satisfied'

  fi

}



dependencies=(wget npm xmllint)



for bin in ${dependencies[@]}

do

    dependency_test $bin

done





#checks and set basex bin
@@ -38,7 +57,6 @@ display_usage(){ 
}







list_plugins(){

  echo -e ''

  echo -e 'MaX plugins : '
@@ -186,8 +204,15 @@ demo_edition_build(){ 
#    echo "  -> resource files copy: DONE"

    cd $DIRECTORY/../editions

    echo "Downloading Max TEI Demo ressources"

     wget https://git.unicaen.fr/chauveau/max-tei-demo/-/archive/v1.0/max-tei-demo-v1.0.zip



    wget $DEMO_RELEASE_URL



    getResult=$?

    if [ $getResult -ne 0 ]

    then

     echo 'MaX demo install error : Cannot fetch '$DEMO_RELEASE_URL

     exit -1

    fi

    unzip max-tei-demo-v1.0.zip

    mv max-tei-demo-v1.0 max_tei_demo

    rm max-tei-demo-v1.0.zip
@@ -255,7 +280,7 @@ init_max(){ 
#creates config file if not exists (.dist copy)

if [ ! -f $DIRECTORY/../configuration/configuration.xml ]

then

    echo "Configuration file does not exists: copying the .dist one"

    echo "Configuration file does not exist: copying the .dist one"

    cp  $DIRECTORY/../configuration/configuration.dist.xml $DIRECTORY/../configuration/configuration.xml

fi
@@ -268,10 +293,17 @@ then 
    new_edition_build $project_id $db_path $xmlns

    read -e -p "XML sources path ? " data_path

    db_project_feed $db_path $data_path

    mkdir $DIRECTORY/../editions/$project_id/fragments

    mkdir $DIRECTORY/../editions/$project_id/xq

    mkdir $DIRECTORY/../editions/$project_id/ui

    mkdir $DIRECTORY/../editions/$project_id/ui/css

    mkdir $DIRECTORY/../editions/$project_id/ui/js

    mkdir $DIRECTORY/../editions/$project_id/ui/fonts

    mkdir $DIRECTORY/../editions/$project_id/ui/i18n

    mkdir $DIRECTORY/../editions/$project_id/ui/images

    mkdir $DIRECTORY/../editions/$project_id/ui/js

    mkdir $DIRECTORY/../editions/$project_id/ui/templates

    mkdir $DIRECTORY/../editions/$project_id/ui/xsl



    touch $DIRECTORY/../editions/$project_id/ui/css/$project_id.css

    cp $DIRECTORY/menu_default.xml $DIRECTORY/../editions/$project_id/menu.xml

    if [ $xmlns = 'ead' ]

documentation/docs/menu.md

+1 −1

File changed.

Contains only whitespace changes.