added docs

Author: AmenJlili

docs/README.html

@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="">
 
 
-      <meta name="docfx:docurl" content="https://github.com/BlueByteSystemsInc/PDMShell.Docs/blob/master/README.md/#L1">
+      <meta name="docfx:docurl" content="https://github.com/BlueByteSystemsInc/PDMShell/blob/master/README.md/#L1">
       <meta name="loc:inThisArticle" content="In this article">
       <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
       <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
@@ -97,7 +97,7 @@ <h1 id="tool">Tool</h1>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/BlueByteSystemsInc/PDMShell.Docs/blob/master/README.md/#L1" class="edit-link">Edit this page</a>
+          <a href="https://github.com/BlueByteSystemsInc/PDMShell/blob/master/README.md/#L1" class="edit-link">Edit this page</a>
         </div>
 
         <div class="next-article d-print-none border-top" id="nextArticle"></div>

docs/index.html

@@ -16,7 +16,7 @@
       <meta name="docfx:rel" content="">
 
 
-      <meta name="docfx:docurl" content="https://github.com/BlueByteSystemsInc/PDMShell.Docs/blob/master/index.md/#L1">
+      <meta name="docfx:docurl" content="https://github.com/BlueByteSystemsInc/PDMShell/blob/master/index.md/#L1">
       <meta name="loc:inThisArticle" content="In this article">
       <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
       <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
@@ -275,7 +275,7 @@ <h2 id="contact-us">Contact Us</h2>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/BlueByteSystemsInc/PDMShell.Docs/blob/master/index.md/#L1" class="edit-link">Edit this page</a>
+          <a href="https://github.com/BlueByteSystemsInc/PDMShell/blob/master/index.md/#L1" class="edit-link">Edit this page</a>
         </div>
 
         <div class="next-article d-print-none border-top" id="nextArticle"></div>

docs/index.json

@@ -59,6 +59,11 @@
     "title": "EDITVARS Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
     "keywords": "EDITVARS Command Documentation DESCRIPTION: Shows the variable editor manager. SYNTAX: editvars PARAMETERS: None EXAMPLES: editvars PREVIEW:"
   },
