Cruisers Forum
 


Join CruisersForum Today

Reply
 
Thread Tools Search this Thread Rate Thread Display Modes
Old 04-12-2016, 13:01   #1
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
OpenCPN Dokuwiki - Comments

In the current Druple Wiki, we have a "Comments" feature at the bottom of pages or sections.

The new Dokuwiki does not have this feature at the moment.
Just how important is it?

There is a "Discussion" plugin which might provide this feature, but every plugin added creates more complexity, so I do not want to do this unless we are certain it is needed. IE: not just a desire, but a very real NEED!
See this: https://www.dokuwiki.org/plugin:discussion
See this: https://forum.dokuwiki.org/thread/14274
These are not necessarily simple things to do...

So please comment below.
---and VOLUNTEER to help us migrate by registering to become an Editor.
__________________

rgleason is offline   Reply With Quote
Old 04-12-2016, 17:46   #2
Registered User

Join Date: Dec 2005
Location: Helsingborg, Sweden
Boat: Dufour 35
Posts: 3,417
Re: OpenCPN Dokuwiki - Comments

Rick
The feature enabling those comments is not important at all.
Nobody are/were monitoring those comments, so they were mostly just a waste of time. Just a few of those comments are/were valuable, mostly they were only asking for help etc. The kind of questions we like to channel to this forum.

Thomas
__________________

cagney is offline   Reply With Quote
Old 04-12-2016, 19:09   #3
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

Great. Thanks Thomas.
rgleason is offline   Reply With Quote
Old 04-12-2016, 22:37   #4
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

Thomas, can I make you an editor? I have your email and can send you a pw?
rgleason is offline   Reply With Quote
Old 05-12-2016, 16:32   #5
Registered User

Join Date: Dec 2005
Location: Helsingborg, Sweden
Boat: Dufour 35
Posts: 3,417
Re: OpenCPN Dokuwiki - Comments

Quote:
Originally Posted by rgleason View Post
Thomas, can I make you an editor? I have your email and can send you a pw?
Please do!
Thomas
cagney is offline   Reply With Quote
Old 05-12-2016, 18:39   #6
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Indexmenu is now working as required

Great Thomas, Thanks.

With Fabbian's excellent work adding blank pages to get the index sorting properly,
https://forum.dokuwiki.org/post/54743

I decided we needed a way to skip the pages labeled "blank" and found one!
https://forum.dokuwiki.org/post/54757

See the newly improved Indexmenu here
GPS Setup and Status [Opencpn]

GPS Setup and Status has a hidden "blank" page that is skipped by Indexmenu now.

We still need good Editors, as there is lots to get done by January!
Please see this Edit User Manual Page
rgleason is offline   Reply With Quote
Old 05-12-2016, 19:10   #7
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

Fabbian, if you don't mind I am going to turn you back into a "Manager" for a brief test, as I figured out the issue Indexmenu Sort Code disappears on Save - fixed by uncheck "only_admins" in configuration
https://forum.dokuwiki.org/post/54758
and more long winded
https://forum.dokuwiki.org/post/54510

If this does not work let me know please (I've also tested it with another Manager's login). Once I know this works for you, I will then turn you and Thomas back to Admin's as you guys are probably the only other people as deep into this now.

We need more good editors so encourage others you know to help out please.
Now the only other thing we need to fix is the sending of emails....would be very nice.
rgleason is offline   Reply With Quote
Old 06-12-2016, 07:40   #8
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

I have been thinking about how I've set up the media files.
I think the long directory names results in excess work and typing for many media links. Ck Edit provides an easy way to search and replace the media links, so it might be better to shorten our media file names now.

Currently the media directories where we store image files are:
media root
- developer_manual
- supplementary_hardware
- supplementary_software
- opencpn_user_manual

I would like to change these to
- dev
- hard
- soft
- user

Are there any objections or other suggestions?

