typo
[idea/community.git] / samples / plugin / readme.html
1 <html> 
2 <title>Readme</title>
3 <style type="text/css">
4 .S0 {
5         font-family: Verdana;
6         color: #000000;
7         font-size: 10pt;
8 }
9 .S1 {
10         color: #000080;
11 }
12 .S3 {
13         color: #008080;
14 }
15 .S6 {
16         color: #7F007F;
17 }
18 .S8 {
19         color: #800080;
20 }
21 .S9 {
22         color: #808000;
23 }
24 .S11 {
25         color: #000080;
26 }
27 span {
28         font-family: Verdana;
29         font-size: 10pt;
30 }
31 </style>
32 <body bgcolor="#FFFFFF">
33 <h1>Installation</h1>
34 <p>Every plugin should be placed to the IDEA_HOME\plugins folder. It may be in 
35   jar or just a folder.<br>
36 </p>
37 <p>Plugin is in jar:</p>
38 <pre>IDEA_HOME<br>      Plugins
39                 Sample.jar/
40                         com.intellij.....
41                                 ...
42                                 ...
43                         META-INF
44                                 plugin.xml
45 </pre>
46 <p><br>
47   Plugin is a folder: </p>
48 <pre>IDEA_HOME<br>      Plugins
49                 Sample
50                         lib
51                         classes                 
52                                 com.intellij.....
53                                 ...
54                                 ...
55                         META-INF
56                                 plugin.xml
57 </pre>
58 <p>Classes and lib folders are automatically added to the classpath.</p>
59 <h1>Plugin configuration (plugin.xml)</h1>
60 <p><span><span class="S1">&lt;idea-plugin&gt;</span><span class="S0"><br />
61   </span> <span class="S9">&lt;!-- plugin name --&gt;</span><span class="S0"><br />
62   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;name&gt;</span><span class="S0">Sample</span><span class="S1">&lt;/name&gt;</span><span class="S0"><br />
63   </span> <span class="S9">&lt;!-- description --&gt;</span><span class="S0"><br />
64   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;description&gt;</span><span class="S0">SamplePlugin</span><span class="S1">&lt;/description&gt;</span><span class="S0"><br />
65   </span> <span class="S9">&lt;!-- plugin versuin --&gt;</span><span class="S0"><br />
66   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;version&gt;</span><span class="S0">1.0</span><span class="S1">&lt;/version&gt;</span><span class="S0"><br />
67   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;vendor&gt;</span><span class="S0">IntelliJ</span><span class="S1">&lt;/vendor&gt;</span><span class="S0"><br />
68   </span> <span class="S9">&lt;!-- minimum and maximum IDEA version plugin is 
69   supposed to work with --&gt;</span><span class="S0"><br />
70   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;idea-version</span><span class="S8"> 
71   </span><span class="S3">min</span><span class="S8">=</span><span class="S6">"3.0"</span><span class="S8"> 
72   </span><span class="S3">max</span><span class="S8">=</span><span class="S6">"3.1"</span><span class="S11">/&gt;</span><span class="S0"><br />
73   </span> <span class="S9">&lt;!-- application components of the plugin --&gt;</span><span class="S0"><br />
74   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;application-components&gt;</span><span class="S0"><br />
75   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;component&gt;</span><span class="S0"><br />
76   </span> <span class="S9">&lt;!-- component implementation class --&gt;</span><span class="S0"><br />
77   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;implementation-class&gt;</span><span class="S0">com.intellij.openapi.samples.SampleApplicationPlugin</span><span class="S1">&lt;/implementation-class&gt;</span><span class="S0"><br />
78   </span> <span class="S9">&lt;!-- component interface class --&gt;</span><span class="S0"><br />
79   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;interface-class&gt;</span><span class="S0">com.intellij.openapi.samples.SampleApplicationPlugin</span><span class="S1">&lt;/interface-class&gt;</span><span class="S0"><br />
80   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;/component&gt;</span><span class="S0"><br />
81   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;/application-components&gt;</span><span class="S0"><br />
82   </span> <span class="S9">&lt;!-- project components of the plugin --&gt;</span><span class="S0"><br />
83   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;project-components&gt;</span><span class="S0"><br />
84   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;component&gt;</span><span class="S0"><br />
85   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;implementation-class&gt;</span><span class="S0">com.intellij.openapi.samples.SampleProjectPlugin</span><span class="S1">&lt;/implementation-class&gt;</span><span class="S0"><br />
86   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;interface-class&gt;</span><span class="S0">com.intellij.openapi.samples.SampleProjectPlugin</span><span class="S1">&lt;/interface-class&gt;</span><span class="S0"><br />
87   </span> <span class="S0">&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="S1">&lt;/component&gt;</span><span class="S0"><br />
88   </span> <span class="S0">&nbsp;&nbsp;</span><span class="S1">&lt;/project-components&gt;</span><span class="S0"><br />
89   </span> <span class="S1">&lt;/idea-plugin&gt;</span></span> </p>
90 </body>
91 </html>