Hilfe-Konfusion

Ein Hallo in die Runde,

ich muß (will) eine Anwenderhilfe-Datei mit Quellcodereferenz und allgemeinem Blabla wie "Getting Started" erstellen.

Nun bin ich dank der Infos aus diesem Forum so weit vorgedrungen, daß ich mittels Sandcastle sowohl HTML-Dateien als eine CHM-Datei aus den XML-Tags in meinem Quellcode erstellen konnte.

So weit, so schön.

Jetzt blick ich allerdings nicht so richtig, wie ich den anderen Kram außer der Quellcodereferenz dort "hinein" bekomme. Also z.B. in die CHM-Datei (was mir als Format am sympathischsten wäre).

Kann man eine durch Sandcastle / Help File Builder erstellte CHM-Datei in ein HTML Help Workshop-Projekt "einbinden"?

Ich stell mich grad doof an, aber das viele Lesen über Hilfe-Erstellung aller Art hat mich ganz konfus gemacht...

Hallo Bini,

für eine Anwenderhilfe kannst du m.E. Sandcastle gar nicht gebrauchen. Benutze stattdessen den Microsoft HTML Workshop.

herbivore

Hallo Herbivore,

ich will doch HTML-Workshop benutzen! Aber es muß eben auch eine Quellcode-Referenz mit rein und die erstellt sich mit Sandcastle ja recht gut.

Weiß jetzt bloß nicht, wie ich das beides - also die Referenz und den Hilfe-Teil "zusammen bringen" kann.

Hallo Bini,

was hat die Quellcode-Referenz in der Anwenderhilfe zu suchen? Die verwirt doch nur. Ich würde das trennen.

herbivore

Na ja, die Zielgruppe sind Informatik-Studenten, insofern paßt es schon zusammen. Die sollen das Tool im Fach Theoretische Informatik benutzen.

Aber vielleicht sollte ich wirklich einfach zwei Dateien erstellen? 🤔

Hallo, meinst Du soetwas wie die MSDN Dokumentation?
Dann wäre ndoc deine Wahl.

Hallo Bini!

NDoc hat mir nach dem kompilieren ein Html Help Workshop Projekt im Debug Verzeichnis abgelegt. Das kannst du öffnen und bearbeiten.

vg,
Simon

drHelp?

Hallo SimonKnight6600,

dann muss man allerdings aufpassen, dass man beim Neugenerieren nicht alle änderungen verliert. Oder ist ndoc so schlau die Änderungen zu erkennen und zu behalten.

Aber da kann man aber so oder so sicher einen Weg finden. Entweder, dadurch dass man das generierte Projekt in ein eigenes nur einbindet oder sich ein kleines Tool schreibt, dass zwei Projekte mischt.

herbivore