Issue: More traditional book table of contents widget

Issue Tools
- View Changes

May 29, 2019 2:51 AM

medic917

Junior Member

More traditional book table of contents widget

If I'm not mistaken, currently, the best way to create a book using VaultWiki is to create a hierarchy of books/sub-books.

For example:
Algebra 1 (book) > Chapter 1 (book) > Section 1.1 (page)

This allows us to get a "full" table of contents showing the hierarchy mentioned in my example above.

The problem is, the "full" table of contents only shows when viewing the highest level book (being Algebra 1).
When I go click to view Chapter 1, for example, we end up seeing a shortened version of the table of contents as shown below:
Chapter 1 > Section 1.1
This omits the "Algebra 1" link in the table of contents.

I understand the automated reasoning behind this, but it is a UX flaw as you can imagine for people trying to implement the wiki for multi-leveled books.

Is there a way we can add an extra setting to the current widget where it will show a table of contents of sub-content linked to a certain book? So I can have the widget show everything including "Algebra 1" and everything below it. Perhaps an option like "List all from parent book:" and have a drop down list of books.

The current table of contents widget also does not include hyperlinks of the appropriate page, making it a bit difficult to implement (I currently have it off due to this). Unfortunately, this widget shares the same behavior that I mentioned at the beginning of my post.

Issue Details

Issue Number 5778

Issue Type Feature

Project VaultWiki 4.x Series

Category Books / Chapters

Status Public Release

Priority 7 - Minor Features / Enhancements

Suggested Version 4.1.0 Beta 1

Implemented Version (none)

Milestone (none)

Software DependencyXenForo 2.x

License TypePaid

Votes for this feature 0

Votes against this feature 0

Attachments 0

Assigned Users (none)

Tags xenforo

May 29, 2019 12:30 PM
pegasus

VaultWiki Team
The following assumes that you are talking about the actual widget "Book Table of Contents" and not the book's content list (which by design shows only hierarchy below the current book). If you are referring to the book's content list, it is not intended to see the full hierarchy here. That is what the navigation links are for, or the separate discussed widget, or the TOC BB-Code's BOOK value.

I identified a bug where for some Maximum Depth settings, the available depth was not being used up. For a partial fix for most values, in src/addons/vw/vw/_core/view/factory/block/book_toc/vw.php, find:

Code:

$maxparent = floor($maxdepth / 2);

Replace with:

Code:

$maxparent = ceil($maxdepth / 2);

It should be noted that the widget is intended only to have the table of contents relative to the current page expanded. The entire TOC is not expanded in this view.

As for not being able to see the full hierarchy relative to the current page, you can adjust this by modifying your Maximum Depth, in Options > VaultWiki: Navigation > Maximum Depth for Book Table of Contents. The number is a count of possible indents in the table of contents. The indents are filled in equal amounts parent and child (if there are not enough on one side we can go deeper on the opposite side), using the currently viewed chapter as the center point. To always show all available hierarchy, set this number to 15 which is the maximum depth that can be created. If there is a Book with no visible chapters in the hierarchy, then we can expect

Assuming enough depths are available, the widget should fill with siblings first, then child chapters, then parents, deeper children, parent siblings, etc, using the viewed chapter as the center point, until reaching the Maximum Preview amount. Options > VaultWiki: Navigation > Number of Previewed Book Contents.

There is also a bug with some values, especially odd numbers, not moving from center in the expected way. This will be fixed in the next release.
Reply

+ Reply

All times are GMT -4. The time now is 3:12 AM.

This site uses cookies to help personalize content, to tailor your experience, and to keep you logged in if you register.
By continuing to use this site, you are consenting to our use of cookies.

Learn more… Accept Remind me later

Welcome to VaultWiki.org, home of the wiki add-on for vBulletin and XenForo!

Issue: More traditional book table of contents widget

Issue Tools