archimatetool / archimatetool/archi
HTML-report layout for knowledge-base documentation and comments
- Dominant language
- Java
- Stars
- 1.3k
- Forks
- 342
- PR merge metrics
- No merged PRs in 30d
Description
In order to adopt HTML-reports for knowledge-base documentation suitable for comments, below are proposals of layout improvements.
As basis were taken built-in HTML-report combined with single-page-html-report. I know that is too much at this request. Please advise on technical limitations, implementation ideas, or other layout adjustment suggestions.
1) Devote whole left-panel to tree
- Views at the top,
- Elements at bottom (some might be hidden).*
- Remove Documentaion window under the tree
- Keep the tree unfolded (or may be just views)
The idea is to use it like a table of contents for ease of navigating through (view/elements) pages
2, 3) Show only Documentation tab (below diagram), which will also include documentation of elements depending on selection
Under the Tab:
- hide Type column,
- add Documentation column
- remove relationships (it is already at a tree), *or place it at right panel bottom
Type can be used for filtering what documentation to show. The idea is to bring more focus to documentation as a knowledge base
4) Select an element in the model tree or in a view to show its details at Documentation tab
- If no element selected - show details of View.
4.1) Would it be possible to highlight the selected element on the diagram?
5) Allow Zoom to down-scale even more - for larger documentation area, if required?
6) Enable hypotes.is as plugin for inline-comments (annotations & highlights)
Contributor guide
Research direction
Start by reviewing the built-in HTML-report and single-page-html-report layouts referenced in the issue, then assess the technical limitations of the proposed tree, documentation tab, selection, zoom, and Hypothes.is changes. Done requires an agreed, implementable subset with clear layout behavior and scope; the issue currently asks for proposals rather than specifying one change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100