HTMLでヘルプファイルを作成します

Question

私は、大規模なプロジェクトのためのヘルプファイルを作成するの楽しいタスクに直面しています。私が原因制約のためにCHMファイルを破棄し、現在HTMLベースのファイルに探しているが、私は形式上はまだ未定だ....

私はに焦点を当てています3つの領域があります：

セクションの再利用性は、（多くのページは、一つのテキストを参照することができます） いくつかのセクションは、かつてヘルプファイルよりも多く使用されますので、私は、マスターセクションを作成する必要がありますし、各サブセクションのマスター・セクションにリンクしています。これは、私は編集を行う際にキャプション複数の場所を変更する必要がなくなります。

Searchfunctionality 私は、ファイル内のフリーテキストを検索できるようにしたいと思います。

印刷適性。 ユーザーは、セクションまたはwholde文書を印刷するように選択することができます。

...私は最初の配布のための静的なページにWikiをエクスポートするプラグインを持つウィキアプローチに傾いたが、私はその解決策を見つけていない。

この問題で皆さんからの任意の提案ですか？私は、複雑にHELPFILESいるのでしょうか？

事前に感謝します！

Answer 1

を再利用の

私は2つのアプローチを参照してください。あなたが再利用したいセクションの個々のページを作成し、どこでも適切な単にそれらにリンクすることができます。これは、HTMLで簡単です。

あなたは、代わりにそのセクションのための情報をHTMLのスニペットまたはフラグメントを作成し、それが必要なのどこインラインそれを含めるようにサーバー側が含まれ（または類似の技術）を使用することができます。この方法では、コンテンツはすべての個々のページに書かれているように見えますが、あなたはそれが唯一の場所ではまだの編集をする必要があるときます。

検索

サイトが公開されている場合は、

、Googleのインデックスにそれを聞かせて、ちょうどGoogleの検索ボックスを提供します。あなたはより良い結果を取得する可能性はありません。

の印刷適性の

CSSで

A「印刷スタイルシートは、」一緒に入れやすく、紙の上で使用するすべてのコンテンツを保存し、ウェブ上のサイトは魅力的にすべてのグラフィック要素を排除することができます。

一度、文書全体を印刷すると、印刷の目的のために、単一のページにまとめてすべてのコンテンツを組み合わせてプログラミングのいくつかの小さなビットを必要とします。個人的に、私も、紙を無駄から人々を阻止するために、そのサービスを提供することを好むと思います。

もちろん、私たちはこれらのもののいずれかを達成するためにどのように洞察力のすべての方法を提供することができますが、現時点では一般的なアドバイス後にしているように聞こえることから、それは私です。

Answer 2

私は、複数の人がいる（またはされる）プロジェクトに関わる場合は特に、ウィキは、ドキュメントのための完璧であると信じています。 wikiページや名前空間の間でリンクすることは容易に達成されます。ページの名前を変更すると、他のドキュメント内のすべてのハイパーリンクを変更します。それはあなたが示唆されたものだ場合、私は、可能な限りしかし、コンテンツの重複を避けるだろう。

私は DokuWikiののページのエクスポートをサポートしている使用します。あなたは（など、独自のテンプレートの内側に置くため、または印刷のための単一のファイルに追加する）、プレーンテキスト、XHTMLやXHTML本体にあなたの全体のwikiをダンプすることができます。

助け

希望！