Document Information

Last modified:
2011/02/22 12:31 (external edit)

This is documentation for qooxdoo 0.7.x only. You might be interested in consulting the latest docs.

Manifest.js

Manifest files provide meta information about the application. It is located in the top-level directory. The file describes the project and contains meta data about the specific version. The format of the file is plain JSON, which is still human-readable while it also allows for processing by the qooxdoo build system.

File Format

  • name (String, required)
    Name of the contribution. Identical to the top-level directory name.
  • summary (String, required)
    Short summary about the project.
  • description (String)
    Longer description about the project.
  • keywords (String[])
    List of keywords (tagging, categories), to be used for searches.
  • homepage (String)
    Contribution homepage.
  • authors (Map[], required)
    Array of maps with the following keys:
    • name (String, required)
      Name of the author
    • email (String)
      email address of the author. Please use AT and DOT instead of @ and . as an anti-spam measure.
  • license (String, required)
    License (e.g. LGPL/EPL, BSD, …)
  • version (String, required)
    version string of this particular release. Identical to the version directory name, e.g. 0.2 or trunk.
  • qooxdoo-versions (String[], required)
    List of qooxdoo versions that this contribution version is supposed to work with.
  • namespace (String)
    Top-level namespace of the contribution. Required if the contribution contains JavaScript classes.
  • resource-uri-setting (String)
    Name of the setting for the resource URI. By default the name of this setting is a concatination of the top-level namespace and .resourceUri (e.g. progressbar.resourceUri).

Example

{
  "name" : "SkeletonWidget",
 
  "summary" : "A Sample widget.",
  "description": "This widget can be used as a blue print for other contributions",
  "keywords" : ["widget", "skeleton"],
  "homepage" : "http://contrib.qooxdoo.org/project/SkeletonWidget",
 
  "authors" : [
    {
      "name" : "",
      "email" : ""
    }
  ],
 
  "license" : "LGPL/EPL",    
  "version" : "0.1",
  "qooxdoo-versions": ["0.7", "trunk"],
 
  "namespace" : "skeletonwidget",
  "resource-uri-setting" : "skeletonwidget.resourceUri"
}

Information

Last modified:
2011/02/22 12:31 (external edit)

Account

 
 
A book on qooxdoo RIAs, authored  by community members
JS Tutorial, JavaScript Tutorial, JavaScript Guide, Learn JavaScript JS, How To Learn JS, Learning JavaScript
 

Bad Behavior has blocked 0 potential spam attempts in the last 7 days.