Incidentally there are about 15 images in the media [root] directory which are for plugins like weatherfax, etc. I believe. Does anyone know about them? Thanks.
I think we want to keep these in another directory. Should we also make a lugin directory or just store these image files under pencpn_user_manual or user?
rgleason is offline   Reply With Quote
Old 06-12-2016, 08:50   #9
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Dokuwiki - Good Find & Replace for links

I just remembered that CK Editor will not search source html code, but there is a good alternative.

Install Notepad++ and if you are using Firefox install the addon plugin ItsAllText. Restart Firefox and go to the O Dokuwiki page you want to find & replace. Go into DW Edit, you should then find a little blue "Edit" button in the lower right margin, click on it and you may have to set preferences for the Notepad++ exe , then you will be able to find & replace and save back to the DW Edit page. From there you will need to also Save the DW Edit page to save the Replacements.

See: https://forum.dokuwiki.org/post/54428

I believe I can use Notepad++ in this way to find and replace all the long instances of the media directory for "opencpn_user_manual" with "user"

I will have to bring up every page in the manual to do this.

Is there a quicker way?
rgleason is offline   Reply With Quote
Old 06-12-2016, 11:05   #10
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

Instead of learning how to use Bash and Sed to edit dokuwiki files, JEdit was suggested and it looks like a graphical interface similar to notepad++ with good find & replace of all files in a directory and subdirectory, with filters.

However it uses Java and I don't believe my server has Java, and I am concerned about security with Java....

Has anyone used it? Any suggestions? I was going to install it on my server to use on Dokuwiki. I need a good find & replace tool.

jEdit - Programmer's Text Editor - Java version compatibility
rgleason is offline   Reply With Quote
Old 06-12-2016, 20:20   #11
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Localization, Internationalization I18n, etc

I appears that Dokuwiki has pretty good support for these efforts.
The Wiki itself can respond to at the 5 languages and the structure is there for more.

The wiki pages are stored under country directories like EN, FR, GE etc

Our wiki pages will need to be moved to be under the EN directory.
Also we will need to use the international version of the wiki when it is finally setup on the intended server.

These are some of the links for those who are interested, like Gilletarom

Summary of translations for dokuwiki and plugins
https://translate.dokuwiki.org/?lang=es

Translation Plugin (assists with translation)
https://www.dokuwiki.org/plugin:translation

https://www.dokuwiki.org/localizatio...r_installation

https://www.dokuwiki.org/devel:localization

Team I18n
https://www.dokuwiki.org/teams:i18n
rgleason is offline   Reply With Quote
Old 07-12-2016, 05:23   #12
Registered User
 
rgleason's Avatar

Join Date: Mar 2012
Location: Boston, MA
Boat: 1981 Bristol 32 Sloop
Posts: 12,035
Re: OpenCPN Dokuwiki - Comments

Should the Media/image direcrories be
- dev. for dev. manuals
- soft. for sup.software
- hard for sup. hardware
- man for user manual?
OR
- user for user manual?

I want editors to know where images should be put!
rgleason is offline   Reply With Quote
Old 07-12-2016, 07:34   #13
Registered User

Join Date: Jun 2010
Location: St. Petersburg, Florida
Boat: Gemini 3200
Posts: 741
Re: OpenCPN Dokuwiki - Comments

1. I agree there's no need for a comments or discussion section in the manual. That's why we have the forum. We don't want to proliferate the places where we have to look for questions and answers.

2. I will let you know if I encounter any problems as "Manager". I'll need a day or so to test the functions I use.

3. I don't see much advantage to shortening the names for the namespaces which contain the media files. It will be a lot of work and the longer names can easily be handled with copy and paste. The cost of bits is pretty low these days and the longer names do make the code more readable. I'd say leave well enough alone.

4. I noticed that a lot of the pages you've migrated contain links to the Drupal manual pages. Take a look, for example, at

GPS Setup and Status [Opencpn]

The very first link takes you back to a Drupal manual page. It points to

