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.

Sign up for GitHub

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

Jump to bottom

Fix issues concerning user's guide conventions #2909

Merged
merged 17 commits into from
Jun 16, 2019
Merged

Fix issues concerning user's guide conventions #2909

merged 17 commits into from
Jun 16, 2019

Conversation

tobolar
Copy link
Contributor

@tobolar tobolar commented Apr 30, 2019

Apply rules defined in Modelica.UsersGuide.Conventions.Documentation on the html documentation itself

close #2906

@tobolar tobolar added the L: UsersGuide Issue addresses Modelica.UsersGuide label Apr 30, 2019
@tobolar @beutlich
Collect examples of documentation format within "Examples" section(s)
1ed83c7
@tobolar @beutlich
Place paragraph text within <p> environment
393acad
@tobolar @beutlich
Write html tags in text within <code> environment
97f9bf3
@tobolar @beutlich
Change indention in example of numbered equation
576c663
@tobolar @beutlich
Reorganize rules in UsersGuide.Conventions.Documentation.Format.Lists
9a4ea1a
@tobolar @beutlich
Delete header <h4>General</h4>
95b4846
@tobolar @beutlich
Minor: just improve html code format
e196f89
@tobolar @beutlich
Use &quot; instead of " in html documentation
19c1629
@tobolar @beutlich
Minor: just improve html code format
c38c527
@tobolar @beutlich
Correct description string being used for boolean parameters
380f2e3
@tobolar @beutlich
Reorder entries of table "Variables and names"
02fac73
@tobolar @beutlich
Change html code indention in example of "References".
0f357e8
@tobolar @beutlich
Write &quot; &amp; and &apos; properly in preformated html source code
0529355
@tobolar @beutlich
Add "caption" of table
e41be78
@tobolar @beutlich
Wrap Figures within <div> environment instead of <p>
b369708
@tobolar @beutlich
Write Figure name and enumeration in bold
88041f3
@tobolar @beutlich
Wrap referred figures with figure number within <table> environment
8b0189c
@beutlich beutlich self-assigned this Apr 30, 2019
@beutlich beutlich added this to the MSL4.0.0 milestone Apr 30, 2019
@beutlich
Copy link
Member

@christiankral Any comments?

christiankral
christiankral approved these changes Jun 16, 2019
View reviewed changes
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.

Looks OK.

@beutlich beutlich changed the title Fix issues concerning users guide conventions Fix issues concerning user's guide conventions Jun 16, 2019
@beutlich beutlich merged commit 99aad05 into modelica:master Jun 16, 2019
@christiankral christiankral mentioned this pull request Jun 16, 2019
Open
@tobolar tobolar deleted the issue2906_minorUsersGuideConventions branch September 3, 2019 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christiankral christiankral christiankral approved these changes

@beutlich beutlich beutlich approved these changes

Assignees

@beutlich beutlich

Labels
L: UsersGuide Issue addresses Modelica.UsersGuide
Projects
None yet
Milestone
MSL4.0.0
Development

Successfully merging this pull request may close these issues.

Minor issues in UsersGuide.Conventions
3 participants
@tobolar @beutlich @christiankral