mbox series

[0/4] SELinux Notebook: Add eBook reader build

Message ID 20211210114340.13977-1-richard_c_haines@btinternet.com (mailing list archive)
Headers show
Series SELinux Notebook: Add eBook reader build | expand

Message

Richard Haines Dec. 10, 2021, 11:43 a.m. UTC
This allows an eBook to be built that can be read by readers such as
Bookworm and Foliate. Note that Bookworm does not render tables or examples
very well, whereas Foliate does.

As eBooks use a different cover format the current SELinux penguin
has been replaced with one from the SELinux artwork repository.

Richard Haines (4):
  selinux-notebook: Make file links consistent
  src/images: Remove current penguin
  src/images: Add new SELinux penguin
  selinux-notebook: Add epub build

 BUILD.md                           |  17 +-
 CONTRIBUTING.md                    |  10 +-
 Makefile                           |  48 +++-
 README.md                          |   9 +-
 src/bounds_rules.md                |   2 +-
 src/cil_overview.md                |   2 +-
 src/cover.md                       |  16 ++
 src/cover_epub.md                  |   2 +
 src/embedded_systems.md            |  12 +-
 src/images/selinux-penguin.svg     | 398 -----------------------------
 src/images/selinux-penguin_400.png | Bin 0 -> 65728 bytes
 src/network_support.md             |   4 +-
 src/postgresql.md                  |   6 +-
 src/styles_epub.css                |  44 ++++
 src/title.md                       |  16 --
 src/toc.md                         |   2 +-
 16 files changed, 139 insertions(+), 449 deletions(-)
 create mode 100644 src/cover.md
 create mode 100644 src/cover_epub.md
 delete mode 100644 src/images/selinux-penguin.svg
 create mode 100644 src/images/selinux-penguin_400.png
 create mode 100644 src/styles_epub.css

Comments

Daniel Burgener Dec. 10, 2021, 4:14 p.m. UTC | #1
On 12/10/2021 6:43 AM, Richard Haines wrote:
> This allows an eBook to be built that can be read by readers such as
> Bookworm and Foliate. Note that Bookworm does not render tables or examples
> very well, whereas Foliate does.
> 
> As eBooks use a different cover format the current SELinux penguin
> has been replaced with one from the SELinux artwork repository.
> 
> Richard Haines (4):
>    selinux-notebook: Make file links consistent
>    src/images: Remove current penguin
>    src/images: Add new SELinux penguin
>    selinux-notebook: Add epub build
> 
>   BUILD.md                           |  17 +-
>   CONTRIBUTING.md                    |  10 +-
>   Makefile                           |  48 +++-
>   README.md                          |   9 +-
>   src/bounds_rules.md                |   2 +-
>   src/cil_overview.md                |   2 +-
>   src/cover.md                       |  16 ++
>   src/cover_epub.md                  |   2 +
>   src/embedded_systems.md            |  12 +-
>   src/images/selinux-penguin.svg     | 398 -----------------------------
>   src/images/selinux-penguin_400.png | Bin 0 -> 65728 bytes
>   src/network_support.md             |   4 +-
>   src/postgresql.md                  |   6 +-
>   src/styles_epub.css                |  44 ++++
>   src/title.md                       |  16 --
>   src/toc.md                         |   2 +-
>   16 files changed, 139 insertions(+), 449 deletions(-)
>   create mode 100644 src/cover.md
>   create mode 100644 src/cover_epub.md
>   delete mode 100644 src/images/selinux-penguin.svg
>   create mode 100644 src/images/selinux-penguin_400.png
>   create mode 100644 src/styles_epub.css
> 

Applying these patches (and subbing in a random png for the penguin 
cover image since you obviously didn't include the binary diff on the 
list) allows me to successfully build an epub and load it using the 
Overdrive app on my Android device.  Everything I poked at generally 
worked fine, although long lines overrun really awkwardly, which is 
particularly an issue for tables.  For example, the table in the SELinux 
Overview section overruns the next several pages and make the whole 
thing very hard to read.  I'm not sure if thats may pandadoc version, my 
epub reader, or just basic difficulties with table rendering in epub.

It might also be nice to populate the epub metadata.

Tested-by: Daniel Burgener <dburgener@linux.microsoft.com>
Richard Haines Dec. 11, 2021, 4:41 p.m. UTC | #2
On Fri, 2021-12-10 at 11:14 -0500, Daniel Burgener wrote:
> On 12/10/2021 6:43 AM, Richard Haines wrote:
> > This allows an eBook to be built that can be read by readers such
> > as
> > Bookworm and Foliate. Note that Bookworm does not render tables or
> > examples
> > very well, whereas Foliate does.
> > 
> > As eBooks use a different cover format the current SELinux penguin
> > has been replaced with one from the SELinux artwork repository.
> > 
> > Richard Haines (4):
> >    selinux-notebook: Make file links consistent
> >    src/images: Remove current penguin
> >    src/images: Add new SELinux penguin
> >    selinux-notebook: Add epub build
> > 
> >   BUILD.md                           |  17 +-
> >   CONTRIBUTING.md                    |  10 +-
> >   Makefile                           |  48 +++-
> >   README.md                          |   9 +-
> >   src/bounds_rules.md                |   2 +-
> >   src/cil_overview.md                |   2 +-
> >   src/cover.md                       |  16 ++
> >   src/cover_epub.md                  |   2 +
> >   src/embedded_systems.md            |  12 +-
> >   src/images/selinux-penguin.svg     | 398 ------------------------
> > -----
> >   src/images/selinux-penguin_400.png | Bin 0 -> 65728 bytes
> >   src/network_support.md             |   4 +-
> >   src/postgresql.md                  |   6 +-
> >   src/styles_epub.css                |  44 ++++
> >   src/title.md                       |  16 --
> >   src/toc.md                         |   2 +-
> >   16 files changed, 139 insertions(+), 449 deletions(-)
> >   create mode 100644 src/cover.md
> >   create mode 100644 src/cover_epub.md
> >   delete mode 100644 src/images/selinux-penguin.svg
> >   create mode 100644 src/images/selinux-penguin_400.png
> >   create mode 100644 src/styles_epub.css
> > 
> 
> Applying these patches (and subbing in a random png for the penguin 
> cover image since you obviously didn't include the binary diff on the
> list)

I did submit [PATCH 3/4] to add new SELinux penguin, however it was
bounced. The file added can be found at [1].

>  allows me to successfully build an epub and load it using the 
> Overdrive app on my Android device.  Everything I poked at generally 
> worked fine, although long lines overrun really awkwardly, which is 
> particularly an issue for tables.  For example, the table in the
> SELinux 
> Overview section overruns the next several pages and make the whole 
> thing very hard to read.  I'm not sure if thats may pandadoc version,
> my 
> epub reader, or just basic difficulties with table rendering in epub.

I've tried a number of readers and found they do vary on rendering
tables, also whether they centre the images or not. I don't see a way
around this except to add a note in BUILD.md explaining these type of
issues. Does anyone have a better idea ?

> 
> It might also be nice to populate the epub metadata.
I could update, anything in particular you would like as there seems to
be quite a few possible entries.

> 

Thanks for testing, also corrected the nit for next update
> Tested-by: Daniel Burgener <dburgener@linux.microsoft.com>

[1]
https://github.com/SELinuxProject/selinux-artwork/blob/main/PNG/selinux-penguin_400.png