commit	d227b1b1fc065e2cea47f9747df0ba40838d7ec4	[log] [tgz]
author	Jesse MacFadyen <jesse.macfadyen@nitobi.com>	Mon Apr 09 14:44:56 2012 -0700
committer	Jesse MacFadyen <jesse.macfadyen@nitobi.com>	Mon Apr 09 14:44:56 2012 -0700
tree	6f64dd7e2bea5f2cf1cb8ab2de0f57d5e681d7a3
parent	29e2124db246a27305bc0e04244ef56974d76af2 [diff]
parent	fc11f45e5e86a74eb8a08ddf455d878836a101eb [diff]

tree: 6f64dd7e2bea5f2cf1cb8ab2de0f57d5e681d7a3

README.md

Cordova API Documentation

The JavaScript API documentation for Apache Cordova.

The documentation is available on PhoneGap API Documentation website.

Documentation Format

All of the Cordova documentation is written with markdown, a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document Cordova's core API and platform-specific APIs.

File Structure

docs/
docs/LANGUAGE
docs/LANGUAGE/VERSION
docs/LANGUAGE/VERSION/phonegap/
docs/LANGUAGE/VERSION/phonegap/PLUGIN/
docs/LANGUAGE/VERSION/phonegap/PLUGIN/className.md
docs/LANGUAGE/VERSION/phonegap/PLUGIN/className.functionName.md

Contributing to the Documentation

Report or Fix an Issue

We use Apache JIRA

By the way, you rock! Thanks for helping us improve the documentation!

Using Git

Are you new to Git or contributing on GitHub?

We have written a few Git tutorials to help you get started with contributing to the documentation.

Sending Pull Requests

Pull requests are welcome!

We appreciate the use of topic branches.

git checkout -b issue_23

# code

git commit -m "Issue 23: Fix a bad bug."

git push origin issue_23

# send pull request from branch issue_23 to cordova:master

Adding a Language

Do you want the Cordova documentation in another language? We do too!

1. Create the language directory

# Spanish
mkdir docs/es

2. Add a version

Start with the latest stable release. You can always add other versions later.

mkdir docs/es/1.0.0

3. Begin Translating

Currently, English is the most up-to-date and so it is easiest to copy each English file into the new language directory.

4. config.json

For each version, there is a config.json that defines the name of the language and how to merge the files.

5. Customizing HTML template

Each language can override the default template in template/docs/LANGUAGE.

Generating the Documentation

Currently, Cordova-Docs uses a Ruby script and joDoc to generate HTML documentation.

Install joDoc

Clone joDoc

  git clone http://github.com/davebalmer/joDoc.git

Add joDoc/ to your path
Open ~/.bashrc or ~/.profile (or whatever you use)
```
  export PATH=$PATH:~/path/to/joDoc/
```

Install markdown

  # Use your package manager
  brew install markdown
  port install markdown
  aptitude install markdown

Install nokogiri (Ruby HTML parser)
```
  gem install nokogiri
```
Install json (Ruby JSON parser)
```
  gem install json
```

Run the Script

./bin/generate

Script Test Suite

Install rspec:

gem install rspec --version 1.3.0

Run all specs:

rake

Run a specific spec:

spec spec/phonegap/add_title_spec.rb