Windows hjelpefiler - hva er alternativene?

stemmer
34

Tilbake i gamle dager, Hjelp var ikke trivielt, men mulig: generere noen funky RTF-fil med spesielle koder, kjøre det gjennom en kompilator, og du fikk en WinHelp fil (HLP) som faktisk fungerer veldig bra.

Deretter bestemte Microsoft at WinHelp var ikke hipt og kult lenger, og byttet til CHM, opp til det punktet de faktisk la ned WinHelp fra Vista.

Nå CHM kanskje hyggelig, men alle som prøvde å åpne en CHM-fil på nettverket vil vite nice ble Navigering til websiden avbrutt skjerm som er forårsaket av sikkerhetsbegrensninger.

Mens det finnes måter å gjøre CHM arbeide av nettverket, er dette neppe et godt valg, fordi når en bruker trykker på Help Button han vil hjelpe og ikke trenger å gjøre noen funky innstillinger.

Ergo: Jeg finner CHM helt ubrukelig. Men med WinHelp ikke være et alternativ lenger heller, jeg lurer på hva alternativene er, spesielt når det gjelder å integrere med min søknad (dvs. for WinHelp og CHM det er funksjoner som lar deg hoppe direkte til et emne)?

PDF har den ulempen at det kreves Adobe Reader (eller en av de mer lette seg at ikke mange bruker). Jeg kunne leve med at det å se da dette er slags standard i dag, men du kan si det sikkert å hoppe til en bestemt side / anker?

HTML-filer ser ut til å være det beste valget, du så bare må forholde seg til ulike nettlesere (CSS og ting).

Edit: Jeg ønsker å lage min egen hjelpefiler. Som jeg er en fan av No Setup, Just Extract og Run Filosofi, jeg hatt det problemet mange ganger i det siste fordi mange av brukerne vil kjøre den av nettverket, noe som fører til akkurat dette problemet.

Så jeg er ute etter en mer robust og fremtidsrettet måte å gi hjelp til brukerne mine uten å måtte kode en annen hjelpesystem for hvert program jeg gjør.

CHM er et veldig fint format, men at sikkerhets Stuff gjør det ubrukelig, som et hjelpesystem er ment å gi hjelp til brukeren, ikke å generere enda mer problemer.

Publisert på 04/08/2008 klokken 10:43
kilden bruker
På andre språk...                            


10 svar

stemmer
15

HTML vil være det nest beste valget, hvis du vil tjene dem fra en offentlig webserver. Hvis du prøvde å pakke det til appen, alle filer (og bilder (og stilark (og ...))) ville gjøre CHM se ut som en gave fra gudene.

Når det er sagt, når faktisk samlet i installasjonspakken, (i stedet for å bli servert over nettverket), fant jeg CHM filer til fungere fint.

OTOH, en annen fallgruve om CHM filer: Selv om du prøver å åpne en CHM fil på en lokal disk, kan du støte på sikkerheten blokk hvis du først lastet den ned fra et sted, fordi filen kan bli merket som "kom fra ekstern kilde" når det ble erholdt.

Svarte 04/08/2008 kl. 10:51
kilden bruker

stemmer
5

Jeg liker ikke html-alternativet, og faktisk flyttet fra ren HTML til CHM ved å komprimere og indeksere dem. Selv bruker dem på en håndfull ikke-Windows-kunder enda. Det rett og slett løst konstant lite brudd av folk setter den på nettverket (hekkende dybde begrenset, merkelige låse effekter), antivirus som døde i kataloger med 30000 html-filer, og 20 minutter dekompresjon tid mens du installerer på et eldre system, leseren sikkerhetssoner og funksjoner, feilberegninger av nødvendig plass i installasjons etc.

Og da jeg ikke engang omfatter de som begynner å "korrigere" dem, tredje parts produkter med feil "integrering" forsøk etc, klager på slowliness (leseren oppstart)

Vi hadde ventet år for problemene gå unna som operativsystemer og maskinvare bedre, men problemene fortsatte tilbakevendende i en bedazzling rekke varianter og nok var nok. Vi fant chmlib, og besluttet vi kunne alltid bruke noe basert på dette som flukt med en enkel ekstern leser, hvis OS gitt de sluttet å fungere og slått.

I mellomtiden har vi også en egen kompilator, så vi er MS gratis fremtidssikre. Det betyr ikke at vi aldri vil forandre seg (løsninger med lokale web-serverne synes favoritt i dag), men minst har vi et valg.

Svarte 06/09/2009 kl. 00:03
kilden bruker

stemmer
3

Det avhenger av hvordan importerer den elektroniske dokumentasjonen er for ditt produkt, kan en god dokumentasjon infrastruktur være komplisert å etablere men når gjort det lønner seg. Her er hvordan vi gjør det -

  • Hjelp kilde DITA compilant XML, lagret i SCC (Clearcase).
  • Hjelp redigering XMetaL
  • Hjelp kompilering, tilpasset Åpne DITA Toolkit , med tilpassede Perl / Java forbehandling
  • Hjelp kilde kryssreferanser programmer ressurser på kompilering, .RC filer etc
  • Hjelp leveranser fra én kilde, PDF, CHM, Eclipse Help , HTML.
  • Enkelt kilde repository produserer hjelpe for flere produkter 10 + med tusenvis av felles emner.

