View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0009146 | Taler | documentation | public | 2024-08-29 17:12 | 2024-12-13 18:15 |
| Reporter | Assigned To | oec | Resolution deadline | ||
| Implementer | Reviewer | ||||
| Release signed by | Deployed by | ||||
| Verifier | Communicator | ||||
| Data protection authority notification required | No | ||||
| CSIRT notification required | No | ||||
| Estimated effort (hours) | Actual effort (hours) | 0 | |||
| Fast-track | No | ||||
| Work package | none | ||||
| Priority | normal | Severity | major | Reproducibility | always |
| Status | closed | Resolution | fixed | ||
| Target Version | 0.14 | Fixed in Version | 0.14 | ||
| Summary | 0009146: HTML documentation does not render mathematics properly | ||||
| Description | The page at https://docs.taler.net/design-documents/024-age-restriction.html contains lots of rendered mathematic expressions, in the sense that the LaTeX source code is literally being rendered to an image, with no attempt made to typeset it. As one can imagine, this makes the document rather difficult to understand. In fact, it's worse than no processing at all, as then at least one could select the text. Presumably sphinx.ext.imgmath isn't set up properly, though I suggest using KaTeX or MathJax as their results carry greater semantic meaning in the HTML output. | ||||
| Tags | No tags attached. | ||||
| Hah, I noticed in a MM channel that Oec is solving his sphinx configuration today, so this might be the soluton of this bug, too. Let's investigate a bit further... | |
| Dear Oec, did you manage to set up your Sphinx configuration lately? Here is a Mantis ticket that deals with an implementation of rendering mathematical expressions with Sphinx on the documentation page for age restrictions (https://docs.taler.net/design-documents/024-age-restriction.html). To be frank, I cannot see any badly rendered equations on said page. Thank you for caring, @oec! Cheers, S. | |
| Mhh, math/LaTeX rendering seems to be disabled now on docs.taler.net. Instead, the LaTeX commands are shown verbatim. This is a slight improvement over the broken rendering. However, I have not done any work on this, yet, will look into it. | |
| If you think that the verbatim equations are well aligned with your own requirements, you can leave the HTML page as is. The cited paper "Zero Knowledge Age Restriction for GNU Taler" shows nicely rendered equations and should suffice (to my eyes and requirements), although it is available only at Springer. | |
| No, the current state is not acceptable, IMHO. I will try configuration changes _or_ re-writing the mathematical statements in pure text, without referring to LaTeX. | |
| With a workaround for the build system, introduced in commit c4b3ca20cbe45b42927755e8e8c6dba10424dbec, the images (now svg's) for the formulas are visisable again. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2024-08-29 17:12 | New Issue | ||
| 2024-08-29 17:12 | Status | new => assigned | |
| 2024-08-29 17:12 | Assigned To | => Stefan | |
| 2024-09-02 19:55 | Stefan | Note Added: 0023140 | |
| 2024-09-09 11:28 | Stefan | Note Added: 0023215 | |
| 2024-09-09 11:28 | Stefan | Assigned To | Stefan => oec |
| 2024-09-09 11:50 | oec | Note Added: 0023217 | |
| 2024-09-09 11:57 | Stefan | Note Added: 0023218 | |
| 2024-09-09 12:03 | oec | Note Added: 0023219 | |
| 2024-11-03 13:41 | oec | Status | assigned => informing |
| 2024-11-03 13:41 | oec | Resolution | open => fixed |
| 2024-11-03 13:41 | oec | Fixed in Version | => git (master) |
| 2024-11-03 13:41 | oec | Note Added: 0023640 | |
| 2024-12-13 00:59 | Christian Grothoff | Fixed in Version | git (master) => 0.14 |
| 2024-12-13 01:00 | Christian Grothoff | Target Version | => 0.14 |
| 2024-12-13 18:15 | Christian Grothoff | Status | informing => closed |