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

Improvements for layout of traceability items #377

Open
gcrabbe opened this issue Jun 14, 2024 · 0 comments
Open

Improvements for layout of traceability items #377

gcrabbe opened this issue Jun 14, 2024 · 0 comments

Comments

@gcrabbe
Copy link

gcrabbe commented Jun 14, 2024

The layout of a traceability item currently presents the following structure:

<div id="DIG-RQT-COMP-ee_fl_2t_shell-1" class="collapsible_links collapse docutils container">
	<i class="fa fa-angle-down" [...]></i>
	<div class="item admonition" [...]>
		<p class="admonition-title">[...]</p>
	</div>
	<dl [...]><dt>Attributes</dt>[...]</dl>
</div>
<blockquote>
	<div>
		<p>Lorem ipsum [...]</p>
		<div class="admonition warning">[...]</div>
	</div>
</blockquote>

And is rendered as such:

image

Observe:

  1. The admonition block with the title, rendered in blue.
  2. The empty admonition body, rendered in pale blue.
  3. The block quote with the actual item contents outside the main container.
  4. The asymmetric alignment caused by the block quote element.

I believe that removing the contents from the block quote, putting them in the admonition body, and merging the admonition with the main container would simplify the structure, better translate the relationship between the title and the contents, and allow items to nest:

<div id="DIG-RQT-COMP-ee_fl_2t_shell-1" class="item admonition collapsible_links collapse docutils container">
	<p class="admonition-title">[...]</p>
	<i class="fa fa-angle-down" [...]></i>
	[...]
	<dl [...]><dt>Attributes</dt>[...]</dl>
	<p>Lorem ipsum [...]</p>
	<div class="admonition warning">[...]</div>
</div>

In addition to giving a more aesthetically pleasing result:

image

The same observation applies to traceability tables and charts, for which the actual content is also not inside, but below, the admonition that provides the title.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant