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

Conflicting guidelines for HTML documentation conventions for tables #3844

Closed
dietmarw opened this issue Jun 18, 2021 · 2 comments · Fixed by #3848
Closed

Conflicting guidelines for HTML documentation conventions for tables #3844

dietmarw opened this issue Jun 18, 2021 · 2 comments · Fixed by #3848
Assignees
Labels
documentation Issue addresses the documentation L: UsersGuide Issue addresses Modelica.UsersGuide
Milestone

Comments

@dietmarw
Copy link
Member

In Modelica.UsersGuide.Conventions.Documentation.Format.Tables the guidelines say that the caption should be defined as:

<caption align="bottom"><strong>Tab 2:</strong> Caption starts with a capital letter</caption>

But this would place the caption at the bottom and not the top. The problem is that Dymola renders the position incorrectly and always displays it on the top. Now the question, should the caption appear at the top of the table or the bottom. If at the top then it needs to be updated and tools need to make sure to get the rendering right.

One additional problem is that align is no longer supported in HTML5, so the guideline should most likely updated anyway.

@dietmarw dietmarw added L: UsersGuide Issue addresses Modelica.UsersGuide documentation Issue addresses the documentation labels Jun 18, 2021
@dietmarw dietmarw changed the title Conflicting guidelines for HTML documentation convention guidelines for tables Conflicting guidelines for HTML documentation conventions for tables Jun 18, 2021
@christiankral
Copy link
Contributor

I assume we do not have a decision yet, if HTML5 is the standard that the MLS and the MSL rely on, see modelica/ModelicaSpecification#2395.

However, we could

  1. remove align from the MSL documentation
<caption><strong>Tab 2:</strong> Caption starts with a capital letter</caption>
  1. and do not specify where the caption shall be placed and thus leave it up to the tool vendors how they implement it

@dietmarw
Copy link
Member Author

I agree that is the most practical and pragmatic solution and also future proof. I'll create a PR to remove it.

@dietmarw dietmarw added this to the MSL4.1.0 milestone Jun 28, 2021
@dietmarw dietmarw assigned dietmarw and unassigned HansOlsson Jun 28, 2021
dietmarw added a commit to dietmarw/ModelicaStandardLibrary that referenced this issue Jun 28, 2021
This fixes modelica#3844 by removing the recommendation and application of `align=\"bottom\"` since tools tend to interpret this differently (e.g., ignore) and the `align` parameter is also deprecated in HTML5. Not using and recommending it  makes it more future proof.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue addresses the documentation L: UsersGuide Issue addresses Modelica.UsersGuide
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants