MOD passage du README dans le wiki

ADD architecture du serveur (pas fini)

diff --git a/README b/README
index eac117d..7a1fe75 100644 (file)
--- a/README
+++ b/README
@@ -1,81 +1 @@
-Ce document a pour but d'introduire le projet Euphorik, de décrire\r
-sa strucure et son utilisation au niveau du développement et de son\r
-utilisation.\r
-\r
-\r
-== Description ==\r
-Euphorik est un site web communautaire développé en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
-Il utilise massivement le javascript et l'AJAX coté client.\r
-\r
-== Installation ==\r
-L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
-est décrit dans le fichier /doc/installation.txt.\r
-\r
-\r
-== Dossiers / Fichiers ==\r
-\r
- /COPYING\r
-   La licence complète de euphorik.\r
-\r
-/VERSION\r
-   La version courante. Cette chaine est copiée à certains endroit des sources lors de l'execution du script "/tools/copie_num_version.rb"\r
-\r
- /index.yaws\r
-   La page principale du site. Elle est interprétée par le server HTTP Yaws et possède un petite partie dynamique.\r
-   \r
- /BD\r
-   Contient les fichiers de la base de données, initialement vide.\r
-   \r
- /BD/backups\r
-   Contient les backups de la base de données. A chaque changement de version de la base un backup est effectué, il est nommé "backup<num>" ou <num> est le numéro de version.\r
-   \r
- /css\r
-   Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
-      \r
- /doc\r
-   Contient la documentation (fonctionnel, technique, etc.).\r
-   \r
- /img\r
-   Contient les images du site avec un séparation des images propres à chaque skin.\r
-   Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.\r
-   \r
- /js\r
-   Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
-      \r
- /modules\r
-   Contient la partie serveur.\r
-   \r
- /modules/Makefile\r
-   Règle de compilation des modules du serveur.\r
-   \r
- /modules/ebin\r
-   Contient les modules compilées, initialement vide.\r
-   \r
- /module/erl\r
-   Contient le code sources des différents modules Erlang.\r
-   \r
- /modules/include\r
-   Contient certaines définitions Erlang (headers).\r
-   \r
- /pages\r
-   Contient certaines pages XHTML qui seront chargée via AJAX.\r
-   \r
- /sessions\r
-   Contient différentes sessions de travail pour le développement avec Scite.\r
-   \r
- /tools\r
-   Contient des outils diverses permettant l'aide au développement ou la mise en production.\r
-   \r
- /tools/tools.rb\r
-   Regoupe un ensemble d'outils permettant :\r
-    - La mise en production\r
-    - La vérification des fichiers JavaScript à l'aide de 'jslint.js'\r
-    - La mise à jour du numéro de version dans les sources à partir de /VERSION\r
-   Voir "tools.rb --help"\r
-   \r
- /tools/jsmin.rb\r
-   Permet la minification du javascript utilisé lors de la mise en production.\r
-      \r
- /tools/start_yaws.sh\r
-   Script shell permettant de lancer Yaws, utilisé uniquement pour le développement. Il faut s'assuré que Yaws n'est pas déjà démarré comme daemon avec d'exécuter ce script.\r
-      
\ No newline at end of file
+Tout est ici : http://dev.euphorik.ch/wiki/euk/Accueil
\ No newline at end of file

