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. 

  <script id="mutanrootpath" type="text/javascript" src="http://localhost/mutan/core.js"></script>

 The core file is include from the HTML file with id attribute. 
 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"

  {
  }

 The empty object 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
  useDirConfig       flag of each directory config
  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
 ------------------------------------------------------------------
  navigationString   string of navigation string

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

G.Easy usage

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

  + mutan
     + docs
     |  - api.txt
     |  - api-jp.txt
     |  - license.txt
     |  - license-jp.txt
     |  - readme.txt
     |  - readme-jp.txt
     + mutan
     |  + lang
     |  |  + en
     |  |  |  - system.js
     |  |  + jp
     |  |     - system.js
     |  + lib
     |  |  + abstract
     |  |  |  - abstractAction.js
     |  |  |  - abstractFilter.js
     |  |  |  - abstractModel.js
     |  |  |  - abstractValidator.js
     |  |  + core
     |  |  |  - domUtils.js
     |  |  |  - httpRequestUtils.js
     |  |  |  - mController.js
     |  |  |  - mUtils.js
     |  |  + interface
     |  |  |  - interfaceLogger.js
     |  |  |  - interfaceRender.js
     |  |  |  - interfaceRequest.js
     |  |  - filter.js
     |  |  - language.js
     |  |  - logger.js
     |  |  - validator.js
     |  + render
     |  |  - domRender.js
     |  |  - dummyRender.js
     |  |  - easyTemplateRender.js
     |  |  - formRender.js
     |  |  - hashRender.js
     |  |  - htmlRender.js
     |  |  - queryRender.js
     |  + request
     |  |  - dummyRequest.js
     |  |  - formRequest.js
     |  |  - hashRequest.js
     |  |  - queryRequest.js
     |  - config.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.doAction(' {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


