GROFF_MWWW

Section: Environments, Tables, and Troff Macros (7)
Updated: 6 August 2001
Index JM Home Page
 

名称

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

書式

groff -mwww [ options ] file ...  

解説

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

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

これは、このマクロセットで見つかる機能の概要です。  

書式

.HTMLINDEX          セクション / ヘッダ用に自動的に

                   作成されるリンクのレベルを決定します。

.BODYCOLOR         ウェブページの色を指定します。

.BACKGROUND        背景画像を指定します。

.URL               2 つのパラメータを用いて URL を作成します。

.MAILTO            HTML 用電子メールアドレスを作成します。

.FTP               FTP への参照を作成します。

.IMAGE             画像ファイルを挿入します。

.HTML              デバイスドライバに生の HTML

                   リクエストを渡します。

.TAG               $1 から HTML の name タグを生成します。

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

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

リクエスト

HTMLINDEX
見出しに対して自動的に作成されるリンクの 切り捨てレベルを決定します。 デフォルトでは、troff ドキュメント中にある すべての見出しへのリンクが HTML ウェブページの先頭に作成されます。 おそらく、細かいレベルの見出しにはリンクは必要ないことが 多いでしょう。またウェブページによっては、見出しへのリンクは一切 必要ないものもあるかもしれません。このような場合、
.HTMLINDEX 0

とすると、 grohtml がリンクを生成しないようになります。 HTMLINDEX を 2 にすると

1.1.1 Some Title

という見出しも、3 レベル目の見出しがあるということにより、 リンクに含まれないようになります。 自動的な見出しを切り替える別の方法は、 コマンドラインスイッチ -P-l です。

BODYCOLOR
5 つパラメータを取ります: 文字色、背景色、アクティブな ハイパーリンクの色、まだ訪問したことがない ハイパーリンクの色、そして訪問したことのある ハイパーリンクの色です。
BACKGROUND
このマクロの唯一のパラメータは、背景画像ファイルを示します。
URL
2 つあるいは 3 つのパラメータを使用して URL を生成します。 $1 はリンク名、$2 は実際の URL、そして $3 は $2 の直後に 印字されるオプション部分です。 実際の URL を印字する間、ハイフネーションは無効化されます。 明示的な改行位置は、 \: で挿入すべきです。 これは、 のエンコードの方法を示したものです。
.URL "groff のホームページ" http://\:groff.\:ffii.\:org/ :

-Thtml 以外のデバイスでこれを処理すると、 次のように表示されます: groff のホームページ <http://groff.ffii.org> 。 URL マクロは、どんな種類の要素でも使えます。例えば、 という参照を次のようにして作ることができます:

.URL "Eric Raymond の pic ガイド" pic.html
MAILTO
HTML 用の電子メール参照を生成します。 第 1 引数は、電子メールアドレスとして必須のものです。 第 2 引数はオプションであり、ブラウザに表示されるテキストです。 そして、第 3 引数もオプションであり、これは第 2 引数の直後に 表示されるものです。 実際の電子メールアドレスを印字する間、ハイフネーションは無効化されます。 例えば、groff メンテナは と です。 これは、次のマクロで実現します:
.MAILTO wl@gnu.org "Werner Lemberg"
.MAILTO Ted.Harding@nessie.mcc.ac.uk "Ted Harding" .

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

FTP
データが FTP 経由で取得できることを示します。 第 1 引数は、ブラウザに表示されるテキストであり、 第 2 引数は URL です。 第 3 引数は、先に述べたマクロと同様に、第 2 引数の 直後に表示されるテキストとして扱われます。 第 2 および第 3 の引数はオプションです。 実際の URL を印字する間、ハイフネーションは無効化されます。 例として、これは、 の場所です。 このマクロの例は、次のように指定します:
.FTP "現在の groff 開発者用配布物" \
ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz 
IMAGE
ドキュメントに画像を含めることができます。 第 1 引数は画像ファイルです。 第 2 のオプションは、水平位置を指定します。 l は画像を左寄せに、 r は画像を右寄せにします。その他の値は画像を中央に置きます。 次の 2 つの引数はオプションです。 第 3 引数は画素数での画像の幅です (指定がなければ、デフォルトは 400 画素です)。 第 4 引数は画素数での画像の高さです (指定がなければ、デフォルトは 画像幅と同じです)。
HTML
このマクロの後に続いたテキストはすべて生の HTML として 扱われます。 ドキュメントが -Thtml を 使わずに 処理される場合、このマクロは無視されます。 このマクロは、より高水準な他のマクロの構成要素です。

例えば、BACKGROUND マクロは次のように定義されます:

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

TAG
引数から HTML の name タグを生成します。 このタグは、 マクロを使って参照できます。 御覧の通り、同一ドキュメント内の参照ですので、タグ名の前には `#' を付けなくてはなりません。 このリンクは、先の URL マクロの記述の中で TAG を置くことで 実現したのです。ソースは次のようになります:
.TP
.B URL
は、
.TAG URL
を生成します。
URL は 2 個あるいは 3 個の
引数を使います。
$1 がリンクの名前、そして $2 が実際の URL です。
LINE
水平方向に幅いっぱいの罫線を生成します。 次が例です:
.LINE
LINKS
は、grohtml が自動的に生成されるリンクをこの位置へ置くよう要求します。 例:
 

セクション見出しへのリンク

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

grohtml の制限

tbl 情報は、現状 png イメージで描かれます。  

関連ファイル

/usr/share/tmac/mwww.tmac (www.tmac へのラッパ)
/usr/share/tmac/www.tmac  

関連項目

groff(1), troff(1), grohtml(1)

 

作者

grohtml は が書きました。  

バグ

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

関連キーワード

マクロ   groff   画像   ドキュメント   実際   tmac   自動的   テキスト   ウェブページ   Thtml   ハイパーリンク   レベル   タグ   印字   ffii   マニュアル   セクション   電子   メールアドレス   挿入   水平   直後   ハイフネーション   無効化   mwww

Linux マニュアル 一覧

関連するコマンド・関数

groff_tmac.5   grohtml.1   grops.1   roff.7   groff_ms.7   tfmtodit.1
 

Index

名称
書式
解説
書式
リクエスト
セクション見出しへのリンク
grohtml の制限
関連ファイル
関連項目
作者
バグ

This document was created by man2html, using the manual pages.
Time: 04:39:38 GMT, October 11, 2026