Generate, validate, and publish PDF versions of Hibernate 4.1 documentation

Description

Hibernate 4.0 and 4.1 do not have PDF versions of the documentation: http://hibernate.org/docs

Please generate, validate (i.e. make sure that the tables fit within the page on which they're displayed, etc.), and publish PDF versions of Hibernate 4.1 documentation.

Thanks, Phil

Environment

Hibernate 4.1

Activity

Show:
Philip Schlesinger
October 19, 2012, 11:25 PM

How do these look? I made them landscape 8.5x14 so the tables would fit. If somebody can do this better as 8.5x11 and/or in portrait, be my guest...

Sanne Grinovero
October 20, 2012, 12:25 AM

Hi! that looks very good. I agree PDFs are still important, especially with ebook readers getting mainstream.. just not sure that feels like a priority to the rest of the team. Curious how you made them?

This is nice to have but will be outdated soon, the best solution would be if you could patch the build system to provide a task to generate them. I would suggest you to drop an email to the hibernate developer mailing list [1] to make sure the whole team notices this; I don't think everyone receives notifications about the "website" project.

1 - https://lists.jboss.org/mailman/listinfo/hibernate-dev

Steve Ebersole
October 20, 2012, 12:44 AM

The "Getting Started Guide" at least cannot be done in PDF; it links to a zip file (see 2. Tutorial code).

Sanne, Phillip and I talked about this on IRC. Really we need someone to help with jDocBook and especially the integration with FOP (how DocBook is converted into PDF). Phillip unfortunately does not know FOP.

Philip Schlesinger
October 20, 2012, 12:55 AM

Hi Sanne,

I saved the single page HTML to a file, imported it into Microsoft Word 2010, and printed to PDF from there via PrimoPDF (Word's Export to PDF feature seems to only do 8.5x11 portrait).

I'll post it to the hibernate-dev list.

Emmanuel Bernard
November 6, 2013, 4:06 PM

Guys I'll close this one. Better move it to per project issues if that's still a concern. But with our recent goal to more chunked documentation we might revisit this.

Assignee

Unassigned

Reporter

Philip Schlesinger

Feedback Requested

None

Feedback Requested By

None

backPortable

None

Pull Request

None

backportDecision

None

backportReEvaluate

None

Priority

Minor
Configure