From 9a524a0707c4a9204c1114dca667eb04aac49aa1 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Sun, 24 Aug 2014 01:43:08 -0700 Subject: [PATCH] Created Definitions (markdown) --- Definitions.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 Definitions.md diff --git a/Definitions.md b/Definitions.md new file mode 100644 index 0000000..2271486 --- /dev/null +++ b/Definitions.md @@ -0,0 +1,32 @@ +### Node + +A **node** is a single, well-defined piece of functionality. + +An **input node** sits at the start of a **flow**. It has one or more **output ports**. + +An **output node** sits at the end of a **flow**. It has one **input port**. + +A **function node** or **query node** sits in the middle of a **flow**. It has one **input port** and one or more **output ports**. + +It is defined in an html file and a js file. The js file contains the runtime functionality. The html file contains the editor definition. + +### Config Node + +A **config node** contains configuration information that can be used by **nodes**. It does not get wired into a flow. + +### Node Set + +A js/html file pair may contain multiple **nodes**. This is called a **node set**. Any error loading the js/html files will cause all **nodes** in a **node set** to be unavailable. + +### Node Module + +An npm **node module** may contain multiple js/html file pairs - each identified in the `package.json` file. Hence, an npm module may contain multiple **node sets**, each containing one or more **nodes**. + +### Node Pack + +A **node pack** is a collection of similarly-themed nodes that a user might want to install together. It is structurally the same as a node module, but acts as a meta-package that pulls in multiple specific **node modules** using the standard package dependency mechanism. + +### Flow + +A **flow** is a collection of connected **nodes** and their associated **config nodes**. +