From MupeWiki

Contents 1 Quick guide 1.1 Version History 1.2 Installing MUPE tools plug-in 1.3 Updating MUPE tools plug-in 1.4 Adding mupe project nature to a project 1.5 Creating a new project 1.6 Creating a new class 1.7 Using Mupe editor 1.8 Adding code snippets to a document 1.9 JDK extensions

Quick guide

Rough guide for using and installing MUPE tools. Report possible bugs, features and suggestions in the talk page

Version History

v 1.0.0 Initial release
v 1.0.1 Bugfix relese
v 1.0.2 Minor fixes
v 1.0.3 Release candidate 1
v 1.0.4 Internal Alpha
v 1.0.6 Internal Beta
v 1.0.7 Public Beta

Installing MUPE tools plug-in

MupeTools can be installed trough eclipses update manager.

1. Use at least Eclipse 3.2 or else some of the features are not available.
2. Choose Help -> Software updates -> Find and Install...
3. Choose "Search new features to install" and click Next
4. Click "New Remote Site..."
5. Fill following information to appearing dialoque
   • Name: MupeTools
   • URL: http://www.cs.tut.fi/~momupe/MupeTools
6. Select MupeTools update site from the list and click Finish.
7. Select MupeTools and click "Finish"
8. Accept the lisence agreement and click "Next"
9. Finally, click "Finish" to complete installation

Updating MUPE tools plug-in

1. Choose Help -> Software updates -> Find and Install...
2. Choose "Search updates.." and click Next
3. Select Mupe update site
4. If new updates are avaivable eclipse installs them after accepting lisence etc.

Adding mupe project nature to a project

Some tools may require to work that a project has mupe project nature. Nature is added automatically if the project is created with Project tool. If project has not Mupe-nature then it can be added by selecting the project from Package Explorer and then selecting Mupe -> Add/Remove mupe project nature.

• Easiest way to check if your project has mupe nature is to right click project name and select Properties. If you see text Mupe among other texts (Info, Builders, Java Build Path...) then nature has been added.

Creating a new project

1. Create a new Mupe project by selecting File > New > Project > MUPE > New Mupe project.
2. Give a name to your new Mupe project
3. Write a port number where the client can connect to your server.
4. Select which of the project templates you want to use.
5. Click Finish.

Features:

• Creates a new project using empty_project v2.30 as model.
• Supports multiple project templates, although only Empty project v2.30 is supplied.

Known bugs:

• Problems with macintosh. (check out the newest version and report the error message...)

Creating a new class

New Mupe class is created by selecting File > New > Project > MUPE > New Mupe Class.

Features:

• Creates new Mupe (java) class.
• Wizard validates (or at least tries) its input.
• If the base class has abstract methods, the wizard generates stubs for them.
• Generated classess are serializable by default.
• User can choose from few of the common (xml-common) XML files or write his/her own name.
• Multiple XML files can be removed at once by selecting them (with Ctrl-key and mouse) and pressing Remove-button.

Current limitations:

• Xml-files are empty, use Mupe-editor to write content.

Using Mupe editor

Open File in Mupe editor:

1. Right-click a (Mupe) XML-file in Package Explorer and choose Open With -> Mupe Editor

Features:

• Code completion
  • Editor suggests possible methods and parameters when user types:
    • !#this#!::
    • $(service.username)::
    • !#
    • !#/
    • number:: (0::)
    • className:: (World::)
• Semantic checking
  • checks that methods and classes and parameters that are called from (mupe) XML-file really exists.
  • Gives error from elements could not be located
  • Gives warning if elements could not be checked (for example 5::method_name)
• Provides possibility to jump related java or xml code
  • Place caret between !#/xml.xml#!, !#XMLmethod#! or !#clientMethod#!. From contextmenu select Mupe -> Jump to Related XML/Java and workbench opena a new editor to selected file.

Adding code snippets to a document

You can add different kind of code snippets to your documents by using Mupe tools.

1. Open document
2. Place cursor somewhere in document
3. Choose Mupe -> Add Code Snippet -> and then select snippet

JDK extensions

• When editing java-code that has a getDynamicXML()-call you can jump to related xml-file, by placing caret over the methdodcall and selecting from context-menu Mupe -> Jump to Related XML.