Ticket #6829 (closed: fixed)
Add more information to algorithm offline help pages
| Reported by: | Peter Peterson | Owned by: | Peter Peterson |
|---|---|---|---|
| Priority: | major | Milestone: | Release 2.5 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Martyn Gigg |
Description (last modified by Peter Peterson) (diff)
wiki_tools.py has gotten a fairly large upgrade since the offline help work was started. Encorporate the methods:
- get_wiki_description
- create_function_signature
into the offline help for algorithms. This may need to be reworked some to generate html.
There are mediawiki parsers written in python.
Change History
comment:1 Changed 8 years ago by Peter Peterson
- Status changed from new to accepted
- Description modified (diff)
comment:2 Changed 8 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:3 Changed 8 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:4 Changed 8 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:5 Changed 8 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:6 Changed 8 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:7 Changed 8 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:8 Changed 8 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:9 Changed 8 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:10 Changed 8 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:11 Changed 8 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:12 Changed 8 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:13 Changed 8 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:14 Changed 8 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:15 Changed 8 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:16 Changed 8 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:17 Changed 8 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:18 Changed 8 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:19 Changed 8 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:20 Changed 8 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:21 Changed 8 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:22 Changed 8 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:23 Changed 8 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:24 Changed 8 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:25 Changed 8 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:26 Changed 8 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:27 Changed 8 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:28 Changed 8 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:29 Changed 8 years ago by Peter Peterson
- Status changed from accepted to verify
- Resolution set to fixed
This is on feature/6829_qtassistant_algorithms.
To test launch the help and see that there is "usage" and "description" in the wiki. The wiki parser is very limited and doesn't support:
- wiki math markup
- wiki links
- images
comment:30 Changed 7 years ago by Martyn Gigg
- Status changed from verify to verifying
- Tester set to Martyn Gigg
comment:31 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:32 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:33 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:34 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:35 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:36 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:37 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:38 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:39 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:40 Changed 7 years ago by Martyn Gigg
- Status changed from verifying to closed
Said feature are present.
Is there any chance of getting the images & math markup working?
comment:41 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:42 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:43 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:44 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:45 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:46 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:47 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:48 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:49 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:50 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:51 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:52 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:53 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:54 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:55 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:56 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:57 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:58 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:59 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:60 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:61 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:62 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:63 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:64 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:65 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:66 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:67 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:68 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:69 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:70 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:71 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:72 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:73 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:74 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:75 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:76 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:77 Changed 7 years ago by Peter Peterson
Re #6829. Added a verbose flag to get_custom_wiki_section.
Changeset: 9952c4983dc9fb3b3bba3bfe2bbb443c71737dd1
comment:78 Changed 7 years ago by Peter Peterson
Re #6829. Added several sections to offline help for algorithms.
Specifically usage, description and a list of categories.
Changeset: 276e68192a810d76e53f47075d676c43105b4607
comment:79 Changed 7 years ago by Peter Peterson
Re #6829. Rolled my own html writing class.
Changeset: 0c94be1143148737e4423a5799bfb5173e116293
comment:80 Changed 7 years ago by Peter Peterson
Re #6829. Copied functionality from wiki_tools and remove dead code.
Changeset: a3893510f8a2fe8d362fad0d17a794d10a406d00
comment:81 Changed 7 years ago by Peter Peterson
Re #6829. Fixing wiki formatting mistake.
Changeset: d52bf14b48580745a1712173c80e25ce709ecb35
comment:82 Changed 7 years ago by Peter Peterson
Re #6829. Fixed goofy tab label and sorted algorithms.
Changeset: d064132eb0ab47629f21adf2ad803317eb7d25b1
comment:83 Changed 7 years ago by Peter Peterson
Re #6829. First pass at mediawiki parsing.
Changeset: e08646dd804b8c31ebe54e15fba0afb2aff240d0
comment:84 Changed 7 years ago by Peter Peterson
Re #6829. Added bits to parse the summary statement as mediawiki.
Changeset: 42aa70ee3112cb30b9a14d4e5931a5caacb89761
comment:85 Changed 7 years ago by Peter Peterson
Re #6829. Adding ability to specify url to HelpWindow constructor.
Changeset: 07eaa0319c165d8ba1dac4c12458167668275394
comment:86 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 7675
