yatex

view docs/yahtmlj.tex @ 70:44e3a5e1e883

find changesets by author, revision, files, or words in the commit message
Fix makefile for Windows Brush up label completion \cite completion Support much more about LaTeX2e --- [yahtml] English Info (By Jun Ohya) Automatic pixel size detection for <img src="..."> Aware global-class of css definition & for char-entity reference
author yuuji
date Sun, 09 Apr 2000 03:37:47 +0000
parents 807c1e7e68b7
children 0aaebd07dad0
line source
1 \def\lang{jp} % -*- texinfo -*- for Texinfo V.3.1
2 \input texinfo
3 @setfilename yahtmlj
4 @settitle Yet Another html-mode for Emacs
5
6 @iftex
7 @c @syncodeindex fn cp
8 @c Infoって最近読む人が増えたらしい
9 @c まだ書き終わっていません。
10 @c Last modified Mon Nov 29 15:43:04 1999 on buell
11 @syncodeindex vr cp
12 @end iftex
13
14 @titlepage
15 @sp 10
16 @center
17 @subtitle Yet Another html-mode for emacs
18 @title 『HTML屋』
19 @subtitle // yahtml //
20 @author @copyright{} 1994-1997 by HIROSE, Yuuji [yuuji@@yatex.org]
21 @end titlepage
22
23 @node Top, Intro, (dir), (dir)
24 @comment node-name, next, previous, up
25
26 @menu
27 * Intro:: はじめに
28 * Installation:: インストール
29 * Command Invocation:: 外部コマンド起動
30 * Completion:: 補完入力
31 * Jump:: カーソルジャンプ
32 * Changing and Deleting:: 変更と削除
33 * CSS Support:: スタイルシート補完
34 * Customizations:: カスタマイズ変数一覧
35 * Copying:: とりあつかい
36 * Concept Index:: 索引
37
38 @end menu
39
40 @node Intro, Installation, Top, Top
41 @comment node-name, next, previous, up
42 @chapter はじめに
43 @cindex Demacs
44 @cindex Mule
45 @cindex LaTeX
46 @cindex HTML屋[HTMLや]
47
48 yahtmlは GNU Emacs 上で HTML文書を作成する時に、繁雑なHTMLタグの入力を補
49 完機能によってスムーズに行えるようにするだけでなく、weblintなどの構文チェッ
50 クプログラム、カーソル位置のURLやファイル名に依存したブラウザ/イメージヴュー
51 アの起動などを Emacs 編集画面中から
52 行えるようにするパッケージです。
53
54 (このInfoは未完成です(__)…)
55
56 @node Installation, Command Invocation, Intro, Top
57 @comment node-name, next, previous, up
58 @chapter インストール
59 @menu
60 * yahtml起動のための設定::
61 * lintプログラム/ブラウザ/イメージヴューア環境等の設定::
62 * WWWページ環境用変数の設定::
63 @end menu
64
65 @node yahtml起動のための設定, lintプログラム/ブラウザ/イメージヴューア環境等の設定, Installation, Installation
66 @section yahtml起動のための設定
67
68
69 @file{~/.emacs}に下の2項目を加えます。
70
71 @lisp
72 (setq auto-mode-alist
73 (cons (cons "\\.html$" 'yahtml-mode) auto-mode-alist))
74 (autoload 'yahtml-mode "yahtml" "Yet Another HTML mode" t)
75 @end lisp
76
77 次にyahtmlに必要なファイル(@file{yahtml.el}, @file{yatexlib.el},
78 @file{yatexprc.el}) を置くディレクトリを load-path に加えます。たとえば、
79 @file{~/src/emacs/yahtml}に置くのであれば、
80
81 @lisp
82 (setq load-path (cons (expand-file-name "~/src/emacs/yahtml") load-path))
83 @end lisp
84
85 @noindent
86 などとします。
87
88 以上の設定により、拡張子が .html であるファイルを編集すると自動的に
89 yahtml がロードされます。yahtmlが正常に起動できたときはモードラインの表示が
90 「yahtml」に変わります。
91
92 @node lintプログラム/ブラウザ/イメージヴューア環境等の設定, WWWページ環境用変数の設定, yahtml起動のための設定, Installation
93 @section lintプログラム/ブラウザ/イメージヴューア環境等の設定
94
95 利用する外部プログラムなどに関する以下の変数を確認し、必要なら正しい値に変
96 更します(括弧内はデフォルト値)。
97 @table @code
98 @item yahtml-www-browser
99 @dots{} 起動するブラウザのコマンド名(netscape)
100 @item yahtml-image-viewer
101 @dots{} 起動する画像ビューアのコマンド名(xv)
102 @item yahtml-lint-program
103 @dots{} 構文チェックプログラムのコマンド名(jweblint)
104 @item yahtml-kanji-code
105 @dots{} htmlファイルの漢字コード
106 @end table
107
108 @node WWWページ環境用変数の設定, , lintプログラム/ブラウザ/イメージヴューア環境等の設定, Installation
109 @section WWWページ環境用変数の設定
110
111 ホームページとなるファイルが存在するPATH名に関する変数を設定します。
112 @table @code
113 @item yahtml-path-url-alist
114 @dots{} ファイルシステム上のPATH名と、URLの対応表
115 @item yahtml-directory-index
116 @dots{} URL指定でファイル名を省略したときに表示されるインデックス
117 ファイル名(NCSA系httpdなら @file{index.html}, CERN系なら
118 @file{Welcome.html}が一般的)
119 @end table
120
121 変数 @code{yahtml-path-url-alist} の設定例を示します。例えば、自宅では、
122 @file{/home/yuuji/http/} が @code{http://localhost/~yuuji} で参照でき、職
123 場では @file{/usr/home/yuuji/www/} が@code{http://www.keio.ac.jp/~yuuji/}
124 で参照できるようになっている場合は以下のように設定します。
125
126 @lisp
127 (setq yahtml-path-url-alist
128 '(("/home/yuuj/http" . "http://localhost/~yuuji")
129 ("/usr/home/yuuj/www" . "http://www.keio.ac.jp/~yuuji")))
130 @end lisp
131
132 この対応組はいくらでも設定することができます。
133
134 @node Command Invocation, Completion, Installation, Top
135 @comment node-name, next, previous, up
136 @chapter 外部コマンド起動
137
138 HTMLファイル編集にかかわるいくつかのコマンドを即座に呼ぶことができます。
139 @table @kbd
140 @item [prefix] t j
141 @dots{} HTML構文チェッカ(jweblint)起動
142 @item [prefix] t p
143 @dots{} 現在のページを対象としたブラウザ起動
144 @item [prefix] t r
145 @dots{} 現在のページがブラウザに表示されているときのreload指定
146 @end table
147
148 @node Completion, Jump, Command Invocation, Top
149 @comment node-name, next, previous, up
150 @chapter 補完入力
151
152 「野鳥」で利用できる、「begin型補完」、「section型補完」、
153 「large型補完」、「maketitle型補完」、「アクセント補完」
154 と全く同じキー操作で対応する
155 HTMLタグの補完入力ができます。それぞれの型の補完は順に、
156 「複数行に渡るタグ入力」、「空要素タグ(imgなど)の補完」、
157 「一行内での開始/終了タグの入力」、「空要素空属性タグの入力」、
158 「文字参照入力」
159 に
160 対応しています。具体的には
161
162 @table @kbd
163 @item [prefix] b (野鳥のbegin補完に対応)
164 @dots{}
165 @example
166 <ul>
167 </ul>
168 @end example
169
170 @noindent
171 のように開始タグと終了タグを二行に渡って書きたい場合の補完を指します。
172 おもにブロック型タグが補完候補に含まれます。
173
174 @item [prefix] s (野鳥のsection型補完に対応)
175 @dots{}
176 @example
177 <img src="foo.gif" alt="photo">
178 @end example
179
180 @noindent
181 のように終了タグを持たず、かつ属性値のみで機能を指定するタグを補完します。
182 補完候補としては、img, input が存在します。
183
184 @item [prefix] l (野鳥のlarge型補完に対応)
185 @dots{} begin型補完とほぼ同じですが、
186
187 @example
188 <big> 〜 </big>
189 @end example
190
191 @noindent
192 のように一行内に開始/終了タグを入れたいときに利用します。
193
194 @item [prefix] m (野鳥のmaketitle型補完に対応)
195 @dots{} 要素も属性値も持たないタグを補完入力します。<br>
196 などが補完候補に相当します。
197
198 @item [prefix] a (野鳥のアクセント補完に対応)
199 @dots{} エンティティ参照による文字表記を入力するときに用います。
200 デフォルトでは < (&lt;), > (&gt;), & (&amp;), " (&quot;), ' (&apos;),
201 ブランク (&nbsp;) の補完入力が行えます。
202 @end table
203
204 @node Jump, Changing and Deleting, Completion, Top
205 @comment node-name, next, previous, up
206 @chapter カーソルジャンプ
207 文書中のいろいろな場所で
208
209 @table @kbd
210 @item [prefix] g
211 @dots{} 対応するオブジェクトにジャンプ
212 @end table
213
214 @noindent
215 を押すことにより、カーソル位置のHTML構文に対応する場所にジャンプ
216 します。対応関係が存在すると解釈されるコマンドには以下のものがあります。
217
218 @itemize @bullet
219 @item @code{<TAG>} ←→ @code{</TAG>}
220 @item @code{<img src="画像ファイル">} → 対応するviewer起動
221 @item @code{<a href="リンク先">} → リンク先へのポイント移動
222 @item @code{<applet code="プログラム">} → Javaソースプログラムへの移動
223 @c @item @code{\include(\input)} → 対応するファイル
224 @end itemize
225
226 @node Changing and Deleting, CSS Support, Jump, Top
227 @comment node-name, next, previous, up
228 @chapter 変更/削除
229
230 @menu
231 * 対タグの変更::
232 * 文字参照への変更::
233 * リジョン内文字のURLencode::
234 @end menu
235
236 @node 対タグの変更, 文字参照への変更, Changing and Deleting, Changing and Deleting
237 @comment node-name, next, previous, up
238 @section 対タグの変更
239 文書中のいろいろな場所で
240
241 @table @kbd
242 @item [prefix] c
243 @dots{} 対応するタグ等を変更
244 @end table
245
246 @noindent
247 を押すことにより、カーソル位置のHTML構文に応じた
248 記述内容の変更を行います。カーソル位置と変更する内容の
249 対応は以下の通りです。
250
251 @itemize @bullet
252 @item @code{<TAG>}〜@code{</TAG>}
253 @dots{} @code{TAG} の変更
254 @item @code{<img src="画像ファイル" alt="photo">} などの属性値
255 @dots{} 属性値の変更
256 @end itemize
257
258 @node 文字参照への変更, リジョン内文字のURLencode, 対タグの変更, Changing and Deleting
259 @comment node-name, next, previous, up
260 @section 文字参照への変更
261 文字としての < や > を表現するときは、文字参照を用いて
262 &lt; や &gt; と表記する必要がありますが、
263 HTML以外のファイルからこれらの文字を含むテキストを張り込んだ場合
264 などに、これらの文字を一括して文字参照形式に変換できます。
265
266 @table @kbd
267 @item [prefix] ;
268 @dots{} 指定した領域の文字参照に置き換えるべき文字の置換
269 @item [prefix] :
270 @dots{} 指定した領域の文字参照を参照文字そのものに置換
271 ([prefix] ; の逆変換)
272 @end table
273
274
275 @node リジョン内文字のURLencode, , 文字参照への変更, Changing and Deleting
276 @comment node-name, next, previous, up
277 @section リジョン内文字のURLencode
278 @table
279 @item [prefix] #
280 @dots{} 指定した領域内に URLencode すべき文字があればそれらを
281 エンコード表記に置換。
282 @end table
283
284 @node CSS Support, Customizations, Changing and Deleting, Top
285 @comment node-name, next, previous, up
286 @chapter CSS(スタイルシート)サポート
287
288 @menu
289 * CSS-class completion::
290 * Reread CSS file::
291 @end menu
292
293 @node CSS-class completion, Reread CSS file, CSS Support, CSS Support
294 @comment node-name, next, previous, up
295 @section CSSクラス名補完
296 HTML屋はCSS(Cascading Style Sheets)のクラス名を補完入力することができます。
297 スタイル定義として
298
299 @display
300 h1.foo, h2.foo @{ background-color: 0xffffff; @}
301 h1.bar, h2.bar @{ font-size: 120%; @}
302 @end display
303
304 のようなものがあった場合に、h1またはh2タグを [prefix] b や [prefix] l で補
305 完入力した場合に、それらに有効な class 名である foo, bar を候補として補完
306 入力することが可能です。また
307
308 @display
309 .caution @{ font-size: 120%; background-color: 0xc00000;@}
310 @end display
311
312 のような全てのエレメントに働くclassが定義されていた場合は、全てのタグの補
313 完入力時にclass参照入力を求められます。これが煩わしい場合はエレメント名入
314 力確定のときにリターンキー(またはC-m)ではなく、C-jを押せばclass補完入力を
315 キャンセルできます。たとえば
316
317 @display
318 @kbd{[prefix] l} 行内タグ補完を起動
319 (または@kbd{[prefix] l SPC})
320 tt <tt></tt>をいれたいのでttと入力
321 @kbd{C-m}
322 @end display
323
324 とした場合は続いて class= と補完プロンプトが出ますが、
325
326 @display
327 @kbd{[prefix] l} 行内タグ補完を起動
328 (または@kbd{[prefix] l SPC})
329 tt <tt></tt>をいれたいのでttと入力
330 @kbd{C-j}
331 @end display
332
333 と最後を @kbd{C-j} で入力した場合は class 補完プロンプトは出ません。
334
335 @node Reread CSS file, , CSS-class completion, CSS Support
336 @comment node-name, next, previous, up
337 @section CSS定義ファイルの読み直し
338 htmlファイルを編集中にCSS定義ファイルを修正し、追加した
339 classを補完候補として直ちに読み込ませたい場合は、
340 @kbd{M-x yahtml-mode} として再起動を行ってください。
341
342 @node Customizations, Copying, CSS Support, Top
343 @comment node-name, next, previous, up
344 @chapter カスタマイズ
345 @cindex カスタマイズ[かすたまいす]
346 @cindex キーアサイン[きいあさいん]
347
348 yahtmlの動作を制御する変数について説明します。
349
350 @menu
351 * All customizable variables:: カスタマイズ変数一覧
352 * Hook variables:: hook変数
353 @end menu
354
355 @node All customizable variables, Hook variables, Customizations, Customizations
356 @comment node-name, next, previous, up
357 @section カスタマイズ変数一覧
358
359 @defvar yahtml-prefix
360 yahtml-mode 中のプリフィクスキー (@kbd{\C-c})
361 @end defvar
362
363 @defvar yahtml-image-viewer
364 imgで参照している画像ファイルを表示するときに起動するコマンド (xv)
365 @end defvar
366
367 @defvar yahtml-www-browser
368 @kbd{[prefix]g} で外部ページを表示するときに起動するブラウザ (netscape)
369 @end defvar
370
371 @defvar yahtml-kanji-code
372 デフォルトの漢字コード。1=sjis, 2=jis, 3=euc (2)
373 .htaccess ファイルに
374 @quotation
375 AddType "text/html; charset=xxx" .html
376 @end quotation
377 の記述があった場合はそれに従う
378 @end defvar
379
380 @defvar yahtml-fill-column
381 auto-fillするときのカラム数 (72)
382 @end defvar
383
384 @defvar yahtml-fill-prefix
385 yahtml-mode 固有のfill-prefix (@code{nil})
386 @end defvar
387
388 @defvar yahtml-path-url-alist
389 OSのファイルシステム上でのフルパス名と、その外部公開時のURLの対応表。
390 @end defvar
391
392 @defvar yahtml-directory-index
393 サーバアクセス時ファイル名を省略したときにデフォルトで開かれる
394 インデックスファイルの名前。多くの場合 index.html。(@code{"index.html"})
395 @end defvar
396
397 @defvar yahtml-lint-program
398 HTML構文チェックプログラム。(@code{"jweblint"})
399 @end defvar
400
401 @defvar yahtml-hate-too-deep-indentation
402 ネストした列挙系環境でのインデントが深すぎるときにtにする。(@code{nil})
403 @end defvar
404
405 @defvar yahtml-always-/p
406 @code{<p>} をいれたら必ず @code{</p>} したい人向け。@code{nil}
407 @end defvar
408
409 @defvar yahtml-p-prefered-env-regexp
410 自動的に @code{<p>} を入れて欲しい環境。@code{^\(body\|dl\)}
411 @end defvar
412
413 @defvar yahtml-template-file
414 新規HTMLファイル作成時に自動的に挿入して欲しいファイル名。
415 @file{"~/http/template.html"}
416 @end defvar
417
418 @defvar yahtml-prefer-upcases
419 タグに大文字を使いたい。@code{nil}
420 @end defvar
421
422 @defvar yahtml-prefer-upcase-attributes
423 属性指定子に大文字を使いたい。@code{nil}
424 @end defvar
425
426 @defvar yahtml-server-type
427 Apache系のサーバを利用している場合は 'apache をセットする。
428 ./.htaccess を参照するかどうかを決定する。@code{'apache}
429 @end defvar
430
431 @defvar yahtml-apache-access-file
432 @code{yahtml-server-type} が @code{'apache} のときに
433 アクセス制限ファイル名を指定。@file{".htaccess"}
434 @end defvar
435
436 @defvar yahtml-shell-command-option
437 シェルで別コマンドを起動するときのオプション。
438 @end defvar
439
440 @defvar yahtml-translate-hyphens-when-comment-region
441 領域コメントアウトをするときに既に存在するハイフンを @code{&#45;} に
442 変更するかどうか。(@code{t})
443 @end defvar
444
445 @defvar yahtml-entity-reference-chars-alist
446 エンティティ参照(Entity Reference)で記述すべき文字群を
447 @code{'(?文字 . "エンティティ表記")} という形式を列挙した
448 alistで並べる。デフォルトで @code{<}, @code{>}, @code{&}, @code{'},
449 @code{"} に対するalistが設定されているので、追加したい分だけを記述すれば良
450 い。cdr部 @code{"エンティティ表記"} は、先頭の @code{&} と 末尾の@code{;}
451 は含めずに書く。
452 @end defvar
453
454 @defvar yahtml-faithful-to-htmllint
455 構文チェッカとして htmllint を利用する場合ちょっとした余計な空白などに
456 対しても警告を示すので、これを回避するときにはこの変数を@code{t}に
457 する。
458 @end defvar
459
460
461 @node Hook variables, , All customizable variables, Customizations
462 @comment node-name, next, previous, up
463 @section hook変数
464
465
466 @node Copying, Concept Index, Customizations, Top
467 @comment node-name, next, previous, up
468 @chapter 取り扱い
469
470 本プログラムはフリーソフトウェアです。本プログラムを使用して生じたいかな
471 る結果に対しても作者は責任を負わないこととします。転載等に関しては制限いた
472 しません。常識的に扱ってください。また、使用している旨をメイルでお知らせい
473 ただくと、作者は喜んでサポートに励むことでしょう。
474
475 苦情、希望、バグ報告、感想等は歓迎いたします。
476 連絡は yuuji@@yatex.org まで(1999年7月現在)。
477 継続的に使用してくださる方はメイリングリスト「fj野鳥の会」に
478 是非加入してください。加入方法については本パッケージの @file{docs/yahtmlqa}
479 ファイルの「その他」の章を御覧ください。
480
481 仕様は、予告なく確実に(気分次第で)変更されます:-p。
482
483 @flushright
484 広瀬雄二
485 @end flushright
486
487
488 @node Concept Index, , Copying, Top
489 @comment node-name, next, previous, up
490 @unnumbered 索引
491 @printindex cp
492
493
494 @contents
495
496 @bye
497
498 @c Local Variables:
499 @c fill-column: 74
500 @c fill-prefix: nil
501 @c End:
502 
503 Tag table:
504 
505 End tag table