Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(capella): Add description editor workaround via expert view #1457

Merged
merged 1 commit into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,27 @@
![Description Editor](./description-editor.png){:style="width:400px"}

This is a common and known bug in Capella itself. We have reported it to the Capella contributors,
but there is no fix available yet. You can track the status on GitHub: <https://github.com/eclipse-capella/capella/issues/2316>
but the bug originates in the Eclipse/Nebula framework. The bug was fixed in Eclipse version
4.24. Capella 6.0.0 and 6.1.0 are based on Eclipse 4.20, so the bug is still present in these versions.
Capella 7.0.0 is based on Eclipse 4.27 and the description editor issues are fixed.

If you are experiencing this problem, please try one of the following workarounds:

- Use the "Semantic" or "Expert" view in Capella to modify the description.
To do so, open the properties tab of the element you want to edit and click on the "Semantic" or "Expert" tab.
In this editor, rich text is not supported! You have to enter valid HTML. The content is not validated
and may later impact other components of the toolchain if invalid.

![Export/Semantic view](./description-editor-expert-view.png)

- Open the description editor by double-clicking the model element you want to edit, and open the description editor from the overlay:
![Element overlay](./description-editor-overlay.png)
- Open the Description Editor from the Properties tab:
![Properties tab](./description-editor-properties.png)
- Reopen Capella in the current session from the task bar at the top of the session window. Expand `File` and close Capella. It will reopen automatically.

![Exit Capella](./exit-capella.png)

- End your session and request a new session in the Capella Collaboration Manager.


Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ nav:
- Export a Model to TeamForCapella: user/tools/capella/teamforcapella/export/export-to-t4c.md
- Git:
- Working with Git: user/tools/capella/git/working-with-git.md
- Troubleshooting: user/tools/capella/troubleshooting.md
- Troubleshooting: user/tools/capella/troubleshooting/index.md
- Jupyter:
- Collaboration: user/sessions/jupyter/collaboration.md
- API documentation:
Expand Down
Loading