HTMLヘルプの代替案

現在、AsciiDocと呼ばれるシステムを使用しており、単純なテキストマークアップでドキュメントを作成できます。それから、複数の出力形式を生成できます。pdf出力とchm出力形式のみを使用します。

chmに代わるものがあるのだろうか？私が探しているのは、ソフトウェアでオフラインで使用できるものです（非常に多くのユーザーが非常に離れた場所にいるため重要です）。インデックス（ハイパーリンクされた用語を含むhtmlページと同じくらい単純にすることができます）があり、検索可能で、コードから特定のエントリを呼び出すことができるメカニズムが必要です（状況依存ヘルプと同様）。

この場合のPDFに対する2つのことは次のとおりです。

1. 状況依存ヘルプはオプションではありません
2. 一般的に、ドキュメントはかなり大きい
3. PDFは、状況依存ヘルプよりも印刷されたドキュメントに適しています

私が望むのは、htmlを使用することです。htmlの唯一の問題は、キーワード検索を自動的に提供する方法がわからないように見えることです（ブラウザのctrl + f機能以外-もっとはっきりしたいのですが）。また、キーワードのハイパーリンクインデックスを自動的に生成する方法が見つからないようです。セクションタグがあるため、状況依存ヘルプは簡単です。デフォルトのブラウザに興味のあるページとセクションのURLを渡すだけで、そのページは正しいセクションまで読み込まれます。

私の要件はchmのようにひどく聞こえます-そうです。要件をchmからモデリングしました。私がchmが好きではない唯一の理由は、コードがmapidなどを使用してそれと対話する方法のためです。私のコードがドキュメントのコンテキスト依存部分にアクセスするために使用できるプレーンテキストリスト（自動的に生成されます）を保存することをお勧めします。

私は、html出力ファイルを調べて、見つかったキーワードのリストを単に含むインデックスページを生成するスクリプトを想定しています。明らかに、the、it、isなどのような単語を無視する単語除外メカニズムが必要です。この部分は比較的簡単に記述できます。2番目の部分には、HTMLテキスト内のキーワードとその場所のデータベースをまとめるための何らかのスクリプトが必要です。これは、ブラウザ内で検索メカニズムを提供するとともに、難しい部分になると思います。

代替案に関するアイデアをいただければ幸いです。私はウィキまたはウェブサーバーでホストされている静的なHTMLページのセットをどこかで使用したいと思っていますが、重要なオフライン使用要件があります。htmlをローカルドライブに配置するだけでは、必要な検索要件が提供されません。

編集：

私は、鉱業で使用されるソフトウェアを設計しています。鉱山の多くは非常に離れており、意味のある方法でインターネットにアクセスできません。pdf、html、chmには何も問題はありません（古くなっていることを除きます）。PDFファイルを正しい場所に表示できる場合（つまり、状況依存ヘルプ）、それを使用します。私はほとんど自分で書きたいと思っています-基本的にはポータブルwikiになります。そういえば、ポータブルwikiを提案する場合は、そのようなツールの使用経験のないエンドユーザーについて考える必要があります。それは非常にシンプルでなければなりません。それはchmの美しさであり、連携するのは苦痛ですが、エンドユーザーはそれを気に入っています。

HTMLではなくDocBook XMLマークアップでヘルプを作成する準備ができている場合、DocBookはWebHelpの生成をサポートしています：http ://wiki.docbook.org/WebHelp

WebHelpドキュメントは、出力のデモでもあります：http : //docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html

以下を含むWebベースのHTMLヘルプ形式を提供します。

• 次を使用した全文検索：
  • 英語、フランス語、およびドイツ語のステミングサポート。ステマーを実装することにより、他の言語のステミングサポートを追加できます。
  • Lucene検索エンジンのコードを使用した中国語、日本語、および韓国語のサポート。
  • 検索された用語が結果のどこに表示されるかを示す検索強調表示。
  • 検索結果には、ターゲットの簡単な説明を含めることができます。
• 折りたたみ可能なTOCツリーを含む目次ペイン。
• コンテンツペインと目次の自動同期。
• TOCおよび検索ペインは、フレームセットを使用せずに実装されています。
• 出力を生成するAnt build.xmlファイル。

RoboHelpの作成者は他のことに取り組み、より良い代替案を作成するために戻ってきました。MadCapのFlareをご覧ください-さまざまな出力形式をサポートし、インデックスを生成し、ローカルで（JavaScriptを介して）動作する検索機能を提供します。

私たちは、使用してきたアドビのRoboHelpをオフラインヘルプドキュメントの様々なスタイルを生成します。コンテンツの多くの出力および統合オプションを提供します。このツールの素晴らしい点は、開発者以外の人に手渡して、ほとんど労力をかけずに優れたコンテンツをソリューションに統合できることです。

CHM自体は古くなっており、Microsoftも新しいものに移行しています：http : //msdn.microsoft.com/en-us/library/bb164608(v=vs.80).aspx

しかし、ヘルプを既存のシステムに変換するのを本当に避けたい場合、および静的ヘルプファイルで検索とキーワード検索を提供する方法を探している場合、2つのアイデアがあります。

• プロジェクトにlocalhost専用の小さなHTTPサーバーを追加して、ドキュメントを含むWebサイトを提供します。問題は、このHTTPサーバーをいつ/どのように起動/停止したり、実行したりするかです。別の方法として、カスタムURLスキームを実装することもできますが、これは1つのブラウザーに結び付けられるため、さらに多くの作業が必要になります（そして、わかります）

• JavaScript検索エンジンを作成します。最近では、どのブラウザのJavaScriptも非常に高速でパフォーマンスが向上しています。キーワードインデックスはJSONに簡単に保存でき、ローカルファイルで通常のエクスプレッションを実行して、かなり良い結果が得られました。

私が探しているのは、ソフトウェアでオフラインで使用できるものです（非常に多くのユーザーが非常に離れた場所にいるため重要です）。

私たちの会社ではRoboHelpを使用していますが、ネットワークアクセスのあるエリアからアクセスできないエリアに移動するユーザーが多いため、ヘルプファイルをオフラインで利用できるようにしています。

検索可能でなければならず、特定のエントリを呼び出すことができるメカニズムが必要です。

RoboHelpのいくつかのページを使用して、画面上の特定のフィールドの使用について説明します。クリック後に表示されるフィールドにポップアップを表示できます。RoboHelpには、非常に優れた検索機能と自動生成されたインデックスもあります。私はいつもそれを使って検索してきました。これはあなたにとって大きな関心事ではないかもしれませんが、RoboHelpは非常に使いやすいプログラムであるため、誰でもドキュメントを更新することができます。