Narenj 0.5.1

What is Narenj plugin?

Edit, view and compare tiddlers side by side.

Tutorials

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

Code and demo

• Demo: https://kookma.github.io/TW-Narenj
• Code: https://github.com/kookma/TW-Narenj

History

Release 0.5.1

• Dec 27th, 2024
• [FIXED] a typo in $:/plugins/kookma/narenj/macros/definition

For all changes see ChangeLog

Install

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

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

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

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

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

Acknowledgement

• Akhater: https://github.com/akhater the developer behind Drift
• David Gifford for his idea on edit in sidebar
• Mat von TWaddle for his idea and plugins on side editor

References

• Forum discussion
• RR-TW5 - A Roam Research Styled TiddlyWiki. This is very powerful and contains tools, codes for todo, queries, ... need to be read carefully!
• Daily Notes on Drift by Akhater Daily Notes - Interstitial Journaling plugin TiddilyWiki The repo is deleted. Link is dead!

Etymology and Story

Narenj (Persian: نارنج) is a Persian name for Bitter Orange (Citrus aurantium) which is mainly produced in Pars province (Shiraz) and north province Mazandaran (Iran). At this time of the year (spring), orange trees are full of blossoms, which are called spring orange blossoms, and they are very fragrant. Many travels to Shiraz and its countryside to see these beautiful trees.

Talk Discussion

For question and discussion see;

https://talk.tiddlywiki.org/t/narenj-plugin-tools-for-pin-view-and-edit-in-the-sidebar/6818

Useful Links

• Optimize svg icons: https://jakearchibald.github.io/svgomg/
• Download svg images: https://www.svgrepo.com/