Transform to plugin, add missing image, update readme

Previously a pull request was opened to merge this filter to the core,
but eventually it became a separate plugin, so I had to reorganize
directory structure.

NOTE: Examples not work because the tiddlers missing.

TiddlyWiki/TiddlyWiki5#3511

Author: bimlas

.gitignore

@@ -0,0 +1,3 @@
+/.idea
+/*.iml
+**/$__StoryList.tid

README.adoc

@@ -5,6 +5,9 @@
 
 For details, see the link:{demo-page}[demo page].
 
+* https://gitlab.com/bimlas/tw5-kin-filter (official repository)
+* https://github.com/bimlas/tw5-kin-filter (mirror, please give a star if you like it)
+
 == How to install?
 
 === Drag-n-drop
@@ -18,20 +21,22 @@ For details, see the link:{demo-page}[demo page].
   loaded)
 - Drag-n-drop the file in to your wiki
 
-== How to use in Node version of TiddlyWiki
-
-=== TiddlyWiki installed via NPM
+=== Copy to directory based (Node.js) wiki
 
 - Clone or download this repository
-- Run `tiddlywiki --listen` in the root of this repository
-- Open `localhost:8080` in your browser
+- Copy the `plugins` directory to the root directory of your wiki
 
 == Development
 
 === Running tests
 
 ----
 $ cd ROOT_OF_THIS_REPO
+
+# Unix-like system
 $ export TIDDLYWIKI_PLUGIN_PATH=./plugins
+# Windows
+$ set TIDDLYWIKI_PLUGIN_PATH=./plugins
+
 $ tiddlywiki test
 ----

editions/test/tiddlers/HelloThere.tid

@@ -0,0 +1,3 @@
+tags: picture
+title: $:/plugins/bimlas/kin-filter/README/concept.svg
+type: image/svg+xml

editions/tw5.com/tiddlers/filters/kin.tid

@@ -1,7 +1,4 @@
-created: 20181026114434874
-modified: 20181108070317997
-tags: [[Operator Examples]] [[kin Operator]]
-title: kin Operator (Examples)
+title: $:/plugins/bimlas/kin-filter/README/examples
 type: text/vnd.tiddlywiki
 
 \define item-class(highlightfilter) <$list filter="""[$highlightfilter$is[current]first[]]""">highlighted-toc-item</$list>

plugins/kin-filter/README/concept.svg

