add docs

Author: AmenJlili

docs/index.json

@@ -74,6 +74,11 @@
     "title": "Dynamic Placeholders | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "Dynamic Placeholders in PDMShell Overview The Dynamic Placeholders feature in PDMShell allows you to substitute values dynamically using placeholders. This functionality is supported by several commands and enables the use of file or folder properties, system variables, and other contextual information to generate new values automatically. Dynamic Placeholders are not a standalone command but a feature used by specific commands to process the value parameter or other relevant inputs. Commands Supporting Dynamic Placeholders The following commands support the use of dynamic placeholders: Commands Using the Current Folder as the Backing Object (directory parameter): cd: Change the current directory. mkdir: Create a new directory. export: 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. renamefromsource: The new file is evaluated if the evaluatealiases parameter is specified. setvar: Uses the value parameter to set variables for files or folders. Placeholders for Dynamic Substitution 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. $extension: The file extension. $id: The file ID. $revision: The current revision of the file (PDM revision, not the PDM variable). $version: The current version of the file. $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. Common Placeholders (Applicable to Both Files and Folders) $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. $guid: Unique identifier. Using Variables in Dynamic Placeholders 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. Example Usage Here’s an example of how to use dynamic placeholders in a command: Renaming a File rename -filePath 1.sldprt -value \"$nameWithoutExtension_$yyyy$mm$dd$extension\""
   },
+  "src/FREEVSPREMIUM.html": {
+    "href": "src/FREEVSPREMIUM.html",
+    "title": "PDMShell Free vs Premium | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
+    "summary": "PDMShell Free vs Premium PDMShell comes in two editions: Free for light use and Premium for full automation in SOLIDWORKS PDM. OVERVIEW Edition Description Free Ideal for testing and small jobs. Processes up to 5 items per command. Premium Full access with unlimited processing, workflow automation, and scripting. FEATURE COMPARISON Feature Free Premium Max items per command 5 Unlimited All search commands ✅ ✅ printfromsource, getvar ✅ (5-limit) ✅ Unlimited Workflow & transitions ❌ ✅ Automation scripting ❌ ✅ Alias & renaming ✅ ✅ Priority support ❌ Full Commercial use ✅ (non-resellers) ✅ Reseller use ❌ ✅ Cost Free Paid FREE EDITION Perfect for evaluation, quick lookups, and validation tasks. Limit: 5 items per command. Note: Resellers and VARs may not use the Free version commercially. Example: printfromsource -filePath \"source.csv\" -csv \"output.csv\" BUY PREMIUM To buy a Premium PDMShell license, visit: http://bluebyte.biz/product/pdmshell"
+  },
   "src/FROGLEAP.html": {
     "href": "src/FROGLEAP.html",
     "title": "FROGLEAP Command Documentation | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
@@ -139,6 +144,11 @@
     "title": "PRINT Command Documentation | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "PRINT Command Documentation DESCRIPTION: Displays the biographical information about the specified file. SYNTAX: print [-filePath|-id] PARAMETERS: -filePath: The file to print biographical information for. EXAMPLES: print -filePath \"C:\\SOLIDWORKSPDM\\Bluebyte\\API\\Sandbox\\fidget spinner\\___108545.SLDPRT\" The print command will print an output like the following: File Name : ___108545.SLDPRT Local Path : C:\\SOLIDWORKSPDM\\Bluebyte\\API\\Sandbox\\fidget spinner\\___108545.SLDPRT Folder Path : \\API\\Sandbox\\fidget spinner File ID : 115310 Folder ID : 457 HEXID : 1C26E Archive Path : E\\0001C26E Checked out? : False State ID : 158 State Name : New State Current state : New State [Workflow: Vaulted] Current Ver : 7 Current Rev : Transitions : Return Engineering [193] From New State [158] To In Design [9]"
   },
