Simple Two Level TOC Generator with Entry Highlighting and Simple Navigation

[Mohammad]

Based on the discussion here https://groups.google.com/d/msg/tiddlywiki/RTzc2MGT__Y/AEfGglcREgAJ

I have made a NON-RECURSIVE two level TOC generator sports entry highlighting in Table of Contents and simple navigation buttons

as tiddler footer.

I think this TOC can be used in many simple small flat organized wiki! It gives some linearity to TW and helps to create small tutorial, essay, report,...

You can find it here

http://kookma.toc.tiddlyspot.com/

Many thanks to Tony who fired the discussion, Eric who really helped with snippets and also Mat, Scott, bimlas.

--Mohammad

[Mohammad]

The simple two level non recursive TOC and navigation builder has got a repo home on GitHub and can be used as a small plugin!

demo: https://kookma.github.io/TW-TOC/

code: https://github.com/kookma/TW-TOC

It now supports the recursive multilevel TOC and navigation builder.

Special tanks go to Eric Shulman, TonyM, Matt, and PMario.

-- Mohammad

 

TOC Plugin

21st February 2020 at 4:39pm

start

Tiddlywiki5.1.21+

 

LicenseMIT

 

Release1.0

 

Statusstatble

What is TOC plugin?

TOC plugin contains several macros, stylesheets and templates to create table of contents and navigator buttons. In contrast to Tiddlywiki core macros, the TOC plugin has many extra features including

• non recursive two level toc
• hierarchical navigation
• recursive multi level toc
• exclude feature to exclude a branch or specific entries

Install

Packaged plugin

1. Drag and drop $:/plugins/kookma/toc into your wiki
2. Save and reload your wiki (for TW 5.1.21-)

Client-Server installation (separate files)

• For Node.js (server version) download the utility folder from source folder and paste in your Tiddlywiki plugins folder
• For local installation put the utility folder into your local plugins folder under your wiki folder

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

Tutorials

TOC Tutorial is a good point to start. Also have a look at individual demo.

1. Two level non recursive TOC
2. Multi level recursive TOC

History

Revision 1.0.0

• Date: [21 Feb 2020]
• [NEW] documentation improved
• [NEW] code polished
• [NEW] common macros and styles mereged

For all changes see History

Acknowledgement

• Eric Shulman
• Mat
• TonyM
• PMario

Reference

• http://kookma.toc.tiddlyspot.com/
• https://groups.google.com/d/msg/tiddlywiki/RTzc2MGT__Y/KlPVMP5tEwAJ

License

• Distributed under an MIT license