/// WorkspaceViewModel's Save method does a two-part serialization. First, it serializes the Workspace,
/// then adds a View property to serialized Workspace, and sets its value to the serialized ViewModel.
@@ -600,7 +710,7 @@ internal void ZoomOutInternal()
///
///
/// Thrown when the file path is null.
- internal void Save(string filePath, bool isBackup = false, EngineController engine = null, SaveContext saveContext = SaveContext.None)
+ internal bool Save(string filePath, bool isBackup = false, EngineController engine = null, SaveContext saveContext = SaveContext.None)
{
if (String.IsNullOrEmpty(filePath))
{
@@ -616,14 +726,11 @@ internal void Save(string filePath, bool isBackup = false, EngineController engi
//set the name before serializing model.
this.Model.setNameBasedOnFileName(filePath, isBackup);
- // Stage 1: Serialize the workspace.
- var json = Model.ToJson(engine);
- var json_parsed = JObject.Parse(json);
- // Stage 2: Add the View.
- var jo = AddViewBlockToJSON(json_parsed);
+ // Stage 1: Serialize the workspace and the View
+ var jo = GetJsonRepresentation(engine);
- // Stage 3: Save
+ // Stage 2: Save
string saveContent;
if(saveContext == SaveContext.SaveAs && !isBackup)
{
@@ -641,23 +748,30 @@ internal void Save(string filePath, bool isBackup = false, EngineController engi
if (result == MessageBoxResult.Cancel)
{
- return;
+ return false;
}
}
}
-
- saveContent = GuidUtility.UpdateWorkspaceGUIDs(jo.ToString());
+ saveContent = GuidUtility.UpdateWorkspaceGUIDs(jo.ToString());
}
else
{
saveContent = jo.ToString();
- }
- File.WriteAllText(filePath, saveContent);
+ }
+ File.WriteAllText(filePath, saveContent);
+
// Handle Workspace or CustomNodeWorkspace related non-serialization internal logic
// Only for actual save, update file path and recent file list
+ // The assignation of the JsonRepresentation and Guid is only for the checksum flow, it will grab info only from .dyn files
if (!isBackup)
{
+ if (Path.GetExtension(filePath).Equals(".dyn"))
+ {
+ JsonRepresentation = JObject.Parse(saveContent);
+ DynamoViewModel.Workspaces[0].Model.Guid = new Guid(JsonRepresentation.Properties().First(p => p.Name == "Uuid").Value.ToString());
+ }
+
Model.FileName = filePath;
Model.OnSaved();
}
@@ -677,6 +791,8 @@ internal void Save(string filePath, bool isBackup = false, EngineController engi
throw ex;
#pragma warning restore CA2200 // Rethrow to preserve stack details
}
+
+ return true;
}
///
/// This function appends view block to the model json
@@ -1567,7 +1683,7 @@ private void DoGraphAutoLayout(object o)
Model.DoGraphAutoLayout();
DynamoViewModel.RaiseCanExecuteUndoRedo();
- Dynamo.Logging.Analytics.TrackCommandEvent("GraphLayout");
+ Dynamo.Logging.Analytics.TrackTaskCommandEvent("GraphLayout");
}
private static bool CanDoGraphAutoLayout(object o)
@@ -1639,7 +1755,7 @@ internal void CollapseSelectedNodes()
DynamoViewModel.Model.CustomNodeManager.Collapse(selectedNodes,
selectedNotes, Model, DynamoModel.IsTestMode, args));
- Dynamo.Logging.Analytics.TrackCommandEvent("NewCustomNode",
+ Dynamo.Logging.Analytics.TrackTaskCommandEvent("NewCustomNode",
"NodeCount", selectedNodes.Count());
}
diff --git a/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs b/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
index 4c3b2a1fa65..9e74bb37fdd 100644
--- a/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
+++ b/src/DynamoCoreWpf/ViewModels/Menu/PreferencesViewModel.cs
@@ -197,13 +197,14 @@ public string SelectedUnits
if (UseHostScaleUnits && IsDynamoRevit) return;
- var result = Enum.TryParse(selectedUnits, out Configurations.Units currentUnit);
+ var enUnit = LocalizedUnitsMap.FirstOrDefault(x => x.Key == selectedUnits).Value;
+ var result = Enum.TryParse(enUnit, out Configurations.Units currentUnit);
if (!result) return;
if (Configurations.SupportedUnits.TryGetValue(currentUnit, out double units))
{
// Update preferences setting and update the grapic helpers
- preferenceSettings.GraphicScaleUnit = value;
+ preferenceSettings.GraphicScaleUnit = currentUnit.ToString();
preferenceSettings.GridScaleFactor = (float)units;
dynamoViewModel.UpdateGraphicHelpersScaleCommand.Execute(null);
@@ -961,23 +962,6 @@ public string SelectedPythonEngine
}
}
- ///
- /// Controls the IsChecked property in the "Hide IronPython alerts" toggle button
- ///
- [Obsolete("This property is deprecated and will be removed in a future version of Dynamo")]
- public bool HideIronPythonAlertsIsChecked
- {
- get
- {
- return preferenceSettings.IsIronPythonDialogDisabled;
- }
- set
- {
- preferenceSettings.IsIronPythonDialogDisabled = value;
- RaisePropertyChanged(nameof(HideIronPythonAlertsIsChecked));
- }
- }
-
///
/// Controls the IsChecked property in the "Show Whitespace in Python editor" toggle button
///
@@ -1050,7 +1034,7 @@ public bool IsDynamoRevit
{
// HostAnalyticsInfo is not set when this is invoked??
//return this.dynamoViewModel.Model.HostAnalyticsInfo.HostName.Equals("Dynamo Revit");
- var host = this.dynamoViewModel.Model.HostAnalyticsInfo.HostName;
+ var host = DynamoModel.HostAnalyticsInfo.HostName;
if (host != null)
{
@@ -1085,6 +1069,17 @@ public bool NodeAutocompleteIsChecked
}
}
+ ///
+ /// If MLAutocompleteTOU is approved
+ ///
+ internal bool IsMLAutocompleteTOUApproved
+ {
+ get
+ {
+ return preferenceSettings.IsMLAutocompleteTOUApproved;
+ }
+ }
+
///
/// Controls if the the Node autocomplete Machine Learning option is checked for the radio buttons
///
@@ -1245,7 +1240,7 @@ internal void HideUnhideNamespace(bool hide, string library, string namespc)
private void AddPythonEnginesOptions()
{
var options = new ObservableCollection { Res.DefaultPythonEngineNone };
- foreach (var item in PythonEngineManager.Instance.AvailableEngines)
+ foreach (var item in PythonEngineManager.Instance.AvailableEngines.GroupBy(x=>x.Name).Select(g=>g.FirstOrDefault()).ToList())
{
options.Add(item.Name);
}
@@ -1297,6 +1292,41 @@ public bool importSettingsContent(string content)
return setSettings(newPreferences);
}
+ ///
+ /// The dictionary that contains the localized resource strings for Units.
+ /// This is done to avoid a breaking change that is storing the selected unit in settings file in english language.
+ ///
+ private Dictionary LocalizedUnitsMap;
+
+ ///
+ /// Returns localized resource strings for Units
+ ///
+ private string GetLocalizedUnits(Enum value)
+ {
+ if (value != null)
+ {
+ switch (value)
+ {
+ case Configurations.Units.Millimeters:
+ return Res.GESUnitMillimeters;
+ case Configurations.Units.Centimeters:
+ return Res.GESUnitCentimeters;
+ case Configurations.Units.Kilometers:
+ return Res.GESUnitKilometers;
+ case Configurations.Units.Meters:
+ return Res.GESUnitMeters;
+ case Configurations.Units.Inches:
+ return Res.GESUnitInches;
+ case Configurations.Units.Feet:
+ return Res.GESUnitFeet;
+ case Configurations.Units.Miles:
+ return Res.GESUnitMiles;
+ }
+ }
+ return null;
+ }
+
+
private bool setSettings(PreferenceSettings newPreferences)
{
// Explicit copy
@@ -1369,9 +1399,15 @@ public PreferencesViewModel(DynamoViewModel dynamoViewModel)
LanguagesList = Configurations.SupportedLocaleDic.Keys.ToObservableCollection();
SelectedLanguage = Configurations.SupportedLocaleDic.FirstOrDefault(x => x.Value == preferenceSettings.Locale).Key;
+ LocalizedUnitsMap = new Dictionary();
+ foreach (var unit in Configurations.SupportedUnits)
+ {
+ LocalizedUnitsMap.Add(GetLocalizedUnits(unit.Key), unit.Key.ToString());
+ }
+
// Chose the scaling unit, if option is allowed by user
- UnitList = Configurations.SupportedUnits.Keys.Select(x => x.ToString()).ToObservableCollection();
- SelectedUnits = Configurations.SupportedUnits.FirstOrDefault(x => x.Key.ToString() == preferenceSettings.GraphicScaleUnit).Key.ToString();
+ UnitList = Configurations.SupportedUnits.Keys.Select(x => GetLocalizedUnits(x)).ToObservableCollection();
+ SelectedUnits = GetLocalizedUnits(Configurations.SupportedUnits.FirstOrDefault(x => x.Key.ToString() == preferenceSettings.GraphicScaleUnit).Key);
GroupStyleFontSizeList = preferenceSettings.PredefinedGroupStyleFontSizes;
@@ -1416,11 +1452,13 @@ public PreferencesViewModel(DynamoViewModel dynamoViewModel)
SavedChangesTooltip = string.Empty;
// Add tabs
- preferencesTabs = new Dictionary();
- preferencesTabs.Add("General", new TabSettings() { Name = "General", ExpanderActive = string.Empty });
- preferencesTabs.Add("Features",new TabSettings() { Name = "Features", ExpanderActive = string.Empty });
- preferencesTabs.Add("VisualSettings",new TabSettings() { Name = "VisualSettings", ExpanderActive = string.Empty });
- preferencesTabs.Add("Package Manager", new TabSettings() { Name = "Package Manager", ExpanderActive = string.Empty });
+ preferencesTabs = new Dictionary
+ {
+ { "General", new TabSettings() { Name = "General", ExpanderActive = string.Empty } },
+ { "Features", new TabSettings() { Name = "Features", ExpanderActive = string.Empty } },
+ { "VisualSettings", new TabSettings() { Name = "VisualSettings", ExpanderActive = string.Empty } },
+ { "Package Manager", new TabSettings() { Name = "Package Manager", ExpanderActive = string.Empty } }
+ };
//create a packagePathsViewModel we'll use to interact with the package search paths list.
var loadPackagesParams = new LoadPackageParams
@@ -1867,10 +1905,6 @@ public class PythonTemplatePathEventArgs : EventArgs
///
public class GeometryScalingOptions
{
- //The Enum values can be Small, Medium, Large or Extra Large
- [Obsolete("This property is deprecated and will be removed in a future version of Dynamo")]
- public GeometryScaleSize EnumProperty { get; set; }
-
///
/// This property will contain the description of each of the radio buttons in the Visual Settings -> Geometry Scaling section
///
diff --git a/src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html b/src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html
index 41204540969..b02d372ee01 100644
--- a/src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html
+++ b/src/DynamoCoreWpf/ViewModels/PackageManager/Docs/PublishPackageDocumentation.html
@@ -1,4 +1,4 @@
-
@@ -150,87 +150,154 @@
- Publishing Dynamo Packages
+ Package Manager
- Dynamo offers a vast number of features out of the box and also maintains an extensive package library, to which the community can contribute, that can significantly extend Dynamo's capability.
- This documentation describes how a user can publish a package from Dynamo.
+ The Dynamo Package Manager is a one-stop-shop for browsing, installing, and publishing packages. Access it from the top navigation under Packages > Package Manager.
+ What are packages?
- The menu option to publish a package can be found at: "Packages > Publish New Package...".
- Clicking this menu item will open a dialog box that will ask for all the information related to the package the user wants to publish.
+ Dynamo offers a vast number of features out of the box and also maintains an extensive package library that can significantly extend Dynamo’s capability.
+ A package is a collection of custom nodes or additional functionality. The Dynamo Package Manager is a portal for the community to download any package that has been published online.
+ These toolsets are developed by third parties to extend Dynamo's core functionality, accessible to all, and ready to download at the click of the button.
- Package Name:
+ Installing Dynamo packages
- Name of the package you want to publish. This will appear in the library and on the package manager website.
+ You can browse and install packages in the Search for Packages tab of the Package Manager. Use the search field to locate specific packages.
+ You can also apply filters and sorting to narrow down the list to meet your criteria, such as a host program or lack of dependencies.
+
+
+ To view more information about a package, click View Details. This opens a panel where you can read a description of the package, find version and license information, and more.
+
+
+ To install a package, click Install either in the search view or in the details panel. You can specify a version to install in the search view by clicking the drop-down and selecting a version; otherwise, the most recent version will be installed.
+ In the package details panel, click Install below a specific version in the Versions and Package Requirements table to install that version.
+
+
+ You can find a list of the packages you have installed in the Installed Packages tab of the Package Manager. On this tab, you can view package files, uninstall packages, and more.
+
+ Publishing Dynamo Packages
+
+ The Package Manager allows you to publish packages inside Dynamo. Open the Publish a Package tab to get started.
+ The Publish a Package tab asks for all required and optional information related to the package that you want to publish.
+
+
+ Adding package details
+
+
+ Package Name:
+ Name of the package you want to publish. This will appear in the library, in package search, and on the package manager website. Package names must be at least 3 characters in length.
Description:
- The description is a great place to add more details about your package, including listing any exceptions and pre-requisites.
- It can also be used to educate users on what the package does and how it can be utilised into their workspaces.
+ The description is a great place to add more details about your package, including listing any exceptions and prerequisites. It can also be used to educate users on what the package does and how it can be used in their workspaces.
Version:
- The version field is split into three sections, major, minor and build, which allows you as a package author to upload new versions of your
- package that follow versioning semantics - Users may want to publish more versions for their packages with new and improved features,
- polish some corners which were left out in the first version, or fix a bug.
+ The version field is split into three sections, major, minor, and build, which allows you as a package author to upload new versions of your package that follow versioning semantics. Package authors may want to publish more versions for their packages with new and improved features, polish some corners that were left out in the first version, or fix a bug.
- Group:
- This field can be used to specify a group that a package belongs to such as the company/organization.
+ Host:
+ If your package relies on a host program, such as Revit, Civil3D, Alias, or others, you can pick one or more hosts from the drop-down. When searching for packages, users can filter results based on host to help them locate packages that are designed to work with their preferred programs.
- External Dependency (optional):
- Your package may depend on a host or its API as Dynamo can be integrated with a bunch of different optional
- hosts such as Revit or Civil 3D, so this field can be used to specify which other host(s) your package depends upon.
+ Keywords (optional):
+ Keywords that can be used as tags related to your package, for example, Generative Design, ML, etc. You can type multiple keywords into the field at once by separating them with the space key, then pressing Enter.
- Keywords (optional):
- Some keywords that can be used as tags related to your package. For e.g Generative Design, ML etc.
+ Group (optional):
+ This field can be used to specify a group that a package belongs to such as the company/organization.
Website (optional):
- Website that may provide the user with more info regarding the package or the organization/author.
+ A link to a website that may provide the user with more information regarding the package or the organization/author.
Repository URL (optional):
- A link to package's repository that can help users to view or contribute to the package development.
+ A link to the package’s repository that allows users to view or contribute to package development.
License (optional):
A license under which the package is released. Default license : MIT.
- Package Contents (optional):
- This section includes the right sidebar of the dialog box.
+ Copyright holder (optional):
+ Name of the person who holds the copyright to the package. If left blank, this defaults to your username.
+
+
+ Copyright year (optional):
+ The copyright year for the package. If left blank, this defaults to the year the package was published.
+
+
+ Adding package files
+
+
+ Package Contents:
+ This section, located in the right sidebar of the Publish a Package tab, allows you to organize your package contents prior to publishing.
+
+
+ Add Files/Directory:
+
+ Select and add all the files that are related to your package. Generally, the bin folder, binaries, and dependencies are added.
+ You can add individual files or folders.
- Add File:
- Select and add all the files that are related to your package; generally the bin folder, binaries and dependencies are added.
+ After you’ve selected files or folders to add, you can view, remove, or add files on the Select Package Contents page.
+ You can view the folder structure of your selected files in the left panel, and the contents of each folder in the right panel.
+
Select Node Libraries:
- Specify which of the files you added to the package are the node libraries. Node libraries contain the types and methods that Dynamo will import as nodes. In general you should mark any assembly as a node library which contains types you wish to import into Dynamo. ZeroTouch, NodeModel, or NodeViewCustomization assemblies should be marked as node library.
+ Specify which of the files you added to the package are the node libraries by checking the box in the Node Library column.
+ Node libraries contain the types and methods that Dynamo will import as nodes. In general, you should mark any assembly as a node library which contains types you wish to import into Dynamo.
+ ZeroTouch, NodeModel, or NodeViewCustomization assemblies should be marked as a node library.
- To load UI NodeViewCustomizations they should be either defined in the same assembly that contains the corresponding NodeModel definitions OR defined in a separate assembly. In either case, the assembly must be tagged as a node library.
- Currently, for assemblies marked as node library that contain NodeModel or NodeCustomization types, all other types will be ignored. For this reason It is important to separate NodeModel/NodeViewCustomization types from types you wish to import using ZeroTouch import.
+ To load UI NodeViewCustomizations, they should be either defined in the same assembly that contains the corresponding NodeModel definitions OR defined in a separate assembly.
+ In either case, the assembly must be tagged as a node library. Currently, for assemblies marked as node library that contain NodeModel or NodeCustomization types, all other types will be ignored. For this reason, it is important to separate NodeModel/NodeViewCustomization types from types you wish to import using ZeroTouch import.
+
- Publish Step:
+
+ Retain folder structure:
+
+ Package authors with complex package folder structures may want to enable the Retain Folder Structure toggle below the package contents preview panel.
+ This setting is toggled on by default when a user is publishing a new version of an existing package, in this case, Dynamo won’t make changes to your package folder structure; instead, the package will be uploaded as is.
+
+
+ If you need your package to be set up in a certain way to ensure they work and to avoid any issues, toggle the setting on.
+ When in doubt, or publishing a new package, toggle the setting off to allow Dynamo to set up the folder structure.
+
- After filling in all the required details you can publish the package locally or online.
- When publishing locally the package will be published in the local root directory,
- whereas while publishing online the package will be uploaded to the package manager.
+ Preview Package Contents:
+ When you are satisfied with your package contents, click Next to see a preview of how the package files will be set up once they are published.
+ This page is view only; to make additional changes to the package contents, go back to the previous page. Click Finish to return to the package details page.
+
+ Add markdown file path (optional):
+ You have the option to specify a file path that hosts markdown (.md) documentation for your package in the Markdown Files Path section.
+
+
+ Publishing your package
+ After filling in all the required details, you can publish the package locally or online. When publishing locally, the package will be published in the local root directory, whereas when publishing online, the package will be uploaded to the Package Manager.
+
+
+
Anti-virus Scans
- To provide a secure environment to all Dynamo Package users, we have introduced anti-virus scans for new packages.
+ To provide a secure environment to all Dynamo package users, we have introduced anti-virus scans for new packages.
When a user uploads a package, it will be scanned for viruses and will only be available publicly once it has been flagged as safe.
The scan will happen during the package upload process and will not add to the usual duration of 10-15 minutes for the new package to be available online.
- If your package is flagged as infected, the Package Manager search window will display a notification stating that the uploaded package has
- been found to be infected and won't be published online. To make the package publicly available, check the files included with the package
- and upload a new version through the Package Manager.
+ If your package is flagged as infected, the Package Manager search page will display a notification stating that the uploaded package has been found to be infected and won't be published online.
+ To make the package publicly available, check the files included with the package and upload a new version through the Package Manager.
+
+ Managing your packages
+
+ You can find a list of your published packages in the My Packages tab of the Package Manager, where you can deprecate them, publish a new version, etc.
+
+ Package Settings
+
+ You can view your package-related settings in the Package Settings tab of the Package Manager, including new package download paths and package/library search paths. To edit your settings, click the Preferences link in the Package Settings tab to access the Preferences panel.
-
\ No newline at end of file
+