Using Papyrus to Edit UML diagrams
This page describes how to edit the OM UML in Papyrus.
What you need
Download a copy of Papyrus if you don't have one. These instructions were based on the Papyrus Mars release.
Setting up the XLIFFOM Project in Papyrus
- If this is your first time running Papyrus, you may be prompted to create a workspace. Do so.
From the File menu, choose New > Papyrus Project.
- Choose "UML" for diagram language, then click Next.
- Choose a project name (I chose "XLIFFOM"). Uncheck "Use default location" and click "Browse". Navigate to your local copy of the XLIFFOM git repository and select the model directory. In the "Model file name" field, write "XLIFFOM". Click Finish.
The project should now be imported. You will want both the Project Explorer and Model Explorer visible on the left nav bar. If one of these isn't visible, use the Window > View submenu to bring them up.
- In the Model Explorer, double-click on "Diagram Class Diagram". This should cause the UML diagram to render in the main pane.
A note about line termination
Currently the UML files use a Windows-style line termination (\r\n). Importing the project into Papyrus on the Mac (or Linux, presumably) seems to rewrite it to Unix-style line termination, which will mark the whole file as dirty in git. There are various methods that should be helpful for managing this (Papyrus project settings, git core.autocrlf setting, etc), but I haven't had luck in getting any of them to work. This may make the git history a bit cluttered.
A warning about using git from within Papyrus
You can work with the git repository directly from Papyrus by right-clicking on items in the Project Explorer and using the "Team" submenu. You can also use git in a shell, a GitHub GUI, etc. If you are ever warned by Papyrus that the upstream branch has changed, don't overwrite it -- that means somebody else has been committing changes. You will need to pull them locally and merge them with your changes before you can push your own work.