source: spip-zone/_galaxie_/code.spip.net/readme.md @ 104202

Last change on this file since 104202 was 76973, checked in by marcimat@…, 7 years ago

Mises à jour du readme, suppression de la branche a13 devenue caduque.
Note sur le .htaccess

File size: 2.9 KB
Line 
1Site code.spip.net
2==================
3
4Ce projet de site de documentation d'API et de phpdoc portait le nom de code `Zora`.
5Ceci explique le nommage des plugins utilisés pour SPIP et pour phpDocumentor.
6De même, le thème graphique `Zora` est en partie commun aux 2 espaces.
7
8Le site est décomposé en 2 parties, qui se retrouvent ici en 2 répertoires distincts.
9La partie `autodoc` (documentation automatique du code) est générée par phpDocumentor ;
10le reste est géré par SPIP.
11
12
13htaccess
14--------
15Il y a une ligne de .htaccess personnalisé à ajouter pour gérer
16les redirections http://code.spip.net/@fonction vers l'autodoc.
17
18        ```
19        RewriteRule ^@(.+)$     autodoc/@$1 [QSA,R,L]
20        ```
21
22
23Organisation des répertoires
24============================
25
26- `spip-zora` : Site SPIP
27- `autodoc` : pour phpDocumentor
28- `scripts` : scripts pour les exécution
29
30
31Répertoire `spip-zora`
32----------------------
33
34Contient les plugins, squelettes et thème pour le site SPIP, c'est à dire
35tout le site sauf la partie d'Autodoc.
36Ces squelettes s'appuient sur `spipr-dist` dont ils dépendent donc.
37
38Les plugins sont au nombre de 3 :
39
40- `ZoraApi` gère l'objet éditorial d'Api, dans la table `spip_api_fonctions`.
41- `ZoraCode` fournit des fonctions pour analyser un code source PHP et
42   extraire des docBlock
43- `ZoraDocBlock` gère les propositions et commits de docBlock
44
45
46Répertoire `autodoc`
47--------------------
48
49Contient la partie permettant de faire fonctionner phpDocumentor pour SPIP.
50Le code PHP ou de template (twig) n'a rien à voir avec SPIP, mais est spécifique
51à l'intégration avec phpDocumentor.
52
53Répertoire `autodoc/trunk`
54--------------------------
55
56Fonctionne avec phpDocumentor 2.0.0+.
57
58- `plugin-zora` augmente certaines fonctionnalités de phpDocumentor notamment pour :
59
60    - gérer les liens vers trac ou redmine
61    - gérer les répertoires (phpDocumentor ne s'occupe que des namespaces et packages)
62    - gérer les apis également en tant qu'élément spécifique
63    - gérer les tags spécifiques à SPIP (@balise, @filtre, ...)
64    - permettre que @uses ajoute @usedby sur les fonctions globales
65    - ajoute des fonctions Twig pour les templates, active le mode debug.
66    - ajoute la gestion d'options spécifiques pour la génération de
67      l'autodoc à destination de code.spip.net, afin que cette
68      génération mette le bon lien de retour sur l'image du bandeau
69      et qu'elle ajoute les boutons de propositions d'amélioration de
70      docblock.
71
72- `template-zora`  est le template Twig pour générer la documentation
73   HTML à partir de l'objet «projet» généré par phpDocumentor
74   2.0. Ce template utilise un peu  les mêmes mécanismes que Zcore
75   chez SPIP, avec le même système de répertoires que spipr.
76
77
78
79Répertoire `scripts`
80--------------------
81
82Scripts .sh pour l'installation et les crons sur un serveur.
83Il ne sont pas génériques mais peuvent servir d'aide.
84
85- `scripts/trunk` : scripts pour phpDocumentor 2.0.
86
87
Note: See TracBrowser for help on using the repository browser.