Add cover page and print site banner custom templates

.gitlab-ci.yml

@@ -100,6 +100,19 @@ build:doc:
       - doc/public_html/
       - doc/LdapSaisie.html
 
+build:doc:pdf:
+  stage: build
+  image:
+    name: pink33n/html-to-pdf
+    entrypoint: ["/bin/sh", "-c"]
+  needs:
+    - build:doc
+  script:
+    - /usr/local/bin/entrypoint --url file://$(pwd)/doc/LdapSaisie.html --pdf doc/LdapSaisie.pdf
+  artifacts:
+    paths:
+      - doc/LdapSaisie.pdf
+
 deploy:doc:
   stage: deploy
   image: alpine:latest
@@ -112,3 +125,4 @@ deploy:doc:
   script:
     - rsync -atv --exclude '.git*' --delete --progress ./doc/public_html/ $SSH_USER@$SSH_HOST:./
     - rsync -atv ./doc/LdapSaisie.html $SSH_USER@$SSH_HOST:LdapSaisie.html
+    - rsync -atv ./doc/LdapSaisie.pdf $SSH_USER@$SSH_HOST:LdapSaisie.pdf

doc/.gitignore

@@ -1,3 +1,4 @@
 public_html
 LdapSaisie.html
+LdapSaisie.pdf
 venv

doc/Makefile

@@ -3,12 +3,15 @@ serve: venv
 
 build: venv public_html LdapSaisie.html
 
-public_html:
+public_html: venv
 	venv/bin/mkdocs build -s
 
-LdapSaisie.html: public_html
+LdapSaisie.html: venv public_html
 	venv/bin/htmlark public_html/print_page/index.html -o LdapSaisie.html
 
+LdapSaisie.pdf: venv LdapSaisie.html
+	docker run -v $(CURDIR):/workspace pink33n/html-to-pdf --url file:///workspace/LdapSaisie.html --pdf LdapSaisie.pdf
+
 venv:
 	python3 -m venv venv
 	venv/bin/python -m pip install -r requirements.txt

doc/mkdocs.yml

@@ -1,4 +1,7 @@
 site_name: LdapSaisie
+site_description: Documentation
+site_author: Benjamin Renard <brenard@easter-eggs.com / brenard@zionetrix.net>
+copyright: Easter-eggs
 docs_dir: 'src'
 site_dir: 'public_html'
 repo_url: https://gitlab.easter-eggs.com/ee/ldapsaisie
@@ -19,7 +22,23 @@ extra:
 plugins:
   - search:
       lang: fr                                      # Set language for search
-  - print-site
+  - print-site:
+      add_to_navigation: true
+      print_page_title: 'Documentation'
+      # Table of contents
+      add_table_of_contents: true
+      toc_title: 'Table des matières'
+      toc_depth: 6
+      # Content-related
+      add_full_urls: false
+      enumerate_headings: true
+      enumerate_figures: true
+      add_cover_page: true
+      cover_page_template: "src/assets/templates/custom_cover_page.tpl"
+      print_site_banner_template: "src/assets/templates/print_site_banner.tpl"
+      path_to_pdf: ""
+      enabled: !ENV [ENABLED_PRINT_SITE, True]
+      exclude:
 
 
 nav:

doc/requirements.txt

@@ -1,7 +1,7 @@
 mkdocs
 mkdocs-material
 mdx_truly_sane_lists
-mkdocs-print-site-plugin
+mkdocs-print-site-plugin==1.3.0
 # For building all-in-one HTML file
 html5lib
 requests

doc/src/assets/templates/custom_cover_page.tpl

@@ -0,0 +1,30 @@
+
+<div style="padding-bottom: 3em">
+
+  {% if config.site_name %}
+    <h1>{{ config.site_name }}</h1>
+  {% endif %}
+
+  {% if config.site_description %}
+    <h2>{{ config.site_description }}</h2>
+  {% endif %}
+
+</div>
+
+<p>
+    <small>
+        Auteur: Benjamin Renard
+        (<a href="mailto:brenard@easter-eggs.com">brenard@easter-eggs.com</a> /
+        <a href="mailto:brenard@zionetrix.net">brenard@zionetrix.net</a>)
+    </small><br />
+
+    {% if config.site_url %}
+        <small>Site web: <a href="{{ config.site_url }}">{{ config.site_url }}</a></small><br />
+    {% endif %}
+    {% if config.repo_url %}
+        <small>Repo: <a href="{{ config.repo_url }}">{{ config.repo_url }}</a></small><br />
+    {% endif %}
+    {% if config.copyright %}
+        <small>{{ config.copyright }}</small><br />
+    {% endif %}
+</p>

doc/src/assets/templates/print_site_banner.tpl

@@ -0,0 +1,8 @@
+<p>
+  Cette page contient l'ensemble de la documentation du projet LdapSaisie et est adaptée pour une
+  impression papier ou PDF.
+</p>
+
+<p>
+  <em>Note : Cette boîte n'apparaîtra pas à l'impression.</em>
+</p>

doc/src/conf/global/ldap/index.md

@@ -21,6 +21,7 @@ $GLOBALS['LSconfig'] = array(
           '[object type 1]',
           '[object type 2]' => array(
             'filter' => '[LDAP filter]',
+            'filter_function' => [callable],
             'password_attribute' => '[attribute name]',
             'web_access' => [booléen],
             'api_access' => [booléen],
@@ -124,6 +125,20 @@ $GLOBALS['LSconfig'] = array(
       identifiant. Exemple de valeur : `(|(uid=%{user})(mail=%{user}))`.
       *Paramètre facultatif, filtre par défaut composé à l'aide de l'attribut RDN.*
 
+    - `filter_function`
+
+      *Callable* (au sens PHP) utilisé pour filtrer les utilisateurs trouvés dans l'annuaire à
+      partir des autres paramètres : cette fonction, si elle est définie, sera appelée pour chaque
+      utilisateur trouvé, avec pour unique paramètre, une référence à l'objet LDAP correspondant
+      (`LSldapObject`). Cette méthode devra alors retourner `true` ou `false` pour respectivement
+      autoriser ou interdire l'accès à l'application à l'utilisateur.
+
+      !!! note
+
+          Si un utilisateur est exclus par cette méthode et qu'aucun autre utilisateur correspondant
+          n'a été trouvé dans l'annuaire, une page d'erreur sera affichée et indiquera que l'accès à
+          l'application est refusée.
+
     - `password_attribute`
 
       Nom de l'attribut stockant le mot de passe de ce type