[FOLIO-978] Investigate solutions for page table-of-contents for dev.f.o Created: 12/Dec/17  Updated: 12/Nov/18  Resolved: 02/Apr/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devweb
Remaining Estimate: Not Specified
Time Spent: 3 days, 35 minutes
Original estimate: Not Specified

Attachments: PNG File screenshot-1.png    
Sprint:

 Description   

Investigate in-page ToC navigation.



 Comments   
Comment by David Crossley [ 12/Dec/17 ]

One solution is tscanlin.github.io/tocbot/

The JavaScript and CSS are small and self-contained. It is available via jsdelivr.

The source repository is active and attentive.

Comment by David Crossley [ 03/Jan/18 ]

One demonstation, using Tocbot and classic-jekyll-theme.

See branch demo FOLIO-978-investigate-tocbot

This has the _data/setup.yml configured for "drop-down-menu: yes". In a local checkout, switch it to "no" to use the vertical left-hand sidebar menus. The in-page menu will be below that.

Comment by David Crossley [ 16/Jan/18 ]

That demonstration has been improved. The toc has better presentation. The classic-jekyll-theme is now configured to use the vertical left-hand menus. It also uses the configuration "banner-position: top-fixed".

An outstanding issue: In browser width narrow, the toc panel is always shown. This would need a CSS show/hide toggle.

Comment by David Crossley [ 17/Jan/18 ]

Also temporarily added a "Tutorials" section to demonstrate the menus with a set of separate tutorials, each in their own sub-directory.

Comment by Peter Murray [ 18/Jan/18 ]

I think this is coming along, and I'm looking forward to seeing how Patricia DeStefano's work integrates with this. Two things I noticed:

1. The Built Artifacts page has the two TOC blocks.
1. The Documentation link in the second toolbar does not work. No action when clicking on it.

Comment by David Crossley [ 19/Jan/18 ]

Regarding your first comment: I cannot see an extra ToC. That page seems okay to me.

Comment by David Crossley [ 19/Jan/18 ]

Regarding your second comment: Ah, yes. That seems to be a bug in the theme. I will report it upstream.

We have some documents that are not linked into the navigation menus, yet should appear to belong to a certain area of the site. For example, /doc/code-analysis/ should have the "Documentation" area highlighted at the top and left-hand navigation menus.

Yesterday i added configuration for all such documents. However that introduced this side issue. I have undone that today.

As we get even more documents, they will not all be able to be linked as part of the menus, but need this indication of which section they belong to.

Comment by Peter Murray [ 19/Jan/18 ]

This is what I'm seeing.

Thanks for the explanation about Documentation

Comment by David Crossley [ 19/Jan/18 ]

Yes, that is correct. When there are more pages to be listed under this section, then the top-left menu would provide for that. For example see the "Reference" menu. It has one additional document and will later have more.

The bottom-left ToC is within each individual page. The top-left navigation menu is for each separate area containing a collection of related pages.

Comment by David Crossley [ 22/Jan/18 ]

The issue described above (to have pages that are not linked into menus but still belong to a certain area of the site) is now fixed with release version 2.1.1 of classic-jekyll-theme. So restored that in this branch.

For example, see this page of the current branch demonstration.

Comment by David Crossley [ 23/Jan/18 ]

Added sliding menu for narrow browser width.

Comment by David Crossley [ 24/Jan/18 ]

Merged this branch to master.

Generated at Thu Feb 08 23:09:55 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.