Common Plugin Files¶
The following represents all the “well-known” files you will encounter during plugin development.
Links are povided to the pages where the file is discussed.
| plugin xyz | Links to definition/explaination |
|---|---|
| src/ | source_files |
| src/org/locationtech/udig/xyz | API Package |
| src/org/locationtech/udig/xyz/XYZPlugin.java | plugin resource and lifecycle management |
| src/org/locationtech/udig/xyz/XYZPlugin.properties | option 1 for internationlization |
| src/org/locationtech/udig/xyz/ISharedImages.java | Constants to retrive shared images |
| src/org/locationtech/udig/xyz/internal | Non API Package |
| src/org/locationtech/udig/xyz/internal/IHelpContextIds.java | constants used for context sensitve help |
| src/org/locationtech/udig/xyz/internal/IImageConstants.java | Constants used to retrive images |
| src/org/locationtech/udig/xyz/internal/Images.java | Manages images for plugin class |
| src/org/locationtech/udig/xyz/internal/Messages.java | option 2 for internationlization |
| src/org/locationtech/udig/xyz/internal/Messages.properties | text for internationlization |
| src/org/locationtech/udig/xyz/internal/Policy.java | option 3 for internationlization |
| src/org/locationtech/udig/xyz/examples | Non API Package |
| src/org/locationtech/udig/xyz/tests | Non API Package |
| bin/ - don’t add to svn/git | generated_class_files |
| doc/ - don’t add to svn/git | generated_schema_doc_files |
| doc/xyz_schema.xml | generated_schema_doc_files |
| html/ | online help |
| html/aHtmlDocument | an online help page |
| /icons/dlcl16/ | disabled local toolbar |
| /icons/dtool16/ | disabled toolbar |
| /icons/dview16/ | disabled view |
| /icons/elcl16/ | enabled local toolbar |
| /icons/etool16/ | enabled toolbar |
| /icons/eview16/ | enabled view |
| /icons/obj16/ | model object |
| /icons/ovr16/ | overlay |
| /icons/wizban/ | wizard banner |
| plugin.xml | plugin manifest file |
| plugin.properties | plugin manifest internationalization |
| build.xml | generated ant export script |
| build.properties | describes src, and export contents |
| .classpath | generated plug-in classpath information |
| .project | plug-in project file |
| toc.xml | table of contents for the top level book |
| tocSubject.xml | table of contents for subject |
| contexts.xml | Maps context ids to context-sensitve help |