Cruisers Forum
 


Join CruisersForum Today

Reply
 
Thread Tools Rate Thread Display Modes
Old 05-01-2016, 14:54   #46
bcn
Registered User

Join Date: May 2011
Location: underway whenever possible
Boat: Rangeboat 39
Posts: 2,759
Re: Opencpn 4.1.1108 Documentation

Rick,

gives me "page not found"

Sorry
__________________

__________________
bcn is offline   Reply With Quote
Old 05-01-2016, 15:00   #47
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

Added Roel Smidt's document for Plugin Documentation.
He would like to have:
1.be logical and consistent.
2.
be easy to understand.

and suggests use far less words and more screenshots.

http://opencpn.org/ocpn/Edit-User-Do...-Documentation

This would perhaps apply to the main program too.
It might be easier to do as well.
__________________

__________________
rgleason is offline   Reply With Quote
Old 05-01-2016, 15:04   #48
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

Sorry, BCN that Link to

Edit the User Manual was messed up.

It needs screenshots now.
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 09:03   #49
Registered User

Join Date: May 2011
Posts: 847
Re: Opencpn 4.1.1108 Documentation

The all about charts page in the user manual no longer exists - related to the recent changes?

Chris
__________________
Littlechay is offline   Reply With Quote
Old 06-01-2016, 09:49   #50
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

Try this. Go from the outline on the webpage, because it is being reorganized to align with the new outline in prep for Version 4.2
"http://opencpn.org/ocpn/Basic_Charts"
Charts | Official OpenCPN Homepage

Sorry, but it is unavoidable.

Just found I need to Check and Change the Links on the Getting started page.
"http://opencpn.org/ocpn/Start_chart-installation"
http://opencpn.org/ocpn/Start_chart-installation

I guess the internal links are not dynamic and automatically changed.
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 10:43   #51
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

@ BCN -Hubert
Shouldn't we have a section under Chart Formats for S63 and the Plugin?
Chart Formats | Official OpenCPN Homepage

Also Plugins S63 Plugin?
External Plugins | Official OpenCPN Homepage
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 11:05   #52
bcn
Registered User

Join Date: May 2011
Location: underway whenever possible
Boat: Rangeboat 39
Posts: 2,759
Re: Opencpn 4.1.1108 Documentation

Rick,

in the 4.0 manual - chart section - there is already some work done.

We will have to update this for the upcoming new version of the plug-in as it does change how a fingerprint for an individual install is taken.

Let us have a look in the next days how to polish things - we are testing the new version in parallel.

Hubert
__________________
bcn is offline   Reply With Quote
Old 06-01-2016, 11:49   #53
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

Hurbert,
I think I figured it out.

Are you ok with me putting your S63 Vector Plugin documentation
S63 Vector Charts | Official OpenCPN Homepage

under the new page for the Plugins > External > S63 Vector Plugin
S63 Vector Charts | Official OpenCPN Homepage

It is on this page:
External Plugins | Official OpenCPN Homepage

And I will make a link under this page at the end to the S63 Plugin and O-charts
Vector Display Tab | Official OpenCPN Homepage

And it is in Chart Sources Page at the bottom
Chart Sources | Official OpenCPN Homepage
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 11:53   #54
bcn
Registered User

Join Date: May 2011
Location: underway whenever possible
Boat: Rangeboat 39
Posts: 2,759
Re: Opencpn 4.1.1108 Documentation

Rick,

yes, please go ahead.
When we have our stuff ready we will see how to retouch the docs/screenshots that changed.

Thanks

Hubert
__________________
bcn is offline   Reply With Quote
Old 06-01-2016, 11:56   #55
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

@bdbcat
Do you have a problem with this organization
Charts | Official OpenCPN Homepage

I have moved several of these pages out of Supplementary Software

Charts

Options > Charts > Tabs

Chart Files Tab (Installing Charts)
Vector Chart Display Tab (Vector Charts)

Chart Groups Tab (Chart Groups)
Chart Downloader Tab
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 12:53   #56
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

Can someone help regarding

"Links must match Heading for export"

What does this mean specifically?
When is "export" done?
Specifically which links and which headings?

I hope I am not making a problem.
__________________
rgleason is offline   Reply With Quote
Old 06-01-2016, 13:04   #57
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

I've pretty much made the major changes to the Outline for the User Manual.

