Git commit 2504480422ab909a32bc2ead43976d30c2eb027c by Yuri Chornoivan. Committed on 22/08/2024 at 05:55. Pushed by yurchor into branch 'master'.
Fix minor typos and formatting M +10 -8 doc/ekos-extensions.docbook https://invent.kde.org/education/kstars/-/commit/2504480422ab909a32bc2ead43976d30c2eb027c diff --git a/doc/ekos-extensions.docbook b/doc/ekos-extensions.docbook index 672ca7c63b..07de3eb9c5 100644 --- a/doc/ekos-extensions.docbook +++ b/doc/ekos-extensions.docbook @@ -20,6 +20,7 @@ <title>Requirements</title> <para> Each extension must consist of at least 2 files, with an optional third icon file. + </para> <itemizedlist> <listitem> <para> @@ -31,7 +32,7 @@ The configuration file. This is a plain text file that defines the required and optional inputs for the extension. It must be named the same as the extension executable with the addition of a .conf file name extension. </para> <para> - It is mandatory that the configuration file contains a line starting with <emphasis role="bold">minimum_kstars_version=n.n.n</emphasis> where n.n.n is the lowest version of KStars that supports the extension eg. 3.7.1 + It is mandatory that the configuration file contains a line starting with <emphasis role="bold">minimum_kstars_version=n.n.n</emphasis> where n.n.n is the lowest version of KStars that supports the extension ⪚ 3.7.1 </para> <para> Optionally (and non-preferred) the configuration file may contain a line starting with <emphasis role="bold">runDetached=true</emphasis>. If present this line makes the extension run independently from KStars. Once it has been started the extension can not pass status information back to Ekos. This should only be used by extensions that are required to continue to run after KStars has closed. The extension must also provide it's own user interface. @@ -46,8 +47,9 @@ </para> </listitem> </itemizedlist> - All files of the extension (executable, configuration, and optional icon) must be copied into the KStars writable data location /extensions eg. ~/.local/share/kstars/extensions - </para> + <para> + All files of the extension (executable, configuration, and optional icon) must be copied into the KStars writable data location /extensions ⪚ ~/.local/share/kstars/extensions + </para> <para> Extensions that are present, have a valid configuration file, and have a minimum KStars version no higher than the current installation will be detected when Ekos is started. If there are no valid extensions detected the extension UI element will not be displayed. The extension UI elements are a ComboBox showing the name and icon of each detected extension, and a start/stop button. If the extension fails to close within 10 seconds of the stop button being clicked, it becomes re-enabled as an abort button that will force close the extension. Only one extension can be used at a time. </para> @@ -55,16 +57,17 @@ <sect2 id="extensions-Development"> <title>Development</title> <para> - The following describes additional points for developers of extensions. + The following describes additional points for developers of extensions. + </para> <itemizedlist> <listitem> <para> - Some extension sources including an example skelton extension are available in the <ulink url="https://github.com/LuckyEddie47/kstars_extensions";>KStars Extension Github</ulink> + Some extension sources including an example skeleton extension are available in the <ulink url="https://github.com/LuckyEddie47/kstars_extensions";>KStars Extension Github</ulink> </para> </listitem> <listitem> <para> - Each extension must check for the existance and validity of it's own configuration file. The minimum_kstars_version configuration file entry must be checked against an internal reference to confirm that the configuration file matches the extension requirements. See the skelton example. + Each extension must check for the existence and validity of it's own configuration file. The minimum_kstars_version configuration file entry must be checked against an internal reference to confirm that the configuration file matches the extension requirements. See the skeleton example. </para> </listitem> <listitem> @@ -74,13 +77,12 @@ </listitem> <listitem> <para> - All interaction with KStars/Ekos/INDI should be via the DBus interface. See the skelton exmaple. Useful tools for interrogating, monitoring and understanding DBus include <ulink url="https://wiki.gnome.org/Apps/DFeet>D-Feet">D-Feet</ulink> and <ulink url="https://gitlab.freedesktop.org/bustle/bustle";>Bustle</ulink> + All interaction with KStars/Ekos/INDI should be via the DBus interface. See the skeleton example. Useful tools for interrogating, monitoring and understanding DBus include <ulink url="https://wiki.gnome.org/Apps/DFeet>D-Feet">D-Feet</ulink> and <ulink url="https://gitlab.freedesktop.org/bustle/bustle";>Bustle</ulink> </para> <para> It may appear on initial investigation that using the Qt DBus Adaptors system would be much easier than direct use of the Qt DBus Interfaces/Messages and KStars does provide the required xml definitions. However currently there is heavy use of custom types the definitions of which are combined with other information in the KStars sources. This results in a large set of files from KStars that require inclusion within an extension in order to make use of the Qt DBus Adaptors. Hopefully this will be addressed in the future. </para> </listitem> </itemizedlist> - </para> </sect2> </sect1>
