Commander Plugin

13th September 2024 at 4:12am

Tiddlywiki5.2.0+
LicenseMIT
Release2.1.13
Statusin progress

What is Tiddler Commander plugin?

Tiddler Commander, in short Commander is a unique tool for batch operations on tiddlers. Commander has the below features

  • Bulk tiddler creation/deletion
  • Combo search to filter and select tiddlers
  • Title operation: add, remove prefixes and suffixes, also remove cahras form begining and end of title (on renaming tiddlers, relink can be used to update title in other tiddlers)
  • Tag operation: add, remove, replace
  • Field operation: add, remove, rename, and set field value
  • SNR, search and replace in all fields including text, tags, title, and common fields
  • Inspect, to review and inspect tiddlers in one place, scroll among them and edit all fields (including common fields), tags, text (title is an exception!)
  • Log, create logs of all operations
  • Search, save and load any combination of filter search

Note: Commander will not work on shadow tiddlers, unless they are overriden! Because shadow tiddlers arenโ€™t stored as real tiddlers. They are intentionally excluded from most operations by default so that they donโ€™t clutter filters made by users unless explicitly required.

Tutorials

The Commander Tutorial is the starting point to learn more about plugin features, help, demo and examples. See below for online pages.

Code and demo

History

Revision 2.1.13

  • Dec 11th, 2024
  • [NEW] A new icon for Commander. The old icon is kept and can be used if one likes to change the Commander icon.

For all changes see ChangeLog

Install

From the below two categories of installing Tiddler Commander plugin, select any suitable method you like.

It is highly recommended to backup your data before trying any new plugin! Do it before installing commander.

A. Installing plugin for Tiddlywiki single html file

Tiddlywiki as a single html file (like emtpy.html) is the most common form of Tiddlywiki in use. To install the plugin on a single html file, follow any of the below procedures.

I. Drag and drop

The simplest method, also called standalone configuration, is the drag and drop method.

  1. Open your Tiddlywiki in a browser
  2. Drag and drop $:/plugins/kookma/commander into your wiki
  3. Save and reload your wiki
II. Use plugin library

Another simple method is to have the Kookma Plugin Library which acts exactly like Official Plugin Library

  1. Drag and drop $:/config/KookmaPluginLibrary into your wiki
  2. In your wiki, open $:/ControlPanel, Plugins tab and the click on big button Get more plugins
  3. Click open library under Kookma Plugin Library
  4. Find commander plugin, and click install, or reinstall if you update commander
  5. Save and reload your wiki

B. Installing plugin for Tiddlywiki on Node.js

III. Tiddlywiki + Node.js

There are two methods in which custom plugins that are not part of official Tiddlywiki's plugin library can be installed when using Tiddlywiki under Node.js (also called client-server configuration).

  • local installation in only a specific wiki
  • global installation on the server, so every wiki running on Node.js has access to the plugin

III.A Local installation

For local installation under Node.js
i. download the commander source folder from GitHub
ii. put the commander source folder directly into local plugins folder under your wiki folder,
iii. if you have not the plugins folder, create it under your own wiki folder.
iv. if server is runing, stop it and restart again
v. finished, it is now available in your wiki!

For details on how download a plugin from GitHub, see Downloading Plugin from GitHub

III.B Global installation

For global installation under Node.js

i. download the commander source folder from GitHub
ii. put the commander source folder into kookm folder (publisher folder) under your server plugins folder
iii. if you have not the kookma folder (publisher folder), create it under your server plugins folder
vi. finished installing for server!

Extra step for global installation (III.B)

After installing the a plugin globally in your Node.js server (the client-server configuration), to use it in any specific wiki, add it to the tiddlywiki.info file of that wiki:

  1. Open the specific wiki folder of choice
  2. Edit the tiddlywiki.info file (it is in JSON format) and locate the plugins section (see below)
  3. Add entries corresponding to the plugins you wish to use. Here add commander.
  4. Take care to retain commas to separate items, but do not terminate the last item in a list with a comma

    {
    	"plugins": [
    		"tiddlywiki/codemirror",
    		"kookma/commander"
    	],
      ...
    }

  5. if server is runing, stop it and restart again

Detailed procedure can be found in More on Client-Server Installation

Acknowledgement

The below people directly or indirectly help developing and improving Tiddler Commander.

  • Jeremy Ruston
  • Jed Carty
  • Rob Hoelz
  • Simon Huber
  • Saq Imtiaz
  • Tobias Beer
  • Ton Gerner
  • Anthony Muscio
  • Birthe C
  • Thomas Elmiger
  • Diego Messa
  • TiddlyTweeter
  • Watt
  • Bimlas

References

Add ref here if any! or clear text to vanish from main page!

Authors

Author

Contributors

Useful Links

Commander Tutorial

13th September 2024 at 4:53am

Tiddler Commander plugin contains several macros for batch operation. This tutorial shows how Commander works. Examples and extra descrition can be found under Examples and Usage.

What is Tiddler Commander?

Tiddler Commander, in short Commander is a unique tool for batch operations on tiddlers. Commander has the below features

  • Bulk tiddler creation/deletion
  • Combo search to filter and select tiddlers
  • Title operation: add, remove prefixes and suffixes, also remove cahras form begining and end of title (on renaming tiddlers, relink can be used to update title in other tiddlers)
  • Tag operation: add, remove, replace
  • Field operation: add, remove, rename, and set field value
  • SnR, search and replace in all fields including text, tags, title, and common fields
  • Inspect, to review and inspect tiddlers in one place, scroll among them and edit all fields (including common fields), tags, text (title is an exception!)
  • Log, create logs of all operations
  • Search, save and load any combination of filter search

Image and Icons

11th September 2024 at 6:50pm

Icons made by SVPRepo.

Examples and Usage

30th December 2022 at 4:00pm

Below list shows examples and usecase of Commander.

  • Add or Remove Prefixes to Tiddlers Title
  • Add or Remove Suffixes to Tiddlers Title
  • Create Bulk of Tiddlers
  • Delete Bulk of Tiddlers
  • Export Bulk of Tiddlers

Idea and Todo List