https://github.com/ksafranski/codiad-plugin-template

A Simple Template for Creating Codiad IDE Plugins
https://github.com/ksafranski/codiad-plugin-template

Last synced: about 1 month ago
JSON representation

A Simple Template for Creating Codiad IDE Plugins

• Host: GitHub
• URL: https://github.com/ksafranski/codiad-plugin-template
• Owner: ksafranski
• Created: 2013-04-26T21:31:09.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-04-28T17:38:39.000Z (over 11 years ago)
• Last Synced: 2024-04-15T09:19:34.995Z (8 months ago)
• Language: JavaScript
• Size: 121 KB
• Stars: 4
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Codiad Plugin Template

This is a base for building plugins for Codiad IDE. There are 3 main components:

* `init.js` which initializes your plugin into the system

* `plugin.json` which is what Codiad uses to identify your plugin

* `README.md` which should contain information for the end-user

You can add CSS files, images, other libraries, etc. as needed for the plugin to operate successfully.

Since you have access to the `global.codiad` object you can also utilize other components in the system to modify the 

editor, work with projects, run searches, etc.

For a style guide and icon listing view the `/style_guide.php` file in the root of your Codiad install instance.

## Explanation of `plugin.json`

The `plugin.json` file describes how the plugin will interact with Codiad. Most of the properties are self explanatory.

```

[{

    "author": "Your Name",

    "version": "Your Version",

    "name": "Your Plugin Name",

    "rightbar": [

        {

            "action": "codiad.MY_PLUGIN.SOME_METHOD();",

            "icon": "icon-NAME",

            "title": "This will be displayed in the rightbar"

        }

    ],

    "contextmenu": [

        {

            "action": "codiad.MY_PLUGIN.SOME_METHOD();",

            "icon": "icon-NAME",

            "applies-to": "both",

            "title": "This will be displayed in the contextmenu"

        }

    ]

}]

```

`author`, `version` and `name` are the core info, describing the plugin.

`rightbar` is used if you want the plugin to appear in the right-hand bar. The `action` parameter should 

call a method in the init.js file.

`contextmenu` is similar format to `rightbar` but gives the ability to add context menu items to the file manager. 

The `applies-to` property specifies whether the menu entry will appear for `directory`(s) `file`(s) or `both`.