Hilfedatei in HTML erstellen

Question

Ich stehe vor der spaßigen Aufgabe, eine Hilfedatei für ein großes Projekt zu erstellen. Ich habe CHM-Dateien verworfen aufgrund der Zwänge und suche nun in HTML-basierten Dateien, aber ich bin noch unschlüssig über das Format ....

Es gibt drei Bereiche konzentriere ich mich auf:

Reusability von Abschnitten (viele Seiten können sich auf einen Text beziehen) Da einige Abschnitte mehr als einmal in der Hilfedatei verwendet werden, muss ich einen Hauptabschnitt erstellen und dann mit den Hauptabschnitten in jedem Unterabschnitt verknüpfen. Dadurch erübrige ich es, bei der Bearbeitung die Beschriftung mehrerer Stellen zu ändern.

Suchfunktionalität Ich möchte in der Lage sein, freien Text in der Datei zu suchen.

Bedruckbarkeit. Der Benutzer kann wählen, um Abschnitte oder Dokumente zu drucken.

Ich wurde zum ersten Mal in den Wiki-Ansatz stütze mich Plug-in, das Wiki in statische Seiten für die Verteilung zu exportieren hat, aber ich habe nicht die Lösung ...

Anregungen von euch in dieser Angelegenheit gefunden? Mache ich Hilfedateien zu kompliziert?

Vielen Dank im Voraus!

Answer 1

Reusability

ich zwei Ansätze zu sehen. Sie können entweder einzelne Seiten für die Abschnitte erstellen, die Sie wiederverwenden möchten, und diese dann einfach verknüpfen, wo es sinnvoll erscheint. Dies ist in HTML trivial.

Sie können alternativ ein HTML-Snippet oder -Fragment mit den Informationen für diesen Abschnitt erstellen und dann serverseitige Includes (oder eine ähnliche Technologie) verwenden, um es inline aufzunehmen, wo immer es benötigt wird. Auf diese Weise wird der Inhalt scheinbar auf jeder einzelnen Seite geschrieben, aber wenn Sie eine Änderung vornehmen müssen, ist es immer noch nur an einer Stelle.

Suche

Wenn die Site öffentlich ist, lassen Sie es Google-Index und bieten nur ein Google-Suchfeld ein. Sie werden wahrscheinlich keine besseren Ergebnisse erzielen.

Bedruckbarkeit

A „print Sheet“ in CSS ist einfach zusammen zu stellen, und können alle grafischen Elemente beseitigen, die die Website attraktiv, die im Internet zu machen, alle Inhalte zur Verwendung auf Papier zu erhalten.

Das Drucken des gesamten Dokuments auf einmal würde ein wenig Programmierung erfordern, um den gesamten Inhalt zu einer einzigen Seite für den Druck zu kombinieren. Persönlich würde ich es vorziehen, diesen Service sogar anzubieten, um die Leute davon abzuhalten, das Papier zu verschwenden.

Natürlich können wir Ihnen alle möglichen Einblicke geben, wie Sie eines dieser Dinge erreichen können, aber da es sich anhört, als ob Sie nach einem allgemeinen Ratschlag suchen, ist das mein.

Answer 2

Ich glaube Wikis sind perfekt für die Dokumentation, vor allem wenn mehr als eine Person in das Projekt involviert ist (oder sein wird). Die Verknüpfung zwischen Wiki-Seiten oder Namespaces ist problemlos möglich. Durch das Umbenennen einer Seite werden alle Hyperlinks in anderen Dokumenten geändert.Ich würde jedoch die Duplizierung von Inhalten vermeiden, wo immer dies möglich ist, wenn Sie das vorschlagen würden.

Ich verwende DokuWiki, die den Seitenexport unterstützt. Sie können Ihr gesamtes Wiki in einfachen Text, XHTML- oder XHTML-Text ablegen (zum Einfügen in eine eigene Vorlage oder zum Anhängen an eine einzelne Datei zum Drucken usw.).

Hoffe, dass hilft!