Attualmente 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 chiedevo 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 luoghi molto remoti) con il nostro software. Dovrebbe avere un indice (può essere semplice come una pagina html con termini ipertestuali), dovrebbe essere ricercabile e dovrebbe avere un meccanismo che consenta di richiamare voci specifiche dal codice (simile alla guida sensibile al contesto).
Le due cose che sono contro PDF in questo caso è:
- 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 parola 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 della sezione che mi interessano nel browser predefinito e quella pagina dovrebbe caricare fino alla sezione corretta.
Le mie esigenze suonano moltissimo come chm - lo fanno. Ho modellato le mie esigenze su chm. L'unico motivo per cui non mi piace chm è a causa del modo in cui il codice interagisce con esso usando mapids e simili. Preferirei di gran lunga utilizzare un elenco di testo semplice (che viene generato automaticamente per me) che il mio codice può utilizzare per accedere alla parte sensibile della contesto della documentazione.
Sto immaginando uno script che attraversi i file di output html e generi una pagina di indice che contenga semplicemente un elenco di parole chiave che ha trovato. ovviamente ci dovrebbe essere un meccanismo di esclusione delle parole per ignorare parole come: the, it, is, 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 sarebbe la parte difficile insieme a fornire il meccanismo di ricerca all'interno del browser.
Qualsiasi idea sulle alternative sarebbe apprezzata. Mi piacerebbe usare un wiki o un insieme di pagine html statiche ospitate su un server web da qualche parte, ma abbiamo un requisito fondamentale per l'utilizzo offline. Il semplice posizionamento dell'html sull'unità locale non ci fornisce i requisiti di ricerca di cui abbiamo bisogno.
MODIFICARE:
Progetto software utilizzato dall'industria mineraria. Molte miniere sono molto remote e non hanno accesso a Internet in 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 (es. Aiuto sensibile al contesto) lo userei. Sono quasi tentato di scrivere il mio - fondamentalmente sarebbe un wiki portatile. A proposito, se suggerisci un wiki portatile, devi pensare all'utente finale che potrebbe non avere esperienza nell'uso di tali strumenti. Deve essere morto semplice. Questa è stata la bellezza di chm, è un dolore lavorare con ma piace agli utenti finali.