|
| 1 | +link:https://www.modelio.org[image:README/logo-modelio-v4.png[]] |
| 2 | + |
| 3 | +link:https://github.com/ModelioOpenSource/Modelio/wiki[*Modelio documentation on GitHub*] |
| 4 | + |
| 5 | +Modelio is a modeling solution offering a wide range of functionality based on commonly used standards for enterprise architecture, software |
| 6 | +development and systems engineering. |
| 7 | + |
| 8 | +Written for developers, analysts and software and systems architects, Modelio is first and foremost a modeling environment, supporting a wide |
| 9 | +range of models and diagrams and providing many services facilitating the modeling of your architectures, such as as model |
| 10 | +consistency-checking. Support for modeling and business processes (BPMN) is integrated into Modelio. These BPMN models can be linked to other |
| 11 | +standards supported by the tool, for example UML, so as to integrate these business processes into a larger context such as an enterprise |
| 12 | +architecture. |
| 13 | + |
| 14 | +https://www.youtube.com/watch?v=GQKqQaL_m5g[image:README/modelio-video-link.png[Modelio Overview]] |
| 15 | + |
| 16 | + |
| 17 | +== Main Features |
| 18 | + |
| 19 | +* *UML Modeler* : Modelio is a first and foremost a modeling environment, supporting a wide range of models and diagrams, and |
| 20 | +providing model assistance and consistency-checking features. |
| 21 | +* *BPMN support* integrated with UML : Modelio combines BPMN support and UML support in one tool, with dedicated diagrams to support business |
| 22 | +process modeling. |
| 23 | +* *Java code generator* : The Java Designer module uses an RCP/Eclipse-style project file structure, and supports Java code |
| 24 | +generation and reverse, Javadoc generation and Java automation. |
| 25 | +* *XMI import/export* : Modelio provides an XMI import/export feature that enables you to exchange UML2 models between different tools. |
| 26 | +* *HTML model publishing* : With the HTML Publisher module, publish your models in HTML format. |
| 27 | +* *Extension system* : Modelio can be extended for any language, methodology or modeling technique just by adding modules to your |
| 28 | +configuration. You can either use existing modules or else develop your own. |
| 29 | +* *Scripting language support (Jython)* : Modelio provides integrated support of the Jython scripting language, for online requests, small |
| 30 | +scripts and macro definition. |
| 31 | + |
| 32 | + |
| 33 | +== Supported Standards |
| 34 | + |
| 35 | +* *UML2* : UML2 is a general-purpose modeling language from the OMG, used in the field of object-oriented software engineering. |
| 36 | +* *BPMN2* : BPMN is a standard for business process modeling, providing a graphical notation for the specification of business processes. |
| 37 | +* *Archimate* : Archimate is an open and independent enterprise architecture modeling language to support the description, analysis and |
| 38 | +visualization of architecture within and across business domains. |
| 39 | +* *XMI* :XMI is an OMG standard used in the exchange of metadata information via the XML language. |
| 40 | +* *MDA* : MDA is an OMG standard, which implements and uses model extensions in the development of software systems. |
| 41 | +* *TOGAF* :TOGAF is an enterprise architecture framework, providing a complete approach to enterprise information architecture design, |
| 42 | +planning, implementation and governance. |
| 43 | + |
| 44 | + |
| 45 | +== Build from Source |
| 46 | + |
| 47 | +To understand how to compile the Modelio Modeling tool from source, |
| 48 | +please refer to the |
| 49 | +https://github.com/ModelioOpenSource/Modelio/wiki/Build-Modelio-Index[Building |
| 50 | +Modelio from Source Guide]. |
| 51 | + |
| 52 | + |
| 53 | +== Contribute |
| 54 | + |
| 55 | +There are many ways to get involved in the Modelio community, on |
| 56 | +whatever level you choose. For each type of contribution, we recommend a |
| 57 | +certain level of knowledge as a user (someone who has some knowledge of |
| 58 | +the Modelio tool, as well as modeling or standards such as UML, SOA, |
| 59 | +BPM, ...) or a developer (someone with some knowledge of programming) |
| 60 | + |
| 61 | +For more information, visit our community web page : |
| 62 | +image:https://www.modelio.org/community/get-involved.html[https://www.modelio.org/community/get-involved.html] |
| 63 | + |
| 64 | + |
| 65 | +== Quick Start Guide |
| 66 | + |
| 67 | +=== Creating a project |
| 68 | + |
| 69 | + |
| 70 | +First you have to start Modelio by double-clicking on the Modelio |
| 71 | +shortcut. Once Modelio is started, go to 'File / Create a project...' or |
| 72 | +click on the [image:README/new-project-button.png[New Project]] button. |
| 73 | +This will open a Project Creation dialog box: |
| 74 | + |
| 75 | +image:README/create-a-project.jpg[Project Creation] |
| 76 | + |
| 77 | +Steps: |
| 78 | + |
| 79 | +1. Enter a project name |
| 80 | +2. Enter a description |
| 81 | +3. You can choose whether to deploy the Java Designer module in your |
| 82 | +project by checking or not checking the Java project tickbox. |
| 83 | +4. Click on "Create" |
| 84 | + |
| 85 | + |
| 86 | +=== General User Interface |
| 87 | + |
| 88 | +image:README/general-user-interface.jpg[Interface] |
| 89 | + |
| 90 | +Key: |
| 91 | + |
| 92 | +1. Model explorer (UML, BPMN, MDA, Requirements, ...) |
| 93 | +2. Diagram view |
| 94 | +3. Diagrams explorer |
| 95 | +4. Module view |
| 96 | +5. Properties view |
| 97 | +6. Symbol view |
| 98 | + |
| 99 | +image:README/gui-main-toolbar.jpg[Toolbar] |
| 100 | + |
| 101 | +Key: |
| 102 | + |
| 103 | +1. Save |
| 104 | +2. Undo/Redo |
| 105 | +3. Project Configurator: Project information, Work models, Libraries, |
| 106 | +Modules, Audit, URLs |
| 107 | +4. Quick diagram creation |
| 108 | +5. Diagram creation wizard |
| 109 | +6. Advanced search tool |
| 110 | +7. Perspectives: Change the layout of the views |
| 111 | +8. Sort model elements |
| 112 | + |
| 113 | + |
| 114 | +=== Creating elements |
| 115 | + |
| 116 | +.From the diagram view |
| 117 | +image::README/create-element-diagram.jpg[Element Creation] |
| 118 | + |
| 119 | +(Note: if you don't see the Modelio layout above, but wish to continue |
| 120 | +with this Quick Start, expand your project in the Model pane until you |
| 121 | +see a folder icon with the same name as your project, and select "Create |
| 122 | +diagram..." from the context menu, typically by right-clicking on that |
| 123 | +icon.) |
| 124 | + |
| 125 | +Key: |
| 126 | + |
| 127 | +1. Choose the type of element you want to create from the diagram palette |
| 128 | +2. Click in the diagram to position the new element. Click again on the element to rename it (or click on the F2 keyboard button) |
| 129 | + |
| 130 | +*From the UML model explorer* |
| 131 | + |
| 132 | +To create your first element, right-click on the root package and then |
| 133 | +on 'Create element'. Choose the kind of UML/BPMN element you want to |
| 134 | +create: |
| 135 | + |
| 136 | +image:README/create-element-uml-explorer.jpg[Element Creation] |
| 137 | + |
| 138 | +*Sibling creation* |
| 139 | + |
| 140 | +To create a series of elements, simply select the original element in |
| 141 | +the model explorer, then click on sibling button as many times as |
| 142 | +necessary. Each new element will be created empty and named with an |
| 143 | +incremental number. Sibling elements are created within the same |
| 144 | +container. |
| 145 | + |
| 146 | +*Clone creation* |
| 147 | + |
| 148 | +To clone an element, simply select it in the UML/BPMN explorer, then |
| 149 | +click on clone button as many times as necessary. Each new element will |
| 150 | +be created with the same sub-elements as the original one, and will be |
| 151 | +named the same. |
| 152 | + |
| 153 | + |
| 154 | +=== Creating diagrams |
| 155 | + |
| 156 | +Diagram creation :: |
| 157 | + |
| 158 | +Click on the Diagram and matrix creation wizard icon in the main toolbar: + |
| 159 | +image:README/diagram-creation-wizard.jpg[Diagrams] + |
| 160 | +Steps: + |
| 161 | +1. Select the kind of diagram you want to create + |
| 162 | +2. Enter a name + |
| 163 | +3. Select an owner for the diagram + |
| 164 | +4. Click on "OK" to create the diagram + |
| 165 | + |
| 166 | +Note: By default, the wizard shows the applicable diagrams for the selected model element. Click on the "Show only applicable diagrams and |
| 167 | +matrices" to show all existing diagrams. |
| 168 | + |
| 169 | +Create elements in the diagram :: |
| 170 | + |
| 171 | +To create elements in your diagram, you can either use the left hand side palette, or drag&drop existing elements from the UML explorer. + |
| 172 | +image:README/diagram-drag-drop.jpg[Diagrams] |
| 173 | + |
| 174 | +Modify the graphic options :: |
| 175 | + |
| 176 | +You can change the objects' graphic properties or the diagram's properties itself. The symbol view offers several options to change the |
| 177 | +graphic properties: color, font, line background, ... + |
| 178 | +image:README/diagram-symbol.jpg[Diagrams] + |
| 179 | +Key: + |
| 180 | +1. Change the options in the Symbol view |
| 181 | + |
| 182 | +Change objects' graphic properties :: |
| 183 | + |
| 184 | +image:README/diagram-object-properties.jpg[Diagrams] + |
| 185 | +Key: + |
| 186 | +1. Select a graphic element + |
| 187 | +2. Change the options in the Symbol view + |
0 commit comments