これはbhlバージョン1.7.1のマニュアルです.
bhlはただのテキストファイルをHTML, SGML, LaTeX, Texinfoおよ びTXTファイルに変換できるEmacsモードです. bhlはオフラ インで実行できるので, スタンドアロン形式でもあります: bhlファ イルを書けば様々なフォーマットに変換できます.
"bhl"は Brute (つまり"プレーン"な書式)からHtmlや LaTeXへ, の略です.
"bhl"の読み方について質問されることがあります. Bhl-
はインド-ヨーロッパ圏で"Blow"(や"blather"のような派生的でありかつ
詩的ではない動詞)の語幹です. なので, "blow"と読んでください.
bhlは文書整形・出版ツールです. bhlは2種類のツール を提供するEmacsモードです: プレーンテキストファイルを暗示的な構造化文 書として編集するツール, およびこの文書を他の書式(HTML, SGML, LaTeX, TexinfoおよびTXT)に変換するツールです.
bhlで読めるよう, プレーンテキストファイルはbhl文法 に従っている必要があります. この文法は完全に一般的なものでもないですが, とりわけ奇妙というほどでもありません. この文法は比較的使いやすい, そし て比較的よく使われているテキスト整形法から作られています. このモードの 目的は全く気にせず, そして最も便利にこの文法を使うことで す. "気にならない文法"とはソースファイルが可能な限り可読であることで す - プレーンテキストファイルはそうあるべきです. "便利な文法"とはユー ザの癖にあっていることです.
たとえば, *語句*は太字となります. _語句_は強調されます.
構造化テキストやWikiに続けてURLを書くことができます. 章
の番号づけは論理構造と直観に関係しています. (See 文法.)
まとめ: bhlモードで文書を書くために学ばなければいけないこと は何もありません(やれば分かります).
bhlはWYSIWYGではありません. テキストを編集するだけだ
からです. bhlは(LyXのように)WYSIWYMではありま
せん. 意図するもの(WYM: what you mean)はテキストの編集だからです. では
bhlとは何でしょうか. bhlとはWYSIWYS(IWYS)で
す: 見ているものが見ているものなのです!! [What You See Is What You See
(Is What You See)]. テキスト編集は所詮テキスト編集でしかないのです.
まずbhl.tar.gzをhttp://www.nongnu.org/bhlからダ
ウンロードします. アーカイブを解凍してください:
~$ tar zxvf bhl.tar.gz
bhl-*/ディレクトリに移動し, Makefileを修正します. 完了したら次
のようにしてコンパイル/インストールします:
~$ make
~$ make install
bhlを/usr/local/や/usr/share/というパスにイン
ストールする場合は, superuser(つまりroot)権限が必要です.
問題がある場合はインストール手順の最後に表示されるメッセージに原因が表
示されます.
bhl.infoファイルを生成/インストールするには:
~$ make info
~$ make install-info
印刷可能なマニュアル(PDF)を作るには:
~$ make pdf
HTMLマニュアルが欲しければ:
~$ make html
ディレクトリを綺麗にするには:
~$ make clean
~/.emacs.elに次の行を追加してください:
(autoload 'bhl-mode "bhl" "BHL Mode" t)
(add-to-list 'auto-mode-alist '("\\.bhl$" . bhl-mode))
最終行で新しい拡張子(.bhl)をbhl編集モードに関連づけま
すので, .bhlファイルを開くと自動的にbhlモードに移行し
ます.
Ordinarily, a plain text file has no visible or invisible syntax. To be bhl-readable, a file has to respect some conventions.
タイトルは必須です. bhlはバッファの最初の行から読みとろうと します. タイトルは改行やタブ文字を含まない1行で記述されます.
サブタイトルは必須ではありません. サブタイトルはHTML, TXTおよびTexinfo 出力に出力されます. サブタイトルは次のように詳細を記述するのに使うこと ができます:
#!subtitle!My subtile subtitle
詳細がどのように整形・挿入されるのかについて: See 機能指定.
パラグラフは行の先頭から始まっていなくてはいけません. インデントをつけ ないでください. インデントはリストでのみつけましょう.
bhlは3レベルの章を扱うことができます. 章, 節, および小節です.
bhlは5種類の異なる章立て形式に対応しています: num,
alpha, aster, equal-signおよびuser-defined
です. デフォルトでは数字形式(num)となっています.
それぞれの形式の例です:
num
alpha
aster
equal-sign
章立てのデフォルト形式をbhl-sectioning-default-styleを修正するこ とで変えることができます. これは新しく作成されるbhlファイル に対して有効となります.
既存のbhlファイルがある場合, bhl-autoguess-style-flag
がtになっていれば(既定値です), bhlは自動的に章立て形
式を推測します. また, bhl-guess-styleによりいつでも
bhlに形式を推測させることができます. これは<C-c M-s>にバ
インドされています(またメニューから呼び出すこともできます).
たとえば, foo.bhlでアルファベット形式を使っていて,
bhl-sectioning-default-styleがnumとなっているとしましょう.
このときbhlは自動的に現在のスタイルをalphaに変更しま
す. bhlがスタイルを判定できない場合,
bhl-sectioning-default-styleの値に設定されます.
章立てスタイルを混ぜないでください. bhlが数字形式と判定した とき, すべての章立てが数字であると愚直に判断します.
bhl-sectioning-switch-styleにより章立て形式を変更することが
できます. このコマンドは形式をミニバッファから読みとり, 文書の章立てを
変更します.
自分独自のスタイルを選んだ場合, 手動で
bhl-my-sectioning-regexp-listをカスタマイズしてください.
See グローバルオプション. この変数は章, 節, 小節に対応する3つの正規
表現のリストを含んでいます. bhl-sectioning-default-styleを
myに設定した場合は, bhl-update-tocがうまく作動しない
ことに注意してください.
章のプレフィクス(数字や文字)を更新するには<C-c M-t>を押します. こ
れはbhl-update-tocの規定キーバインドです.
この章ではフォント指定, 環境, 水平線の記述方法を紹介します.
フォント指定により強調, 下線, 太字, および語句のtruetype化ができます.
SGMLとTexinfo出力では, underlineはemphasisと同様イタリッ ク(斜体)になります. HTMLとLaTeX出力では, underlineは下線を意味 します.
太字の斜体にしたい場合, _*この順番*_で指定してください. ただし
Texinfo出力では無効となります.
アンダースコアやアスタリスクを表示したい場合は, \*や\*の
ようにエスケープ文字を前につけてください. 同様にしてコメント文字を出力
することもできます: \#. See コメント.
bhl-change-font-コマンドにより, 指定された範囲にフォントを指
定することもできます. See フォント変更.
bhl-change-font- commands. See フォント変更.
フォントを変更したいときにbhlファイルで使うことのできるタグ の一覧です:
*語句*
語句を太字にします.
_語句_
語句を強調します.
_*語句*_
語句を太字の斜体にします.
__語句__
語句に下線をひきます.
==語句==
語句をtruetypeフォントで表示します.
新しいコメントを始める文字は#です.
コメントは好きなところに書くことができますが, コメントは行末まで続くも のと解釈されます. "コメント終了"を意味する文字はありません.
コメントを意味するわけではなく, 単純に文字#を入力する場合は, エ
スケープ文字をつけてください: \#.
現在の領域をすべてコメントにするにはbhl-comment-regionを実行
します. これは<C-c ;>にバインドされています. また, コメントを外す
にはC-u bhl-comment-regionにシンボリックプレフィクスをつけま
す: <C-u C-c ;>
コメントを不可視にするにはbhl-hide-commentを, 可視にするには
C-u bhl-hide-commentを実行します.
bhlは3つの環境を扱うことができます: quote,
verbatim, minipageです. quoteはテキストの一部を引
用します. verbatimは文書にコードを記述する場合に便利です.
minipageはメインページ内にミニページを作成します. 境界線をつけ
ることも可能です.
一部を引用するには, 行頭にタブを1つ置いてください. 例:
Put some words here.
Put some words here.
Put some words here.
Put some words here.
verbatim環境の文法です:
--
Put some words here.
--
注意: 2つのダッシュがverbatim環境の区切りです. また, 4つのダッ
シュは水平線を意味します.
bhl-special-faceがbhl-hr-faceと異なる場合, ダッシュの強調 は文法的な役割の違いを表します. See 水平線.
bhl-verbatim-ignore変数はverbatim環境内で無意味になる文法要素の 一覧が指定されています. つまり, たとえフォント指定であっても, 文法要素 は変換されません. See グローバルオプション.
minipageの挿入法の例です:
%%%[12cm]
This minipage (12cm) will be centered without border.
%%%
<%%[10cm]
This minipage (10cm) will be put on the left without border.
%%%
>-%
This minipage will be put on the right with borders.
%%%
minipage環境の区切りとなるのは行頭の%%%です. これは中央に配置さ
れたメインページと同じ幅の枠なしミニページを意味します.
最初の%を<や>にした場合, ミニページが左または右に
配置されます. たとえば, <%%%%は左に配置された, メインページと同
じ幅のミニページを意味します.
2番目の%をダッシュ(-)にした場合, ミニページに枠をつけま
す. たとえば, <-%%%%はメインページと同じ幅で左に配置された枠あ
りのミニページを意味します.
角括弧で幅を指定することができます: %%%[8cm]. これはオプション
です. "40%"のような相対長は指定できません. 文字%はLaTeX環境で
はコメントを意味します. 絶対長を使ってください.
ミニページはHTML, LaTeX, Texinfo出力でのみ正常に動作します. Texinfo出
力では, bhl-texi-centered-minipage-tagのような中央に配置されたミ
ニページを選択できます. SGML出力では, bhl-sgml-minipage-tagのよ
うなミニページを選択できます. bhl2txtはミニページを変換しま
せん. 単に行頭にある%%%を削除するだけにとどめます.
ミニページをbhl-insert-minipageで挿入できます. See 挿入.
水平線は4つ以上のダッシュを行頭に置きます. 最初のダッシュは配置指示で 置き換えることが可能です.
注意: 水平線はSGMLとTexinfo形式では無視されます.
----[12cm]
<---[12cm]
>---[12cm]
最初の例では中央に配置されます. 2番目の例では左に, 3番目では右に配置さ
れます. 線の幅は12cmです. 長さはオプションです. 単に----として
も問題ありません.
水平線はbhl-insert-hrで挿入できます. See 挿入.
4つの文字をエスケープすることができます: アスタリスク(*), アン
ダースコア(_), シャープ(#), バックスラッシュ(\)で
す. エスケープされると, これらの文字は文法的な意味を失います. バックス
ラッシュのエスケープはbhl2latexでの変換でのみ意味をもちます.
LaTeXに変換する際, bhlは自動的にいくつかの文字をエスケープし
ます. 対象となる文字は次の通りです: $ & % { }. 注意:
bhl2latexによる変換ではバックスラッシュは自動的には変換
されません. 自分で$\backslash$のように入力するか, \\のよ
うにエスケープする必要があります. Texinfoに変換する際, bhlは
@ { }をエスケープします.
bhlがこれらの文字をエスケープしないなら, bhlファイ ル内で自分でエスケープする必要があります.
リンクには2種類あります: URLとWikiNameです. URLは... よく知っているで
しょう. WikiNameは"MyWikiName"のように大文字と小文字の混ざった語句で
す. カーソルをリンクの上におき, <RET>または<mouse-2>を押すと飛
びます. URLであればbhl-browse-url-functionが実行されます.
WikiNameであればWikiNameに.bhlをつけたファイル名をもつファイル
が開かれます.
bhl-downcase-wikifiles-names-flagをnon-nilに設定しておけ
ばすべてを小文字に変換します. また, WikiFile名の拡張子を
bhl-default-wikifiles-extensionに設定することもできます.
WikiNameとして解釈してほしくない語句のリストを
bhl-non-wiki-names-listに設定できます.
文書のリンク一覧をbhl-show-lol(<C-c C-/>にバインドされて
います)で見ることができます. リンク一覧を挿入する場合は
bhl-insert-lol(<C-c C-c l>にバインドされています)を使い
ます. See リンク一覧.
URLやWikiNameをbhl-goto-next-url-or-wiki <C-TAB>でブラウ
ズすることができます. (See BHLファイルのブラウズ.)
URLはbhl-convert-url関数により変換され, WikiNameは
bhl-convert-wiki-namesにより変換されます. URLはそのまま
(http://site.org)書くことも, ラベルを定義するために角括弧に入
れて([[http://site.org][my site]]書くこともできます.
URLはbhl-insert-url, <C-c C-c h>で挿入できます:
See コマンドとキーバインド.
以下にURLとそのHTMLへの変換結果を示します:
|
以下にURLとそのLaTeXへの変換結果を示します:
|
以下にURLとそのTexinfoへの変換結果を示します:
|
以下にURLとそのSGMLへの変換結果を示します:
|
以下にURLとそのTXTへの変換結果を示します:
|
これらの例で, `http://'を`ftp://'や`file:///'に置き換えることもできま
す. [[...][...]]を使う場合, `http://'のようなプレフィクスは必須
ではありません.
bhlは3種類のリストを処理できます: 番号なしリスト, 番号ありリ スト, そして叙述(限定)的リストです.
番号なしリストは, 行頭の<TAB>, セパレータ<- * o>,
空白で定義されます.
番号ありリストは, 行頭の<TAB>, 数字, ピリオド, そして空白で 定義されます.
定義リストは, 行頭の<TAB>, 用語, 空白, ダッシュ2つ, そして 空白で定義されます.
<TAB>はインデントをつけるためのもの, そして<M-TAB>はちょうと3
カラムのTABを挿入するためのものです. *の後に空白を忘れないでく
ださい. 空白がないと次の文字が太字になります.
bhlは入れ子になったリストも処理できますが, 定義リストは入れ 子にできません. 入れ子になる項目を追加するには, TABでインデントをつけ てください. それぞれのリストにおいて, 先頭にある項目がリストの種類を決 めています.
リストのセパレータの一覧です:
<TAB(S)>[*,-,o]<SPC>
<TAB(S)>[0-9].<SPC>
<TAB(S)>A term<SPC>--<SPC>
詳細はhttp://www.nongnu.org/bhlにある例を見てください.
以下が表の例です:
| @Name@ | @First name@ | @Age@ |
| Jean | Luc-Henri | 123 |
| Paul | Matthieu | 2 |
|
文字|が3種類の異なる役割を果たしています: 行の始まり, セルの区
切り, そして行の終わりです. 空白やタブは行頭と最初の|の間にあっ
てはいけません.
セルの中身周辺の@はこのセルがヘッダであることを意味しています.
通常ヘッダは最初の行にあります. HTML出力では, ヘッダセルは
<TH></TH>タグで表されます. LaTeXやSGMLではヘッダ行は水平線で表
の他の部分から区切られます.
表のオプションの詳細について: See 表の変換.
画像を挿入した例です:
[[image.jpg]]
特定のファイルを探してイメージとして挿入するには<C-c C-c i>を使い
ます. これはbhl-insert-imageにバインドされたキーです.
bhl2htmlだけが画像を扱うことができます. bhl2sgml,
bhl2texinfo, bhl2latexのような他の変換関数では画像
のかわりに文字が入ります. bhl2txtでは画像は消去されます.
bhl文書を何もカスタマイズせずに変換したいと思うかもしれませ
ん. ええ, 問題ありません. しかし, 変換関数に応じて異なる機能を使おうと
考えるかもしれません. たとえば, HTMLへの変換であれば目次をつけ, LaTeX
への変換では目次をつけないようにすることは可能です. LaTeX出力の時だけ
\date{...}を出力することもできます. 特定のHTML出力にだけ別の
CSSスタイルを設定することもできるのです.
この章ではこのような設定の方法を紹介します.
変換機能を選択する2つの重要な変数があります.
bhl-xxx-conversion-listとbhl2xxx-properties-listです. ただ
しxxxには変換の名前が入ります. See グローバルオプション.
bhl-xxx-conversions-listには各書式での変換の詳細が入ります. 通常 この変数を修正する必要はほとんどありません.
bhl2xxx-properties-listには変換のグローバルオプションが入ります.
これらのグローバルオプションはあいまいなタグ, セクションのプレフィクス
の挿入, 表のキャプション, i18n変換, 目次の挿入, そして章/タイトルのセ
ンタリング(bhl2txt変換)を設定できます. 変数を変えるには:
M-x customizeで変数を変える
この順番は重要です: 指定行のオプションはメニューによる設定を無効にしま す. そしてメニューによる設定はカスタマイズを無効にするのです.
このグローバルオプションはbhl-modeコマンドを実行するたびデフォ
ルト値(カスタマイズした値)に設定されます.
bhl-after-conversion-hookリストから
bhl-initialize-properties関数を除去しない限り, 変換ごとに初
期値に再設定されます.
bhlは文書内に機能設定行をもちます. よってbhlは この文書を適切に処理できます. 機能指定は2種類に大別できます: 文 書のヘッダおよび変換です. 指定行の例をあげます:
#!html!prefix:check:caption:toc
#!latex!noprefix:nocheck:nocaption:notoc
#!date!It's %H:%M.
この例で, コマンドbhl2htmlは章のプレフィクスを挿入し, あいま
いなタグをチェックし, 表にキャプションをつけ, 目次(toc)をつけま
す. 一方, コマンドbhl2latexではこれらを一切しません. 日付は
現在の時刻(時:分)に設定されます. とても簡単ですね.
指定行は行の先頭にコメント記号をつけます. 指定行は2部に分離できます:
感嘆符2つに挟まれたプレフィクスと, コロンで区切られたラベ
ルです. 各ラベルはno-をつけることでオフにすることができます:
notocはtocの逆になるわけです.
以下にプレフィクスとラベルの一覧をあげます:
#!author!
#!title!
#!xxx-title!指定).
#!xxx-title!
xxx変換のときの文書のタイトル. xxxはhtml,
latex, texiのことです. この指定は#!title!によりオー
バーライドされますが, 先頭行についてはオーバーライドします.
#!subtitle!
#!lang!
@documentlanguageの値として設定されます.
#!encoding!
@documentencodingの値として設定されます. HTML
出力では, bhl-html-content-typeの値としてオーバーライドされます.
#!date!
#!date!:%H:%Mにより現在の時刻(時:分)が設定さ
れます. see Time Conversion.
#!html!
bhl2htmlに関する指定. 利用できるラベルは以下の通りです:
prefix
check
caption
i18n
toc
#!html-style!
#!latex!
bhl2latexに関する指定. 利用できるラベルは以下の通りです:
prefix
check
caption
i18n
toc
!#latex-class!
#!latex-options!
#!latex-packages!
#!latex-packages!fontenc[T1]:[latin1]inputenc:babel[french]
\usepackage[T1]{fontenc}
\usepackage[latin1]{inputenc}
\usepackage[french]{babel}
角括弧の位置は問いません.
#!texi!
bhl2texinfoに関する指定. 利用できるラベルは以下の通りです:
check
i18n
toc
#!texi-style!
classicalまたはcenteredが指定
可能.
#!sgml!
bhl2sgmlに関する指定. 利用できるラベルは以下の通りです:
check
caption
i18n
#!txt!
bhl2txtに関する指定. 利用できるラベルは以下の通りです:
center
toc
tas
bhlモードは文書をブラウズする2つのコマンドとともに使われます:
bhl-show-tocおよびbhl-show-lolです. 後者はリンク一
覧をブラウズできます. 前者は目次をブラウズできます. これら2つのコマン
ドは新しいバッファを作ります.
bhlモードはbhlファイルの章番号を更新したり, 目次を 挿入したり, 目次を新しいバッファでブラウズすることができます.
目次の処理には2つの変数が必要です: bhl-toc-locationと
bhl-default-toc-depthです. 始めの変数は目次を挿入する場所を指定
します. この値はメニューやcustomizeで変更できます. 2番目の変
数は目次の深さを変更できます.
bhl-insert-toc <C-c C-c t>で目次を挿入できます. 引数で数
字を指定することで深さを設定できます. *toc*バッファから<i>
で目次を挿入することもできます. このバッファから挿入すると, バッファに
表示されている深さに設定されます.
バッファを変換するとき, bhlはまず目次があるかを調べます. 存 在する場合, bhlは現在の目次の位置に挿入します.
ブラウズできる目次のある*toc*というバッファを生成できます. メ
ニューまたは<C-c C-t>によりブラウズできます. 引数の数字で深さが指
定できます.
bhl-toc-modeの簡単な説明
*toc*バッファを閉じる
<C-c C-c t>でbhlファイル自身に目次を挿入できます. 目次が すでに挿入されている場合, 目次が更新されます. 目次がない場合, bhl-toc-locationで指定された場所に挿入します. 引数の数字で深さを 指定します.
リンク一覧をbhl-show-lolで見ることができます. 標準のキーは
<C-c C-/>です. *lol*という新しいバッファが作られ,
bhl-lol-modeとなります.
このバッファ内を動く間, 文書のバッファはリンク先を指すように更新されま す. <RET>や<mouse-2>によりリンク先に飛ぶことができます.
bhl-lol-mode内で使うことのできるコマンド一覧です:
bhl-lol-modeの簡単な説明
*lol*バッファを閉じる
この章ではbhlモードのメインコマンドを説明します.
この変換コマンドは2つのフックに大別されます: 各変換書式に関するもの (bhl-xxx-after-conversion-hook)およびグローバルフック (bhl-after-conversion-hook)です. これらのコマンドはポップアップ メニュー<C-down-mouse-3>(<control>を押しながらマウスの右ボタン を押す)からも指定できます.
| bhl2html | Function |
| 現在のバッファをHTMLに変換し新しいバッファに表示します. デフォルトでは <C-c C-w>にバインドされています. |
| bhl2latex | Function |
| 現在のバッファをLaTeXに変換し新しいバッファに表示します. デフォルトで は<C-c C-l>にバインドされています. |
| bhl2texinfo | Function |
| 現在のバッファをTexinfoに変換し新しいバッファに表示します. デフォルト では<C-c C-o>にバインドされています. |
| bhl2sgml | Function |
| 現在のバッファをSGML(Linuxdoc)に変換し新しいバッファに表示します. デフォ ルトでは<C-c C-s>にバインドされています. |
| bhl2txt | Function |
| 現在のバッファをTXTに変換して新しいバッファに表示します. タグや文法要 素を削除します. デフォルトでは<C-c C-d>にバインドされています. |
| bhl-insert-url | Function |
| URLと名前をミニバッファから読みこんで挿入します. デフォルトでは <C-c C-c h>にバインドされています. |
| bhl-insert-image | Function |
| 画像のファイル名をミニバッファから読みこんで挿入します. デフォルトでは <C-c C-c i>にバインドされています. |
| bhl-insert-minipage | Function |
| ミニページを挿入します. デフォルトでは<C-c C-c m>にバインドされて います. |
| bhl-insert-verbatim | Function |
| verbatim環境を挿入します. デフォルトでは<C-c C-c v>にバインドされ ています. |
| bhl-insert-hr | Function |
| 水平線を挿入します. 配置と幅をミニバッファで聞きます. デフォルトでは <C-c C-c r>にバインドされています. |
| bhl-insert-toc [depth] | Function |
現在のバッファに目次を挿入します. デフォルトでは<C-c C-c t>にバイ
ンドされています. このコマンドはbhl-toc-modeの*toc*バッ
ファから<i>で呼び出すことができます.
任意の引数( 目次が挿入できる場所は3箇所あります: タイトルの直後, 文書の末尾, そし て指定した場所です. bhl-toc-locationで指示します. |
| bhl-insert-lol | Function |
リンク一覧を現在のバッファに挿入します. デフォルトでは<C-c C-c l>
にバインドされています. このコマンドはbhl-lol-modeの
*lol*バッファから<i>で呼び出すことができます.
|
| bhl-show-toc [depth] | Function |
目次の書かれた*toc*というバッファを作成します. デフォルトでは
<C-c C-t>にバインドされています. 任意の引数(depth)は目次の
深さです. 引数がなければ深さはbhl-default-toc-depthとなります.
このコマンドはポップアップメニューからも利用可能です.
|
| bhl-show-lol | Function |
リンク一覧のある*lol*というバッファを作成します. リンクはURLや
WikiNameです. デフォルトでは<C-c C-/>にバインドされています. この
コマンドはポップアップメニューからも利用可能です.
|
| bhl-goto-next-section | Function |
| 次の章に飛びます. デフォルトでは<C-c C-n>にバインドされています. <C-u>に続けると次の章または(小)節に飛びます. |
| bhl-goto-previous-section | Function |
| 前の章に飛びます. デフォルトでは<C-c C-p>にバインドされています. <C-u>に続けると前の章または(小)節に飛びます. |
| bhl-goto-next-url-or-wiki | Function |
| 次のURLまたはWikiNameに飛びます. デフォルトでは<C-TAB>にバインドさ れています. |
| bhl-change-font-bold | Function |
2つの*で挟みます. 領域が選択されている場合, 領域全体を*
で挟みます. それまでのフォント指定は解除されます. デフォルトでは
<C-c C-f C-b>にバインドされています.
|
| bhl-change-font-emphasis | Function |
2つの_で挟みます. 領域が選択されている場合, 領域全体を_
で挟みます. それまでのフォント指定は解除されます. デフォルトでは
<C-c C-f C-e>にバインドされています.
|
| bhl-change-font-underline | Function |
2つの__で挟みます. 領域が選択されている場合, 領域全体を__
で挟みます. それまでのフォント指定は解除されます. デフォルトでは
<C-c C-f C-u>にバインドされています.
|
| bhl-change-font-truetype | Function |
2つの==で挟みます. 領域が選択されている場合, 領域全体を==
で挟みます. それまでのフォント指定は解除されます. デフォルトでは
<C-c C-f C-t>にバインドされています.
|
| bhl-change-font-bolditalic | Function |
_*と*_で挟みます. 領域が選択されている場合, 領域全体を
_*と*_で挟みます. それまでのフォント指定は解除されます.
デフォルトでは<C-c C-f C-_>にバインドされています.
|
| bhl-change-font-normal | Function |
| 選択された領域のフォント指定を解除します. 領域が指定されていない場合は 何もしません. デフォルトでは<C-c C-f C-n>にバインドされています. |
| bhl-sectioning-switch-style | Function |
ミニバッファから章立てのスタイルを読みこみ章立てを修正します. 利用可能
なスタイルはnum, alpha, aster, equal-sign
です.
|
| bhl-comment-region | Function |
| 現在の領域をコメント化します. シンボル引数があればコメントを解除します. デフォルトでは<C-c ;>にバインドされています. |
| bhl-hide-comment | Function |
| コメントを不可視にします. シンボル引数があれば可視化します. |
| bhl-compose-mail | Function |
現在のバッファをbhl2txtでTXT化しメールドラフトに出力します.
デフォルトでは<C-c C-x m>にバインドされています. このコマンドはポッ
プアップメニューでも利用可能です.
|
| bhl-view-log | Function |
| 最後の変換のログを一時バッファに表示します. |
| bhl-update-toc | Function |
| 章立ての番号を更新します. デフォルトでは<C-c M-t>にバインドされて います. |
| bhl-submit-but-report | Function |
| バグレポートをメールで送ります. これはGNU Emacsでのみ利用可能です. |
| bhl-show-version | Function |
| bhlモードのバージョン番号を表示します. デフォルトでは <C-c C-v>にバインドされています. |
| bhl-texi-toggle-accents | Function |
| Texinfoバッファでアクセントをトグルします. アクセントを使っている場合, この関数をbhl-after-texi-conversion-hookに加えておくとよいでしょ う. |
You can change the value of each option via M-x
customize-group RET bhl RET or via Customize BHL in the
bhl menu.
| bhl-mode-hook | User Option |
Hook run while in bhl mode. If you are under GNU Emacs, it
could be useful to add footnote-mode, since bhl
converts footnotes.
|
| bhl-after-conversion-hook | User Option |
Hook run at the very end of a conversion. The default value is
bhl-initialize-properties. If you remove this function, the
conversion properties of the last converted buffer will be the
default conversion properties for the next converted buffer -
which may not be what tou really want.
|
| bhl-autoguess-style-flag | User Option |
|
If non-nil, autoguess the sectioning style. When you find a file,
BHL tries to guess its sectioning style and sets the value
of `bhl-sectioning-default-style' to the value of the file's style.
The default value of bhl-autoguess-style-flag is |
| bhl-sectioning-default-style | User Option |
Define the style for the titles of sections, subsections and
subsubsections. The five available styles are: numerical (num),
alphabetical (alpha), asterisks (aster), equal-signs
(equal-signs) and your own style (my). See 章.
If you want to use your own style, you have to define
bhl-my-sectioning-regexp-list. In this case,
|
| bhl-my-sectioning-regexp-list | User Option |
A list of regular expressions that match the different levels of
sectioning. They respectively match the prefix of a section's,
subsection's and subsubsection's title. Since the titles of the
sections are always put at the beginning of the line, you don't
have to insert a ^ in these regular expressions.
The default value of bhl-my-sectioning-regexp-list is the value
of bhl-my-sectioning-regexp-list, which corresponds to the
numerical style ( |
| bhl-verbatim-ignore | User Option |
A list of syntactic elements that shouldn't be converted when found
inside a verbatim environment. The default value of this variable is
(tag comment list description table url wikiname images
special-char tex-label footnote quote).
|
| bhl-ignored-regexps | User Option |
| A list of regexps. Each line matching a regexp within this list is automatically killed before any conversion. |
| bhl-i18n-conventions | User Option |
The car of this variable is a language specification among
english, french and german. bhl will follows
conventions according to the chosen language.
If the second element if t, bhl follows conventions concerning the
punctuation, as defined in bhl-xx-punctuation (where If the third element if t, bhl follows conventions concerning the quotation marks, as defined in bhl-xx-quotation-marks. If the fourth element if t, bhl follows conventions concerning special characters, as defined in bhl-xx-special-chars. |
| bhl-browse-url-function | User Option |
A function for calling your favorite browser. The default value is
browse-url.
|
| bhl-after-html-conversion-hook | User Option |
| Hook run after the HTML conversion. |
| bhl2html-properties-list | User Option |
The list of properties relevant for the bhl2html
conversion. See 変換機能. Don't modifiy this
variable manually. Use M-x customize instead.
|
| bhl-html-conversions-list | User Option |
A list of conversions to perform with bhl2html. Each element of
this list is boolean. Don't edit this option manually, use M-x
customize instead.
|
| bhl-html-meta-alist | User Option |
A list of META tags to be inserted in the header of HTML output. Each
element is divided into two elements: the first one indicates the
name of the META tag, the second one indicates the
content of the META tag.
|
| bhl-html-link-alist | User Option |
A list of LINK tags to be inserted in the header of HTML
output. Each element is divided into two elements: the first one
indicates the rel of the LINK tag, the second one
indicates the href of the LINK tag.
|
| bhl-html-doctype | User Option |
The document type description of the HTML output. The default value is:
<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01
Transitional//EN\">.
|
| bhl-html-content-type | User Option |
The content type description of the HTML output. The default value is:
<META HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=iso-8859-1>".
|
| bhl-html-default-style | User Option |
The style to be inserted into the header (<HEAD>...</HEAD>) of
the HTML output.
|
| bhl-html-title-tags | User Option |
| A list defining the opening and closing tags of the HTML title. |
| bhl-html-subtitle-tags | User Option |
| A list defining the opening and closing tags of the HTML subtitle. |
| bhl-html-para-align | User Option |
How bhl aligns each paragraph of the HTML output. The default value
is none.
|
| bhl-html-img-align | User Option |
Image alignment. The default value is center.
|
| bhl-html-list-item-is-para-flag | User Option |
Non-nil means that list items are paragraphs into the HTML
output.
|
| bhl-after-latex-conversion-hook | User Option |
| Hook run after the LaTeX conversion. |
| bhl2latex-properties-list | User Option |
The list of properties relevant for the bhl2latex
conversion. See 変換機能. Don't modifiy this
variable manually. Use M-x customize instead.
|
| bhl-latex-conversions-list | User Option |
A list of conversions to perform with bhl2latex. Each element
of this list is boolean. Don't edit this option manually, use
M-x customize instead.
|
| bhl-latex-packages-alist | User Option |
A list of packages to be included in the LaTeX header. Each element
is divided into two elements: the first one indicates the name
of the packages, the second one indicates the options of the
package.
|
| bhl-latex-default-class | User Option |
The default class of document for the LaTeX output. The default value
is article.
|
| bhl-latex-default-class-options | User Option |
The default options passed to the \documentclass{...}
command. The default value is 12pt.
|
| bhl-texi-conversion-hook | User Option |
Hook run after the Texinfo conversion. The default value is
(texinfo-every-node-update bhl-texi-make-menu), so
that the output file is ready for compilation. If you are using
accents, you may add bhl-texi-toggle-accents.
|
| bhl2texi-properties-list | User Option |
The list of properties relevant for the bhl2texinfo
conversion. See 変換機能. Don't modifiy this
variable manually. Use M-x customize instead.
|
| bhl-texi-conversions-list | User Option |
A list of conversions to perform with bhl2texinfo. Each
element of this list is boolean. Don't edit this option manually, use
M-x customize instead.
|
| bhl-texi-setchapternewpage-flag | User Option |
Set the @setchapternewpage value. The default value is
on.
|
| bhl-texi-titlepage-style | User Option |
The style of the title page. The classical titlepage is the
one mostly used by the GNU manuals. The centered
titlepage centers the title and other informations on the front page.
|
| bhl-texi-centered-minipage-tag | User Option |
| The default tag used for the conversion of centered minipages. See 環境. |
| bhl-texi-table-tag | User Option |
The tag for the conversion of tables in the Texinfo output. The
default value is verbatim. If you want to skip tables when
converting into Texinfo format, you should set this to ignore.
|
| bhl-after-sgml-conversion-hook | User Option |
| Hook run after the SGML conversion. |
| bhl2sgml-properties-list | User Option |
The list of properties relevant for the bhl2hsgml
conversion. See 変換機能. Don't modifiy this
variable manually. Use M-x customize instead.
|
| bhl-sgml-conversions-list | User Option |
A list of conversions to perform with bhl2sgml. Each element
of this list is boolean. Don't edit this option manually, use
M-x customize instead.
|
| bhl-sgml-list-item-is-para-flag | User Option |
Non-nil means that list items are paragraphs into the SGML
output.
|
| bhl-sgml-minipage-tag | User Option |
| The default tag used for the conversion of minipages. See 環境. |
| bhl-after-txt-conversion-hook | User Option |
| Hook run after the TXT conversion. |
| bhl2txt-properties-list | User Option |
The list of properties relevant for the bhl2txt
conversion. See 変換機能. Don't modifiy this
variable manually. Use M-x customize instead.
|
| bhl-txt-conversions-list | User Option |
A list of conversions to perform with bhl2txt. Each element
of this list is boolean. Don't edit this option manually, use
M-x customize instead.
|
| bhl-is-a-local-wiki-flag | User Option |
If non-nil, this means that bhl is a local wiki. You
can toggle this variable from the menu.
|
| bhl-default-wikifiles-extension | User Option |
The default extension for the Wiki file names. The default value for
this options is .bhl. For example, when following a WikiName
named MyWikiName, a new file named MyWikiName.bhl will
be found.
|
| bhl-downcase-wikifiles-names-flag | User Option |
If non-nil, following a WikiName named MyWikiName will
find a file named mywikiname.bhl, which is the downcased value
of the WikiName. Otherwise, it will find a file named
MyWikiName.bhl.
|
| bhl-non-wiki-names-list | User Option |
| A list of mixed-case strings that should not be considered as WikiNames. For example: "OpenOffice". |
| bhl-default-toc-depth | User Option |
| The default doc depth. The default value is three. |
| bhl-toc-location | User Option |
Indicates the toc location. This variable may have three different
values: top (just after the title), bottom (just before
the end) or point (at point).
|
| bhl-intro-toc | User Option |
| A string to insert before the table of contents in the source file. |
| bhl-end-toc | User Option |
| A string to insert after the table of contents in the bhl files. |
| bhl-table-location | User Option |
Where to put the table. The default value is htbp, i.e. here
top bottom page. This variable does not concern the HTML output.
|
| bhl-table-align | User Option |
The table alignment. The default value is center.
|
| bhl-table-cell-align | User Option |
The cell alignment inside a table. The default value is center.
|
Just ANother Example
--- Table of contents
1. Fonts and environments
1.1. Using font beautifiers
1.2. Environments
2. Converting lists
2.1. Ordered and non-ordered lists
2.2. Description lists
2.3. Nested lists
3. Converting tables
4. Browsing your document
4.1. The table of content
4.2. The list of links
5. Contact
--- End of the table of contents
# This is the last example of a BHL file converted into HTML, LaTeX
# and SGML formats. This example shows you the various syntaxic rules
# that BHL handles. For further details, please refer to the manual
# of the BHL mode. http://www.nongnu.org/bhl
# These lines are comments.
# You can comment a region with `bhl-comment-region'
# The few next lines are specification lines. They
# indicate the properties of the different conversions.
#!author!Bastien Guerry
#!date!It is %Hh%M on %d/%m/%Y.
#!html!toc:nocaption:noprefix:noi18n
#!sgml!caption
#!latex!toc:caption:prefix:i18n
#!latex-options!11pt:a4paper
#!latex-packages!inputenc[latin1]
This document is a small example of what BHL can do. For further
details, please read the full documentation on
http://www.nongnu.org/bhl.
#!language!fr
#!encoding!iso-8859-1
#!texi-style!centered
1. Fonts and environments
1.1. Using font beautifiers
Here is a list of the *different* fonts beautifiers that you can
use inside the BHL mode.
Bold -- *one or two words.*
Emphasis -- _one or two words._
Truetype -- ==one or two words.==
Underline -- __one or two words.__
Bold italic -- _*one or two words*_.
If want to insert an asterisk, you can use the escape character like
\*this\* or like \_this\_. This is also available for \#comments.
1.2. Environments
BHL handles two specific environments: verbatim and minipage.
Verbatim:
--
Here is a *part* of text that will be displayed
in verbatim #a comment
Please remark[1] that this environment has no syntactic rule, except
you modify the variable bhl-verbatim-ignore.
* list are ignored
And so do...
Item -- descriptions.
And so do tables!
| A | B |
| C | D |
And so do quote environments:
blahblahblah
blahblahblah
Etc.
--
A minipage:
%%%[12cm]
This minipage (12cm) is centered without border.
%%%
<%%[10cm]
This minipage (10cm) is put on the left without border.
%%%
>-%[8cm]
This minipage (8cm) is put on the right with border.
%%%
A horizontal rule:
----[3cm]
Another horizontal rule, put on the right:
>---[3cm]
2. Converting lists
2.1. Ordered and non-ordered lists
*Ordered* lists begin with three *whitespaces*, a list separator (\*, - or o)
and another whitespace.
* Like this;
* or like that.
2.2. Description lists
Description lists are treated like other lists, except that they
cannot be nested in other lists.
A description item consists in tabs, a term to be defined, a
whitespace, two dashes and another whitespace.
Term -- a definition of the terme.
Definition -- another definition.
2.3. Nested lists
* Lists can be nested inside other lists.
* You just need to add three whitespaces more.
* These to items will be nested into two other items. sldkfj
lskdjf lmmlkm
1. Three levels of nested lists are supported.
2. Four levels won't be very useful...
* Blank lines are not mandatory between items.
3. Converting tables
A WikiName.
Here is a table:
| @A header here@ | @ And here@ |
| Free softxware | blabla@free.fr |
| With Emacs | Without Emacs |
| bastien | Without Emacs |
A table line begins and ends with a "|". Other "|" inside a line of
the table separate two cells. Arobases around the content of a cell
mean that this cell is a header of the table.
4. Browsing your document
4.1. The table of content
H馼馼. You can _browse_ the table of content, _insert_ it inside your
document, and _update_ the numbering of sections.
The default key binding for browsing the table of content is C-c
C-t.
You can also choose the style of sectioning and swith from one style
to another. The style of this document is set to *num* (which is the
default style) by the specification line above.
4.2. The list of links
The default key binding for browsing the list of links is C-c
C-/. This creates a new buffer with a list of URLs or wikinames that
you can follow.
5. Contact
Please feel free to submit bugs or ideas:
[[mailto:bzgNOSPAM@altern.org][BHL contact]].
Footnotes:
[1] A note.
#!author!: 機能指定
#!date!: 機能指定
#!encoding!: 機能指定
#!html!: 機能指定
#!html-style!: 機能指定
#!html-title!: 機能指定
#!lang!: 機能指定
#!latex!: 機能指定
#!latex-class!: 機能指定
#!latex-options!: 機能指定
#!latex-packages!: 機能指定
#!latex-title!: 機能指定
#!sectioning!: 機能指定
#!sgml!: 機能指定
#!sgml-title!: 機能指定
#!subtitle!: タイトルとパラグラフ, 機能指定
#!texi!: 機能指定
#!texi-style!: 機能指定
#!texi-title!: 機能指定
#!title!: 機能指定
#!txt!: 機能指定
%%%: 環境
(no)caption: 機能指定
(no)center: 機能指定
(no)check: 機能指定
(no)i18n: 機能指定
(no)prefix: 機能指定
(no)tas: 機能指定
(no)toc: 機能指定
*lol*: 文書のブラウズ, リンク一覧
*toc*: 文書のブラウズ
----: 水平線
1: 目次をブラウズ
2: 目次をブラウズ
3: 目次をブラウズ
<: 目次をブラウズ, リンク一覧
>: 目次をブラウズ, リンク一覧
?: リンク一覧, 目次をブラウズ
alpha: 章
bhl-after-conversion-hook: グローバルオプション, 機能の紹介
bhl-after-html-conversion-hook: BHL to HTML
bhl-after-latex-conversion-hook: BHL to LaTeX
bhl-after-sgml-conversion-hook: BHL to SGML
bhl-after-txt-conversion-hook: BHL to TXT
bhl-autoguess-style-flag: グローバルオプション
bhl-browse-url-function: グローバルオプション, リンク操作
bhl-change-font-bold: フォント変更
bhl-change-font-bolditalic: フォント変更
bhl-change-font-emphasis: フォント変更
bhl-change-font-normal: フォント変更
bhl-change-font-truetype: フォント変更
bhl-change-font-underline: フォント変更
bhl-comment-region: その他
bhl-compose-mail: その他
bhl-convert-url: リンク操作, 環境
bhl-default-toc-depth: オプション of the toc, 目次
bhl-default-wikifiles-extension: Wiki options, リンク操作
bhl-downcase-wikifiles-names-flag: リンク操作, Wiki options
bhl-end-toc: オプション of the toc
bhl-goto-next-section: BHLファイルのブラウズ
bhl-goto-next-url-or-wiki: BHLファイルのブラウズ, リンク操作
bhl-goto-previous-section: BHLファイルのブラウズ
bhl-hide-comment: その他
bhl-hr-face: 環境
bhl-html-content-type: BHL to HTML, 機能指定
bhl-html-conversions-list: 機能の紹介, BHL to HTML
bhl-html-default-style: BHL to HTML
bhl-html-doctype: BHL to HTML
bhl-html-img-align: BHL to HTML
bhl-html-link-alist: BHL to HTML
bhl-html-list-item-is-para-flag: BHL to HTML
bhl-html-meta-alist: BHL to HTML
bhl-html-para-align: BHL to HTML
bhl-html-subtitle-tags: BHL to HTML
bhl-html-title-tags: BHL to HTML
bhl-i18n-conventions: 機能指定, グローバルオプション
bhl-ignored-regexps: グローバルオプション
bhl-initialize-properties: 機能の紹介
bhl-insert-hr: 挿入
bhl-insert-image: 画像操作, 挿入
bhl-insert-lol: 挿入
bhl-insert-minipage: 環境, 挿入
bhl-insert-toc: 目次, 挿入
bhl-insert-url: 画像操作, 挿入
bhl-insert-verbatim: 挿入
bhl-intro-toc: オプション of the toc
bhl-is-a-local-wiki-flag: Wiki options
bhl-latex-conversions-list: BHL to LaTeX, 機能の紹介
bhl-latex-default-class: BHL to LaTeX
bhl-latex-default-class-options: BHL to LaTeX
bhl-latex-packages-alist: BHL to LaTeX
bhl-lol-mode: リンク一覧
bhl-mode-hook: グローバルオプション
bhl-my-sectioning-regexp-list: グローバルオプション
bhl-non-wiki-names-list: リンク操作, Wiki options
bhl-sectioning-default-style: グローバルオプション
bhl-sectioning-switch-style: その他
bhl-sgml-conversions-list: 機能の紹介, BHL to SGML
bhl-sgml-list-item-is-para-flag: BHL to SGML
bhl-sgml-minipage-tag: 環境, BHL to SGML
bhl-show-lol: リンク一覧, 文書のブラウズ, BHLファイルのブラウズ
bhl-show-toc: 文書のブラウズ, BHLファイルのブラウズ
bhl-show-version: その他
bhl-special-face: 環境
bhl-submit-but-report: その他
bhl-table-align: 表の変換
bhl-table-cell-align: 表の変換
bhl-table-location: 表の変換
bhl-texi-centered-minipage-tag: 環境, BHL to Texinfo
bhl-texi-conversion-hook: BHL to Texinfo
bhl-texi-conversions-list: 機能の紹介, BHL to Texinfo
bhl-texi-setchapternewpage-flag: BHL to Texinfo
bhl-texi-table-tag: BHL to Texinfo
bhl-texi-titlepage-style: BHL to Texinfo
bhl-texi-toggle-accents: その他
bhl-toc-location: コマンドとキーバインド, オプション of the toc, 目次を挿入, 目次
bhl-toc-mode: 文書のブラウズ
bhl-tt-face: フォント変更
bhl-txt-conversions-list: 機能の紹介, BHL to TXT
bhl-update-toc: その他
bhl-verbatim-ignore: グローバルオプション, 環境
bhl-view-log: その他
bhl-xxx-conversions-list: グローバルオプション
bhl2html: 変換コマンド
bhl2html-properties-list: BHL to HTML, 機能の紹介
bhl2latex: 変換コマンド
bhl2latex-properties-list: BHL to LaTeX, 機能の紹介
bhl2sgml: 変換コマンド
bhl2sgml-properties-list: BHL to SGML, 機能の紹介
bhl2texi-properties-list: 機能の紹介, BHL to Texinfo
bhl2texinfo: 変換コマンド
bhl2txt: 変換コマンド
bhl2txt-properties-list: BHL to TXT, 機能の紹介
browse-url: グローバルオプション, リンク操作
C-c ;: コメント, その他
C-c C-/: 文書のブラウズ, BHLファイルのブラウズ, リンク一覧
C-c C-c C-w: コマンドとキーバインド
C-c C-c h: 挿入, リンク操作
C-c C-c i: 画像操作, 挿入
C-c C-c l: 挿入
C-c C-c r: 挿入
C-c C-c t: コマンドとキーバインド, 挿入, 目次を挿入
C-c C-c v: 挿入
C-c C-d: 変換コマンド, コマンドとキーバインド
C-c C-f C-_: コマンドとキーバインド, フォント変更
C-c C-f C-b: フォント変更, コマンドとキーバインド
C-c C-f C-e: コマンドとキーバインド, フォント変更
C-c C-f C-n: コマンドとキーバインド, フォント変更
C-c C-f C-t: フォント変更
C-c C-f C-u: コマンドとキーバインド, フォント変更
C-c C-l: コマンドとキーバインド, 変換コマンド
C-c C-n: BHLファイルのブラウズ
C-c C-o: 変換コマンド, コマンドとキーバインド, その他
C-c C-p: BHLファイルのブラウズ
C-c C-s: コマンドとキーバインド, 変換コマンド
C-c C-t: 目次をブラウズ, 目次, BHLファイルのブラウズ, コマンドとキーバインド, 章, 文書のブラウズ, その他
C-c C-v: その他
C-c C-w: コマンドとキーバインド, 変換コマンド
C-c C-x m: その他
C-c M-t: コマンドとキーバインド, 章, 目次
C-S-TAB: BHLファイルのブラウズ, リンク操作
C-TAB: BHLファイルのブラウズ, リンク操作
C-u C-c ;: コメント, その他
C-u C-c C-n: BHLファイルのブラウズ
C-u C-c C-p: BHLファイルのブラウズ
equal-sign: 章
footnote-mode: グローバルオプション
HeVeA: Top
i: リンク一覧, 目次をブラウズ
LaTeX: Top
latex2html: Top
M-TAB: リスト操作
mouse-2: リンク一覧, リンク操作
n: 目次をブラウズ, リンク一覧
num: 章
p: 目次をブラウズ, リンク一覧
q: リンク一覧, 目次をブラウズ
RET: リンク一覧
Thanks to Serge Basterot, Jeffrey Borlik, Christoph Conrad, Tim Cross, Mario Domg‡rgen, Thomas Gehrlein, Jacob Hamacher, Sylvain Holtzer, Dan P. Katz, Mario Lang, Massimiliano Mirra, Julie Neveux, John Stauffer, Thierry Stoehr and Marco Testi.