From d3dd6dfe44a6a94783a1b1fe4cd33d80bd43a185 Mon Sep 17 00:00:00 2001 From: Kazuhito Yokoi Date: Mon, 8 Apr 2019 17:59:03 +0900 Subject: [PATCH] Add node naming rules --- docs/creating-nodes/appearance.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/creating-nodes/appearance.md b/docs/creating-nodes/appearance.md index 2744f5ed..051232be 100644 --- a/docs/creating-nodes/appearance.md +++ b/docs/creating-nodes/appearance.md @@ -157,6 +157,16 @@ it can be set dynamically on a per-node basis according to the nodes properties. The value of the property can be either a string or a function. If the value is a string, that is used as the label. +Use one of the following formats when naming nodes. + +- Verb only (e.g. "update") +- Noun only (e.g. "server status") +- Verb + noun (e.g. "stop job") + +Keep the following in mind: + +- Words must begin with a lower-case letter. +- Use one single-byte space between words. If the value is a function, it will get evaluated when the node is first loaded, or after it has been edited. The function is expected to return the value to use