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

Remove all occurrences of valign="top" from Documentation #2517

Merged
merged 1 commit into from Apr 27, 2018

Conversation

dietmarw
Copy link
Member

The attribute valign="top" has no effect on any of the tables and therefore just adds noise to the HTML code which is then also harder to read.

Also the attribute should not be added to td elements but rather defined via styles if really necessary.

@dietmarw
Copy link
Member Author

I am aware that there are some additional usages of valign=bottom|middle those should probably also be reevaluated but that takes more time than is worth it really. The main thing is that the User's Guide no longer mentions them and that the top ones are removed.

Copy link
Contributor

@christiankral christiankral left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with the proposed removal of valign="top" since it seems to be a result of copy+paste activities only

The attribute `valign="top"` has no effect on any of the tables and therefore just adds noise to the HTML code which is then also harder to read.

Also the attribute should not be added to `td` elements but rather defined via styles if really necessary.
@beutlich beutlich added this to the MSL3.2.3 milestone Apr 27, 2018
@beutlich beutlich changed the title Remove all occurences of valign=top Remove all occurences of valign="top" from Documentation Apr 27, 2018
@beutlich beutlich merged commit 5591ebc into modelica:master Apr 27, 2018
@dietmarw dietmarw deleted the remove-valign branch April 27, 2018 08:36
@beutlich beutlich added the documentation Issue addresses the documentation label Apr 30, 2018
@beutlich beutlich self-assigned this May 22, 2018
@beutlich
Copy link
Member

I noticed that valign="top" indeed looks better for broken long lines, as for example is recommended in Modelica.UsersGuide.Conventions.UsersGuide.References.

Without valign:
no_valign

With valign="top":
valign_top

Another table that looked better with valign="top" is in Modelica.Mechanics.MultiBody.Examples.Elementary.

beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this pull request May 24, 2018
This reverts commit 5591ebc.

# Conflicts:
#	Modelica/Math/package.mo
#	Modelica/Mechanics/MultiBody/Examples/Elementary/package.mo
#	Modelica/Mechanics/MultiBody/Examples/Loops/package.mo
#	Modelica/Mechanics/MultiBody/Forces.mo
#	Modelica/Mechanics/MultiBody/Frames.mo
#	Modelica/Mechanics/MultiBody/Joints.mo
#	Modelica/Mechanics/MultiBody/Parts.mo
#	Modelica/Mechanics/MultiBody/Types.mo
#	Modelica/Mechanics/MultiBody/Visualizers.mo
#	Modelica/Media/Water/IF97_Utilities.mo
#	Modelica/Utilities/Files.mo
#	Modelica/Utilities/Strings.mo
#	Modelica/package.mo
dietmarw added a commit to dietmarw/OMCompiler that referenced this pull request May 25, 2018
During a documentation clean up of the MSL for 3.2.3 release the
style seetings for vertical alignment were removed (modelica/ModelicaStandardLibrary#2517)
Other tools (e.g., SimulationX and Dymola) have their own default settings
that actually match top alignment. OMEdit is probably going to have
the same. This PR adds this for the documentation generation.
dietmarw added a commit to dietmarw/OMCompiler that referenced this pull request May 25, 2018
During a documentation clean up of the MSL for 3.2.3 release the
style settings for vertical alignment were removed (modelica/ModelicaStandardLibrary#2517)
Other tools (e.g., SimulationX and Dymola) have their own default settings
that actually match top alignment. OMEdit is probably going to have
the same. This PR adds this for the documentation generation.
OpenModelica-Hudson pushed a commit to OpenModelica/OMCompiler that referenced this pull request May 25, 2018
During a documentation clean up of the MSL for 3.2.3 release the
style settings for vertical alignment were removed (modelica/ModelicaStandardLibrary#2517)
Other tools (e.g., SimulationX and Dymola) have their own default settings
that actually match top alignment. OMEdit is probably going to have
the same. This PR adds this for the documentation generation.

Belonging to [master]:
  - #2467
@beutlich beutlich changed the title Remove all occurences of valign="top" from Documentation Remove all occurrences of valign="top" from Documentation Jun 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue addresses the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants