schoeberl / chisel-book

Digital Design with Chisel
752 stars 141 forks source link

Enable PDF sidebar table of contents and metadata #38

Closed carlosedp closed 2 years ago

carlosedp commented 2 years ago

This enables PDF reader sidebar table of contents.

Tested in mac:

image

Also added the PDF metadata to the generated file.

image

Fixes #35

schoeberl commented 2 years ago

Thanks for this PR. I was struggling with this for quite some time. And it still does not show up in my Mac PDF viewer. Although other PDFs do have a TOC in the sidebar. I installed the Acrobat reader and it shows the TOC of the Chisel book. So I think this is fine for most users. need to check the iPad reader.

Again, thanks, Martin

carlosedp commented 2 years ago

Nice it "kinda" I'm on MacOS Big Sur 11.4 and it shows fine in the sidebar.

schoeberl commented 2 years ago

You are right! It now shows up there in the side bar as well. Great fix!

Thanks, Martin

On 8 Feb, 2022, at 22:58, Carlos Eduardo @.***> wrote:

Nice it "kinda" I'm on MacOS Big Sur 11.4 and it shows fine in the sidebar.

— Reply to this email directly, view it on GitHub https://github.com/schoeberl/chisel-book/pull/38#issuecomment-1033101875, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAE63GARDYNSSBSHEFQNZY3U2GGXHANCNFSM5NJJJARA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you modified the open/close state.

chakpongchung commented 2 years ago

Thanks! great work!

is there any way we can use overleaf to always access the latest build of the pdf?

http://www.imm.dtu.dk/~masca/chisel-book.pdf is not showing the latest build from master. Local build requires a lot of latex plugins that many people do not have.

@schoeberl @carlosedp

carlosedp commented 2 years ago

We could implement GitHub actions CI to dynamically build it every merge to master for example. To build I have a flow using Docker containers with Latex that can be seen here: https://github.com/carlosedp/chisel-book/commit/089cc2cf2854e2a127149343d039006d0fb2e4de

The only problem is that since the slides have relative paths, I could not include them in the flow (it can be done with some adjustments tho).