Cruisers Forum
 


Join CruisersForum Today

Reply
 
Thread Tools Rate Thread Display Modes
Old 08-01-2016, 18:44   #76
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,314
How Links and Headings Work in the User Manual

How Links & Headings Work | Official OpenCPN Homepage

They work completely normally as you would expect.

The key thing to remember about links is that they must work!
They do NOT have to match the Heading of the document being referred to.
however the URL pasted into the HYPERLINK must be correct so that the link works.
Then the automated PHP code will create good links in the Exported single page Wiki.
__________________

__________________
rgleason is offline   Reply With Quote
Old 08-01-2016, 18:45   #77
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 9,314
How Links and Headings Work in the User Manual

How Links & Headings Work | Official OpenCPN Homepage

Quote:
They work completely normally as you would expect.

The key thing to remember about links is that they must work!
They do NOT have to match the Heading of the document being referred to.
however the URL pasted into the HYPERLINK must be correct so that the link works.
Then the automated PHP code will create good links in the Exported single page Wiki.
__________________

__________________
rgleason is offline   Reply With Quote
Old 09-01-2016, 07:25   #78
Registered User
 
rgleason's Avatar

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

David,

Editing and changing the Outline is actually quite straight forward.
The only requirement is that links work correctly.

I've been adding pages to the Editing Manual here and have organized it.

Edit the User Manual | Official OpenCPN Homepage

Need to put some screenshots up when I have time.

Would you mind looking at

Getting Started | Official OpenCPN Homepage

To see what other changes are needed?
__________________
rgleason is offline   Reply With Quote
Old 09-01-2016, 07:25   #79
Registered User

Join Date: Jan 2007
Location: Minneapolis
Boat: Irwin 37 CC
Posts: 660
Re: How Links and Headings Work in the User Manual

Quote:
Originally Posted by rgleason View Post
This is ironic. I get "page not found" for the above link!

I'll look at this AM but it might be tomorrow before I do anything.

I think we need a standard way to identify links; italics or underline or both.
__________________
David Kester
Pegasus IV
wdkester is offline   Reply With Quote
Old 09-01-2016, 07:27   #80
Registered User
 
rgleason's Avatar

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

Yes it is. I changed the URL. Sorry.
Where was that link? I am sorry.
It is now:
Links & Headings | Official OpenCPN Homepage

Its going to stay that way now.
__________________
rgleason is offline   Reply With Quote
Old 09-01-2016, 08:44   #81
Registered User

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

Quote:
Originally Posted by rgleason View Post
David,

Editing and changing the Outline is actually quite straight forward.
The only requirement is that links work correctly.

I've been adding pages to the Editing Manual here and have organized it.

Edit the User Manual | Official OpenCPN Homepage

Need to put some screenshots up when I have time.

Would you mind looking at

Getting Started | Official OpenCPN Homepage

To see what other changes are needed?
I'll look at it this AM but will be busy until tomorrow.

A general comment - There seems to be a lot of redundancy. I'll leave most of it in because of the way the manuual will be used; but, having the open soft ware notice more than once is silly. They will see it when they install the S/W.

I think we should put internal links in italics(this is standard) and underline external links(not standard yet).
__________________
David Kester
Pegasus IV
wdkester is offline   Reply With Quote
Old 09-01-2016, 09:48   #82
Registered User

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

Rick,

Comment on out of date screens- If they are functionally OK I leave them. If they are functionally wrong (e.g. options>charts) I replace them.

