Forum: Italian Ruby user group implementare help online e inline

Salve a tutt*,

devo implementare l'help online in una mia applicazione già sviluppata
- e per le applicazioni che svilupperò in futuro.

I requisiti, almeno quelli che mi vengono in mente per ora:

* l'help dev'essere localizzato;

* devono esserci varie pagine di help più o meno collegate (manuale,
faq, troubleshoots...);

* dev'esserci help contestuale (pulsanti what's this, aiuto per i vari
form, etc.);

* a differenza delle pagine di help, l'help contestuale dev'essere
mostrato inline (in pratica devono essere frammenti html da infilare
al volo in un div);

* dev'essere robusto e testabile, vale a dire:
  robusto: non deve esplodere se un help manca, ma mostrare semmai un
"nessun aiuto per questo elemento";
  testabile: voglio sapere se ci sono help mancanti o inutilizzati;

* (opzionale) sarebbe bello se si potesse in qualche modo estrarne
help statico, html, latex o quel che capita;

Inizialmente avevo buttato giù un sistema di template ed helper, che
però non mi soddisfa, perché, oltre a non essere né robusto né 
testabile, sta diventando complicatissimo da gestire man mano che
aggiungo help.

Ho provato a cercare in giro, ma non ho trovato niente di adatto.


Avete idee, suggerimenti, consigli o altro?

grazie


pietro

te la butto lì, magari ti fa arrivare a qualcosa di meglio :P

per le pagine di manuale, presumo tu possa concepirlo in "Argomenti"
(contenitore) e "Pagine" (contenuto), a quel punto puoi aggiungere
quello che vuoi e correlarlo.

per l'help contestuale potresti prendere in considerazione YAML assieme
a qualche helper: con YAML strutturi l'albero degli aiuti come
preferisci, puoi localizzarlo in varie lingue, e soprattutto puoi creare
valori "vuoti" che ti permettono di sapere se è presente un help.
l'helper ti agevolerebbe per usarli nei template.

spero di aver capito quello che intendevi :P

ciao,
A.

Io da qualche anno uso la dokuwiki (un progetto in php 
http://www.dokuwiki.org/ ) come contenitore di documentazioni. L'help 
contestuale lo gestisco all'interno del singolo applicativo, attraverso 
l'internazionalizzazione di rails che in pratica è quanto ti ha 
suggerito Andrea.