きすちょこマニュアル

きすちょこ特長

(FKISS機能は未実装です。)

更新履歴
1999/10/01 - manual.txt作成。
1999/10/05 - manual.html作成。
1999/10/07 - KISS/GS非互換な事を推奨する内容を修正。あと、用語解説を追加。
2000/ 5/01 - バージョンβ0.02に対応して大幅に改定&「準備」を追加
2001/ 3/30 - バージョンβ0.03に対応して改定

もくじ

準備

データを公開する前にKISSファイル一式をLHAでまとめて圧縮しておくことをおすすめします。
LHAにまとめておいたほうがロード時間を大幅に短縮できます。

LHAファイルを作ったら アプレットとしてHTMLに埋め込む方法を参考にしてhtmlファイルを作ってみて下さい。

うまくいかないときはJavaアプリケーションとして単独で起動する方法で単独できすちょこを起動してhtmlが悪いのかデータが悪いのか確認できます。

LHAにKISSデータをまとめるときの注意事項

もくじへもどる

アプレットとしてHTMLに埋め込む方法

●簡単な例

KISSデータはあらかじめ準備を参考にLHA形式で圧縮してまとめておいてください。

以下ダブルクォーテーション「"」で囲まれた値はすべて大文字小文字を厳密に一致させるようにしてください。

例)

"sample.html"にあるAPPLETタグの例です。

        :
    <APPLET CODE="KissChoco.class" WIDTH=400 HEIGHT=402 CODEBASE="." ARCHIVE="choco.zip" >

      <PARAM NAME="CNF" VALUE="SAMPLE.CNF">
      <PARAM NAME="LZH" VALUE="SAMPLE.LZH">
      <PARAM NAME="BGCOLOR" VALUE="#40C0C0">

         (ここにはAPPLET非対応のブラウザやアプレットを
          OFFにしている人のためのコメントをかきます。)

    </APPLET>
        :

この場合のサーバー上のファイルの配置

    (KISSページを置きたいサーバのディレクトリ)
                        |
                        +--sample.html
                        +--choco.zip
                        |
                        +--SAMPLE.LZH

アプレットの大きさの指定をするWIDTH=400 HEIGHT=402のところはAPPLETタグのプロパティを参考に調整してください。

 

●プロパティとパラメータの詳しい説明

きすちょこの表示に必要なAPPLETタグのプロパティ
プロパティ名 説明
CODE アプレットのメインクラスファイルを指定します。
"KissChoco.class"と指定してください。
WITH アプレットの幅と高さを指定します。省略できません。
KISSコンフィグファイルで指定した大きさにあわせて調整します。
幅はコンフィグファイルの値そのままでも大丈夫ですが
高さは切替ボタンやプログレスバーの領域のために52ドットほど高くなります。
これらの値が小さいとスクロールバーが表示されるようになります。
これらの値が大きいときは回りがBGCOLORで塗りつぶされます。
HEIGHT
CODEBASE アプレットのクラスファイル
のありかを指し示すプロパティです。
クラスファイルをHTMLと同じィレクトリに置いた
場合でも"."を必ず指定した方がいいです。
(NN2.0では指定しないと駄目でした)
下記のARCHIVEプロパティを指定する場合もKISSファイルの
ありかの基準にもなるので指定する必要があります。
ARCHIVE アーカイブファイルを使ってクラスファイルを読み込ませるプロパティです。
"choco.zip"と指定してください。
バラのclassファイルを読みこませるのであれば省略可能ですが
遅いのでアーカイブを使いましょう。
zipアーカイブの読み込みに対応していない古いブラウザにも対応するには、
バラのclassファイルも一緒に置いておけば大丈夫です。
そう言ったブラウザはこのプロパティ自身が無視されてclassファイルを読みに行きます。

PARAMタグで指定するパラメーター
パラメーター名 説明 必須
DIR KISSファイル一式(またはLHAファイル)の置いてあるディレクトリを指定します。
CODEBASEを基準としたサブディレクトリを指定してください。
省略するとCODEBASEのディレクトリにKISSファイル一式(またはLHAファイル)があるものとみなします。
×
CNF KISSコンフィグファイルのファイル名を指定します。
LZHパラメーターが指定されている場合は省略可能です。

