|
1 | 1 | XML.Template
|
2 | 2 | ------------
|
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
3 | 7 | ### Synopsis
|
4 | 8 | XML Template Transpiler.
|
5 | 9 |
|
| 10 | + |
| 11 | + |
6 | 12 | ---
|
| 13 | + |
| 14 | + |
7 | 15 | ### Description
|
8 | 16 |
|
9 | 17 | Allows PipeScript to generate XML.
|
10 | 18 |
|
11 | 19 | Multiline comments blocks like this ```<!--{}-->``` will be treated as blocks of PipeScript.
|
12 | 20 |
|
| 21 | + |
| 22 | + |
13 | 23 | ---
|
| 24 | + |
| 25 | + |
14 | 26 | ### Parameters
|
15 | 27 | #### **CommandInfo**
|
16 | 28 |
|
17 | 29 | The command information. This will include the path to the file.
|
18 | 30 |
|
19 | 31 |
|
20 | 32 |
|
21 |
| -> **Type**: ```[CommandInfo]``` |
22 | 33 |
|
23 |
| -> **Required**: true |
24 | 34 |
|
25 |
| -> **Position**: named |
26 | 35 |
|
27 |
| -> **PipelineInput**:true (ByValue) |
| 36 | +|Type |Required|Position|PipelineInput | |
| 37 | +|---------------|--------|--------|--------------| |
| 38 | +|`[CommandInfo]`|true |named |true (ByValue)| |
28 | 39 |
|
29 | 40 |
|
30 | 41 |
|
31 |
| ---- |
32 | 42 | #### **AsTemplateObject**
|
33 | 43 |
|
34 | 44 | If set, will return the information required to dynamically apply this template to any text.
|
35 | 45 |
|
36 | 46 |
|
37 | 47 |
|
38 |
| -> **Type**: ```[Switch]``` |
39 | 48 |
|
40 |
| -> **Required**: true |
41 | 49 |
|
42 |
| -> **Position**: named |
43 | 50 |
|
44 |
| -> **PipelineInput**:false |
| 51 | +|Type |Required|Position|PipelineInput| |
| 52 | +|----------|--------|--------|-------------| |
| 53 | +|`[Switch]`|true |named |false | |
45 | 54 |
|
46 | 55 |
|
47 | 56 |
|
48 |
| ---- |
49 | 57 | #### **Parameter**
|
50 | 58 |
|
51 | 59 | A dictionary of parameters.
|
52 | 60 |
|
53 | 61 |
|
54 | 62 |
|
55 |
| -> **Type**: ```[IDictionary]``` |
56 | 63 |
|
57 |
| -> **Required**: false |
58 | 64 |
|
59 |
| -> **Position**: named |
60 | 65 |
|
61 |
| -> **PipelineInput**:false |
| 66 | +|Type |Required|Position|PipelineInput| |
| 67 | +|---------------|--------|--------|-------------| |
| 68 | +|`[IDictionary]`|false |named |false | |
62 | 69 |
|
63 | 70 |
|
64 | 71 |
|
65 |
| ---- |
66 | 72 | #### **ArgumentList**
|
67 | 73 |
|
68 | 74 | A list of arguments.
|
69 | 75 |
|
70 | 76 |
|
71 | 77 |
|
72 |
| -> **Type**: ```[PSObject[]]``` |
73 | 78 |
|
74 |
| -> **Required**: false |
75 | 79 |
|
76 |
| -> **Position**: named |
77 | 80 |
|
78 |
| -> **PipelineInput**:false |
| 81 | +|Type |Required|Position|PipelineInput| |
| 82 | +|--------------|--------|--------|-------------| |
| 83 | +|`[PSObject[]]`|false |named |false | |
| 84 | + |
| 85 | + |
79 | 86 |
|
80 | 87 |
|
81 | 88 |
|
82 | 89 | ---
|
| 90 | + |
| 91 | + |
83 | 92 | ### Syntax
|
84 | 93 | ```PowerShell
|
85 | 94 | XML.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
|
86 | 95 | ```
|
87 | 96 | ```PowerShell
|
88 | 97 | XML.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
|
89 | 98 | ```
|
90 |
| ---- |
91 | 99 |
|
0 commit comments