Ticket #6966 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Parse equations in offline help

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: blocker Milestone: Release 2.5
Component: Mantid Keywords: qtassistant
Cc: Blocked By:
Blocking: Tester: Stuart Campbell

Description

The equations in the offline help need to get converted into images. Two things to help in that direction are this ​blog article and ​scihtmlatex on github. The idea is to create the images if enough of the required tools are present (latex toolchain and dvipng), otherwise leave the raw latex source in the output html files.

Change History

comment:1 Changed 7 years ago by Peter Peterson

  • Status changed from new to accepted

comment:2 Changed 7 years ago by Peter Peterson

Re #6966. First version of the equation parser that 'works'.

Changeset: 5a26487ca34acd45935e5bdd29b6929dc3340ff9

comment:3 Changed 7 years ago by Peter Peterson

Re #6966. Reduced the code to a more readable set.

Changeset: 6347208de2eba830d9be8998a7fdb36f39c30d6e

comment:4 Changed 7 years ago by Peter Peterson

Re #6966. Fixed latex equation errors.

Changeset: f069612aca07c4fd14e2ca8ba74c3e4fbee5cae8

comment:5 Changed 7 years ago by Peter Peterson

Re #6966. Got equations worked into the main qt-assistant build.

This will probably only work on linux right now as the paths for the tools are not introspected, but hard-coded. If they are not found you just get the regular unparsed latex in your help.

Changeset: 475a50a6b94c6d508558a5e8b592733b5ab175a9

comment:6 Changed 7 years ago by Peter Peterson

Re #6966. Fixing spelling errors.

Changeset: 2850bc37c7755be156f575b4a60f2de1473436a5

comment:7 Changed 7 years ago by Peter Peterson

Re #6966. Moving latex/dvipng config into cmake.

Changeset: e4dc987f125f77e6f54d416e2cb9f06dbacc95a6

comment:8 Changed 7 years ago by Peter Peterson

Re #6966. Removing dead guard.

Changeset: f387c3a126aee62b01668d90b9fedf2042fd73ef

comment:9 Changed 7 years ago by Peter Peterson

Merge branch 'feature/6966_qtassistant_eqns' into develop

Conflicts:

Code/Mantid/docs/qtassistant/CMakeLists.txt Code/Mantid/docs/qtassistant/mediawiki.py

Re #6966

Changeset: b3880d7e99430abc4945a68f8b75e5757b69c23f

comment:10 Changed 7 years ago by Peter Peterson

Re #6966. Use the output directory as a temp directory.

Changeset: c51b189b2b3e2938401d08687c9b51e97391f80f

comment:11 Changed 7 years ago by Peter Peterson

Re #6966. Use the output directory as a temp directory.

Changeset: c51b189b2b3e2938401d08687c9b51e97391f80f

comment:12 Changed 7 years ago by Peter Peterson

  • Status changed from accepted to verify
  • Resolution set to fixed

This is in ​feature/6966_qtassistant_eqns.

To test:

  1. Install latex and dvipng
  2. Rerun cmake
  3. Build
  4. Look at help pages that you know have equations

This should give the previous help pages if you don't have latex AND dvipng installed.

comment:13 Changed 7 years ago by Stuart Campbell

  • Status changed from verify to verifying
  • Tester set to Stuart Campbell

comment:14 Changed 7 years ago by Stuart Campbell

  • Status changed from verifying to closed

I indeed get equations - although I had to make sure I 'touched' a relevant file in order for the qt-assistant to re-run after installing the required packages.

comment:15 Changed 7 years ago by Peter Peterson

Re #6966. First version of the equation parser that 'works'.

Changeset: 5a26487ca34acd45935e5bdd29b6929dc3340ff9

comment:16 Changed 7 years ago by Peter Peterson

Re #6966. Reduced the code to a more readable set.

Changeset: 6347208de2eba830d9be8998a7fdb36f39c30d6e

comment:17 Changed 7 years ago by Peter Peterson

Re #6966. Fixed latex equation errors.

Changeset: f069612aca07c4fd14e2ca8ba74c3e4fbee5cae8

comment:18 Changed 7 years ago by Peter Peterson

Re #6966. Got equations worked into the main qt-assistant build.

This will probably only work on linux right now as the paths for the tools are not introspected, but hard-coded. If they are not found you just get the regular unparsed latex in your help.

Changeset: 475a50a6b94c6d508558a5e8b592733b5ab175a9

comment:19 Changed 7 years ago by Peter Peterson

