Generated HTML documentation needs to be improved for the release.

[modelica-trac-importer]

Modified by dietmarw on 24 Sep 2010 11:25 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.(fixed)
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.(fixed)
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?(fixed)
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)(fixed)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.(fixed)
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice(fixed)
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found(fixed)
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice(tool issue)
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?(fixed)
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?(tool issue)
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.(fixed)

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.(fixed)

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 21 Sep 2010 14:57 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.(fixed)
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.(fixed)
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)(fixed)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.(fixed)
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice(fixed)
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found(fixed)
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice(tool issue)
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?(fixed)
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?(tool issue)
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.(fixed)

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.(fixed)

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 14 Sep 2010 23:05 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.(fixed)
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.(fixed)
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)(fixed)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.(fixed)
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice(fixed)
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found(fixed)
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice(tool issue)
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?(fixed)
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?(tool issue)
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.(fixed)

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.(fixed)

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 13 Sep 2010 23:04 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.(fixed)
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.(fixed)
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)(fixed)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.(fixed)
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found(fixed)
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice(tool issue)
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?(fixed)
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?(tool issue)
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.(fixed)

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.(fixed)

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 12 Sep 2010 19:13 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.(fixed)
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)(fixed)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.(fixed)
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found(fixed)
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice(tool issue)
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?(fixed)
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?(tool issue)
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 12 Sep 2010 00:51 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found (was tool issue)
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 11 Sep 2010 17:26 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Modified by dietmarw on 11 Sep 2010 16:54 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.

    Big bug::

    16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Reported by Ulf.WISTROeM on 10 Sep 2010 19:04 UTC I created a HTML document (one file) for MSL3.2 just for testing and got stuck looking at the result. I found a number of small bugs – of course not important right now, but to add to “to do later” list; however the big bug in the end might be corrected earlier. (I am aware of that documentation issues like this probably are planned for correction later anyway, and I am aware that you probably are aware of a number of them, but you get what I found just for feedback.)

Small bugs::

1. In Modelica.UserGuide.Contact a tab is introduced that is never set back.
2. In Modelica.Electrical.Analog a large number of empty lines are present in the documentation in a number of packages. Is the idea to later insert images?
3. Modelica.Electrical.Analog.[Basic.M_Transformer] + …[Lines.M_Oline]: the matrices not very nice.
4. Modelica.Electrical.Analog.Ideal.[IntermediateSwitch] + [ControlledIdealIntermediateSwitch]; images not well posed, to big?
5. (Tables in e.g. Modelica.Electrical.Analog.Semiconductors.HeatingNMOS not 100% perfekt in alignment, but that I guess one can live with)
6. In Modelica.Electrical.QuasiStationary.Multiphase.Ideal italics is introduced in the information of idle branch; never set back.
7. Modelica.Electrical.Spice3.UsersGuide.Spicenetlist: shouldn´t the two columns be syncronized in some way? I guess the table can be improved.
8. Modelica.Magnetic.FluxTubes.UsersGuide.Literature + Contact: dot list not nice
9. Modelica.Magnetic.FluxTubes.Shapes.FixedShape.HollowCylinderAxialFlux and following: Images not found
10. Modelica.Magnetic.FundamentalWave.UsersGuide.ReleaseNotes: strange blue underline – also later in package + a number of images not found
11. Modelica.Mechancs.MulitBody.UsersGuide: numbered list not nice
12. Starting from Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.Introduction a number of images, tables and formulas are centered. In following packages, it is mixed. Perhaps some kind of guidelines would be good?
13. In reference to the big bug below, some sections have very short lines and a lot of space (e.g. Modelica.Mechanics.Translational.Components.InitializeFlang). A mixing of this is e.g. Modelica.Fluid.UsersGuide.BuildingSystemModels.SystemComponent. Guidelines?
14. In the end of Modelica.Fluid.Fittings.BaseClasses.Bends.EdgedBend bold face is introduced for body text, never set back.

15. Modelica.Fluid.Dissipation.HeatTransfer.StraightPipe.kc_twoPhaseOverall_KC: in the reference section a number of tabs is introduced – actually set back in Modelica.Fluid.Utilities.regSquare2.

    Big bug::

16. Starting from Modelica.Electrical.Spice3.Sources.I_pwl (might be earlier) – lines too long, they later become exteme…. (Modelica.Magnetic)

---

Migrated-From: https://trac.modelica.org/Modelica/ticket/407

[modelica-trac-importer]

Comment by dietmarw on 10 Sep 2010 19:36 UTC OK I've already started on this. Some of the issues might best be solved by the lib devs themselves. The most crucial thing is now fixed (long lines see below).

Ulf, what I can say for now is:

• The "big bug" 16. was related to 6. and it looks like that confused the HTML generator w.r.t. dynamic linebreaks. Fixed in 10961de357f9b07fdb8a42f6ba766218076ddd46 Christoph:: I agree with Ulf on item 2. and looked at it. For some reason there are loads of ugly constructs like "</p><p><br/><br/>". Since I don't manage this tonight I'd ask you to look through all of Electrical.Analog and clean this up. If in doubt on how to best format it ... there is a formatting guide in Modelica.UsersGuide.Conventions.Documentation available. This this is a documentation fix only it's fine to just make the changes and commit them when ready. If any possible before the 25th of September (Release Candidate).

  Ulf:: As you can see there are now guidelines but they are very new and need to be properly "enforced" ;) Another thing, when you say "tabs introduced and not set back" do you actually mean "tags"?

