插件配置文件

原文链接:
http://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_configuration_file.html

这是一个示例插件配置文件,它展示和描述了可在plugin.xml文件中使用的所有元素。

<!-- url=""指定插件主页的链接(显示在欢迎界面和"插件"设置对话框)-->
<idea-plugin url="http://www.jetbrains.com/idea">

  <!-- 插件名称 -->
  <name>VssIntegration</name>

  <!-- 插件的唯一标识符,不能在不同插件版本之间更改
       如果未指定则与<name>相同 -->
  <id>VssIntegration</id>

  <!-- 插件的描述 -->
  <description>Vss integration plugin</description>

  <!-- 插件最新版本的更改描述
      显示在"插件"设置对话框和插件库Web界面 -->
  <change-notes>Initial release of the plugin.</change-notes>

  <!-- 插件版本 -->
  <version>1.0</version>

  <!-- 插件的厂商
       可选的"url"属性指定厂商的主页链接;
       可选的"email"属性指定厂商的电子邮件地址;
       可选的"logo"属性指定显示在欢迎界面插件名称旁边
       的大小为16x16的图标在插件JAR中的地址 -->
  <vendor url="http://www.jetbrains.com" email="support@jetbrains.com" logo="icons/plugin.png">Foo Inc.</vendor>

  <!-- 此插件所依赖的插件唯一标识符 -->
  <depends>MyFirstPlugin</depends>

  <!-- 可选的插件依赖
       如果安装了ID为"MySecondPlugin"的插件,
       文件mysecondplugin.xml(格式与plugin.xml文件相同)将会被加载 -->
  <depends optional="true" config-file="mysecondplugin.xml">MySecondPlugin</depends>

  <!-- 允许插件与系统帮助系统集成(JavaHelp格式)
       "file"属性指定插件目录下"help"子目录的JAR文件名
       "path"属性指定JAR文件内的helpset文件名 -->
  <helpset file="myhelp.jar" path="/Help.hs" />

  <!-- 插件与IDEA兼容的最小和最大版本 -->
  <idea-version since-build="3000" until-build="3999"/>

  <!-- 包含插件描述、操作名称等文本资源将会被加载 -->
  <resource-bundle>messages.MyPluginBundle</resource-bundle>

  <!-- 插件应用级组件 -->
  <application-components>
    <component>
      <!-- 组件接口类 -->
      <interface-class>com.foo.Component1Interface</interface-class>

      <!-- 组件实现类 -->
      <implementation-class>com.foo.impl.Component1Impl</implementation-class>
    </component>
  </application-components>

  <!-- 插件项目级组件 -->
  <project-components>
    <component>
      <!-- 接口和实现类相同 -->
      <interface-class>com.foo.Component2</interface-class>

      <!-- 如果"workspace"选项设置为"true",组件会将其状态保存到.iws文件而不是.ipr文件
          注意<option>元素尽在组件实现了JDOMExternalizable接口时有效 -->
      <option name="workspace" value="true" />

      <!-- 如果存在"loadForDefaultProject"标签,项目级组件还会为默认项目实例化 -->
      <loadForDefaultProject>
    </component>
  </project-components>

  <!-- 插件模块级组件 -->
  <module-components>
    <component>
      <interface-class>com.foo.Component3</interface-class>
    </component>
  </module-components>

  <!-- 操作 -->
  <actions>
    <action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Collect _Garbage" description="Run garbage collector">
      <keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/>
    </action>
  </actions>

  <!-- 插件定义的扩展点
        扩展点由插件注册,以便其他插件可以为此插件提供某些数据
        “beanClass”属性指定可以用于扩展点的实现类 -->
  <extensionPoints>
    <extensionPoint name="testExtensionPoint" beanClass="com.foo.impl.MyExtensionBean"/>
  </extensionPoints>

  <!-- 插件为IDEA核心或其它插件定义的扩展点添加的扩展
       "defaultExtensionNs "属性必须设置为定义扩展点插件的ID,
       如果扩展点时IDEA核心定义的,则设置为"com.intellij" ;
       <extensions>标签内的标签名称必须与扩展点的名称匹配,
       "implementation"属性指定添加到扩展点的类名 -->
  <extensions xmlns="VssIntegration">
    <testExtensionPoint implementation="com.foo.impl.MyExtensionImpl"/>
  </extensions>
</idea-plugin>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容