Code:
 http://opencpn.org/ocpn/Start_gps-setup
It needs to be changed to point to

Code:
opencpn:opencpn_user_manual:getting_started:gps_setup
Everyone working on the project needs to be very careful about this. As long as the original user manual is still in place the Dokuwiki pages will look OK. When the Drupal pages are gone a huge chunk of the manual will disappear if those links haven't been corrected.

In every page you migrate, look for the little globe icon to the left of a link. That tells you the link is to an outside Web page. If the outside Web page is a page in the original user manual it needs to be changed to a link to a Dokuwiki page. If the Dokuwiki page doesn't exist it needs to be created in the proper place in the index structure and copied from the Drupal page.

5. In your instructions in the Edit User Manual page you say to log in as Editor into the old manual. That's not necessary. You can simply highlight the Drupal page, copy it to the clipboard, and paste it into the Dokuwiki CKG edit page. Save it, then edit it further with DW Edit.

In a few rare cases you might need to look at the Drupal source code to figure out why something didn't copy properly. In those cases you need to be logged in and able to switch to plain text editor. I found a couple cases where images had been encoded as binary strings in the HTML. I had to view the page, save the image file, upload it to Dokuwiki, and change the Dokuwiki code to point to the newly uploaded image.

With the exception of those few instances I found I did not need to log in to the Drupal manager at all. That streamlines the process a bit.

Fabbian
fgd3 is offline   Reply With Quote
Old 07-12-2016, 08:06   #14
Registered User

Join Date: Jun 2010
Location: St. Petersburg, Florida
Boat: Gemini 3200
Posts: 741
Re: OpenCPN Dokuwiki - Comments

On the

Code:
opencpn:opencpn_user_manual:toolbar_buttons:plugins:install_and_enable
page there is a link to the dedicated page for downloading plugins:

Code:
http://opencpn.org/ocpn/downloadplugins
Which is a stand alone page in the OpenCPN Web site but is not part of the manual. Will that remain valid as an external link or should the downloadplugins page be move into the user manual?

Fabbian
fgd3 is offline   Reply With Quote
Old 07-12-2016, 08:21   #15
Registered User

Join Date: Jun 2010
Location: St. Petersburg, Florida
Boat: Gemini 3200
Posts: 741
Re: OpenCPN Dokuwiki - Comments

When I started working on this project I had the impression that images were linked with a line like this

Code:
{{:opencpn:opencpn_user_manual:image.png?nolink&WxH}}
but

Code:
{{opencpn:opencpn_user_manual:image.png?nolink&WxH}}
seems to work equally well. Is there any importance to the leading colon? The same question applies to internal links.

Code:
[[:opencpn:opencpn_user_manual:toolbar_buttons:plugins:install_and_enable|Install and Enable]]
and

Code:
[[opencpn:opencpn_user_manual:toolbar_buttons:plugins:install_and_enable|Install and Enable]]
seem to work equally. Is there a difference or was the leading colon just a misunderstanding of the syntax?

Fabbian
__________________

fgd3 is offline   Reply With Quote
Reply

Tags
enc, men, opencpn

Thread Tools Search this Thread
Search this Thread:

Advanced Search
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 Dokuwiki Migration -MOB- Help Needed!!! MOB rgleason OpenCPN 87 20-12-2016 11:12
DokuWiki for Opencpn Manual ? rgleason OpenCPN 30 08-11-2016 17:57
Privilege 48' Comments? Input? tonisan Multihull Sailboats 5 29-12-2008 08:57
I just have a FEW comments. 29cascadefixer General Sailing Forum 8 23-12-2003 15:52
Posting comments to the photos Gisle Forum Tech Support & Site Help 0 13-05-2003 11:10



Copyright 2002- Social Knowledge, LLC All Rights Reserved.

All times are GMT -7. The time now is 03:19.


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

ShowCase vBulletin Plugins by Drive Thru Online, Inc.