Searchwikis Plugin

29th December 2023 at 6:52am

Tiddlywiki5.2.0+
LicenseMIT
Release1.4.0
Statusin progress

What is SearchWikis plugin?

Searchwikis enable to have a central wiki and search all other wikis from one place.

Tutorials

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

Code and demo

History

Release 1.4.0

  • Dec 29th, 2023
  • [NEW] Updated to TiddlyWiki 5.3.3

For all changes see ChangeLog

Install

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

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

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/searchwikis 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 searchwikis plugin, and click install, or reinstall if you update searchwikis
  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 searchwikis source folder from GitHub
ii. put the searchwikis 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 searchwikis source folder from GitHub
ii. put the searchwikis 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 searchwikis.
  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/searchwikis"
    	],
      ...
    }

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

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

Acknowledgement

  • Mat
  • bimlas
  • David Gifford
  • Olegh Bondarenko
  • Ilya
  • TonyM

References

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

Authors

  • Mohammad
  • Mark S

Useful Links

Searchwikis Tutorial

29th December 2023 at 7:01am

This titorial briefly describes the features of Searchwikis plugin.

Idea

  • Tiddlywiki is great at small to moderate number of tiddlers
  • It is easier to keep few subjects in a Tiddlywiki, for example a student can have one wiki per course
    • Tiddlywiki is like a MsWord file but with tons of features and suprior flexibility
    • Tiddlywiki is like a webpage, but simple to create, customize and use
    • Tiddlywiki is like a database
  • RESULT
    • People using Tiddlywiki have several separate Tiddlywikis
  • ISSUE
    • Searching and finding something gets difficult and makes headache

One solution

  • Create a master Tiddywiki also called central, host, or main wiki
  • Use a dataTiddler per wiki to index few fields per tiddler like tiddler titles, caption and tags fields
  • Put all these indexes in the master Tiddlywiki
  • Use the standard or advanced search to look in these indexes and return a link to the tiddler in the external wiki

Howto

  • a simple script to create or update the index in the external wiki
  • export the updated index to the master wiki
  • search tool to search and find in indexes

Search in External Wikis

4th April 2020 at 1:30pm

Searchwikis Index Summary

4th April 2020 at 1:30pm

Index summary

  TitleUrlLast updateindex Tiddler Delete
TiddlyWiki https://tiddlywiki.com/ Mar 4th, 2020 17:43:30 $:/stw/index/TiddlyWiki
TW-Scripts https://kookma.github.io/TW-Scripts/ Mar 4th, 2020 17:46:14 $:/stw/index/TW-Scripts
Delete all index tiddlers?

Index tools
index and export tool (drag and drop to external wiki, create index and export to this central wiki)
Change search result order by rearrange the index tiddlers

Idea and Todo List

Filter and search in table

All tasks: 2

Delete Created and Modified Dates
My First Idea rework

Image and Icons

Icons made by SVPRepo.