Ticket #9761 (closed: fixed)
Fix header links in offline help
Reported by: | Peter Peterson | Owned by: | Martyn Gigg |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Keith Brown |
Description
Remove:
- Home
- Download
- Documentation
- Search (which doesn't work without javascript)
Change "Contact Us" to just open an appropriate "mailto:" link
Change History
comment:3 Changed 6 years ago by Martyn Gigg
- Status changed from assigned to inprogress
Allow a Sphinx conf file to be configured based on the builder.
This gives greater flexibility in configuring the generated output for each builder type. At this point the output is the same as it was for the single conf file case. Refs #9761
Changeset: 6373d319ac049b971793b560b41cc13f969ed1d4
comment:4 Changed 6 years ago by Martyn Gigg
Turn off the fixed navigation bar.
It now only appears when you are looking at the top of the page. This has the side effect that when the bar itself increases in height then the rest of the page content is pushed down as expected. Refs #9761
Changeset: 06dffbd585ec7f7756fa456279aaaa9cabc8a289
comment:5 Changed 6 years ago by Martyn Gigg
Remove h1 top margin
The navbar already has a 20px margin-bottom so we don't need to add to that. Refs #9761
Changeset: 1663e4b30bfceceb81afc678cd3cbefbf26c53c8
comment:6 Changed 6 years ago by Martyn Gigg
Add conf-builder files as dependencies of the relevant targets.
Refs #9761
Changeset: 0deed27520c5b32efee5981feb12db28f105639c
comment:7 Changed 6 years ago by Martyn Gigg
Remove all links from the navigation bar.
It's not possible to the contact to become a mailto: link as they don't work in QtAssistant. Refs #9761
Changeset: bf7b3f4490bd5a1bf846b4fc026242d6e9cbf5c8
comment:8 Changed 6 years ago by Martyn Gigg
Remove the search box for the embedded qthelp html.
Defines a navbar html template that removes the search box when in embedded mode. Refs #9761
Changeset: 3d30b20c6ad357f4e9df3bb539c5978c7b906414
comment:9 Changed 6 years ago by Martyn Gigg
Add a dependency for the docs-* targets on the runner script.
Refs #9761
Changeset: 86d300bf7c7ea6671060ea37066de5437f81aced
comment:10 Changed 6 years ago by Martyn Gigg
Branch: feature/9761_remove_navbar_links_offline_help
Tester: Build both the html & qthelp docs targets. The navigation bar links from the standard html should still be present and correct. Open MantidPlot and look at the "Algorithm Descriptions" help. You should still see a navbar and icon but the links should be gone.
As noted in the commit in comment 7 it is not possible to use mailto: links in Qt Assistant as it doesn't understand them. There is the contact but in Help that I think is sufficient.
Another thing to note is that the navigation bar is no longer fixed to the top of the page. It is only visible when the user scrolls to the top of the page. This prevents the page title being over shadowed by the navbar when the page width shrinks too much.
comment:11 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
comment:12 Changed 6 years ago by Keith Brown
- Status changed from verify to verifying
- Tester set to Keith Brown
comment:13 Changed 6 years ago by Keith Brown
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9761_remove_navbar_links_offline_help'
Full changeset: ae69a49c401076f25d6db625376cd58ee248e76f
comment:14 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10603