* fixes w.r.t. to the AsciiDoc

   generation

Author: festo-i40

src/AasxCsharpLibrary/Extensions/ExtendReference.cs

@@ -270,9 +270,7 @@ public static Key GetAsExactlyOneKey(this IReference reference)
         public static string ToStringExtended(this IReference reference, int format = 1, string delimiter = ",")
         {
             if (reference.Keys == null)
-            {
-                throw new NullValueException("Keys");
-            }
+                return "";
 
             return reference.Keys.ToStringExtended(format, delimiter);
         }

src/AasxCsharpLibrary/Extensions/ExtendReferenceList.cs

@@ -30,6 +30,18 @@ public static bool MatchesAnyWithExactlyOneKey(this List<IReference> reflist, IK
 
             return found;
         }
+
+        /// <summary>
+        /// Formats: 1 = [key, value] 2 = value
+        /// </summary>
+        public static string ToStringExtended(this List<IReference> reflist, int format = 1, string separator = ",")
+        {
+            if (reflist == null)
+                return "";
+
+            return string.Join(separator,
+                reflist.Select((rf) => rf.ToStringExtended(format)));
+        }
     }
 
 }

src/AasxPackageExplorer/debug.MIHO.script

@@ -22,4 +22,5 @@ Select("Submodel", "First");
 // Tool("sammaspectexport", "File", "C:\\HOMI\\Develop\\Aasx\\repo\\samm-test\\out.ttl");
 // Tool("submodelinstancefromsammaspect");
 // Tool("importtable", "Format", "Excel", "Preset", "Submodel templ. spec. import", "File", "C:\\HOMI\\Develop\\Aasx\\repo\\bugfix\\test-import.xlsx");
-Tool("WinMaximize");
+// Tool("WinMaximize");
+Tool("ExportTable", "File", "C:\\HOMI\\Develop\\Aasx\\repo\\new.adoc", "Preset", "AsciiDoc");

src/AasxPackageExplorer/options-debug.MIHO.json

@@ -32,9 +32,11 @@
   // "AasxToLoad": "C:\\HOMI\\Develop\\Aasx\\repo\\Test1.aasx",
   // "AasxToLoad": "C:\\HOMI\\Develop\\Aasx\\repo\\samm-test\\SMT_and_SAMM_Showcase_v02.aasx",
   // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\SMT_TechData_Work\\IDTA 02003-1-2_SubmodelTemplate_TechnicalData_v1.3_workingFile_MIHO.aasx",
-  // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\f.aasx",
+  // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\g.aasx",
+  // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\IDTA 02006-3-0_Template_Digital Nameplate_AsciiDoc_Draft_v13_Test_a.aasx",
   // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\SMT_and_SAMM_Showcase_v02.aasx",
-  "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\nearnull.aasx",
+  // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\nearnull.aasx",
+  "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\SMT_TechData_Work\\IDTA 02003-1-2_SubmodelTemplate_TechnicalData_v1.2__with_Draft_1_3_and_AsciiDoc_v01.aasx",
   // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\SMT_ProductChangeNotification_Draft_v19_spiel.aasx",
   // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\00_FestoDemoBox-Module-2-Kopie.aasx",
   // "AasxToLoad": "C:\\Users\\homi0002\\Desktop\\tmp\\8001203_SPAU-P10R-T-R18M-L-PNLK-PNVBA-M8D_060ff64f-9fd2-422d-81ce-b17e49f007c5_work_spiel.aasx",

src/AasxPackageLogic/DispEditHelperEntities.cs

@@ -3574,7 +3574,7 @@ public void DisplayOrEditAasEntitySubmodelElement(
                                     if (cd.IdShort == null || cd.IdShort.Trim() == "")
                                         cd.IdShort = sme.IdShort;
 
-                                    var ds = cd.EmbeddedDataSpecifications.GetIEC61360Content();
+                                    var ds = cd.EmbeddedDataSpecifications?.GetIEC61360Content();
                                     if (ds != null && (ds.ShortName == null || ds.ShortName.Count < 1))
                                     {
                                         ds.ShortName = new List<Aas.ILangStringShortNameTypeIec61360>

src/AasxPluginExportTable/AasxPluginExportTable.options.json

@@ -225,7 +225,7 @@
         "",
         "",
         "%font=bold%Explanation: %bg=#0029cc% %fg=white%",
-        "%Parent.description% %colspan=3%",
+        "%Parent.description@en% %colspan=3%",
         "",
         "",
         "",
@@ -247,7 +247,7 @@
         "",
         "",
         "[%SME.elementShort%]\r\n%brpost%%SME.idShort%",
-        "%SME.semanticId[0].value%\r\n%brpost%%CD.definition@en%\r\n%SME.description@en%",
+        "%SME.semanticId[0].value%\r\n%brpost%%SME.supplSemIds[br-label=supplementalSemanticId]%%CD.definition@en%\r\n%SME.description@en%",
         "[%Property.valueType%]\r\n%brpost%%SME.value%",
         "%SME.multiplicity%"
       ]

src/AasxPluginExportTable/Smt/ExportSmt.cs

@@ -69,6 +69,14 @@ protected void ProcessTextBlob(string header, Aas.IBlob blob)
             _adoc.AppendLine(header + text);
         }
 
