Cruisers Forum
 


Join CruisersForum Today

Reply
 
Thread Tools Rate Thread Display Modes
Old 18-10-2016, 18:45   #1
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
DokuWiki for Opencpn Manual ?

Because the upgrade path from Drupal 6 to Drupal 7 or 8 is unclear, particularly with respect to necessary plugins and actually moving the documentation. Also since Drupal depends on a CMS database which is difficult to work with, Dave determined that we need a 'flat" wiki for the Manuals. I believe that is why he suggested I try Dokuwiki. Well this is as far as I've gotten so far. The menu structure is almost identical, and can be improved quite readily now that I've learned how it is done.

The method for importing pages and images will need some work and can possibly be improved.

However this should give people some idea of how the Manual would work. Note: only some pages have been imported.

At some point we will need help transferring over by editors at some point, if this is going to be used.
Please let us know what you think.

TOOLBAR Buttons [Opencpn Wiki]
__________________

__________________
rgleason is offline   Reply With Quote
Old 19-10-2016, 01:53   #2
Registered User

Join Date: Nov 2012
Location: Orust Sweden
Boat: Najad 34
Posts: 1,645
Re: DokuWiki for Opencpn Manual ?

If I understand it correct the change of wiki environment is driven by a hope for an easier method to create and edit the manual. If so I don't have any particular comments since I didn't worked much with the existing one more than it was a rather prolix affair to ad or edit images in the old one, wasn't it. Rick, you must able to judge it since you've done a lot for the existing one.

One of the most important features for a wiki is a reasonable result when using the search function. I did some small tests on the one you've linked to and found it rather good. Every word seems indexed, paragraphs with lot of hits was accordingly sorted and headings connected to the search phrase was emphasized.

Headings in the side bar seems sorted after implementation order? It may be a good idea to check for other possibilities, like user manuals in the upper part and development wikis further down?
Håkan
__________________

__________________
Hakan is offline   Reply With Quote
Old 19-10-2016, 01:57   #3
Registered User

Join Date: Jul 2010
Location: Monastir, Tunisia
Boat: Westerly Pentland
Posts: 1,515
Re: DokuWiki for Opencpn Manual ?

Believe it or not: There exists people which does not understand english.
So these documents are useless for such people.

Gerhard
__________________
CarCode is offline   Reply With Quote
Old 19-10-2016, 02:07   #4
bcn
Registered User

Join Date: May 2011
Location: underway whenever possible
Boat: Rangeboat 39
Posts: 2,231
Re: DokuWiki for Opencpn Manual ?

And therefore some users made an effort to translate and to create extensive support web sites in French or Dutch.

But what else do you want to state?? That cleaning up the Wiki is useless if not translated in 55 languages?
__________________
bcn is offline   Reply With Quote
Old 19-10-2016, 03:20   #5
Registered User

Join Date: Jul 2010
Location: Monastir, Tunisia
Boat: Westerly Pentland
Posts: 1,515
Re: DokuWiki for Opencpn Manual ?

Quote:
Originally Posted by bcn View Post
And therefore some users made an effort to translate and to create extensive support web sites in French or Dutch.

But what else do you want to state?? That cleaning up the Wiki is useless if not translated in 55 languages?
Perhaps you are new to computers. The best software is intuitive and therefore does not need any manual or docu. OpenCPN is just the opposite.

Gerhard
__________________
CarCode is offline   Reply With Quote
Old 19-10-2016, 04:37   #6
Registered User

Join Date: Nov 2012
Location: Orust Sweden
Boat: Najad 34
Posts: 1,645
Re: DokuWiki for Opencpn Manual ?

Gerhard
It may be you're not so new to handle code that you cannot contribute to shape the code to self a explained program? I think you're welcome to remake the user interface.

All - BTW - Would it be feasible to handle the new wiki text in Crowdin, is DokuWiki prepared for that in any way?

Håkan
__________________
Hakan is offline   Reply With Quote
Old 19-10-2016, 07:12   #7
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

Guys
You're thoughts and feedback are welcome. This is an investigation of possibilities right now, which I hope will develop into a move to a useful wiki!

If you look at dokuwiki documentation here https://www.dokuwiki.org/dokuwiki#
and here under features https://www.dokuwiki.org/features
Support for over 50 languages I have not enabled that yet.

Its going to take some help to get the text, images and links all transferred. I have set up an authorized signup for Editors... but it's not yet ready for prime time as I need some guys to try it and try transferring the pages to be sure we have a good process.

Also when we get it all working and transferred over, if this is the what we are doing, the wiki will need to be transfered over to opencpn.org website.
__________________
rgleason is offline   Reply With Quote
Old 20-10-2016, 11:47   #8
Registered User
 
Gilletarom's Avatar

Join Date: Mar 2010
Location: France
Boat: 10.50 mètres
Posts: 2,099
Re: DokuWiki for Opencpn Manual ?

Hello Gerhard,

Quote:
Originally Posted by CarCode View Post
Believe it or not: There exists people which does not understand english.
So these documents are useless for such people.
Gerhard
When you cease to be negative ....

Best regards, Gilletarom.
__________________
Gilletarom is offline   Reply With Quote
Old 20-10-2016, 11:49   #9
Registered User
 
Gilletarom's Avatar

Join Date: Mar 2010
Location: France
Boat: 10.50 mètres
Posts: 2,099
Re: DokuWiki for Opencpn Manual ?

Hello Rick,

Quote:
Originally Posted by CarCode View Post
Believe it or not: There exists people which does not understand english.
So these documents are useless for such people.

