mad template

Installation

Put the directory "mad" in the directory "templates" of the JsDoc Toolkit.

Run

Run the JsDoc Toolkit with the configuration file of the mad template.
"-t" option is not necessary.
More detailed specifications is see the Wiki of the JsDoc Toolkit on the Google Code.

examples

java -jar app/js.jar app/run.js -c=templates/mad/mad.conf -d=js_docs_out test/data

You can configure an item of the mad template in "templates/mad/mad.conf".
It is displayed like to this.

items

1. The title of your document
2. The description of your document
3. The version of your document
4. Your name
5. Your E-mail address or URL for contact
6. The copyright of your scripts
7. The license of your scripts
8. The URL of your source files, if you want to package it in your document.
9. The custom page,
   when you want to prepare for the page that is not generated by a generator.
   You prepare a template (sample: "templates/mad/page.tpl") to like it
   and can define CSS ("templates/mad/pages.css").

mad.conf

{
	//_: ["test"],
	//d: "JsDoc",
	a: true,
	r: 10,
	x: "js",
	t: "templates/mad",
	mad: {
1) -->		title    : "Mad Template Sample Document",
3) -->		version  : "1.01",
4) -->		author   : "inamorix",
5) -->		contact  : "mailto:inamorix@metatype.jp",
6) -->		copyright: "Copyright (c) 2007 metatype.",
7) -->		license  : "The MIT-style license.",
8) -->		download : "http://src.metatype.jp/madtemplate_1.01.zip",
2) -->		desc     : "The mad template for JsDoc Toolkit.",
9) -->		pages    : [
			{ name: "Custom Page1", tpl: "page.tpl" },
			{ name: "Custom Page2", tpl: "page.tpl" },
			{ name: "Custom Page3", tpl: "page.tpl" }
		]
	}
}

When you are not necessary, you can comment out any item.

Check out the latest version from Subversion repository of the Google Code.

• JsDoc Toolkit 1.3.1a

• The MIT-style license.