Erstellen von Hilfe-Datei in HTML

Question

Ich bin vor der Spaß Aufgabe, eine Hilfedatei für ein großes Projekt zu schaffen. Ich habe die Einschränkungen aufgrund CHM-Dateien verworfen 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 kann auf einen Text beziehen) Da einige Abschnitte in der Hilfe-Datei mehr als einmal verwendet werden soll, muss ich einen Master-Abschnitt erstellen und verknüpfen Sie dann in jedem Abschnitt zu den Master-Abschnitte. Das so vermeide ich mit den caption mehreren Stellen zu ändern, wenn Änderungen zu tun.

Searchfunctionality Ich möchte in der Lage sein, frei Text in der Datei zu suchen.

Bedruckbarkeit. Der Benutzer Druckabschnitt oder wholde Dokument auswählen kann.

Ich lehne zunächst auf den Wiki-Ansatz Plugins mit der Wiki in statische Seiten für die Verteilung zu exportieren, aber ich habe nicht diese Lösung ...

gefunden

Irgendwelche Vorschläge von euch in dieser Angelegenheit? Bin ich Hilfe-Dateien zu kompliziert zu machen?

Vielen Dank im Voraus!

Answer 1

Reusability

Ich sehe zwei Ansätze. Sie können entweder einzelne Seiten für die Abschnitte erstellen, die Sie wiederverwenden möchten, und dann einfach auf sie verweisen, wo immer angemessen. Dies ist trivial in HTML.

Sie können alternativ ein Snippet oder HTML-Fragment mit den Informationen für diesen Abschnitt erstellen, und verwenden Sie dann Server-Side Includes (oder eine ähnliche Technik) aufzunehmen es inline, wo es gebraucht wird. Auf diese Weise wird der Inhalt erscheint auf jeder einzelnen Seite geschrieben wurde, aber wenn Sie eine Änderung vornehmen müssen, um es an einem Ort nur noch ist.

Suchen

Wenn die Site öffentlich ist, lassen Sie Google indiziert, und bietet nur ein Google-Suchfeld ein. Sie sind wahrscheinlich nicht bessere Ergebnisse als das bekommen.

Bedruckbarkeit

Ein „print Sheet“ in CSS 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.

Drucken des gesamten Dokuments auf einmal würde eine kleine Menge an Programmierung erfordern alle Inhalte zum Zwecke der Druck in einer einzigen Seite zusammen zu kombinieren. Persönlich würde ich es vorziehen, auch diesen Dienst anbieten, um Menschen davon abhalten, das Papier zu verschwenden.

Natürlich können wir alle möglichen Einblick in bieten, wie alle diese Dinge zu erreichen, aber da es klingt wie Sie nach allgemeinen Beratung zur Zeit sind, das ist meins.

Answer 2

Ich glaube, Wikis für die Dokumentation perfekt sind, vor allem, wenn mehr als eine Person ist (oder wird) an dem Projekt beteiligt. Die Verknüpfung zwischen Wiki-Seiten oder Namensraum leicht erreicht wird. eine Seite umbenennen alle Hyperlinks in anderen Dokumenten ändern. Ich würde, wo immer möglich, obwohl Vervielfältigung von Inhalten vermeiden, wenn es das ist, was Sie vorschlagen.

Ich benutze DokuWiki die Seite Export unterstützt. Sie können Ihre gesamte Wiki in Klartext, XHTML oder XHTML Körper (für die Umsetzung der eigenen Vorlage oder in eine einzelne Datei zum Drucken anhängen usw.) auszugeben.

Ich hoffe, das hilft!