On Wednesday, January 29, 2020 at 5:59:30 AM UTC-8, Mohammad wrote: > > I have prepared a summary on Eric TOC Tools with a simple installation. > This is for people like to give a try or use Eric flexible TOC and > outliner in their real work. > I hope Eric confirm if the procedure given below is correct. > Regarding the license I assume it is open source, but Eric himself will > explain. >
Although I have posted InsideTW for *reading*, I have NOT yet "published" InsideTW or the TiddlyBook framework for general distribution. Take note of the words on the CoverPage: *FOR REVIEW ONLY - DO NOT DISTRIBUTE* <file:///C:/Users/Eric/Documents/TWDev/GitHub/EricShulman/tiddlytools.github.com/InsideTW/index.html#Legal%2FCopyrights> I'm OK with sharing the current TOC stuff for *testing and debugging purposes only*. While it can be used in other documents, I have my own plans for providing a separate distribution for public consumption and I don't want people to grab all sort of bits and pieces of the TiddlyBook framework until I formally package and publish each bundle - which I have NOT done yet! While I can appreciate your enthusiasm for my work, *Please don't tell people to take ANY other parts of the TiddlyBook framework without asking me!* > The Eric TOC tools is a set of macros, templates, and stylesheets to > create flexible table of contents by Eric Shulman > <http://tiddlytools.com/InsideTW/>. > Everything that I share for general use will be formally distributed under my *legal trademark* of TiddlyTools, so "Eric TOC" is NOT an appropriate name. When I do provide a distribution "bundle" for the TOC, it will be called "TiddlyTools/TOC". > It can create an outliner, a feature (outlining) quite necessary in long > writings like novels, theses, project reports,... > > It is a smart designed Table of Contents (TOC) generator. > > It not only generates a flexible table of content, but also generates its > TOC as an outliner. > > With the outliner, you can see in a single glance the overall status of > your contents (book, report, ...). See how contents (sections, chapters, > ...) are organised. See which character appear in which scene. Quickly > rearrange things. Write notes for each item as you keep the big picture in > view. > > - It is possible to drag'n drop a tiddler title from the river into > the TOC (outliner) > > You can also drag-and-drop to re-order items within the TOC. Drag a TOC item and drop it onto another TOC item. The dropped item is placed *before* the item it is dropped onto. Hold SHIFT while dropping to place the item to *after* the item it is dropped onto. Hold CTRL while dropping to place the item as a "child" of the item it is dropped onto. > > - It uses $:/HistoryList!!currenttiddler to highlight the most > recently opened tiddler > - It can exclude items and multiple branches in the TOC > - It can switch between author mode and reader mode (in reader mode > one cannot edit the TOC) > > > - It uses a local window on hover lets you create new item and new > branch > > > - It uses a local window on hover lets you create new item and new > branch > > Not sure what you mean by "local window". When in "author" mode, hovering over a TOC item shows the TiddlyWiki standard "more" menu for that tiddler. > > - It has toc-list macro, a simple recursion, that returns the entire > TOC contents as a simple list of tiddlers > > toc-all macro is also a simple recursion that shows the whole TOC with indented levels, but without support for open/close individual branches toc-tree macro offers full tree with "arrows" to open/close individual branches. It also features "auto-open" logic to open a branch when you view a tiddler contained in that branch (i.e., navigation to a tiddler via normal "in tiddler" links) > > - It has a ViewTemplate addition that uses the toc-list output to > present next/previous buttons to provide a "sequential reader" interface > that lets you step through all the TOC items, one at a time. > > TiddlyTools/NavBar/Bottom is optional, and currently transcludes a few bits of TiddlyBook-specific content and includes a reference to {{TiddlyBook/RootTag}} to define the TOC starting tag (the "root" of the tree). I will eventually be re-factoring this tiddler into two parts, one for TiddlyBook-specific use, and another as a generic TOC addon. How to Install > > The ONLY tiddlers that are REQUIRED for the TOC "bundle" are: [prefix[TiddlyTools/TOC]] [[TiddlyTools/ReadOnly/Stylesheet]] 1. TiddlyTools/ReadOnly/Stylesheet 2. TiddlyTools/TOC/Macros 3. TiddlyTools/TOC/scrollhere.js 4. TiddlyTools/TOC/StyleSheet 5. TiddlyTools/TOC/Template with an OPTIONAL addition of: [[TiddlyTools/ReadOnly]] [[TiddlyTools/NavBar/Bottom]] 1. TiddlyTools/NavBar/Bottom 2. TiddlyTools/ReadOnly The following are NOT part of the TOC bundle and should NOT be copied without separate permission > > 1. TiddlyTools/History > 2. TiddlyTools/ReadOnly/Toolbar > 3. TiddlyTools/Settings/Macros > 4. TiddlyBook/Print/Page > 5. TiddlyBook/Favorites/ToggleFavorite > > -e -- You received this message because you are subscribed to the Google Groups "TiddlyWiki" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/6c9d11cb-7fbc-4d16-892d-2d59d4c37e88%40googlegroups.com.
