Loading...
 

Suggestions for improving autotoc (in-page navigation)

Status
Open
Subject
Suggestions for improving autotoc (in-page navigation)
Version
27.x
28.x (future, soon to be master)
Category
  • Feature request
Feature
Wiki (page view, edit, history, rename, etc)
Resolution status
New
Submitted by
Gary Cunningham-Lee
Lastmod by
Gary Cunningham-Lee
Rating
(0)
Description

After checking out in-page navigation outside of Tiki and doing some searching for best practices, I'd like to make a few suggestions for improvement.

First of all, about the current situation of autotoc in master (to be Tiki 27), I came across these bugs, that I think are known already, plus some recommendations:

  • Autotoc plugin
    • Parameters don't work (bugs):
      • title (nothing displays)
      • levels (only the top level displays)
    • The terminology could be improved IMO (suggestions):
      • "inline" should be "sticky-top" or "fixed-top" . I think one of these would be more descriptive; I've always been kind of confused by "inline" here.
      • "activity" should be "active" . This would be a more standard term.


• Autotoc feature itself (suggestions for improvement):

    • No need for the page name to be a link as the page name/title is already elsewhere on the page. Presumably the first link of the page content is at the top of the content so the page name isn't needed for clicking in autotoc to get back to the page top.
    • Instead, autotoc should have a title like "On this page" to let readers know these aren't links to other pages. (Apparently people sometimes mistake in-page navigation links for links to outside the page.) When the title parameter bug is fixed, the page editor can add "On this page" manually, of course, but maybe it should be default text unless replaced,
    • The full list/outline of links should display on page load to give the reader an idea of the page content. I'm recommending this because of articles I came across saying how one main function of in-page navigation is to provide a complete outline of the page content.
    • Instead, currently in Tiki 26, only the top-level links display initially, and the display of subsection links seems kind of erratic. Actually I wonder if hiding and displaying lower-level links is needed. Maybe just keep them all visible all the time. See https://getbootstrap.com/docs/5.3/components/scrollspy/

.** If the autotoc is longer than the viewport height, then either make dropdowns for lower-level links like a vertical menu, so there are visual cues (dropdown arrows) that they are there, or put the whole nav in a div with overflow-y:scroll. But actually I think the whole thing should display, and the reader can scroll the page if the toc extends down out of sight.

Importance
8
Easy to solve?
5
Priority
40
Demonstrate Bug (Tiki 19+)
Please demonstrate your bug on show2.tiki.org
 About show2.tiki.org

To help developers solve the bug, we kindly request that you demonstrate your bug on a show2.tiki.org instance. To start, simply select a version and click on "Create show2.tiki.org instance". Once the instance is ready (in a minute or two), as indicated in the status window below, you can then access that instance, login (the initial admin username/password is "admin") and configure the Tiki to demonstrate your bug. Priority will be given to bugs that have been demonstrated on show2.tiki.org.

Version: Create show2.tiki.org instance
Demonstrate Bug (older Tiki versions)
Please demonstrate your bug on show.tikiwiki.org
 About show.tikiwiki.org

To help developers solve the bug, we kindly request that you demonstrate your bug on a show.tikiwiki.org instance. To start, simply select a version and click on "Create show.tikiwiki.org instance". Once the instance is ready (in a minute or two), as indicated in the status window below, you can then access that instance, login (the initial admin username/password is "admin") and configure the Tiki to demonstrate your bug. Priority will be given to bugs that have been demonstrated on show.tikiwiki.org.

Version: Create show.tikiwiki.org instance
Ticket ID
8604
Created
Tuesday 12 March, 2024 13:22:51 GMT-0000
by Gary Cunningham-Lee
LastModif
Tuesday 12 March, 2024 13:26:03 GMT-0000

Attachments

 filenamecreatedhitscommentversionfiletype 
No attachments for this item


Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Diagram
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw -superseded by Diagram
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Gantt
Group
Groupmail
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Kanban
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend
Terms and Conditions
Theme
TikiTests
Federated Timesheets
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools