Versions Compared

Key

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

...

  • First, install Maven:
    • For most Linux distributions, you should be able to just install the Maven client available in your distribution's repositories.
    • For all other operating systems, you can install the latest version from the Apache Maven site.
  • Configure Netbeans to use your external Maven:
    • Go to the "Tools" menu, and select "Options" (on OS/X, this is "NetBeans" -> "Preferences")
    • Select the "Miscellaneous" section.
    • Select the "Maven" tab.
    • Directly under the "External Maven Home" field, you'll see a line that says "Using Default Maven Version:___". It's possible that Netbeans will already see your external version of Maven (if it's in your PATH). However, if it says that it is using the "bundled maven", then you'll want to fill out the "_External Maven Home" field with the location of your external installation of Maven.
    • In the middle of this page, you may also need to fill out the location of your "Local Repository". This should be the location of the ".m2" directory under your user's home directory.
      • On Linux and OS/X, it should be located at ~/.m2/
      • On Windows, it should be located at C:\Documents and Settings\username\.m2 (Windows XP) or C:\Users\username\.m2 (Windows 7)
    • All the other Maven settings should be fine as their defaults. Press "OK" to save your changes.

...

  1. The easiest way to install DSpace may be to just follow the normal installation procedure in the DSpace System Documentation. NetBeans doesn't seem to have an efficient way to perform this installation, so it's easiest to just do it from the command line, as normal.
  2. Alternatively, you can use NetBeans to run the ant fresh_install command as follows: (You need to create a database and a database owner first.)
    • Go to your start browser, open pgAdmin (Assuming you install PostGreSQL
    • Connect to PostGreSQL 9.0
    • Right click login roles, select new login role
    • Type dspace for the following fields: Role name/ password/ password again
    • Click Ok
    • Right click database, select new database
    • Type dspace in the following field: Name. Select dspace from dspace owner field
    • Click Ok
    • Return to project folder in Netbeans
    • Click over to the "Files" tab in the left hand window
    • Click over to the "Files" tab in the left hand window
    • Wiki Markup
      Browse under the "DSpace Assembly and Configuration" project.  You are looking for the {{target/dspace-\[version\]-build.dir/build.xml}} Ant configuration file.
    • Right click on the build.xml file and select "Run Target" => "fresh_install"
    • Wiki Markup
      The
      Browse 
      above
      under 
      command will perform a fresh install of DSpace based on the settings specified in your
      the "DSpace Assembly and Configuration" project.  You are looking for the {{target/dspace-\[version\]-build.dir/
      config/dspace
      build.
      cfg
      xml}} Ant configuration file.
    • Right click on the build.xml file and select "Run Target" => "fresh_install"
      • Wiki Markup
      Finally,
      • The 
      return
      • above 
      to
      • command 
      the
      • will 
      normal
      • perform 
      installation
      • a 
      procedure
      • fresh 
      in
      • install 
      the
      • of 
      [
      • DSpace 
      System Documentation|DSDOC:Installation] for
      • based on the 
      commands
      • settings 
      to setup an initial DSpace Administrator, etc. from your newly created
      • specified in your {{target/dspace-\[version\]-build.dir/config/dspace.cfg}} file.
    • Wiki Markup
      Finally, return to the normal installation procedure in the [DSpace System Documentation|DSDOC:Installation] for the commands to setup an initial DSpace Administrator, etc. from your newly created {{\[dspace\]}} dspace\]}} installation directory.

Run DSpace from NetBeans with Tomcat

...

Integrate DSpace Javadoc within Netbeans

...

This section provides instructions for generating the DSpace javadoc and its integration within Netbeans. Its aim is to allow developers to refer to the current DSpace Library API calls, and understanding its uses from within the IDE. 

  • Open pom.xml in DSpace Assembly and Configuration

...

  • Copy the following code within the plugins tags

           <plugin>
                  <plugin>
<groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-javadoc-plugin</artifactId>
                  <version>2.8</version>
                  <configuration>
                  </configuration>
<            </plugin>3.

  • After copying, the entire section should look a little something like this.

<plugins>
<!-           <plugins>
                 <!- overall project assembly - ->
<plugin>
                 <plugin>
                            <artifactId>maven-assembly-plugin</artifactId>
<version>2                            <version>2.2-beta-1</version>
<configuration>
<descriptors>
version>
                           <configuration>
                           <descriptors>
                              <descriptor>src/assemble/assembly.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>directory-single</goal>
</goals>
</execution>
</executions>                            </descriptors>
                           </configuration>
                           <executions>
                           <execution>
                           <phase>package</phase>
                           <goals>
                           <goal>directory-single</goal>
                           </goals>
                           </execution>
                           </executions>
                 </plugin>

                 <plugin>
                           <groupId>org
</plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2                            <artifactId>maven-javadoc-plugin</artifactId>
                           <version>2.8</version>
<configuration>
</configuration>
</plugin>

</plugins>

...

                           <configuration>
                           </configuration>
                 </plugin>

           </plugins>

  • Right click on DSpace Assembly and Configuration and select Generate Javadoc

...

  • After build is successful, select dependencies folder within DSpace Assembly and Configuration and select download Javadoc

...

  • Javadoc for DSPace should be available within Netbeans.