Skip to content

Commit

Permalink
v0.37 ! Better About Box, tweak release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidbannon
davidbannon committed Dec 22, 2023
1 parent 6e5894a commit 6faa7ce
Show file tree
Hide file tree
Showing 7 changed files with 93 additions and 177 deletions.
55 changes: 30 additions & 25 deletions doc/wiki/Bugs-and-Known-Issues.note
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ There is some advice about DIY debugging further down this document.

<size:huge><bold>Known Issues</bold></size:huge>

<list><list-item dir="ltr"><list><list-item dir="ltr">On some Macs, when using the in note Find tool, a 'shadow highlight' can appear superimposed over the button bar. It does no harm, disappears when you move the mouse over the button but is unsightly. Its a know upstream problem, https://forum.lazarus.freepascal.org/index.php/topic,53055.0.html .</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">On some older Macs, when using the in note Find tool, a 'shadow highlight' can appear superimposed over the button bar. It does no harm, disappears when you move the mouse over the button but is unsightly. Its a know upstream problem, https://forum.lazarus.freepascal.org/index.php/topic,53055.0.html .</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Do not set your notes directory to be on a network share. Please keep your notes on a local disk and use the sync facility to share them with other machines (or even the same multiboot machine).</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">On at least Debian Bookworm KDE (using Wayland) tomboy-n will fail unless its passed an enviournment variable to force use of xcb, see below.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Qt versions do not always pick up System Colours, you need to give the app a hint what colour theme to use, see bleow.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Qt versions do not always pick up System Colours, you need to give the app a hint what colour theme to use, see below.</list-item></list></list-item></list>


<size:huge><bold>Specific Things with a Work Around</bold></size:huge>
Expand All @@ -27,14 +26,10 @@ There is some advice about DIY debugging further down this document.
Can be a problem on some Linux Desktops. Generally, I don't suggest Qt5 version of tomboy-ng with systems that use Qt5 earlier than 5.15. So, using Ubuntu 20.04 (Qt5 is 5.12) is a risk factor. Setting your Qt theme to 'gtk3' on those early Qt5 systems is asking for trouble. I have not tested on systems with Qt5 between 5.12 and 5.15 so your mileage may vary. By time you get to Qt5 5.15, it all just works !

<size:large><bold>Qt5 and Wayland</bold></size:large>
On some (but not all) Wayland using Desktops, there are still a number of Qt5 problems. This is particularly the case <bold>Debian KDE Bookworm</bold>. The solution is to force the app to use xcb instead of direct to Wayland. Set an environment variable, QT_PLATFORM=xcb and it all works perfectly. Test this from the command line like this

$&gt; QT_PLATFORM=xcb tomboy-ng [enter]

And if you like the result, set it permently using one of the models described below.
If you launch tomboy-ng from the console on a Wayland using system, you see a number of harmless messages coming from the Qt libraries. Just ignore them.

<size:large><bold>Dark Theme</bold></size:large>
Generally, the QT5 apps do not pick up the Dark Theme from the operating system. You can pass the executable a --dark-theme switch but the results are not great. A much better approach is to use Qt5's theme setting capability, using <bold>QT_QPA_PLATFORMTHEME</bold> env var. Some operating systems set this for you, other require you to do it. The easist approach (on most Linux systems) is set it to your existing gtk2 or gtk3 theme, you will need to install the <bold>qt5-style-plugins</bold> package using your normal package manager, then, start tomboy-ng with the enviournment variable set to either 'gtk2' or 'gtk3'. Small section below on setting the variable.
Sometimes, QT5 apps do not pick up the Dark Theme from the operating system. You can pass the executable a --dark-theme switch but the results are not great. A much better approach is to use Qt5's theme setting capability, using <bold>QT_QPA_PLATFORMTHEME</bold> env var. Some operating systems set this for you, other require you to do it. The easist approach (on most Linux systems) is set it to your existing gtk2 or gtk3 theme, you will need to install the <bold>qt5-style-plugins</bold> package using your normal package manager, then, start tomboy-ng with the enviournment variable set to either 'gtk2' or 'gtk3'. Small section below on setting the variable.

Another approach is to install the <bold>qt5ct</bold> package from your package manager and set any colour theme you like. The qt5ct command has a nice GUI, select 'custom' and choose the theme you want. Again, you will need to set the same environment variable, this time to 'qt5ct', it tells Qt apps (including qt5ct itself) that you are using qt5ct colours but only works after you have started qt5ct and selected a color scheme.

Expand Down Expand Up @@ -85,32 +80,41 @@ GTK2 (and Qt5 using tricks mentioned above) do a clean and functional Dark Theme

It also possible to pass a --dark-theme switch to the application on the command line and you get, sort of, a Dark Theme. Sadly, some forms in the application are based on components that simply will not play, Settings being a good example. Sorry.

<size:large><bold>QT5 versions and Gnome Desktops</bold></size:large>
It appears that even Qt5 apps can now use XWayland so much of this is unnecessary, leave it here for now, just in case.
Almost all Gnome Desktops now use the Wayland Display Manager instead of X (or XCB). QT5 has a plugin that will manage the connection between a QT5 app and Wayland, typically called qtwayland5, you may find it already installed or need to manually install it yourself. If you run a QT5 app, such as the QT5 version of tomboy-ng, you may see a warning to the effect that its ignoring the request to run under Wayland, if you want it to run under Wayland, do something like -

QT_QPA_PLATFORM=wayland tomboy-ng [enter]

