Skip to content

Latest commit

 

History

History
66 lines (61 loc) · 1.98 KB

plugins.textile

File metadata and controls

66 lines (61 loc) · 1.98 KB

Sample Format

{
        "name": "PhpParser",
	"title": "PHP Parser",
	"description": "Php Parser for web developers",
	"version": "1.0.0",
	"parentMenu": "menuPhp",
	"menuName": "Php Parser",
	"actions": [
		{
		"name": "parsePhp",
		"title": "Parse Php",
		"parentMenu": "menuPhp",
		"shortcutKeys": "",
		"type": "php",
		"functionName" : "parser.interface.parsePhp",
		"icons": {}
		},
		{
		"name": "parsePhpProject",
		"title": "Parse Project",
		"parentMenu": "menuPhp",
		"shortcutKeys": "",
		"type": "php",
		"functionName" : "parser.interface.parsePhpProject",
		"icons": {}
		}
	]
    ,
    "files" : {
        "php" : ["interface"]
    }
    ,
     "icons": {
	"128": "jsonlint-logo.png"
	},
	"license": "Apache"
 }

Explaining above terms

  • name : Plugin name
  • title : Plugin title
  • description : Plugin description must be brief
  • version: Plugin version
  • parentMenu: Should be “menuPhp” if plugin is in php
  • menuName: Plugin menu name which comes flavours menu.
    It will add action if we have single action inside actions else it will add menu with all action under that menu.
    • actions:
      • name: functionname in php file which be called on this action
      • title: Internal title
      • parentMenu: menuPhp is default and should be mention in file.
      • shortcutKeys: Shortcut keys for this action
      • type: php if lang is php
      • functionName : Its function path. Its similar to python import like. Example “parser.interface.parsePhpProject” where parser is directory inside plugins and interface is php file which contains parserPhpProject function. It under progress work.
      • icons: Icon appear in menu
      • We can add more actions in similar way
    • files: Normally we don’t need to add anything here. We deprecate this.
      • php: It start with php if plugins is in php and contains just filename in json array format.
  • icons: It contains icons
    • size: filename ( Full path of file relative to resources path)
  • license: Opensource licenses like Apache, MIT, BSD etc