Skip to content

Commit 7b8f8c1

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding SVG Template Transpiler (Fixes #411)
1 parent a9d39f0 commit 7b8f8c1

1 file changed

Lines changed: 115 additions & 0 deletions

File tree

docs/SVG.template.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
SVG.template
2+
------------
3+
4+
5+
6+
7+
### Synopsis
8+
SVG Template Transpiler.
9+
10+
11+
12+
---
13+
14+
15+
### Description
16+
17+
Allows PipeScript to generate SVG.
18+
19+
Multiline comments blocks like this ```<!--{}-->``` will be treated as blocks of PipeScript.
20+
21+
22+
23+
---
24+
25+
26+
### Examples
27+
#### EXAMPLE 1
28+
```PowerShell
29+
$starsTemplate = Invoke-PipeScript {
30+
Stars.svg template '
31+
<!--{
32+
Invoke-RestMethod https://pssvg.start-automating.com/Examples/Stars.svg
33+
}-->
34+
'
35+
}
36+
```
37+
$starsTemplate.SaveTemplate("$pwd\Stars.svg")
38+
39+
40+
---
41+
42+
43+
### Parameters
44+
#### **CommandInfo**
45+
46+
The command information. This will include the path to the file.
47+
48+
49+
50+
51+
52+
53+
|Type |Required|Position|PipelineInput |
54+
|---------------|--------|--------|--------------|
55+
|`[CommandInfo]`|true |named |true (ByValue)|
56+
57+
58+
59+
#### **AsTemplateObject**
60+
61+
If set, will return the information required to dynamically apply this template to any text.
62+
63+
64+
65+
66+
67+
68+
|Type |Required|Position|PipelineInput|
69+
|----------|--------|--------|-------------|
70+
|`[Switch]`|true |named |false |
71+
72+
73+
74+
#### **Parameter**
75+
76+
A dictionary of parameters.
77+
78+
79+
80+
81+
82+
83+
|Type |Required|Position|PipelineInput|
84+
|---------------|--------|--------|-------------|
85+
|`[IDictionary]`|false |named |false |
86+
87+
88+
89+
#### **ArgumentList**
90+
91+
A list of arguments.
92+
93+
94+
95+
96+
97+
98+
|Type |Required|Position|PipelineInput|
99+
|--------------|--------|--------|-------------|
100+
|`[PSObject[]]`|false |named |false |
101+
102+
103+
104+
105+
106+
---
107+
108+
109+
### Syntax
110+
```PowerShell
111+
SVG.template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
112+
```
113+
```PowerShell
114+
SVG.template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
115+
```

0 commit comments

Comments
 (0)