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

Appearance of "Set of Faces" in documentation. #7701

Closed
albert-github opened this issue Sep 7, 2023 · 5 comments · Fixed by #7703
Closed

Appearance of "Set of Faces" in documentation. #7701

albert-github opened this issue Sep 7, 2023 · 5 comments · Fixed by #7703

Comments

@albert-github
Copy link
Contributor

Looking at the documentation of the Triangulation package (Triangulation/index.html in the 1.8.13 doxygen version as in the 1.9.6 / master version this part is not present see proposed pull request #7700):
image

the gray background is a bit strange and comes from the fact that a <blockquote> is used (in Triangulation/doc/Triangulation/Triangulation.txt).

Probably better would bee something like:
image

resulting from:

Possible values of \f$d\f$ (the <I>current dimension</I> of the triangulation) include
\par
<table cellspacing="0" cellpadding="0">
<tr>
<td><B>\f$d=-2\f$</B><td>&nbsp;<td> This corresponds to an empty
triangulation data structure.
</tr>
<tr>
<td><B>\f$d=-1\f$</B><td>&nbsp;<td> This corresponds to an abstract simplicial
complex reduced to a single vertex.
</tr>
<tr>
 <!---  and a single full cell. In a geometric triangulation, this vertex corresponds to the vertex at infinity. -->
<td><B>\f$d=0\f$</B><td>&nbsp;<td> This corresponds to an abstract simplicial
complex including two vertices, each corresponding to a full cell;
the two full cells being neighbors of each other. This is the unique
triangulation of the \f$ 0\f$-sphere.
</tr>
<tr>
<!--- (geometrically, the finite vertex and the infinite vertex), -->
<td><B>\f$ 0< d \le D\f$</B><td>&nbsp;<td> This corresponds to a triangulation of
the sphere \f$ \mathbb{S}^d\f$.
</tr>
</table>
@albert-github albert-github changed the title Appearence of s"Set of Faces" in documenttaion. Appearence of "Set of Faces" in documenttaion. Sep 7, 2023
@albert-github albert-github changed the title Appearence of "Set of Faces" in documenttaion. Appearance of "Set of Faces" in documentation. Sep 7, 2023
@lrineau
Copy link
Member

lrineau commented Sep 7, 2023

<dl> seems the right HTML element to use, instead of <table>. I have no idea how Doxygen formats it.

@albert-github
Copy link
Contributor Author

When using just the <dl> preceded by a \par we get:
image

This doesn't look bad at all, just that by using a <table > it is a bit more compact.
The most important though is, in my opinion, to get ride of the gray area.

@lrineau
Copy link
Member

lrineau commented Sep 7, 2023

And semantically <blockquote> was really the wrong element to use.

As for the compactness of <dl>, that is just a matter of CSS rules. See for example https://stackoverflow.com/questions/1713048/how-to-style-dt-and-dd-so-they-are-on-the-same-line

@albert-github
Copy link
Contributor Author

  • so the <blockquote> part is clear
  • the <dl> styling through css is something I'm not that in favor of. For this case it might work but when applying it generally and having a <dt> with a longer part its will (as it would with a table!) take more place for the initial column. In that case a multi line <dl> might be better.

albert-github added a commit to albert-github/cgal that referenced this issue Sep 7, 2023
Remove gray background and get some indentation
(Note this proposed pull request needs the proposed pull request CGAL#7700)
@albert-github
Copy link
Contributor Author

Regarding the background: I've just pushed a proposed patch, pull request #7703

@lrineau lrineau linked a pull request Sep 7, 2023 that will close this issue
@lrineau lrineau added this to the 6.0-beta milestone Sep 7, 2023
lrineau added a commit that referenced this issue Sep 13, 2023
issue #7701 Appearance of "Set of Faces" in documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants