Mutan - javascript MVC framework system

A.Introduction
B.Feature
C.Production environment
D.System requirements
E.Installation
F.Setting
G.Easy usage
H.Notes
I.FAQ
J.Extra information
K.Copyright & license


A.Introduction

 It has created it though it looked for because it was not found.

---- 8< ---- Tear off along dotted line ---- 8< ----

B.Feature

 1.It is sure to move if it is a browser to which javascript with XMLHttpRquest 
  is supported. 
 2.It comes to be ..setting.. revokable at and each. 
 3.A part unpleasant because it is open source is rewriting. 
 4.Pure javascript can be used anywhere in case of the server where external js 
  can be put. 
 5.Can you correspond to several languages because the language file function 
  is provided, too?
 6.It becomes easy to do a variety of substitutions surely maybe ･･･ ..good..
 7.Only because the corefile is read as it is, can HTML be used?

---- >8 ---- Tear off along dotted line ---- >8 ----

C.Production environment

 OS      win2k,winXP
 Browser Firefox1.5+FireBug+WebDeveloper
 Editor  Eclipse+JSEclipse

---- 8< ---- Tear off along dotted line ---- 8< ----

D.System requirements

 It operates on a browser that supports javaSctipt and XMLHttpRequest. 
 However, compatibility is bad with the library where the built-in 
 object is extended.

 confirming the operation environment is
 win2K + IE6,Firefox1.5
 winXP + IE7,Firefox1.5,Opera9,Netscape7,and Netscape8

---- >8 ---- Tear off along dotted line ---- >8 ----

E.Installation

 It uploads to the server that can be accessed from the outside. 
 The core file is include from the HTML file. 
 The installation is completed only by it.

---- 8< ---- Tear off along dotted line ---- 8< ----

F.Setting

 The file "config.js" is only put on the same directory as include HTML. 
 Minimum contents of "config.js"

  {
   this.rootPath = 'http://localhost/mutan/';
  }

 The directory path that there is a corefile of mutan in is only set. 
 Other set items

  item name          description
 ------------------------------------------------------------------
  actionPath         directory path of action object files
  configPath         directory path of config file with action
  filterPath         file path of filter object
  language           name of language
  languagePath       file path of language object
  languagesPath      directory path of language files
  loggerPath         file path of logger object
  modelPath          directory path of model object files
  onloadAction       action name of onload callback function
  renderPath         file path of render object
  requestPath        file path of request object
  sysLangPath        directory path of system language file
  useCustomConfig    flag of each action config
  useCustomLanguage  flag of each action language
  useDebug           flag of use debug mode
  useDirLanguage     flag of each directory language
  validatorPath      file path of validator object
 ------------------------------------------------------------------
  template           name of template(it is revokable in action)
  templatePath       directory path of template files


---- >8 ---- Tear off along dotted line ---- >8 ----

G.Easy usage

 1.Download, extract the package, and confirm the composition. 

  + mutan
     + docs
     |  - api.txt
     |  - license.txt
     |  - readme.txt
     + mutan
     |  + lang
     |  |  + en
     |  |  |  - system.js
     |  |  + jp
     |  |     - system.js
     |  + lib
     |  |  + abstract
     |  |  |  - abstractAction.js
     |  |  |  - abstractFilter.js
     |  |  |  - abstractModel.js
     |  |  |  - abstractValidator.js
     |  |  + interface
     |  |  |  - interfaceLogger.js
     |  |  |  - interfaceRender.js
     |  |  |  - interfaceRequest.js
     |  |  - domUtils.js
     |  |  - filter.js
     |  |  - httpRequestUtils.js
     |  |  - language.js
     |  |  - logger.js
     |  |  - mController.js
     |  |  - mUtils.js
     |  |  - validator.js
     |  + render
     |  |  - dummyRender.js
     |  |  - easyTemplateRender.js
     |  |  - htmlRender.js
     |  + request
     |  |  - formRequest.js
     |  - core.js
     + sample
        + actions
        |  - helloWorldAction.js
        |  - onloadAction.js
        + configs
        |  - helloWorldConfig.js
        |  - onloadConfig.js
        + models
        |  - helloWorldModel.js
        |  - onloadModel.js
        - config.js
        - index.html

 There is no problem if it is a composition of the above-mentioned. 

 2.Extract is completed then
  /mutan/mutan
  /mutan/sample
 directory is copy to document root

 3.Access to "/sample/index.html"

 4."click" button is clicked

 5.When "Hello World" and the display appear under the screen,
  it is test completion. 

   mController.procedureAction(' {ActionName} ');
  the action that specifies can be executed. 

   /sample/helloWorldAction.js
   /sample/helloWorldModel.js
  change variously when can understand from seeing.

 *When setting it besides the document root,
  it is necessary to rewrite path that exists in 
   /sample/config.js
   /sample/index.html

---- 8< ---- Tear off along dotted line ---- 8< ----

H.Notes

 1.The file that can be basically accessed from "Mutan" can see everyone.
 2.Thus, please do not fill in important data like the password.
 3.Only cookie use the local file in the javascript limitarion.
 4.The file on the server becomes it in "Mutan" only for reading.
 5.Describe the script read on the way as an unnamed object.
 6.Make the caracter-code UTF-8 when you use characters other than ascii.
 7.Please do not forget the person of off javascript.

---- >8 ---- Tear off along dotted line ---- >8 ----

I.FAQ

 Q1.Mumin's English is unskilled
 A1.It is a specification. 
  Please hear it on the translation site.

 Q2.Mumin's Japanese is unskilled too
 A2.It is a specification too
  It is easy for me to write the code from the document.

 Q3.Why do you call mutan?
 A3.It cries very much. 

 A4.Is this function mounted?
 Q4.Please create it because it is open source by yourself.
  However, it is possible to be likely to do by help it. 


---- 8< ---- Tear off along dotted line ---- 8< ----

J.Extra information

 More information is visit here

 project page in SourceForge (http://sourceforge.jp/projects/mutan/)
 Mutan's project site (http://mutan.sourceforge.jp/)
 Mumin's weblog (http://wishstar.info/blog/index.php?user_id=0&cat_id=43)

 but Mumin is not so good English...

---- >8 ---- Tear off along dotted line ---- >8 ----

K.Copyright & license

 License is Artistic License.
 Please look at "/mutan/docs/license.txt" about details. 

 Copyright (C) 2006 Mumin Cacao


---- 8< ---- Tear off along dotted line ---- 8< ----


A.はじめに
B.特徴
C.製作環境
D.動作環境
E.いんすとーる方法
F.設定方法
G.簡単な使い方
H.注意点
I.よくある質問
J.その他の情報
K.こぴーらいと＆らいせんす


A.はじめに

 いろいろと探してみたけど，さーばさいどと切り離せなかったり，中を見てみたら
 ただのらいぶらりだったり，常駐してあどれすが変わるのを監視してたりって
 これというのが見つからなかったので創ってみましたです☆ヾ（・ｘ・。【みかん

---- >8 ---- きりとり ---- >8 ----

B.特徴

 1.XMLHttpRquest付きのjavascriptをさぽーとしてるぶらうざなら動くはず
 2.でぃれくとりやあくしょん毎に設定を変更できるようになってますです
 3.おーぷんそーすなのでやな部分はこあでも書き換えおっけぃ
 4.pure javascriptってことで外部jsの置けるさ～ばならどこでも使えますです
 5.いちおう言語ふぁいる機能もあるから多言語に対応できるかも？
 6.たぶんきっといろいろと取替えがしやすくなってる・・・といいなぁ・・・
 7.HTMLはそのままにこあふぁいるを読み込むだけで使えるかも？

---- 8< ---- きりとり ---- 8< ----

C.製作環境

 OS       win2k,winXP
 ぶらうざ Firefox1.5 + FireBug + WebDeveloper
 えでぃた Eclipse + JSEclipse

 こんなかんじになってますです☆ヾ（・ｘ・。【みかん

---- >8 ---- きりとり ---- >8 ----

D.動作環境

 XMLHttpRequestをさぽーとしたjavascriptが動くぶらうざならたぶんきっとだいじょ～ぶ☆
 ただ組み込みおぶじぇくとに手を出すようならいぶらりとは相性が悪そうにう・・・
 いちおう
 win2K + IE6,Firefox1.5
 winXP + IE7,Firefox1.5,Opera9,Netscape7,Netscape8
 で動作確認は取れてますです☆

---- 8< ---- きりとり ---- 8< ----

E.いんすとーる方法

 さーばの外部からあくせすできる場所に置いてhtmlふぁいるから読み込むだけ☆

---- >8 ---- きりとり ---- >8 ----

F.設定方法

 読み込んだHTMLふぁいるとおんなじでぃれくとりに"config.js"というふぁいる置くだけ☆
 最低限の中身は

  {
   this.rootPath = 'http://localhost/mutan/';
  }

 みたいにむぅたんのこあが置いてあるでぃれくとりぱすを設定するだけでおっけぃ☆
 それ以外の設定項目は

  項目名             内容
 ------------------------------------------------------------------
  actionPath         使用するあくしょんおぶじぇくとのでぃれくとり
  configPath         あくしょん毎に使用するこんふぃぐのでぃれくとり
  filterPath         使用するふぃるたおぶじぇくとのぱす
  language           使用する言語
  languagePath       使用する言語おぶじぇくとのぱす
  languagesPath      使用する言語ふぁいるのでぃれくとり
  loggerPath         使用するろぐおぶじぇくとのぱす
  modelPath          使用するもでるおぶじぇくとのでぃれくとり
  onloadAction       ぺ～じが読み込みに起動するあくしょん名
  renderPath         使用するれんだーおぶじぇくとのぱす
  requestPath        使用するりくえすとおぶじぇくとのぱす
  sysLangPath        使用するしすてむ言語ふぁいるのでぃれくとり
  useCustomConfig    あくしょん毎に設定を変更する？
  useCustomLanguage  あくしょん毎に言語ふぁいるを使用する？
  useDebug           でばっぐもーどを使用する？
  useDirLanguage     でぃれくとり毎に言語ふぁいるを使用する？
  validatorPath      使用するばりでーたおぶじぇくとのぱす
 ------------------------------------------------------------------
  template           使用するてんぷれ～と（あくしょん内でも変更可）
  templatePath       てんぷれ～との入ってるでぃれくとり

 こんなかんじになってますです☆

---- 8< ---- きりとり ---- 8< ----

G.簡単な使い方

 1.まずはぱっけーじをだうんろーど＆解凍して以下の構成になっているかちぇっく☆

  + mutan
     + docs
     |  - api.txt
     |  - license.txt
     |  - readme.txt
     + mutan
     |  + lang
     |  |  + en
     |  |  |  - system.js
     |  |  + jp
     |  |     - system.js
     |  + lib
     |  |  + abstract
     |  |  |  - abstractAction.js
     |  |  |  - abstractFilter.js
     |  |  |  - abstractModel.js
     |  |  |  - abstractValidator.js
     |  |  + interface
     |  |  |  - interfaceLogger.js
     |  |  |  - interfaceRender.js
     |  |  |  - interfaceRequest.js
     |  |  - domUtils.js
     |  |  - filter.js
     |  |  - httpRequestUtils.js
     |  |  - language.js
     |  |  - logger.js
     |  |  - mController.js
     |  |  - mUtils.js
     |  |  - validator.js
     |  + render
     |  |  - dummyRender.js
     |  |  - easyTemplateRender.js
     |  |  - htmlRender.js
     |  + request
     |  |  - formRequest.js
     |  - core.js
     + sample
        + actions
        |  - helloWorldAction.js
        |  - onloadAction.js
        + configs
        |  - helloWorldConfig.js
        |  - onloadConfig.js
        + models
        |  - helloWorldModel.js
        |  - onloadModel.js
        - config.js
        - index.html
 なかんじになってたらおっけぃ☆

 2.ぶじに解凍できてたら
  /mutan/mutan
  /mutan/sample
  って２つのでぃれくとりをどきゅめんとるーとにせっと☆

 3."/sample/index.html"にれっつあくせす☆ヾ（・ｘ・。【みかん

 4."click"ってぼたんをくりっく☆

 5.ちょっと下に"Hello World"って表示が出たらてすと完了☆
   mController.procedureAction('あくしょん名');
  で指定したあくしょんを起動できるので，
   /sample/helloWorldAction.js
   /sample/helloWorldModel.js
  を見てなんとなくわかりそうなひとはいろいろ変更してみてくださいなです☆

 *どきゅめんとるーと以外に置いたときは
  /sample/config.js
  /sample/index.html
 にあるぱすを書き換える必要がありますです☆

---- >8 ---- きりとり ---- >8 ----

H.注意点

 1.基本的にむぅたんからあくせすできるふぁいるはみんなが見れますです
 2.ということでぱすわーどみたいな大事なでーたは描かないでくださいです
 3.javascriptの制限上ろーかるのふぁいるはcookieぐらいしか触れませんです
 4.っていうかさーば上のふぁいるでもむぅたん単品では読み込み専用になりますです
 5.途中で読み込まれるすくりぷとは無名おぶじぇくととして記述してくださいです
 6.ascii以外の文字を使うときは文字こーどをUTF-8にしてくださいです
 7.javascriptおふなひとのことも忘れないでくださいです

---- 8< ---- きりとり ---- 8< ----

I.よくある質問

 Q1.変な英語
 A1.仕様で・・・っていうか翻訳さいとさんに聞いてくださいです（´ω｀；【みかん

 Q2.日本語も変
 A2.こっちも仕様・・・
  っていうかreadmeのほうがこ～どよりも大変なのです（つｘ；【みかん

 Q3.なんでこんな名称なの？
 A3.なんとなく

 Q4.こんな機能が欲しい
 A4.せっかくのお～ぷんそ～すなんだから自由に創ってくださいなです☆
  内容によってはお手伝いぐらいならできるかもしれないけど・・・

---- >8 ---- きりとり ---- >8 ----

J.その他の情報

 たぶんきっとここよりも
  SourceForgeのぷろじぇくとぺーじ(http://sourceforge.jp/projects/mutan/)
  むぅたんぷろじぇくとぺーじ(http://mutan.sourceforge.jp/)
  むうみんのぶろぐ(http://wishstar.info/blog/index.php?user_id=0&cat_id=43)
 あたりを探すとなにか見つかるかもしれませんです☆

---- 8< ---- きりとり ---- 8< ----

K.こぴーらいと＆らいせんす

 らいせんすはArtistic Licenseっておーぷんそーすのらいせんすになりますです☆
 詳しくは"/mutan/docs/license.txt"を見てくださいなです☆

 Copyright (C) 2006 Mumin Cacao

