Updating PipeScript.HelpOut.ps1 (including topics, re #132)

Author: StartAutomating

docs/README.ps1.md

@@ -1,27 +1,32 @@
-This directory and it's subdirectories contain syntax changes that enable common programming scenarios in PowerShell and PipeScript.
+This directory and it's subdirectories contain Transpilers that transform parameter attributes.
+
+Parameter Transpilers do not need to take any values from the pipeline.
+They will be called by the Core PipeScript Transpiler ```PipeScript.ParameterAttribute```.
+
+When Transpiling a Parameter, the Transpiler should return one of two things.
+
+1. An empty ```[ScriptBlock]``` preceeded by attributes or help.  This will replace the Transpiled attribute with a real one.
+2. A ```[Collections.IDictionary]``` can be used to send arguments directly back to ```Update-PipeScript```.
+
+Many parameter transpilers can also apply to a ```[Management.Automation.Language.VariableExpressionAst]```.  
+
+When this is the case it is common for the transpiler to add a ```[ValidateScript]``` attribute to the variable.  This will constraint the value of that variable.
+
+## List Of Parameter Transpilers
 
 ~~~PipeScript{
     [PSCustomObject]@{
         Table = Get-Transpiler -TranspilerPath $pwd |
-            Select-Object DisplayName, Synopsis, @{
+            Select-Object DisplayName, @{
+                Name='Synopsis'
+                Expression= { $_.Synopsis -replace '[\s\r\n]+$' }
+            }, @{
                 Name='Link'
                 Expression = { $_.Name }
             }
-    }}
+    }
+}
 ~~~
 
 
-~~~PipeScript{
-    @(foreach ($transpiler in Get-Transpiler -TranspilerPath $pwd) {
-        $examples = @($transpiler.Examples)
-        if (-not $examples) { continue }
-        for ($exampleNumber = 1; $exampleNumber -le $examples.Length; $exampleNumber++) {
-            @("## $($transpiler.DisplayName) Example $($exampleNumber)", 
-                [Environment]::Newline,
-                "~~~PowerShell",                
-                $examples[$exampleNumber - 1],                
-                "~~~") -join [Environment]::Newline
-        }        
-    }) -join ([Environment]::Newline * 2)
-}
-~~~
+