89 lines
3.5 KiB
HTML
89 lines
3.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<title>Module HowTo - Help entries</title>
|
|
<link rel="stylesheet" type="text/css" href="style/layout.css">
|
|
</head>
|
|
<body>
|
|
<div style="text-align: center;">
|
|
<h1>Module HowTo - Help entries<br>
|
|
</h1>
|
|
<br>
|
|
<br>
|
|
<div style="text-align: left;"><br>
|
|
<h2>1. Defining help entries<br>
|
|
</h2>
|
|
Your module should provide help for all input fields and other
|
|
important things.<br>
|
|
The LAM help system defines an extra ID range for each module. So you
|
|
are free in defining your own IDs.<br>
|
|
<br>
|
|
The help entries are specified with <span style="font-weight: bold;">get_help()</span>
|
|
or <span style="font-weight: bold;">meta['help']</span>.<br>
|
|
<br>
|
|
<span style="font-weight: bold; text-decoration: underline;">Example:</span><br
|
|
style="font-weight: bold; text-decoration: underline;">
|
|
<br>
|
|
The <span style="font-style: italic;">ieee802Device</span>
|
|
module needs help entries for the MAC address.<br>
|
|
<br>
|
|
<table style="width: 100%; text-align: left;" class="mod-code"
|
|
border="0" cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="vertical-align: top;"> /**<br>
|
|
* Returns meta data that is interpreted by parent
|
|
class<br>
|
|
*<br>
|
|
* @return array array with meta data<br>
|
|
*/<br>
|
|
<span style="font-weight: bold;">function</span>
|
|
get_metaData() {<br>
|
|
$return = array();<br>
|
|
<span style="color: rgb(255, 0, 0);">
|
|
// help Entries</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
$return['help'] = array(</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
'mac' => array(</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
"Headline"
|
|
=> _("MAC address"),</span><br style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
"Text" =>
|
|
_("This is the MAC address of the network card of the device (e.g.
|
|
00:01:02:DE:EF:18).")</span><br style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
),</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
'macList' => array(</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
"Headline"
|
|
=> _("MAC address list"),</span><br style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
"Text" =>
|
|
_("This is a comma separated list of MAC addresses.")</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
<span style="color: rgb(255, 0, 0);">
|
|
));</span><br
|
|
style="color: rgb(255, 0, 0);">
|
|
return $return;<br>
|
|
}<br>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<br>
|
|
<br>
|
|
<span style="font-weight: bold;"></span>
|
|
<h2><span style="font-weight: bold;"></span></h2>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|