+  "src/EVAL.html": {
+    "href": "src/EVAL.html",
+    "title": "Evaluation Functionality in PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
+    "keywords": "Evaluation Functionality in PDMShell Overview The Evaluation functionality in PDMShell allows dynamic value substitution using placeholders. This feature is supported by several commands and enables the use of file or folder properties, system variables, and other contextual information to generate new values dynamically. Evaluation is not a standalone command but a functionality used by specific commands to process the value parameter or other relevant inputs. Commands Supporting Evaluation The following commands support evaluation: Commands Using the Current Folder as the backing Object (directory parameter): cd: Change the current directory. mkdir: Create a new directory. exportcommand: Export commands to a file. addtvault: Add a vault with the directory as the backing object. Commands Using Files or Folders as the backing Object: rename: Uses the value parameter for renaming files or folders. setvar: Uses the value parameter to set variables for files or folders. Placeholders for Evaluation The value parameter in supported commands can include placeholders that are dynamically replaced with actual values based on the context. The placeholders differ slightly depending on whether the backing object is a file or a folder. Placeholders for Files $value: Existing value of the variable. $name: The file name with extension. $nameWithoutExtension: The file name without extension. $username: The name of the logged-in user. $vaultName: The name of the vault. $yyyy: The current year. $mm: The current month (two digits). $hh: The current hour (two digits). $mi: The current minute (two digits). $ss: The current second (two digits). $id: The file ID. $revision: The current revision of the file (PDM revision, not the PDM variable). $date: The current date. $time: The current time in the current locale. $version: The current version of the file. $extension: The file extension. $fullyQualifiedName: The full local path of the file. $fullyQualifiedFolderName: The full local path of the folder containing the file. $folderName: The name of the folder containing the file. Placeholders for Folders $value: Existing value of the variable. $name: The folder name. $folderName: The name of the parent folder. $id: The folder ID. $fullyQualifiedName: The full local path of the folder. $username: The name of the logged-in user. $vaultName: The name of the vault. $yyyy: The current year. $mm: The current month (two digits). $hh: The current hour (two digits). $mi: The current minute (two digits). $ss: The current second (two digits). $date: The current date. $time: The current time in the current locale. Using Variables in Evaluation In addition to placeholders, you can include other variables by enclosing them in square brackets (e.g., [VariableName]). These variables are dynamically resolved based on the context of the file or folder."
+  },
   "src/FROGLEAP.html": {
     "href": "src/FROGLEAP.html",
     "title": "FROGLEAP Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
@@ -198,5 +203,10 @@
     "href": "src/introduction.html",
     "title": "Introduction to PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "keywords": "Introduction to PDMShell Welcome to PDMShell, the command-line interpreter designed specifically for SOLIDWORKS PDM Professional. PDMShell empowers engineers and IT professionals with a powerful, flexible, and efficient tool for automating and streamlining tasks within the SOLIDWORKS PDM environment. Using the Help System PDMShell provides a comprehensive help system and detailed command documentation to guide you through its features. Here's how to get started: To view a list of all available commands, type: help To get detailed information about a specific command, type: help -c <command> For example: help -c cd Understanding the Command Documentation Structure Each command page in PDMShell documentation is organized into the following sections: DESCRIPTION: A brief explanation of what the command does. SYNTAX: The syntax for using the command, including required and optional parameters. PARAMETERS: A detailed explanation of each parameter, including whether it is required or optional. EXAMPLES: Practical examples of how to use the command. REMARKS: Additional notes, tips, or special considerations for using the command. VIDEO: A short video tutorial demonstrating the command in action (if available). Example Command Documentation Here’s an example of how a command is documented: CD Command Documentation DESCRIPTION: Changes the current PDM directory. SYNTAX: cd [-directory|id] PARAMETERS: directory (or d): The directory to switch to. The directory parameter can be a relative or absolute path in PDM. id: ID of the folder to navigate to. EXAMPLES: cd -directory 'C:\\Vault\\NewFolder' # Navigates to NewFolder cd -id 755 # Navigates to the folder with ID 755 REMARKS: Use cd.. to navigate to the parent folder or cd\\ to navigate to the root of the vault. If you just created a new folder and want to cd to it using autocomplete, use the dir command with the -refresh parameter to reload the session. directory is the default parameter, so you don’t need to specify it if it’s the only parameter in your command. VIDEO: By following this structure, you can quickly learn how to use any command in PDMShell and integrate it into your workflows. 📞 Getting Support If you need assistance or have any questions, we're here to help! Contact Us: Click the button below to reach out to our support team: Get Support Thank you for choosing PDMShell! We’re excited to help you streamline your PDM workflows and unlock new levels of productivity."
+  },
+  "src/scripting.html": {
+    "href": "src/scripting.html",
+    "title": "| Powershell like features for SOLIDWORKS PDM Professional",
+    "keywords": "gi# Scripting in PDMShell Overview PDMShell supports scripting to automate tasks and streamline workflows. Scripts use the .pdmshell file extension and are plain text files, making them easy to create and edit using any text editor, such as Notepad. Creating a Script A PDMShell script is a sequence of PDMShell commands written in a plain text file. Each command is executed in the order it appears in the script. Example Script Below is an example of a .pdmshell script: # filepath: example.pdmshell # This script automates exporting and adding files to the vault. # Navigate to the working directory cd \"\\api\\sandbox\\fidget spinner\" # Create a new export folder with a dynamic name using the current folder mkdir \"$name-export-$date\" # Export all SolidWorks part files to the new folder as STEP files export -search %.sldprt -directory \"$name-export-$date\" -extensions stp -name $namewithoutextension-$yyyy-$mm-$dd # Change to the newly created export folder cd \"$name-export-$date\" # Add the exported files to the vault as stp files are NOT automatically added addtovault -source \" \" # Check in all files in the current folder checkin -search % # Open the folder in File Explorer start . Script Annotations cd \"\\api\\sandbox\\fidget spinner\": Changes the current working directory to the specified path. mkdir \"$name-export-$date\": Creates a new folder with a dynamic name based on the current date and the folder name. export: Exports all .sldprt files in the current directory to the newly created folder as .stp files, appending the current date to the file names. cd \"$name-export-$date\": Changes the working directory to the newly created export folder. addtovault: Adds the exported files to the vault. checkin: Checks in all files in the current folder to the vault. start .: Opens the current folder in File Explorer. Comments Lines that start with # are ignored. Executing a Script There are two ways to execute a .pdmshell script: 1. Using pdmcli.exe You can execute a script using the pdmcli.exe command-line tool. Provide the script file as the first argument, wrapped in quotes if the file path contains spaces. Example Command pdmcli.exe \"C:\\Scripts\\example.pdmshell\" The pdmcli.exe tool can be found in the installation folder under Program Files (x86)\\BLUE BYTE SYSTEMS INC. 2. Using the runscript Command You can also execute scripts directly from the PDMShell console using the runscript command. [Note] Example Command runscript -source \"C:\\Scripts\\example.pdmshell\" Note For more information about the runscript command, refer to the runscript documentation. Advanced Usage: Workflow Integration For users with the Premium Version of PDMShell, pdmcli.exe can be hooked into workflow transitions. This allows scripts to be executed automatically as part of a workflow, enabling seamless automation of complex processes. Remarks Scripts are a powerful way to automate repetitive tasks and enforce consistency in workflows. Since .pdmshell files are plain text, they can be created and edited using any text editor. Ensure the script file is saved with the .pdmshell extension for proper execution. Use comments (#) in scripts to document the purpose of each command for better readability. Let Blue Byte Systems Write Your Scripts If you need assistance creating scripts for your specific workflows, Blue Byte Systems offers professional scripting services. Their team of experts can design and implement custom .pdmshell scripts tailored to your requirements, ensuring optimal efficiency and accuracy. To learn more about this service, contact Blue Byte Systems directly through their support page."
   }
 }

docs/manifest.json

@@ -4,7 +4,7 @@
     "changefreq": "weekly",
     "priority": 1.0
   },
-  "source_base_path": "C:/Users/jlili/source/repos/BlueByteSystemsInc/PDMShell.Docs",
+  "source_base_path": "C:/Users/jlili/source/repos/BlueByteSystemsInc/PDMShell",
   "xrefmap": "xrefmap.yml",
   "files": [
     {
@@ -965,6 +965,16 @@
       },
       "version": ""
     },
+    {
+      "type": "Conceptual",
+      "source_relative_path": "src/EVAL.md",
+      "output": {
+        ".html": {
+          "relative_path": "src/EVAL.html"
+        }
+      },
+      "version": ""
+    },
     {
       "type": "Conceptual",
       "source_relative_path": "src/FROGLEAP.md",
@@ -1245,6 +1255,16 @@
       },
       "version": ""
     },
+    {
+      "type": "Conceptual",
+      "source_relative_path": "src/scripting.md",
+      "output": {
+        ".html": {
+          "relative_path": "src/scripting.html"
+        }
+      },
+      "version": ""
+    },
     {
       "type": "Toc",
       "source_relative_path": "src/toc.yml",