From 635ee454d9a7eb39b35af0fb77c2a6613c0feb06 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Ujhelyi?= <zoltan.ujhelyi@incquerylabs.com>
Date: Tue, 18 Feb 2025 19:24:20 +0100
Subject: [PATCH 1/6] ST6RI-823 Allow external magic command defininitions in
 Jupyter

This commit adds a service registration based mechanism that can be used
to register additional magic commands to the system.

Furthermore, to allow these commands to add new items to the built-in
help system, and appropriate extension method was added to
SysMLInteractiveHelp
---
 .../interactive/SysMLInteractiveHelp.java     | 92 +++++++++++++------
 org.omg.sysml.jupyter.kernel/.classpath       |  7 --
 org.omg.sysml.jupyter.kernel/pom.xml          | 19 ----
 .../kernel/IMagicCommandRegistrator.java      | 31 +++++++
 .../omg/sysml/jupyter/kernel/SysMLKernel.java |  3 +
 .../src/main/resources/sysml/kernel.json      |  5 +-
 6 files changed, 101 insertions(+), 56 deletions(-)
 create mode 100644 org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java

diff --git a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
index 0808a2917..93355a44a 100644
--- a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
+++ b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
@@ -30,36 +30,33 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.TreeMap;
 
 import org.omg.sysml.plantuml.SysML2PlantUMLStyle;
 
