Changeset 75092 in spip-zone

Timestamp:

Aug 29, 2013, 3:16:31 PM (7 years ago)

Author:

marcimat@…

Message:

Mise à jour des scripts et documentation

Location:

_galaxie_/code.spip.net

Files:

• readme.md (modified) (4 diffs)
• scripts/trunk/autodoc_plugins.sh (added)
• scripts/trunk/autodoc_spip.sh (added)
• scripts/trunk/phpdoc_spip.xml (added)

_galaxie_/code.spip.net/readme.md

@@ -29 +29 @@
 
 - `ZoraApi` gère l'objet éditorial d'Api, dans la table `spip_api_fonctions`.
-- `ZoraCode` fournit des fonctions pour analyser un code source PHP et extraire des docBlock
+- `ZoraCode` fournit des fonctions pour analyser un code source PHP et
+   extraire des docBlock
 - `ZoraDocBlock` gère les propositions et commits de docBlock
 
@@ -41 +42 @@
 
 La branche 2.0a13 fonctionne avec phpDocumentor 2.0a13.
-Le trunk fonctionne(ra) avec phpDocumentor 2.0b8+.
+Le trunk fonctionne avec phpDocumentor 2.0b8+.
 
-Répertoire `autodoc/branche/2.0a13`
+Répertoire `autodoc/branche/2.0a13` (à supprimer)
 -----------------------------------
 
@@ -72 +73 @@
 Chantier en cours. Il vise à refaire le code de l'autodoc avec la version beta de phpDocumentor.
 
-- `plugin-zora` (à faire)
-- `template-zora` (à faire)
+- `plugin-zora` augmente certaines fonctionnalités de phpDocumentor notamment pour :
+
+    - gérer les liens vers trac ou redmine
+    - gérer les répertoires (phpDocumentor ne s'occupe que des namespaces et packages)
+    - gérer les apis également en tant qu'élément spécifique
+    - gérer les tags spécifiques à SPIP (@balise, @filtre, ...)
+    - permettre que @uses ajoute @usedby sur les fonctions globales
+    - ajoute des fonctions Twig pour les templates, active le mode debug.
+    - ajoute la gestion d'options spécifiques pour la génération de
+      l'autodoc à destination de code.spip.net, afin que cette
+      génération mette le bon lien de retour sur l'image du bandeau
+      et qu'elle ajoute les boutons de propositions d'amélioration de
+      docblock.
+
+- `template-zora`  est le template Twig pour générer la documentation
+   HTML à partir de l'objet «projet» généré par phpDocumentor
+   2.0. Ce template utilise un peu  les mêmes mécanismes que Zcore
+   chez SPIP, avec le même système de répertoires que spipr.
 
 
@@ -83 +100 @@
 Il ne sont pas génériques mais peuvent servir d'aide.
 
-- `scripts/branches/2.0a13` : scripts pour cette version de phpDocumentor.
-- `scripts/trunk` : scripts pour phpDocumentor 2.0b8+ (à faire).
+- `scripts/branches/2.0a13` : scripts pour cette version de
+phpDocumentor. (à supprimer)
+- `scripts/trunk` : scripts pour phpDocumentor 2.0.