Hilfe-Generierungs-Tool mit MS Word und C# xmldoc Unterstützung

Question

Ich bin für eine Hilfe/Dokumentation Generierungstool suchen, die solche Anforderungen erfüllen würde:

• sollte es von C# Compiler erzeugt xmldoc Kommentar unterstützen oder (noch besser) direkt unterstützen Sandburg
• sollte es den Import von MS Word-Dokumenten unterstützen.
• Es sollte die Erstellung von Links von der konzeptionellen Dokumentation zur Referenzdokumentation aus dem Quellcode unterstützen.
• wäre es schön, wenn es
in MS Word doc konzeptionellen Authoring unterstützt

Weitere Details. Mein Projekt ist ein Framework/eine Bibliothek für .NET. Es hat mehrere VS-Lösungen mit insgesamt mehr als 50 C# -Projekten. Zuallererst möchte ich Hilfe (chm & help2 & help3 in der Zukunft) aus dem Quellcode meiner Projekte generieren. Ich werde diese Dokumentation als "Referenzdokument" bezeichnen. Sandcastle (vor allem mit SCFB) kann dies auf sehr nette Weise tun. Aber (ich denke, es ist eine sehr häufige Situation) Ich habe einige zusätzliche Dokumentation für das Framework/Bibliothek. Diese Dokumentation befindet sich in MS Word-Dateien (5-10 Dateien). Ich werde diese Dokumentation als "konzeptionelles Dokument" bezeichnen. Ich möchte ein solides Hilfesystem mit konzeptionellen Doc und Referenzdokument (wie MSDN) erstellen. Und ich möchte, dass konzeptionelle Teil der Hilfe enthält Links (URL), die Referenz-Teil der Hilfe für jeden .NET-Typ-Namen aus dem Framework/Bibliothek verweisen. (Offensichtlich ist jedes Hilfesystem nur HTML).

Das Problem besteht darin, wie diese Verknüpfungen erstellt werden. MS Word-Dateien wissen nichts über C# xmldoc. Sandcastle unterstützt keine Word-Dateien. Also muss ich etwas Hilfe-Authoring-Tool (HAT) nehmen. Im Moment finde ich kein passendes Werkzeug für mich. Und ich wäre sehr dankbar für jede Hilfe!

Ein Stolperstein für alle Werkzeuge ist Links Autocreation. Ich möchte, dass Links während der Generierung automatisch erstellt werden (was auf dem Build-Server stattfinden kann). Warum automatisch? Weil es das einfache Umbenennen von Typen erlaubt. Für eine Instanz. Ich habe etwas Text im konzeptuellen Dokument: "für den Zugriff auf Anfrage Verarbeitung Kontext verwenden statische Eigenschaft Current of XOperationContext Typ". Hier ist XOperationContext ein Typname. Ich möchte, dass es ein Link (URL) zur Spezifikation der XOperationContext-Klasse im Ergebnishilfesystem ohne nennenswerten Aufwand wird. Ich möchte es in Word markieren (wahrscheinlich mit einigen HAT-Plugin installiert) oder in HAT-Editor als etwas wie "make this Word Link wenn möglich". Während der Generierung wurde jedes solche Wort zu einem Link, wenn es einen Typnamen mit einem solchen Namen gibt.

Ich weiß über diese Werkzeuge:

• Toolsfactory Doc-o-Matic (mit jetzt) ​​
• Innovasys DocumentX and HelpStudio
• ComponentOne Doc-to-Help

Doc-O-Matic Unterstützung Links automatische Erstellung. Wirklich automatisch. Es versucht einen Link für jedes Wort in PascalCase zu erstellen - brillant. Aber es unterstützt MS Word nicht. Die Software von Innovasys und ComponentOne unterstützt das automatische Erstellen von Verknüpfungen nicht. Die Software von Innovasys unterstützt MS Word nicht (ich bin mir nicht 100% sicher).

Ich habe versucht, auf Innovasys und ComponentOne-Foren zu fragen. Bisher kein Glück. Innovasys Soft-Support-Szenario wie meines: Erstellung eines konzeptionellen Dokuments in einem separaten Tool - HelpStudio und Generierung von Hilfe aus Quellcode mit einem anderen Tool - DocumentX. Aber es ist nicht möglich, Links automatisch zu erstellen und MS Word-Dateien zu importieren.

Also bitte teilen Sie Ihre Laufzeit für diese gemeinsame Aufgabe (ich bin mir sicher, es sollte üblich sein).

p.s. bitte lassen Sie es mich wissen, wenn ich es nicht geschafft habe, meine Gedanken aus der Sicht der englischen Grammatik richtig zu erklären, ich werde es noch einmal versuchen.

Answer 1

Werfen Sie einen Blick auf SandCastle.

Answer 2

Wie wäre es, Ihre MS Word-Dateien in HTML zu exportieren und sie dann in den HTML-Code für die Hilfedateien zu integrieren? Ist das eine Option? Es kann zu einem Verlust der Formatierung kommen, aber Sie können alles besser integrieren.

Answer 3

Sandcastle ist Open Source, also warum nicht selbst etwas erfinden? Schreiben Sie ein Office-Automatisierungs-Tool ist nicht so schwer, nachdem alle. Und Sie können sogar ein Geschäft mit diesem Tool erstellen.

Answer 4

Ich denke, die Lösung wäre, Ihre Word-Dateien zuerst in (X) HTML oder ein anderes nicht-binäres Format zu konvertieren und dann die konzeptionellen Dokumente zusammen mit den Referenzdokumenten zu importieren. Sie können Verknüpfungen basierend auf dem Textinhalt der Dokumenthauptteile automatisch erstellen (wie Sie darauf hingewiesen haben) oder die konzeptuellen Dokumente über einen Vorverarbeitungsschritt ausführen, um sie mit Anmerkungen zu versehen. Dies könnte sogar ein Skript vor dem Import sein.

Answer 5

Haben Sie sich Doxygen angesehen? Es macht nichts mit Word-Dateien, aber es ist Open Source, also könnten Sie diese Funktionen vielleicht selbst hinzufügen. Ich mag die erstellten Dokumente sehr, und es ist sehr leicht, daher habe ich es in den Build-Prozess aufgenommen, um Dokumente automatisch zu regenerieren.

Answer 6

Ich würde vorschlagen, beginnend mit SandCastle und dann eines der Ausgabedateiformate nachbearbeiten, um Word-Dokumente zu erzeugen. Das Erstellen von Office 2007 Word-Dokumenten (*.docx) von Grund auf neu ist nicht so schwierig, sobald Sie ein gutes Verständnis dafür haben, wie die Dinge verpackt sind. Brian Jones hat einen ausgezeichneten Blog auf der Open XML SDK, die Unterstützung für den Umgang mit Office-Dokumente von .NET bietet.

Und Sie können immer entscheiden, mit einem vorhandenen Word-Dokument zu beginnen und dann Platzhalter durch Ihren eigenen Text ersetzen, wenn das Erstellen eines vollständigen Pakets zu kompliziert oder zu viel Arbeit für das, was Sie erreichen möchten, zu sein scheint.