@@ -29,9 +29,9 @@ Extract from the README:
>
> % update-mime-database ~/.local/share/mime
-# Build HTML or PDF Versions
+# Build HTML, PDF or EPUB Versions
-The SELinux Notebook can be rendered in both HTML and PDF using the included
+The SELinux Notebook can be rendered in HTML, PDF and EPUB using the included
Makefile. In order to build these versions of the notebook, "pandoc" and
"weasyprint" must be installed on your system; consult your distribution
documentation for information on installing these packages.
@@ -41,9 +41,22 @@ following command:
% make pdf
-... and the following will generate the HTML notebook:
+... the following will generate the HTML notebook:
% make html
-The PDF and HTML notebooks will be generated in newly created "pdf" and "html"
-directories.
+... and the following will generate the EPUB notebook:
+
+ % make epub
+
+The PDF, HTML and EPUB notebooks will be generated in newly created "pdf",
+"html" and "epub" directories.
+
+**Notes:**
+
+- The Notebook examples are not embedded into any of the document formats,
+ however they will have links to them via their build directory.
+- When viewing the Notebook EPUB version, eBook readers do vary on rendering
+ tables, displaying images and resolving links to the examples. For Linux,
+ Foliate was found to be the most consistent, and can be found at:
+ <https://github.com/johnfactotum/foliate>
@@ -10,11 +10,11 @@ project.
## Make Sure Your Changes Render Correctly
-The SELinux Notebook can be viewed in three different formats: Markdown, HTML,
-and PDF. Your changes need to render correctly in all three formats. The
-HTML and PDF formatted notebooks can be created using the included Makefile
-and Markdown can be viewed directly via the GitHub source browser or any
-number of Markdown viewers.
+The SELinux Notebook can be viewed in four different formats: Markdown, HTML,
+PDF and EPUB. Your changes need to render correctly in all four formats.
+The HTML, PDF and EPUB formatted notebooks can be created using the included
+Makefile and Markdown can be viewed directly via the GitHub source browser
+or any number of Markdown viewers.
## Explain Your Work
@@ -2,20 +2,23 @@
# The SELinux Notebook
#
+SED = sed
+PANDOC = pandoc
CWD ?= $(shell pwd)
SCRIPTS = $(CWD)/scripts
SRCDIR = $(CWD)/src
HTMLDIR ?= $(CWD)/html
PDFDIR ?= $(CWD)/pdf
+EPUBDIR ?= $(CWD)/epub
IMAGES = $(SRCDIR)/images
EXAMPLES = $(SRCDIR)/notebook-examples
+EXAMPLES_EPUB = $(shell echo $(EXAMPLES) | $(SED) 's;/;\\/;g')
METADATA = $(SRCDIR)/metadata.yaml
HTML_OUT = SELinux_Notebook.html
PDF_OUT = SELinux_Notebook.pdf
+EPUB_OUT = SELinux_Notebook.epub
-SED = sed
-PANDOC = pandoc
PANDOC_OPTS = --from markdown+pipe_tables
PANDOC_OPTS += -V mainfont='DejaVu Serif' -V monofont='DejaVu Sans Mono'
@@ -27,8 +30,8 @@ help:
@echo "targets:"
@grep "^#@ " Makefile | cut -c4-
-#@ all build both the PDF and HTML versions
-all: html pdf
+#@ all build the PDF, HTML and EPUB versions
+all: html pdf epub
#@ navlinks update the navigation links in the markdown sources
.PHONY: navlinks
@@ -46,11 +49,13 @@ navlinks:
echo "" >> $$i; \
done
-#@ pdf build both the PDF version
+#@ pdf build PDF version
.PHONY: pdf
pdf: $(DEP_FILE_LIST) $(METADATA)
mkdir -p $(PDFDIR)
cat $(METADATA) > $(PDFDIR)/.full_document.md
+ cat $(SRCDIR)/cover.md | $(SCRIPTS)/macros_section.sh \
+ >> $(PDFDIR)/.full_document.md
for i in $(DEP_FILE_LIST); do \
cat $$i | $(SCRIPTS)/macros_section.sh \
>> $(PDFDIR)/.full_document.md; \
@@ -70,11 +75,13 @@ pdf: $(DEP_FILE_LIST) $(METADATA)
--css=$(SRCDIR)/styles_pdf.css --self-contained \
$(PDFDIR)/.full_document.md -o $(PDFDIR)/$(PDF_OUT))
-#@ html build both the HTML version
+#@ html build HTML version
.PHONY: html
html: $(DEP_FILE_LIST) $(METADATA)
mkdir -p $(HTMLDIR)
cat $(METADATA) > $(HTMLDIR)/.full_document.md
+ cat $(SRCDIR)/cover.md | $(SCRIPTS)/macros_section.sh \
+ >> $(HTMLDIR)/.full_document.md
for i in $(DEP_FILE_LIST); do \
cat $$i | $(SCRIPTS)/macros_section.sh \
>> $(HTMLDIR)/.full_document.md; \
@@ -92,7 +99,34 @@ html: $(DEP_FILE_LIST) $(METADATA)
--css=$(SRCDIR)/styles_html.css --self-contained \
$(HTMLDIR)/.full_document.md -o $(HTMLDIR)/$(HTML_OUT))
+#@ epub build EPUB version
+.PHONY: epub
+epub: $(DEP_FILE_LIST) $(METADATA)
+ mkdir -p $(EPUBDIR)
+ cat $(METADATA) > $(EPUBDIR)/.full_document.md
+ cat $(SRCDIR)/cover_epub.md | $(SCRIPTS)/macros_section.sh \
+ >> $(EPUBDIR)/.full_document.md
+ for i in $(DEP_FILE_LIST); do \
+ cat $$i | $(SCRIPTS)/macros_section.sh \
+ >> $(EPUBDIR)/.full_document.md; \
+ echo '<!-- %PAGEBREAK% -->' \
+ >> $(EPUBDIR)/.full_document.md; \
+ done
+ $(SCRIPTS)/macros_doc.sh $(EPUBDIR)/.full_document.md
+ $(SED) -i 's/](.*\.md#/](#/' $(EPUBDIR)/.full_document.md
+ # remove the section file name from all HTML links
+ $(SED) -i 's/href=.*\.md#/href="#/' $(EPUBDIR)/.full_document.md
+ # fixup path for examples, otherwise defaults to file:///EPUB/text
+ $(SED) -i 's/](.\/notebook-examples/](file:\/\/$(EXAMPLES_EPUB)/g' \
+ $(EPUBDIR)/.full_document.md
+ [ -e $(EPUBDIR)/images ] || ln -s $(IMAGES) $(EPUBDIR)
+ [ -e $(EPUBDIR)/notebook-examples ] || ln -s $(EXAMPLES) $(EPUBDIR)
+ (cd $(EPUBDIR); $(PANDOC) $(PANDOC_OPTS) \
+ --epub-cover-image=$(SRCDIR)/images/selinux-penguin_400.png \
+ --css=$(SRCDIR)/styles_epub.css --self-contained \
+ $(EPUBDIR)/.full_document.md -o $(EPUBDIR)/$(EPUB_OUT))
+
#@ clean clean any build artifacts
.PHONY: clean
clean:
- rm -rf $(HTMLDIR) $(PDFDIR)
+ rm -rf $(HTMLDIR) $(PDFDIR) $(EPUBDIR)
@@ -1,6 +1,6 @@
# The SELinux Notebook
-
+
## Introduction
@@ -69,7 +69,8 @@ See: **<http://www.gnu.org/licenses/fdl-1.3.html>**
Logo designed by [*Máirín Duffy*](http://pookstar.deviantart.com/)
-## Building HTML/PDF Versions
+## Building HTML/PDF/EPUB Versions
-The [**BUILD.md**](BUILD.md) file has more information on building HTML and PDF
-versions of the notebook as well as alternate ways to view the source markdown.
+The [**BUILD.md**](BUILD.md) file has more information on building HTML, PDF
+and EPUB versions of the notebook as well as alternate ways to view the
+source markdown.
new file mode 100644
@@ -0,0 +1,16 @@
+<!-- %STYLESTART%(text-align:center;) -->
+
+<!-- %STYLESTART%(font-size:400%) -->
+# The SELinux Notebook
+<!-- %STYLEEND% -->
+
+<!-- %STYLESTART%(display:block;margin-left:auto;margin-right:auto;padding:2em) -->
+
+<!-- %STYLEEND% -->
+
+**<!-- %DATE% -->**
+<!-- %GITHEAD% -->
+
+<!-- %STYLEEND% -->
+
+<!-- %PAGEBREAK% -->
new file mode 100644
@@ -0,0 +1,2 @@
+**<!-- %DATE% -->**
+<!-- %GITHEAD% -->
@@ -1,3 +1,17 @@
---
title: The SELinux Notebook
+author: Originally created by Richard Haines
+subject: Security-Enhanced Linux (SELinux)
+description: |
+ Gives a description of SELinux and its major components to provide
+ Mandatory Access Control services for GNU / Linux. Hopefully it will
+ show how the SELinux components link together and how SELinux-aware
+ applications / object manager have been implemented.
+contributor: |
+ Anyone may contribute to this book, see
+ <https://github.com/SELinuxProject/selinux-notebook/blob/main/CONTRIBUTING.md>
+rights: |
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.3 or
+ any later version published by the Free Software Foundation.
---
new file mode 100644
@@ -0,0 +1,52 @@
+
+.title {
+ /* pandoc generates the h1 title with the "title" class */
+ display: none;
+}
+
+.author {
+ display: none;
+}
+
+.rights {
+ display: none;
+}
+
+html {
+ font-size: 100%;
+}
+
+a {
+ color: blue;
+}
+
+table {
+ /* limit to 95% page width */
+ min-width: 50%;
+ max-width: 95%;
+ /* combine table borders when they are adjacent */
+ border-collapse: collapse;
+}
+table th {
+ padding: 0.5em;
+ border: 1px solid black;
+ background-color: #d3d3d3;
+}
+table tr, td {
+ padding: 0.5em;
+ border: 1px solid black;
+}
+
+img {
+ /* center and limit to 95% page width */
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+ max-width: 95%;
+}
+
+pre {
+ width: 95%;
+ padding: 1em;
+ background-color: #f5f5f5;
+}
@@ -4,6 +4,14 @@
display: none;
}
+.author {
+ display: none;
+}
+
+.rights {
+ display: none;
+}
+
html {
/* 1em is specified as 16pt, 75% should be 12pt */
font-size: 100%;
@@ -48,6 +48,14 @@
display: none;
}
+.author {
+ display: none;
+}
+
+.rights {
+ display: none;
+}
+
html {
/* 1em is specified as 16pt, 75% should be 12pt */
font-size: 75%;
@@ -1,19 +1,3 @@
-<!-- %STYLESTART%(text-align:center;) -->
-
-<!-- %STYLESTART%(font-size:400%) -->
-# The SELinux Notebook
-<!-- %STYLEEND% -->
-
-<!-- %STYLESTART%(display:block;margin-left:auto;margin-right:auto;padding:2em) -->
-
-<!-- %STYLEEND% -->
-
-**<!-- %DATE% -->**
-<!-- %GITHEAD% -->
-
-<!-- %STYLEEND% -->
-
-<!-- %PAGEBREAK% -->
## Copyright Information
Build an epub document. Signed-off-by: Richard Haines <richard_c_haines@btinternet.com> --- BUILD.md | 23 +++++++++++++++----- CONTRIBUTING.md | 10 ++++----- Makefile | 48 +++++++++++++++++++++++++++++++++++------ README.md | 9 ++++---- src/cover.md | 16 ++++++++++++++ src/cover_epub.md | 2 ++ src/metadata.yaml | 14 ++++++++++++ src/styles_epub.css | 52 +++++++++++++++++++++++++++++++++++++++++++++ src/styles_html.css | 8 +++++++ src/styles_pdf.css | 8 +++++++ src/title.md | 16 -------------- 11 files changed, 169 insertions(+), 37 deletions(-) create mode 100644 src/cover.md create mode 100644 src/cover_epub.md create mode 100644 src/styles_epub.css