added docs

Author: AmenJlili

docs/index.json

@@ -11,22 +11,22 @@
   },
   "src/ADDTOVAULT.html": {
     "href": "src/ADDTOVAULT.html",
-    "title": "ADDTOVAULT Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
+    "title": "ADDTOVAULT Command Documentation | PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "ADDTOVAULT Command Documentation DESCRIPTION: The addtovault command is used to add files or directories to the PDM vault. It supports various parameters to specify the source files or directories, search queries, and additional options such as ignoring existing files, updating references, and recursive operations. SYNTAX: addtovault -csv -dir -search -source -ignoreex -updaterefs -recursive PARAMETERS: csv: (Optional) Specifies the path to a CSV file containing a list of files or directories to be added to the vault. dir: (Required) Specifies the target directory. If not specified current directory is used. If using the current directory, use \"\". search: (Optional) A search query to filter files or directories to be added to the vault. This is File Explorer search query. Use * as a wildcard. source: (Required) Specifies the source file or directory to be added to the vault. ignoreex: (Optional) Ignores files that already exist in the vault. This prevents overwriting existing files. updaterefs: (Optional) Updates references for the files being added to the vault. recursive: (Optional) Adds all files and subdirectories within the specified directory. This parameter is only applicable when adding directories. EXAMPLES: addtovault -source \"C:\\Projects\\file.txt\" -directory \"\" # adds text file to the current directory REMARKS: Use the recursive parameter with caution, as it will add all contents within the specified directory. The ignoreex parameter prevents overwriting files that already exist in the vault. Ensure you have the necessary permissions to add files or directories to the PDM vault. Files are left checked out after command completes. Note Use checkin -search % -recursive to check in all added files after calling addtovault. TUTORIAL:"
   },
   "src/CD.html": {
     "href": "src/CD.html",
-    "title": "CD Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
+    "title": "CD Command Documentation | PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "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 its newFolder REMARKS: Please be aware of the following special ways to change directory: cd.. # Navigates to the parent folder cd\\ # Navigates to the root of the vault If the user just created a new folder and wants to cd to it using autocomplete, they need to use the dir command with the -refresh parameter to force the session to load the current files and sub-folders in the active directory. Using -refresh might affect the performance of the session if the current folder has too many files and sub-folders. directory is the default parameter. You do not need to specify it if it is the only parameter in your command. Example: cd api #navigates to the api folder cd -id 755 #navigates to the folder with id 755 TUTORIAL:"
   },
   "src/CHECKIN.html": {
     "href": "src/CHECKIN.html",
-    "title": "CHECKIN Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
+    "title": "CHECKIN Command Documentation | PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "CHECKIN Command Documentation DESCRIPTION: Performs a check-in operation on a specified file or many files. SYNTAX: checkin -search -filePath -comment -Checkinoptions PARAMETERS: search: The search operation to use. filePath: The file(s) to be checked in. This is the default parameter. comment: The comment to add to the check-in. Checkinoptions: The check-in options to use. EXAMPLES: checkin -filePath \"file1.sldprt\" REMARKS: The search parameter searches the current directory and does not drill down. The search query is a PDM one, so you can use % for wildcard. If combining Checkinoptions parameters, the user needs to add + between the values. Checkinoptions Parameter Values: Member Description EdmUnlock_FailOnRegenerationNeed Fail if the file needs to be regenerated in the CAD program. NOTE: Only files resaved in SOLIDWORKS 2009 or later can trigger this flag EdmUnlock_ForceUnlock Unlock the file even if it is not modified EdmUnlock_IgnoreCorruptFile Ignore files with file formats unrecognized by SOLIDWORKS PDM Professional; without this flag, SOLIDWORKS PDM Professional returns E_EDM_INVALID_FILE if it encounters a corrupt file or a file containing a newer format than SOLIDWORKS PDM Professional can handle EdmUnlock_IgnoreReferences Silently unlock parent files without their references EdmUnlock_IgnoreRefsNotLockedByCaller Ignore references not locked by caller EdmUnlock_IgnoreRefsOutsideVault Ignore references to files outside the vault EdmUnlock_KeepLocked Keep the file checked out after creating the new version in the archive EdmUnlock_OverwriteLatestVersion Do not create a new version; overwrite the last version of the file with new changes EdmUnlock_RemoveLocalCopy Remove the local copy of the file from the hard disk after the file has been checked in EdmUnlock_Simple Check in the file using default behavior"
   },
   "src/CHECKOUT.html": {
     "href": "src/CHECKOUT.html",
-    "title": "CHECKOUT Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
+    "title": "CHECKOUT Command Documentation | PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "CHECKOUT Command Documentation DESCRIPTION: Performs a check out operation on a specified file or many files. SYNTAX: checkout -search -recursive -filePath PARAMETERS: -search: Search keyword -filePath: The file(s) to be checked out. This is the default parameter -recursive: Recursively check out all files in the current directory. Use in combination with search EXAMPLES: checkout -filePath file1.sldprt REMARKS: The search parameter searches the current directory and does not drill down. The search query is a PDM one, so you can use % for wildcard. TUTORIAL:"
   },
   "src/CLEARCACHE.html": {
@@ -56,7 +56,7 @@
   },
   "src/DESTORY.html": {
     "href": "src/DESTORY.html",
-    "title": "DESTROY Command Documentation | Powershell like features for SOLIDWORKS PDM Professional",
+    "title": "Destroy Command Documentation | PDMShell | Powershell like features for SOLIDWORKS PDM Professional",
     "summary": "DESTROY Command Documentation DESCRIPTION: The destroy command is used to permanently delete files that have been marked as deleted in a specified directory. This command supports recursive deletion and filtering by date. SYNTAX: destroy -directory -recursive -date PARAMETERS: directory: The directory to destroy. recursive: Enables recursive search (for files). date: (Optional) Specifies a date filter. Only files deleted on or before the specified date will be destroyed. The date format should be YYYY-MM-DD. EXAMPLES: destroy -directory \"C:\\Projects\\Project\" # destroys all deleted files in project folder REMARKS: The directory parameter is mandatory and must specify a valid directory. Use the recursive parameter with caution, as it will process all subdirectories within the specified directory. The date parameter allows you to target files deleted on or before the specified date, providing more control over the destruction process. This action is irreversible. Ensure you have the necessary permissions and have reviewed the files before executing the command. TUTORIAL:"
   },
   "src/DIR.html": {