Book TOC (Table of Contents)

I found a module called booktree , might inspire this idea. Could possibly "borrow" some code from the booktree module

this patch is by no means ready, it is just a beginning.

It requires the booktree module installed and configured (for now).

eventually won't need the booktree module at all.

patch from comment #6 actually works, but requires booktree to have been configured prior.

Next, clean this up to remove reliance on the booktree module configuration.

New patch

Another one.

https://chat.openai.com/share/c98318cd-e75b-4222-a97d-8c79097ed836

Latest patch works.

Please go with the merge request.

https://git.drupalcode.org/project/book_pdf/-/merge_requests/6.patch

ok it's mergeable now

Hi joseph.olstad. Thanks very much for all your work on this.

I've taken a quick look through the MR. From what I can see, the the inclusion of a ToC is not configurable? I.e. users can't choose whether the PDF includes a ToC?

ya it would be nice to have a configuration on/off option for the TOC. With that said, I'd imagine that will want it.

Sorry I haven't had any more time to work on this, it's working with the latest Merge request 6.

here's a new patch, I haven't tested it, the idea is an optional TOC, defaulted to disabled.

warning, I have not tested this patch.

ok this patch I have tested, so far so good.

interdiff from 26 to 27

patch 27 didn't fix the book translation issue, hoping this might help

new patch and interdiff.

patch 30 was insufficient but did not regress.

Here's a new patch that should resolve it (knock on wood).

patch 31 is a regression (crashes), knock on wood again this time
new interdiff

new patch

Ok so I made a few discoveries with book_pdf 1.0.x-dev@dev , something changed in the drupal.org release system and with the dev branch and likely the next tagged branch of book_pdf they'll probably start forcing the requirement of the contrib book module which currently with Drupal 10.2.7 crashes.

Patch 34 works with 1.0.x-dev@dev
Patch 36 is for 1.0.1 , but incomplete.

Testing these, hoping I get it this time.

Ok so it took a while to figure this out.

If a PDF was already generated, the returned PDF was a filename as follows [bid].pdf

I have a solution to ensure the cache of a PDF works correctly, it should probably also have the revision id in the filename as well as the langcode for the language version.

So, for english should actually be [bid]-[vid]-en.pdf

example: 1001-9991-en.pdf

1001 is the bid/node id
9991 is the revision id.
en is the language code for english.

New patch to follow shortly.

New patch as discussed in #37

ok once I have tested this to solve the issue, some cleanup could be done, although that could happen later on also. The most important thing is ensuring this works for everyone.

ok, 38 led me to 40.

I have tested this, have a good look at the interdiff, it makes more sense now.

new patch

Multiple fixes in this Merge Request.

Improves the PDF caching algorithm which fixed the localization support
Add revision support for the PDF caching algorithm so that new PDFs are generated for future versions of books otherwise the cache served up the originally cached pdf based on the node id only.

ToC is optional and disabled by default.

Alternative to the MR:

Patch 44

This works well.

It would be good to get merging on this, otherwise, I suppose I can keep pushing more into this one.

I'm going to add another feature to this:

I will add a "Delete PDF cache" button and the handler logic for it.

Here's the interdiff

Now for a user defined splash page
a user defined header
a user defined footer

interdiff from patch 44

Ok the Merge Request is in good shape.

With that said, I've forked book_pdf into a new module called book_pdfs

I swapped out wkhtmltopdf for dompdf in book_pdfs, this is the reason for the fork.

https://www.drupal.org/project/book_pdfs →

Ok so the dompdf version of this module called book_pdfs is in good shape with rc5, with that said, I'm going to switch back to book_pdf for now because wkhtmltopdf works better for very large multipage tables that get otherwise mangled by dompdf.

Unfortunately my clients content includes large multipage tables . These tables are rendered nicely with wkhtmltopdf.

so I'll review the merge request a bit more yet.

Found a regression that occurs when the Table of Contents is enabled.

Viewing the book node results in a WSOD if creating a book node without choosing an option from the "Book" select dropdown in the node edit form.

I will fix this bug soon.

Error message is as follows which occurs when viewing the new "book node":

Error: Call to a member function id() on null in Drupal\book_pdf\Controller\BooktreeController->tree() (line 24 of modules/contrib/book_pdf/src/Controller/BooktreeController.php).

Workaround :

when creating a new book node make sure to select SOMETHING from the "Book" dropdown select list before saving.

New patch and interdiff