print.html - all-in-one page

[b4u-mw]

Hello,

since this theme is (primarily) creating books rather than blogs, it would be great if there's a print.html layout that

• contains a TOC, similar to the menu
• contains all the pages in the order of the menu
• has a print stylesheet applied as default

I found some hints how to do so:

• https://discourse.gohugo.io/t/how-to-create-print-html-for-printing-all-pages-in-single-page/41346
• https://stackoverflow.com/questions/74370580/how-to-print-all-contents-of-hugo-in-single-page-similar-rust-book-print-html

Kind regards,
Michael.

[inphobia]

i also have this somewhere on my wishlist , but not very high.

the references i found were mostly to:
https://gohugo.io/render-hooks/links/#pageinner-details

which kinda seems able to do what you need?

haven't taken an in depth look since:

• my site structure might be an issue. have a bunch of single pages that i reference in multiple general overviews (think like a math exercise that's shared between mutliple books).
• i use a shortcode to enable unique id's via front matter so i don't have to deal with how relative & whatever links work in hugo (https://github.com/boevski/hugo?tab=readme-ov-file#elinkhtml). i find it a trade off between more manual work do define everything versus getting intimate with hugo :-D

i also came by https://www.sphinx-doc.org/en/master/ that claims to be excellent for that use case. it did not take long for me to realize i have no ambition to learn "restructuredtext", i might as well just dust of my latex skills from 15 years ago.

[alex-shpak]

@b4u-mw I will consider this option, not sure at the moment if it is something that I want permanently in theme, but it could be a module/snippet tho

@inphobia I'm not sure how to help you here :)

[inphobia]

@alex-shpak i think you already did all you possibly could. i wanted a simple way to maintain some technical docs with as little as possible overhead. it would be a challenge to come up with something hugo-book is missing for my use case.
my frustration is with hugo itself mostly, but out of all the major frameworks it's without doubt the best fit for my needs.

if i needed somewhat professional typesetting for a 300page document that needs to be print, pdf & online there are likely better fits. but right now the bottleneck is me writing content, not me fiddling with 200 settings.

25years in the business have thought me the elegance of simplicity!

[takusuman]

I'm willing to try to implement it.
Are there any guidelines here regarding style? Things such as tabs, etc.

[b4u-mw]

@takusuman That's great. I have very little experience in developing in hugo, so cannot help here much but I can test and give feedback.

If you fork it, I'll switch to your branch for testing.

The 1st step could be just a print.html page that iterates over all pages in the same way the menu does (using "params.BookSection" as a selector).

Ideally it creates a "<a name=..>" for each topic and a ToC on the 1st page. This way we can test that linking works (e.g. when printed to pdf)

Edit: regarding the ToC, see puppeteer/puppeteer#1778. This could be a way to create awesome PDF out of the print.html page. But let's first start with the print page and make it better step by step ;-)

[takusuman]

If you fork it, I'll switch to your branch for testing.

Great. I will fork it right now and we (or, in this case, I 😅) can start it in this weekend.

[takusuman]

@b4u-mw I will be borrowing your principal issue message as some sort of TO-DO.
As the icing on the cake, we could have an "Open print dialog" button that just call the print() function on the browser --- not sure about older ones, though. 🤔
I know that's obvious, just a mention.

[takusuman]

@alex-shpak Would there be any problem if I opened a draft pull-request?

[alex-shpak]

Hi there!
Nah, go ahead with draft PR.

Few hints:

• take a look how landing page is implemented, I think that will work well for this case. so users can choose which page is single output.

  • https://github.com/alex-shpak/hugo-book/blob/main/exampleSite/content.en/_index.md
  • https://github.com/alex-shpak/hugo-book/blob/main/layouts/landing.html

• you can try to take ordered list of pages from pagination partial: https://github.com/alex-shpak/hugo-book/blob/main/layouts/_partials/docs/prev-next-cache.html

• just keep in mind to keep everything simple :)