Opened 12 years ago
Last modified 7 years ago
#2205 new defect
Documentation generator needs to handle <head> and <body> sections correctly
| Reported by: | Dietmar Winkler | Owned by: | Martin Sjölund |
|---|---|---|---|
| Priority: | normal | Milestone: | Future |
| Component: | Build Environment | Version: | trunk |
| Keywords: | Cc: | Dietmar Winkler |
Description
I noticed a small problem with the documentation generation script GenerateDoc.mos:
If a model contains already a <head> ... </head> and/or <body> ... </body> section in the info layer then the resulting HTML will contain two of them. It seems that two head sections are not such a big problem but tidy does not like to have content after the </body> tag.
Now the one file that is almost always going to cause this problem is the ModelicaLicense2 class because the template has exactly this structure. Funnily enough in Modelica.UsersGuide.ModelicaLicense2 the <body> tags have been removed which means no warnings in from tidy.
Solution could look like something like this:
- look for
<head> ... </head>and if more than one then merge the content into one. At the same time only keep one<title>(otherwise there will be a warning again) - look for
<body>, keep first instance and discard all following. - look for
</body>, keep only the last instance
Change History (13)
comment:2 by , 12 years ago
The problem with trying to remove the title tag is of course that the code is not valid xml until we have run tidy on it. But we could probably look for regex <title>.*</title> anyway since that will make most problems disappear.
As for the <body> problem, wouldn't it work if we simply filtered out that warning from the tidy log?
comment:3 by , 12 years ago
The regex <title>.*</title> solution is exactly what I had in mind.
About the <body> problem, sure we could simply add another ignore to it but then again since we know what will cause the problem and since we know that no matter what, the script will add the <[/]body> tag correctly why not simply remove them on the fly if present in the info/revision layer.
comment:6 by , 10 years ago
| Milestone: | 1.9.1 → 1.9.2 |
|---|
This ticket was not closed for 1.9.1, which has now been released. It was batch modified for milestone 1.9.2 (but maybe an empty milestone was more appropriate; feel free to change it).
comment:7 by , 10 years ago
| Milestone: | 1.9.2 → 1.9.3 |
|---|
Milestone changed to 1.9.3 since 1.9.2 was released.
comment:12 by , 8 years ago
| Milestone: | 1.11.0 → 1.12.0 |
|---|
Milestone moved to 1.12.0 due to 1.11.0 already being released.
comment:13 by , 7 years ago
| Milestone: | 1.12.0 → Future |
|---|
The milestone of this ticket has been reassigned to "Future".
If you think the issue is still valid and relevant for you, please select milestone 1.13.0 for back-end, code generation and run-time issues, or 2.0.0 for front-end issues.
If you are aware that the problem is no longer present, please select the milestone corresponding to the version of OMC you used to check that, and set the status to "worksforme".
In both cases, a short informative comment would be welcome.
Actually, I forgot that tidy does most of the corrections already. The only thing that we need to do is:
<title> ... </title>and simply remove that (gets set by the script more correctly)<body>, </body>. Those get set in the script anyway.