diff --git a/doc/architecture_serveur.svg b/doc/architecture_serveur.svg
new file mode 100644 (file)
index 0000000..002f28d
--- /dev/null
+++ b/doc/architecture_serveur.svg
@@ -0,0 +1,354 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="210mm"
+   height="297mm"
+   id="svg2"
+   sodipodi:version="0.32"
+   inkscape:version="0.46"
+   sodipodi:docname="schema_serveur.svg"
+   inkscape:output_extension="org.inkscape.output.svg.inkscape">
+  <defs
+     id="defs4">
+    <marker
+       inkscape:stockid="Arrow1Lstart"
+       orient="auto"
+       refY="0.0"
+       refX="0.0"
+       id="Arrow1Lstart"
+       style="overflow:visible">
+      <path
+         id="path3579"
+         d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z "
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;marker-start:none"
+         transform="scale(0.8) translate(12.5,0)" />
+    </marker>
+    <marker
+       inkscape:stockid="Arrow1Lend"
+       orient="auto"
+       refY="0.0"
+       refX="0.0"
+       id="Arrow1Lend"
+       style="overflow:visible;">
+      <path
+         id="path3582"
+         d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z "
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;marker-start:none;"
+         transform="scale(0.8) rotate(180) translate(12.5,0)" />
+    </marker>
+    <inkscape:perspective
+       sodipodi:type="inkscape:persp3d"
+       inkscape:vp_x="0 : 526.18109 : 1"
+       inkscape:vp_y="0 : 1000 : 0"
+       inkscape:vp_z="744.09448 : 526.18109 : 1"
+       inkscape:persp3d-origin="372.04724 : 350.78739 : 1"
+       id="perspective10" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="1.4"
+     inkscape:cx="334.11639"
+     inkscape:cy="851.68479"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1280"
+     inkscape:window-height="943"
+     inkscape:window-x="-4"
+     inkscape:window-y="-4" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Calque 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <text
+       xml:space="preserve"
+       style="font-size:28px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+       x="173.66833"
+       y="55.341621"
+       id="text3444"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan3446"
+         x="173.66833"
+         y="55.341621">Dépendances inter-modules</tspan></text>
+    <g
+       id="g3551"
+       transform="matrix(0.621787,0,0,0.621787,278.22386,181.10016)">
+      <rect
+         ry="0"
+         y="112.90382"
+         x="78.88028"
+         height="30.345304"
+         width="134.93559"
+         id="rect2672"
+         style="fill:#e9e9e9;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.68149883;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3452"
+         y="133.31572"
+         x="85.005302"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="133.31572"
+           x="85.005302"
+           id="tspan3454"
+           sodipodi:role="line">euphorik_bd</tspan></text>
+    </g>
+    <g
+       id="g3546"
+       transform="matrix(0.621787,0,0,0.621787,442.51445,8.0632701)">
+      <rect
+         ry="0"
+         y="152.88066"
+         x="75.043365"
+         height="30.185959"
+         width="206.49709"
+         id="rect3456"
+         style="fill:#f3ef6f;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.84084421;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3458"
+         y="173.21289"
+         x="81.08873"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="173.21289"
+           x="81.08873"
+           id="tspan3460"
+           sodipodi:role="line">euphorik_bd_admin</tspan></text>
+    </g>
+    <g
+       id="g3472"
+       transform="matrix(0.621787,0,0,0.621787,349.74055,141.12082)">
+      <g
+         id="g3477">
+        <g
+           id="g3482"
+           transform="translate(6.0609153,-39.395949)">
+          <rect
+             ry="0"
+             y="150.85217"
+             x="225.04285"
+             height="30.202318"
+             width="198.43222"
+             id="rect3466"
+             style="fill:#e9e9e9;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.82448417;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+          <text
+             sodipodi:linespacing="125%"
+             id="text3468"
+             y="171.19258"
+             x="231.09639"
+             style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+             xml:space="preserve"><tspan
+               y="171.19258"
+               x="231.09639"
+               id="tspan3470"
+               sodipodi:role="line">euphorik_common</tspan></text>
+        </g>
+      </g>
+    </g>
+    <g
+       id="g3541"
+       transform="matrix(0.621787,0,0,0.621787,312.79634,-20.869345)">
+      <rect
+         ry="0"
+         y="199.39748"
+         x="75.308319"
+         height="30.215113"
+         width="192.24052"
+         id="rect3487"
+         style="fill:#f3ef6f;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.81169093;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3489"
+         y="219.74429"
+         x="81.368256"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="219.74429"
+           x="81.368256"
+           id="tspan3491"
+           sodipodi:role="line">euphorik_daemon</tspan></text>
+    </g>
+    <g
+       id="g3536"
+       transform="matrix(0.621787,0,0,0.621787,33.562539,98.935449)">
+      <rect
+         ry="0"
+         y="245.24152"
+         x="74.009476"
+         height="29.955635"
+         width="337.69534"
+         id="rect3493"
+         style="fill:#e9e9e9;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.07116878;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3495"
+         y="265.45859"
+         x="79.939674"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="265.45859"
+           x="79.939674"
+           id="tspan3497"
+           sodipodi:role="line">euphorik_minichat_conversation</tspan></text>
+    </g>
+    <g
+       id="g3531"
+       transform="matrix(0.621787,0,0,0.621787,75.136293,-18.261854)">
+      <rect
+         ry="0"
+         y="286.55777"
+         x="71.040016"
+         height="30.180254"
+         width="209.34853"
+         id="rect3499"
+         style="fill:#e9e9e9;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.84654981;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3501"
+         y="306.88715"
+         x="77.082527"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="306.88715"
+           x="77.082527"
+           id="tspan3503"
+           sodipodi:role="line">euphorik_protocole</tspan></text>
+    </g>
+    <g
+       id="g3526"
+       transform="matrix(0.621787,0,0,0.621787,77.801089,-107.91954)">
+      <rect
+         ry="0"
+         y="339.40631"
+         x="71.031403"
+         height="30.197493"
+         width="200.79434"
+         id="rect3509"
+         style="fill:#f3ef6f;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.82931072;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3511"
+         y="359.74429"
+         x="77.082535"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="359.74429"
+           x="77.082535"
+           id="tspan3513"
+           sodipodi:role="line">euphorik_requests</tspan></text>
+    </g>
+    <g
+       id="g3521"
+       transform="matrix(0.621787,0,0,0.621787,205.41324,-137.23236)">
+      <rect
+         ry="0"
+         y="386.49799"
+         x="80.980209"
+         height="30.299879"
+         width="153.75388"
+         id="rect3515"
+         style="fill:#f3ef6f;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.72692496;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3517"
+         y="406.88715"
+         x="87.082535"
+         style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:Bitstream Vera Sans;-inkscape-font-specification:Bitstream Vera Sans"
+         xml:space="preserve"><tspan
+           y="406.88715"
+           x="87.082535"
+           id="tspan3519"
+           sodipodi:role="line">euphorik_test</tspan></text>
+    </g>
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 307.83923,122.15313 L 364.94873,251.09041"
+       id="path4358"
+       inkscape:connector-type="polyline"
+       inkscape:connection-start="#g3521"
+       inkscape:connection-end="#g3551" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 416.12377,122.15313 L 372.48582,251.09041"
+       id="path5406"
+       inkscape:connector-type="polyline"
+       inkscape:connection-start="#g3541"
+       inkscape:connection-end="#g3551" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 289.88826,260.73645 L 327.05872,260.73644"
+       id="path5410"
+       inkscape:connector-type="polyline"
+       inkscape:connection-start="#g3536"
+       inkscape:connection-end="#g3551" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 184.39315,122.15313 L 184.39315,159.65286"
+       id="path5412"
+       inkscape:connector-type="polyline"
+       inkscape:connection-start="#g3526"
+       inkscape:connection-end="#g3531" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 203.89123,178.94492 L 349.72311,251.09041"
+       id="path5935"
+       inkscape:connector-type="polyline"
+       sodipodi:nodetypes="ccc"
+       inkscape:connection-end="#g3551"
+       inkscape:connection-start="#g3531" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62178701px;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-opacity:1"
+       d="M 553.53181,122.15313 L 554.97138,210.16652"
+       id="path6979"
+       inkscape:connector-type="polyline"
+       inkscape:connection-end="#g3472"
+       inkscape:connection-start="#g3546" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 249.74143,178.20275 L 493.18154,211.37204"
+       id="path7502"
+       inkscape:connector-type="polyline"
+       inkscape:connection-end="#g3472"
+       inkscape:connection-start="#g3531"
+       sodipodi:nodetypes="cc" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 541.39029,122.15313 L 381.20495,251.09041"
+       id="path8027"
+       inkscape:connector-type="polyline"
+       inkscape:connection-end="#g3551"
+       inkscape:connection-start="#g3546" />
+    <path
+       style="opacity:1;fill:none;fill-rule:evenodd;stroke:#7a7a7a;stroke-width:0.62199998;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow1Lend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="M 184.41159,178.94492 L 184.54951,251.09042"
+       id="path8550"
+       inkscape:connector-type="polyline"
+       inkscape:connection-end="#g3536"
+       inkscape:connection-start="#g3531" />
+  </g>
+</svg>