Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 2.78 KB

Instructions.markdown

File metadata and controls

62 lines (38 loc) · 2.78 KB
Raw

Doc Template for Library Plugins

Overview

These template files will help you write documentation for library plugins.

If you wish to create a library plugin, you can code it in 2 ways:

  • Lua code. It's much easier to create a plugin that works cross-platform, but you are limited to what's available in the Lua API's. To create a new project, use the Project Template for Library Plugins (Lua).
  • Native code. You have to generate binaries for each platform, but you have complete access to the native API's of the underlying platform. To create a new project, use the 'App' template that's available in the CoronaEnterprise install.

Hosting

In order to distribute your plugin to the Corona Store, you must post documentation for your plugin online.

To simplify the hosting of your plugin documentation, we have designed these template files to be hosted as a public github repository.

As a starting point, we recommend you copy, clone or fork this repository.

Files

This template provides the stub markdown files:

  • Readme.markdown
    • This is the main library index page.
    • You should list all functions and properties here.
  • FUNCTION.markdown
    • This is a template for all library functions.
    • You should duplicate this file for each function in the library.
  • PROPERTY.markdown
    • This is a template for all library properties (e.g. version information)
    • You should duplicate this file for each property in the library.

NOTE: The files in ALL CAPS are stub files. The actual names of the files should match the case of the corresponding function/property names.

Markdown Guidelines

The template files are based on markdown.

Please consult Github Flavored Markdown for guidelines for more information.

Conventions

In the template files, there are various words that are written in all-caps. We recommend that you do a bulk find/replace before you start the actual documentation writing process. This will ensure your docs are consistent.

Some examples of bulk find/replace are shown below for a fictitious 'binaryjson' plugin developed by the fictitious 'MyCompany' developer:

  • PLUGIN_NAME => binaryjson
  • FUNCTION => encode()
  • PROPERTY => version
  • TYPE => [String](http://docs.coronalabs.com/api/type/String.html)
  • PUBLISHER_CONTACT => [email protected]
  • PUBLISHER_NAME => MyCompany
  • PUBLISHER_URL => http://mycompany.com/
  • FORUM_URL => http://mycompany.com/forums/binaryjson
  • REVERSE_PUBLISHER_URL => com.mycompany
  • SAMPLE_CODE_URL => http://github.com/mycompany/binaryjson-sample