[education/kstars] doc: Added handbook section on editing the scheduler queue while running, and on...

2024-01-15 Thread Hy Murveit
Git commit 47e7a0a6f8872f4fb0dfb120d45608c98f4e08df by Hy Murveit.
Committed on 15/01/2024 at 22:29.
Pushed by murveit into branch 'master'.

Added handbook section on editing the scheduler queue while running, and on...

Added handbook section on editing the scheduler queue while running, and on the 
Capture Sequence Editor.

M  +5-0doc/ekos-capture.docbook
M  +40   -2doc/ekos-scheduler.docbook
A  +---doc/ekos_capture_sequence_editor.png

https://invent.kde.org/education/kstars/-/commit/47e7a0a6f8872f4fb0dfb120d45608c98f4e08df

diff --git a/doc/ekos-capture.docbook b/doc/ekos-capture.docbook
index 6d6a5edcea..565a63e974 100644
--- a/doc/ekos-capture.docbook
+++ b/doc/ekos-capture.docbook
@@ -343,6 +343,11 @@
 
 To edit a job, double click it. You will notice the add button 
 now changed to check mark 
button . Make your changes on the 
left-hand side of the CCD module and once done, click on the check mark button. 
To cancel a job edit, click anywhere on the empty space within the sequence 
queue table.
 
+
+
+  Editing running jobs: When 
Capture is running, or when the Scheduler is running, you cannot edit the 
sequence queue or a .esq file on disk using the Capture tab. However, the 
scheduler tab does have a Capture Sequence Editor tool that can be used to edit 
.esl files on disk, or create new ones.
+
+
 
 If your camera supports live video feed, then you can click the 
Live Video button to start streaming. The video stream 
window enables recording and subframing of the video stream. For more 
information, check the video below:
 
diff --git a/doc/ekos-scheduler.docbook b/doc/ekos-scheduler.docbook
index 61103b5cc0..2b287aa70e 100644
--- a/doc/ekos-scheduler.docbook
+++ b/doc/ekos-scheduler.docbook
@@ -80,9 +80,9 @@
 
 
 
-Scheduler Files (.esq)
+Scheduler Files (.esl)
 
-  The scheduler table with its list of jobs and attributes can be 
saved onto disk and read back in. It writes an .esq file. Controls for writing 
the current Scheduler table to disk, and reading back other .esq files are 
located above the table to the right.
+  The scheduler table with its list of jobs and attributes can be 
saved onto disk and read back in. It writes an .esl file. Controls for writing 
the current Scheduler table to disk, and reading back other .esl files are 
located above the table to the right.
 
 
 