I have updated: Getting Started, Windows, (don't know anything about UNIX variants or Mac OS), Troubleshoot Installation looks OK; but a developer should check.

I will start on OpenCPN First Use tomorrow. First impression- lots of out of date sreens
__________________
David Kester
Pegasus IV
wdkester is offline   Reply With Quote
Old 09-01-2016, 10:49   #83
Registered User

Join Date: Nov 2014
Location: Netherlands
Posts: 179
Re: Opencpn 4.1.1108 Documentation

There is a problem with the naming of AIS.
There are 2 locations with just AIS in the Heading.

In the MenuBar and in the Toolbar Buttons.
This causes problems in the export doc.

Change to AIS Menu in the MenuBar is maybe the best solution??

Peter
__________________
ptulp is offline   Reply With Quote
Old 09-01-2016, 12:46   #84
Registered User
 
rgleason's Avatar

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

Quote:
I'll look at it this AM but will be busy until tomorrow.

A general comment - There seems to be a lot of redundancy. YES I'll leave most of it in because of the way the manual will be used; but, having the open soft ware notice more than once is silly. YES They will see it when they install the S/W.

I think we should put internal links in italics(this is standard) and underline external links(not standard yet YES
I would like to whittle it down.
We can do that with what I call Jump Pages

Look at the Plugins that is not under Toolbar_Buttons

OpenCPN User Manual | Official OpenCPN Homepage

Plugins | Official OpenCPN Homepage

Eventually I hope someone will suggest a way to make a direct hyperlink in the menu! That would be useful to eliminate redundancy.

We need to clean up Getting Started more I think.
Chart Installation is kind of a jump page and maybe it should just be a Jump page with nothing but a link to
Chart Installation
Chart Files Tab | Official OpenCPN Homepage

Ptulp, I will look at the link. Thanks.
__________________
rgleason is offline   Reply With Quote
Old 09-01-2016, 13:01   #85
Registered User
 
rgleason's Avatar

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

Quote:
There is a problem with the naming of AIS.
There are 2 locations with just AIS in the Heading.
In the MenuBar and in the Toolbar Buttons.
This causes problems in the export doc.
Change to AIS Menu in the MenuBar is maybe the best solution??
Peter
Yes, indeed. Peter you have identified that there is just one important requirement for Headings.

Headings

1. All Headings must be unique, otherwise the PHP program uses the first heading to make the internal link in all following cases. 2. Heading text is used to make the menu to the left, so the heading should be as short as possible, otherwise the menus on the left become terrribly formated and unreadable.
3. A shortened or longer version of the Heading should be put in the URL link below the edit screen so that we can find the page later with searches if it gets lost or disassociated. This URL should start with a single word from the parent title, followed by an underline. EG: toolbar_scale
4. The URL must be used for all hyperlinks in the text, so it is best not to change the URL's once established, otherwise text links will break.

I seem to be doing that a lot lately, but I wanted to "get it right" at the beginning, because I had a title that was way too long "How to ..." Sorry again.

Thanks Peter.

Yes, under Menubar changed AIS to AIS Menubar and now in the single page Export version it works.

Changed Heading to AIS Menubar
http://opencpn.org/ocpn/Menubar_AIS <-- did not change this, they were already unique, and need to be.

Left Heading as AIS
http://opencpn.org/ocpn/toolbar_AIS <-- did not change this. It is a unique identifier of the page.

Now when I click on Toolbar Buttons AIS in the Exported version, the second AIS link in the flat document goes where it should.
AIS

And the MenuBar AIS goes where it should AIS Menubar
__________________
rgleason is offline   Reply With Quote
Old 09-01-2016, 14:34   #86
Registered User
 
rgleason's Avatar

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

Because it is the second instance using the same Heading the Plugins menu item in the bottom of the main directory, misses the Jump page in the export wiki and goes straight to the page we want it to go to. http://opencpn.org/ocpn/ocpn_manual_export/
Wouldn't it be nice if we had an direct external link for menu items though?
__________________
rgleason is offline   Reply With Quote
Old 10-01-2016, 09:13   #87
Registered User

Join Date: Nov 2014
Location: Netherlands
Posts: 179
Re: Opencpn 4.1.1108 Documentation

Rick,

Are you working on the doc for the Chart Downloader Plugin?
We are totally missing that.

Peter
__________________
ptulp is offline   Reply With Quote
Old 10-01-2016, 09:19   #88
Registered User

Join Date: Nov 2014
Location: Netherlands
Posts: 179
Re: Opencpn 4.1.1108 Documentation

I see that the Chart Downloader plugin description is under
Charts->Charts Download Tab.

So the plugin link should point there I guess.

Peter
__________________
ptulp is offline   Reply With Quote
Old 10-01-2016, 10:13   #89
Registered User
 
rgleason's Avatar

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

Yes
Pavel TDan and I wrote it.
I will retrieve it and put it in the pi internal page.
__________________
rgleason is offline   Reply With Quote
Old 10-01-2016, 10:15   #90
Registered User
 
rgleason's Avatar

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

BTW
The text portion of the documentation is very small.
However the images are 45mb.
Therefore we should try to be smart and sparing in our inage use.
__________________

__________________
rgleason 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 04:37.


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.