Updating PipeScript.HelpOut.ps1 (#56)

Author: StartAutomating

docs/PipeScript.Inline.md

@@ -0,0 +1,150 @@
+
+PipeScript.Inline
+-----------------
+### Synopsis
+Inline Transpiler
+
+---
+### Description
+
+The PipeScript Core Inline Transpiler.  This makes Source Generators with inline PipeScript work.
+
+Regardless of underlying source language, a source generator works in a fairly straightforward way.
+
+Inline PipeScript will be embedded within the file (usually in comments).
+
+If a Regular Expression can match each section, then the content in each section can be replaced.
+
+---
+### Parameters
+#### **SourceSection**
+
+A list of source sections
+
+
+
+|Type              |Requried|Postion|PipelineInput |
+|------------------|--------|-------|--------------|
+|```[PSObject[]]```|true    |1      |true (ByValue)|
+---
+#### **SourceText**
+
+A string containing the text contents of the file
+
+
+
+|Type          |Requried|Postion|PipelineInput|
+|--------------|--------|-------|-------------|
+|```[String]```|true    |named  |false        |
+---
+#### **SourcePattern**
+
+A string containing the pattern used to recognize special sections of source code.
+
+
+
+|Type         |Requried|Postion|PipelineInput|
+|-------------|--------|-------|-------------|
+|```[Regex]```|true    |named  |false        |
+---
+#### **ReplacePattern**
+
+|Type         |Requried|Postion|PipelineInput|
+|-------------|--------|-------|-------------|
+|```[Regex]```|true    |named  |false        |
+---
+#### **StartPattern**
+
+The Start Pattern.
+This indicates the beginning of what should be considered PipeScript.
+An expression will match everything until -EndPattern
+
+
+
+|Type         |Requried|Postion|PipelineInput|
+|-------------|--------|-------|-------------|
+|```[Regex]```|true    |named  |false        |
+---
+#### **EndPattern**
+
+The End Pattern
+This indicates the end of what should be considered PipeScript.
+
+
+
+|Type         |Requried|Postion|PipelineInput|
+|-------------|--------|-------|-------------|
+|```[Regex]```|true    |named  |false        |
+---
+#### **ReplacementEvaluator**
+
+|Type               |Requried|Postion|PipelineInput|
+|-------------------|--------|-------|-------------|
+|```[ScriptBlock]```|false   |named  |false        |
+---
+#### **NoTranspile**
+
+If set, will not transpile script blocks.
+
+
+
+|Type          |Requried|Postion|PipelineInput|
+|--------------|--------|-------|-------------|
+|```[Switch]```|false   |named  |false        |
+---
+#### **SourceFile**
+
+The path to the source file.
+
+
+
+|Type          |Requried|Postion|PipelineInput|
+|--------------|--------|-------|-------------|
+|```[String]```|false   |named  |false        |
+---
+#### **Begin**
+
+A Script Block that will be injected before each inline is run.
+
+
+
+|Type               |Requried|Postion|PipelineInput|
+|-------------------|--------|-------|-------------|
+|```[ScriptBlock]```|false   |named  |false        |
+---
+#### **ForeachObject**
+
+A Script Block that will be piped to after each output.
+
+
+
+|Type               |Requried|Postion|PipelineInput|
+|-------------------|--------|-------|-------------|
+|```[ScriptBlock]```|false   |named  |false        |
+---
+#### **End**
+
+A Script Block that will be injected after each inline script is run.
+
+
+
+|Type               |Requried|Postion|PipelineInput|
+|-------------------|--------|-------|-------------|
+|```[ScriptBlock]```|false   |named  |false        |
+---
+### Syntax
+```PowerShell
+PipeScript.Inline [-SourceSection] <PSObject[]> [-NoTranspile] [-SourceFile <String>] [-Begin <ScriptBlock>] [-ForeachObject <ScriptBlock>] [-End <ScriptBlock>] [<CommonParameters>]
+```
+```PowerShell
+PipeScript.Inline -SourceText <String> -StartPattern <Regex> -EndPattern <Regex> [-ReplacementEvaluator <ScriptBlock>] [-NoTranspile] [-SourceFile <String>] [-Begin <ScriptBlock>] [-ForeachObject <ScriptBlock>] [-End <ScriptBlock>] [<CommonParameters>]
+```
+```PowerShell
+PipeScript.Inline -SourceText <String> -ReplacePattern <Regex> [-ReplacementEvaluator <ScriptBlock>] [-NoTranspile] [-SourceFile <String>] [-Begin <ScriptBlock>] [-ForeachObject <ScriptBlock>] [-End <ScriptBlock>] [<CommonParameters>]
+```
+```PowerShell
+PipeScript.Inline -SourceText <String> -SourcePattern <Regex> [-NoTranspile] [-SourceFile <String>] [-Begin <ScriptBlock>] [-ForeachObject <ScriptBlock>] [-End <ScriptBlock>] [<CommonParameters>]
+```
+---
+
+