This is forked from Li Dong. Two modifications I've made:
- correct one problem when there are '..' or '...' etc as the subsection subsubsection marker.
- add the page shift option
The modified installer can be found here and --shift can be used to specify the page shift
$ pdfmate insert-toc <path to PDF> --toc <path to outputted TOC text file> --shift <shifted pgae No.>
Other details can be found in the original README.md below:
PdfMate is a small tool that provides several utilities to deal with PDF files. For the time being, its main function is to add the missing TOC (Table Of Content) into the PDF files and only command line interface is provided.
Although PdfMate is written in Java, I only support Linux and Mac platform officially. The installer can be downloaded here. After downloading, invoke
$ chmod a+x pdfmate.installer
$ ./pdfmate.installer
and relogin. You should be able call PdfMate as
$ pdfmate help
Note: Try to use TAB key to autocomplete the typing in BASH.
When there is some improvements, you can update your downloaded PdfMate by running:
$ pdfmate update
When reading a PDF with long length, it is diffcult to navigate without a TOC that links to each part of the content. PdfMate solves this problem by providing two operators extract-pages and insert-toc. The first one can be used to extract the texts on the table of contents pages as
$ pdfmate extract-pages <path to PDF>
[Notice]: pdfmate: Input the page range or list:
> 1-3
It will ask for the page ranges and print out the extracted text onto screen. The output (in standard error output) can also be redirected to a file for later editing as
$ pdfmate extract-pages <path to PDF> 2> <path to outputted toc text file>
By now, you got a text file that contains the contents table and also some other stuffs, so you need manually edit it to the following list of TOC entries:
# <hierarchy level> <title> <page number>
1 Some Root-level Title Words 44
1.1 Some Sub-level Title Words 45
. Some Sub-level Title Words 45
.. Some Sub-sub-level Title Words 46
- Some Root-level Title Words 60
...
Any line starting with # will be commented. Each line will be an entry in the final TOC with the first two items as the title and the last one as the page number that this entry links to. If a sub-level entry has no hierarchy level number, use . to specify the level. And for a root-level entry has no number, use -.
Then invoke operator insert-toc as
$ pdfmate insert-toc <path to PDF> --toc <path to outputted TOC text file>
A new PDF will be generated with TOC alongside with the original PDF.
Note: In some occasions, the encoding of TOC text file may not be the default UTF-8, you can use option --encoding <encoding> to specify one. If you want to know what encodings are available, you can just input any invalid one, and PdfMate will print out them for you!
TODO: Currently, you need to edit the toc text file manually for all the type of PDFs. In future, PdfMate should be smart enough to do the dirty job when it is possible for you!
- Li Dong [email protected]