Ticket #10711 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Replace Indirect Wiki pages with RST files using the interface directive

Reported by: Dan Nixon Owned by: Dan Nixon
Priority: major Milestone: Release 3.4
Component: Documentation Keywords:
Cc: Blocked By: #10863
Blocking: #10960 Tester: Harry Jeffery

Description

The Wiki pages for indirect are far from perfect and a pain to keep up to date, since there is some nice functionality for making custom interface documentation in the same way as algorithms, etc. this should be used instead, especially since this means the documentation will be available offline.

Links to the new help pages should be added on the current Wiki pages and the "?" buttons on the interfaces replaced to open the Qt help.

Change History

comment:1 Changed 6 years ago by Dan Nixon

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Dan Nixon

  • Milestone changed from Backlog to Release 3.4

comment:3 Changed 6 years ago by Dan Nixon

  • Summary changed from Replace Indirect documentation RST files using the interface directive to Replace Indirect Wiki pages with RST files using the interface directive

comment:4 Changed 6 years ago by Dan Nixon

  • Status changed from assigned to inprogress

Added initial indirect pages

Refs #10711

Changeset: b6c0dedd50e9fc8535ac30d93ad2a034cd1509cc

comment:5 Changed 6 years ago by Dan Nixon

Use correct catagory

Refs #10711

Changeset: c1be4638888a51b5bcb650e92ab47bcaaeaa6eda

comment:6 Changed 6 years ago by Dan Nixon

Add ability to open an interface page from HelpWindow

Refs #10711

Changeset: f27f1ec5a548feccc648bf3262a1b71718346520

comment:7 Changed 6 years ago by Dan Nixon

Remove old help code, add Tools page

Refs #10711

Changeset: bbfc3b40d0193bc9f7ee39fa936db6b4ab356e1f

comment:8 Changed 6 years ago by Dan Nixon

Allow the interface directive to take a width param

Refs #10711

Changeset: fd8b5dbf751b9c3ed3b1c241ec459ed1b00285d7

comment:9 Changed 6 years ago by Dan Nixon

Started adding docs to IDR

Refs #10711

Changeset: 7c59fca5ef972b8352079571a1d68f91297f9c98

comment:10 Changed 6 years ago by Dan Nixon

Start adding Bayes documentation

Refs #10711

Changeset: 406e57f58af31d4ee331f1eb83d546db7fe588ed

comment:11 Changed 6 years ago by Dan Nixon

Added docs for Bayes and IDR

Refs #10711

Changeset: e571acf9c414904eb1698d4fae54972c12a272b3

comment:12 Changed 6 years ago by Dan Nixon

Document diffraction and simulation, start on IDA

Refs #10711

Changeset: 91477f017a7408e788530dc5c21d7fee0bcc1421

comment:13 Changed 6 years ago by Dan Nixon

  • Blocked By 10863 added

This widget fixes issues creating screenshots of tools interface.

comment:14 Changed 6 years ago by Dan Nixon

Formatting and links, added Tools docs

Refs #10711

Changeset: 0a506d22d99299f41310a428c147d18e211807b2

comment:15 Changed 6 years ago by Dan Nixon

Correct UI issues giving strage screenshots, more formatting

Refs #10711

Changeset: 0ba1f6afda9d494b9e0146755780961d02ced164

comment:16 Changed 6 years ago by Dan Nixon

Fix angstrom symbol on Tools

Refs #10711

Changeset: fe21863bd97e0dfa2382532dfce8943913660a49

comment:17 Changed 6 years ago by Dan Nixon

Merge branch 'master' into feature/10711_indirect_ui_documentation

Refs #10711

Changeset: 2c9896fd68b26ecd5dfab1b93a42ad4d00a24ee3

comment:18 Changed 6 years ago by Dan Nixon

Re add the tools screenshots, fix one final build issue

Refs #10711

Changeset: 275e9c159c4404c58115deac67d9d37c99d2a9ff

comment:19 Changed 6 years ago by Dan Nixon

To test:

  • Verify documentation builds correctly
  • See that the "?" button on indirect interfaces opens the local documentation
  • Verify the documentation is an accurate description of the interface

comment:20 Changed 6 years ago by Dan Nixon

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

comment:21 Changed 6 years ago by Dan Nixon

  • Blocking 10960 added

comment:22 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying
  • Tester set to Harry Jeffery

comment:23 Changed 6 years ago by Harry Jeffery

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Some minor issues:

  • Indirect Bayes - Quasi
    • The model that is being fitted is that of a δ-function - Presumably that should be δ or Δ
    • So /sigma is identified with - Should that be Σ?
  • Indirect Data Analysis
    • Conv Fit
      • Theory section says TODO
    • Calculate Corrections
      • Screenshot is very glitchy - widgets are squished.
      • Sample Details and Theory sections say TODO
  • Indirect Diffraction
    • OSIRIS diffonly screenshot has a very large amount of whitespace around the widgets for some reason

comment:24 Changed 6 years ago by Dan Nixon

The fixes for the calc corr UI will be done in #10960.

Edit: fixed in this ticket.

Last edited 6 years ago by Dan Nixon (previous) (diff)

comment:25 Changed 6 years ago by Dan Nixon

  • Status changed from reopened to inprogress

Fix theory descriptions for IDA

Refs #10711

Changeset: 8827f43b1c4dec24716dd32ccb1b18a9fa2d8f08

comment:26 Changed 6 years ago by Dan Nixon

adjustSize widgets before a screen shot

Existing algorithm and interface screenshots seem unaffected by this

Refs #10711

Changeset: 5f1d8c1b0cd9615f031209d19d71d3ab1bd305d1

comment:27 Changed 6 years ago by Dan Nixon

Additions to testing:

comment:28 Changed 6 years ago by Dan Nixon

Fix IDA calc corr screenshot

Refs #10711

Changeset: 9f4cd092fe5dca79a2dfeb943e70a2cde9dea305

comment:29 Changed 6 years ago by Dan Nixon

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

comment:30 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying

comment:31 Changed 6 years ago by Dan Nixon

  • Status changed from verifying to closed

Merge branch 'master' into feature/10711_indirect_ui_documentation

Refs #10711

Full changeset: 2c9896fd68b26ecd5dfab1b93a42ad4d00a24ee3

comment:32 Changed 6 years ago by Harry Jeffery

Merge remote-tracking branch 'origin/feature/10711_indirect_ui_documentation'

Full changeset: 27867f707054de3d73764a199eb1bceacb10437c

comment:33 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 11553

Note: See TracTickets for help on using tickets.