ArrangeNote(HTMLヘルプ作成ツールとして)

HTMLヘルプを作りたい人向けの記事。

個人的に、HTMLマニュアルや、HTMLヘルプのマニュアルを作成するのはとてつもなく大変な作業なのでやめてしまい、二度とやるもんかと思った今年の春。

ようやく手軽に使えそうなヘルプ作成環境を発見。

シェアウェアで私自身はまだ試用期間中なのだが、手応えはかなりいい感じ。

ArrangeNote
http://homepage3.nifty.com/yamakox/ArrangeNote/index.html

ArrangeNoteの本来の目的は「メモ作成」なのだが、お手軽なHTMLヘルプ作成ツールとして、とても使いやすい。

Ver.2を開発中のこと。

Wikiフォーマットから簡単にHTMLヘルプを作成

ヘルプ作成スクリプトを登録したら、任意のテキストを追加して、キーを押すだけで、ぱっと階層構造つきのHTMLヘルプができあがる。特にWikiフォーマットで記述する形が極めて使いやすい。(F5キーに割り当てられていた他の機能を消して、HTMLヘルプ化のスクリプトを登録してしまった)

ふだんWikiを使い慣れていない人は、どうせならArrangeNoteでHTMLヘルプを作成するために慣れてしまった方がいいと思えるくらい単純だ。

デザインを変えたい場合、スクリプト付属のスタイルシートを弄る。

世には、本物のWikiをHTMLヘルプに変換するツールもあるようだが、階層を意識しなければならないHTMLヘルプでは、スタンドアロンで動くArrangeNoteのようなメモソフトの方が使い勝手がいいように思う。

スクリプト機能について

HTMLヘルプ化の機能は、そのままでは不満でもスクリプトを弄れば自分好みに変えられる(該当のスクリプトJScript)。ためしにWikiスクリプトを元に、記事の見出しを検出して、本文のキーワードに自動でリンクを埋め込む機能を組み込んでみたが、作業はそれほど大変ではなく、実用性が高いと感じた。(ただし、プログラム言語の扱いに慣れていない人には、改造は難しい。ちなみに私はJScriptなどほとんど触れたことがなかったが、半日ほどで作業完了)

手元にあった、数十の記事があっという間にHTMLヘルプ化され、自動的に埋め込まれた相互リンクも問題なし。(スクリプトの再配布は原則禁止のようなのでここには載せないが、手元ではかなり便利な形に変更している。あと、さりげなく不具合らしき部分を直していたり……)

フォーマットがプレーンテキストかWikiであるため、既存のヘルプを移行させるとなると面倒なケースもあるが、これからヘルプを作成する人にとっては、有用なツールになりうるのではないかと思う。

スクリプト機能としてはJScriptVBScriptほか、PerlPythonRuby、Tclも使えるようだ。

Wikiとしての不満

Wikiフォーマットからの変換スクリプトだが、個人的には、やや機能に不満が残る。

たとえば、テーブルの各セルをセンタリングしたり右寄せすることができない(私が普段親しんでいるPukiWikiでは、CENTER:やRIGHT:のタグを使って位置を調整できるが、ArrangeNoteのサイトからダウンロードできるスクリプトには、そのような機能が付いていない)。

また、見出しを示す「*」の階層は二段階目の「**」まで。これはあまり問題になっていない。

キーワードのリンクは少し使いづらく、キーワードを別名にリンクさせる機能がない。PukiWikiでは [ [A>B] ]と記述すると、キーワードとしてAを表示しながらBにリンクする機能だ。httpリンクにはこの機能があるが、ArrangeNoteのメモ内に対しては、この方法ではリンクできない。

このような部分をスクリプトで調節する気のある人なら、ある意味、他のHTMLヘルプ作成専門ソフトより、便利かもしれない。

ArrangeNote本体のヘルプはHTMLヘルプではない

面白いことに、これだけのスクリプトがあるにもかかわらず、「メモソフト」として、サンプルデータを提供するという目的があるのだろう、ArrangeNote自身のヘルプは「メモデータ」として提供されており、HTMLヘルプ化されていない。

正直なところ、HTMLヘルプの方が見やすいので、早速これをヘルプに変換した。あとはこのヘルプをF1キーで呼び出せるとありがたいのだが……。

……あ。スクリプトで呼び出す手があるか。



ところで、アプリにスクリプト機能を組み込む際、既存の、知名度の高い処理系を利用する方法があるとは思いつきませんでした。これは使いやすい。どうやって組み込むんだろ。

JavaScriptって、数行のHTMLを吐き出すくらいにしか使ったことがなかったんだけど、実は結構いろいろなことができるんですな。