Timelines Plugin

31st October 2024 at 6:23pm

Tiddlywiki5.2.0+
LicenseMIT
Release1.5.0
StatusStable

What is Timelines plugin?

A chronological arrangement of events in the order of their occurrence.

Timelines presents a visual display, with a line representing the passage of time and events being placed along the line depending on the order of when they happened. Each tiddler stores one event.

Tutorials

The Timelines 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.5.0

  • Oct 31st, 2024
  • [NEW] Updated to TiddlyWiki 5.3.5
  • [NEW] Updated to Gatha devlopment studio
  • [NEW] All macros replaced by procedures
  • [FIXED] Code is much simpler
  • [FIXED] Horizontal timeline issues fixed (offset for date, filling line color)

For all changes see ChangeLog

Install

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

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

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

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

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

Acknowledgement

  • bulleted item

References

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

Useful Links

Source 
\import [[Plugin Data]]
{{Plugin Status}}

<span style="float:right;width:96px">{{$:/favicon.ico}}</span>

!! What is <<plugindisplayName>> plugin?
<<<
<!-- retrive plugin description from readme, keep the format and structure -->
<$let newline="
">
<$list filter="[<pluginReadme>get[text]splitregexp[;]!is[blank]first[]split<newline>butfirst[]join<newline>]">
<$transclude $variable=currentTiddler $mode=block/>
</$list>
</$let>

<<alert warning "Timelines presents a visual display, with a line representing the passage of time and events being placed along the line depending on the order of when they happened. Each tiddler stores one event." width:"80%">>

<<<

!! Tutorials
>The [[Timelines Tutorial]] is the starting point to learn more about plugin features, help, demo and examples. See below for online pages.

!! Code and demo

* Demo: <a href=<<plugindemoUrl>> ><<plugindemoUrl>></a>
* Code: <a href=<<plugincodeUrl>> ><<plugincodeUrl>> </a>

<$list filter="[tag[doc]tag[info]has[text]!has[draft.of]]">
<h2>{{!!title}}</h2>
<blockquote><$transclude tiddler=<<currentTiddler>> mode=block/></blockquote>
</$list>

Timelines Tutorial

31st October 2024 at 6:24pm

Timelines presents a visual display, with a line representing the passage of time and events. Timelines has two types of macros: timeline and sequence.

Timelines is a collection of four macros for creating vertical and horizontal timeline and sequence. The content or description and data of events are stored in individual tiddlers.

Timelines contain two timeline macros and two sequence macros. A sequence macro shows event contents in sequence not necessarily in chronological order. The order can be determined by tag or list field or other methods.

The date of events can be stored in a separate field or the modified field can be used.

Source 
Timelines presents a visual display, with a line representing the passage of time and events. Timelines has two types of macros: timeline and sequence.

<<tabs tabsList:"[tag[tutorial]!tag[advanced]!has[draft.of]]" default:"Tutorial Concept" class:"tc-vertical" template:"$:/tabs/tabTemplate" explicitState:"$:/state/tab-plugin-tutorial">>

Image and Icons

11th September 2024 at 6:50pm

Icons made by SVPRepo.

Source 
Icons made by <a href="https://www.svgrepo.com" title="SVGRepo" target="_blank">SVPRepo</a>.

<!--
Icons made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik" target="_blank">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon" target="_blank"> www.flaticon.com</a>
-->

Idea and Todo List

13th September 2024 at 6:43am
Add a Button to Correct the $:/config/FileSystemPaths open 2024.08.30  normal
Check Sort in All Procedures open 2024.10.31  normal
Delete Created and Modified Dates open 2024.05.16  very high
Doc New File Path Convention open 2024.08.29  normal
Doc New Free Random Port open 2024.09.06  normal
Doc New Location of Plugin Tiddlers open 2024.08.29  normal
Doc New Publish Script open 2024.08.30  normal
Doc vcBackup and vcRestore open 2024.08.30  normal
Doc: Horizontal Seq open 2024.10.31  normal
Doc: pageEntries open 2024.10.31  normal
Remove These Tasks for Final Release open 2024.08.21  normal
Use Conditional Footer open 2024.10.31  high

Source 
<%if [[$:/plugins/kookma/thinkup/ui/task-explorer]is[missing]] %>
	<$macrocall $name=table-dynamic filter="[tag[Task]]" fields="tbl-checkbox tbl-expand title status due priority" class="w-100 thinkup-task-explorer" stateTiddler="TaskExplorer-stateTiddler" emptyMessage='<br/>'/>
<%else%>
	{{$:/plugins/kookma/thinkup/ui/task-explorer}}
<%endif%>