Editors Needed for User Manual Basic

[flpaoli]

Originally Posted by rgleason

STEP 2 Testing and Learning
Good luck.
Rick

Done. I didn't resize the image, neither tried to make it smaller in the docuwiki link.

[spiv]

Hello Rick,
I use Xnview on Linux (Kubuntu).
It's fast and provides a lot of options to optimase images.
I am happy to try and get clear, low size images.
I'll pm you.

[rgleason]

Originally Posted by flpaoli

Done. I didn't resize the image, neither tried to make it smaller in the docuwiki link.

I checked the location of your image using Media Manager and it is located

here https://opencpn.org/wiki/dokuwiki/do...it_user_manual
(only editors will have access to this page)

The file location is shown at the top

"Files in opencpn:edit_user_manual"

I can tell you that you did locate the file in the correct namespace because you started by editing the Editor User Manual on the Test & Learn Page, then used Media Manager to "Upload" > Select file then Upload.

The to create a link in the page you are editing, you click on the file name that you uploaded.

This link appears as when in DW Edit:

{{pencpn:edit_user_manual:tb-opt-flpaoli.png|Toolbar - Options menu}}

I will resize it a little smaller this way
{{pencpn:edit_user_manual:tb-opt-flpaoli.png?500|Toolbar - Options menu}}

Very well done. My only suggestion is to before making the image try to resize the menu to use less real estate if possible.

[Aldebaran17]

Dear Rick,

I am also happy to help here. I am using OPenCPN on a Raspberry on board and on a Mac for planning.
The Pi onboard is connected to a NMEA2000 network and can be accessed via VNC from phone/tablet/notebook. On board I also have a NMEA183 streamed via Wifi/UDP.

Here are my (scaled down for Mac, native resolution for Pi) screen shot of the own ship page.

From Mac:



From Pi:


I will send you a PM with my email-address.

Best,

Manfred

[rgleason]

Originally Posted by Aldebaran17

Dear Rick,

I am also happy to help here. I am using OPenCPN on a Raspberry on board and on a Mac for planning.
The Pi onboard is connected to a NMEA2000 network and can be accessed via VNC from phone/tablet/notebook. On board I also have a NMEA183 streamed via Wifi/UDP.

Here are my (scaled down for Mac, native resolution for Pi) screen shot of the own ship page.

I will send you a PM with my email-address.

Best,

Manfred

Dear Manfred,


Those images appear to be good and clear. Only suggestion is to see if you can adjust the menu to use less real estate, without having a slider show. We are using screenshot name format like this tb-opt-ship-ownship (etc) png or jpg.
Your rpi is resolution width 240 (a little low) and DPI 240. Your mac image is resolution width 865 (maybe a little high) and DPI 144 (this one is 140kb, would like to get it lower).

Your MacOS and RPI experience and setup will be an asset for Editing.
I will add you to the List of 2024 Editors next. Thank you!


Rick

[Portage_bay]

A little late to the party. Using the same screen shot rgleason used in post #24 Options/Ships I come up with the attached screen shots.


One is not reduced, file size is 314 KB. It seems to be quite clear when zoomed in. The other is reduced to a width of 800, file size is 208 KB. It seems to be a bit fuzzy when zoomed in.



I'm using Windows 11 on Lenovo laptop and Paint.net

1. Capture the image to the clipboard using the built in function key PrtSc (Print Screen), rectangle mode. PrtSc seems to bring up the snipping tool on this setup.
2. Paste into Paint.net as new image.
3. Clean up the edges around the original screenshot if need be using crop to selection
4. Resize to 800 pixel width using the settings shown
5. Save As

[rgleason]

@Portage_bay
If you want to be a 2024 Editor of the User Manual, send me a PM with the following:
Full Name:
Username: (same as CF? I hope)
Email:
OS Platform:
Photo software using:

Regarding your images. I would conclude as you have. We need crisp images less than 120kb. You are using Windows 11. We found that Snipping tool JSSailem suggested, it is very good I believe I will be using that. Try to make a couple of more images using Snipping Tool.
See my notes below. Thanks.

Trying the Windows Snipping Tool
1. Add Windows Snipping Tool to the Taskbar
2.Windows Key - Shift-S to start a snip.
3. Crop the area.
4. Select the Snipping tool Clipboard popup (in the lower right corner) to edit.
5. Then a new window appears.
6. Click the upper right Disk (Save as) Icon and save it as png directly.

Really easy, just about two moves. Cut out, Click on lower right clipboard, save it using the upper right disk.

See the next post #25.

That is only 50kb and is png. Looks good too.

[flpaoli]

@rgleason, as I'm reading through the Basic User Manual / Quick Start Guide / Chart Installation page, I think it will become easier for a new basic user if it isn't organized by chart type, but by geography.

For a basic user, we should determine what is the simplest way to get a chart for each geography (or the most popular ones), and make sub-sections per geography with instructions of how to get those charts. Then at the end of each section explain there are other options and link to an advanced page that describes them.

As a new user, when one reads "OpenCPN can read NOAA charts, BSB, S-57 unencrypted and early CM93 charts and MBTiles" the immediate thought I believe is going to be "wow, this is complicated, I have no idea what I need, I'm not techie enough, this isn't for me". We can tell them a default solution that works for their geography without explaining all that OpenCPN can do to everyone.

Thoughts on that approach?

If you like it, I'll need a list of chart types per geography to draft a version of the page following this approach.

[rgleason]

Originally Posted by flpaoli

@rgleason, as I'm reading through the Basic User Manual / Quick Start Guide / Chart Installation page, I think it will become easier for a new basic user if it isn't organized by chart type, but by geography.

For a basic user, we should determine what is the simplest way to get a chart for each geography (or the most popular ones), and make sub-sections per geography with instructions of how to get those charts. Then at the end of each section explain there are other options and link to an advanced page that describes them.

As a new user, when one reads "OpenCPN can read NOAA charts, BSB, S-57 unencrypted and early CM93 charts and MBTiles" the immediate thought I believe is going to be "wow, this is complicated, I have no idea what I need, I'm not techie enough, this isn't for me". We can tell them a default solution that works for their geography without explaining all that OpenCPN can do to everyone.

Thoughts on that approach?

If you like it, I'll need a list of chart types per geography to draft a version of the page following this approach.

Good idea. I think we could have a small table with this information on the Chart Install page.


USA Chartdownloader NOAA Enc Charts Free
Canada Ocharts.org Encrypted Purchase
Carabean Ocharts.org Encrypted Purchase
South America
EuropeAfrica
etc. Most of the rest require Ocharts

Look at Chart Sources in the manual.

There is old CMP93 Charts that can sometimes be found that will work.


From the programming side there has been some real progress on First User improvement and one of those is considering download of an available free chart.

[Aldebaran17]

Originally Posted by rgleason

STEP 2 Testing and Learning

In OpenCPN Dokuwiki we have an Editor Manual with a TEST & LEARN page.
I've copied a typical page from the User Manual Basic into this page. It is missing the main Toolbar > Options menu screenshot.

After making the necessary screenshot and naming it the typical way with your name added, please log into the OpenCPN manual and go to that page TEST & LEARN page and
1. add your screenshot using Media Manager (see the Edit Manual item about this)
2. Add a title with your name underneath
3. Describe the way you created the image.
4. Give the properties of the image: pixels, dpi, color depth bits, compression if jpeg , etc.
5. Review the image as it appears in this Test and Learn page.

Each one of you can add your image and text below the first one who does it.


Note about where to save the media files.

1. We are changing where we save image files, before we kept them in opencpn:manual, now we are

2. Go to the page that needs editing.
3. Open the page in the Editor.
4. Select Media Manager and when you select and upload, media manager will automatically upload the file to the correct location.
5. The location or "namespace" used can be copied from the top of the media manager, but the easiest thing to do is
6. Select and Upload the file.
7. Then in Media Manager click on the filename of the image you uploaded and an image link will be made in the text where your cursor is located.
8. To see the image "Save" the page (down at the bottom).
9. Image links look like this {{pencpn:manual_basic:ui-toolbar-hamburger-options.jpg?40|}}
10. Adjust the size with the numbers at the end.



Good luck.
Rick

Dear Rick,

I tried following your instructions and am stuck at point 7. My image is visible in the media manager, but no link is showing up automatically in the document, when clicking to the image in the media manager. Well, I found a workaround, which is probably not wanted. I copied the URL given by the media manager and inserted this with "image" icon in the editor.

Manfred

[rgleason]

Originally Posted by Aldebaran17

Dear Rick,

I tried following your instructions and am stuck at point 7. My image is visible in the media manager, but no link is showing up automatically in the document, when clicking to the image in the media manager. Well, I found a workaround, which is probably not wanted. I copied the URL given by the media manager and inserted this with "image" icon in the editor.

Manfred

Manfred I've rewritten and tried to clarify, hope it helps.

Upload Screenshots Hope that is clearer.
Media Manager

[Aldebaran17]

Originally Posted by rgleason

Manfred I've rewritten and tried to clarify, hope it helps.

Upload Screenshots Hope that is clearer.
Media Manager

Thanks. This is clear - even to me. I managed to upload the image again.

[rgleason]

Originally Posted by Aldebaran17

Thanks. This is clear - even to me. I managed to upload the image again.

Manfred this is a good image. Thanks

[Gilletarom]

Hello RGleason,

I would like to try to update the page relating to the two plugins
- Grib
- Weather Routing.

Gilletarom.

[rgleason]

Originally Posted by Gilletarom

Hello RGleason,

I would like to try to update the page relating to the two plugins
- Grib
- Weather Routing.

Gilletarom.

Gilletarom

That would be great and much appreciated, however there are two things to consider:
1. Plugins Manuals are done through github using Ascidoc/Antora
2. The main set of manuals for OpenCPN are done with Dokuwiki.


A. I can certainly make you an Editor for the OpenCPN Manuals if you send me a PM with your full name, email, desired username and OS and Hardware, and what you use for photo editing or sceenshots.
B. The plugins manual link page is here
https://opencpn.org/wiki/dokuwiki/do...manual_plugins
At the bottom it discussed how to Edit Plugin Manuals.


https://opencpn-manuals.github.io/ma...ng/author.html
1. Gilly you should get a free Github Account first (very useful anyway)
2. Then you will need to hit the Edit Page button for those two plugins and edit the sections you want changed and then make a git commit to have it saved for review and adding to the manual. (I told the guys that this would be more difficult for users, but we decided to move them to the github system anyway, programmers know git).


PS: One other way is you write up the changes and send me any screenshots and tell me where you want the changes, and I can do it. You have my email.