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

Non normative start #2654

Merged
merged 13 commits into from Sep 10, 2020
Merged

Non normative start #2654

merged 13 commits into from Sep 10, 2020

Conversation

HansOlsson
Copy link
Collaborator

Improve the structuring of chapters by stating that the initial text is non-normative; and should also restructure package-chapter.
Draft since there are some tricky remaining chapters.

Closes #2366

@HansOlsson
Specify that chapter introductions are non-normative.
f15ae91
@HansOlsson
Split of terminology as separate section.
50d1408
@HansOlsson
Remove normative text (already part of equations-chapter),
ae60b5b 
and replace it with some relevant introduction.
@HansOlsson
No need to mark the start as non-normative anymore.
b998695
@HansOlsson
Split of normative part.
711326c
@HansOlsson
Reformulate to have a non-normative introduction, followed by an actu…
b425c4d 
…al normative part.
@HansOlsson
Switch from table to item-list after latexml bug was corrected.
22b221d
@HansOlsson
Fix reference to table.
8dba6d6
@HansOlsson
Mark entire introduction to array chapter as non-normative.
fc393b5 
As far as I could see all the normative parts were duplicated from the chapter
and thus redundant.
@HansOlsson
Move non-normative motivation for package to start of chapter,
69de9dc 
and move up most definitions as discussed.
@HansOlsson
Reorder sections in package-chapter as discussed.
9acfd09
@HansOlsson
Copy link
Collaborator Author

Note on a missing commit: I believe that the classes-chapter should work as is. The introductory parts are as far as I understand duplicated.

@HansOlsson HansOlsson marked this pull request as ready for review September 9, 2020 10:25
@HansOlsson HansOlsson mentioned this pull request Sep 9, 2020
Merged
@henrikt-ma
Copy link
Collaborator

henrikt-ma commented Sep 9, 2020 •
edited

Shouldn't every chapter have a non-normative start? Chapters missing one:

  • Equations
  • Modelica Concrete Syntax
  • Modelica DAE Representation (currently everything is placed in the non-normative start)

henrikt-ma
henrikt-ma approved these changes Sep 9, 2020
View reviewed changes
Copy link
Collaborator

@henrikt-ma henrikt-ma left a comment

Choose a reason for hiding this comment

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

This looks like a good start. Approving, even though a few more things could be done, see comments.

chapters/operatorsandexpressions.tex Show resolved Hide resolved
@HansOlsson
Copy link
Collaborator Author

Shouldn't every chapter have a non-normative start?

Ideally, yes. But it takes a bit of time to write a good introductions so I thought that could be done later.

@HansOlsson HansOlsson merged commit e5f5169 into modelica:master Sep 10, 2020
@HansOlsson HansOlsson deleted the NonNormativeStart branch September 10, 2020 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@henrikt-ma henrikt-ma henrikt-ma approved these changes

@sjoelund sjoelund Awaiting requested review from sjoelund

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Poor structure of chapter "Packages"
2 participants
@HansOlsson @henrikt-ma