major
nice-to-have
minor
#25217
Layout-Export führt zu invaliden Komponenten-Referenzen bei Referenzierung einer bestehenden Komponente
#25327
Modell-Editor: Falsche Kompositionsmarker, wenn Container-Typ in Diagramm von Content-Typ gezogen wird
enhancement
(User-visible)
An in-app documentation system is to be developed for Top-Logic. In the long term, this system is intended to replace the existing "Online Help."
Improvement
The current “Online Help” has several drawbacks:
- It must be maintained externally.
- It is imported into the application via a complicated, unstable process.
- Its code is severely outdated and unsuitable for further development.
Therefore, a new system will be developed to address these issues:
- The documentation is maintained within the app.
- The documentation is stored in the database, just like new views, for example.
- The documentation can be exported with the click of a button (to the workspace).
- Existing documentation in the workspace is imported when the application is launched.
- The in-app documentation system will initially exist alongside the “Online Help.” This allows each application to decide for itself when to make the switch.
Application
Eclipse project: com.top_logic.doc
Applications must inherit from com.top_logic.doc instead of com.top_logic.help. They will then automatically receive the "new" documentation.
Related Tickets
Ticket #24665 contains a collection of ideas related to the theme.
Test
The new documentation is displayed when the Help window is opened.