← Back to branch summary

~ubuntu-branches/ubuntu/trusty/netbeans/trusty

« back to all changes in this revision

Viewing changes to apisupport/project/javahelp/org/netbeans/modules/apisupport/project/docs/create_plugin/projectlevel_create/create_module.html

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
apisupport/project/javahelp/org/netbeans/modules/apisupport/project/docs/create_plugin/projectlevel_create/create_module.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<!--
 
3
 *        Copyright � 2006 Sun Microsystems, Inc. All rights reserved. 
 
4
 *        Use is subject to license terms.
 
5
> -->
 
6
<html>
 
7
<head>
 
8
 
 
9
    <title>Creating a Module Project</title>
 
10
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 
11
    <link rel="StyleSheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
 
12
</head>
 
13
 
 
14
<body>
 
15
    <h2>Creating a Module Project</h2>
 
16
    <p><small> 
 
17
        <a href="#seealso">See Also</a> 
 
18
    </small></p>
 
19
    Use a module project template to create a module project. The module
 
20
    project is the place where you code your module. Module projects implement the module's features 
 
21
    and functionality that extend the NetBeans APIs, which you kickstart 
 
22
    by using file templates. In addition, module projects include the 
 
23
    business logic that integrate the library wrapper module projects 
 
24
    into the module. Code housed in module projects also provides, 
 
25
    for example, the user interface for receiving and processing user input.
 
26
    <p><b>To create a module project:</b>
 
27
    <ol>
 
28
        <li>Choose File &gt; New Project 
 
29
        (Ctrl-Shift-N). </li>
 
30
        <li>From the NetBeans Modules category, select Module. Click Next.
 
31
        <li>In the Name and Location panel, specify the following:
 
32
        <ul>
 
33
            <li><b>Project Name. </b>Specifies the folder in which the project
 
34
            will be housed, prepended by the project location, which
 
35
            is specified in the next field.</li>
 
36
            <li><b>Project Location. </b>Specifies the location where you want to store the 
 
37
            project metadata and source code.</li>
 
38
            <li><b>Project Folder. </b>Specifies the folder where you want 
 
39
            to store the project metadata and source code. The folder is a concatenation
 
40
            of the project location and the project name.</li>
 
41
            <li><b>Standalone Module.</b> Specifies that the module does not belong to a module suite. In addition,
 
42
            you must specify which platform the module will be compiled and deployed against. To add additional
 
43
            platforms to the list, click Manage and use the <a href="../../csh/NbPlatformCustomizer.html">NetBeans Platform Manager</a>.
 
44
            <li><b>Add to Module Suite.</b> Specifies that the module belongs to a module suite. If the module
 
45
            suite is not currently open in the IDE, click Browse to locate the module suite in your
 
46
            filesystem.
 
47
            <li><b>Set as Main Project.</b> Sets the newly created project as the main
 
48
            project.</li>
 
49
        </ul>
 
50
        <li>Click Next.
 
51
        <li>In the Basic Module Configuration panel, specify the following:
 
52
        <ul>
 
53
            <li><b>Code Name Base. </b>Specifies a unique name for the module. A main
 
54
            package will be created with the same name as the code name base. If your
 
55
            code name base is <tt>org.modules.foo</tt>, your default package structure will be
 
56
            <tt>org/modules/foo</tt>.
 
57
            <li><b>Module Display Name. </b>Specifies the name that will be displayed
 
58
            in the Projects window.</li>
 
59
            <li><b>Localizing Bundle. </b>Specifies location of the <tt>Bundle.properties</tt>
 
60
            file. Normally, the default suggestion should be appropriate.</li>
 
61
            <li><b>XML Layer.</b> Specifies the location of the <a href="../../about/about-xml-layers.html">XML layer file</a>.
 
62
            Normally, the default suggestion should be appropriate.
 
63
        </ul>
 
64
        <li>Click Finish.
 
65
    </ol>
 
66
 
 
67
    <dl>
 
68
        <dt><a name="seealso">See Also</a></dt>
 
69
        <dd>  <a href="../../about/nbmodule-about.html">About NetBeans Platform and Module Development</a></dd>
 
70
        <dd><a href="../../about/about-netbeans-platform.html">About the NetBeans Platform</a></dd>
 
71
        <dd><a href="../../about/nbmodule-about-system-filesystem.html">About the System Filesystem</a></dd>
 
72
        <dd><a href="../../about/nbmodule-about.html">About NetBeans Platform and Module Development</a></dd>
 
73
        <dd><a href="../../about/about-xml-layers.html">About XML Layer Files</a></dd>
 
74
        <dd><a href="../../about/modules_process.html">Working with Modules</a></dd>
 
75
        <dd><a href="../../about/modules_quickref.html">Module Tasks: Quick Reference</a></dd>
 
76
    </dl> 
 
77
    <hr>
 
78
    <small><a href="../../credits.html">Legal Notices</a></small> 
 
79
    <table cellpadding="20" border="0"> 
 
80
        <tr><td>&nbsp;</td></tr> 
 
81
        <tr><td>&nbsp;</td></tr> 
 
82
        <tr><td>&nbsp;</td></tr> 
 
83
    </table> 
 
84
</body></html>