Help abstraction update (#68)

##### Objective
Embed the year reference within the webHelpAbstraction.json export.

##### Abstractions
Removed all hard coded and/or dynamically generated year paths related to documentation. Implemented a user prompt during abstraction creation, the provided value becomes the year baseline in all places from that point forward.

##### Tests performed
**C#**
- Verified the year would be dynamically added to existing json exports
- Verified the pages wouldn't load if an unreleased year was provided

**TS**
- Verified the help link functionality still works and used the json year value

Author: JD-Howard

.gitignore

@@ -4,3 +4,9 @@ vendor
 tmp
 autolispext*.zip
 package.nls.*.json
+
+utils/HelpAbstractionGenerator/**/*.pdb
+utils/HelpAbstractionGenerator/**/*.xml
+utils/HelpAbstractionGenerator/.vs
+utils/HelpAbstractionGenerator/obj
+utils/HelpAbstractionGenerator/packages

extension/src/help/openWebHelp.ts

@@ -26,9 +26,11 @@ export class WebHelpLibrary implements IJsonLoadable {
 	functions: Dictionary<WebHelpFunction> = {};
 	ambiguousFunctions: Dictionary<WebHelpFunction[]> = {};
 	enumerators: Dictionary<string> = {};	
+	year: string;
 
 	// consumes a JSON converted object into the WebHelpLibrary
 	loadFromJsonObject(obj: object): void{		
+		this.year = obj['year'] ?? '2021';
 		Object.keys(obj["dclAttributes"]).forEach(key => {
 			let newObj = new WebHelpDclAtt(obj["dclAttributes"][key]);
 			this.dclAttributes[key] = newObj;
@@ -65,26 +67,26 @@ export class WebHelpLibrary implements IJsonLoadable {
 			return; // No Document
 		} else if (editor.document.fileName.slice(-4).toUpperCase() === ".LSP") {
 			if (symbolProfile in this.objects){
-				return this.objects[symbolProfile].getHelpLink();
+				return this.objects[symbolProfile].getHelpLink(this.year);
 			} else if (symbolProfile in this.functions){        
-				return this.functions[symbolProfile].getHelpLink();
+				return this.functions[symbolProfile].getHelpLink(this.year);
 			} else if (symbolProfile in this.ambiguousFunctions){
-				return this.ambiguousFunctions[symbolProfile][0].getHelpLink();
+				return this.ambiguousFunctions[symbolProfile][0].getHelpLink(this.year);
 			} else if (symbolProfile in this.enumerators){
 				return this.getWebHelpUrlBySymbolName(this.enumerators[symbolProfile]);
 			} else {
-				return WebHelpEntity.createHelpLink("4CEE5072-8817-4920-8A2D-7060F5E16547");  // LSP General Landing Page
+				return WebHelpEntity.createHelpLink("4CEE5072-8817-4920-8A2D-7060F5E16547", this.year);  // LSP General Landing Page
 			}
 		} else if (editor.document.fileName.slice(-4).toUpperCase() === ".DCL") {
 			if (symbolProfile in this.dclTiles){        
-				return this.dclTiles[symbolProfile].getHelpLink();
+				return this.dclTiles[symbolProfile].getHelpLink(this.year);
 			} else if (symbolProfile in this.dclAttributes){        
-				return this.dclAttributes[symbolProfile].getHelpLink();
+				return this.dclAttributes[symbolProfile].getHelpLink(this.year);
 			} else {
-				return WebHelpEntity.createHelpLink("F8F5A79B-9A05-4E25-A6FC-9720216BA3E7"); // DCL General Landing Page
+				return WebHelpEntity.createHelpLink("F8F5A79B-9A05-4E25-A6FC-9720216BA3E7", this.year); // DCL General Landing Page
 			}
 		}
-		return WebHelpEntity.getDefaultHelpLink();
+		return WebHelpEntity.getDefaultHelpLink(this.year);
 	}
 }
 
@@ -138,18 +140,17 @@ class WebHelpEntity {
 	}
 
 
-	getHelpLink(): string {
-		return WebHelpEntity.getDefaultHelpLink() + "?guid=GUID-" + this.guid;
+	getHelpLink(year): string {
+		return WebHelpEntity.getDefaultHelpLink(year) + "?guid=GUID-" + this.guid;
 	}
 
-	static createHelpLink(guid: string): string {
-		return WebHelpEntity.getDefaultHelpLink() + "?guid=GUID-" + guid;
+	static createHelpLink(guid: string, year: string): string {
+		return WebHelpEntity.getDefaultHelpLink(year) + "?guid=GUID-" + guid;
 	}
 
-	static getDefaultHelpLink(): string {
+	static getDefaultHelpLink(year: string): string {
 		let lang: string = WebHelpEntity.getLanguageUrlDomain();
-		let year: number = new Date().getFullYear();
-		return "https://help.autodesk.com/view/OARX/" + year.toString() + lang;
+		return "https://help.autodesk.com/view/OARX/" + year + lang;
 	}
 
 	static getLanguageUrlDomain(): string {

extension/src/help/webHelpAbstraction.json

@@ -1,4 +1,5 @@
 {
+  "year": "2021",
   "objects": {
     "_dacadapplicationevents": {
       "methods": [

utils/HelpAbstractionGenerator/HelpAbstractionGenerator.csproj

@@ -41,6 +41,7 @@
     <Reference Include="Microsoft.mshtml, Version=7.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
       <EmbedInteropTypes>True</EmbedInteropTypes>
     </Reference>
+    <Reference Include="Microsoft.VisualBasic" />
     <Reference Include="Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
       <HintPath>packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
     </Reference>

utils/HelpAbstractionGenerator/MainWindow.xaml

@@ -37,7 +37,8 @@
                         <TextBlock TextWrapping="Wrap" Margin="5">
                                    Once the page has loaded, expand all the left-side navigation elements you want to include in the data collection,
                                    this is required because the actual links don't exist until they've been expanded through a click event. Finally,
-                                   click the 'Collect Links and Continue' button before moving onto step 2.
+                                   click the 'Collect Links and Continue' button before moving onto step 2. If this page doesn't load then there is a
+                                   good change the year you provided doesn't have documentation available at this time.
                         </TextBlock>
                         <Separator Margin="0" Padding="0"/>
                     </StackPanel>                    

utils/HelpAbstractionGenerator/MainWindow.xaml.cs

@@ -141,6 +141,8 @@ private void tabInterface_SelectionChanged(object sender, SelectionChangedEventA
                             break;
                         case 5: // possibly some kind of rule system
                             CurrentLib = ioPathHelpAbstraction.UnPack<WebObjectLibrary>();
+                            if (CurrentLib.year == null)
+                                CurrentLib.year = urlHelpers.year;
                             AllOverrides.Clear();
                             Filter = "";
                             if (System.IO.File.Exists(ioPathRuleOverrides) == true)
@@ -250,7 +252,7 @@ private void lbxScrapeContent_SelectedItemChanged(object sender, RoutedPropertyC
         }
         private void btnScrapeAllContent_Click(object sender, RoutedEventArgs e)
         {
-            WebObjectLibrary ejoLib = new WebObjectLibrary();
+            WebObjectLibrary ejoLib = new WebObjectLibrary(urlHelpers.year);
             foreach (var key in CatagorizedLinks.Keys)
             {
                 foreach (var link in CatagorizedLinks[key])
@@ -348,7 +350,7 @@ private void btnExportFinalAbstraction_Click(object sender, RoutedEventArgs e)
                 StringBuilder sb = new StringBuilder();
                 sb.AppendLine("Extraction Completed: " + (Errors.Count == 0 ? "without errors" : "with override json errors!"));
                 sb.AppendLine("");
-                sb.AppendLine("Note that unless you've specifically overwritten the internal (pre-override) version, then this dialog will not show show the exported version");
+                sb.AppendLine("Note that unless you've specifically overwritten the internal (pre-override) version, then this dialog will not show the exported version");
                 sb.AppendLine("");
                 sb.AppendLine("");
                 foreach (string err in Errors)

utils/HelpAbstractionGenerator/StaticUtilities.cs

@@ -38,13 +38,18 @@ public static string wrapContentIntoHtmlDocument(List<HAP.HtmlNode> bodyContent)
 
     public static class urlHelpers
     {
+        public static string year = "";
         public static string getHelpURL(string guid)
         {
             return getDefaultHelpURL() + "?guid=GUID-" + guid;
         }
         public static string getDefaultHelpURL()
         {
-            return "https://help.autodesk.com/view/OARX/2021/" + System.Globalization.CultureInfo.CurrentCulture.ThreeLetterWindowsLanguageName + "/";
+            if (year == "")
+                year = Microsoft.VisualBasic.Interaction.InputBox("This should be the most current version of the Autodesk documentation and may not be the current year shown", "Enter 4 digit year", DateTime.Now.Year.ToString()).Trim();
+            if (year == "")
+                year = "2021";
+            return "https://help.autodesk.com/view/OARX/" + year + "/" + System.Globalization.CultureInfo.CurrentCulture.ThreeLetterWindowsLanguageName + "/";
         }
     }
 

utils/HelpAbstractionGenerator/StepBehaviors/Step4.WebObjectLibrary.cs

@@ -13,6 +13,7 @@ namespace HelpAbstractionGenerator
     #region Exported Json Objects
     public class WebObjectLibrary
     {
+        public string year { get; set; }
         public Dictionary<string, ejoObject> objects { get; set; } = new Dictionary<string, ejoObject>();
         public Dictionary<string, ejoFunction> functions { get; set; } = new Dictionary<string, ejoFunction>();
         public Dictionary<string, List<ejoFunction>> ambiguousFunctions { get; set; } = new Dictionary<string, List<ejoFunction>>();
@@ -22,6 +23,7 @@ public class WebObjectLibrary
         public Dictionary<string, ejoEvent> events { get; set; } = new Dictionary<string, ejoEvent>();
 
         public WebObjectLibrary() { }
+        public WebObjectLibrary(string year) { this.year = year; }
     }