Skip to content

Added section for node configuration properties #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added section for node configuration properties #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/creating-nodes/help-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@ a consistent appearance between nodes.
<p>Connects to a MQTT broker and publishes messages.</p>
</div>
</div>
<div class="grid" style="min-height:auto; padding:5px 0 5px; border-bottom: 1px solid #f0f0f0;">
<div class="col-1-2">
If the node has any configuration properties, this section describes those properties
and how they affect the operation of the node. The description should be brief - if further
descrption is needed, it should be in the Details section.
</div>
<div class="col-1-2 node-help" style="padding-right: 5px; background: #f9f9f9;">
<h3>Properties</h3>
<dl class="message-properties">
<dt>server
<span class="property-type">config node</span>
</dt>
<dd> the config node specifying the MQTT server to connect to. </dd>
<dt class="optional">topic <span class="property-type">string</span></dt>
<dd> the MQTT topic to publish to.</dd>
</dl>
</div>
</div>
<div class="grid" style="min-height:auto; padding:5px 0 5px; border-bottom: 1px solid #f0f0f0;">
<div class="col-1-2">
If the node has an input, this section describes the properties of the
Expand Down Expand Up @@ -111,6 +129,15 @@ The above example was created with the following HTML.
<script type="text/x-red" data-help-name="node-type">
<p>Connects to a MQTT broker and publishes messages.</p>

<h3>Properties</h3>
<dl class="message-properties">
<dt >server <span class="property-type">config node</span></dt>
<dd> the MQTT server to publish to.</dd>
<dt class="optional">topic <span class="property-type">string</span></dt>
<dd> the MQTT topic to publish to. Overrides <code>msg.topic</code></dd>
<dt class="optional">QoS <span class="property-type">string</span></dt>
<dd> 0, fire and forget - 1, at least once - 2, once and once only. Overrides <code>msg.qos</code></dd>
</dl>
<h3>Inputs</h3>
<dl class="message-properties">
<dt>payload
Expand Down