2008-12-29 10 views
19

Sembrerebbe che i file della guida CHM non siano più il formato del file della guida di scelta.La direzione futura dei formati di file della guida

WinHelp
- obsoleta

HtmlHelp (CHM)
- non supportato su Vista di default
- non funziona bene su una condivisione di rete

Help 2 (HXS)
- I capire che questo è usato in VS2005 + per visualizzare l'aiuto

Basato sul Web
- Potrebbe essere difficile gestire per più versioni

Quale formato di file di guida si utilizzerà in una nuova (C#) applicazione che fornisce più versioni dalla stessa base di codice?

Vorremmo utilizzare CHM aiuto tuttavia non sembra essere la direzione che Microsoft ci vuole muoversi in.

Qualcuno impiegano HXS per i loro file di aiuto?

Feeback apprezzato


aggiornamento sulla base di commenti lassevk;

Sembra che la guida di HXS non sia destinata a essere utilizzata per progetti di guida normali.


risposta

4
this.Mode = Modes.Rant; 

Non ci sono enormi problemi con quasi tutti i formati di file di aiuto perché i creatori (tipicamente Microsoft per un bel po 'di loro) non sembrano voler fare un lavoro di più che un po' abbastanza buono per il proprio uso.

Non posso dirvi quante volte il nuovo formato HXS ha completamente protetto la mia guida di Visual Studio quando terze parti si integrano. Si potrebbe dire che questo è un errore degli strumenti di installazione di terze parti, ma per un po 'di tempo c'era no documentazione su come fare questo, quindi dovettero scegliere tra il reverse engineering (e sbagliare, a volte) o no integrando affatto. Non riesco ancora a capire se l'integrazione funzioni, ma di questi tempi cambio semplicemente Visual Studio per utilizzare la guida in linea. Funziona solo, soprattutto, mentre la guida incorporata ricade invariabilmente su quella barra di avanzamento che blocca Visual Studio solo fino a quando non ha ricostruito il file di aiuto, tranne che non perché i file sono ora corrotti, quindi ogni volta che colpisco F1, Visual Studio si blocca solo se non uccido il programma DEXPLORE un numero qualsiasi di volte.

Come questo è finito come una soluzione a qualsiasi problema, non lo so ancora.

In secondo luogo, gli strumenti devono essere presenti. CHM viewer è presente su pre-vista, non su Vista, ma gli strumenti necessari per mostrare HXS non sono presenti su pre-vista, ma ho capito che sono su Vista. Bello, quindi ora ho una scelta tra l'uso di un formato che deve essere installato sul computer degli utenti, o ... err, un altro che deve essere installato su altri computer degli utenti. Destra.

this.Mode = Modes.JustTicked; 

Dove lavoro spediamo i file CHM, e una versione di HTML basata su file per coloro che distribuire le loro applicazioni attraverso una condivisione di rete. Per quanto riguarda Vista, non abbiamo ancora visto molto, ma la versione html avrebbe funzionato anche lì.

Preferirei avere un lucido aiuto file.

Un bel risultato della versione html è che possiamo collegare gli stessi file nel modulo web che segue il nostro prodotto. In questo modo ci sarebbe solo una versione di cui il cliente ha bisogno.

Stiamo cercando di aggiornare lo strumento che usiamo al lavoro, così sul mio programma per questa settimana, bello e tranquillo al lavoro, guarderò i vari tipi di output che può produrre, tra l'altro HXS.


Edit: Hmm, un rapido sguardo alle pagine del manuale di aiuto e di manuale, il prodotto che usiamo, ha this to say about HXS:

di Visual Studio Guida anche è noto come MS Help 2.0. Originariamente questo formato di guida doveva essere il successore della Guida HTML. Tuttavia, Microsoft ha quindi posticipato la sua versione per un tempo indefinito ed è chiaro che non verrà mai rilasciato come formato di guida per le normali applicazioni utente.

Si noti che questo è un formato di guida speciale che viene utilizzato solo per documentare componenti di programmazione di terze parti progettati per l'integrazione in Visual Studio .NET. Non è adatto per altri scopi e non può essere utilizzato per normali progetti di aiuto per programmi applicativi!

Immagino che HXS sia completamente fuori dal tavolo.


Nota: Web-based non significa necessariamente che avete bisogno di un web server di , ma solo che è necessario un browser web . Sia che tu lo integri nella tua app, utilizzando un componente del browser web, o se lanci il browser predefinito degli utenti, quella sarebbe una scelta che dovresti fare, ma la maggior parte degli output di aiuto basati sul web che ho visto non richiede alcuna installazione del server a tutti.

+0

grazie ... sembra HXS ​​è totalmente off limits. – Helios

+0

Forse dovremmo aspettare Windows 7 per scoprire cosa stanno andando a fare lì. E poi, ancora, in Windows 8. ...: D –

4

Per me, CHM è ancora la risposta. Costruisco file CHM con lo Sandcastle Help File Builder tool disponibile su Codeplex.

Le preoccupazioni sull'accessibilità di CHM sono valide. Per far fronte a ciò, ho prodotto un convertitore CHM-to-Web abbastanza facilmente, con qualche hacking IStorage, una ricerca e sostituzione del testo e una trasformazione XSL. This page è un sito Web che è stato prodotto automaticamente in circa 8 secondi. Ha una vista ad albero di espansione/compressione sul menu di navigazione a sinistra. Basato su frame (non molto user friendly) ma funziona abbastanza bene.

2

L'unica documentazione di aiuto utile che abbia mai visto è stata l'HTML semplice. La maggior parte, se non tutti, dei progetti open source che ho visto tutti hanno pagine di aiuto HTML (per API e documenti di riferimento). Tutto ciò che utilizza un formato proprietario o che richiede un lettore proprietario rischia tutto di diventare obsoleto (CHM) o di avere problemi di compatibilità o ingombranti (PDF).

Per qualche motivo, Microsoft è solo un pessimo aiuto ai file.La guida in linea di Visual Studio/SQL Studio/Office è terribile, MSDN è un disastro, i CHM sono goffi e la ricerca di Microsoft non restituisce mai i risultati che desideri. (Solo la mia opinione :)

+2

I CHM sono solo HTML indicizzati e compressi. Ci sono spettatori Open Source e (de) compressori –

1

Adobe RoboHelp può essere utilizzato per creare contenuti di guida con contenuto/indice/ricerca/glossario e funziona in un browser come viene generato in HTML. Supporta 35 lingue.

Abbiamo un'app Web basata su Flex che utilizza questo per la gestione del contenuto della guida dell'app. L'app Flex e il suo sistema di aiuto funzionano sulla maggior parte dei browser su Windows/MacOSX/Linux.

10

Cosa ti fa pensare che non ci sia un visualizzatore .chm predefinito su Windows Vista? (V'è certamente uno sul mio computer, come pure sulla mia casella di Win7)

si potrebbe confondere con chm hlp (Microsoft infatti caduto hlp supporto in Vista, poi alla fine ripreso in un aggiornamento di Windows)

linea di fondo: i file con estensione chm sembrano essere ancora supportato su tutte le versioni di Windows, e l'unica vera alternativa ai file cHM che conosco è .html

1

Alcune riflessioni aggiornate per chiunque ancora leggendo questa domanda ...

Secondo Wikipedia, Microsoft ha deciso di Microsoft Assistance Markup Language dopo aver rinunciato a una Guida 2.

C'è anche Microsoft Help System, che è ciò che viene spedito con Visual Studio 2010.

Problemi correlati