Coder Social home page Coder Social logo

pdf-bookmarker's Introduction

PDF-Bookmarker

A tool to add bookmarks and title/author to PDF using hexapdf

Usage

ruby Bookmarker.rb "<filename (without extension)>"

This program requires a correspondent json file with the same name as the PDF. The json files must follow the format below:

{
	"Info": {
		"BookTitle": string,
		"BookAuthor": string
	},
	"Outline": array of outlines
}

where each element of Outline should contain

"Title": string,
"Target": integer,
"Style": 0 or 1 or 2 or "Italic" or "Bold",
"Opened": boolean,
"Color": string,
"Bookmark": array of outlines

Some elements can be ommitted, for example,

{
	"Info": {
		"BookTitle": "a",
		"BookAuthor": "a"
	},
	"Outline": [
		{
			"Target": 180,
			"Title": "a",
			"Style": 2
		},
		{
			"Target": 192,
			"Title": "a",
			"Bookmark": [
				{
					"Title": "a",
					"Target": 90
				},
				{
					"Title": "a",
					"Target": 29,
					"Style": 1,
					"Color": "red"
				}
			]
		}
	]
}

is valid.

Future development

  • More options e.g. input/output filename, whether to optimize -> done
  • Json file generator (perhaps from pdftk's dump data?) -> partly done (from csv)
  • Provide a conprehensive document

pdf-bookmarker's People

Contributors

niccori250k avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.