Al momento utilizziamo un sistema chiamato AsciiDoc che ci consente di creare documentazione in un semplice markup di testo. Da ciò possiamo generare più formati di output. Utilizziamo solo i formati di output pdf e chm.
Mi stavo chiedendo se ci fosse un'alternativa a chm? Quello che sto cercando è qualcosa che può essere usato off-line (questo è importante perché molti dei nostri utenti sono in posti molto remoti) con il nostro software. Dovrebbe avere un indice (può essere semplice come una pagina html con termini con collegamenti ipertestuali), dovrebbe essere ricercabile e dovrebbe avere un meccanismo che consente di richiamare voci specifiche dal codice (simile alla guida sensibile al contesto).
Le due cose che sono contro il PDF in questo caso sono:
- La guida sensibile al contesto non è un'opzione
- Generalmente il documento è piuttosto grande
- Il PDF è più adatto alla documentazione stampata rispetto alla guida sensibile al contesto
Quello che vorrei è usare html. L'unico problema con html è che non riesco a capire come fornire automaticamente una ricerca per parole chiave (oltre alla funzionalità ctrl + f del browser - vorrei qualcosa di più evidente). Inoltre, non riesco a trovare un metodo per generare automaticamente un indice ipertestuale di parole chiave. La guida sensibile al contesto sarebbe semplice a causa dei tag della sezione: potrei semplicemente passare l'URL della pagina e la sezione che sono interessato al browser predefinito e quella pagina dovrebbe caricarsi nella sezione corretta.
Le mie esigenze suonano molto come chm - lo fanno. Ho modellato le mie esigenze da chm. L'unica ragione per cui non mi piace chm è a causa del modo in cui il codice interagisce con esso usando mapid e così via. Preferirei piuttosto archiviare una lista di testo semplice (generata automaticamente per me) che il mio codice può utilizzare per accedere alla porzione sensibile al contesto della documentazione.
Sto immaginando uno script che passi attraverso i file di output html e generi una pagina indice che contiene semplicemente un elenco di parole chiave trovate. ovviamente dovrebbe esserci un meccanismo di esclusione delle parole per ignorare parole come: il, è, ecc. Questa parte sarebbe relativamente facile da scrivere. La seconda parte avrebbe bisogno di uno script di qualche tipo per mettere insieme un database di parole chiave e la loro posizione all'interno del testo html. Penso che questa sia la parte difficile insieme a fornire il meccanismo di ricerca all'interno del browser.
Qualche idea su alternative sarebbe apprezzata. Mi piacerebbe utilizzare un wiki o un insieme di pagine html statiche ospitate su un server web da qualche parte, ma abbiamo un requisito di utilizzo offline critico. Semplicemente posizionando il codice html sul disco locale non ci fornisci i requisiti di ricerca di cui abbiamo bisogno.
Modifica
Progetto software che viene utilizzato dall'industria mineraria. Molte miniere sono molto remote e non hanno accesso a Internet in alcun modo significativo. Non c'è niente di sbagliato in pdf o html o chm (tranne che sta invecchiando). Se potessi visualizzare un file pdf nella posizione corretta (ad esempio aiuto sensibile al contesto) lo userei. Sono quasi tentato di scrivere il mio - fondamentalmente sarebbe un wiki portatile. A proposito, se suggerisci una wiki portatile, devi pensare all'utente finale che potrebbe non avere esperienza nell'uso di tali strumenti. Deve essere semplicemente semplice. Quella era la bellezza di chm, è un dolore lavorare con ma piace agli utenti finali.