[modelica-trac-importer]

Modified by dietmarw on 11 Sep 2010 16:54 UTC

[modelica-trac-importer]

Comment by dietmarw on 11 Sep 2010 17:26 UTC Item 5. and another missing </i> tag fixed in 8b77b6db21b1f9c3cc32800be0ff48b840afd596

[modelica-trac-importer]

Comment by dietmarw on 12 Sep 2010 00:51 UTC Committed some more fixes:

• abaafe65b0759d0be896895c75068d2c34a24503 fixes item 3.,

• 313d9856ccb4befbdc6dbf3364df7e72a3cbef3b fixes item 10., the strange under lines were due to line-breaks just after a href tag. My suspicion is that this was introduced by the tools html editor. The missing image links were partly due to not updated new location within Resources (my bad) and some missing image extensions in the path (lib devs bad ;) )

  Christoph:: Perhaps you and Kristin can look at the changes I've made in abaafe65b0759d0be896895c75068d2c34a24503 and update the rest of the Anaolg library accordingly. I'll leave item 2., 4., and 7. to you!

  Ulf:: I looked at item 1. but don't really know what tab(tag?) you mean. Can you give me some additional pointers? As for item 9., that was actually missing tool support of modelica:// URIs in the __Dymola_Image annotation. That is already fixed in the newest 7.5 pre-alpha so doesn't need to be fixed in the MSL (only you need to remember to use at least that version when generating the HTML documentation. Btw, those parameter images will be changed to use the new standard annotation attribute groupImage in MSL4.0 (see also #408).

  Christian, Toni:: Would it be possible for you to have a look at item 8.?

[modelica-trac-importer]

Comment by dietmarw on 12 Sep 2010 01:01 UTC

• 4760deaa4eeee77d3c5fa5a53dd0d72803e26b3a removes <br/><br/> constructs which I think almost might solve item 2.

[modelica-trac-importer]

Comment by dietmarw on 12 Sep 2010 19:13 UTC More fixes:

• item 11. and item 13. are "won't fix" since these are issues of the html generator. The numbered lists look perfectly well in the source and the length of the lines is something that depends on the viewer (i.e., in all those cases it was not explicitly defined in the source). It looks like that the HTML generator does not work well with <tt>...</tt> constructs. Since the guideline actually recommends the usage of <code>...</code>, I replaced those in 19c7905c0f67703b3ab3b10445aeb43999375629
• item 12. is fixed in c4d47c9462d93340d34a18fa41251108cc6f5d8e. The convention guide states that images and tables should be outside <p>...</p> environments in order to be html compliant. Although not explicitly stated this means also that they should be left-aligned. This also makes sense for dynamic html documentation which display depends on the width of the current viewer window.

[modelica-trac-importer]

Comment by dietmarw on 13 Sep 2010 23:04 UTC The tab and boldface issue of item 1., item 14., and item 15. were fixed in 90bf946a4f28b28d8633ac73117c5a1b3fc872b2.

[modelica-trac-importer]

Comment by dietmarw on 14 Sep 2010 23:05 UTC item 8. fixed in a542d86a3d9bc7330306ecd1945798a820de017d

[modelica-trac-importer]

Comment by clauss on 21 Sep 2010 14:02 UTC 81caa24c29a2a7e4dd21cd17aa8d739e1286465c: The HTML errors fixed (usage of

...

around images, usage of
, wrong usage of

 and ,
address added at one place).
Not quite sure to have found all such errors.

Still open: bad images
            

[modelica-trac-importer]

Comment by dietmarw on 21 Sep 2010 14:57 UTC OK I had to correct some of the changes done in 81caa24c29a2a7e4dd21cd17aa8d739e1286465c. Have a look at cf3760480560b035796500daa15a31db6ff88dbb to see what I changed. Mainly it was that <pre> was exchanged by <code> which is not correct.

From the User's guide::

1. For constants, parameters and variables in code segments and should to be used, e.g., parameter Modelica.SIunits.Time tStart "Start time"
2. Write multi or single line code segments using

    and 

   .

Also there were still some missing </p> tags and text which did not reside within a paragraph and the Spice3 netlist needed to be fixed again in 56f56f20f409fc3859a42c3d87cf1a719708f577 to make it independent of the display window width.

[modelica-trac-importer]

Comment by dietmarw on 21 Sep 2010 16:31 UTC Ulf:: I finally found all the offending (and forgotten) closing </pre> tags. As of be39990e1be4b4819e9972794cba5630146eacd3 the HTML documentation should no longer have long lines. Great if you could check that version again.

[modelica-trac-importer]

Comment by dietmarw on 24 Sep 2010 11:25 UTC Item 4. has been finally fixed in f6a13a8b0647fdb068a1638b4c96293c12144dbf : 91589c1bfbeb486488893eb42500626a2acc39ee

If more documentation glitches occur a new ticket should be opened.