@@ -0,0 +1,38 @@
+title: $:/plugins/bimlas/kin-filter/README/syntax
+type: text/vnd.tiddlywiki
+
+! Kin filter operator
+
+* https://gitlab.com/bimlas/kin-filter (official repository)
+* https://github.com/bimlas/kin-filter (mirror, please give a star if you like it)
+
+The purpose of the ''kin'' operator with examples:
+
+* Finds out where base tiddler originates and what other elements originate from it
+* Finds the ancestors and successors of a family member
+* Finds the "leaves" of the branch of the base tiddler in a tree-like structure (where the base tiddler is a leaf)
+* Finds the super- and subsets / groups of a mathematical set (where the base tiddler is a set)
+
+[img[$:/plugins/bimlas/kin-filter/README/concept.svg]]
+
+|''input''|a [[selection of titles|https://tiddlywiki.com/#Title%20Selection]]|
+|''suffix''|the ''kin'' operator uses a rich suffix, see below for details|
+|''parameter''|''B'' base tiddler title or nothing|
+|''output''|''with parameter B''<br>&raquo; those input titles which are ''kin with B'' <br>''without B''<br>&raquo; ''all'' tiddler titles which are ''kin with input titles'' (treat input titles as base tiddlers)|
+|''`!` output''|''with parameter B''<br>&raquo; those input titles which are ''//NOT// kin with B''<br>''without parameter B''<br>&raquo; ignored|
+
+The ''kin'' operator uses an extended syntax that permits multiple fields and flags to be passed:
+
+```
+[kin:<field>:<direction>:<depth>[<operand>]]
+```
+
+* ''field'': name of the [[field|https://tiddlywiki.com/#TiddlerFields]] which connecting tiddlers (assumed to be a [[title list|https://tiddlywiki.com/#Title%20List]], defaulting to `tags`)
+* ''direction'':  collect the tiddler titles in this direction relative to the base tiddler
+** ''from'': collect kins of base tiddler pointing from it (including the base tiddler title itself)
+** ''to'': collect kins of base tiddler pointing to it (including the base tiddler title itself)
+** ''with'': (the default) union of the aboves
+* ''depth'': maximum depth of the collected labels in the tree structure relative to the base tiddler (a positive number, not limited by default)
+* ''operand'': filter operand, the base tiddler
+
+''kin'' is a [[modifier|https://tiddlywiki.com/#Selection%20Constructors]], but without ''B'' parameter is a [[constructor|https://tiddlywiki.com/#Selection%20Constructors]].

plugins/kin-filter/README/concept.svg.meta

@@ -1,5 +1,5 @@
 /*\
-title: $:/core/modules/filters/kin.js
+title: $:/plugins/bimlas/kin-filter/kin.js
 type: application/javascript
 module-type: filteroperator
 
@@ -12,17 +12,6 @@ Finds out where a tiddler originates from and what other tiddlers originate from
 	/*global $tw: true */
 	"use strict";
 
-	function getObjectKeysByExpression(object,callback) {
-		var key,
-			results = [];
-		for (key in object) {
-			if (object.hasOwnProperty(key) && callback(object[key])) {
-			results.push(key);
-			}
-		}
-		return results;
-	};
-
 	function collectTitlesRecursively(baseTiddler,baseTitle,options) {
 		var cacheName = "kin-filter-" + baseTitle + "-" + options.fieldName + "-",
 			titlesPointingFromBase = {},
@@ -58,6 +47,17 @@ Finds out where a tiddler originates from and what other tiddlers originate from
 			}
 		}
 
+		function getObjectKeysByExpression(object,callback) {
+			var key,
+				results = [];
+			for (key in object) {
+				if (object.hasOwnProperty(key) && callback(object[key])) {
+					results.push(key);
+				}
+			}
+			return results;
+		}
+
 		function getResultsInGivenDepth(cachedData) {
 			if(options.depth) {
 				return getObjectKeysByExpression(cachedData,function(value) {

editions/tw5.com/tiddlers/filters/examples/kin.tid plugins/kin-filter/README/examples.tid

@@ -0,0 +1,10 @@
+{
+	"title": "$:/plugins/bimlas/kin-filter",
+	"description": "Kin filter: Recursively looking for kinship between tiddler titles",
+	"author": "bimlas",
+	"version": "1.0.0",
+	"core-version": ">=5.1.18",
+	"source": "https://gitlab.com/bimlas/tw5-kin-filter",
+	"plugin-type": "plugin",
+	"list": "README/syntax README/examples"
+}

plugins/kin-filter/README/syntax.tid

@@ -0,0 +1,3 @@
+title: HelloThere
+
+This is the plugin's browser-based test runner (running on TiddlyWiki <<version>>). See the bottom of this page for the test results.

core/modules/filters/kin.js plugins/kin-filter/kin.js

@@ -1,3 +1,3 @@
 title: $:/SiteTitle
 
-TiddlyWiki5
+Plugin test

plugins/kin-filter/plugin.info

@@ -0,0 +1,58 @@
+{
+    "description": "Basic client-server edition",
+    "plugins": [
+        "tiddlywiki/tiddlyweb",
+        "tiddlywiki/filesystem",
+        "tiddlywiki/highlight"
+    ],
+    "themes": [
+        "tiddlywiki/vanilla",
+        "tiddlywiki/snowwhite"
+    ],
+    "build": {
+        "index": [
+            "--rendertiddler",
+            "$:/plugins/tiddlywiki/tiddlyweb/save/offline",
+            "index.html",
+            "text/plain"
+        ],
+        "externalimages": [
+            "--savetiddlers",
+            "[is[image]]",
+            "images",
+            "--setfield",
+            "[is[image]]",
+            "_canonical_uri",
+            "$:/core/templates/canonical-uri-external-image",
+            "text/plain",
+            "--setfield",
+            "[is[image]]",
+            "text",
+            "",
+            "text/plain",
+            "--rendertiddler",
+            "$:/plugins/tiddlywiki/tiddlyweb/save/offline",
+            "externalimages.html",
+            "text/plain"
+        ],
+        "static": [
+            "--rendertiddler",
+            "$:/core/templates/static.template.html",
+            "static.html",
+            "text/plain",
+            "--rendertiddler",
+            "$:/core/templates/alltiddlers.template.html",
+            "alltiddlers.html",
+            "text/plain",
+            "--rendertiddlers",
+            "[!is[system]]",
+            "$:/core/templates/static.tiddler.html",
+            "static",
+            "text/plain",
+            "--rendertiddler",
+            "$:/core/templates/static.template.css",
+            "static/static.css",
+            "text/plain"
+        ]
+    }
+}