Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version 3

changes.mady.by.user Ben Wolfe

Saved on

Key

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

<html><head><title></title></head><body>These are some rough notes. It would be great if someone could follow up and add some more substance or edit what is here as they are building their first module — e.g., some first-hand experience.

...

  1. Check out a local copy of the Basic Module from the repository: <tt>
    No Format
    http://svn.openmrs.org/openmrs-modules/basicmodule
    </tt> ## If given the option to set the project name, give it a module name using the same conventions.
  2. Disconnect the project from the database (you won't be checking your changes back in as the "BasicModule")
    1. Using Subclipse: right-click on the project name, select "Team->Disconnect..."
    2. "Confirm Disconnect from SVN" wizard appears
    3. select the "Also delete the SVN meta..." radio button
    4. click "Yes" button
  3. Replace all references to the Basic Module with your new modules name, using the same conventions. (For example, rename BasicModule to MyFirstModule).
    1. edit metadata/config.xml
      1. find the Code Block"<id>" tag, edit the value (example: change " Code Block<id>basicmodule</id>" to " Code Block <id>myfirst</id>")
      2. find the Code Block <name> tag, edit the value (example: change " Code Block<name>Basic Module</name>" to " Code Block<name>My First Module</name>")
      3. find the Code Block <author> tag, edit change the value (from Ben Wolfe to your name ... Ben shouldn't get all the credit (wink)
      4. find the Code Block <description> tag, edit the value if you want, you can change the Code Block <version> value, following the versioning conventions
      5. find the Code Block <activator> tag, change the activator name
    2. edit metadata/moduleApplicationContext.xml
      • This file is really only needed if you want either 1) your module to provide jsp files or 2) your module to have its own ___Service.java class
    3. edit metadata/sqldiff.xml
      • This file is not needed if you are not adding/modifying any tables or columns in the openmrs datamodel
      1. find the Code Block <author> tag and edit the value.
      2. find the Code Block <date> tag and edit the value.
    2. rename the project (if you didn't set it during checkout)
      1. right-click on "BasicModule" in the "Package Explorer"
      2. select "Refactor->Rename..."
      3. enter the new name (example: change to "MyFirstModule")
    3. rename the packages
      1. expand src
      2. right-click on org.openmrs.module.basicmodule "Refactor->Rename..."
      3. the "Rename Package" wizard appears
      4. edit the name (example: change to "org.openmrs.module.myfirst")
      5. select all of the check boxes (Put a * in the "File name patterns" text field)
      6. click "Preview"
      7. (wait patiently)
      8. click "OK" on the final screen of the wizard
    4. Repeat the previous set of steps for web/src and test/
    5. Be certain to rename all files that have BasicModule (or basicmodule) in their name (for example basicmoduleForm.jsp under web/module). Also look in the contents of the files (e.g. AdminList.java and build.xml)
  2. Change the contents of metadata/messages_*.properties
  3. We recommend (and use) Eclipse IDE, but as long as you have Apache ANT installed, you can use a text editor if you prefer.
  4. Build your module (.omod file) using ANT (e.g., run <tt>ant package-module</tt> at command line in the root of the module)
  5. Try out your module
    • Go to your openmrs installation Administration-->Manage Modules
  6. Choose Upload and browse to the "dist" folder in your checked out code. choose the latest.omod file
  7. Document your module
    • Modules should have a home page that describes their purpose, features, instructions, known issues, etc.
    • Feel free to create a wiki page for your module on this wiki. Your page should be called "FooBar Module" if you have created a module called FooBar.Make sure to place
    • No Format at the top of your module's wiki page, so your module documentation will be listed in the Module Documentation page.Create it as a child of the ?Active Projects page
  8. Publish the resulting .omod file
  9. Committing your code to the OpenMRS subversion repository
    1. See Developers Guide Code Repository#Requesting_Subversion_Repository_Access to get a new SVN project created for you.
    2. After a new SVN project has been created for you, the easiest way is to:
    • check out the new project that was created for you
    • then copy and paste your unattached code into that project
    • Then just commit that entire project Panel </body></html>