最低どちらか一方
LZH KISSファイル一式をまとめて圧縮したLHAファイルを指定します。
省略した場合CNFパラメーターで指定されたコンフィグファイルから生のKISSファイルが読み込まれます。
THREADS LZHパラメーターでLHAファイルを指定した場合は無視されます。
CELLファイルなどをいくつまで同時にロードするかを指定します。
省略時のデフォルトは3です。
×
BGCOLOR セルの表示領域の外側の背景色を指定します。
HTMLファイルの背景色等を16進数で指定するときと
同じ方法で指定してください。
(例) #40C0C0 - #[赤16進][緑16進][青16進]
省略時の色はライトグレー(#C0C0C0)です。
×
もくじへもどる

Javaアプリケーションとして単独で起動する方法

きすちょこは単独でJavaアプリケーションとして実行することもできます。

以下で示すような引数をあらかじめ組み込んだシェルスクリプトやバッチファイル を作っておくと便利です。
Windows環境でも基本的に大文字と小文字は区別して指定してください。

以下の説明の※印の意味。

※1: choco.zipのあるディレクトリ
※2: JDKをインストールしたディレクトリ

相対パス名でよい場合もありますが念のため絶対パスで指定する方が安全でしょう。

JDK1.0.2,JDK1.1.xの場合

    [Windows]

        java -classpath [※1]\choco.zip;[※2]\lib\classes.zip KissChoco
[Solarisなど] java -classpath [※1]/choco.zip:[※2]/lib/classes.zip KissChoco

JDK1.2.x以降(Java2)の場合

JDK1.2.x(Java2)からはシステムのライブラリは指定しなくてもよくなりました。

    [Windows]
java -classpath [※1]\choco.zip KissChoco
[Solarisなど]
java -classpath [※1]/choco.zip KissChoco

●IE4.0以降をインストールしてあるWindows

最近のIEはWindows版でもJava機能がオプション扱いになっている事もあるようです。
IEとは別にWindowsUpdateなどを使ってMicrosoftからJavaVMをダウンロードする必要があるかもしれません。
(IE上から"きすちょこのサンプル"sample.html"が表示できるようなら大丈夫です)

    jview /cp [※1]\choco.zip KissChoco

●その他

それぞれのJava実行環境でのJavaアプリケーションの起動方法を
調べてみてください。
ポイントは以下の3点です。

zip形式の実行ファイルに対応していない場合は、
choco.zipをディレクトリ付きで展開し、展開したディレクトリ(フォルダ)
をCLASSPATHに指定してください。

●起動オプション

それぞれのコマンドラインの最後には共通したオプションとして

の2つを追加できます。

スレッド数 ファイルを同時にいくつロードするか。
デフォルトは3
KISSコンフィグファイル名 起動と同時に このコンフィグファイルでロードを始めます。
LHAアーカイブ名 起動と同時に このアーカイブに含まれるKISSファイルデータでロードを始めます。
もくじへもどる

日本語文字コードについて

いまのところKISSのコンフィグファイルの日本語コードには
ShiftJISしかサポートしていません。
これはコメント等の部分を含みます。(っていうかコメント以外の部分では
日本語は使えないはずですが。)
他の文字コードの日本語処理系でコンフィグファイルを作成された方は、
一度ShiftJISに変換するか、日本語コード文字を使用したコメント等を
削除してください。

(言い訳)

これはきすちょこがJDK1.0に対応しているためです。

JDK1.0の段階ではJavaは日本語コードをサポートしていませんでした。
そこで、JDK1.0で起動されたときは、きすちょこではShiftJISの日本語コードとみなせる
部分は文法解析の前段階で"?"(クエスチョンマーク)に置き換えています。
こうしないといわゆる文字化けのような状態が起こって
文法エラーになってしまうのです。

ちなみに改行コードに関しては CR+LF, CRのみ LFのみ
いずれのパターンでも問題ありません。

もくじへもどる

大文字小文字の区別について

アプレットとしてWEBサーバーにアップロードして使う場合、
HTMLやKISSのコンフィグファイルのファイル名の大文字と小文字は
一致させてください。

特に、LHAファイルを使わないときは大文字と小文字を一致させないとCELLファイルやパレットファイルなどが見つからないため最悪すべてのCELLが表示されなくなったりします

LHAファイルでファイルをまとめてある場合も、HTMLファイルに指定してあるLHAファイル名と実際のファイル名が厳密に一致していないとまったく表示されなくなるので気をつけてください

特にWindows系は実際のファイル名と表示が一致しないので
注意してください。
(実際のファイル名はDOS窓でDIRコマンドを使うなどして確認してください)

そんなわけで、公開するまえにWEBサーバー上に一度アップロードして
確認することをおすすめします。


ファイル名が厳密に一致していない場合でかつファイルが読込み可能な場合、
コンソールやDOS窓に以下のような警告がでます。

(警告の例。英語が怪しいっすけど)

> --Warning!-- Specified filename is different in charactor case.
> specifiled='aaa.cel' true filename='AAA.CEL'
もくじへもどる

フルカラー(CKISS)機能について

きすちょこβ0.03からフルカラー(CKISS)に対応しました。

ただし、InternetExplorerおよびNetscape4.x以下等ではディザリングで擬似的に表示されます。
擬似でないフルカラーで表示するにはJava2環境が必要なようです。
JavaPluginを用いるかNetscape6.x以降で表示してもらうようにしてください。

コンフィグファイルに通常のセルファイルと同様にフルカラー(CKISS)仕様のセルファイルを指定してください。
コメントの印である';'の後ろに%t(数字)をつけて不透明なセルに透明度を指定することも出来ます。(通常のセルも半透明にできます)
0が不透明で指定無しと同じ表示になります。256で完全に透明になります。

(例)

#3  SAILOR1.CEL : 0 1   3 4 ;%t128
#3  SAILOR2.CEL : 0 1       ;%t128 "このようにコメント機能と組みあわせることもできます。"

もくじへもどる

コメント機能について

きすちょこバージョン0.03からコメント機能をサポートしました。

セルの上でマウスの右クリックか、コントロールキー+左クリックするとセルファイルの指定行のうしろのコメントが表示されます。
同じオブジェクトのセルのコメントはまとめて一度に表示されます。
コメントの頭にダブルクォーテーション'"'かスラッッシュ'/'で囲まれた部分があればその中身のみを表示します。

表示するコメントには下記のエスケープシーケンスが使用できます。
ただしタブで確保される文字のあきはあまり正確ではありません
\n(改行)
\t(タブ)
\"(ダブルクォーテーション)
\\(\そのもの)

日本語のコメントを表示させるためにはもちろん日本語対応のブラウザや実行環境が必要です。
非対応の環境では日本語がクエスチョンマーク'?'に化けてしまいます。

また、JDK1.0環境ではJava自体がまだ日本語表示をサポートしていなかった関係ですべての日本語は'?'に化けます。

もくじへもどる

ロード中のリアルタイム表示について

きすちょこはロードの途中経過がリアルタイムで見ることが出来ます。
しかし、それは見えてはいけないものも一瞬見えてしまう可能性も
あるってことです。(^_^;

そんな事態を避けるため
きすちょこでは以下の条件に一つでもあてはまる間はセルを一時的に
表示しないようにしてます。

一応これで理論上は“見えてはいけない”ものは見えないと思います。
でも、セルの分割の様子などはわかってしまいますし、あるいは
「TURNERのいいかげんなプログラムなんか信用ならない!」
というひともいると思います。

ロード中の表示モードとしていずれネタバレ防止モードをサポートするかもしれません。

もくじへもどる

KISS/GS準拠について

きすちょこで言うところのKISS/GS準拠とは、
KISS/GSに則ったデータを表示できるという意味で、
きすちょこで表示できたデータがKISS/GS規格に則っていることを
保証するものではありません。

いまのところ、エラーチェックが甘いのでなんの警告も表示されずに
厳密には正しくないコンフィグファイルが表示できたりしてしまいます。

いずれエラーチェックもきちんとしていきたいですが、
WKPのサイトにチェック用の専用ツールもありますので、そちらでチェックすることをお勧めします。

もくじへもどる

懸案事項

●以下にあげた一覧は将来的に解決、実装したいと思っている機能です。

もくじへもどる

■用語解説

JDK (JDK1.0.x, JDK1.1.x, JDK1.2.x, JDK1.3.x)

Java Development Kitの略で、SUNが無料で提供しているJava開発キットです。

現在、JDK1.0.x, から JDK1.3.x までの4つの大きなバージョンがあります。
特にJDK1.2.x以降では大幅に機能がアップしたのでJava2と呼んだりもします。
ネットスケープのバージョン6が1.3対応なのをのぞけば現在Java対応のブラウザはおおよそ1.1レベル対応のようです。

きすちょこは一応JDK1.0相当の環境から動くように作ってあります。
ただし、日本語のコメント表示にはJDK1.1以上が必要です。
Java2以上の環境でないとフルカラー(CKISS)機能がディザリングで擬似表示されるようです。(IE,NS4.x以下等)

IEやネスケ4.x用にJava2対応にさせるためのプラグインがSUNから提供されています。

本家SUNのJavaサイト-http://www.java.sun.com/
日本サンのJavaサイト-http://www.sun.co.jp/java/

KISS/GS

KISS General Specification : KISS一般仕様

KISSデータの基本的なファイルフォーマットを規定した規格です。

多くのKISSローダがこの規格に沿ったデータを読み込めるようになっています。
この仕様に則ったKISSデータを作れば
さまざまな環境上の多くのKISSローダで見てもらえるはずです。

WKP

World Kiss Project
KISSの総本山のようなサイト。
「世界制服計画」の名の下にKISSを世界に広めようと日夜活動しておられるようです。

KISSのデータやローダ、リンク等がとても充実しています。
資料や純粋に楽しみのためにいつも御世話になっています。

World Kiss Project-http://www.kiss-wkp.com/

もくじへもどる