pdfplumber icon indicating copy to clipboard operation
pdfplumber copied to clipboard

Add `Page.table_of_contents`

Open jsvine opened this issue 2 years ago • 1 comments

... probably as a @property method. This should(?) be relatively straightforward, and seems like it'd be helpful:

  • https://github.com/jsvine/pdfplumber/discussions/456#discussioncomment-947380

  • https://github.com/jsvine/pdfplumber/issues/1018#issuecomment-1769517654

jsvine avatar Oct 30 '23 16:10 jsvine

Hello Maintainer,

I am a computer science student currently working on an open-source contribution as part of a university project.

I would like to take on Issue #1034 - “Add Page.table_of_contents property.”

My plan is as follows:

Implement a new table_of_contents property in both the PDF and Page classes to expose the document’s outline (if available) using pdfminer’s get_outlines() method.

Add a unit test (tests/test_toc.py) with a sample PDF containing bookmarks to verify extraction correctness.

Update the documentation, changelog, and contributor list according to the CONTRIBUTING.md guidelines.

Could you please assign this issue to me so I can proceed with the implementation and submit a pull request?

Thank you for maintaining and supporting this great project!

AbdullahMehmoodAwan avatar Oct 25 '25 10:10 AbdullahMehmoodAwan