Ticket #6972 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Host offline help within Mantidplot rather than QT assistant

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: major Milestone: Release 3.2
Component: Documentation Keywords: qtassistant
Cc: Blocked By: #9647
Blocking: #9680 Tester: Michael Reuter

Description (last modified by Peter Peterson) (diff)

This starts with reverting the changes of ​c409a19a80 then rewriting the urls to point at the new content layout.

The built-in widget can just be taken from ParaView. The class is pqHelpWindow.

Change History

comment:1 Changed 7 years ago by Peter Peterson

  • Keywords qtassistant added

comment:2 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:3 Changed 7 years ago by Peter Peterson

  • Milestone changed from Release 2.6 to Backlog

comment:4 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

Bulk move to assigned at the introduction of the triage step

comment:5 Changed 6 years ago by Nick Draper

  • Description modified (diff)
  • Summary changed from Get qt-assistant working on mac to Host offline help within Mantidplot rather than QT assistant

comment:6 Changed 6 years ago by Peter Peterson

  • Component changed from Framework to Documentation

comment:7 Changed 6 years ago by Peter Peterson

  • Description modified (diff)
  • Milestone changed from Backlog to Release 3.2

comment:8 Changed 6 years ago by Peter Peterson

  • Blocked By 9647 added

comment:9 Changed 6 years ago by Peter Peterson

  • Blocking 9680 added

comment:10 Changed 6 years ago by Pete Peterson

  • Status changed from assigned to inprogress

Re #6972. Adding in ParaView's pqHelpWindow.

Changeset: da5f1ff7b2c4c631673ba2bf477e6869264b1a96

comment:11 Changed 6 years ago by Pete Peterson

Re #6972. Brining back old HelpWindow implementation.

Changeset: d456a4a3b5d5135b159b72b0e82604a18274541b

comment:12 Changed 6 years ago by Pete Peterson

Re #6972. Fixing compile error.

Changeset: bc30309f24974b3667638b9bf78945d4114e885c

comment:13 Changed 6 years ago by Pete Peterson

Re #6972. Fixing where collection file is.

Changeset: b405b547f31c7ca7a847aca159506adcfb7ef4c7

comment:14 Changed 6 years ago by Pete Peterson

Re #6972. Fixing links for algorithms and index pags.

Changeset: 3d2ea8ed7934f26536febf2408a79ffaa8f63751

comment:15 Changed 6 years ago by Pete Peterson

Re #6972. Moving files about to make way for adding an interface.

Changeset: 436056bb3e9f640bb1c43fc32754180d48162d48

comment:16 Changed 6 years ago by Pete Peterson

Re #6972. Moving classes to make way for backage dependencies.

Changeset: df79851689a215ab412dabb66dddf76d0290c548

comment:17 Changed 6 years ago by Pete Peterson

Re #6972. Added registration method for the help window.

This was to get around all the wackyness of package dependencies. This is checkpointing work before actually bringing up the help window.

Changeset: 6c980a2625cc3e3bb8c099a377c54d3886d31a54

comment:18 Changed 6 years ago by Pete Peterson

Re #6972. Adding implementation in HelpWindow.

Changeset: 2dcef450c9980824fdfdc5b9d1dfb5e750b712ce

comment:19 Changed 6 years ago by Pete Peterson

Re #6972. First pass at using the internal help widget.

Changeset: a751ba8d8f6ef1cd2c1fa39b1b95f1f396d7bbe1

comment:20 Changed 6 years ago by Pete Peterson

Re #6972. Removing qt-assistant as an external call.

Changeset: efd0522fbff461ce79345834960d61f41b4eeee8

comment:21 Changed 6 years ago by Pete Peterson

Re #6972. Changed QHelpEngine into a static variable.

Changeset: 6d5a8a251e036cb83554e85d5c10069cc47bb2c7

comment:22 Changed 6 years ago by Pete Peterson

Re #6972. Changing help engine to be a transient thing.

Changeset: 2c56bd866945bea54e96925dcf3d96b1778e935a

comment:23 Changed 6 years ago by Pete Peterson

Re #6972. Changed to forward declares.

Changeset: 9434148436ef8c1cee841520947c028bdad3005c

comment:24 Changed 6 years ago by Pete Peterson

Re #6972. Changed much of the help stuff to be QWidgets.

Changeset: c79364e1c5f9a62dda7349d23a636992e9727d51

comment:25 Changed 6 years ago by Pete Peterson

Re #6972. Connecting shutdown to close the window.

Changeset: d162ec76535ef8537e2bf8e5fdc931f77d301d88

comment:26 Changed 6 years ago by Pete Peterson

Re #6972. Connected the shutdown signals.

Changeset: 43472b0717c47b320f21aa9bcc4473c5f5ea2753

comment:27 Changed 6 years ago by Pete Peterson

Re #6972. Removing unused function.

Changeset: 9dbda6deedfd1f9c7528f3aa4cee4aa492c0e5a7

comment:28 Changed 6 years ago by Pete Peterson

Re #6972. Got rid of segfault on close.

Changeset: c67e02894673ac190bd1f90dc23c83d3dcd4e875

comment:29 Changed 6 years ago by Pete Peterson

Re #6972. Clearing out doxygen warnings.

Changeset: d35513040001b35d48a1007ff9e43b023183545e

comment:30 Changed 6 years ago by Pete Peterson

Re #6972. Fixing doxygen link.

Changeset: 3d1542bfa5a0a0950ed755a75c7ada8cd7d53abf

