Ticket #7022 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Dialog images in offline documentation

Reported by: Owen Arnold Owned by: Owen Arnold
Priority: major Milestone: Release 2.5
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: #7023 Tester: Martyn Gigg

Description

Would be good to get algorithm dialog images into the offline documentation.

Change History

comment:1 Changed 7 years ago by Owen Arnold

  • Blocking 7023 added

comment:2 Changed 7 years ago by Owen Arnold

refs #7022. Download and use dialog image.

Changeset: 12a152df041dac9f077af81ca7cdb330fa739c1b

comment:3 Changed 7 years ago by Peter Peterson

I agree with making it a cmake variable. Why don't you also look at ​fetchimg.py to do some of the lifting for you. Please make sure that downloading the images is configurable so it doesn't happen for everybody during every build.

comment:4 Changed 7 years ago by Owen Arnold

refs #7022. Download and use dialog image.

Changeset: 12a152df041dac9f077af81ca7cdb330fa739c1b

comment:5 Changed 7 years ago by Owen Arnold

refs #7022. Make download an optional part of build

Changeset: 0ba5d12fcb3f29b20f9678df07040671de07eca1

comment:6 Changed 7 years ago by Owen Arnold

refs #7022. Merge master into branch.

Changeset: 1a04edbcfec410880dd279b56f34c4d12138ada7

comment:7 Changed 7 years ago by Owen Arnold

refs #7022. Make download an optional part of build

Changeset: 0ba5d12fcb3f29b20f9678df07040671de07eca1

comment:8 Changed 7 years ago by Owen Arnold

refs #7022. Merge master into branch.

Changeset: 1a04edbcfec410880dd279b56f34c4d12138ada7

comment:9 Changed 7 years ago by Owen Arnold

  • Status changed from new to accepted

comment:10 Changed 7 years ago by Owen Arnold

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

Tester:

You should have a new CMake variable QT_ASSISTANT_FETCH_IMAGES (advanced), this should default to off.

The following testing steps need to be performed at ISIS.

  • Make the documentation with this in it's default off state, and note that the algorithm documentation does not contain any screenshots.
  • Turn it on, and repeat, and again, no screenshots should appear in the documentation.
  • Repeat again, ensuring that the cmake variable is set to on, but this time set the environment variable http_proxy to "​http://wwwcache.rl.ac.uk:8080" prior to the build. Now you should have downloaded dialog images which are linked in the help pages for each of the algorithms.

comment:11 Changed 7 years ago by Owen Arnold

branch is feature/7022_alg_dialogs

comment:12 Changed 7 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

comment:13 Changed 7 years ago by Martyn Gigg

  • Status changed from verifying to closed

comment:14 Changed 7 years ago by Owen Arnold

refs #7022. Download and use dialog image.

Changeset: 12a152df041dac9f077af81ca7cdb330fa739c1b

comment:15 Changed 7 years ago by Owen Arnold

refs #7022. Make download an optional part of build

Changeset: 0ba5d12fcb3f29b20f9678df07040671de07eca1

comment:16 Changed 7 years ago by Owen Arnold

refs #7022. Merge master into branch.

Changeset: 1a04edbcfec410880dd279b56f34c4d12138ada7

comment:17 Changed 7 years ago by Martyn Gigg

  • Status changed from closed to reopened
  • Resolution fixed deleted

comment:18 Changed 7 years ago by Owen Arnold

  • Status changed from reopened to accepted

Using absolute paths for the image is probably wrong. I'm going to use relative paths instead. That way I shouldn't see the problems with packaged mantid that I've been seeing.

comment:19 Changed 7 years ago by Owen Arnold

refs #7022. Use relative paths fix.

Changeset: b67629eb69ead547379966d48ebb89b998eb3068

comment:20 Changed 7 years ago by Owen Arnold

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

comment:21 Changed 7 years ago by Martyn Gigg

  • Status changed from verify to verifying

comment:22 Changed 7 years ago by Owen Arnold

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Still a bug in this. Don't test yet.

comment:23 Changed 7 years ago by Owen Arnold

  • Status changed from reopened to accepted

comment:24 Changed 7 years ago by Owen Arnold

refs #7022. Fix to not disabling image download properly.

Changeset: 2f9a22b4b2cf1d1f656264a969c0e9a150c9479b

comment:25 Changed 7 years ago by Owen Arnold

refs #7022. Fix to not disabling image download properly.

Changeset: 2f9a22b4b2cf1d1f656264a969c0e9a150c9479b

comment:26 Changed 7 years ago by Martyn Gigg

Add dialog images to qhp file reference.

If they are not listed in this file then they don't show up even if the link looks correct. Refs #7022

Changeset: 82be8dfaa4099cd4f4c59216281cf264017692ca

comment:27 Changed 7 years ago by Martyn Gigg

Add dialog images to qhp file reference.

If they are not listed in this file then they don't show up even if the link looks correct. Refs #7022

Changeset: 82be8dfaa4099cd4f4c59216281cf264017692ca

comment:28 Changed 7 years ago by Martyn Gigg

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

