Book Image

MooTools 1.2 Beginner's Guide

Book Image

MooTools 1.2 Beginner's Guide

Overview of this book

MooTools is a simple-to-use JavaScript library, ideal for people with basic JavaScript skills who want to elevate their web applications to a superior level. If you're a newcomer to MooTools looking to build dynamic, rich, and user-interactive web site applications this beginner's guide with its easy-to-follow step-by-step instructions is all you need to rapidly get to grips with MooTools.
Table of Contents (14 chapters)
MooTools 1.2 Beginner's Guide
Credits
About the Authors
About the Reviewer
Preface

Preparing your plugin for the public


If you'd like to make your plugin available to the public for use in their own projects, there are a few tips and guidelines you can follow. In the following section, we will obey, as much as we can, MooTools standard documentation. Though there isn't an official standard method for documentation yet, we can use the official MooTools docs and coding styles in MooTools More plugin so that our documentation will be familiar to MooTools developers, making it easy for them to understand and learn how to implement our work.

Documenting your plugin with comments

At the top of ImageCaption.js, we should put some meta information about our plugin so that people studying its working can know a little bit more about it. In MooTools More plugin, here is the format of this comment block.

Script: Plugin file name
Brief description of the plugin
License:
Licensing type and copyright information
Authors:
FirstName-1 LastName-1 - Website URL FirstName-2 LastName-2 - Website...