Archived issue #0028038
Incorrect documentation generated for "user guides/BRep Format"
Description
It was found that "BRep Format" document contains a lot of TEX formulas. For some strange reason images have not been generated. The example below demonstrates such situation.
\( f_{1}\; f_{2}\; f_{3}\; f_{4}\; f_{5}\; f_{6}\; f_{7} \) <flag>s \( f_{i}\;(1\leq i \leq 7) \)
\( f_{1}\; f_{2}\; f_{3}\; f_{4}\; f_{5}\; f_{6}\; f_{7} \) <flag>s \( f_{i}\;(1\leq i \leq 7) \)
Steps to reproduce
Open https://dev.opencascade.org/doc/overview/html/occt_dev_guides__documentation.html and check that the formulae at the end of the document are rendered correctly
Public activity
6 archived notes
Participants are labeled by their role within this record.
Apparently the problem is that MathJax does not load properly.
The problem exists only for documentation that is located on our servers, including docs for previous releases, e.g.:
https://dev.opencascade.org/doc/overview/html/occt_dev_guides__documentation.html
https://www.opencascade.com/doc/occt-6.7.0/overview/html/dev_guides__documentation.html
(examples of formulae are put at the end of this document).
There is no such problem in documentation local documentation included with official release (installer) or generated from code.
I could not find any difference between HTML code of the documentation from server against local version (apart of URLs). Hence, the problem seems to be most likely in server settings / configuration. Please investigate this.
As a first step, I suggest copying docs back from server to local station and checking if the problem appears.
The problem exists only for documentation that is located on our servers, including docs for previous releases, e.g.:
https://dev.opencascade.org/doc/overview/html/occt_dev_guides__documentation.html
https://www.opencascade.com/doc/occt-6.7.0/overview/html/dev_guides__documentation.html
(examples of formulae are put at the end of this document).
There is no such problem in documentation local documentation included with official release (installer) or generated from code.
I could not find any difference between HTML code of the documentation from server against local version (apart of URLs). Hence, the problem seems to be most likely in server settings / configuration. Please investigate this.
As a first step, I suggest copying docs back from server to local station and checking if the problem appears.
This is because out websites moved to HTTPS, while the documentation contains links to external HTTP resources (MathJax), that is insecure from the the point of view of browsers.
It is always better to load external resources via HTTPS, if available.
Thus could you please take care of this in next releases. Another way is to deliver documentation with local versions of external .js libraries.
As for the old versions of documentation on the server, I will replace all links:
http://cdn.mathjax.org/mathjax/latest/MathJax.js
with the HTTPS ones:
https://cdn.mathjax.org/mathjax/latest/MathJax.js
It is always better to load external resources via HTTPS, if available.
Thus could you please take care of this in next releases. Another way is to deliver documentation with local versions of external .js libraries.
As for the old versions of documentation on the server, I will replace all links:
http://cdn.mathjax.org/mathjax/latest/MathJax.js
with the HTTPS ones:
https://cdn.mathjax.org/mathjax/latest/MathJax.js
Branch [archived branch] has been created by Participant.
[revision removed]
Detailed log of new commits:
Author: aiv
Date: Mon Nov 21 18:23:28 2016 +0300
0028038: Incorrect documentation generated for "user guides/BRep Format"
References to external MathJax.js library were changed from HTTP to HTTPS alternative.
[revision removed]
Detailed log of new commits:
Author: aiv
Date: Mon Nov 21 18:23:28 2016 +0300
0028038: Incorrect documentation generated for "user guides/BRep Format"
References to external MathJax.js library were changed from HTTP to HTTPS alternative.
Hi Andrey,
I fixed references to MathJax.js on www.opencascade.com/doc/...
I see no impact if references will be updated everywhere, so please find the corresponding changes in the CR28038 branch as well.
As for updating documentation on dev.opencascade.org - it is yours.
I fixed references to MathJax.js on www.opencascade.com/doc/...
I see no impact if references will be updated everywhere, so please find the corresponding changes in the CR28038 branch as well.
As for updating documentation on dev.opencascade.org - it is yours.
Reviewed and checked; please integrate (no testing is needed)
Branch [archived branch] has been deleted by Participant.
[revision removed]
[revision removed]