Re #6966. Fixing spelling errors.

Changeset: 2850bc37c7755be156f575b4a60f2de1473436a5

comment:20 Changed 7 years ago by Peter Peterson

Re #6966. Moving latex/dvipng config into cmake.

Changeset: e4dc987f125f77e6f54d416e2cb9f06dbacc95a6

comment:21 Changed 7 years ago by Peter Peterson

Re #6966. Removing dead guard.

Changeset: f387c3a126aee62b01668d90b9fedf2042fd73ef

comment:22 Changed 7 years ago by Peter Peterson

Re #6966. Use the output directory as a temp directory.

Changeset: c51b189b2b3e2938401d08687c9b51e97391f80f

comment:23 Changed 7 years ago by Peter Peterson

Re #6966. First version of the equation parser that 'works'.

Changeset: 5a26487ca34acd45935e5bdd29b6929dc3340ff9

comment:24 Changed 7 years ago by Peter Peterson

Re #6966. Reduced the code to a more readable set.

Changeset: 6347208de2eba830d9be8998a7fdb36f39c30d6e

comment:25 Changed 7 years ago by Peter Peterson

Re #6966. Fixed latex equation errors.

Changeset: f069612aca07c4fd14e2ca8ba74c3e4fbee5cae8

comment:26 Changed 7 years ago by Peter Peterson

Re #6966. Got equations worked into the main qt-assistant build.

This will probably only work on linux right now as the paths for the tools are not introspected, but hard-coded. If they are not found you just get the regular unparsed latex in your help.

Changeset: 475a50a6b94c6d508558a5e8b592733b5ab175a9

comment:27 Changed 7 years ago by Peter Peterson

Re #6966. Fixing spelling errors.

Changeset: 2850bc37c7755be156f575b4a60f2de1473436a5

comment:28 Changed 7 years ago by Peter Peterson

Re #6966. Moving latex/dvipng config into cmake.

Changeset: e4dc987f125f77e6f54d416e2cb9f06dbacc95a6

comment:29 Changed 7 years ago by Peter Peterson

Re #6966. Removing dead guard.

Changeset: f387c3a126aee62b01668d90b9fedf2042fd73ef

comment:30 Changed 7 years ago by Peter Peterson

Re #6966. Use the output directory as a temp directory.

Changeset: c51b189b2b3e2938401d08687c9b51e97391f80f

comment:31 Changed 7 years ago by Peter Peterson

Re #6966. First version of the equation parser that 'works'.

Changeset: 5a26487ca34acd45935e5bdd29b6929dc3340ff9

comment:32 Changed 7 years ago by Peter Peterson

Re #6966. Reduced the code to a more readable set.

Changeset: 6347208de2eba830d9be8998a7fdb36f39c30d6e

comment:33 Changed 7 years ago by Peter Peterson

Re #6966. Fixed latex equation errors.

Changeset: f069612aca07c4fd14e2ca8ba74c3e4fbee5cae8

comment:34 Changed 7 years ago by Peter Peterson

Re #6966. Got equations worked into the main qt-assistant build.

This will probably only work on linux right now as the paths for the tools are not introspected, but hard-coded. If they are not found you just get the regular unparsed latex in your help.

Changeset: 475a50a6b94c6d508558a5e8b592733b5ab175a9

comment:35 Changed 7 years ago by Peter Peterson

Re #6966. Fixing spelling errors.

Changeset: 2850bc37c7755be156f575b4a60f2de1473436a5

comment:36 Changed 7 years ago by Peter Peterson

Re #6966. Moving latex/dvipng config into cmake.

Changeset: e4dc987f125f77e6f54d416e2cb9f06dbacc95a6

comment:37 Changed 7 years ago by Peter Peterson

Re #6966. Removing dead guard.

Changeset: f387c3a126aee62b01668d90b9fedf2042fd73ef

comment:38 Changed 7 years ago by Peter Peterson

Re #6966. Use the output directory as a temp directory.

Changeset: c51b189b2b3e2938401d08687c9b51e97391f80f

comment:39 Changed 7 years ago by Stuart Campbell

Merge branch 'feature/7015_update_dev_rpm' into develop into 6856_ConvertToDiffractionMDWS_v2

comment:40 Changed 7 years ago by Stuart Campbell

Merge branch 'feature/7015_update_dev_rpm' into develop into 6856_ConvertToDiffractionMDWS_v2

comment:41 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7812

Note: See TracTickets for help on using tickets.