GROFF_WWW(7)

名称
groff_www - ウェブページのオーサリング用 groff マクロ

書式
groff -mwww [ options ] file ...

解説
このマニュアルページは、GNU -mwww マクロについて解説しています。 これは、groff ドキュメント整形システムの一部です。 このマニュアルページは、ごく基本的なガイドに過ぎませんし、 html デバイスドライバ (grohtml) は完全に書き直されましたがいまだにアルファ版という段階です。 多くの人達がテストする機会を持てるようにするため、 このマクロを配布物に含めているのです。 このマクロファイルは、-Thtml を使用すれば (troffrc ファイルによって) 自動的に呼ばれるのだということに 注意してください。

ハイパーリンクが動作することを確認するには、このマニュアルページを grohtml デバイスを用いて整形してください。

このマクロセットで見つかる機能の概要です。
.HX	自動的なヘッダレベルの切り捨て。
	$1 がセクション/ヘッダを指します。
.BCL	ウェブページの色を指定します。
.BGIMG	背景画像を指定します。
.URL	2 つのパラメータを用いて URL を作成します。
.FTP	FTP への参照を作成します。
.MTO	HTML email アドレスを作成します。
.FTP	FTP への参照を作成します。
.TAG	HTML の name を作成します。
.IMG	画像ファイルを挿入します。
.PIMG	PNG 画像を挿入します。
.MPIMG	PNG を余白に置き、その周辺をテキストで包みます。
.HnS	見出しを開始します。
.HnE	見出しを終了します。
.LK	自動的に収集されたリンクを出力します。
.HR	水平罫線を出力します。
.NHR	罫線の自動生成を抑制します。
.HTL	HTML タイトルのみを作成します。
.ULS	順序無しリストを開始します。
.ULE	順序無しリストを終了します。
.LI	リスト項目を挿入します。
.DC	ドロップキャピタルを作成します。
.HTML	HTML の生リクエストをデバイスドライバに渡します。

Output of the pic, eqn, refer, tbl プリプロセッサの出力を入力として受け付けることができます。

リクエスト

HX  見出しに対して自動的に作成されるリンクの 切り捨てレベルを決定します。 パラメータに 2 を指定すると、 grohtml は .NH 1 と .NH 2 にはリンクのリストを作成しますが、 .NH 3 に対してはしません。

        .HX 0

    とすると、 grohtml がリンクを生成しないようになります。 自動的な見出しをオフにする別の方法は、 groff のコマンドラインスイッチ -P-l です。

BCL 5 つパラメータを取ります: 文字色、背景色、アクティブな ハイパーリンクの色、まだ訪問したことがない ハイパーリンクの色、そして訪問したことのある ハイパーリンクの色です。

BGIMG
    このマクロの唯一のパラメータは、背景画像ファイルを示します。

URL 2 つあるいは 3 つのパラメータを使用して URL を生成します。 第 1 パラメータはリンク名、第 2 パラメータは実際の URL、 そして第 3 パラメータは省略可能であり直後に印字されます。 実際の URL を印字中はハイフネーションは無効化されます。 明示的な改行位置を \: エスケープで挿入すべきです。 以下に をどのようにエンコードすべきかを示します:

        .URL http://\:foo.\:org/ foo :

    これを -Thtml 以外のドライバで処理すると、次のようになります:

        foo ⟨http://foo.org⟩:

    URL マクロはどんなタイプでも構いません。 例えば は次のように参照できます:

        .URL pic.html "Eric Raymond's pic guide"

MTO HTML 用の電子メール参照を生成します。 第 2 引数はオプションであり、ブラウザに表示されるテキストです。 そして、第 3 引数もオプションであり、これは第 2 引数の直後に 表示されるものです。 実際の電子メールアドレスを印字する間、ハイフネーションは無効化されます。 例えば は次のように実現されます:

        .MTO joe@user.org "Joe User"

    実際には、groff では URL はテキストとしての空白を 一切使わないものとして扱われることに注意してください。 このことは、いくつかの問題の原因となりますのでバグだと 考えられるでしょう。 これを回避するために、 www.tmac は他に影響を 与えない空白に展開される幅 0 の文字を挿入します (-Thtml 付きで実行された場合のみ)。

