Coding Standards

[TSUCHIYA Masatoshi <tsuchiya@xxxxxxxxxxxxxxxxxxxxxxx>]

中島さんによる Shimbun Basics の記述を見直していて気が付いたのですが，

  * Coding Standards of Emacs-w3m::     Emacs-w3m のコーディング規約
  * Coding Standards of Shimbun::       Shimbun バックエンドを書くときの約束事

というノードがあるといいのではないでしょうか．これまで，さまざまな議論
が行われてきましたが，その summary にあたるものがなくて，議論の結論が
散逸してしまっている状況です．開発者の利便のためにも，ここらへんで一旦
取りまとめが必要だろうと思います．

その基本とするため，これまでにどんな議論が行われて，どういった結論が出
ているのかという一覧表の作成を行おうと思います．

そこで，言い出しっぺの法則でちょっと調べてみました．

■ 本体に関する約束・提案
   [emacs-w3m:00026] cl, flim
     使って良い関数の範囲についての部分的な議論．私の理解では，『使っ
     て良いのは，Emacs20 / Emacs21 で定義されている関数と，CL で定義さ
     れている関数．ただし，run-time CL 関数は除く』ということになって
     いると思うのですが…．

   [emacs-w3m:01775] [Conclusion] coding-system of ChangeLog
     changelog で使って良い文字の範囲について．w3m-*.el で使って良い文
     字の範囲については，議論したことはありましたっけ?

   [emacs-w3m:02252] coding rules
     一般的な規約は守るようにしましょう．

   [emacs-w3m:03522] Re: Emacs 19 support
     Emacs19 など Mule のない Emacsen もサポートしましょう．

   [emacs-w3m:03527] Re: Emacs 19 support
     ただし，開発版は non-Mule Emacsen で動かなくなる場合もあり得ると
     いうこと，それから，non-Mule Emacsen で動かない機能を実装するこ
     とを妨げない．

   [emacs-w3m:04372] Re: info
     文書類の ChangeLog について．

■ shimbun に関する約束
   [emacs-w3m:00999] Constraint of shimbun header values
     へッダには TAB は入れてはいけません．

   [emacs-w3m:03621] <BASE> tag must be inserted in generated articles by shimbun
     text/html な記事を作成する場合は，必ず <base> タグを入れるように
     しましょう．

   [emacs-w3m:04679] Coding cookie for source files including CJK characters
     ファイル先頭に -*- coding:... -*- を入れるようにしましょう．

■ 安定版の扱い
   [emacs-w3m:00773] Re: stable branch
     安定版を管理するブランチの扱いについての議論．

   [emacs-w3m:02829] Re: Problems with HTML entities
     幹を変更した人は，それが必要な場合は安定版の枝にも反映してくださ
     いね，という提案．

きっと，見落としがかなりあるのではないかと思いますので，指摘をお願いし
ます．

-- 
土屋 雅稔 ( TSUCHIYA Masatoshi )