Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New Help System #41

Merged
merged 33 commits into from Oct 20, 2011
Merged

New Help System #41

merged 33 commits into from Oct 20, 2011

Conversation

vaussard
Copy link
Member

After some discussions on the mailing list, it appeared important to update our workflow regarding the help system of Aseba Studio. It has been decided to use the wiki-based help as the main reference.

This set of patches:

  • Create a Python-based fetcher in maintainer/updatedoc/. It will recursively download the Wikidot help for the available languages, and update the doc in studio/doc/.
  • Switch to the Qt Help Framework (http://doc.qt.nokia.com/stable/qthelp-framework.html), working with specific XML descriptor files, generating binary files used by the help system.
  • Create a new viewer in Aseba Studio, leveraging the features of the previous point, enhancing the user experience with the help system. Even if this part can be greatly enhanced, it is still a major improvement over the previous system.

This will simply the documentation-related issues, like issues #14, #26, #31, and lay out the foundations for new features, like the context-aware help of issue #35.

Florian Vaussard added 30 commits October 19, 2011 16:06
Adding the wikidot parser
bf6ddaa
Integrating the python wikidot parser with Aseba Studio
e482b58
Adding CSS to aseba studio help
6da14ef
Fix the improper width attribute of <img> tags, due to Wikidot
b78b612
Adding link to the User Manual doc
da4b91d
Adding the HelpViewer class
e1a6976
Adding navigation buttons to the Help Viewer
e49a1ed
Fixing window title
2f3b9f7
Saving and restoring the state of the Help Viewer
ab31173
Adding Qt Help Project / Collection for english doc, with correspondi…
6e5a0f6 
…ng CMake rule
Integrating the QtHelp system into the Help Viewer
db26ee2
Adding multi-language flavor
0147d20
Removing old stuff
0e0c4be
Adding a shortcut for the Help Menu
272c783
Fix mistake when changing from aseba-doc-en -> aseba-doc
a07c6d3
Simplifying the help css
6539a36
Adding the generation of the Qt Help Project into the Python parser.
3dbb9d0 
The hierarchy of the pages is based on the breadcrumbs of each page.
This is used to build a tree, which is used to build the XML file.
Fixing missing charref in the title (of the French doc)
9114045
Adding an ordered set, so links are listed in the order of appearance.
a35f3df
Adding a nice title at the top of each fetched page.
b30affb
Styling a bit the stylesheet.
339771b 
Unfortunatly, some CSS properties (padding, centering) have no effect in
the QTextBrowser used to display the content... We should switch to the
QtWebKit if we want to use those properties one day :-(
Adding the TOC to the .html, when available in the wikidot.
f377f9f
Simplifying the state machine. And fixing some related issues.
ffaa872
Fix the invalid conversion of TOC links.
3cd9106
Adding a readme file with some useful information.
ad5e2af
Moving the python script to a dedicated directory.
cbbe8fa
Add a summary attribute in <table> for the TOC (HTML-tidy was complai…
a5c431f 
…ning).
Add a clever search for the help binaries.
26818b5 
The application first search for the binaries in the application's folder,
then fallback to a user-defined path. If no data found, a warning is emitted,
and the Help Viewer will appear blank.
Amending authors.txt
1875ef7
Committing the freshly fetched wikidot-documentation.
4b7462b
Florian Vaussard added 3 commits October 19, 2011 16:06
Enabling translations for some of the strings in HelpViewer.
2776759
Updating the Qt project file.
92dca30 
This is not mandatory, but needed to update the translations and handy
to work with Qt Creator.
Updating French translations.
9319d71
stephanemagnenat added a commit that referenced this pull request Oct 20, 2011
@stephanemagnenat
Merge pull request #41 from vaussard/dev_wikidot_fetch
04fffd2 
New Help System
@stephanemagnenat stephanemagnenat merged commit 04fffd2 into aseba-community:master Oct 20, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@vaussard @stephanemagnenat