Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace xsltproc/fop by asciidoctor-pdf #5968

Merged
merged 12 commits into from
Jan 13, 2021
Merged

Replace xsltproc/fop by asciidoctor-pdf #5968

merged 12 commits into from
Jan 13, 2021

Conversation

cgx
Copy link
Collaborator

@cgx cgx commented Nov 6, 2020

Description

Use asciidoctor-pdf to generate the guides in pdf format.

Impacts

  • No more dependencies on XSL/docbook/fop/Java. The theme is also easier to maintain.
  • I also move the generated HTML documents to the root of the docs directory. It simplifies the relative URLs of the images.

Limitations

The title page had to be simplified because of the current limitations of asciidoctor-pdf. It is now a combination of a cover page with the PacketFence logo and a title page with the guide name and PacketFence version. I think the result is totally acceptable.

New Package(s) Required

We need asciidoctor-pdf. It can be packaged, or simply installed using gem.

Generated PDF Example

PacketFence_Clustering_Guide.pdf

@cgx cgx requested a review from nqb November 6, 2020 18:22
@nqb nqb self-assigned this Nov 9, 2020
Copy link
Contributor

@nqb nqb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When #5936 is merged, we will need to remove TOC from PDF generation for NEWS file.

EDIT: not relevant anymore because NEWS.asciidoc is not part of PDF build

@cgx cgx mentioned this pull request Nov 9, 2020
1 task
rpm/packetfence.spec Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
docs/README.asciidoc Show resolved Hide resolved
rpm/packetfence.spec Outdated Show resolved Hide resolved
docs/includes/global-attributes.asciidoc Show resolved Hide resolved
docs/includes/global-attributes.asciidoc Show resolved Hide resolved
docs/includes/global-attributes.asciidoc Show resolved Hide resolved
UPGRADE.asciidoc Outdated Show resolved Hide resolved
@nqb nqb merged commit 63702da into devel Jan 13, 2021
@nqb nqb mentioned this pull request Jan 14, 2021
@satkunas satkunas deleted the feature/fopless branch May 15, 2024 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants