Merge pull request #552 from jongough/updates

Update to ODraw documentation

CMakeLists.txt

@@ -61,8 +61,8 @@ set(PACKAGE "ocpn_draw")
 set(VERSION_MAJOR "1")
 set(VERSION_MINOR "8")
 set(VERSION_PATCH "49")
-set(VERSION_TWEAK "0")
-set(VERSION_DATE "03/04/2024") # DD/MM/YYYY forma0t
+set(VERSION_TWEAK "1")
+set(VERSION_DATE "11/05/2024") # DD/MM/YYYY forma0t
 set(OCPN_MIN_VERSION "ov50")
 set(OCPN_API_VERSION_MAJOR "1")
 set(OCPN_API_VERSION_MINOR "17")

ci/circleci-build-msvc.bat

@@ -18,6 +18,8 @@ dir %SCRIPTDIR%..\msvc
 call %SCRIPTDIR%..\msvc\win_deps.bat %wx_vers%
 path %SCRIPTDIR%.local\bin;%PATH%;"C:\Program Files\CMake\bin"
 call "%SCRIPTDIR%..\cache\wx-config.bat"
+set PATH=%EXTRA_PATH%;%PATH%
+echo EXTRA_PATH: %EXTRA_PATH%
 echo USING wxWidgets_LIB_DIR: %wxWidgets_LIB_DIR%
 echo USING wxWidgets_ROOT_DIR: %wxWidgets_ROOT_DIR%
 echo USING OCPN_TARGET_TUPLE: %TARGET_TUPLE%
@@ -42,6 +44,10 @@ wget https://download.opencpn.org/s/oibxM3kzfzKcSc3/download/OpenCPN_buildwin-4.
 wget https://download.opencpn.org/s/54HsBDLNzRZLL6i/download/nsis-3.04-setup.exe
 nsis-3.04-setup.exe /S
 
+echo Check if poedit has been installed
+poedit -version
+echo Done check
+
 echo Create build environment
 
 if "%MSVC_VERSION%" == "2019" (

manual/modules/ROOT/pages/index.adoc

@@ -1,4 +1,4 @@
-= Ocpn_Draw 1.6
+= Ocpn_Draw 1.8
 
 Developer: Jon Gough
 
@@ -247,8 +247,10 @@ multiple Draw objects and then import them when you have finished.
 This version of the plugin requires at least version of OpenCPN 5.xx.yy.
 It is not compatible with any version before this. The reason is that
 the user interface changed with OCPN 5 and a new graphics library was
-used. +
-Download the plugin from the Plugin Downloads section of opencpn.org
+used.
+Download the plugin using OpenCPN Plugin Manager found in OpenCPN
+settings/Plugins.
+
 
 == Interface Icons
 
@@ -257,15 +259,15 @@ in the OpenCPN Toolbar, they will always appear together, but depending
 on the other plugins that are currently active may appear in different
 positions within the toolbar.
 
-image::od_toolbar_icons.png[image,width=44,height=71]OCPN
-Toolbar icons
+image::od_toolbar_icons.png[image,width=44,height=71]
+OCPNToolbar icons
 
 The top icon is for the Draw Paths and Points Manger, the bottom icon is
 the Draw tool that was last used. It can be any of the tools from the
 Draw Toolbar below.
 
-image::od_toolbar.png[image,width=239,height=69]Draw
-Toolbar
+image::od_toolbar.png[image,width=239,height=69]
+Draw Toolbar
 
 Depending on the settings you have chosen for Draw this toolbar may
 never be displayed, displayed whilst a drawing tool is in use or always
@@ -353,6 +355,12 @@ they will load into the same layer. To use Layers and move Drawing
 Objects into a temporary user created Layer, select them, Export
 Selected and then import then from the Layers tab Import.
 
+Layers can also be persistent meaning that the layer will be reloaded
+after a restart. By default persistent layers will not be shown,
+however, this behaviour can be changed by setting the *_Show Layers_*
+checkbox to a tick. Then all persistent layers will be shown over
+a restart.
+
 === Edit Mode for Draw Objects
 
 First, if you are in the 'create' mode you must terminate this by, Right
@@ -441,8 +449,7 @@ This section will describe in more detail the drawing tools that are
 available with this Plug In.
 
 === Boundary
-
-image::boundary_mui.png[]
+image:boundary_mui.png[]
 
 This allows drawing of a closed path joining all points that of the
 path. The smallest Boundary has two points, but normal Boundaries will
@@ -494,8 +501,7 @@ As such, each Boundary Point can have the same capabilities as
 individual Boundary Points.
 
 === Boundary Point
-
-image::pointbutton_mui.png[]
+image:pointbutton_mui.png[]
 
 This allows the placing of individual points on the chart. They are very
 similar to 'Marks' that can be dropped by OpenCPN. However, they have
@@ -525,8 +531,7 @@ create mode is terminated. This allows the placing of as many points
 with single mouse left clicks as the user wishes.
 
 === Text Point
-
-image::textpointbutton_mui.png[]
+image:textpointbutton_mui.png[]
 
 This allows the placing of individual Text Points on the chart. They
 appear very similar to Boundary Points, but they allow the displaying of
@@ -588,8 +593,7 @@ text. You can pick the font and the font metrics to use for all the text
 associated with one text point.
 
 === Electronic Bearing Line (EBL)
-
-image::ebl_mui.png[]
+image:ebl_mui.png[]
 
 The EBL always starts attached to the boat with the far end of the line
 being placed by left clicking the chart. The default action for the end
@@ -666,8 +670,7 @@ in the ocpn_draw_pi section of the config file as there is no setting in
 the properties dialog for this.
 
 === Dead Reckoning (DR)
-
-image::dr_mui.png[]
+image:dr_mui.png[]
 
 This draws a Dead Reckoning line with multiple points along it starting
 at the boats current location. As mentioned above, this tool does not
@@ -681,8 +684,7 @@ COG/SOG. So the DR line at that point becomes more of a line with
 possibly little meaning in the context of DR.
 
 === Guard Zone (GZ)
-
-image::gz_mui.png[]
+image:gz_mui.png[]
 
 This draws a segment of a torus or doughnut. The centre is the boat and
 the angle and size is determined from the two points that are used to
@@ -701,8 +703,7 @@ boat irrespective of which direction the boat is moving. This is set in
 the default propertiesd but can also be changed for each individual GZ.
 
 === Parallel Index Line (PIL)
-
-image::pil_mui.png[]
+image:pil_mui.png[]
 
 Annex to IMO res.A893(21)-Guidelines For Voyage Planning. Section 4-
 Appraisal
@@ -870,8 +871,7 @@ These will either copy/past in the selected box or will copy/paste both
 the Latitude and Longitude at the same time.
 
 == Settings
-
-image::od-settings.png[]
+image:od-settings.png[]
 
 Options > Plugins > Ocpn Draw > Preferences +
 Under Preferences the Tabs are General, Boundary, Boundary Point, Text
@@ -926,6 +926,10 @@ unchecked and use right click and move waypoint. If you intend to move
 entire zone check this option, it is a brilliant concept and very
 useful.
 
+=== Show Layers
+
+This checkbox hides, unchecked, or shows, checked, layers on restart.
+
 === Nav Object Backups
 
 This setting determines how many backups to keep of the navigation
@@ -947,6 +951,12 @@ but before the first object is created. This is supplied so that the
 screen does not start panning if you move your pointer off of the toll
 bar near the edge of the screen.
 
+=== Toolbar icon scaling (requires restart)
+
+If the OCPN Draw toolbar is not the required size this item allows
+scaling of the icons. On most systems this will require restarting
+OpenCPN, or deactivating and reactivating OCPN Draw.
+
 === Display Toolbar
 
 The plugin allows you to use two graphical methods of selecting the tool
@@ -968,7 +978,7 @@ whether you are using the plugin.
 
 This setting allows the user to set all settings back to the default
 value. If the button has the label 'Yes' and it is clicked this will
-ensure that no settings are saved when OCPN is shut down. The text of
+ensure that no OCPN Draw settings are saved when OCPN is shut down. The text of
 the label will be changed to 'Remove OCPN_Draw setting and restore to
 default on restart (Yes)' to indicate what will happen. The button label
 will now say 'No' indicating what will hapen if it is clicked again.
@@ -1202,6 +1212,16 @@ wrapping the displayed text. In Font Based the font being used will
 determine where the wrapping occurs. In Character Based the count of the
 characters will determine where the wrapping occurs.
 
+=== Show Display Text
+
+This is the default for when the Display Text of a Text Point is shown.
+
+* Always - Display text is always shown
+* On Rollover Only - The text will be displayed when the mouse pointer
+rolls over the Text Point. This is to try and help declutter the screen
+if there are many objects being concurrently displayed.
+* Never - The display text is not displayed
+
 === Maximum Text Width
 
 Depending on the selection of Maximum Width Type will determine the
@@ -1230,16 +1250,6 @@ by a platform specific font picker. The current font that will be used
 is shown by the work 'Example' which will be drawn using the font
 selected.
 
-=== Show Display Text
-
-This is the default for when the Display Text of a Text Point is shown.
-
-* Always - Display text is always shown
-* On Rollover Only - The text will be displayed when the mouse pointer
-rolls over the Text Point. This is to try and help declutter the screen
-if there are many objects being concurrently displayed.
-* Never - The display text is not displayed
-
 === Path (this item is currently hidden)
 
 image::od-preferences-path.png[]
@@ -1718,8 +1728,6 @@ This page provides information on the interaction of this plugin with
 the Watchdog plugin. This shows when alarms should ring for various
 boundary types.
 
-== 
-
 == OCPN_Draw directories
 
 OCPN_Draw uses a set of directories to hold information and data, these

msvc/win_deps.bat

@@ -29,6 +29,10 @@ echo In win_deps
 
 setlocal enabledelayedexpansion
 
+if not exist %SCRIPTDIR%\..\cache ( mkdir %SCRIPTDIR%\..\cache )
+set "CONFIG_FILE=%SCRIPTDIR%\..\cache\wx-config.bat"
+set EXTRA_PATH=
+
 git --version > nul 2>&1
 if errorlevel 1 (
    set "GIT_HOME=C:\Program Files\Git"
@@ -41,15 +45,15 @@ cmake --version > nul 2>&1
 if errorlevel 1 (
   set "CMAKE_HOME=C:\Program Files\CMake"
   choco install -y --no-progress cmake
-::  pathman add "!CMAKE_HOME!\bin" > nul
-::  echo Adding !CMAKE_HOME!\bin to path
+  set "EXTRA_PATH=%CMAKE_HOME%\bin;%EXTRA_PATH%"
 )
 
 :: Install choco poedit and add it's persistent user path element
 ::
-set "POEDIT_HOME=C:\Program Files (x86)\Poedit\Gettexttools"
-if not exist "%POEDIT_HOME%" choco install -y poedit
-::pathman add "%POEDIT_HOME%\bin" > nul
+set "POEDIT_HOME=C:\Program Files (x86)\Poedit\GettextTools"
+if not exist "%POEDIT_HOME%" (choco install -y poedit)
+dir "%POEDIT_HOME%"
+set "EXTRA_PATH=%POEDIT_HOME%\bin;%EXTRA_PATH%"
 
 :: Update required python stuff
 ::
@@ -78,9 +82,9 @@ if "%~1"=="wx32" (
   set "TARGET_TUPLE=msvc"
 )
 
-if not exist %SCRIPTDIR%\..\cache ( mkdir %SCRIPTDIR%\..\cache )
-set "CONFIG_FILE=%SCRIPTDIR%\..\cache\wx-config.bat"
-echo set "wxWidgets_ROOT_DIR=%wxWidgets_ROOT_DIR%" > %CONFIG_FILE%
+:: Add settings to CONFIG_FILE to allow them to be set in the calling batch file
+echo set "EXTRA_PATH=%EXTRA_PATH%" > %CONFIG_FILE%
+echo set "wxWidgets_ROOT_DIR=%wxWidgets_ROOT_DIR%" >> %CONFIG_FILE%
 echo set "wxWidgets_LIB_DIR=%wxWidgets_LIB_DIR%" >> %CONFIG_FILE%
 echo set "TARGET_TUPLE=%TARGET_TUPLE%" >> %CONFIG_FILE%
 
@@ -105,5 +109,5 @@ if not exist "%WXWIN%" (
   )
 )
 dir cache
-type cache\wx-config.bat
+type "%CONFIG_FILE%"
 refreshenv