You can do so (if you have qtwayland5 installed) but it seems to make little or no difference and does trigger a couple of warning messages from the QT libraries. So, honestly, don't worry about it.
<size:large><bold>System Tray Issues</bold></size:large>
Please see https://github.com/tomboy-notes/tomboy-ng/wiki/System-Tray-on-Linux - generally only a problem for people using the Gnome Desktop

<size:large><bold>Calc separator</bold></size:large>
In the calculator, many countries use the comma instead of a period as a decimal separator. Quite difficult to fix, my apologies to people from locales where this is an issue. https://forum.lazarus.freepascal.org/index.php/topic,56305.msg418384.html#msg418384

<size:large><bold>System Tray Issues</bold></size:large>
Please see https://github.com/tomboy-notes/tomboy-ng/wiki/System-Tray-on-Linux - generally only a problem for people using the Gnome Desktop.


<size:huge><bold>Long term 'maybe' stuff</bold></size:huge>
These are things I have no immediate plans to fix, but they might be addressed some time in the future if there is some demand from end users.
<list><list-item dir="ltr"><list><list-item dir="ltr">On Linux GTK2 based versions, using the Compose Key approach to entering accented characters results in a bad character also being inserted. This is a known, upstream issue, https://bugs.freepascal.org/view.php?id=38454 . Qt5 versions do not have this problem.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Stop house keeping from moving viewport.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Restoring cursor position on note load.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Dark theme is less than perfect on Windows and unknown on Mac. Windows will not let us set a dark background to buttons, must look at owner draw modes.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Dark theme is less than perfect on Windows and unknown on Mac. Windows will not let us set a dark background to button.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Lines starting with an '*' should be auto converted to a Bullet.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Tabs do not work.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Tabs do not work and probably never will.</list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr">Revise controls, at present modelled on Tomboy, we can improve.</list-item></list></list-item></list>


<size:huge><bold>Legacy Fixes</bold></size:huge>
<bold>Notes, kept in case needed but generally do not apply anymore.</bold>

<size:large><bold>Qt and KDE Desktop Issues</bold></size:large>
On some (but not all) Wayland using Desktops, there are still a few Qt5 problems. This is particularly the case <bold>Debian KDE Bookworm</bold>. The solution is to force the app to use xcb instead of direct to Wayland. Set an environment variable, QT_PLATFORM=xcb and it all works perfectly. Test this from the command line like this

$&gt; QT_PLATFORM=xcb tomboy-ng [enter]

And if you like the result, set it permently, see Setting that Enviournment Variable

<size:large><bold>QT5 (or Qt6) versions and Gnome Desktops</bold></size:large>
It appears that even Qt5 apps can now use XWayland so much of this is unnecessary, leave it here for now, just in case.
Almost all Gnome Desktops now use the Wayland Display Manager instead of X (or XCB). QT5 has a plugin that will manage the connection between a QT5 app and Wayland, typically called qtwayland5, you may find it already installed or need to manually install it yourself. If you run a QT5 app, such as the QT5 version of tomboy-ng, you may see a warning to the effect that its ignoring the request to run under Wayland, if you want it to run under Wayland, do something like -

QT_QPA_PLATFORM=wayland tomboy-ng [enter]

You can do so (if you have qtwayland5 installed) but it seems to make little or no difference and does trigger a couple of warning messages from the QT libraries. So, honestly, don't worry about it.

<size:huge><bold>Debugging</bold></size:huge>
If you have problems with the application, or wish to make a feature request, please report via the github tomboy-ng issues facility.
Expand All @@ -133,6 +137,7 @@ If tomboy-ng crashes or does something unexpected, there are a number of command
<list><list-item dir="ltr"><list><list-item dir="ltr"><monospace>--import-md=PATH_to_FILE Import file into Note Repo also -m</monospace></list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr"><monospace>--import-note=PATH_to_NOTE Import file into Note Repo also -n</monospace></list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr"><monospace>--title-fname Use Filename as title for import txt &amp; md</monospace></list-item></list></list-item></list>
<list><list-item dir="ltr"><list><list-item dir="ltr"><monospace>--useappind=[yes|no] Ctrl use of AppInd (ie TrayIcon) on Linux</monospace></list-item></list></list-item></list>

<bold>Capturing to a file</bold>
Windows and Mac do not, for this purpose, have a console. But they too can be told to capture this log info to a file using another command line switch or by setting an env variable that specifies a file name. Please ensure you have permission to write to the location specified. For example a linux user would -
Expand Down Expand Up @@ -160,14 +165,14 @@ In all cases, you may need to zip that file up to post it on Github. If you do


</note-content></text>
<last-change-date>2023-05-09T15:18:43.2439021+10:00</last-change-date>
<last-metadata-change-date>2023-05-09T15:18:43.2439021+10:00</last-metadata-change-date>
<last-change-date>2023-12-22T09:25:50.9279222+11:00</last-change-date>
<last-metadata-change-date>2023-12-22T09:25:50.9279222+11:00</last-metadata-change-date>
<create-date>2018-06-23T12:35:30.7960000+10:00</create-date>
<cursor-position>1</cursor-position>
<selection-bound-position>1</selection-bound-position>
<width>1211</width>
<height>626</height>
<x>602</x>
<y>77</y>
<x>137</x>
<y>230</y>
<open-on-startup>False</open-on-startup>
</note>
Loading

0 comments on commit 6faa7ce

Please sign in to comment.