+import com.google.common.base.Preconditions;
+
 public class SysMLInteractiveHelp {
 	
-	private static final String GENERAL_HELP_STRING =
+
+	private static final String GENERAL_HELP_STRING_PREFIX =
 			  "The following SysML v2 magic commands are available.\n"
 			+ "For help on a specific command, use \"%help <COMMAND>\" or \"%<cmd> -h\".\n\n"
-			+ "%eval\t\tEvaluate a given expression.\n"
-			+ "%export\t\tSave a file of the JSON representation of the abstract syntax tree rooted in the named element.\n"
-			+ "%help\t\tGet a list of available commands or help on a specific command\n"
-			+ "%list\t\tList loaded library packages or the results of a given query\n"
-			+ "%load\tLoads a model from the repository and adds it to the Xtext index\n"
-			+ "%show\t\tPrint the abstract syntax tree rooted in a named element\n"
-			+ "%projects\tList projects in the repository\n"
-			+ "%publish\tPublish to the repository the modele elements rooted in a named element\n"
-			+ "%view\t\tRender the view specified by the named view usage\n"
-			+ "%viz\t\tVisualize the name model elements\n"
 			;
 	
+	private static final String HELP_HELP_SHORT_STRING = "%help\t\tGet a list of available commands or help on a specific command";
 	private static final String HELP_HELP_STRING =
 			  "Usage: %help [<COMMAND>]\n\n"
 			+ "Print help information on the named SysML v2 magic <COMMAND>.\n"
 			+ "If no <COMMAND> is given, then list the available commands.\n";
 	
+	private static final String EVAL_HELP_SHORT_STRING = "%eval\t\tEvaluate a given expression.";
 	private static final String EVAL_HELP_STRING =
 			  "Usage: %eval [--target=<NAME>] <EXPR>\n\n"
 			+ "Print the results of evaluating <EXPR> on the target given by <NAME>, which must be fully qualified.\n"
 			+ "If a target is not given, then evaluate <EXPR> in global scope.\n";
 
+	private static final String LIST_HELP_SHORT_STRING = "%list\t\tList loaded library packages or the results of a given query";
 	private static final String LIST_HELP_STRING =
 			  "Usage: %list [<QUERY>]\n\n"
 			+ "If <QUERY> is not given, then list all loaded library packages.\n"
@@ -71,6 +68,8 @@ public class SysMLInteractiveHelp {
 			+ "    <NAME>::**\t\tall members of the namespace <NAME> and, recursively, members of owned namespaces.\n" 
 			+ "The last two forms may be optionally followed by a filter expression in square brackets.\n";
 
+	private static final String SHOW_HELP_SHORT_STRING = 
+			"%show\t\tPrint the abstract syntax tree rooted in a named element";
 	private static final String SHOW_HELP_STRING =
 			  "Usage: %show [--style=<STYLE>] <NAME>\n\n"
 			+ "Print the abstract syntax tree rooted in <NAME>. <NAME> must be fully qualified.\n\n"
@@ -78,10 +77,15 @@ public class SysMLInteractiveHelp {
     	    + "   TREE\t\tHierarchically indented representation with only identifying information\n"
     	    + "   JSON\t\tComplete JSON representation of the tree\n";
 
+	private static final String PUBLISH_HELP_SHORT_STRING =
+			"%publish\tPublish to the repository the modele elements rooted in a named element";
 	private static final String PUBLISH_HELP_STRING =
 			  "Usage: %publish <NAME>\n\n"
 			+ "Publish the model elements rooted in <NAME> to the repository. <NAME> must be fully qualified.\n";
 
+	
+	private static final String VIZ_HELP_SHORT_STRING =
+			"%viz\t\tVisualize the name model elements";
     private static final String VIZ_HELP_STRING =
     	      "Usage: %viz [--view=<VIEW>] [--style=<STYLE>...] <NAME> [<NAME>...]\n\n"
     	    + "Visualize model elements of <NAME>(s). <NAME>s must be fully qualified.\n\n"
@@ -99,6 +103,8 @@ public class SysMLInteractiveHelp {
     	    + "\t%viz --view Tree --style LR --style ortholine Pkg1::PartDef Pkg1::Pkg2::partUsage\n"
     	    + "should visualize Pkg1::PartDef and Pkg1::Pkg2::partUsage with a tree view ordered in the left-to-right direction with orthogonal lines.\n";
 
+    private static final String VIEW_HELP_SHORT_STRING =
+			"%view\t\tRender the view specified by the named view usage";
     private static final String VIEW_HELP_STRING =
     	      "Usage: %view [--render=<RENDERING>] [--style=<STYLE>...] <NAME>\n\n"
     	    + "Render the view specified by the view usage <NAME>. <NAME> must be fully qualified.\n"
@@ -114,23 +120,38 @@ public class SysMLInteractiveHelp {
             + SysML2PlantUMLStyle.getStyleHelp();
     
 
+    private static final String EXPORT_HELP_SHORT_STRING = 
+    		"%export\t\tSave a file of the JSON representation of the abstract syntax tree rooted in the named element.";
 	private static final String EXPORT_HELP_STRING =
 			  "Usage: %export <NAME>\n\n"
 			+ "Save a file containing the complete JSON representation of the abstract syntax tree rooted in <NAME>.\n"
 		    + "<NAME> must be fully qualified.\n";
 	
+	private static final String LOAD_HELP_SHORT_STRING = "%load\t\tLoads a model from the repository and adds it to the Xtext index"; 
 	private static final String LOAD_HELP_STRING =
 			  "Usage: %load [--id=<PROJECT ID] [--name=<NAME>] [<NAME>]\n\n"
-			+ "Downloads previously published models from the repository. <NAME> must be the full name of the project.\n"
+			+ "Downloads previously published models from the repository. <NAME> must be the full name of the project."
 			+ "Use --id=<PROJECT ID> to load projects by id.\n"		  
 			+ "Use %projects to view repository contents.\n";
 	
+	private static final String PROJECTS_HELP_SHORT_STRING = "%load\t\tLoads a model from the repository and adds it to the Xtext index"; 
 	private static final String PROJECTS_HELP_STRING =
 			  "Usage: %projects\n\n"
 			+ "Returns the name and identifier from the repository for all publications\n";
  
+	private static String generalHelpCached;
+	
 	public static String getGeneralHelp() {
-		return GENERAL_HELP_STRING;
+		if (generalHelpCached == null) {
+			StringBuilder sb = new StringBuilder();
+			sb.append(GENERAL_HELP_STRING_PREFIX);
+			for (var entry: commandShortHelpMap.entrySet()) {
+				sb.append(entry.getValue());
+				sb.append(System.lineSeparator());
+			}
+			generalHelpCached = sb.toString();
+		}
+		return generalHelpCached;
 	}
  
 	public static String getHelpHelp() {
@@ -173,22 +194,37 @@ public static String getLoadHelp() {
     	return LOAD_HELP_STRING;
     }
     
-    private static Map<String, String> commandHelpMap = createCommandHelpMap();
+    private static Map<String, String> commandShortHelpMap = new TreeMap<>();
+    private static Map<String, String> commandHelpMap = new HashMap<>();
+    static {
+    	registerHelpString("%help", HELP_HELP_SHORT_STRING, HELP_HELP_STRING);
+    	registerHelpString("%eval", EVAL_HELP_SHORT_STRING, EVAL_HELP_STRING);
+    	registerHelpString("%list", LIST_HELP_SHORT_STRING, LIST_HELP_STRING);    	
+    	registerHelpString("%show", SHOW_HELP_SHORT_STRING, SHOW_HELP_STRING);    	
+    	registerHelpString("%publish", PUBLISH_HELP_SHORT_STRING, PUBLISH_HELP_STRING);    	
+    	registerHelpString("%viz", VIZ_HELP_SHORT_STRING, VIZ_HELP_STRING);    	
+    	registerHelpString("%view", VIEW_HELP_SHORT_STRING, VIEW_HELP_STRING);    	
+    	registerHelpString("%export", EXPORT_HELP_SHORT_STRING, EXPORT_HELP_STRING);
+    	registerHelpString("%load", LOAD_HELP_SHORT_STRING, LOAD_HELP_STRING);
+    	registerHelpString("%projects", PROJECTS_HELP_SHORT_STRING, PROJECTS_HELP_STRING);
+    }
     
-    private static Map<String, String> createCommandHelpMap() {
-    	Map<String, String> map = new HashMap<>();
-    	map.put("%help", HELP_HELP_STRING);    	
-    	map.put("%eval", EVAL_HELP_STRING);    	
-    	map.put("%list", LIST_HELP_STRING);    	
-    	map.put("%show", SHOW_HELP_STRING);    	
-    	map.put("%publish", PUBLISH_HELP_STRING);    	
-    	map.put("%viz", VIZ_HELP_STRING);    	
-    	map.put("%view", VIEW_HELP_STRING);    	
-    	map.put("%export", EXPORT_HELP_STRING);
-    	map.put("%load", LOAD_HELP_STRING);
-    	map.put("%projects", PROJECTS_HELP_STRING);
-    	
-    	return map;
+    /**
+     * Adds command helps to the centralized store.
+     * @param command The name of the magic command, including the '%' prefix
+     * @param shortDescription
+     * 		A one-line description of a command, including the command name with the '%' prefix
+     * 		one or two tabs to make the output of the %help command nicely formatted.
+     * @param detailedHelp
+     * 		A multi-line help for a given command, expected to also detail the parameter formatting
+     * 
+     * @throws IllegalStateException when help for a command is being re-registered
+     */
+    public static void registerHelpString(String command, String shortDescription, String detailedHelp) {
+    	Preconditions.checkState(!commandHelpMap.containsKey(command), "Help is already registered for command %s", command);
+    	commandShortHelpMap.put(command, shortDescription);
+    	commandHelpMap.put(command, detailedHelp);
+    	generalHelpCached = null;
     }
     
     public static String getHelpString(String command) {
diff --git a/org.omg.sysml.jupyter.kernel/.classpath b/org.omg.sysml.jupyter.kernel/.classpath
index 71b6e06e4..8d51af379 100644
--- a/org.omg.sysml.jupyter.kernel/.classpath
+++ b/org.omg.sysml.jupyter.kernel/.classpath
@@ -21,7 +21,6 @@
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17">
 		<attributes>
-			<attribute name="module" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
@@ -37,12 +36,6 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" output="target/classes" path="target/kernel">
-		<attributes>
-			<attribute name="optional" value="true"/>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
 	<classpathentry combineaccessrules="false" kind="src" path="/org.omg.sysml.interactive"/>
 	<classpathentry combineaccessrules="false" kind="src" path="/org.omg.sysml"/>
 	<classpathentry kind="output" path="target/classes"/>
diff --git a/org.omg.sysml.jupyter.kernel/pom.xml b/org.omg.sysml.jupyter.kernel/pom.xml
index 45f26defa..d360aaf29 100644
--- a/org.omg.sysml.jupyter.kernel/pom.xml
+++ b/org.omg.sysml.jupyter.kernel/pom.xml
@@ -200,25 +200,6 @@
                 </execution>
             </executions>
         </plugin>
-
-        <!-- Needed for updating the version number in the kernel.json. This is used to copy the resources to the unzipped kernel.-->
-		<plugin>
-			<groupId>org.codehaus.mojo</groupId>
-			<artifactId>templating-maven-plugin</artifactId>
-			<version>3.0.0</version>
-			<executions>
-				<execution>
-					<phase>prepare-package</phase>
-					<goals>
-						<goal>filter-sources</goal>
-					</goals>
-				</execution>
-			</executions>
-			<configuration>
-				<sourceDirectory>src/main/resources</sourceDirectory>
-				<outputDirectory>target/kernel</outputDirectory>
-			</configuration>
-		</plugin>
        
        <plugin>
         <groupId>org.apache.maven.plugins</groupId>
diff --git a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java
new file mode 100644
index 000000000..95f08ab46
--- /dev/null
+++ b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java
@@ -0,0 +1,31 @@
+/*****************************************************************************
+ * SysML 2 Pilot Implementation
+ * Copyright (c) 2025 Model Driven Solutions, Inc.
+ *    
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of theGNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
+ * 
+ * Contributors:
+ *  Zoltan Ujhelyi, MDS
+ * 
+ *****************************************************************************/
+package org.omg.sysml.jupyter.kernel;
+
+import io.github.spencerpark.jupyter.kernel.magic.registry.Magics;
+
+public interface IMagicCommandRegistrator {
+
+	void registerMagicCommand(Magics magics);
+}
diff --git a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
index 375257d6d..401371584 100644
--- a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
+++ b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
@@ -36,6 +36,7 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
+import java.util.ServiceLoader;
 
 public class SysMLKernel extends BaseKernel {
 
@@ -82,6 +83,8 @@ public SysMLKernel() {
         this.magics.registerMagics(Export.class);
         this.magics.registerMagics(Projects.class);
         this.magics.registerMagics(Load.class);
+        
+        ServiceLoader.load(IMagicCommandRegistrator.class).forEach(reg -> reg.registerMagicCommand(this.magics));
 
         this.magicParser = new MyMagicParser();
     }
diff --git a/org.omg.sysml.jupyter.kernel/src/main/resources/sysml/kernel.json b/org.omg.sysml.jupyter.kernel/src/main/resources/sysml/kernel.json
index e7e2b0075..832417a0c 100644
--- a/org.omg.sysml.jupyter.kernel/src/main/resources/sysml/kernel.json
+++ b/org.omg.sysml.jupyter.kernel/src/main/resources/sysml/kernel.json
@@ -1,8 +1,9 @@
 {
     "argv": [
         "java",
-        "-jar",
-        "@KERNEL_INSTALL_DIRECTORY@/jupyter-sysml-kernel-${project.version}-all.jar",
+		"-cp",
+		"@KERNEL_INSTALL_DIRECTORY@/*",
+		"org.omg.sysml.jupyter.kernel.ISysML",
         "{connection_file}"
     ],
     "display_name": "SysML",

From 4e0c3e8c8a2ffcb5307d4ac8784c6c69be0ea49e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Ujhelyi?= <zoltan.ujhelyi@incquerylabs.com>
Date: Thu, 15 May 2025 14:23:44 +0200
Subject: [PATCH 2/6] ST6RI-823 Reverted line ending change caused by merging

---
 .../interactive/SysMLInteractiveHelp.java     | 516 +++++++++---------
 1 file changed, 258 insertions(+), 258 deletions(-)

diff --git a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
index fbcd02645..d2f6c948a 100644
--- a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
+++ b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
@@ -1,258 +1,258 @@
-/*******************************************************************************
- * SysML 2 Pilot Implementation
- * Copyright (c) 2021, 2025 Model Driven Solutions, Inc.
- * Copyright (c) 2021 Twingineer LLC
- * Copyright (c) 2022 Mgnite Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of theGNU Lesser General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
- *
- * Contributors:
- *  Ed Seidewitz, MDS
- *  Ivan Gomes
- *  Hisashi Miyashita
- *
- *******************************************************************************/
-
-package org.omg.sysml.interactive;
-
-import java.util.HashMap;
-import java.util.Map;
-import java.util.TreeMap;
-
-import org.omg.sysml.plantuml.SysML2PlantUMLStyle;
-
-import com.google.common.base.Preconditions;
-
-public class SysMLInteractiveHelp {
-
-
-	private static final String GENERAL_HELP_STRING_PREFIX =
-			  "The following SysML v2 magic commands are available.\n"
-			+ "For help on a specific command, use \"%help <COMMAND>\" or \"%<cmd> -h\".\n\n"
-			;
-
-	private static final String HELP_HELP_SHORT_STRING = "%help\t\tGet a list of available commands or help on a specific command";
-	private static final String HELP_HELP_STRING =
-			  "Usage: %help [<COMMAND>]\n\n"
-			+ "Print help information on the named SysML v2 magic <COMMAND>.\n"
-			+ "If no <COMMAND> is given, then list the available commands.\n";
-
-	private static final String EVAL_HELP_SHORT_STRING = "%eval\t\tEvaluate a given expression.";
-	private static final String EVAL_HELP_STRING =
-			  "Usage: %eval [--target=<NAME>] <EXPR>\n\n"
-			+ "Print the results of evaluating <EXPR> on the target given by <NAME>, which must be fully qualified.\n"
-			+ "If a target is not given, then evaluate <EXPR> in global scope.\n";
-
-	private static final String LIST_HELP_SHORT_STRING = "%list\t\tList loaded library packages or the results of a given query";
-	private static final String LIST_HELP_STRING =
-			  "Usage: %list [<QUERY>]\n\n"
-			+ "If <QUERY> is not given, then list all loaded library packages.\n"
-			+ "If <QUERY> is given, list all elements as specified by the <QUERY>.\n\n"
-			+ "<QUERY> must have a form such that \"import <QUERY>;\" would be a legal import, "
-			+ "that is, one of the following:\n"
-			+ "    <NAME>\t\telement given by the fully qualified <NAME>\n"
-			+ "    <NAME>::*\t\tall members of the namespace <NAME>\n"
-			+ "    <NAME>::**\t\tall members of the namespace <NAME> and, recursively, members of owned namespaces.\n"
-			+ "The last two forms may be optionally followed by a filter expression in square brackets.\n";
-
-	private static final String SHOW_HELP_SHORT_STRING =
-			"%show\t\tPrint the abstract syntax tree rooted in a named element";
-	private static final String SHOW_HELP_STRING =
-			  "Usage: %show [--style=<STYLE>] <NAME>\n\n"
-			+ "Print the abstract syntax tree rooted in <NAME>. <NAME> must be fully qualified.\n\n"
-			+ "<STYLE> is also case insensitive. The possible style names are:\n"
-    	    + "   TREE\t\tHierarchically indented representation with only identifying information\n"
-    	    + "   JSON\t\tComplete JSON representation of the tree\n";
-
-	private static final String PUBLISH_HELP_SHORT_STRING =
-			"%publish\tPublish to the repository the modele elements rooted in a named element";
-	private static final String PUBLISH_HELP_STRING =
-			  "Usage: %publish [-d] [--project=<PROJECT NAME>] [--branch=<BRANCH NAME>] <NAME>\n\n"
-			+ "Publish the model elements rooted in <NAME> to the repository. <NAME> must be fully qualified.\n"
-			+ "Use the -d flag to include derived properties.\n"
-			+ "If <PROJECT NAME> is given, it is used as the name of the project to create or update.\n"
-			+ "If <PROJECT NAME> is not given, the (simple) name of the model element is used.\n"
-			+ "    If no project exits with the given name, then a new project with that name is created.\n"
-			+ "    Otherwise, the existing project is updated with a new commit.\n"
-			+ "If <BRANCH NAME> is given, then the model is written to this branch of the project.\n"
-			+ "If <BRANCH NAME> is not given, the default branch is used.\n";
-
-
-	private static final String VIZ_HELP_SHORT_STRING =
-			"%viz\t\tVisualize the name model elements";
-    private static final String VIZ_HELP_STRING =
-    	      "Usage: %viz [--view=<VIEW>] [--style=<STYLE>...] <NAME> [<NAME>...]\n\n"
-    	    + "Visualize model elements of <NAME>(s). <NAME>s must be fully qualified.\n\n"
-    	    + "<VIEW> is case insensitive and possible candidates are:\n"
-    	    + "   DEFAULT\t\tAutomatically choose an appropriate view from the given model element names\n"
-    	    + "   TREE\t\t\tShow a tree-structural view, like a Block Definition Diagram (BDD)\n"
-    	    + "   INTERCONNECTION\tShow an interconnection view, like an Internal Block Diagram (IBD)\n"
-    	    + "   STATE\t\tShow state machines\n"
-    	    + "   ACTION\t\tShow actions like an activity diagram\n"
-    	    + "   SEQUENCE\t\tShow events and messages in a sequence diagram\n"
-    	    + "   MIXED\t\tShow multiple views\n\n"
-    	    + "<STYLE> is also case insensitive. Multiple --style options are allowed.  The possible style names are:\n"
-            + SysML2PlantUMLStyle.getStyleHelp()
-    	    + "\nExample:\n"
-    	    + "\t%viz --view Tree --style LR --style ortholine Pkg1::PartDef Pkg1::Pkg2::partUsage\n"
-    	    + "should visualize Pkg1::PartDef and Pkg1::Pkg2::partUsage with a tree view ordered in the left-to-right direction with orthogonal lines.\n";
-
-    private static final String VIEW_HELP_SHORT_STRING =
-			"%view\t\tRender the view specified by the named view usage";
-    private static final String VIEW_HELP_STRING =
-    	      "Usage: %view [--render=<RENDERING>] [--style=<STYLE>...] <NAME>\n\n"
-    	    + "Render the view specified by the view usage <NAME>. <NAME> must be fully qualified.\n"
-    	    + "If the view usage has a rendering, this overrides the rendering given in the render option.\n\n"
-    	    + "<RENDERING> is case insensitive and possible candidates are:\n"
-    	    + "   DEFAULT\t\tAutomatically choose an appropriate view from the given model element names\n"
-    	    + "   TREE\t\t\tShow a tree-structural view, like a Block Definition Diagram (BDD)\n"
-    	    + "   INTERCONNECTION\tShow an interconnection view, like an Internal Block Diagram (IBD)\n"
-    	    + "   STATE\t\tShow state machines\n"
-    	    + "   ACTION\t\tShow actions like an activity diagram\n"
-    	    + "   MIXED\t\tShow multiple views\n\n"
-    	    + "<STYLE> is also case insensitive. Multiple --style options are allowed.  The possible style names are:\n"
-            + SysML2PlantUMLStyle.getStyleHelp();
-
-
-    private static final String EXPORT_HELP_SHORT_STRING =
-    		"%export\t\tSave a file of the JSON representation of the abstract syntax tree rooted in the named element.";
-	private static final String EXPORT_HELP_STRING =
-			  "Usage: %export <NAME>\n\n"
-			+ "Save a file containing the complete JSON representation of the abstract syntax tree rooted in <NAME>.\n"
-		    + "<NAME> must be fully qualified.\n";
-
-	private static final String LOAD_HELP_SHORT_STRING = "%load\t\tLoads a model from the repository";
-	private static final String LOAD_HELP_STRING =
-			"Usage: %load [--id=<PROJECT ID] [--name=<NAME>] [--branch=<BRANCH_NAME>] [<NAME>]\n\n"
-			+ "Download previously published models from a project in the repository. <NAME> is the full name of the project.\n"
-			+ "Named elements of the downloaded models may then be referenced models in the notebook."
-			+ "(Use %projects to view repository contents.)\n"
-			+ "If <PROJECT ID> is given, then the project with that UUID is loaded. In this case, the <NAME> must not be given.\n"
-			+ "If <BRANCH NAME> is given, then the model is loaded from this branch of the project.\n"
-			+ "If <BRANCH NAME> is not given, the default branch is used.\n";
-
-	private static final String PROJECTS_HELP_SHORT_STRING = "%projects\tList projects in the repository";
-	private static final String PROJECTS_HELP_STRING =
-			  "Usage: %projects\n\n"
-			+ "Print the name and identifier of all projects in the repository.\n";
-
-	private static final String API_BASE_PATH_HELP_SHORT_STRING ="%repo\tSet the api base path for the repository";
-	private static final String API_BASE_PATH_HELP_STRING =
-			  "Usage: %repo [<BASE PATH>]\n\n"
-			+ "If <BASE PATH> is not given, print the current repository base path.\r\n"
-			+ "If <BASE PATH> is given, set the repository base path.\r\n"
-			+ "\r\n"
-			+ "<BASE PATH> is a URL giving the API base path for the repository access by the %projects, %publish and %load commands. \r\n"
-			+ "For example: https://my.domain.com/sysml_repo";
-
-	private static String generalHelpCached;
-
-	public static String getGeneralHelp() {
-		if (generalHelpCached == null) {
-			StringBuilder sb = new StringBuilder();
-			sb.append(GENERAL_HELP_STRING_PREFIX);
-			for (var entry: commandShortHelpMap.entrySet()) {
-				sb.append(entry.getValue());
-				sb.append(System.lineSeparator());
-			}
-			generalHelpCached = sb.toString();
-		}
-		return generalHelpCached;
-	}
-
-	public static String getHelpHelp() {
-		return HELP_HELP_STRING;
-	}
-
-	public static String getEvalHelp() {
-		return EVAL_HELP_STRING;
-	}
-
-	public static String getListHelp() {
-    	return LIST_HELP_STRING;
-    }
-
-    public static String getShowHelp() {
-    	return SHOW_HELP_STRING;
-    }
-
-    public static String getPublishHelp() {
-    	return PUBLISH_HELP_STRING;
-    }
-
-    public static String getVizHelp() {
-    	return VIZ_HELP_STRING;
-    }
-
-    public static String getViewHelp() {
-    	return VIEW_HELP_STRING;
-    }
-
-    public static String getExportHelp() {
-    	return EXPORT_HELP_STRING;
-    }
-
-    public static String getProjectsHelp() {
-    	return PROJECTS_HELP_STRING;
-    }
-
-    public static String getLoadHelp() {
-    	return LOAD_HELP_STRING;
-    }
-
-    public static String getApiBasePathHelp() {
-    	return API_BASE_PATH_HELP_STRING;
-	}
-
-    private static Map<String, String> commandShortHelpMap = new TreeMap<>();
-    private static Map<String, String> commandHelpMap = new HashMap<>();
-    static {
-    	registerHelpString("%help", HELP_HELP_SHORT_STRING, HELP_HELP_STRING);
-    	registerHelpString("%eval", EVAL_HELP_SHORT_STRING, EVAL_HELP_STRING);
-    	registerHelpString("%list", LIST_HELP_SHORT_STRING, LIST_HELP_STRING);
-    	registerHelpString("%show", SHOW_HELP_SHORT_STRING, SHOW_HELP_STRING);
-    	registerHelpString("%publish", PUBLISH_HELP_SHORT_STRING, PUBLISH_HELP_STRING);
-    	registerHelpString("%viz", VIZ_HELP_SHORT_STRING, VIZ_HELP_STRING);
-    	registerHelpString("%view", VIEW_HELP_SHORT_STRING, VIEW_HELP_STRING);
-    	registerHelpString("%export", EXPORT_HELP_SHORT_STRING, EXPORT_HELP_STRING);
-    	registerHelpString("%load", LOAD_HELP_SHORT_STRING, LOAD_HELP_STRING);
-    	registerHelpString("%projects", PROJECTS_HELP_SHORT_STRING, PROJECTS_HELP_STRING);
-		registerHelpString("%repo", API_BASE_PATH_HELP_SHORT_STRING, API_BASE_PATH_HELP_STRING);
-    }
-
-    /**
-     * Adds command helps to the centralized store.
-     * @param command The name of the magic command, including the '%' prefix
-     * @param shortDescription
-     * 		A one-line description of a command, including the command name with the '%' prefix
-     * 		one or two tabs to make the output of the %help command nicely formatted.
-     * @param detailedHelp
-     * 		A multi-line help for a given command, expected to also detail the parameter formatting
-     *
-     * @throws IllegalStateException when help for a command is being re-registered
-     */
-    public static void registerHelpString(String command, String shortDescription, String detailedHelp) {
-    	Preconditions.checkState(!commandHelpMap.containsKey(command), "Help is already registered for command %s", command);
-    	commandShortHelpMap.put(command, shortDescription);
-    	commandHelpMap.put(command, detailedHelp);
-    	generalHelpCached = null;
-    }
-
-    public static String getHelpString(String command) {
-    	return commandHelpMap.get(command);
-    }
-
-}
+/*******************************************************************************
+ * SysML 2 Pilot Implementation
+ * Copyright (c) 2021, 2025 Model Driven Solutions, Inc.
+ * Copyright (c) 2021 Twingineer LLC
+ * Copyright (c) 2022 Mgnite Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of theGNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
+ *
+ * Contributors:
+ *  Ed Seidewitz, MDS
+ *  Ivan Gomes
+ *  Hisashi Miyashita
+ *
+ *******************************************************************************/
+
+package org.omg.sysml.interactive;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.TreeMap;
+
+import org.omg.sysml.plantuml.SysML2PlantUMLStyle;
+
+import com.google.common.base.Preconditions;
+
+public class SysMLInteractiveHelp {
+
+
+	private static final String GENERAL_HELP_STRING_PREFIX =
+			  "The following SysML v2 magic commands are available.\n"
+			+ "For help on a specific command, use \"%help <COMMAND>\" or \"%<cmd> -h\".\n\n"
+			;
+
+	private static final String HELP_HELP_SHORT_STRING = "%help\t\tGet a list of available commands or help on a specific command";
+	private static final String HELP_HELP_STRING =
+			  "Usage: %help [<COMMAND>]\n\n"
+			+ "Print help information on the named SysML v2 magic <COMMAND>.\n"
+			+ "If no <COMMAND> is given, then list the available commands.\n";
+
+	private static final String EVAL_HELP_SHORT_STRING = "%eval\t\tEvaluate a given expression.";
+	private static final String EVAL_HELP_STRING =
+			  "Usage: %eval [--target=<NAME>] <EXPR>\n\n"
+			+ "Print the results of evaluating <EXPR> on the target given by <NAME>, which must be fully qualified.\n"
+			+ "If a target is not given, then evaluate <EXPR> in global scope.\n";
+
+	private static final String LIST_HELP_SHORT_STRING = "%list\t\tList loaded library packages or the results of a given query";
+	private static final String LIST_HELP_STRING =
+			  "Usage: %list [<QUERY>]\n\n"
+			+ "If <QUERY> is not given, then list all loaded library packages.\n"
+			+ "If <QUERY> is given, list all elements as specified by the <QUERY>.\n\n"
+			+ "<QUERY> must have a form such that \"import <QUERY>;\" would be a legal import, "
+			+ "that is, one of the following:\n"
+			+ "    <NAME>\t\telement given by the fully qualified <NAME>\n"
+			+ "    <NAME>::*\t\tall members of the namespace <NAME>\n"
+			+ "    <NAME>::**\t\tall members of the namespace <NAME> and, recursively, members of owned namespaces.\n"
+			+ "The last two forms may be optionally followed by a filter expression in square brackets.\n";
+
+	private static final String SHOW_HELP_SHORT_STRING =
+			"%show\t\tPrint the abstract syntax tree rooted in a named element";
+	private static final String SHOW_HELP_STRING =
+			  "Usage: %show [--style=<STYLE>] <NAME>\n\n"
+			+ "Print the abstract syntax tree rooted in <NAME>. <NAME> must be fully qualified.\n\n"
+			+ "<STYLE> is also case insensitive. The possible style names are:\n"
+    	    + "   TREE\t\tHierarchically indented representation with only identifying information\n"
+    	    + "   JSON\t\tComplete JSON representation of the tree\n";
+
+	private static final String PUBLISH_HELP_SHORT_STRING =
+			"%publish\tPublish to the repository the modele elements rooted in a named element";
+	private static final String PUBLISH_HELP_STRING =
+			  "Usage: %publish [-d] [--project=<PROJECT NAME>] [--branch=<BRANCH NAME>] <NAME>\n\n"
+			+ "Publish the model elements rooted in <NAME> to the repository. <NAME> must be fully qualified.\n"
+			+ "Use the -d flag to include derived properties.\n"
+			+ "If <PROJECT NAME> is given, it is used as the name of the project to create or update.\n"
+			+ "If <PROJECT NAME> is not given, the (simple) name of the model element is used.\n"
+			+ "    If no project exits with the given name, then a new project with that name is created.\n"
+			+ "    Otherwise, the existing project is updated with a new commit.\n"
+			+ "If <BRANCH NAME> is given, then the model is written to this branch of the project.\n"
+			+ "If <BRANCH NAME> is not given, the default branch is used.\n";
+
+
+	private static final String VIZ_HELP_SHORT_STRING =
+			"%viz\t\tVisualize the name model elements";
+    private static final String VIZ_HELP_STRING =
+    	      "Usage: %viz [--view=<VIEW>] [--style=<STYLE>...] <NAME> [<NAME>...]\n\n"
+    	    + "Visualize model elements of <NAME>(s). <NAME>s must be fully qualified.\n\n"
+    	    + "<VIEW> is case insensitive and possible candidates are:\n"
+    	    + "   DEFAULT\t\tAutomatically choose an appropriate view from the given model element names\n"
+    	    + "   TREE\t\t\tShow a tree-structural view, like a Block Definition Diagram (BDD)\n"
+    	    + "   INTERCONNECTION\tShow an interconnection view, like an Internal Block Diagram (IBD)\n"
+    	    + "   STATE\t\tShow state machines\n"
+    	    + "   ACTION\t\tShow actions like an activity diagram\n"
+    	    + "   SEQUENCE\t\tShow events and messages in a sequence diagram\n"
+    	    + "   MIXED\t\tShow multiple views\n\n"
+    	    + "<STYLE> is also case insensitive. Multiple --style options are allowed.  The possible style names are:\n"
+            + SysML2PlantUMLStyle.getStyleHelp()
+    	    + "\nExample:\n"
+    	    + "\t%viz --view Tree --style LR --style ortholine Pkg1::PartDef Pkg1::Pkg2::partUsage\n"
+    	    + "should visualize Pkg1::PartDef and Pkg1::Pkg2::partUsage with a tree view ordered in the left-to-right direction with orthogonal lines.\n";
+
+    private static final String VIEW_HELP_SHORT_STRING =
+			"%view\t\tRender the view specified by the named view usage";
+    private static final String VIEW_HELP_STRING =
+    	      "Usage: %view [--render=<RENDERING>] [--style=<STYLE>...] <NAME>\n\n"
+    	    + "Render the view specified by the view usage <NAME>. <NAME> must be fully qualified.\n"
+    	    + "If the view usage has a rendering, this overrides the rendering given in the render option.\n\n"
+    	    + "<RENDERING> is case insensitive and possible candidates are:\n"
+    	    + "   DEFAULT\t\tAutomatically choose an appropriate view from the given model element names\n"
+    	    + "   TREE\t\t\tShow a tree-structural view, like a Block Definition Diagram (BDD)\n"
+    	    + "   INTERCONNECTION\tShow an interconnection view, like an Internal Block Diagram (IBD)\n"
+    	    + "   STATE\t\tShow state machines\n"
+    	    + "   ACTION\t\tShow actions like an activity diagram\n"
+    	    + "   MIXED\t\tShow multiple views\n\n"
+    	    + "<STYLE> is also case insensitive. Multiple --style options are allowed.  The possible style names are:\n"
+            + SysML2PlantUMLStyle.getStyleHelp();
+
+
+    private static final String EXPORT_HELP_SHORT_STRING =
+    		"%export\t\tSave a file of the JSON representation of the abstract syntax tree rooted in the named element.";
+	private static final String EXPORT_HELP_STRING =
+			  "Usage: %export <NAME>\n\n"
+			+ "Save a file containing the complete JSON representation of the abstract syntax tree rooted in <NAME>.\n"
+		    + "<NAME> must be fully qualified.\n";
+
+	private static final String LOAD_HELP_SHORT_STRING = "%load\t\tLoads a model from the repository";
+	private static final String LOAD_HELP_STRING =
+			"Usage: %load [--id=<PROJECT ID] [--name=<NAME>] [--branch=<BRANCH_NAME>] [<NAME>]\n\n"
+			+ "Download previously published models from a project in the repository. <NAME> is the full name of the project.\n"
+			+ "Named elements of the downloaded models may then be referenced models in the notebook."
+			+ "(Use %projects to view repository contents.)\n"
+			+ "If <PROJECT ID> is given, then the project with that UUID is loaded. In this case, the <NAME> must not be given.\n"
+			+ "If <BRANCH NAME> is given, then the model is loaded from this branch of the project.\n"
+			+ "If <BRANCH NAME> is not given, the default branch is used.\n";
+
+	private static final String PROJECTS_HELP_SHORT_STRING = "%projects\tList projects in the repository";
+	private static final String PROJECTS_HELP_STRING =
+			  "Usage: %projects\n\n"
+			+ "Print the name and identifier of all projects in the repository.\n";
+
+	private static final String API_BASE_PATH_HELP_SHORT_STRING ="%repo\tSet the api base path for the repository";
+	private static final String API_BASE_PATH_HELP_STRING =
+			  "Usage: %repo [<BASE PATH>]\n\n"
+			+ "If <BASE PATH> is not given, print the current repository base path.\r\n"
+			+ "If <BASE PATH> is given, set the repository base path.\r\n"
+			+ "\r\n"
+			+ "<BASE PATH> is a URL giving the API base path for the repository access by the %projects, %publish and %load commands. \r\n"
+			+ "For example: https://my.domain.com/sysml_repo";
+
+	private static String generalHelpCached;
+
+	public static String getGeneralHelp() {
+		if (generalHelpCached == null) {
+			StringBuilder sb = new StringBuilder();
+			sb.append(GENERAL_HELP_STRING_PREFIX);
+			for (var entry: commandShortHelpMap.entrySet()) {
+				sb.append(entry.getValue());
+				sb.append(System.lineSeparator());
+			}
+			generalHelpCached = sb.toString();
+		}
+		return generalHelpCached;
+	}
+
+	public static String getHelpHelp() {
+		return HELP_HELP_STRING;
+	}
+
+	public static String getEvalHelp() {
+		return EVAL_HELP_STRING;
+	}
+
+	public static String getListHelp() {
+    	return LIST_HELP_STRING;
+    }
+
+    public static String getShowHelp() {
+    	return SHOW_HELP_STRING;
+    }
+
+    public static String getPublishHelp() {
+    	return PUBLISH_HELP_STRING;
+    }
+
+    public static String getVizHelp() {
+    	return VIZ_HELP_STRING;
+    }
+
+    public static String getViewHelp() {
+    	return VIEW_HELP_STRING;
+    }
+
+    public static String getExportHelp() {
+    	return EXPORT_HELP_STRING;
+    }
+
+    public static String getProjectsHelp() {
+    	return PROJECTS_HELP_STRING;
+    }
+
+    public static String getLoadHelp() {
+    	return LOAD_HELP_STRING;
+    }
+
+    public static String getApiBasePathHelp() {
+    	return API_BASE_PATH_HELP_STRING;
+	}
+
+    private static Map<String, String> commandShortHelpMap = new TreeMap<>();
+    private static Map<String, String> commandHelpMap = new HashMap<>();
+    static {
+    	registerHelpString("%help", HELP_HELP_SHORT_STRING, HELP_HELP_STRING);
+    	registerHelpString("%eval", EVAL_HELP_SHORT_STRING, EVAL_HELP_STRING);
+    	registerHelpString("%list", LIST_HELP_SHORT_STRING, LIST_HELP_STRING);
+    	registerHelpString("%show", SHOW_HELP_SHORT_STRING, SHOW_HELP_STRING);
+    	registerHelpString("%publish", PUBLISH_HELP_SHORT_STRING, PUBLISH_HELP_STRING);
+    	registerHelpString("%viz", VIZ_HELP_SHORT_STRING, VIZ_HELP_STRING);
+    	registerHelpString("%view", VIEW_HELP_SHORT_STRING, VIEW_HELP_STRING);
+    	registerHelpString("%export", EXPORT_HELP_SHORT_STRING, EXPORT_HELP_STRING);
+    	registerHelpString("%load", LOAD_HELP_SHORT_STRING, LOAD_HELP_STRING);
+    	registerHelpString("%projects", PROJECTS_HELP_SHORT_STRING, PROJECTS_HELP_STRING);
+		registerHelpString("%repo", API_BASE_PATH_HELP_SHORT_STRING, API_BASE_PATH_HELP_STRING);
+    }
+
+    /**
+     * Adds command helps to the centralized store.
+     * @param command The name of the magic command, including the '%' prefix
+     * @param shortDescription
+     * 		A one-line description of a command, including the command name with the '%' prefix
+     * 		one or two tabs to make the output of the %help command nicely formatted.
+     * @param detailedHelp
+     * 		A multi-line help for a given command, expected to also detail the parameter formatting
+     *
+     * @throws IllegalStateException when help for a command is being re-registered
+     */
+    public static void registerHelpString(String command, String shortDescription, String detailedHelp) {
+    	Preconditions.checkState(!commandHelpMap.containsKey(command), "Help is already registered for command %s", command);
+    	commandShortHelpMap.put(command, shortDescription);
+    	commandHelpMap.put(command, detailedHelp);
+    	generalHelpCached = null;
+    }
+
+    public static String getHelpString(String command) {
+    	return commandHelpMap.get(command);
+    }
+
+}

From c17528a140993bb113ea287a1f09ee30cba6c5f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Ujhelyi?= <zoltan.ujhelyi@incquerylabs.com>
Date: Thu, 15 May 2025 14:49:54 +0200
Subject: [PATCH 3/6] ST6RI-823 Minor enhancements to the registrator workflow

 - Added error handling for the command registrator interface
 - Added Javadoc to the registrator to clarify the expected contract of
implementors
---
 .../kernel/IMagicCommandRegistrator.java      | 21 ++++++++++++++++---
 .../omg/sysml/jupyter/kernel/SysMLKernel.java | 12 ++++++++++-
 2 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java
index 95f08ab46..b16b4537b 100644
--- a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java
+++ b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/IMagicCommandRegistrator.java
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * SysML 2 Pilot Implementation
  * Copyright (c) 2025 Model Driven Solutions, Inc.
- *    
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
@@ -16,16 +16,31 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  *
  * @license LGPL-3.0-or-later <http://spdx.org/licenses/LGPL-3.0-or-later>
- * 
+ *
  * Contributors:
  *  Zoltan Ujhelyi, MDS
- * 
+ *
  *****************************************************************************/
 package org.omg.sysml.jupyter.kernel;
 
+import org.omg.sysml.interactive.SysMLInteractiveHelp;
+
 import io.github.spencerpark.jupyter.kernel.magic.registry.Magics;
 
 public interface IMagicCommandRegistrator {
 
+	/**
+	 * Implementors of this method are free to register their extra commands to the
+	 * Jupyter kernel. This method is called when the Jupyter environment is
+	 * initialized and it assumed the registration code will run quickly and without
+	 * exceptions. If the registrator cannot run successfully, it should not
+	 * register anything instead of throwing an exception.
+	 * </p>
+	 * Implementors are recommended to use the register methods of the {@link Magics}
+	 * class. Help is managed by the {@link SysMLInteractiveHelp} class.
+	 *
+	 * @see Magics#registerMagics(Class)
+	 * @see SysMLInteractiveHelp#registerHelpString(String, String, String)
+	 */
 	void registerMagicCommand(Magics magics);
 }
diff --git a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
index b52607ead..d0e63ce3e 100644
--- a/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
+++ b/org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/SysMLKernel.java
@@ -85,7 +85,17 @@ public SysMLKernel() {
         this.magics.registerMagics(Load.class);
         this.magics.registerMagics(ApiBasePath.class);
 
-		ServiceLoader.load(IMagicCommandRegistrator.class).forEach(reg -> reg.registerMagicCommand(this.magics));
+		ServiceLoader.load(IMagicCommandRegistrator.class).forEach(reg -> {
+			try {
+				reg.registerMagicCommand(this.magics);
+			} catch (Exception e) {
+				// Given there is no available logging mechanism and an exception thrown by the
+				// registrator would cause the Jupyter kernel not to start up correctly, errors
+				// are logged to the standard err output, but otherwise ignored.
+				System.err.printf("Error while running the command registrator %s: %s", reg.getClass().getTypeName(),
+						e.getMessage());
+			}
+		});
 
         this.magicParser = new MyMagicParser();
     }

From 139ebb7213d4fb1f7530a093afc65b29504e33d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Ujhelyi?= <zoltan.ujhelyi@incquerylabs.com>
Date: Fri, 16 May 2025 09:48:09 +0200
Subject: [PATCH 4/6] ST6RI-823 Unify whitespace usage

---
 .../src/org/omg/sysml/interactive/SysMLInteractiveHelp.java     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
index d2f6c948a..e94ea6194 100644
--- a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
+++ b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
@@ -230,7 +230,7 @@ public static String getApiBasePathHelp() {
     	registerHelpString("%export", EXPORT_HELP_SHORT_STRING, EXPORT_HELP_STRING);
     	registerHelpString("%load", LOAD_HELP_SHORT_STRING, LOAD_HELP_STRING);
     	registerHelpString("%projects", PROJECTS_HELP_SHORT_STRING, PROJECTS_HELP_STRING);
-		registerHelpString("%repo", API_BASE_PATH_HELP_SHORT_STRING, API_BASE_PATH_HELP_STRING);
+    	registerHelpString("%repo", API_BASE_PATH_HELP_SHORT_STRING, API_BASE_PATH_HELP_STRING);
     }
 
     /**

From 2e0b5342e3bdc137a9af02421fa3f40a7c83cf32 Mon Sep 17 00:00:00 2001
From: Ed Seidewitz <ed-s@modeldriven.com>
Date: Thu, 22 May 2025 10:48:10 -0400
Subject: [PATCH 5/6] ST6RI-823 Updated SysMLInteractiveHelp.

---
 .../sysml/interactive/SysMLInteractive.java   |  2 +-
 .../interactive/SysMLInteractiveHelp.java     | 45 ++++++++++---------
 2 files changed, 24 insertions(+), 23 deletions(-)

diff --git a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java
index dc7095169..4bd8fbd77 100644
--- a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java
+++ b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java
@@ -282,7 +282,7 @@ public String help(String command) {
 	public String repo(String apiBasePath, List<String> help) {
 		this.counter++;
 		if (!help.isEmpty()) {
-			return SysMLInteractiveHelp.getApiBasePathHelp();
+			return SysMLInteractiveHelp.getRepoPathHelp();
 		}
 		
 		if (!Strings.isNullOrEmpty(apiBasePath)) {
diff --git a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
index e94ea6194..fde8f14cc 100644
--- a/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
+++ b/org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractiveHelp.java
@@ -21,8 +21,9 @@
  *
  * Contributors:
  *  Ed Seidewitz, MDS
- *  Ivan Gomes
- *  Hisashi Miyashita
+ *  Zoltan Ujhelyi, MDS
+ *  Ivan Gomes, Twingineer
+ *  Hisashi Miyashita, Mgnite
  *
  *******************************************************************************/
 
@@ -38,7 +39,6 @@
 
 public class SysMLInteractiveHelp {
 
-
 	private static final String GENERAL_HELP_STRING_PREFIX =
 			  "The following SysML v2 magic commands are available.\n"
 			+ "For help on a specific command, use \"%help <COMMAND>\" or \"%<cmd> -h\".\n\n"
@@ -78,7 +78,7 @@ public class SysMLInteractiveHelp {
     	    + "   JSON\t\tComplete JSON representation of the tree\n";
 
 	private static final String PUBLISH_HELP_SHORT_STRING =
-			"%publish\tPublish to the repository the modele elements rooted in a named element";
+			"%publish\tPublish to the repository the model elements rooted in a named element";
 	private static final String PUBLISH_HELP_STRING =
 			  "Usage: %publish [-d] [--project=<PROJECT NAME>] [--branch=<BRANCH NAME>] <NAME>\n\n"
 			+ "Publish the model elements rooted in <NAME> to the repository. <NAME> must be fully qualified.\n"
@@ -92,7 +92,7 @@ public class SysMLInteractiveHelp {
 
 
 	private static final String VIZ_HELP_SHORT_STRING =
-			"%viz\t\tVisualize the name model elements";
+			"%viz\t\tVisualize the named model elements";
     private static final String VIZ_HELP_STRING =
     	      "Usage: %viz [--view=<VIEW>] [--style=<STYLE>...] <NAME> [<NAME>...]\n\n"
     	    + "Visualize model elements of <NAME>(s). <NAME>s must be fully qualified.\n\n"
@@ -134,29 +134,30 @@ public class SysMLInteractiveHelp {
 			+ "Save a file containing the complete JSON representation of the abstract syntax tree rooted in <NAME>.\n"
 		    + "<NAME> must be fully qualified.\n";
 
-	private static final String LOAD_HELP_SHORT_STRING = "%load\t\tLoads a model from the repository";
+	private static final String LOAD_HELP_SHORT_STRING = "%load\t\tLoad models from the repository";
 	private static final String LOAD_HELP_STRING =
-			"Usage: %load [--id=<PROJECT ID] [--name=<NAME>] [--branch=<BRANCH_NAME>] [<NAME>]\n\n"
-			+ "Download previously published models from a project in the repository. <NAME> is the full name of the project.\n"
-			+ "Named elements of the downloaded models may then be referenced models in the notebook."
-			+ "(Use %projects to view repository contents.)\n"
+			"Usage: %load [--id=<PROJECT ID>] [--name=<NAME>] [--branch=<BRANCH_NAME>] [<NAME>]\n\n"
+			+ "Download previously published models from a project in the repository. (Use %projects to view repository contents.)\n"
+			+ "Named elements of the downloaded models may then be referenced by models in the notebook.\n"
+			+ "<NAME> is the full name of the project.\n"
 			+ "If <PROJECT ID> is given, then the project with that UUID is loaded. In this case, the <NAME> must not be given.\n"
-			+ "If <BRANCH NAME> is given, then the model is loaded from this branch of the project.\n"
-			+ "If <BRANCH NAME> is not given, the default branch is used.\n";
+			+ "If <BRANCH NAME> or <BRANCH ID> is given, then the model is loaded from this branch of the project.\n"
+			+ "If no <BRANCH NAME> or <BRANCH ID> is given, the default branch is used.\n"
+			+ "If <BRANCH ID> is given, then a <BRANCH NAME> must not be given.\n";
 
 	private static final String PROJECTS_HELP_SHORT_STRING = "%projects\tList projects in the repository";
 	private static final String PROJECTS_HELP_STRING =
 			  "Usage: %projects\n\n"
 			+ "Print the name and identifier of all projects in the repository.\n";
 
-	private static final String API_BASE_PATH_HELP_SHORT_STRING ="%repo\tSet the api base path for the repository";
-	private static final String API_BASE_PATH_HELP_STRING =
+	private static final String REPO_HELP_SHORT_STRING ="%repo\t\tSet the API base path for the repository";
+	private static final String REPO_HELP_STRING =
 			  "Usage: %repo [<BASE PATH>]\n\n"
-			+ "If <BASE PATH> is not given, print the current repository base path.\r\n"
-			+ "If <BASE PATH> is given, set the repository base path.\r\n"
-			+ "\r\n"
-			+ "<BASE PATH> is a URL giving the API base path for the repository access by the %projects, %publish and %load commands. \r\n"
-			+ "For example: https://my.domain.com/sysml_repo";
+			+ "Set the API base path for the repository accessed by the %projects, %publish and %load commands.\n"
+			+ "<BASE PATH> is a URL (possibly including port number), such as: https://my.domain.com/sysml_repo:9000.\n"
+			+ "If <BASE PATH> is not given, the current repository base path is printed.\n"
+			+ "If <BASE PATH> is given, the repository base path is set to this.\n"
+			;
 
 	private static String generalHelpCached;
 
@@ -213,8 +214,8 @@ public static String getLoadHelp() {
     	return LOAD_HELP_STRING;
     }
 
-    public static String getApiBasePathHelp() {
-    	return API_BASE_PATH_HELP_STRING;
+    public static String getRepoPathHelp() {
+    	return REPO_HELP_STRING;
 	}
 
     private static Map<String, String> commandShortHelpMap = new TreeMap<>();
@@ -230,7 +231,7 @@ public static String getApiBasePathHelp() {
     	registerHelpString("%export", EXPORT_HELP_SHORT_STRING, EXPORT_HELP_STRING);
     	registerHelpString("%load", LOAD_HELP_SHORT_STRING, LOAD_HELP_STRING);
     	registerHelpString("%projects", PROJECTS_HELP_SHORT_STRING, PROJECTS_HELP_STRING);
-    	registerHelpString("%repo", API_BASE_PATH_HELP_SHORT_STRING, API_BASE_PATH_HELP_STRING);
+    	registerHelpString("%repo", REPO_HELP_SHORT_STRING, REPO_HELP_STRING);
     }
 
     /**

From 54091337e7a1626cca11bf1ddddd3f0513db2678 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zolt=C3=A1n=20Ujhelyi?= <zoltan.ujhelyi@incquerylabs.com>
Date: Thu, 22 May 2025 17:55:05 +0200
Subject: [PATCH 6/6] ST6RI-823 Corrects fix for incorrect removal of
 templating-maven-plugin

The templating-maven-plugin, used to copy the resources into the target
directory `kernel`, was causing the kernel zips recursively containing
earlier builds as well, causing its size to balloon (mostly because
maven considered a target folder as a source folder). However, simply
removing broke clean builds, as the installer and other metadata were
missing from the output folder.

This commit uses the maven-resources-plugin to copy the required files
to the installer, thus avoiding the original issue.
---
 org.omg.sysml.jupyter.kernel/pom.xml | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/org.omg.sysml.jupyter.kernel/pom.xml b/org.omg.sysml.jupyter.kernel/pom.xml
index d360aaf29..f69eaac53 100644
--- a/org.omg.sysml.jupyter.kernel/pom.xml
+++ b/org.omg.sysml.jupyter.kernel/pom.xml
@@ -8,7 +8,7 @@
     <version>${revision}</version>
   </parent>
   <artifactId>jupyter-sysml-kernel</artifactId>
-  
+
     <dependencies>
         <dependency>
             <groupId>org.omg.sysml</groupId>
@@ -35,8 +35,8 @@
         		</exclusion>
     		</exclusions>
         </dependency>
-        <!-- 
-        Dependencies needed for m2e 
+        <!--
+        Dependencies needed for m2e
         we need to add these manually so the Eclipse IDE can see the classpath
         -->
         <dependency>
@@ -119,7 +119,7 @@
           </execution>
         </executions>
       </plugin>
-      
+
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
@@ -138,7 +138,7 @@
            </execution>
         </executions>
       </plugin>
-      
+
       <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-shade-plugin</artifactId>
@@ -200,7 +200,7 @@
                 </execution>
             </executions>
         </plugin>
-       
+
        <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-resources-plugin</artifactId>
@@ -222,6 +222,9 @@
                     <include>${project.artifactId}-${project.version}-all.jar</include>
                   </includes>
                 </resource>
+                <resource>
+                  <directory>${basedir}/src/main/resources</directory>
+                </resource>
                 <resource>
                   <directory>..</directory>
                   <targetPath>sysml</targetPath>
@@ -236,7 +239,7 @@
           </execution>
         </executions>
       </plugin>
-       
+
 	     <plugin>
 	        <groupId>org.apache.maven.plugins</groupId>
 	        <artifactId>maven-assembly-plugin</artifactId>