To Do
  1. Some URL changes to make to Charts subcategories conform, moving the files from Supplemental Software.
  2. All links to User Manual pages within the website need to be checked, particularly the Jump pages (Page which comes up after clicking on Plugins for example. Any links on those types of pages need checking.
  3. Links within the text to other parts of the User Manual. These links may have changed.

Please talk a look and advise.
OpenCPN User Manual | Official OpenCPN Homepage
__________________
rgleason is offline   Reply With Quote
Old 07-01-2016, 08:58   #58
Registered User

Join Date: Jan 2007
Location: Minneapolis
Boat: Irwin 37 CC
Posts: 660
Re: Opencpn 4.1.1108 Documentation

Rick, This is a huge job.

When I look at the TOC i see
Install OpenCPN
Configure Ubuntu PPA
Install Linux Plugins
OpenGL"

I think Windows and Mack OS should appear as well. The text is there for Windows but no TOC entry. Confusing to First Time User. (FTU hahaha)
__________________
David Kester
Pegasus IV
wdkester is offline   Reply With Quote
Old 07-01-2016, 12:36   #59
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,382
Re: Opencpn 4.1.1108 Documentation

I agree with you David, and I am trying to make it clearer and eliminate redundancy.

http://opencpn.org/ocpn/opencpn_manual
Once the Outline is ok, I need to get the links fixed within the text.

The first job has been to get back to a sensible outline. Thomas had a great outline earlier, and somehow we strayed from it on the last release because we had new elements to deal with, and today I finally understood what needed to be done insofar as the main outline.

I think I have most of it organized now, but I need someone to take a look at the organization and advise. Can you do that for me?

Getting Started - Help for new users, As clear and concise as possible. (it is not there yet)
MenuBar - The alternative menu that can be very useful
Toolbar Buttons - Main menu system, with Toolbar Icons & Chart Buttons. Has subcategories, much as before, moving things like plugins into line, etc. Each subcategory should be in order with the Program's Toolbar Ions.
Right Click Menu - Details about this important menu and user interface.
Options_Charts Gathering all the chart information into one place
Options_Connections Detailing the use of this interface.
Advanced Features Advanced how to stuff.
FAQ
Links
Edit User Manual

Once we are pretty sure about this outline, I need to go through the entire document and replace and make new links that work.
Many of the links no longer work, but I don't want to do that unless the organization is pretty much done.

Do you think all the subcategory items under http://opencpn.org/ocpn/Start_os-install-details should be moved back to Advanced > OS Install Details?

--Maybe so.
__________________
rgleason is offline   Reply With Quote
Old 07-01-2016, 16:47   #60
Registered User

Join Date: Jan 2007
Location: Minneapolis
Boat: Irwin 37 CC
Posts: 660
Re: Opencpn 4.1.1108 Documentation

I'll try.

I like your Outline above. The only thing that might be missing is plugins, but they could appear under Advanced Features

Some changes with the current structure-

Instead of "OS Install details" how about "Installing OpenCPN under Different Operating Systems", more words but more informative?

Under the above heading how about the following sub-heads
Windows
Mac OS
Linux
Ubuntu
Fedora
Dedicated Marine OS

Move Configure Ubuntu PPA, under Ubuntu
Move Install Linux Plugins under Plugins
Move OpenGL under Options_Charts (I think this reads better as Chart Options ditto Connection Options)
Move Low Power Systems and Portable OpenCPN under Advanced Features

As a(nother) general principal topics under a single heading should be sorted with most likely to be used first by the inexperienced.

Before I go further is this what you are looking for?
__________________

__________________
David Kester
Pegasus IV
wdkester is offline   Reply With Quote
Reply

Tags
documentation, enc, men, opencpn

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 Beta test 4.1.1108 Release bdbcat OpenCPN 694 14-01-2016 08:10
Beta test 4.1.1108 on ARM NahanniV OpenCPN 9 07-12-2015 09:09
Value of USCG documentation? Wahoo Sails Rules of the Road, Regulations & Red Tape 18 07-09-2008 14:13
federal documentation/state requirements?? cadye Rules of the Road, Regulations & Red Tape 3 24-08-2005 13:23
USCG Documentation delay? alicemacinnes Rules of the Road, Regulations & Red Tape 2 14-12-2004 07:12



Copyright 2002- Social Knowledge, LLC All Rights Reserved.

All times are GMT -7. The time now is 16:23.


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.