comment:31 Changed 6 years ago by Pete Peterson

Re #6972. Only window builds appear to need the includes.

Changeset: 03c6488a50c0ba4d515d7d1344a980d45227c8c8

comment:32 Changed 6 years ago by Pete Peterson

Re #6972. Parent widget is now required in help system.

Changeset: 2b6ff2630495e696a528c11ab03aa34843e77175

comment:33 Changed 6 years ago by Pete Peterson

Re #6972. Connected index widget to browser widget.

Changeset: 54476d9cef8c2d1be04f96b179ad0e19543bdfb3

comment:34 Changed 6 years ago by Pete Peterson

Re #6972. Explicitly creating a cache file.

Changeset: 94378bd7129903ced5f0f317ec375683782bc2d5

comment:35 Changed 6 years ago by Martyn Gigg

Testing on Mac:

The good news is that window shows up. The bad news is that it's still empty.

comment:36 Changed 6 years ago by Martyn Gigg

It looks like it finds the collection file correctly. This is the results log after clicking "Algorithm Descriptions" in the Help menu 

Welcome to Mantid version 3.1.20140623.1845 - Manipulation and Analysis Toolkit for Instrument Data
Please cite Mantid in your publications using: http://dx.doi.org/10.5286/Software/Mantid
Trying "/Applications/MantidPlot.app/Contents/MacOS/MantidProject.qhc"
Trying "/Applications/MantidPlot.app/Contents/MacOS/qthelp/MantidProject.qhc"
Trying "/Applications/MantidPlot.app/Contents/MacOS/../docs/qthelp/MantidProject.qhc"
Trying "/Applications/MantidPlot.app/Contents/MacOS/../share/doc/MantidProject.qhc"
Using collection file "/Applications/MantidPlot.app/Contents/MacOS/../../share/doc/MantidProject.qhc"
Loading /Applications/MantidPlot.app/Contents/MacOS/../../share/doc/MantidProject.qhc
Making local cache copy for saving information at /Users/mantid/Library/Application Support/mantidproject/MantidProject.qhc
open help window for "qthelp://org.mantidproject/doc/algorithms/index.html"

comment:37 Changed 6 years ago by Martyn Gigg

I had a look at the "/Users/mantid/Library/Application\ Support/mantidproject/" directory and it appears to be empty. Is that correct?

comment:38 Changed 6 years ago by Martyn Gigg

I tried copying the qhc file in there manually and restarted MantidPlot. It looked like something was happening but then MantidPlot crashed

comment:39 Changed 6 years ago by Pete Peterson

Re #6972. Connecting warnings of help engine to logging.

Changeset: 26c166e89fe7671c25ad7ee58da6137d9c40f878

comment:40 Changed 6 years ago by Pete Peterson

Re #6972. Adding qt-sqlite plugins for mac packaging.

Changeset: b1af40733df97bff11afe698ab60c0ce729f2a23

comment:41 Changed 6 years ago by Pete Peterson

Re #6972. Log if copying qcollection file failed.

Changeset: 3c8f9852de71a35031aaa8039d076c583937ce8c

comment:42 Changed 6 years ago by Pete Peterson

Re #6972. Changed what renders the pages to be a QTextBrowser.

Changeset: d9192901a7f2cc863b0107f5602a1999093f0171

comment:43 Changed 6 years ago by Martyn Gigg

Update collection fie search locs for windows builds.

Refs #6972

Changeset: 7852276812d1a109f68fba4a9054a7dde6421d53

comment:44 Changed 6 years ago by Martyn Gigg

Fix ambiguous overload build errors

Refs #6972

Changeset: 7351899acc0fbf2f1192c6bfea95f472733d7184

comment:45 Changed 6 years ago by Pete Peterson

Re #6972. Got search working on big cleanup.

Changeset: 538e0139b8a522d2e7bed2838c6f9ba710f294d4

comment:46 Changed 6 years ago by Pete Peterson

Re #6972. Went back to QWebView for rendering pages.

Changeset: eda478bf8f73ba719567bac521087dbc410a33b6

comment:47 Changed 6 years ago by Pete Peterson

Re #6972. Fixed the window title.

Changeset: dd9dff6c0a01023021858e216b4688998bf5a6e2

comment:48 Changed 6 years ago by Peter Peterson

This is on ​feature/6972_offlinehelp_integration.

To test:

  • Try one of the packages from a ​clean develop build and see that the help button brings up something.
  • The search box inside the webpage is broken, but everything else *should* work. All of the smaller issues should be new tickets following on from this one.

comment:49 Changed 6 years ago by Peter Peterson

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

comment:50 Changed 6 years ago by Martyn Gigg

Ubuntu 12.04 looks good.

comment:51 Changed 6 years ago by Michael Reuter

RHEL6 looks fine.

comment:52 Changed 6 years ago by Michael Reuter

Windows is fine except the category links aren't formatted properly. They do work however.

comment:53 Changed 6 years ago by Michael Reuter

OSX looks fine too.

comment:54 Changed 6 years ago by Michael Reuter

  • Status changed from verify to verifying
  • Tester set to Michael Reuter

comment:55 Changed 6 years ago by Michael Reuter

  • Status changed from verifying to closed

Merge remote branch 'origin/feature/6972_offlinehelp_integration'

Full changeset: ​555cb08581dad4b03d43985f11ea69ce1a36ccde

comment:56 Changed 6 years ago by Martyn Gigg

Just a note: The problem with the windows category links is fixed in #9757

comment:57 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7818

Note: See TracTickets for help on using tickets.