Prima o poi, seguiamo la pista (CCK || Taxonomy) -> Views -> Advanced Help, perchè con Views ci vuole tutto l'aiuto che puoi trovare.
Se poi avventuriamo nel scrivere codice, conviene creare un modulo per contenere (la maggioranza) di questo codice.
Se avete una memoria terribile, come me, allora conviene anche tenere una documentazione di questi piccoli - ma essenziali - ritocchi. Ma dove metti questa documentazione, e come la trovi?
A me sembra logico tenerla con il codice, magari in um formatto che conosco, e (ovviamente) senza aggiungere nient'altro. Nessun modulo nuovo, nemeno una riga di codice in più. Infatti sto 'riutilizzando' Advanced Help per visualiizzare questo documentazione, che è in formatto HTML.
Così, per ogni nuovo progetto, nella cartella sites/all/modules o sites/default/modules creo un modulo col nome del progetto, dentro la quale metto:
progetto.info
progetto.install
progetto.module
help/progetto.help.ini
help/doc.htmlE nel
help/progetto.help.ini metto:[doc]
title = Note di sviluppo del progetto 'progetto'In questo modo, posso arrivare alla documentazione tramite
admin/advanced_help/progetto
E vuoi, come lo fatte?
John
Non l'ho mai fatto, sono troppo disordinato.
Ma se lo dovessi fare userei http://drupal.org/project/helpinject in aggiunta ad advanced help.
Certified to Rock
Questo modulo e molto interesante :) http://drupal.org/project/sitedoc
----------------------------------------
bI’Iqchugh’ yIvang !
Se sei triste, agisci!
Proverbio Klingon
Thank you for those...
Non sapevo di Help Inject, ma avevo sperimentato Site Documentation - soprattutto per la capacità di scoprire gli orfani nelle tabelle del db. Nancy Wichmann ha anche svilupata Site Notes, che permette la documentazione tramite Drupal stesso. Non lo provato. Prabilimente può servire ai utenti 'gestore' del sito. Per il momento, uso AH perchè la documentazione e read-only - ho già avuto un gestore cancellare 20 nodi (incluso l'home-page) per 'controllare che funzionasse'. Ho chiesto se fa lo stesso anche con il suo hard-disk. Sigh.
Più imparo, più dubito.
se devo documentare il mio codice uso il modulo API e le funzioni documentate con phpdocumentation, poi ovviamente un Wiki con la doc in parallelo, magari quellodi trrac (che quindi è collegato a ticket system & c.)
Ciao
Marco
--
My blog
Working at @agavee
Porta pazienza se ti chiedo dettaglie...
Mi piace il 'se' ;-) Credo che era Java la prima linguaggio di programmazione a introdurre un 'compilatore' per la documentazione (JavaDoc). Stiamo parlando di phpDocumentor? E' quello che viene usato per il core Drupal?
Hmmm. Ho perso di vista Trac dopo il 2006. Allora un problema (dove stavo lavorando) era che non gestiva progetti multipli. Vedo che questo è ancora sulla lista 'to do'. Comunque mi sembrava un ottimo programma, e anche un ottimo codebase per studiare Python.
Più imparo, più dubito.
Assolutamente nessun problema, anzi, mi fa piacere scambiare un pò di info in merito :)
A me no, ma purtroppo è così, a volte scrivi codice e commenti inline, ma non fai della vera documentazione, con tutti i problemi che questo causa, ma è anceh vero che a volte il codice cambia tealmente velocemente che la documentazione invecchia prima di essere finita.
Si, stiamo parlando di phpDocumentor, che è "uno standard" nella documentazione PHP, anche se imho ha alcune pecche e in alcuni punti è troppo complesso per essere veramente comodo da usare, ma per le funzioni/classi va più che bene.
Temo che non sia cambiato tantissimo..
AHIAAAAAAAAAA!!! hai pigiato subito il tasto dolente :P
Scherzi a parte, si è un problema MA nemmeno troppo, installazioni multiple per ogni progetto, ha i suoi svantaggi, ma anche vantaggi (anceh perché ogni progetto aha alcune sue peculiarità), c'è di buono che ci sono talmetne tanti plugin attorno che lo integri con quasi qualsiasi cosa (chi ha detto netbeans?)
He già, e imho lo resterà per sempre, credo che per come sa progettato la multiprogettualità sia più complessa da implementare che non la riscrittura da 0 del progetto.
Già, anche se poi effettivamente sono pochi i casi in cui devi sviluppare plugin. Ha dalla sua ua quantità veramente industriale di plugin, puoi fare praticamente qualsiasi cosa (tranne gestire il multiprogetto :D)
Ciao
Marco
--
My blog
Working at @agavee