Cross-platform strumenti end-user-help authoring
https://stackoverflow.com/questions/2977398
-
24-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Quali sono alcuni strumenti di buona authoring per la creazione di file di aiuto multipiattaforma per gli utenti finali? (La nostra applicazione utilizza il framework Qt, se questo fa alcuna differenza.)
Nota: io non sono interessato a documentazione API interna -: siamo utilizzando doxygen per questo.
Idealmente, una soluzione sarebbe:
- ci permettono di gestire tutti i contenuti di aiuto (testo, una tabella di contenuti, immagini, ecc) in un unico luogo.
- Output in formati nativi di aiuto. (CHM per Windows - o almeno qualcosa che potremmo alimentare direttamente l'API Guida HTML;., Non sicuro di quello che altri piattaforme formati di aiuto 'standard' sono)
- dignitoso il supporto WYSIWYG:. Maniglia di inserimento del testo comune, le immagini, i riferimenti incrociati, ecc facilmente, ma siamo in grado di modificare il codice HTML quando abbiamo bisogno di
- file in formato testo base per il progetto di aiuto (XML, ecc) in modo che possa essere di versione in Subversion.
- Le eventuali ganci che aiutano a mantenere in sincronia con la base di codice vero e proprio sarebbe grande. (Forse in qualche modo un argomento della guida è associato ad un file di codice, e può controllare Subversion per vedere se sono state apportate modifiche e la bandiera di un argomento come "possibilmente fuori data" ... sto sognando?)
- contenuto della Guida può essere localizzato.
- non si oppone al prodotto commerciale, ma un'opzione gratuita sarebbe bello.
andrò avanti e fare di questo un wiki e iniziare con alcuni esempi. Vote 'em up o verso il basso se si ha esperienza con loro, e lasciare alcuni commenti. Aggiungi strumenti aggiuntivi.
Soluzione
Ho appena scoperto Sfinge ; Credo di essere innamorata.
- Meglio di WYSIWYG su HTML: reStructuredText
- Uscite a QtHelp (tra l'altro), quindi sarà facile per distribuire (e integrare) nella nostra applicazione.
- Non sei sicuro di localizzazione ancora, ma attraverseremo quel ponte quando abbiamo bisogno di.
- è stato facile da configurare e "funziona"; sembra professionale.
Altri suggerimenti
Ho usato RoboHelp per anni.
E 'bene, ma la tecnologia di base è molto vecchio ormai. Anche il modo in cui si bloccano per le versioni di Word è una valle di lacrime totale (e mi ha costretto ad evitare MS aggiornamenti ufficio più volte).
Ci stiamo muovendo a folle bagliore http://www.madcapsoftware.com/products /flare/robohelp.aspx
DocBook indirizzi tutti voi requisiti tranne forse i ganci di sincronizzazione, che ci penserò un po 'più sopra. E 'essenzialmente un sottoinsieme di XML progettato per la creazione di documentazione, ed è libero e open source. E 'solo un formato più un insieme di trasformazioni XSL uscita che convertono l'Docbook in formati più utile (HTML e quindi CHM, JavaHelp, PDF tramite XML-FO o Tex).
Questo significa che è ancora necessario scegliere uno strumento di authoring XML effettivamente modificare così le cose come WYSIWYG dipenderà dalle caratteristiche del vostro software di authoring XML. Usiamo Syntext Serna in quanto ha un buon supporto per WYSIWYG e la modifica in linea di # include XML (nessun altro sembra sostenere quest'ultimo). Si possono trovare altri strumenti di authoring XML meglio soddisfare le vostre esigenze -. Serna è un'offerta commerciale ragionevolmente costoso
Docbook fornisce un sacco di flessibilità tramite profiling, che permette di includere / escludere elementi XML in base alle loro caratteristiche. casi d'uso esempio potrebbe essere quello di avere in uscita aiuto leggermente diverso per OS = Windows rispetto OS = Linux. Localizzazione è anche supportato tramite profilatura e altri meccanismi.
Una discreta introduzione alla DocBook può essere trovato qui .
Usiamo Docbook per il nostro formato di aiuto, e compilare in file CHM che contengono aiuto solo per gli elementi pertinenti a un prodotto specifico (ad esempio Enterprise Edition ha caratteristiche che non sono nelle versioni standard o demo). I passi rilevanti sono:
- Esegui i modelli Profiling XSL sul Origine XML (utilizzando ad esempio xsltproc).
- Esegui i modelli XSL HTML-Help sull'uscita del 1.
- compilare i file HTML di output utilizzando Microsoft HTML Help Compiler (HHC).
L'unico che conosco è lattice, uno dei convertitori latex2html, e poi un paio di adattamento per rendere il codice HTML risultante pronto per l'archiviatore CHM.
- di testo, HTML, CHM, PDF, PS non è un problema.
- Conversione in Word tramite RTF usato per essere un disastro, non so stato attuale.
- lattice 2 html convertitori, mentre diversi, tutti hanno i loro problemi.
- I PDF look assolutamente grande.
- WYSIWYM (via LyX) possibile.
Questo archivio ha un mazzo di CHMs questo modo (segnatamente le prog, ref e contiene parti, il resto (RTL, FCL, LCL) sono generati dal nostro doxygen equivalente, fpdoc)
http://www.stack.nl/~marcov/doc-chm .zip
Si noti che i CHMs di cui sopra sono realizzati con il nostro (portatile) CHM compilatore. Sì, non più workshop.
Un documento Lyx in formato PDF e HTML:
