Skip to main content

Mini PDF outline editor

Project description

Mini PDF Outline Editor

pipx run pdf-outline-edit     # tk GUI
pipx run pdf-outline-edit[qt] # qt GUI, does not work yet

A GUI program to import, edit and modify PDF outlines/Table-of-Content through a simple textual format.

The textual format is almost the same as printed books' ToC which has been "rediscovered" multiple times.

  1. Indent level -> Nesting level
  2. Number at the end -> Page number
  3. Text in between -> Title

You can copy and paste existing outline from PDF books and tidy it up a bit to fuse it into the PDF file in 3 easy steps:

  1. Set a target PDF file
  2. Write the outline
  3. Press "Write to PDF" button
demo

Extra

Auto tidy-up

  1. Remove excessive spaces
  2. Remove ending punctuations (,.) in titles
  3. ?

Auto indent by heads

Try convert

index 1
1 Chapter one 2
1.1 nice 3
1.2 world 4
2 Chapter two 5
2.1 hello 6
2.2 noice 7
references 8

into

index 1
1 Chapter one
    1.1 nice
    1.2 world
2 Chapter two
    2.1 hello
    2.2 noice
    references 8  <--- this needs to adjust final entries that has no chapters

Extra Options

  • Offset: Starting page of the page numbers. The pages before it will be roman numerals and the offset page's page label will be 1.

Alternatives

  • HandyOutliner Almost identical program but written in .NET & iText and uses XML
  • pdf.tocgen Over-engineered by following the disgusting "unix philo-dogshit-sophy".

DevOops

# Install in virtualenv
python3 -m pip install -e .
python3 -m pip install -e .[qt]

# Run in dev environment
./src/run-gui.py

License

AGPL-3.0-or-later

FYI

Python packaging is HOLY HELL.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdf-outline-edit-24.2.3.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

pdf_outline_edit-24.2.3-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file pdf-outline-edit-24.2.3.tar.gz.

File metadata

  • Download URL: pdf-outline-edit-24.2.3.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pdf-outline-edit-24.2.3.tar.gz
Algorithm Hash digest
SHA256 8837d91cd71ecbcb3804a437b66725afbb7f03e0f009e42c6336f8ea3788031e
MD5 61dc3851d1a0a3803481c15c15019011
BLAKE2b-256 dc8779c1191cacdac2e1c383ace93cba4fe8793e4c72e2485df6dbc3f7cb7aa3

See more details on using hashes here.

File details

Details for the file pdf_outline_edit-24.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pdf_outline_edit-24.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 47b63cbafef3c57b14fa33ebdc34ea72f098875e16df23436c7a3480c2954c8e
MD5 f0455dd5324656e14d6e4d1622a997bb
BLAKE2b-256 505c02c65af853873000a22070952e40f311d38b5bab09d421e96e88b568264c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page