Gerhard
For cons, about the remark Gerhard about the English language, it lacks in the manual or on the website, a page in every language possible, explaining to readers how to use the automatic google translator to translate the manual pages a by one.
__________________
Gilletarom is offline   Reply With Quote
Old 20-10-2016, 16:27   #10
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

Gillletarom and Gerhardt,
I will try to install the International plugin and see what happens. It may take several days to get to it.
I think the translation would be supplemental to the native language website.
In fact, there is good additional information on all these websites.
__________________
rgleason is offline   Reply With Quote
Old 20-10-2016, 16:44   #11
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

Hakan:
Quote:
One of the most important features for a wiki is a reasonable result when using the search function. I did some small tests on the one you've linked to and found it rather good. Every word seems indexed, paragraphs with lot of hits was accordingly sorted and headings connected to the search phrase was emphasized.

Headings in the side bar seems sorted after implementation order? It may be a good idea to check for other possibilities, like user manuals in the upper part and development wikis further down?
Håkan
Thanks, I was just trying to get menus organized and pages in place, learning the program. Good news that it searches well!

On the left Menu outline I could index it differently so User Manuals are at the top.
__________________
rgleason is offline   Reply With Quote
Old 21-10-2016, 09:51   #12
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

There is one small problem with the left nav index. We include some sort index code with a number to get the pages in the correct order for a book with chapters, which works, however when a chapter has other sub pages below, it moves up to the top and gets an expansion + and is ordered with all pages that have sub-pages. I have not yet figured out how to change this behavior. Tried for a long time, so now I am just leaving it until we find a solution.

Things to do next:
1. Get international working even if Gerhardt promoses not to use it.
2. Get registration setup for Users (all users are editor). I am going to assign admins status to several strong editors, so that registrations are vetted!
3. Get the Index in the right corner working.
4. Do a trial export of html chkedit for off line documentation.
5.Try to figure out the easiest and best structure for images. Should all images for a given book be saved in a subdirectory by that book name? With no further breakdown? If dokuwiki can handle this structure, that is how I'd like to do it. Please provide insight and thoughts here! I find user image directories more difficult, but sometimes it helps with sort and finding.
6. Also we need to develop the easiest way to move the documents over. I can copy and paste, but images have to be downloaded and uploaded for each page and the all the links have to be fixed.
Right now I and missing a search and replace function in dokuwiki which would really help.
8. Once we have the technique down, we need to write and Editor Step by Step for transfer of pages.
9. Then we need to get to work and can use all the skilled help available.
10. Right now I need 2 volunteers who can help figure out and develop the best process for tranferring Books and pages into the new structure. Is anyone interested?
__________________
rgleason is offline   Reply With Quote
Old 21-10-2016, 13:39   #13
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

For those who would like to understand how Dokuwiki Books / Pages work, there is a thread which explains what was needed to get the Opencpn Dokuwiki to its present state: Migrating from Drupal 6 to Dokuwiki
https://forum.dokuwiki.org/thread/14060,2;nocount

Export books
https://forum.dokuwiki.org/post/53969

Customize Sidebar - Namespace sorting issues
https://forum.dokuwiki.org/thread/14085
There are a few other threads that will explain other aspects
__________________
rgleason is offline   Reply With Quote
Old 21-10-2016, 14:10   #14
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

Regarding languages, translation, localization of dokuwiki

https://www.dokuwiki.org/devel:localization
https://www.dokuwiki.org/teams:i18n:...nttranslations
https://www.dokuwiki.org/tips:multil...nt:local.php?s[]=international

This translation plugin by Andreas Gohr might work it is compatible with the current version of Dokuwiki
https://www.dokuwiki.org/plugin:translation
Multilingual Content
https://www.dokuwiki.org/tips:multil...nt:local.php?s[]=international

https://www.dokuwiki.org/jalugin:translation

We are not ready to mess with this!
__________________
rgleason is offline   Reply With Quote
Old 21-10-2016, 14:17   #15
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 7,632
Re: DokuWiki for Opencpn Manual ?

Dokuwiki Syntax - We'll need to know this.

https://www.dokuwiki.org/wiki:syntax...nd_other_files

User Manual

https://www.dokuwiki.org/manual
__________________

__________________
rgleason is offline   Reply With Quote
Reply

Tags
enc, 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, Linux, Web site opencpn.org, user manual and manual wiki ... Gilletarom OpenCPN 26 30-11-2015 16:17
OpenCPN 4.0.0 User Manual in PDF Format RKG OpenCPN 7 18-11-2015 08:14
Manual OpenCPN 4.0 in Dutch Aart K. OpenCPN 12 12-11-2015 09:13
For Sale: YANMAR Service Manual, Parts Catalog, Operation Manual Kohanadiver Classifieds Archive 0 22-02-2013 13:41
Yanmar 4JH2E owner's manual (not service manual) janders Engines and Propulsion Systems 4 19-02-2009 12:13


Our Communities

Our communities encompass many different hobbies and interests, but each one is built on friendly, intelligent membership.

» More about our Communities

Automotive Communities

Our Automotive communities encompass many different makes and models. From U.S. domestics to European Saloons.

» More about our Automotive Communities

Marine Communities

Our Marine websites focus on Cruising and Sailing Vessels, including forums and the largest cruising Wiki project on the web today.

» More about our Marine Communities


Copyright 2002- Social Knowledge, LLC All Rights Reserved.

All times are GMT -7. The time now is 21:28.


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

ShowCase vBulletin Plugins by Drive Thru Online, Inc.