2012-12-28 16 views
5

Su Windows CHM è un'opzione molto buona.Che sistema di aiuto dell'applicazione (come i file chm) esiste su Linux/GTK?

C'è altro che fornire un set statico di pagine HTML e utilizzare una chiamata primitiva a un browser Web (che è anche un problema in sé su linux). E non offrirebbe alcun tipo di ricerca di testo completo, segnalibri separati e anche il semplice fatto di non aprire una nuova scheda per ogni chiamata di aiuto.

+0

E le pagine man? http://en.wikipedia.org/wiki/Man_page –

+1

pagine man per un programma GUI. Scusate. E distribuire pagine man troff è anche peggio di HTML. Sì, sono abbastanza vecchio per conoscere il troff. – Lothar

risposta

3

Il programma Gnome yelp è quello che viene utilizzato per le applicazioni GTK/Gnome. Supporta un numero di formati, ma non direttamente CHM. Hanno iniziato a definire il loro markup, chiamato Mallard.Ma non so quale sia lo stato di ciò.

+0

C'è un'API per lanciare Yelp, o è l'unico modo per farlo un fork/exec – user877329

+0

Sulla mia macchina, semplicemente lancia firefox quando dò un file HTML ... – user877329

1

Ci sono i visualizzatori CHM disponibili su Linux anche se francamente come un utente Linux vorrei preferisco per ottenere pagine HTML statiche.

Alcuni esempi sono chmsee e kchmviewer.

+1

Le pagine Web statiche sono documentazione, non di aiuto. La guida è integrata con un'applicazione. –

3

Suggerirei comunque l'HTML statico come l'opzione migliore (e ovviamente le pagine man!). Ad esempio, è possibile utilizzare Sphinx per scrivere una bella documentazione con un supporto per la ricerca di testo completo!

+1

Questi strumenti di documentazione sono una dozzina di volte. Molti di questi sono più adatti ai documenti SDK rispetto alla guida per l'applicazione. Preferisco il latex con un tex4ht e alcuni post-DOM basati su DOM. Ma per me il PDF è il formato di destinazione principale. –

+1

Questo è vero. Ma trovo Sphinx molto conveniente anche per scrivere la documentazione dell'applicazione, grazie al formato di testo rifatto. Inoltre Sphinx ha LaTeX, PDF, pagine Man, CHM, ePub e molti altri builder accanto al generatore di documenti HTML. –

+0

Sto cercando una soluzione per un manuale dell'applicazione. Mentre mi piace il testo ricostruito ho molti più requisiti. Come la compilazione condizionale. produciamo documentazione per prodotti diversi da una base di fonti comuni all'80%. Abbiamo il nostro processore XML fatto in casa, quindi la domanda riguarda solo la consegna. – Lothar

1

Afaik non esiste un sistema universale. A seconda del sistema desktop (gnome/kde) potrebbero esserci dei sistemi di supporto, ma di solito sono basati su file vaganti e utilizzano browser in piena regola. (in genere basato sul webkit)

Per Lazarus è stato creato un help system basato su CHM e un browser incorporato, incluso il supporto per la scrittura CHM.

Le ragioni per evitare l'HTML statico sciolti erano per lo più:

  1. la documentazione statica 60000 lemma preso troppo a lungo da installare su sistemi o sistemi più leggeri con filesystem specializzati.
  2. CHM rimuove il gioco e aggiunge compressione.
  3. supportiamo anche sistemi non posix e OS X, e piccoli problemi relativi al file system (set di caratteri/codifica, separatori, profondità del percorso ecc.) E filesystem insensivi alle maiuscole/minuscole su * nix hanno causato molto dolore. L'aiuto basato su CHM ha risolto questo problema, consentendo a un gruppo di routine di accedere ai dati help su tutti i sistemi.
  4. indexing e toc sono basati su Btree e possono essere facilmente runtime uniti da set di guide prodotti indipendentemente. In generale, l'integrazione di file di aiuto prodotti indipendentemente è un aspetto poco apprezzato dei file di aiuto in generale, mentre la chiave per aprire le piattaforme.
  5. ricerca full text nativa.

Un visualizzatore personale ha anche la possibilità di sfruttare le funzionalità extra in cima al sistema di base.

Non sto menzionando il sistema Lazarus nella speranza che tu lo adotti, poiché è attualmente un sistema orientato troppo al sistema di sviluppo (SDK), lo spettatore non è nemmeno disponibile come pacchetto separato. Lo menziono principalmente per illustrare i problemi di html loose.

Non ho indagato su KDE/Gnome/Eclipse su ciò che usano come sistema di supporto per un po 'di tempo. Se dovessi ricominciare da capo, ecco dove guarderei prima.

Se dovessi creare qualcosa io stesso rapidamente, userei l'html statico zippato e un singolo file gzip con metadati/indici e il browser più leggero (Konquerer?) Che potrei trovare. Non ideale, non come Windows, ma a quanto pare il meglio che Linux può offrire.