comment:29 Changed 7 years ago by Martyn Gigg

  • Owner changed from Owen Arnold to Martyn Gigg
  • Status changed from verify to assigned
  • Tester Martyn Gigg deleted

comment:30 Changed 7 years ago by Martyn Gigg

Fix for when not downloading. Refs #7022

Changeset: f0da4ccb63f7a76804b3452de320ef5df7ab2202

comment:31 Changed 7 years ago by Martyn Gigg

Fix for when not downloading. Refs #7022

Changeset: f0da4ccb63f7a76804b3452de320ef5df7ab2202

comment:32 Changed 7 years ago by Martyn Gigg

  • Status changed from assigned to accepted

comment:33 Changed 7 years ago by Martyn Gigg

  • Status changed from accepted to verify

comment:34 Changed 7 years ago by Owen Arnold

  • Status changed from verify to reopened
  • Resolution fixed deleted

comment:35 Changed 7 years ago by Owen Arnold

refs #7022. Paths separators incorrect.

Changeset: 30c6e57a38c1b8485814678d33f2c9aea8776c92

comment:36 Changed 7 years ago by Owen Arnold

refs #7022. Try different separator.

Changeset: ebe30f180121faa7670486fff6b26e9c0c3c20df

comment:37 Changed 7 years ago by Owen Arnold

refs #7022. Paths separators incorrect.

Changeset: 30c6e57a38c1b8485814678d33f2c9aea8776c92

comment:38 Changed 7 years ago by Owen Arnold

refs #7022. Try different separator.

Changeset: ebe30f180121faa7670486fff6b26e9c0c3c20df

comment:39 Changed 7 years ago by Owen Arnold

  • Owner changed from Martyn Gigg to Owen Arnold
  • Status changed from reopened to accepted

comment:40 Changed 7 years ago by Owen Arnold

This seems to be working correctly now -finally. I checked that the images were turning up on the packaged/deployed dev build on win7, and works ok.

comment:41 Changed 7 years ago by Owen Arnold

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

comment:42 Changed 7 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

I'll double check and recheck it on linux.

comment:43 Changed 7 years ago by Owen Arnold

refs #7022. Use relative paths fix.

Changeset: b67629eb69ead547379966d48ebb89b998eb3068

comment:44 Changed 7 years ago by Owen Arnold

refs #7022. Fix to not disabling image download properly.

Changeset: 2f9a22b4b2cf1d1f656264a969c0e9a150c9479b

comment:45 Changed 7 years ago by Martyn Gigg

Add dialog images to qhp file reference.

If they are not listed in this file then they don't show up even if the link looks correct. Refs #7022

Changeset: 82be8dfaa4099cd4f4c59216281cf264017692ca

comment:46 Changed 7 years ago by Martyn Gigg

Fix for when not downloading. Refs #7022

Changeset: f0da4ccb63f7a76804b3452de320ef5df7ab2202

comment:47 Changed 7 years ago by Owen Arnold

refs #7022. Paths separators incorrect.

Changeset: 30c6e57a38c1b8485814678d33f2c9aea8776c92

comment:48 Changed 7 years ago by Owen Arnold

refs #7022. Try different separator.

Changeset: ebe30f180121faa7670486fff6b26e9c0c3c20df

comment:49 Changed 7 years ago by Martyn Gigg

  • Status changed from verifying to closed

Looks good. All of the various switches do the appropriate thing so that devs can turn stuff off.

comment:50 Changed 7 years ago by Owen Arnold

refs #7022. Download and use dialog image.

Changeset: 12a152df041dac9f077af81ca7cdb330fa739c1b

comment:51 Changed 7 years ago by Owen Arnold

refs #7022. Make download an optional part of build

Changeset: 0ba5d12fcb3f29b20f9678df07040671de07eca1

comment:52 Changed 7 years ago by Owen Arnold

refs #7022. Merge master into branch.

Changeset: 1a04edbcfec410880dd279b56f34c4d12138ada7

comment:53 Changed 7 years ago by Owen Arnold

refs #7022. Use relative paths fix.

Changeset: b67629eb69ead547379966d48ebb89b998eb3068

comment:54 Changed 7 years ago by Owen Arnold

refs #7022. Fix to not disabling image download properly.

Changeset: 2f9a22b4b2cf1d1f656264a969c0e9a150c9479b

comment:55 Changed 7 years ago by Martyn Gigg

Add dialog images to qhp file reference.

If they are not listed in this file then they don't show up even if the link looks correct. Refs #7022

Changeset: 82be8dfaa4099cd4f4c59216281cf264017692ca

comment:56 Changed 7 years ago by Martyn Gigg

Fix for when not downloading. Refs #7022

Changeset: f0da4ccb63f7a76804b3452de320ef5df7ab2202

comment:57 Changed 7 years ago by Owen Arnold

refs #7022. Paths separators incorrect.

Changeset: 30c6e57a38c1b8485814678d33f2c9aea8776c92

comment:58 Changed 7 years ago by Owen Arnold

refs #7022. Try different separator.

Changeset: ebe30f180121faa7670486fff6b26e9c0c3c20df

comment:59 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7868

Note: See TracTickets for help on using tickets.