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

feat(makefile) Produce a combined .epub file including the arf.md and… #212

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skounis
Copy link
Contributor

@skounis skounis commented Jun 26, 2024

… all the annexes available in .md #190

Resolves #190

@skounis skounis requested review from paolo-de-rosa and duviner June 26, 2024 14:18
@skounis
Copy link
Contributor Author

skounis commented Jun 26, 2024

make epub will create the build/epub/arf+annexes.epub file merging arf.md and all the annexes available in .md

An example .epub file (need to unzip it) follows:

You can test it in the following online epub reader

Copy link
Contributor

@toonn toonn left a comment

Choose a reason for hiding this comment

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

LGTM for the most part, thank you for tackling this!

Building the epub target now includes some of the annexes.

With a tool like ImageMagick it would be possible to convert the figures for Annex 4 from PDF to a raster format like PNG, paired with a simple markdown that would allow inclusion of Annex 4.

### ANNEX 4 - Service Blueprints

### A.4.1 Blueprint Initialization and activation
![](docs/annexes/annex-4/annex-4.01-eudi-wallet-initialisation-and-activation1.png)

### A.4.2 Blueprint Online Identification and authentication
![](docs/annexes/annex-4/annex-4.02-eudi-wallet-online-identification-and-authentication1.png)

### A.4.3 Blueprint Issuing mDL
![](docs/annexes/annex-4/annex-4.03-eudi-wallet-issuing-mdl1.png)

### A.4.4 Blueprint Presenting mDL (proximity-supervised)
![](docs/annexes/annex-4/annex-4.04-eudi-wallet-presenting-mdl-proximity-supervised1.png)

### A.4.5 Blueprint Presenting mDL (proximity-unsupervised)
![](docs/annexes/annex-4/annex-4.05-eudi-wallet-presenting-mdl-proximity-unsupervised1.png)

### A.4.6 Blueprint Remote QES -- Creating a signature for authentication / authorisation
![](docs/annexes/annex-4/annex-4.06-Remote-qes-creating-a-signature-eudi-wallet-used-for-authentication-authorisation1.png)

### A.4.7 Blueprint Remote QES - Enrolment
![](docs/annexes/annex-4/annex-4.07-remote-qes-enrolment1.png)

### A.4.8 Blueprint Remote QES - Creating a signature channelled by EUDI Wallet
![](docs/annexes/annex-4/annex-4.08-remote-qes-creating-a-signature-channeled-by-eudi-wallet1.png)

### A.4.9 Blueprint Remote QES - Creating a signature channelled by Relying Party
![](docs/annexes/annex-4/annex-4.09-remote-qes-creating-a-signature-channeled-by-relying-party1.png)

### A.4.10 Blueprint QES -- View history of signatures
![](docs/annexes/annex-4/annex-4.10-qes-view-history-of-signatures1.png)

### A.4.11 Blueprint Local QES - Enrolment
![](docs/annexes/annex-4/annex-4.11-local-qes-enrolment1.png)

### A.4.12 Blueprint Local QES -- Creating a signature.
![](docs/annexes/annex-4/annex-4.12-local-qes-creating-a-signature1.png)

Comment on lines +41 to +42
install-pandoc:
sudo apt-get update && sudo apt-get install -y pandoc
Copy link
Contributor

Choose a reason for hiding this comment

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

This target is specific to distributions that use the apt-get package manager, Debian and Ubuntu mainly. This excludes other distributions like Fedora and OpenSUSE and many more. And other operating systems like macOS and Windows.

I think it's better to fail with a warning that a certain program is necessary, installing things system-wide just for a single project can be undesirable. There's many ways to do this so I wouldn't choose any particular one for the user. I myself use the following to provide me with a project-specific environment using nix-shell:

{ pkgs ? import <nixpkgs> {} }:

let inherit (pkgs) mkShell; in

mkShell {
  packages = with pkgs; [ mkdocs pandoc texlive.combined.scheme-small ];
}

@@ -49,10 +58,15 @@ PANDOC_EPUB_OPTIONS=--to epub3

# Targets and dependencies

.PHONY: all clean
.PHONY: all clean combined.epub
Copy link
Contributor

Choose a reason for hiding this comment

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

The target name needs to change either here or in the definition of the target.

Suggested change
.PHONY: all clean combined.epub
.PHONY: all clean epub

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.

Add a Makefile target to include Annexes in (ePub) output
3 participants