Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Java Build Path
    • On the Libraries tab, remove the default JRE System Library and click Add Library. Choose JRE System Library and click Next. Select Execution environment, select the one beginning with J2SE-1.5 and click Finishensure that Workspace defualt JRE is jdk1.8.0.
  • Checkstyle
    • If your plug-in only contains generated code, disable Checkstyle.
    • Otherwise, activate Checkstyle.
      • In the Exclude from checking... list, select all file types except, click Change... and remove properties. Checkstyle usually gives wrong warnings for property files.
      • If there are packages containing generated code, select files from packages from the Exclude from checking... list and add the packages to it.

...

  • Tab Overview
    • ID: start with de.cau.cs.kieler as prefix, except for plugins that contain third-party code
    • Version: 0.1.0.qualifier, increase with each release according to changes in the plugin
    • Name: start with KIELER, e.g. KIELER Core UI
    • Provider: Christian-Albrechts-Universität zu Kiel Kiel University
    • Check Activate this plug-in when one of its classes is loaded and This plug-in is a singleton, except if you know what you're doing
    • Execution Environment: J2SEJavaSE-1.58.0
    • Activator: Set the name of your Activator class (this represents the entry point of you plug-in). By default it is named "Activator.java". Rename this class to <Name>Plugin.java (e.g. CorePlugin.java).
  • Tab Dependencies
    • For Eclipse plugins: set your current version with 0 as third digit for Minimum Version, e.g. org.eclipse.core.runtime (3.5.0)
    • For our own plugins: if you know that you really need a specific version of the plugin, do the same as for Eclipse plugins, else leave the minimum version empty
    • Don't reexport dependencies, except in one case: UI plug-ins may reexport their dependencies on plug-ins that are part of the same project. (de.cau.cs.kieler.kiml.ui could reexport a dependency on de.cau.cs.kieler.kiml)
    • Collect all KIELER internal dependencies on the bottom of the list to increase readability.
  • Tab Runtime
    • Add all Java packages that must be visible for other plugins, e.g. if they contain classes or interfaces that must be referenced elsewhere
  • Tab Extensions
    • Add extensions to other extension points as needed
  • Tab Build
    • Binary Build
      • Include epl-v10.html (copy into plugin from one of the other plugins)
      • Include META-INF folder, plugin.xml and plugin.properties if present
      • Do not include src or bin folder
      • Include all icons, models etc. that are in your plugin
    • Source Build
      • Include epl-v10.html (copy into plugin from one of the other plugins)
      • Do not include src or bin folder
      • Include files that you explicitly want to be present in the source project

...

  • New plugin
    • New plugins need a pom.xml in the plugin's root folder

      Code Block
      languagehtml/xml
      titleplugin pom.xml
      collapsetrue
       <?xml version="1.0" encoding="UTF-8"?>
      <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <modelVersion>4.0.0</modelVersion>
        <parent>
          <groupId>de.cau.cs.kieler</groupId>
          <artifactId>plugins</artifactId>
          <version>0.0.1-SNAPSHOT</version>
        </parent>
        <groupId>de.cau.cs.kieler</groupId>
        <artifactId>YOUR.NEW.PLUGIN.NAME</artifactId>
        <version>0.7.0-SNAPSHOT</version>
        <packaging>eclipse-plugin</packaging>
      </project>
      
      
    • Make sure that <version> is in sync with Bundle-Version in META-INF/MANIFEST.MF
    • Add a <module> entry in the corresponding parent POM i.e. plugins/pom.xml
    • If your plugin uses xtend, tell maven to run the xtend compiler in pom.xml

      Code Block
      languagehtml/xml
      collapsetrue
        <build>
          <sourceDirectory>src</sourceDirectory>
          <plugins>
            <plugin>
              <groupId>org.eclipse.xtend2</groupId>
              <artifactId>xtend-maven-plugin</artifactId>
              <executions>
                <execution>
                  <goals>
                    <goal>compile</goal>
                  </goals>
                </execution>
              </executions>
            </plugin>
          </plugins>
        </build>
      
      
  • New JUnit test plugin
    • Basically the same steps as for plugins except <packaging> is eclipse-test-plugin
  • New features
    • The same steps as for plugins except <packaging> is eclipse-feature
    • Additionally if sources are to be distributed a separate source - feature with the corresponding source-bundles must be created

...