Documentation catch up / minor revisions.

BuvinJT · Jan 5, 2021 · 6375644 · 6375644
1 parent 3749157
commit 6375644
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 44 deletions.
diff --git a/docs/ConfigClasses.md b/docs/ConfigClasses.md
@@ -798,6 +798,14 @@ Event constants for convenience methods.
 On Windows, set `isAutoBitContext=False` if you need to execute a 64 bit
 program from the installer's 32 bit context.
 
+####  QtIfwExternalOp.CreateTempDataFile
+
+    CreateTempDataFile( event, fileName, isElevated=True )
+
+#### QtIfwExternalOp.WriteTempDataFile
+
+    WriteTempDataFile( event, fileName, data, isElevated=True )
+
 #### QtIfwExternalOp.RemoveFile
 
     RemoveFile( event, filePath, isElevated=True )
@@ -815,7 +823,7 @@ program from the installer's 32 bit context.
 
 #### QtIfwExternalOp.UninstallWindowsApp
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     UninstallWindowsApp( appName, arguments=None,
                          isSynchronous=True, isHidden=True, 
@@ -824,7 +832,7 @@ program from the installer's 32 bit context.
 
 #### QtIfwExternalOp.CreateRegistryKey
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     CreateRegistryKey( event, key, isAutoBitContext=True )
 
@@ -834,7 +842,7 @@ use of SysWow64 nodes.
 
 #### QtIfwExternalOp.RemoveRegistryKey
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     RemoveRegistryKey( event, key, isAutoBitContext=True )        
 
@@ -844,7 +852,7 @@ use of SysWow64 nodes.
 
 #### QtIfwExternalOp.CreateRegistryEntry
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     CreateRegistryEntry( event, 
     	key, valueName=None, value="", valueType="String",
@@ -856,7 +864,7 @@ use of SysWow64 nodes.
 
 #### QtIfwExternalOp.RemoveRegistryEntry
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     RemoveRegistryEntry( event, 
     	key, valueName=None, isAutoBitContext=True )        
@@ -865,6 +873,30 @@ Set `isAutoBitContext=False` if you need to access 64 bit entries
 from the installer's 32 bit context, and/or wish to be explicit in the
 use of SysWow64 nodes.
 
+#### QtIfwExternalOp.CreateExeFromScript
+
+**WINDOWS ONLY**
+
+    CreateExeFromScript( script, brandingInfo, srcIconPath,
+                         targetDir=QT_IFW_TARGET_DIR )
+
+**script**: [ExecutableScripts](LowLevel.md#executablescript)
+
+#### QtIfwExternalOp.WrapperScript2Exe
+
+**WINDOWS ONLY**
+
+    Script2Exe( scriptPath, exePath, brandingInfo,
+                iconDirPath, iconName, 
+                isScriptRemoved=False, isIconDirRemoved=False )
+                        
+#### QtIfwExternalOp.WrapperScript2Exe
+
+**WINDOWS ONLY**
+
+    WrapperScript2Exe( scriptPath, exePath, 
+                       targetPath, brandingInfo, iconName="0.ico" )
+
 ### QtIfwExternalOp Convenience Scripts
 
 #### QtIfwExternalOp.RunProgramScript
@@ -873,84 +905,97 @@ use of SysWow64 nodes.
     				  isHidden=False, isSynchronous=True,
     				  isAutoBitContext=True, 
     				  replacements=None )
+
+**Windows Type**: Batch or PowerShell (determined by options employed)
+**Mac/Linux Type**: ShellScript 
 
 On Windows, set `isAutoBitContext=False` if you need to execute a 64 bit
 program from the installer's 32 bit context.
 
 Note: Elevation is controlled via the operation executing the script 
 rather embedded within it.
 
-#### QtIfwExternalOp.RemoveFileScript( filePath )
+#### QtIfwExternalOp.WriteTempDataFileScript
+
+    WriteTempDataFileScript( fileName, data=None )
+
+**Windows Type**: Batch 
+**Mac/Linux Type**: ShellScript 
+
+#### QtIfwExternalOp.RemoveFileScript
 
 	RemoveFileScript( filePath )
+
+**Windows Type**: Batch 
+**Mac/Linux Type**: ShellScript 
 
-#### QtIfwExternalOp.RemoveDirScript( dirPath )
+#### QtIfwExternalOp.RemoveDirScript
 
 	RemoveDirScript( dirPath )
 
+**Windows Type**: Batch 
+**Mac/Linux Type**: ShellScript 
+
 #### QtIfwExternalOp.UninstallWindowsAppScript
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     UninstallWindowsAppScript( appName, arguments=None,
                                isSynchronous=True, isHidden=True, 
                                isAutoBitContext=True )
+
+**Type**: PowerShell 
 
-### QtIfwExternalOp.CreateRegistryKeyScript
+#### QtIfwExternalOp.CreateRegistryKeyScript
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     CreateRegistryKeyScript( key, isAutoBitContext=True, 
                              replacements=None )
+
+**Type**: PowerShell 
 
-### QtIfwExternalOp.RemoveRegistryKeyScript
+#### QtIfwExternalOp.RemoveRegistryKeyScript
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     RemoveRegistryKeyScript( key, isAutoBitContext=True, 
                              replacements=None ) 
 
-### QtIfwExternalOp.CreateRegistryEntryScript
+**Type**: PowerShell 
+
+#### QtIfwExternalOp.CreateRegistryEntryScript
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     CreateRegistryEntryScript( key, valueName=None, 
                                value="", valueType="String",
                                isAutoBitContext=True,
                                replacements=None )
+
+**Type**: PowerShell 
 
-### QtIfwExternalOp.RemoveRegistryEntryScript
+#### QtIfwExternalOp.RemoveRegistryEntryScript
 
-	**WINDOWS ONLY**
+**WINDOWS ONLY**
 
     RemoveRegistryEntryScript( key, valueName=None, 
                                isAutoBitContext=True, 
                                replacements=None ) 
-                                                                                        
-#### QtIfwExternalOp.CreateExeFromScript
-
-	**WINDOWS ONLY**
 
-    CreateExeFromScript( script, brandingInfo, srcIconPath,
-                         targetDir=QT_IFW_TARGET_DIR )
-
-**script**: [ExecutableScripts](LowLevel.md#executablescript)
-
-#### QtIfwExternalOp.WrapperScript2Exe
-
-	**WINDOWS ONLY**
-
-    Script2Exe( scriptPath, exePath, brandingInfo,
-                iconDirPath, iconName, 
-                isScriptRemoved=False, isIconDirRemoved=False )
-                        
-#### QtIfwExternalOp.WrapperScript2Exe
-
-	**WINDOWS ONLY**
+**Type**: PowerShell 
+
+#### QtIfwExternalOp.UninstallWindowsAppScript
+                  
+**WINDOWS ONLY**
+
+    UninstallWindowsAppScript( appName, arguments=None,
+                               isSynchronous=True,
+                               isHidden=True,
+                               isAutoBitContext=True )            
+
+**Type**: PowerShell 
 
-    WrapperScript2Exe( scriptPath, exePath, 
-                       targetPath, brandingInfo, iconName="0.ico" )
-                                                           
 ## QtIfwKillOp
 
 This class is used to drive process killing operations. Such actions are frequently 

diff --git a/docs/LowLevel.md b/docs/LowLevel.md
@@ -1457,12 +1457,24 @@ a distribution.
 
 ### qtIfwDynamicValue
 
-Use this produce the resolution of dynamic substitution variables 
-utilized by QtIFW scripts (directly or indirectly) on a target machine.
-These are often paths to files or directories on the target, or embedded 
-resources in the installer, but may in fact be used for strings containing
-any content, which the installer knows how to resolve.  
+    qtIfwDynamicValue( name )
 
+Use this function produce the resolution of dynamic substitution variables 
+at runtime, which are utilized by QtIFW scripts (directly or indirectly) 
+on a target machine.
+
+These values are often paths to files or directories on the target, or 
+embedded resources in the installer, but may in fact be used for strings 
+containing *any* content, which the installer knows how to resolve.  
+
+### qtIfwTempDataFilePath
+
+	qtIfwTempDataFilePath( rootFileName )
+
+Use this function produce the resolution of dynamic temp paths  
+at runtime, which are utilized by QtIFW scripts (directly or indirectly) 
+on a target machine.
+
 ### isParentDir 
 
     isParentDir( parent, child, basePath=None ):