frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

more core node info updates to newer style

Browse Source
This commit is contained in:
Dave Conway-Jones
2017-04-25 21:47:58 +01:00
parent 45fbd22e28
commit 7f90d31846
7 changed files with 84 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
nodes/core/parsers/70-CSV.html
View File

@@ -1,20 +1,4 @@
<!--
Copyright JS Foundation and other contributors, http://js.foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<script type="text/x-red" data-template-name="csv">
<div class="form-row">
<label for="node-input-temp"><i class="fa fa-list"></i> <span data-i18n="csv.label.columns"></span></label>
@@ -68,12 +52,16 @@
</script>
<script type="text/x-red" data-help-name="csv">
<p>A function that parses the <code>msg.payload</code> to convert CSV to/from a javascript object.
<p>A function that parses the <code>msg.payload</code> to convert CSV to or from a javascript object.
Places the result in the payload.</p>
<p>If the input is a string it tries to parse it as CSV and creates a javascript object.</p>
<p>If the input is a javascript object it tries to build a CSV string.</p>
<p>If the input is a simple array the output is just a CSV generated from that array.</p>
<p>If the input is an array of arrays, or an array of objects, a multiple-line CSV is created.</p>
<h3>Inputs</h3>
<ul>
<li>If the input is a string it tries to parse it as CSV and creates a javascript object.</li>
<li>If the input is a javascript object it tries to build a CSV string.</li>
<li>If the input is a simple array the output is just a CSV generated from that array.</li>
<li>If the input is an array of arrays, or an array of objects, a multiple-line CSV is created.</li>
</ul>
<h3>Details</h3>
<p>The columns template should contain an ordered list of column headers. For CSV input these become the property names.
For CSV output these specify the properties to extract from the object and the order for the CSV.</p>
<p>If the input is an array then the columns template does not matter, but can be used to generate a row of column titles.</p>

32
nodes/core/parsers/70-HTML.html
View File

@@ -1,18 +1,3 @@
<!--
Copyright JS Foundation and other contributors, http://js.foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<script type="text/x-red" data-template-name="html">
<div class="form-row">
@@ -45,11 +30,22 @@
<script type="text/x-red" data-help-name="html">
<p>Extracts elements from an html document held in <code>msg.payload</code> using a selector.</p>
<p>If left blank the selector may be set dynamically by passing in <code>msg.select</code> along with the <code>msg.payload</code>.
<h3>Inputs</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">string</span></dt>
<dd>the html string from which to extract elements.</dd>
<dt class="optional">select <span class="property-type">string</span></dt>
<dd>if not configured in the edit panel the selector can be set as a property of msg.</dd>
</dl>
<h3>Output</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">array | strings</span></dt>
<dd>the result can be either a single message with a payload containing an array of the matched elements, or multiple
messages that each contain a matched element.</dd>
</dl>
<h3>Details</h3>
<p>The selector uses <a href="https://github.com/cheeriojs/cheerio/blob/master/Readme.md" target="_blank">Cheerio</a>
which uses the <a href="https://github.com/fb55/CSSselect#user-content-supported-selectors" target="_blank">CSS selector</a> syntax.</p>
<p>The result can be either a single message with a payload containing an array of the matched elements, or multiple
messages that each contain a matched element.</p>
</script>
<script type="text/javascript">

25
nodes/core/parsers/70-JSON.html
View File

@@ -1,18 +1,3 @@
<!--
Copyright JS Foundation and other contributors, http://js.foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<script type="text/x-red" data-template-name="json">
<div class="form-row">
@@ -22,9 +7,13 @@
</script>
<script type="text/x-red" data-help-name="json">
<p>A function that parses the <code>msg.payload</code> to convert a JSON string to/from a javascript object. Places the result back into the payload.</p>
<p>If the input is a JSON string it tries to parse it to a javascript object.</p>
<p>If the input is a javascript object it creates a JSON string.</p>
<p>A function that parses the <code>msg.payload</code> to convert a JSON string
to or from a javascript object. Places the result back into the payload.</p>
<h3>Inputs</h3>
<ul>
<li>If the input is a JSON string it tries to parse it to a javascript object.</li>
<li>If the input is a javascript object it creates a JSON string.</li>
<ul>
</script>
<script type="text/javascript">

37
nodes/core/parsers/70-XML.html
View File

@@ -1,18 +1,3 @@
<!--
Copyright JS Foundation and other contributors, http://js.foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<script type="text/x-red" data-template-name="xml">
<div class="form-row">
@@ -33,13 +18,21 @@
</script>
<script type="text/x-red" data-help-name="xml">
<p>A function that parses the <code>msg.payload</code> to convert xml to/from a javascript object. Places the result in the payload.</p>
<p>If the input is a string it tries to parse it as XML and creates a javascript object.</p>
<p>If the input is a javascript object it tries to build an XML string.</p>
<p>You can also pass in a <code>msg.options</code> object to override all the multitude of parameters. See
<a href="https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/README.md#options" target="_blank">the xml2js docs</a>
for more information.</p>
<p>If set, options in the edit dialogue override those passed in on the msg.options object.</p>
<p>A function that parses the <code>msg.payload</code> to convert xml to or from a javascript
object. Places the result in the payload.</p>
<h3>Inputs</h3>
<ul>
<li>If the input is a string it tries to parse it as XML and creates a javascript object.</li>
<li>If the input is a javascript object it tries to build an XML string.</li>
</ul>
<dl class="message-properties">
<dt class="optional">options <span class="property-type">string</span></dt>
<dd>You can also pass in a <code>msg.options</code> object to override all the multitude of parameters. See
<a href="https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/README.md#options" target="_blank">the xml2js docs</a>
for more information.</dd>
</dl>
<h3>Details</h3>
<p>If set, options in the edit dialogue override those passed in on the msg.options object.</p>
</script>
<script type="text/javascript">

10
nodes/core/parsers/70-YAML.html
View File

@@ -7,9 +7,13 @@
</script>
<script type="text/x-red" data-help-name="yaml">
<p>A function that parses the <code>msg.payload</code> to convert a YAML string to/from a javascript object. Places the result back into the payload.</p>
<p>If the input is a YAML string it tries to parse it to a javascript object.</p>
<p>If the input is a javascript object it creates a YAML string.</p>
<p>A function that parses the <code>msg.payload</code> to convert a YAML string to or
from a javascript object. Places the result back into the payload.</p>
<h3>Inputs</h3>
<ul>
<li>If the input is a YAML string it tries to parse it to a javascript object.</li>
<li>If the input is a javascript object it creates a YAML string.</li>
</ul>
</script>
<script type="text/javascript">