FTP データが FTP 経由で取得できることを示します。 第 1 引数は URL で、 第 2 引数は、ブラウザに表示されるテキストです。 第 3 引数は、先に述べたマクロと同様に、第 2 引数の 直後に表示されるテキストとして扱われます。 第 2 および第 3 の引数はオプションです。 実際の URL を印字する間、ハイフネーションは無効化されます。 例として、これは、 例として、これは、 です。 このマクロの例は、次のように指定します:

        .FTP ftp://\:ftp.gnu.org/ "GNU ftp server" .

TAG 引数から HTML の name タグを生成します。 このタグは、 マクロを使って参照できます。 御覧の通り、同一ドキュメント内の参照ですので、タグ名の前には # を付けなくてはなりません。 このリンクは、先の URL マクロの記述の中で TAG を置くことで 実現したのです。ソースは次のようになります:

        .TP
        .B URL
        は、
        .TAG URL
        すなわち 2 個か 3 個の引数を使用する URL を作成します。
        ...

IMG ドキュメントに画像を含めます。 第 2 のオプションは、水平位置、すなわち右・左・中央を指定します (-R, -L, -C) 。 第 2 引数は画像ファイルです。 オプションの第 3 引数と第 4 引数は、幅と高さです。 幅を指定しないと、デフォルトの 1 インチになります。 高さを指定しないと、幅と同じになります。 これは、HTML の IMG タグにマップされます。 PNG 画像を挿入する場合、 PIMG マクロを使用することをお勧めします。

PIMG
    PNG フォーマットの画像を含めます。 このマクロは IMG マクロとまったく同じパラメータを取ります。 PostScript と HTML デバイスと連携動作するという利点があります。 また、 netpbm パッケージの pngtopnm, pnmcrop, pnmtops を使用して、自動的に画像を EPS フォーマットに変換するという利点があります。 ドキュメントを -Thtml で処理しない場合、groff の -U オプションが必要です。

MPIMG
    PNG 画像を余白に置き、その周辺をテキストで包みます。 第 1 パラメータは、左か右の整列位置 (-L mataha -R) です。 第 2 引数がファイル名です。 オプションの第 3 引数と第 4 引数は、幅と高さです。 幅を指定しないと、デフォルトの 1 インチになります。 高さを指定しないと、幅と同じになります。

HnS 見出しを開始します。 見出しレベルは、第 1 引数で指定します。 URL を含む見出しにはこのマクロを使用してください。 例:

        .HnS 1
        .HR
        GNU Troff
        .URL http://groff.ffii.org (Groff)
        — a
        .URL http://www.gnu.org/ GNU
        project.
        Hosted by
        .URL http://ffii.org/ FFII .
        .HR
        .HnE

HnE 見出しを終了します。

LK  この位置に自動生成リンクを置くよう、grohtml に強制します。 マニュアルページを -Thtml で処理した場合、リンクはここに見えます。

セクション見出しへのリンク
デフォルトでは grohtml はセクションの見出しすべてへのリンクを生成し、 リンクを HTML ドキュメントの先頭に配置します (オフにしたり位置を変えるための詳細は を参照してください)。

HR  水平方向の罫線を幅いっぱいに作成します。

NHR grohtml がデフォルトで生成する、トップとボトムの罫線の生成を抑制します。

HTL HTML タイトルのみを生成します。 ms マクロパッケージの TL マクロは、HTML タイトルと H1 見出しの両方を生成します。 これを使って、サーチエンジン用の食材として HTML タイトルを提供し、 ドキュメント中では画像のタイトルを使用できます。

HTML
    このマクロより後の全テキストは生の HTML として扱われます。 -Thtml 無しでドキュメントを処理すると、このマクロは無視されます。 内部的に、他の高位のマクロの構成要素としてこのマクロが使用されています。

    例えば BGIMG マクロは次のように定義されています。

        .de BGIMG
        .   HTML <body background=\$1>
        ..

DC  ドロップキャピタルを生成します。 第 1 パラメータが、ドロップされる文字であり大きくなります。 第 2 パラメータが、これに続くテキストであり、 この高さを最初の文字は越えてはなりません。 オプションの 第 3 パラメータは、ドロップされた文字の色です。

GROHTML の制限

tbl 情報は、現在 PNG 画像として描かれます。

関連ファイル
/usr/share/tmac/www.tmac

関連項目
groff(1), troff(1) grohtml(1), netpbm(1)

作者
grohtml は が書きました。

バグ
バグレポートは へ送ってください。 バグが再現できるように、完全で自己完結している例を付けてください。 また、どのバージョンの groff を使っているかも伝えてください。