+  "src/PRINTFROMSOURCE.html": {
+    "href": "src/PRINTFROMSOURCE.html",
+    "title": "PRINTFROMSOURCE Command Documentation | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
+    "summary": "PRINTFROMSOURCE Command Documentation DESCRIPTION: The printfromsource command is used to validate a list of filepaths in the PDM system based on a source CSV file. The CSV file must contain a header and a list of complete file paths in the first column. SYNTAX: printfromsource -filePath -csv PARAMETERS: filePath: (Required) The source file path. This must be a CSV file with one column: file Path: Complete file path. csv: Specifies the output csv. This will contains information about files from the source parameter. EXAMPLES: Rename files using a source CSV file: printfromsource -filePath \"source.csv\" -csv \"output.csv\" REMARKS: The filePath parameter is mandatory and must point to a valid CSV file. The csv is the output from the verification process printfromsource performs: ID Complete File Path Folder ID Checked Out Where Used ID 1 C:\\Vault\\ProjectA\\Part1.SLDPRT 105 FALSE 5021 2 C:\\Vault\\ProjectB\\Drawing1.SLDDRW 106 TRUE 5022 3 C:\\Vault\\ProjectC\\Assembly1.SLDASM 107 FALSE 5023"
+  },
   "src/QUIT.html": {
     "href": "src/QUIT.html",
     "title": "QUIT Command Documentation | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
@@ -232,7 +242,7 @@
   "src/faq.html": {
     "href": "src/faq.html",
     "title": "FAQ | PDMShell | SOLIDWORKS PDM | Powershell like features for SOLIDWORKS PDM Professional",
-    "summary": "Frequently Asked Questions (FAQ) for PDMShell 1. Why are some commands marked as \"N/A\" or have no description after installing a new version? This issue can occur if the new version of PDMShell is installed over an existing version without properly uninstalling the old one. Solution: Uninstall the current version of PDMShell manually from your system. Download the latest version of PDMShell from our official website. Reinstall the downloaded version. This ensures that all commands and descriptions are updated correctly. 2. How do I install or update PDMShell? You can install or update PDMShell either from our official website or via the Microsoft Store. For detailed instructions, refer to the Installation Guide. 3. Do I need administrative privileges to install PDMShell? Yes, you may need administrative privileges to install or update PDMShell, especially if you are installing it from the official website. 4. Can I use PDMShell without a premium license? Yes, PDMShell offers a Free License that includes basic functionality. However, advanced features, such as workflow integration, require a Premium License. 5. How do I report a bug or request support? You can report bugs or request support by visiting our Support Page or emailing us at support@bluebyte.biz. 6. What are the system requirements for PDMShell? PDMShell requires: Operating System: Windows 10/11 SOLIDWORKS PDM Professional: Version 2014 or newer SOLIDWORKS 3D: Version 2017 or newer (for commands that use SOLIDWORKS) For additional questions, feel free to contact us at support@bluebyte.biz."
+    "summary": "Frequently Asked Questions (FAQ) for PDMShell 1. What is PDMShell? PDMShell is a command-line environment for SOLIDWORKS PDM Professional that allows users to automate, query, and batch process vault data using simple shell commands. It is designed for administrators, developers, and power users who want to extend PDM capabilities beyond the standard client. 2. What is the difference between the Free and Premium versions? Feature Free License Premium License Max items processed per command 5 items Unlimited Access to all search commands ✅ Included ✅ Included Workflow and transition integration ❌ Not available ✅ Available Technical support & updates ❌ Not available Priority Commercial use ❌ Not available ✅ Allowed The Free License is ideal for evaluation and lightweight tasks. The Premium License unlocks full automation, workflow integration, and unlimited command processing. 3. How do I install or update PDMShell? You can install or update PDMShell from: The official website, or The Microsoft Store For detailed setup steps, see the Installation Guide. If you are updating from a previous version, uninstall the old one first to ensure all command definitions and descriptions are refreshed properly. 4. Why are some commands marked as “N/A” or missing descriptions after an update? This usually happens when PDMShell is updated over an existing installation without removing old files. Solution: Uninstall the current version of PDMShell. Download the latest version from the official website. Reinstall it cleanly to refresh command data and documentation. 5. Do I need administrative privileges to install PDMShell? Yes. Administrative privileges are required when installing PDMShell from the website installer (MSI). If you install via the Microsoft Store, Windows handles elevation automatically. 6. What are the system requirements for PDMShell? Operating System: Windows 10 or 11 SOLIDWORKS PDM Professional: 2014 or newer SOLIDWORKS 3D: 2017 or newer (for commands that interact with SOLIDWORKS) 7. How do I report a bug or request support? You can reach us via: Email: support@bluebyte.biz Web Form: bluebyte.biz/contact Please include your PDMShell version, command name, and error message when reporting issues. 8. Which commands are available in the Free version? All search-related commands and basic file utilities are free to use (limited to processing 5 items per run). These commands are ideal for quick lookups, validation, and testing automation workflows before upgrading to Premium. For additional questions, contact us anytime at support@bluebyte.biz."
   },
   "src/howtoinstall.html": {
     "href": "src/howtoinstall.html",

docs/manifest.json

@@ -975,6 +975,16 @@
       },
       "version": ""
     },
+    {
+      "type": "Conceptual",
+      "source_relative_path": "src/FREEVSPREMIUM.md",
+      "output": {
+        ".html": {
+          "relative_path": "src/FREEVSPREMIUM.html"
+        }
+      },
+      "version": ""
+    },
     {
       "type": "Conceptual",
       "source_relative_path": "src/FROGLEAP.md",
@@ -1105,6 +1115,16 @@
       },
       "version": ""
     },
+    {
+      "type": "Conceptual",
+      "source_relative_path": "src/PRINTFROMSOURCE.md",
+      "output": {
+        ".html": {
+          "relative_path": "src/PRINTFROMSOURCE.html"
+        }
+      },
+      "version": ""
+    },
     {
       "type": "Conceptual",
       "source_relative_path": "src/QUIT.md",