Documentation

This project is for all Feature concerning documentation.
Tasklist

FS#716 - Config file items in documentation hard to find

Attached to Project: Documentation
Opened by Marco (Mbjh9acu) - Friday, 13 January 2012, 05:04 GMT-7
Last edited by Serge (AISEAG) - Sunday, 15 September 2013, 07:36 GMT-7
Task Type
Category
Status
Assigned To Dave (bdbcat)
Operating System All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 0%
Votes 3
Private No

Details

I think we might want to have a list of all entries in the config file that are only read by OCPN. Some are mentioned in the documentation, some aren't (or I couldn't find them...).

I can do the documentation, but I need some input:
-Is this list a good idea? Or are those entries 'undocumented' on purpose?
-Where is a good entry point in the documentation-index? I think a chapter under 'advanced' could be a proper place.
-What (read-only) config file entries are in use? Some are documented here (http://www.cruisersforum.com/forums/f134/opencpn-version-2-6-beta-build-1310-a-74549.html) and some in the documentation. Is there a list? (can do some intelligent grep on navutil.cpp, but that doesn't tell me which are read-only to OCPN...).
This task depends upon

Comment by Pavel (nohal) - Sunday, 15 January 2012, 06:58 GMT-7
Marco...
Yes, it's a good idea. Chapter under Advanced looks like a good place, but it can be moved to anywhere at any time, so it's probably not that important.
The best to start with is probably taking the INI file and striping the options that have importance close to zero (like the whole [Settings/ObjectFilter] section for example) - If you do it with a clean install INI, you will also have the default values for all the settings.

Pavel
Comment by Marco (Mbjh9acu) - Sunday, 29 January 2012, 07:06 GMT-7
Tried to add a start today. Vodafone internet is so slow that almost everything I do times out :(((. Well, maybe some other day :(
Comment by Serge (AISEAG) - Sunday, 15 September 2013, 07:36 GMT-7
  • Field changed: Attached to Project ( → Documentation)
Previously was in OpenCPN 2.6.x Beta,

Thomas want it to be posted in a documenation projet.

Serge
Comment by Marco (Mbjh9acu) - Monday, 23 September 2013, 14:12 GMT-7
23/9: Got a mail from Serge if this is still relevant.
I don't care where this is posted. As long as it's resolved some day :)
Comment by Marco (Mbjh9acu) - Monday, 21 October 2013, 12:05 GMT-7
Probably an ongoing subject... It might be a good idea to close this one once documentation is up-to-date. Open a new one if needed?

Loading...