+        protected static string EscapeAdText(string input)
+        {
+            if (input == null)
+                return null;
+            input = input.Replace(@"""", @"\""");
+            return input;
+        }
+
         protected string EvalLinkArguments(ExportSmtArguments args, Aas.ISubmodelElement sme)
         {
             var astr = "";
@@ -78,7 +86,7 @@ protected string EvalLinkArguments(ExportSmtArguments args, Aas.ISubmodelElement
 
             var titStr = sme?.Description?.GetDefaultString();
             if (titStr?.HasContent() == true)
-                astr += $",title=\"{titStr}\"";
+                astr += $",title=\"{EscapeAdText(titStr)}\"";
 
             astr = astr.Trim(',');
 
@@ -168,13 +176,14 @@ protected void ProcessImageLink(Aas.ISubmodelElement sme)
             _log?.Info("Image data with {0} bytes writen to {1}.", data.Length, absFn);
 
             // create link arguments
+            var imgId = AdminShellUtil.FilterFriendlyName(sme.IdShort);
             var astr = EvalLinkArguments(args, sme);
 
             // create link text
             if (doLink)
             {
                 _adoc.AppendLine("");
-                _adoc.AppendLine($"image::{fn}[{astr}]");
+                _adoc.AppendLine($"image::{fn}[id=\"{imgId}\", {astr}]");
                 _adoc.AppendLine("");
             }
         }
@@ -289,7 +298,7 @@ protected void ProcessTables(Aas.IReferenceElement refel)
                 _optionsAll, optionsTable, absTableFn,
                 target, _package?.AasEnv, ticket, _log, maxDepth: processDepth,
                 idOfElem: refel.IdShort,
-                titleOfTable: refel.Description?.GetDefaultString());
+                titleOfTable: EscapeAdText(refel.Description?.GetDefaultString()));
 
             // include file into AsciiDoc
             if (_optionsSmt.IncludeTables)

src/AasxPluginExportTable/Table/ExportTableProcessor.cs

@@ -149,6 +149,13 @@ public CellRecord GetBodyCell(int row, int col)
         // Processors
         //
 
+        public class AdvancedMatch
+        {
+            public string Trigger;
+            public string Pattern;
+            public string Replace;
+        }
+
         public class ItemProcessor
         {
             //
@@ -177,8 +184,20 @@ public ItemProcessor(ImportExportTableRecord record, ExportTableAasEntitiesItem
             private Regex regexReplacements = null;
             private Regex regexStop = null;
             private Regex regexCommands = null;
+            
             private Dictionary<string, string> repDict = null;
 
+            private List<AdvancedMatch> _advancedMatches = new List<AdvancedMatch>();
+
+            private void advancedRep(string trigger, string pattern, string replace)
+            {
+                _advancedMatches.Add(new AdvancedMatch() {
+                    Trigger = trigger?.Trim().ToLower(),
+                    Pattern = pattern, 
+                    Replace = replace
+                });
+            }
+
             private void rep(string tag, string value)
             {
                 tag = tag?.Trim().ToLower();
@@ -283,12 +302,31 @@ private void repListOfLangStr(string head, List<Aas.ILangStringPreferredNameType
                     repLangStr(head, ls);
             }
 
+            protected string escapeLiteralsToFormat(string input)
+            {
+                // access
+                if (Record == null)
+                    return input;
+
+                // switch
+                var fmt = (ImportExportTableRecord.FormatEnum)Record.Format;
+                if (fmt == ImportExportTableRecord.FormatEnum.MarkdownGH ||
+                    fmt == ImportExportTableRecord.FormatEnum.AsciiDoc)
+                {
+                    // escape __00__
+                    input = input.Replace(@"__00__", @"\__00__");
+                    input = input.Replace(@"__000__", @"\__000__");
+                }
+
+                return input;
+            }
+
             private void repReferable(string head, Aas.IReferable rf)
             {
                 //-9- {Referable}.{idShort, category, description, description[@en..], elementName, 
                 //     elementAbbreviation, parent}
                 if (rf.IdShort != null)
-                    rep(head + "idShort", rf.IdShort);
+                    rep(head + "idShort", escapeLiteralsToFormat(rf.IdShort));
                 if (rf.Category != null)
                     rep(head + "category", rf.Category);
 
@@ -310,7 +348,8 @@ private void repReferable(string head, Aas.IReferable rf)
                         rf.GetSelfDescription()?.ElementAbbreviation);
                 }
                 if (rf is Aas.IReferable rfpar)
-                    rep(head + "parent", "" + (rfpar.IdShort != null ? rfpar.IdShort : "-"));
+                    rep(head + "parent", escapeLiteralsToFormat(
+                        "" + (rfpar.IdShort != null ? rfpar.IdShort : "-")));
 
                 // further details
                 List<string> details = new List<string>();
@@ -413,11 +452,33 @@ private void repReference(string head, string refName, Aas.IReference rid)
                 }
             }
 
+            private void repReferenceList(string head, string refName, List<Aas.IReference> rids)
+            {
+                if (refName == null)
+                    return;
+
+                rep(head + refName + "", "" + rids?.ToStringExtended(2, ", "));
+                rep(head + refName + "[br]", "" + rids?.ToStringExtended(2, "\r\n%BRPOST%%BRPOST%"));
+
+                advancedRep(
+                    trigger: "" + head + refName,
+                    pattern: head + refName + @"\[label=([^]]*)\]",
+                    replace: (rids?.IsValid() != true) ? ""
+                        : "%GROUP1%: " + rids?.ToStringExtended(2, ", ") + "");
+
+                advancedRep(
+                    trigger: "" + head + refName,
+                    pattern: head + refName + @"\[br-label=([^]]*)\]", 
+                    replace: (rids?.IsValid() != true) ? "" 
+                        :  "%GROUP1%: " + rids?.ToStringExtended(2, ", ") + "%BRPOST%%BRPOST%");
+            }
+
             public void Start()
             {
                 // init Regex
                 // nice tester: http://regexstorm.net/tester
-                regexReplacements = new Regex(@"%([a-zA-Z0-9.@\[\]]+)%", RegexOptions.IgnoreCase);
+                // MIHO 2024-06-12: added "=-" to first regex!
+                regexReplacements = new Regex(@"%([a-zA-Z0-9.@\[\]=-]+)%", RegexOptions.IgnoreCase);
                 regexStop = new Regex(@"^(.*?)%stop%(.*)$", RegexOptions.IgnoreCase);
                 regexCommands = new Regex(@"(%([A-Za-z0-9-_]+)=(.*?)%)", RegexOptions.IgnoreCase);
 
@@ -464,6 +525,7 @@ public void Start()
                         repMultiplicty(head, parsme.Qualifiers);
                         //-1- {Reference} = {semanticId, isCaseOf, unitId}
                         repReference(head, "semanticId", parsme.SemanticId);
+                        repReferenceList(head, "supplSemIds", parsme.SupplementalSemanticIds);
                     }
 
                     //-1- {Referable} = {SM, SME, CD}
@@ -477,6 +539,7 @@ public void Start()
                         repIdentifiable(head, sm);
                         //-1- {Reference} = {semanticId, isCaseOf, unitId}
                         repReference(head, "semanticId", sm.SemanticId);
+                        repReferenceList(head, "supplSemIds", sm.SupplementalSemanticIds);
                     }
 
                     if (sme != null)
@@ -486,6 +549,7 @@ public void Start()
                         repQualifiable(head, sme.Qualifiers);
                         repMultiplicty(head, sme.Qualifiers);
                         repReference(head, "semanticId", sme.SemanticId);
+                        repReferenceList(head, "supplSemIds", sme.SupplementalSemanticIds);
 
                         //-2- SME.value
 
@@ -631,6 +695,16 @@ public void Start()
                 }
             }
 
+            private static bool IsRegexMatchOne(string input, string pattern, out string matchOne)
+            {
+                var m = Regex.Match(input, pattern);
+                matchOne = "";
+                if (!m.Success || m.Groups.Count < 2)
+                    return false;
+                matchOne = m.Groups[1].ToString();
+                return true;
+            }
+
             // see: https://codereview.stackexchange.com/questions/119519/
             // regex-to-first-match-then-replace-found-matches
             public static string Replace(string s, int index, int length, string replacement)
@@ -668,15 +742,51 @@ public void ProcessCellRecord(CellRecord cr)
                         continue;
 
                     // OK, found a placeholder-tag to replace
-                    var tag = "" + match.Groups[1].Value.Trim().ToLower();
+                    var tag = "" + match.Groups[1].Value.Trim();
+                    var tagLC = tag.ToLower();
+
+                    // try match advanced
+                    string advancedReplace = null;
+                    foreach (var am in _advancedMatches)
+                        // fast condition
+                        if (tagLC.Contains(am.Trigger))
+                        {
+                            // sufficient condition
+                            // it is important to do the matching (for the group) on 
+                            // upper-/ lowercase
+                            var m = Regex.Match(tag, am.Pattern, RegexOptions.IgnoreCase);
+                            if (m.Success && m.Groups.Count >= 2)
+                            {
+                                // do the replace
+                                advancedReplace = am.Replace;
+
+                                // debug
+                                if (am.Replace != "")
+                                    ;
+
+                                // now care for regognized groups
+                                for (int i = 1; i < m.Groups.Count; i++)
+                                    advancedReplace = advancedReplace
+                                        .Replace($"%GROUP{i}%", m.Groups[i].ToString());
+                            }
+                        }
 
-                    if (repDict.ContainsKey(tag))
+                    // further matching and actual replace of input
+                    if (advancedReplace != null)
                     {
-                        input = Replace(input, match.Index, match.Length, repDict[tag]);
+                        // already prepared
+                        input = Replace(input, match.Index, match.Length, advancedReplace);
                         NumberReplacements++;
                     }
                     else
-                    if (tag == "stop")
+                    if (repDict.ContainsKey(tagLC))
+                    {
+                        // use dictionary value
+                        input = Replace(input, match.Index, match.Length, repDict[tagLC]);
+                        NumberReplacements++;
+                    }                    
+                    else
+                    if (tagLC == "stop")
                     {
                         // do nothing! see below!
                         ;

src/AasxPluginExportTable/Table/ImportExportPlaceholders.cs

@@ -42,7 +42,8 @@ public static string GetHelp()
                 @"All placeholders delimited by %{..}%, {} = set arithmetics, [] = optional
                 {Referable}.{idShort, category, description[@en..], elementName, elementShort, elementShort2, elementAbbreviation, kind, parent, details}, {Referable|Identifiable} = {SM, SME, CD}, depth, indent}
                 Identifiable.id, administration.{ version, revision}}, {Qualifiable}.qualifiers, {Qualifiable}.multiplicity
-                {Aas.Reference}, {Aas.Reference}[0..n], {Aas.Reference}[0..n].{type, local, idType, value}, {Aas.Reference} = {semanticId, isCaseOf, unitId}
+                {Aas.Reference}, {Aas.Reference}[0..n], {Aas.Reference}[0..n].{type, local, idType, value}, {Aas.Reference} = {semanticId, isCaseOf, unitId}                
+                {Aas.RefList}, {Aas.RefList}[br], {Aas.RefList}[label={label}], {Aas.RefList}[br-label={label}] {Aas.ReferenceList} = {supplSemIds}
                 SME.value, Property.{value, valueType, valueId}, MultiLanguageProperty.{value, vlaueId}, Range.{valueType, min, max}, Blob.{mimeType, value}, File.{mimeType, value}, ReferenceElement.value, 
                 RelationshipElement.{first, second}, SubmodelElementCollection.{value = #elements, ordered, allowDuplicates}, Entity.{entityType, asset}
                 CD.{preferredName[@en..], shortName[@en..], unit, unitId, sourceOfDefinition, symbol, dataType, definition[@en..], valueFormat}

src/Notes_V3.md

@@ -445,3 +445,10 @@ These projects are not migrated or integrated, yet:
 (\w+)\.(AssetAdministrationShells|Submodels|ConceptDescriptions)
 ```
 
+# TODO (starting from 2024-06-17)
+
+* Open Aux (Ctrl-X) keyboard shortcut not working
+* "Move down" of Submodels does not visually update
+* Copy an Submodel from aux while already having an SM with the *same* ID does not throw an error but is hard to recoginze.
+  (DispEditHelperEntities.cs:1429)
+* exporting Markdown/ AsciiDoc: text in cells from idShort shall not interpreted as markdown (__Marking_00__)