I wrote this blog post to show some of the
UI features provided by
DocBook WebHelp. So, following is a set of screenshots I took which which is how webhelp will look like in the next release. The next release would probably be versioned as 1.77.x. These are taken from revision r
9240 on
2012-03-16. You may download the latest snapshot from
DocBook snapshots site. You may download the latest release
here.
![](//3.bp.blogspot.com/-1a_Th_APv2g/T2SQmOU7oDI/AAAAAAAADis/DgKh4MGnYMg/s640/normal-output-page-docbook-webhelp-snapshot-r9240-blog.kasunbg.org.png) |
A chunked output page docbook webhelp. It includes a header in top with a company logo, Contents, and Search panes at left side; the real contents in the right larger section; And some minor but useful features at top-right corner. The browser is Chromium/Google Chrome 16. Click on the screenshot for a larger view. |
![](//1.bp.blogspot.com/--KJv3WqrYVM/T2SQsqMZXkI/AAAAAAAADjM/vQO-zLw5qk8/s640/without-sidebar-docbook-webhelp-r9240.png) |
You may hide/unhide the left sidebar by clicking on SIDEBAR at top-right corner in the page. Isn't that a easier way to read the contents? or do you prefer the default way? For larger monitors the effect is minimal!
|
![](//2.bp.blogspot.com/-EsiuonQ_fEE/T2SQitqT7-I/AAAAAAAADik/GgUShxu522g/s1600/left-contents-pane-docbook-webhelp-r9240.png) |
A zoomed view the Contents pane in left. This shows the Table of Contents of the documentation, broken down by chapters/sections. You can configure the number of tree levels if you think it's necessary.
|
![](//4.bp.blogspot.com/-56l311sYAgY/T2SQnI5JWzI/AAAAAAAADi0/xKg0HI7vT28/s1600/search-pane-in-left-docbook-webhelp-r9240-plain.png) |
Plain search view. You can turn on/off the Search Highlighter provided. Try it yourself! |
![](//2.bp.blogspot.com/-Yg-NsX3Kgzo/T2SQoMYVmcI/AAAAAAAADi8/Q14zKfPdwwk/s1600/search-pane-in-left-docbook-webhelp-r9240-scoring.png) |
A typical search results section. Read here to understand how the search result summaries appeared! And, we provide search scoring/rating mechanism for better searching.
|
![](//2.bp.blogspot.com/-Xa_za2Jic-g/T2SQpoWOG3I/AAAAAAAADjE/YzEN6Pa-eaM/s1600/search-pane-in-left-docbook-webhelp-r9240-two-words.png) |
A search with several words. WebHelp displays the results for the whole query, as well as for individual words which is nicely sectioned as shown above. |
No comments:
Post a Comment