Fra det du beskriver vil jeg se på Eclipse Hjelp, det er ikke enkelt å integrere i NET eller MFC-programmer, du i utgangspunktet trenger å gjøre hjelp kartlegging for å løse forespørsel til en URL deretter brann URL til Eclipse Hjelp wrapper eller en nettleser.

Svarte 21/09/2008 kl. 00:11
kilden bruker

stemmer
3

Hvis du ikke ønsker å bruke et installasjonsprogram og du ikke vil at brukeren skal utføre noen ekstra skritt for å tillate CHM filer over nettverket, hvorfor ikke falle tilbake til WinHelp? Vista inkluderer ikke WinHlp32.exe ut av boksen, men det er fritt tilgjengelig som en nedlasting for både Vista og Server 2008.

Svarte 04/08/2008 kl. 13:48
kilden bruker

stemmer
3

Vår programvare er både distribueres lokalt til klientene og servert fra en nettverksressurs. Vi satset på å generere både en CHM-fil og et sett med HTML-filer for servering fra nettverket. Brukere som starter programmet lokalt bruke CHM-filen, og brukerne får sine program servert fra en nettverksressurs må bruke HTML-filer.

Vi bruker Hjelp og manuell og kan dermed enkelt produsere begge typer utgang fra samme kildekode. HTML-filene inneholder også søkefunksjoner og krever ikke en web server, så selv om det ikke er en optimal løsning, fungerer fint.

Så langt har alle de single-filtyper for Windows synes brutt på en eller annen måte:

  • WinHelp - obsoleted
  • Htmlhelp (CHM) - foreldet på Vista, fungerer ikke fra nettverksressurs, annet enn som fungerer veldig fint
  • Microsoft Hjelp 2 (HXS) - dette synes å fungere helt til det punktet når det ikke skjer, ødelagte indekser eller lignende, dette blir brukt av Visual Studio 2005 og oppover, som et eksempel
Svarte 04/08/2008 kl. 11:02
kilden bruker

stemmer
3

Er spørsmålet hvordan å generere dine egne hjelpefiler, eller hva som er den beste hjelpen filformat?

Personlig finner jeg CHM å være utmerket. En av de første tingene jeg gjør når du setter opp en maskin, er å laste ned PHP Manual i CHM format ( http://www.php.net/download-docs.php ) og legge til en hurtigtast til det i Crimson Editor . Så når jeg trykker på F1 den laster CHM og utfører et søk etter ordet mitt markøren er på (flott for rask funksjon referanse).

Svarte 04/08/2008 kl. 10:52
kilden bruker

stemmer
2

Jeg tror løsningen vi kommer til å ende opp med å gå med for vår søknad er vert for hjelpefiler selv. Dette gir oss umiddelbar tilgang til filer og evnen til å holde dem oppdatert.

Det jeg har tenkt er å ha innholdet lastet inn i en stor serie av XML-filer, hver inneholder hjelp for et bestemt element. Denne XML vil inneholde linker til andre XML-filer. Vi vil bruke XSLT for å vise innholdet som er nødvendig.

Avhengig av lisensiering, kan vi bygge en klient-spesifikke XSLT-fil for å skreddersy utseendet til det de trenger. Vi må kanskje være i stand til å bare vise hjelp for bestemte versjoner av produktet vårt også, og det kan gjøres ved å filtrere ut ting i XSLT.

Svarte 27/11/2008 kl. 20:39
kilden bruker

stemmer
2

PDF har den ulempen at det kreves Adobe Reader

Jeg bruker Foxit Reader på Windows hjemme og på jobb. Mye mindre og veldig rask til å åpne. Veldig hendig når du lurer på hva a80000326.pdf er og hvorfor det er clogging opp dokumentmappen.

Svarte 05/08/2008 kl. 18:55
kilden bruker

stemmer
2

Hvis du gjør "bare pakke ut og kjøre", skal du kjøre i sikkerhetsspørsmål. Dette gjelder spesielt hvis du er brukere kjører Vista (eller senere). er det en grunn til at du ønsket å unngå emballasje programmene inne et installasjonsprogram? Ved hjelp av en installatør ville lindre "ekstern kilde" problem. Du vil kunne bruke CHM-filer uten problemer.

Vi bruker Install å skape våre installere pakker. Det er ikke billig, men er veldig bra. Hvis prisen er din bekymring, Wix er åpen kildekode og ganske robust. Wix har en læringskurve, men det er lett å jobbe med.

Svarte 04/08/2008 kl. 12:11
kilden bruker

stemmer
1

Jeg bruker en kommersiell pakke kalt autoritet; som kan generere en rekke ulike formater, for eksempel CHM, html, pdf, word, vinduer hjelp, xml, xhtml, og noen andre jeg har aldri hørt om (gjør DITA ringe en bjelle?). Det er et content management system rettet mot behovene til tekniske dokumentasjon forfattere. Fordelen er at du kan bruke og gjenbruke det samme innholdet til å bygge et sett av veiledere, og deretter generere dem i forskjellige formater.

Så bunnlinjen i forhold til spørsmålet om å velge CHM eller html eller hva er at hvis du bruker dette er du ikke låst til et gitt format, men du kan gi flere som brukeren kan velge, og du kan til og med legge til flere formater hvert, uten ekstra kostnad.

Hvis du bare har en guide for å lage det vil ikke være verdt din tid, men hvis du har en dokumentasjon satt til å administrere så det er det beste jeg vet. Deres støtte er svært nyttig også.

Svarte 18/09/2008 kl. 14:47
kilden bruker

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more