La direzione futura dei formati dei file della Guida

Question

Sembrerebbe che i file della guida CHM non siano più il formato di file della guida preferito.

WinHelp
- obsoleto

Guida Html (CHM)
- non supportato su Vista per impostazione predefinita
- non funziona bene su una condivisione di rete

Aiuto 2 (HXS)
- Capisco che questo venga utilizzato in VS2005+ per visualizzare la guida

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

Quale formato di file della guida utilizzeresti in una nuova applicazione (C#) che fornisce più versioni dalla stessa codebase?

Vorremmo utilizzare l'aiuto CHM, tuttavia non sembra essere la direzione in cui Microsoft vuole che ci muoviamo.

Qualcuno utilizza HXS ​​per i propri file di aiuto?

Feedback apprezzato

---

Aggiornamento basato sui commenti di lassevk;

Sembra che l'aiuto di HXS non sia destinato a essere utilizzato per normali progetti di aiuto.

---

Answer 1

Cosa ti fa pensare esattamente che non esista un visualizzatore .chm predefinito su Windows Vista?(Ce n'è certamente uno sul mio computer, così come sul mio box Win7)

Potresti confondere .chm con .hlp (Microsoft ha effettivamente abbandonato il supporto .hlp in Vista, quindi alla fine lo ha ripreso in un aggiornamento di Windows)

Linea di fondo :I file .chm sembrano essere ancora supportati su tutte le versioni di Windows e l'unica vera alternativa ai file .chm che conosco è .html

Answer 2

this.Mode = Modes.Rant;

Ci sono enormi problemi con quasi tutti i formati di file della guida perché i produttori (tipicamente Microsoft per alcuni di loro) non sembrano voler fare un lavoro più che semplicemente leggermente abbastanza buono per il loro uso.

Non posso dirti quante volte il nuovo formato HXS ha completamente eliminato il mio aiuto di Visual Studio quando si integrano terze parti.Si potrebbe dire che sia colpa degli strumenti di installazione di terze parti, ma per un bel po' di tempo è stato così NO documentazione su come farlo, quindi hanno dovuto scegliere tra il reverse engineering (e sbagliare, a volte) o la mancata integrazione.Non so ancora se l'integrazione funziona, ma oggigiorno passo semplicemente a Visual Studio per utilizzare la guida in linea.Funziona, per lo più, mentre la guida integrata cade invariabilmente su quella barra di avanzamento che blocca Visual Studio finché non ha ricostruito il file della guida, tranne per il fatto che non è stato così perché i file ora sono corrotti, quindi ogni volta che premo F1, Visual Studio si blocca a meno che non uccida il programma DEXPLORE un numero qualsiasi di volte.

Come questo sia finito per risolvere qualsiasi problema, ancora non lo so.

In secondo luogo, gli strumenti devono essere presenti.Il visualizzatore CHM è presente su Pre-Vista, non su Vista, ma gli strumenti necessari per mostrare HXS non sono presenti su Pre-Vista, ma mi risulta che siano su Vista.Bene, quindi ora posso scegliere tra utilizzare un formato che deve essere installato in modo personalizzato sul computer dell'utente oppure...err, un altro che deve essere installato su misura sui computer di altri utenti.Giusto.

this.Mode = Modes.JustTicked;

Dove lavoro spediamo file CHM e una versione html basata su file per coloro che distribuiscono le proprie applicazioni tramite una condivisione di rete.Per quanto riguarda Vista, non ne abbiamo ancora visti molti, ma la versione html funzionerebbe anche lì.

Preferirei di gran lunga avere un aiuto brillante file Anche se.

Un risultato interessante 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 utilizziamo al lavoro, quindi nel mio programma per questa settimana, tranquillo e sereno al lavoro, esaminerò i vari tipi di output che può produrre, tra le altre cose HXS.

---

Modificare:Hmm, una rapida occhiata alle pagine della guida per Guida e Manuale, il prodotto che utilizziamo, ha questo per dire di HXS:

La Guida di Visual Studio è nota anche come MS Help 2.0.Originariamente questo formato di guida doveva essere il successore della Guida HTML.Tuttavia, Microsoft ha poi rinviato il suo rilascio a tempo indeterminato ed ora è chiaro che non verrà mai rilasciato come formato di aiuto per le normali applicazioni utente.

Tieni presente che si tratta di un formato di guida speciale utilizzato solo per documentare componenti di programmazione di terze parti progettati per l'integrazione in Visual Studio .NET.Non è adatto per nessun altro scopo e non può essere utilizzato per normali progetti di aiuto per programmi applicativi!

Immagino che HXS sia completamente fuori discussione allora.

---

Nota:Basato sul Web non significa necessariamente che hai bisogno di un web server, solo che hai bisogno di un web navigatore.Sia che lo integri nella tua app, utilizzando un componente del browser Web o se avvii semplicemente il browser predefinito dell'utente, questa sarebbe una scelta che dovresti fare, ma la maggior parte degli output di aiuto basati sul Web che ho visto non ne richiede alcuno configurazione del server.

Answer 3

Per me, CHM è ancora la risposta.Creo file CHM con il file Strumento per la creazione di file della Guida di Sandcastle disponibile su Codeplex.

Le preoccupazioni sull’accessibilità del CHM sono valide.Per risolvere questo problema, ho prodotto un convertitore CHM-to-Web abbastanza facilmente, con alcuni hacking IStorage, una ricerca e sostituzione del testo e una trasformazione XSL. Questa pagina è un sito web che è stato prodotto automaticamente in circa 8 secondi.Ha una visualizzazione ad albero espandi/comprimi sul menu di navigazione a sinistra.Basato su frame (non molto compatibile con gli URL) ma funziona abbastanza bene.

Answer 4

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

Per qualche ragione, Microsoft è pessima con i file della guida.La guida in linea per Visual Studio/SQL Studio/Office è terribile, MSDN è un disastro, i CHM sono goffi e la ricerca di Microsoft non restituisce mai i risultati desiderati.(Solo la mia opinione :)

Answer 5

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

Disponiamo di un'app Web basata su Flex che la utilizza per gestire il contenuto della guida dell'app.L'app Flex e il relativo sistema di guida funzionano sulla maggior parte dei browser su Windows/MacOSX/Linux.

Answer 6

Alcuni pensieri aggiornati per chiunque stia ancora leggendo questa domanda...

Secondo Wikipedia, Microsoft ha deciso Linguaggio di markup di assistenza Microsoft dopo aver rinunciato ad un Aiuto 2.

C'è anche Sistema di guida Microsoft, che è ciò che viene fornito con Visual Studio 2010.