Documentation

First Steps

Analyze JavaScript coding

Make sure you have a folder which contains html files together with JavaScript code. You may for instance use git to replicate the source code of this application to a local folder.

Open this application in a browser

Choose in the menu File -> Extract Code from File System to SOMIX model (w/o .git). Choose the main folder of the application. All extracted components will be displayed in a circle.

Choose in the menu FIle -> Open Work Folder. Specify a folder where the generation information for all diagrams shall be stored. In case you analyze this application choose the folder models.

In case you use this application. Choose in the menu File -> Read Diagram. You will see a list of existing diagrams.

In case there are no diagram informations yet. Choose in the menu File -> New Diagram. Enter a name for the diagram. Choose Diagram -> Explore model to choose components to be displayed.

Demo

It is possible to display and use demo data. Follow these steps:

Open the application in a Browser

Choose in the menu Help -> Load demo data

Do a right mouse click into the pane and choose "Start Force-directed graph". Wait some time and choose then "Stop Force-directed graph".

Click on one of the red or blue circles with the right mouse button. Choose "Add element with all neighbors"

Do a right mouse click into the pane and choose Demo Diagram

Play around with left and right clicks of the mouse on elements, into boxes and onto the pane. Use also the scrool wheel of the mouse.

You may also choose Diagram -> Explore Model. Use this steps:

Open the application in a Browser

Choose in the menu Help -> Load demo data

Enter for instance ^Z.*LOG in the input field. This filters for all elements which start with Z and have a LOG somewhre in the name. You can use any Regex expression. The search is case insensitive.

The Button Apply Filter may not yet work, instead move the mouse down.

You can scroll with the mouse wheel in the result list.

Make a right click on an element and choose "Add element with all neighbors"

Choose cancel

Make a right click in the pane and choose Demo Diagram.

Play around with left and right clicks of the mouse on elements, into boxes and onto the pane. Use also the scrool wheel of the mouse.

Generate a SOMIX model from files in a local folder

It is possible to analyze folders in the local file system:

Extract a model where files are date and folders are groupings. Choose File -> Extract File System to SOMIX model (w/o .git). A pop up opens where you specify a local folder on your computer. Content in .git folders is ignored. This is in most cases helfull when git is used. Git stores many files which are normally not of interest.

Extract a model of the code in files. This is currently in development. Extract Code from File System to SOMIX model (w/o .git). A pop up opens where you specify a local folder on your computer. Content in .git folders is ignored. This is in most cases helfull when git is used. Git stores many files which are normally not of interest.

Use a SOMIX model

When you have a SOMIX model (You will need to use SAP2Moose for now):

Choose File -> Load Model and load a SOMIX model

Choose File -> Open Work Folder (Generation informations for files will be stored in this folder)

Choose File -> New Diagram and enter a name for the new diagram.

Make a right click into the pane and choose the name of your diagram. This will change the view and display: "This diagram is currentl empty: ..."

Make a right mouse click into the pane and choose "Make this diagram active". When you later add elements to a diagram, these elements will be added to the active diagram.

Now choose an element and add it to the active diagram like it was described on this page under "First Steps" -> "Demo".

To save the displayed diagram choose File -> Save Displayed Diagram.

When you repeat your work do

• Load a new SOMIX model. This will normally not be the model you used before. The diagram will be automatically adapted to the new software version.
• Choose File -> Open Work Folder
• Choose File -> Read Diagram (You will need "Import old Diagram (XML) only when you worked with the Smalltalk version of Moose2Model).

Implemented Features

General features

• Load a SOMIX model
• Read a folder and create a SOMIX model of the contained folders and files.
• Create a new diagram
• Force-dragged positioning. Start and stop with a context click in background of pane
• Scrolling by dragging the pane(with "right" mouseclick")
• Dragging elements (with "left" mouseclick)
• Zooming with the wheel of the mouse
• Menu Diagram
  • Search elements in the model. The search is case insensitive.
  • Switch between dark and white theme
  • Remove all hightlighting of the displayed elements
• Context click on elements:
  • Add an element with all neighbors to the active diagram
  • Redo adding an element with all neighbors to the active diagram
  • Get informations on the element
  • Enter or edit a comment for an element
  • Supress an element with all children
  • Redo supressing an element with all children
  • Jump to code with when a link is contained in the model (For SAP: adt links have to be activated for Eclipse. For JavaScript: This works currently only when the tool is called from file and not from the Web. The jump may go to the correct line or higher. This is due to a not exact implementation of the logic to determine the line number.)
  • Remove pinning of recently dragged elements
  • Highlight elements or the using or used elements
• Context click on pane:
  • (Only in the diagram with all model elements: Toogle the display of element names)
  • Set a diagram active (But not the diagram with all elements)
  • Start and Stop Force-directed graph
  • Jump to other diagram
• Save information to generate a diagram to file
  • Specify a workfolder first. These folder contains all diagrams which belong to the same model
  • Save the generation information for the displayed diagram. It be stored in a file with extension .m2m and similar name.
  • Read the generation information from an .m2m file. You should have all required model data loaded before. A diagram with identical name is created.
  • Import xml files from the old Smalltalk version of Moose2Model.
  • Please note that no warning is yet raised when information is lost due to wrong handling.

Header

• Display the diagram which is displayed and which is active.
• Unsaved changes are marked with a bullet point behind the name of a diagram.

Diagram with all elements

A diagram with all elments is always displayed. It can be animated as a force-directed graph. This works well for small models. The main intention of this application is not to make force-directed graph, so other tools might work better here.

Circuit Diagram for Software

• Code is displayed as orange box
• Data is displayed as blue circle
• Persistent data is displayed as green circle
• Groupings are indicated by a dashed box and include all elements contained in them
• Elements can be commented

Planned Features

Most current features of Moose2Model as are available currently in Smalltalk. And some more.