-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathGet-LoremIpsum-help.xml
More file actions
300 lines (277 loc) · 30.1 KB
/
Get-LoremIpsum-help.xml
File metadata and controls
300 lines (277 loc) · 30.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<?xml version="1.0" encoding="utf-16"?>
<helpItems schema="maml" xmlns="http://msh" xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">
<!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19-->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
<command:details>
<command:name>Get-LoremIpsum</command:name>
<maml:description>
<maml:para>Gets a string of placeholder text ("lorem ipsum")</maml:para>
</maml:description>
<maml:copyright>
<maml:para/>
</maml:copyright>
<command:verb>Get</command:verb>
<command:noun>LoremIpsum</command:noun>
<dev:version/>
</command:details>
<maml:description>
<maml:para>The Get-LoremIpsum cmdlet gets placeholder or filler text ("lorem ipsum"), which is nonsense text that is commonly used to demonstrate the graphic elements of a document or visual presentation.
Get-LorumIpsum returns one string. You can include the string in files and pipe it to cmdlets that take string values and insert it in serialized files, such as XML and JSON files.
Get-LorumIpsum returns fixed values. To get random text strings, use the Get-Random cmdlet.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Get-LoremIpsum</maml:name>
<command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="">
<maml:name>Length</maml:name>
<maml:description>
<maml:para>Specifies the number of units of placeholder. The default is 1.
The Length parameter works with the Character, Paragraph, and Word parameters to determine the quantity of placeholder in the output. The default is one paragraph of lorem ipsum.</maml:para>
</maml:description>
<command:parameterValue required="true">Int32</command:parameterValue>
<dev:defaultValue>1</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Character</maml:name>
<maml:description>
<maml:para>Lets you specify the number of characters of placeholder text in the output. To specify the number of characters, use the Length parameter.
Otherwise, you can specify the number of words (-Word) or the number of paragraphs (-Paragraph). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Language</maml:name>
<maml:description>
<maml:para>Specifies the language style of the lorem ipsum nonsense text.
Valid values are Latin, Italian, Silly, and Spanish. The default is Latin.</maml:para>
</maml:description>
<command:parameterValue required="true">LoremIpsumLanguage</command:parameterValue>
<dev:defaultValue>Latin</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-LoremIpsum</maml:name>
<command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="">
<maml:name>Length</maml:name>
<maml:description>
<maml:para>Specifies the number of units of placeholder. The default is 1.
The Length parameter works with the Character, Paragraph, and Word parameters to determine the quantity of placeholder in the output. The default is one paragraph of lorem ipsum.</maml:para>
</maml:description>
<command:parameterValue required="true">Int32</command:parameterValue>
<dev:defaultValue>1</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Language</maml:name>
<maml:description>
<maml:para>Specifies the language style of the lorem ipsum nonsense text.
Valid values are Latin, Italian, Silly, and Spanish. The default is Latin.</maml:para>
</maml:description>
<command:parameterValue required="true">LoremIpsumLanguage</command:parameterValue>
<dev:defaultValue>Latin</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Word</maml:name>
<maml:description>
<maml:para>Lets you specify the number of words of placeholder text in the output. To specify the number of words, use the Length parameter.
Otherwise, you can specify the number of characters (-Character) or the number of paragraphs (-Paragraph). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.
</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Get-LoremIpsum</maml:name>
<command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="">
<maml:name>Length</maml:name>
<maml:description>
<maml:para>Specifies the number of units of placeholder. The default is 1.
The Length parameter works with the Character, Paragraph, and Word parameters to determine the quantity of placeholder in the output. The default is one paragraph of lorem ipsum.</maml:para>
</maml:description>
<command:parameterValue required="true">Int32</command:parameterValue>
<dev:defaultValue>1</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Language</maml:name>
<maml:description>
<maml:para>Specifies the language style of the lorem ipsum nonsense text.
Valid values are Latin, Italian, Silly, and Spanish. The default is Latin.</maml:para>
</maml:description>
<command:parameterValue required="true">LoremIpsumLanguage</command:parameterValue>
<dev:defaultValue>Latin</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Paragraph</maml:name>
<maml:description>
<maml:para>Lets you specify the number of paragraphs of placeholder text in the output. To specify the number of paragraphs, use the Length parameter. Because Paragraph is the default unit, this parameter is not required.
Otherwise, you can specify the number of characters (-Character) or the number of words (-Word). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:defaultValue>True</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" globbing="false" pipelineInput="false" position="1" aliases="">
<maml:name>Length</maml:name>
<maml:description>
<maml:para>Specifies the number of units of placeholder. The default is 1.
The Length parameter works with the Character, Paragraph, and Word parameters to determine the quantity of placeholder in the output. The default is one paragraph of lorem ipsum.</maml:para>
</maml:description>
<command:parameterValue required="false">Int32</command:parameterValue>
<dev:type>
<maml:name>Int32</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>1</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Character</maml:name>
<maml:description>
<maml:para>Lets you specify the number of characters of placeholder text in the output. To specify the number of characters, use the Length parameter.
Otherwise, you can specify the number of words (-Word) or the number of paragraphs (-Paragraph). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Language</maml:name>
<maml:description>
<maml:para>Specifies the language style of the lorem ipsum nonsense text.
Valid values are Latin, Italian, Silly, and Spanish. The default is Latin.</maml:para>
</maml:description>
<command:parameterValue required="false">LoremIpsumLanguage</command:parameterValue>
<dev:type>
<maml:name>LoremIpsumLanguage</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>Latin</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Paragraph</maml:name>
<maml:description>
<maml:para>Lets you specify the number of paragraphs of placeholder text in the output. To specify the number of paragraphs, use the Length parameter. Because Paragraph is the default unit, this parameter is not required.
Otherwise, you can specify the number of characters (-Character) or the number of words (-Word). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>True</dev:defaultValue>
</command:parameter>
<command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="">
<maml:name>Word</maml:name>
<maml:description>
<maml:para>Lets you specify the number of words of placeholder text in the output. To specify the number of words, use the Length parameter.
Otherwise, you can specify the number of characters (-Character) or the number of paragraphs (-Paragraph). Paragraph is the default. You cannot use the Word, Character, and Paragraph parameters in the same command.
</maml:para>
</maml:description>
<command:parameterValue required="false">SwitchParameter</command:parameterValue>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:parameters>
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>None</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para/>
</maml:description>
</dev:type>
<maml:description>
<maml:para>You cannot pipe input to this cmdlet.</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>System.String</maml:name>
<maml:uri>
</maml:uri>
<maml:description>
<maml:para/>
</maml:description>
</dev:type>
<maml:description>
<maml:para>Get-LoremIpsum returns one string of output, regardless of the length or units used in the command.</maml:para>
</maml:description>
</command:returnValue>
</command:returnValues>
<maml:alertSet>
<maml:title>
</maml:title>
<maml:alert>
<maml:para>Get-LoremIpsum returns fixed text string. These strings are not random.</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
<command:example>
<maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\>
PS C:\>
</maml:para>
</maml:introduction>
<dev:code>Get-LoremIpsum
</dev:code>
<dev:remarks>
<maml:para>This command generates one paragraph of Latin-style placeholder text.</maml:para>
</dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText/>
</command:commandLine>
</command:commandLines>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\></maml:para>
</maml:introduction>
<dev:code>Get-LoremIpsum -Word -Length 10 -Language Spanish
Li Europan lingues es membres del sam familie. Lor separat</dev:code>
<dev:remarks>
<maml:para>This command generates 10 words of Spanish-style placeholder text.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\></maml:para>
</maml:introduction>
<dev:code>Get-LoremIpsum -Length 20 -Character -Italian
Ma quande lingues co</dev:code>
<dev:remarks>
<maml:para>This command gets 20 characters of Italian-style placeholder text.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>
<maml:introduction>
<maml:para>PS C:\></maml:para>
</maml:introduction>
<dev:code>Get-LoremIpsum -Paragraph -Length 2 -Language Silly | Out-File Silly.txt
Epsum factorial non deposit quid pro quo hic escorol. Olypian quarrels et gorilla congolium sic ad nauseum. Souvlaki ignitus carborundum e pluribus unum. Defacto lingo est igpay atinlay. Marquee selectus non provisio incongruous feline nolo contendre. Gratuitous octopus niacin, sodium glutimate. Quote meon an estimate et non interruptus stadium.
Sic tempus fugit esperanto hiccup estrogen. Glorious baklava ex librus hup hey ad infinitum. Non sequitur condominium facile et geranium incognito. Epsum factorial non deposit quid pro quo hic escorol. Marquee selectus non provisio incongruous feline nolo contendre Olypian quarrels et gorilla congolium sic ad nauseum. Souvlaki ignitus carborundum e pluribus unum.</dev:code>
<dev:remarks>
<maml:para>This command gets 2 paragraphs of silly-style placeholder text and writes it to the Silly.txt file.</maml:para>
</dev:remarks>
</command:example>
</command:examples>
<maml:relatedLinks/>
</command:command>
<!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19-->
</helpItems>