User Tools

Site Tools


v050:userguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
v050:userguide [2016/07/28 10:50]
ndj94 [Compilation to C++]
v050:userguide [2016/08/16 00:18] (current)
deva [Sample models]
Line 16: Line 16:
   * Download and unzip the {{v050:​demo.zip|sample models}}.   * Download and unzip the {{v050:​demo.zip|sample models}}.
   * Import them into your Eclipse workspace (''​File''​ / ''​Import''​ / ''​General''​ / ''​Existing projects into workspace''​).   * Import them into your Eclipse workspace (''​File''​ / ''​Import''​ / ''​General''​ / ''​Existing projects into workspace''​).
 +  * Clean and build the projects (''​Project''​ / ''​Clean...''​).
  
-Sample models are implemented using either XtxtUML syntax (see the source packages ''<​name of example>​.x.model''​) or JtxtUML syntax (see the source packages ''<​name of example>​.j.model''​),​ or both. In addition, the sample models are accompanied with diagram descriptions (see the Java classes inheriting from the ''​ClassDiagram''​''​StateMachineDiagram''​ or ''​CompositeDiagram''​ type).+Sample models are implemented using either XtxtUML syntax (see the source packages ''<​name of example>​.x.model''​) or JtxtUML syntax (see the source packages ''<​name of example>​.j.model''​),​ or both. In addition, the sample models are accompanied with diagram descriptions (see the Java classes inheriting from the ''​ClassDiagram'' ​or ''​StateMachineDiagram''​ type).
  
 We suggest reading the [[v050:​userguide#​Generating diagrams]] and the [[v050:​userguide#​Running and debugging models|Running and debugging models]] sections as the next steps of experimenting with the sample models. We suggest reading the [[v050:​userguide#​Generating diagrams]] and the [[v050:​userguide#​Running and debugging models|Running and debugging models]] sections as the next steps of experimenting with the sample models.
Line 61: Line 62:
 ==== Generating diagrams === ==== Generating diagrams ===
  
-It is possible to generate [[http://​wiki.eclipse.org/​MDT-UML2|EMF-UML2]] models together with [[https://​eclipse.org/​papyrus/​|Papyrus]] diagrams from txtUML models. Currently classstate machine ​and composite structure ​diagrams can be generated. Content and layout of the class diagrams and flat state machine ​or composite structure ​diagrams can be defined by textual diagram descriptions. (Support for [[https://​github.com/​ELTE-Soft/​txtUML/​issues/​214|hierarchical diagrams]] is coming in a later release.)+It is possible to generate [[http://​wiki.eclipse.org/​MDT-UML2|EMF-UML2]] models together with [[https://​eclipse.org/​papyrus/​|Papyrus]] diagrams from txtUML models. Currently class and state machine diagrams can be generated. Content and layout of the class diagrams and flat state machine diagrams can be defined by textual diagram descriptions. (Support for [[https://​github.com/​ELTE-Soft/​txtUML/​issues/​214|hierarchical diagrams]] is coming in a later release.)
  
 The following simple example assumes classes ''​A'',​ ''​B'',​ ''​C''​ and ''​D''​ in the model. We create a class diagram where classes ''​A'',​ ''​B''​ and ''​C''​ are in a row, and class ''​D''​ is below ''​B''​. Diagram definitions can be written using a Java API. See the [[v050:​layout|Diagram Language Guide]] for detailed description. The following simple example assumes classes ''​A'',​ ''​B'',​ ''​C''​ and ''​D''​ in the model. We create a class diagram where classes ''​A'',​ ''​B''​ and ''​C''​ are in a row, and class ''​D''​ is below ''​B''​. Diagram definitions can be written using a Java API. See the [[v050:​layout|Diagram Language Guide]] for detailed description.
Line 159: Line 160:
 **CMake support:** **CMake support:**
  
-You can compile the generated files with any C++ compiler manually but we suggest using the generated //CMakelist// file to create native "make files" that can be used in the compiler environment of your choice. //CMake// is available from [[https://​cmake.org/​]].+You can compile the generated files with any C++ compiler manually but we suggest using the generated //CMakeLists// file to create native "make files" that can be used in the compiler environment of your choice. //CMake// is available from [[https://​cmake.org/​]].
 It is recommended to create a new folder next to the generated files, where the build environment should be created. The compilation can be performed by the following command: It is recommended to create a new folder next to the generated files, where the build environment should be created. The compilation can be performed by the following command:
  
Line 169: Line 170:
   * ''<​environment>'':​ The chosen build environment. You can use the ''​cmake %%--%%help''​ command to list the possible build environments. ​   * ''<​environment>'':​ The chosen build environment. You can use the ''​cmake %%--%%help''​ command to list the possible build environments. ​
   * ''<​type>'':​ The type of the build. Can be ''​Debug''​ or ''​Release''​.   * ''<​type>'':​ The type of the build. Can be ''​Debug''​ or ''​Release''​.
-  * ''<​path>'':​ The relative path to the generated ​CMakeList ​file.+  * ''<​path>'':​ The relative path to the generated ​//​CMakeLists// ​file.
  
 A concrete example: A concrete example:
v050/userguide.1469695848.txt.gz ยท Last modified: 2016/07/28 10:50 by ndj94