A documentation view is available to help user to comment each element of the Papyrus model. By Default it take as source the first comment found of the selected element, if it doesn’t exist a comment will be created.
The enter text will be save at the focus lost of the view.
The documentation can be write through HTML richtext editor:
You can activate it with the preference:
Window > Preferences > Papyrus > Rich text > Use advanced rich text editor
By default the toolbar is collapse. This can be changed with the preference:
Window > Preferences > Papyrus > Documentation View > Initialy expand Richtext Toolbar
You can choose to select the first comment stereotyped with
Documentation::Documentation. You must first apply the profile to
Documentation to the model.
If stereotyped comment doesn’t exist a new one will be created.
The use of
Documentation Profile provide a new tab in the Documentation View: 'Resources'. It correspond to the property
associatedRessource of
Documentation::Documentation stereotype.
The use of the Documentation Profile can be set at preference:
Window > Preferences > Papyrus > Documentation View > Choose type of Documentation Comment.
The Documentation View is available from a right-click on the desired item, it is possible to select the "Show Documentation View" option.
The documentation view is synchronized by default with the selection. This can be disabled with
icon.
The selection synchronization works with elements selected in from properties view:
