Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: replace <<list-links ...>> with <<toc-tabbed-internal-nav ...>> #3664

Closed
00SS opened this issue Dec 25, 2018 · 8 comments
Closed

DOCS: replace <<list-links ...>> with <<toc-tabbed-internal-nav ...>> #3664

00SS opened this issue Dec 25, 2018 · 8 comments

Comments

@00SS
Copy link
Contributor

00SS commented Dec 25, 2018

I have been wondering if using a Tabbed Internal Table of Contents (toc-tabbed-internal-nav) may be an effective way to present certain groups of tiddlers.

For an example, please look at at THIS Help Internal ToC. This is what I am proposing.

Is this a good idea? If so, I may work a little on making the changes for further discussion.

The below tiddlers have all used a simple list-links macro for a tag related list. I propose this presentation is changed to a Tabbed Internal Table of Contents.

The modifications needed to make these changes appears to be quite minor and easy - but the presentation style gives large benefits for quick review and navigation.

List of tiddlers (apart from the ones marked --X--) to look at modifying the display:

  • About
  • Commands
  • Concepts
  • Core Macros
  • Core Variables
  • Custom Styles FAQ
  • Customise TiddlyWiki
  • Definitions
  • --X-- Editions
  • --X-- Editor toolbar
  • Features
  • --X-- Filter Syntax
  • Hidden Settings
  • How to apply custom styles
  • --X-- Languages
  • Learning
  • Macro Syntax
  • Mechanisms
  • Messages
  • OfficialPlugins
  • Platforms
  • Plugin Editions
  • PluginMechanism
  • Plugins
  • --X-- ReadMe -->tag--> TiddlyWiki on Node.js
  • Videos
  • Webserver -->tag--> WebServer Parameters & WebServer Guides
  • WebServer API
  • WebServer Guides
  • WebServer Parameters
  • Widgets -->tag--> Widgets
  • Widgets in WikiText -->tag--> Widgets
  • WikiText
  • Working with TiddlyWiki
@00SS
Copy link
Contributor Author

00SS commented Jan 2, 2019

If you save this text file ( Tiddlers using List Links.txt ) - rename it to *.tid and import (drag & drop) it into http://tiddlywiki.com/

It shows the number of list-links links for each tiddler that is a possible candidate for changing to a toc-tabbed-internal-nav ToC .

Below are the tiddlers that contain a list-links of over 20 links:

  • Widgets 46
  • Messages 43
  • Concepts 37
  • Learning 33
  • Definitions 32
  • Core Macros 29
  • Features 24
  • Commands 23
  • Core Variables 22
  • WikiText 22
  • WebServer Parameters 21
  • Working with TiddlyWiki 20

@ibnishak
Copy link
Contributor

ibnishak commented Jan 4, 2019

Please consider that it looks rather confusing on mobile screens

@00SS
Copy link
Contributor Author

00SS commented Jan 4, 2019

I must admit I do not use smart phones and thus never considered this.

To get an idea of how others solve the issue, I am looking at https://www.w3schools.com/html/default.asp on my laptop, and on an Android mobile. The two presentation styles are completely different.

The normal style is very much like TW's toc-tabbed-internal-nav Table of Contents.

The mobile version changes the left side menu into a clickable dropdown (upper left of the screen). I wonder if anyone has already implemented this in a TW table of contents.

Each page on both a laptop and a mobile also has a [< Previous] [Next >] button, both at the top and the bottom of the page being displayed.

At tiddlywiki.com - the present Table of Contents when fully expanded is over 1,700 lines long. This is much more like an index. It is really difficult to use efficiently.

A better way of navigating through the information would be very useful.

Any ideas?

@00SS
Copy link
Contributor Author

00SS commented Jan 4, 2019

Another thought for the following tiddlers:

Tiddler name Links
Widgets 46
Messages 43
Definitions 32
Commands 23
Core Macros 29
Core Variables 22
WikiText 22
WebServer Parameters 21
OfficialPlugins 13
Hidden Setting 7
Platforms 4

What if these were remade in the same style as: Filter Operators
<$count filter="[tag[Filter Operators]]"/> = 90

This Filter Operators table layout style with a short summary and a link to the detailed tiddler is really useful. I refer to it very often because it is so informative. It also displays well in both wide and narrow screen devices.

@Jermolene
Copy link
Owner

Hi @00SS I wonder if another solution might not be to explore adding a variant of <<list-links>> macro that is better suited to displaying larger numbers of items. It could include an input box for filtering the list, and options to reduce the font size and use multiple columns where the screen is wide enough.

Looking through your wiki I see many good suggestions. I wonder if we should establish a new ticket for keeping track of all the work you are doing, just to make sure that I pay attention to the areas that will make the most difference for you.

@00SS
Copy link
Contributor Author

00SS commented Feb 16, 2019

Thanks for the suggestions @Jermolene - I've been mulling over this for almost 2 weeks now.

I can't come to any conclusions so I thought to try one possibility.

An effective solution might be the way Filter Operators is laid out in tables. That entails each item having fields

  1. description
  2. caption (many already have this)
  3. Other relevant information field(s) - in this example: location

I tried this with the tiddler: Hidden Settings

Attached a json for record: Hidden Settings.zip

@00SS
Copy link
Contributor Author

00SS commented Mar 18, 2019

Anyone has perhaps 30 seconds to look at the new layout for: Hidden Settings ?

Would be useful to know if this was a better layout that the original tiddlywiki.com list-links style.

If it is, then effort could be made to do the same for other similarly presented tiddlers using list-links.

Thanks

@00SS
Copy link
Contributor Author

00SS commented Apr 22, 2019

Perhaps if not 30 seconds, then 20 seconds?
😞

@00SS 00SS closed this as completed Apr 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants