(X)HTML文書の作成補助 (ihtml)

ihtml は、「ISO-HTML又はXHTML 1.1の文書を作るのにちょっと便利な小物」を目指して製作してゐる、xyzzyで動くLISPです。

プログラム本体置場

β版です。恐らくファイルを破壊することは無いと思ひますが、自己責任で。無限ループに陥ったらC-g (Ctrl + g)でquitしてください。

• ihtml.zip (21KiB, Ver.0.2.6.20210908)

適用ライセンス

書庫に含まれる全てのファイルに於いて、私、空拇が作った部分は、著作権抛棄とします。自由に変更・転載してください。(CC0です)

License: CC0 (Please feel free to reproduce or edit, except quotation.)

説明書

導入方法

xyzzy を導入し、 site-lisp/ に ihtml.l (.lc) と html+-mode-u.l (.lc) を置いた後、次のどちらかのコードを .xyzzy 又は siteinit.l に追記してください。

ihtmlを単体で導入する場合

(pushnew '("\\.s?html?$" . ihtml-mode) *auto-mode-alist* :test 'equal)

html+-modeと共存する場合

(in-package "editor")
(export 'ed::html+-mode "ed")
;(autoload 'html+-mode "html+-mode" t)
(autoload 'html+-mode "html+-mode-u" t)
(pushnew '("\\.s?html?$" . html+-mode) *auto-mode-alist* :test 'equal)
(in-package "user")

siteinit.lに追記した場合は、siteinit.lをバイトコンパイルし直して、xyzzyのダンプファイルを再生成(Ctrl+Shiftを押しながら起動)してください。

オプションとして、ISO-HTMLではなくXHTML 1.1のマークアップをする場合は、更に次のコードも追加してください。

(setq *ihtml-xhtml11* t)

また、ポップアップ(右クリック)メニューを追加するには、.xyzzy に次のコードを追記してください。(siteinit.l への追記はエラーになるので不可です)

(require "ihtml-menu")

使用方法

インライン要素: 文字列を範囲選択してから、キー操作又は右クリック操作でマークアップします。<img>などの空要素は、範囲選択は不要で、そのままカーソル位置に挿入できます。

ブロック・リスト要素: マークアップ操作を行ふと、カーソルが行末に無くても、その行全体がマークアップされ、次の行に移ります。

• html+-modeとは共存できます。但し、一部のキーバインドが衝突するので、御自身で好きな方の函数を優先させてください。
• 使用者に正しいHTMLの知識があることが前提です。ihtmlを誤り用ゐると、幾らでも間違った(X)HTMLを生成できてしまひます。

次に、ihtml特有の機能について述べます。

(1) マークアップに関すること

• 文字列の選択範囲(セレクション)が有る時、何かしらのファイルをxyzzyのウインドウにドロップすると、そのファイルへのアンカー<a href="...">が相対パスで生成されます。
• 画像ファイル(*.png等、*ihtml-img-extensions*で判断)をドロップすると、<img>が挿入されます。その際、alt文字列の入力を促されます。
• h0(C-0 (Ctrl + 0))で、1つ前の見出しと同じレベルの見出しでマークアップできます。同様に、h+(C-+)は1つ深いレベル、h-(C--)は1つ浅いレベルです。例へば、直前に<h2>がある時にC-+を押すと、その行が<h3>でマークアップされます。
• C-RET (Ctrl + Enter)で、カーソル位置の行全体を<p>でマークアップします。
• C-*で、その行を<li>でマークアップします。
• RET (Enter)は単なる改行ですが、S-RET (Shift + Enter)は<br>を挿入しつつ改行します。
• C-tで、選択文字列を(ISO-HTML又はHTML 1.1にある)任意のタグで(補完入力しつつ)マークアップできます。
• M-RET (Alt + Enter)で、直前のタグのclass、id、title属性を一括で修正できます。右クリックメニューから「Attributes」⇒「core」と選んでも同じです。

(2) その他

• C-! (Ctrl + Shift + 1)で選択範囲をコメント化できます。その際、選択範囲内のコメントは全部解除されます。コメント内で使った場合はコメントが解除されます。
• 文字列を選択してから、右クリックメニューより「escape」を選ぶと、選択範囲内の「<>&"」の4文字がそれぞれ「<>&"」に変ります。「unescape」は逆の動作です。
• M-, (Alt + ,)、M-.、M-6、M-2の各キーは「<>&"」の文字に対応してゐます。

注記

• <ins>と<del>はdatetime属性を自動で振ります。
• その他のタグでも、属性値の入力を促されることがあります。極一部の属性(dir、rel)では補完が効きます。
• XHTMLモードが有効の時は、空要素タグは<br />といった形で挿入されます。
• idの駄目文字判定(最初の文字に数字は許されない等)は未実装です。
• 属性値(URI等)として危険な文字(&や<など)は自動でエスケープされます。
• これらの挙動は将来的に変るかもしれません。

更新履歴

2006年5月27日 Ver.0.1.0.20070526

公開初版。

2007年9月14日 Ver.0.2.0.20070914

とにかく大幅に更新。

ドキュメントの整備し直し。

2011年10月8日 Ver.0.2.1.20111008

ライセンスとしてCC0を明記。

ほぼ全部の函数・変数にdocstringを追加。

*ihtml-imgs*を*ihtml-img-extensions*に改名。(中身は同じ)

*ihtml-xhtml11*のtとnilを切り替へる函数ihtml-toggle-xhtml11を追加。

ihtml-markup-line: *ihtml-line-break*がnilの時は、改行しないで次の行に移る様にした。(HTML化する前のテキストを、行ごとにマークアップする時に便利)

*ihtml-line-break*のtとnilを切り替へる函数ihtml-toggle-line-breakを追加。

ihtml-comment: 選択範囲内に「<!--」「-->」がある場合は全部削除し、一つもない場合は選択範囲をコメント化する様に挙動を変更。(選択範囲が無い場合は今までと同じ挙動)

ihtml-completing-markup: *ihtml-xhtml11*がtの時は、XHTML 1.1の要素を補完する様にした。

2011年10月13日 Ver.0.2.2.20111013

*ihtml-tags*: <fieldset>が抜けてゐたので追加。

ihtml-markup、ihtml-markup-empty: 属性リストattrの属性リスト値にnilが与へられた時は、HTML属性値を省略する様にした。例: (ihtml-markup-empty "input" '("type" "checkbox" "checked" nil)) => <input type="checkbox" checked>

ihtml-set-attribute: 補完入力も可能な様に改造。ihtml-attr-bdoで使用。

ihtml-escape、ihtml-unescape: nilを受け取ると、エラーではなくnilを返す様に変更。(ihtml-markupの(mapcar #'ihtml-auto-escape attr)で、attrの属性リスト値がnilでもエラーにならない様に)

その他、ソース内コメント・ドキュメントの微修正。

2011年11月1日 Ver.0.2.3.20111101

ポップアップメニューを別ファイルに分離。これにより本体をsiteinit.lに記述できる様になった。(メニュー関係は.xyzzyにしか記述できない)

2012年5月24日 Ver.0.2.4.20120524 (未公開)

ihtml-defun-markup-selectionなど: docstringを入力できる様に改良。

ihtml-a: 挙動をihtml-a-globalからihtml-a-local相当に修正。

ihtml-br、ihtml-hr: ブロック要素と同じ挙動に変更。

ihtml-markup-line: 引数tagを受け付ける様に変更。

ihtml-a-fragment: 追加。文書内のid属性値を抽出して<a href="#...">を生成。

2014年10月30日 Ver.0.2.5.20141030

マクロで生成してゐたマークアップ函数など、これまでdocstringが無かった函数にもできるだけdocstringを追加。

ポップアップメニュー(ihtml-menu.l)のファイルのバージョン表記を本体(ihtml.l)に合せた。

ポップアップメニューのihtml-aをihtml-a-localとihtml-a-globalに分離。

ihtml-a: 挙動をihtml-a-localからihtml-a-global相当に戻し、デフォルトの挙動を切り替へる変数*ihtml-a-local*を追加。

ihtml-string-to-uri: si::www-url-encodeを適用するかを選択する変数*ihtml-string-to-uri-escape*を追加。

ihtml-meta: 新しく追加。http-equivの属性値を*ihtml-meta-http-equiv*に従って補完入力可能(*ihtml-meta-name*も同様)。ポップアップメニューのOthersにも<link>、<meta>を追加。

ihtml-defun-markup-line、ihtml-implied-attr: 新しく追加。コードを短く書くためのマクロ。

ISO-HTMLに含まれる全てのフォーム要素を追加。ポップアップメニューにも追加。

ihtml-object: 誤って空要素扱ひにしてゐて、終了タグが挿入されなかったバグを修正。

ihtml-set-attribute: XHTML 1.1モードの時、<hr />などの空要素に使用すると「/」と「>」の間に属性が挿入されるバグを修正。

2021年9月11日 Ver.0.2.6.20210908

HTMLを読み込んだ時だけキーマップを適用する様に修正。

html+-modeと共存できるようにhtml+-mode-u.lを同梱し、導入方法を変更。