-
Notifications
You must be signed in to change notification settings - Fork 0
/
Convert-RelatedLinkToHtml.html
74 lines (65 loc) · 2.36 KB
/
Convert-RelatedLinkToHtml.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>PowerShell - Convert-RelatedLinkToHtml - Silk</title>
<link href="silk.css" type="text/css" rel="stylesheet" />
<link href="styles.css" type="text/css" rel="stylesheet" />
</head>
<body>
<ul id="SiteNav">
<li><a href="index.html">Get-Silk</a></li>
<li><a href="documentation.html">-Documentation</a></li>
<li><a href="releasenotes.html">-ReleaseNotes</a></li>
<li><a href="http://pshdo.com">-Blog</a></li>
<li><a href="http://github.com/pshdo/Silk">-Project</a></li>
</ul>
<h1>Convert-RelatedLinkToHtml</h1>
<div class="Synopsis">
<p>Converts a command's related link to HTML.</p>
</div>
<h2>Syntax</h2>
<pre class="Syntax"><code>Convert-RelatedLinkToHtml [-CommandHelp] <Object> [[-ModuleName] <String>] [[-Script] <String[]>] [<CommonParameters>]</code></pre>
<h2>Description</h2>
<div class="Description">
<p><code>Convert-RelatedLinkToHtml</code> converts a command's related links to HTML. If the related link is not a URL, the command name is converted to a link that poitns to a <code>CommandName.html</code> file.</p>
</div>
<h2> Parameters </h2>
<table id="Parameters">
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required?</th>
<th>Pipeline Input</th>
<th>Default Value</th>
</tr>
<tr valign='top'>
<td>CommandHelp</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.object.aspx">Object</a></td>
<td class="ParamDescription"><p>The help object returned by <code>Get-Help</code>.</p></td>
<td>true</td>
<td>true (ByValue)</td>
<td></td>
</tr>
<tr valign='top'>
<td>ModuleName</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.string.aspx">String</a></td>
<td class="ParamDescription"><p>The name of the module the command is in.</p></td>
<td>false</td>
<td>false</td>
<td></td>
</tr>
<tr valign='top'>
<td>Script</td>
<td><a href="http://msdn.microsoft.com/en-us/library/system.string.aspx">String[]</a></td>
<td class="ParamDescription"><p>The names of any scripts in the module.</p></td>
<td>false</td>
<td>false</td>
<td></td>
</tr>
</table>
<div class="Footer">
Copyright 2016 <a href="http://pshdo.com">Aaron Jensen</a>.
</div>
</body>
</html>