@@ -189,6 +189,44 @@ There is a checkbox and number input right below the 
Scheduler jobs table that a
 

 
+
+Editing running jobs
+
+  It is possible to edit the scheduler's job table, and attributes of 
individual jobs, while the scheduler is running. As always, you double click on 
a job, change the desired attributes, and click the checkbox to finalize the 
change. If you edit the running job it will be restarted (i.e. the startup 
steps (slew, focus, align, guide) will be re-done. You can also move jobs up 
and down in priority, add new jobs, or deleted existing ones. You cannot delete 
the running job.
+
+
+  One important attribute of scheduler jobs is their sequence file 
(.esq) which controls the capture module while the job is running. For example, 
it sets number of captures, filters used, gain/ISO, etc. The .esq is normally 
created and edited in the capture tab, but that cannot be done while the 
scheduler is running. If you desire to make changes to a .esq file while the 
scheduler is running, or create a new one, the scheduler provides a tool called 
the Capture Sequence Editor.
+  
+   
+Capture Sequence Editor
+
+   The Capture Sequence Editor is a tool to create and edit capture 
sequence files (.esq) which can be started by clicking the edit (pencil) icon 
just above the scheduler table. A screenshot is shown below.
+
+  
+
+Capture Sequence Editor
+
+
+
+
+
+
+Capture Sequence Editor
+
+
+
+
+  The editor is very similar in use and layout to the capture 
tab--though it is missing all the controls to actually capture image. You edit 
jobs the same way you do in capture, and load or save sequence queues the same 
way too (though there are additional Load and Save-To buttons provided in the 
editor).
+
+
+It is important to understand that capture sequences rely to 
some extent on the filterwheel and camera being used (e.g. the filter names, 
the possible ISO values, ...). The Capture Sequence Editor, which is not 
connected to the device drivers, does not have direct access to this 
information. Instead, the editor uses the values from the last time the capture 
tab 

[sdk/kdesrc-build] /: Add --show-options-specifiers option

2024-01-15 Thread Andrew Shark
Git commit 35e68fb5b925ef438cf441ead6dce3285f0fdbc8 by Andrew Shark.
Committed on 15/01/2024 at 18:23.
Pushed by ashark into branch 'master'.

Add --show-options-specifiers option

M  +8-8doc/supported-cmdline-params.docbook
M  +9-10   modules/ksb/Cmdline.pm

https://invent.kde.org/sdk/kdesrc-build/-/commit/35e68fb5b925ef438cf441ead6dce3285f0fdbc8

diff --git a/doc/supported-cmdline-params.docbook 
b/doc/supported-cmdline-params.docbook
index 71993bdc..219c9099 100644
--- a/doc/supported-cmdline-params.docbook
+++ b/doc/supported-cmdline-params.docbook
@@ -704,14 +704,6 @@ Display the program version.
 
 
 
-
---author
-
-Display contact information for the
-author.
-
-
-
 
 --help (or -h)
 
@@ -728,6 +720,14 @@ prove useful in bug reports or when asking for help in 
forums or mailing lists.
 
 
 
+
+--show-options-specifiers
+
+Print the specifier lines (in the format that GetOpts::Long accepts) for all 
command line options supported by the script.
+This may be used by developers, for example, for generating zsh autocompletion 
functions.
+
+
+
 
 
 
diff --git a/modules/ksb/Cmdline.pm b/modules/ksb/Cmdline.pm
index b11dc63a..2422cd83 100644
--- a/modules/ksb/Cmdline.pm
+++ b/modules/ksb/Cmdline.pm
@@ -142,7 +142,7 @@ sub readCommandLineOptionsAndSelectors (@options)
 %foundOptions = (
 'show-info' => sub { _showInfoAndExit();},
 version => sub { _showVersionAndExit(); },
-author  => sub { _showAuthorAndExit();  },
+'show-options-specifiers' => sub { _showOptionsSpecifiersAndExit(); },
 help=> sub { _showHelpAndExit();},
 
 # Intended as a short option, -d would imply --include-dependencies and
@@ -399,17 +399,16 @@ sub _showInfoAndExit
 exit;
 }
 
-sub _showAuthorAndExit
+sub _showOptionsSpecifiersAndExit
 {
-my $version = "kdesrc-build " . scriptVersion();
-say <<~DONE;
-$version was written (mostly) by:
-  Michael Pyne 
+my @supportedOptions = _supportedOptions();
 
-Many people have contributed code, bugfixes, and documentation.
+# The initial setup options are handled outside of Cmdline (in the 
starting script).
+my @initial_options = ("initial-setup", "install-distro-packages", 
"generate-config", "update-shellrc");
 
-Please report bugs using the KDE Bugzilla, at https://bugs.kde.org/
-DONE
+foreach my $option (@supportedOptions, @initial_options) {
+print "$option\n";
+}
 
 exit;
 }
@@ -420,7 +419,6 @@ sub _supportedOptions
 # See https://perldoc.perl.org/5.005/Getopt::Long for options 
specification format
 
 my @non_context_options = (
-'author',
 'build-only',
 'dependency-tree',
 'dependency-tree-fullpath',
@@ -441,6 +439,7 @@ sub _supportedOptions
 'resume-from|from|f=s',
 'set-module-option-value=s',
 'show-info',
+'show-options-specifiers',
 'src-only|s',
 'start-program|run=s{,}',
 'stop-after|to=s',