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

Use quoted section for preformatted text #2752

Closed
tobolar opened this issue Oct 23, 2018 · 7 comments · Fixed by #3171
Closed

Use quoted section for preformatted text #2752

tobolar opened this issue Oct 23, 2018 · 7 comments · Fixed by #3171
Assignees
Labels
documentation Issue addresses the documentation L: UsersGuide Issue addresses Modelica.UsersGuide
Milestone

Comments

@tobolar
Copy link
Contributor

tobolar commented Oct 23, 2018

I suggest to quote sections of preformated text in the documentation, in HTML by <blockquote> ... </blockquote>. This is already established in plenty of classes, but not consequently in all classes.
If agreed, this should especially be documented in Modelica.UsersGuide.Conventions.Documentation.Format.Code.

@tobolar tobolar added discussion Discussion issue that it not necessarily related to a concrete bug or feature documentation Issue addresses the documentation labels Oct 23, 2018
@tobolar
Copy link
Contributor Author

tobolar commented Oct 30, 2018

I found out there is right opposite definition in Modelica.UsersGuide.Conventions.Documentation.Format.Code:

  1. Multi line or single line code shall not be indented.

But I still believe the text in the second figure below is better readable than the text in the first figure and vote for changing this rule.


Figure 1 - snapshot of the current "Code" document:

grafik

Figure 2 - the same document, code lines formated using blockquote:

grafik

@beutlich
Copy link
Member

Are the blockquote tags missing in the 2nd example of the 2nd figure? Otherwise I wonder why it is indented w.r.t. the 1st figure.

@tobolar
Copy link
Contributor Author

tobolar commented Oct 31, 2018

@beutlich Fixed 2nd figure.

@beutlich beutlich removed the discussion Discussion issue that it not necessarily related to a concrete bug or feature label Oct 15, 2019
@beutlich
Copy link
Member

@tobolar Seems accepted.

  1. Can you please update the conventions! Thanks.
  2. Do we also want to fix it in current MSL for v4.0.0?

@beutlich beutlich added the L: UsersGuide Issue addresses Modelica.UsersGuide label Oct 15, 2019
@tobolar
Copy link
Contributor Author

tobolar commented Oct 21, 2019

  1. Do we also want to fix it in current MSL for v4.0.0?

You mean to go through all <pre>s?

@beutlich
Copy link
Member

beutlich commented Oct 21, 2019

  1. Do we also want to fix it in current MSL for v4.0.0?

You mean to go through all <pre>s?

Yes.

@tobolar
Copy link
Contributor Author

tobolar commented Oct 23, 2019

OK, I will look over it.

beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Oct 24, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Nov 8, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Nov 8, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 8, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 8, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 8, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 17, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 17, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Dec 17, 2019
@beutlich beutlich added this to the MSL4.0.0 milestone Dec 17, 2019
@beutlich beutlich changed the title Use quoted section for preformated text Use quoted section for preformatted text Feb 2, 2020
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.

2 participants