Cruisers Forum
 


Join CruisersForum Today

Reply
 
Thread Tools Rate Thread Display Modes
Old 08-04-2011, 14:24   #1
Marine Service Provider

Join Date: Feb 2010
Posts: 279
Context Sensitive Help for OpenCPN

As OpenCPN matures now may be a good time to implement context sensitive Help. Many of the support type questions on the forum are easily answered by the excellent OpenCPN documentation. The advantage of a HTML Help file is that it is seachable and can be made context sensitive I have created a HTML Help file from the existing documentation for the latest beta realease here is the link

https://docs.google.com/leaf?id=0B3S...thkey=COCXuMgO

If you are using Vista or 7 you will need the Microsoft Html Help Viewer If you are using Linux you need xchm and on Mac the Cocoa chm viewer

The help file is just a straght conversion from the documentation It has lost a few links and needs tidying up.

To implement context help in OpenCPN we can use the F1 key or add a help button to each dialog box. If it is implemented I will need to add context ids to each topic so the correct topic is pulled.

I am happy to caryout the conversions to help for each main or beta release for testing


regards

Richard Fairman
__________________
r.fairman is offline   Reply With Quote
Old 08-04-2011, 16:02   #2
Marine Service Provider

Join Date: Feb 2010
Posts: 279
Re: Context Sensitive Help for OpenCPN

Sorry wrong link in previous post Please try this one

https://docs.google.com/leaf?id=0B3S...thkey=CICE84cG

Regards

Richard
__________________
r.fairman is offline   Reply With Quote
Old 08-04-2011, 16:04   #3
Registered User

Join Date: Jul 2010
Location: Monastir, Tunisia
Boat: Amel Sharki
Posts: 1,777
Re: Context Sensitive Help for OpenCPN

Richard,

correct, OpenCPN becomes more complex now. I have reworked its build-in help file already a little bit: OpenCPN User Manual

Did you know the build-in help works also in other languages? Another file called help_de_DE.html e.g. for german in the doc folder will do: OpenCPN Handbuch

Mac OS X has already a build-in help system. This is context sensitive and has a search function. The Cocoa chm viewer is not usable and looks rather ugly. The final stable Mac OS X version will use the help system of the OS. Actually OpenCPN for Mac OS X is still a Beta.

To do a real context sensitive help for Windows or Linux however there are needed to place some anchors in the OpenCPN code.

Gerhard
__________________
CarCode is offline   Reply With Quote
Reply

Thread Tools
Display Modes Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are Off
Pingbacks are Off
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
OpenCPN 2.3.0 dlymn OpenCPN 3 29-06-2011 02:44
HD Radar: Is it Sensitive Enough to Pick Up Small Objects ? Exiles Navigation 15 14-02-2011 10:57
OpenCPN bdbcat OpenCPN 1343 19-09-2009 16:59
Voltage Sensitive Relay Nyssa Electrical: Batteries, Generators & Solar 12 04-12-2008 14:21
LED Bulbs Polarity Sensitive Ron_Fran Electrical: Batteries, Generators & Solar 4 14-07-2008 18:06



Copyright 2002- Social Knowledge, LLC All Rights Reserved.

All times are GMT -7. The time now is 02:38.


Google+
Powered by vBulletin® Version 3.8.8 Beta 1
Copyright ©2000 - 2017, vBulletin Solutions, Inc.
Social Knowledge Networks
Powered by vBulletin® Version 3.8.8 Beta 1
Copyright ©2000 - 2017, vBulletin Solutions, Inc.

ShowCase vBulletin Plugins by Drive Thru Online, Inc.