Merge pull request #1541 from YunoHost/grav-enh

[Grav] Small enhancements

config/themes/yunohost-docs.yaml

@@ -1,11 +1,17 @@
+streams:
+  schemes:
+    theme:
+      type: ReadOnlyStream
+      prefixes:
+        '': [user/themes/yunohost-docs, user/themes/learn4]
 enabled: true
 production-mode: false
 grid-size: grid-xl
 github:
   note: false
   link: true
-  tree: https://github.com/yunohost/doc/blob/grav/
-  commits: https://github.com/yunohost/doc/commits/grav/
+  tree: 'https://github.com/yunohost/doc/blob/grav/'
+  commits: 'https://github.com/yunohost/doc/commits/grav/'
 spectre:
   exp: false
   icons: false

pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.md

@@ -52,6 +52,6 @@ You can host your friends, your family and your company safely and with ease, bu
 Black and white YunoHost PNG logo by ToZz (400 × 400 px):
 
 [![](image://ynh_logo_black_300dpi.png?resize=220)](image://ynh_logo_black_300dpi.png)
-[![](image://ynh_logo_white_300dpi.png?resize=220)](image://ynh_logo_white_300dpi.png)
+[![](image://ynh_logo_white_300dpi.png?resize=220&id=whitelogo)](image://ynh_logo_white_300dpi.png)
 
 Licence: CC-BY-SA 4.0

pages/01.administrate/01.selfhosting/02.tryyunohost/try.md

@@ -11,13 +11,14 @@ routes:
 
 [center]
 [columns]
-[<i class="fa fa-user"></i> User interface](https://demo.yunohost.org/?target=_blank&classes=btn,btn-lg,btn-success)  
+[[fa=user /] User interface](https://demo.yunohost.org/?target=_blank&classes=btn,btn-lg,btn-success)  
 Username: demo  
 Password: demo
 
-[<i class="fa fa-user"></i> Administration interface](https://demo.yunohost.org/yunohost/admin?target=_blank&classes=btn,btn-lg,btn-primary)  
-Password: demo</p>
+[[fa=cog /] Administration interface](https://demo.yunohost.org/yunohost/admin/?target=_blank&classes=btn,btn-lg,btn-primary)  
+Password: demo
+
 [/columns]
 [/center]
 
-!!! **Demo server gracefully provided by [Gitoyen](https://www.gitoyen.net?target=_blank)**
+!!!! **Demo server gracefully provided by [Gitoyen](https://www.gitoyen.net?target=_blank) [fa=heart /]**

pages/01.administrate/01.selfhosting/03.howtohostyourself/howtohostyourself.md

@@ -14,7 +14,7 @@ You can host yourself at home (on a small computer), or on a remote server. Each
 You can host yourself at home with an ARM board or a re-purposed regular computer, connected to your home router/box. 
 
 - **Pros**  : you will have physical control of the machine and only need to buy the hardware;
-- **Cons**  : you will have to [manually configure your internet box](/administrate/postinstall/ispbox) and [might be limited by your ISP](/administrate/advance/isp).
+- **Cons**  : you will have to [manually configure your internet box](/isp_box_config) and [might be limited by your ISP](/isp).
 
 ### At home, behind a VPN
 

pages/01.administrate/03.postinstall/01.isp_box_config/isp_box_config.es.md

@@ -5,9 +5,17 @@ taxonomy:
     category: docs
 routes:
   default: '/isp_box_config'
+  aliases:
+    - '/port_forwarding'
 ---
 
-Si te estás auto-alojando en casa y sin VPN, tienes que redirigirse los puertos de tu router (caja/box). Si quieres una explicación sencilla de lo que es y por qué necesitas redirigir los puertos, puedes echar un vistazo a [esta página](/port_forwarding). [Esta página](https://www.testdevelocidad.es/configuraciones/abrir-correctamente-los-puertos-router/) también propone explicaciones detalladas sobre el funcionamiento de los puertos, y las etapas de configuración para un router genérico.
+Si te estás auto-alojando en casa y sin VPN, tienes que redirigirse los puertos de tu router (caja/box).
+
+El esquema aquí abajo intenta explicar brevemente el rol de la redirección de los puertos durante la instalación de un servidor en tu casa.
+
+[figure caption="Ilustración de la importancia del redirección de puertos"]![](image://portForwarding_en.png)[/figure]
+
+[Esta página](https://www.testdevelocidad.es/configuraciones/abrir-correctamente-los-puertos-router/) también propone explicaciones detalladas sobre el funcionamiento de los puertos, y las etapas de configuración para un router genérico.
 
 ### 0. Diagnosticar los puertos abiertos
 

pages/01.administrate/03.postinstall/01.isp_box_config/isp_box_config.fr.md

@@ -5,9 +5,15 @@ taxonomy:
     category: docs
 routes:
   default: '/isp_box_config'
+  aliases:
+    - '/port_forwarding'
 ---
 
-Si vous vous auto-hébergez à la maison et sans VPN, il vous faut rediriger les ports de votre routeur ("machin-box"). Si vous souhaitez une explication courte de ce qu'est et pourquoi vous avez besoin de rediriger les ports, vous pouvez jeter un œil à [cette page-ci](/port_forwarding). [Cette page-là](https://craym.eu/tutoriels/utilitaires/ouvrir_les_ports_de_sa_box.html) propose également des explications détaillées sur le fonctionnement des ports, et les étapes de configuration pour différents routeurs.
+Si vous vous auto-hébergez à la maison et sans VPN, il vous faut rediriger les ports de votre routeur ("machin-box"). Le schéma ci-dessous tente d'expliquer brièvement le rôle de la redirection des ports lors de la mise en place d'un serveur à la maison.
+
+[figure caption="Illustration de l'importance de la redirection des ports"]![](image://portForwarding_fr.png)[/figure]
+
+[Cette page](https://craym.eu/tutoriels/utilitaires/ouvrir_les_ports_de_sa_box.html) propose également des explications détaillées sur le fonctionnement des ports, et les étapes de configuration pour différents routeurs
 
 ### 0. Diagnostiquer les ports ouverts
 

pages/01.administrate/03.postinstall/01.isp_box_config/isp_box_config.md

@@ -5,9 +5,13 @@ taxonomy:
     category: docs
 routes:
   default: '/isp_box_config'
+  aliases:
+    - '/port_forwarding'
 ---
 
-If you are self-hosting at home and without a VPN, you need to forward ports on your home router ("Internet box"). If you want a short explanation on what is and why you need port forwarding, have a look to [this page](/port_forwarding).
+If you are self-hosting at home and without a VPN, you need to forward ports on your home router ("Internet box"). The sketch below tries to briefly summarize the role and necessity of port forwarding when setting up a server at home.
+
+[figure caption="Illustration of the importance of port-forwarding"]![](image://portForwarding_en.png)[/figure]
 
 ### 0. Diagnose ports opened
 
@@ -16,7 +20,7 @@ correctly exposed.
 
 ### 1. Access your box/router administration interface
 
-Your box/router admin interface is usually reachable via http://192.168.0.1 or http://192.168.1.1. Then, you will probably need to authenticate yourself with your internet server provider's credentials.
+Your box/router admin interface is usually reachable via [http://192.168.0.1](http://192.168.0.1) or [http://192.168.1.1](http://192.168.1.1). Then, you will probably need to authenticate yourself the credentials given by your internet server provider.
 
 ### 2. Find the local IP of your server
 

pages/01.administrate/03.postinstall/01.ispbox/01.post_forwarding/port_forwarding.es.md

@@ -1,12 +0,0 @@
----
-title: Redirección de puertos
-template: docs
-taxonomy:
-    category: docs
-routes:
-  default: '/port_forwarding'
----
-
-El esquema aquí abajo intenta explicar brevemente el rol de la redirección de los puertos durante la instalación de un servidor en tu casa.
-
-![](image://portForwarding_en.png)

pages/01.administrate/03.postinstall/01.ispbox/01.post_forwarding/port_forwarding.fr.md

@@ -1,13 +0,0 @@
----
-title: Redirection de ports
-template: docs
-taxonomy:
-    category: docs
-routes:
-  default: '/port_forwarding'
----
-
-Le schéma ci-dessous tente d'expliquer brièvement le rôle de la redirection des
-ports lors de la mise en place d'un serveur à la maison.
-
-![](image://portForwarding_fr.png)

pages/01.administrate/03.postinstall/01.ispbox/01.post_forwarding/port_forwarding.md

@@ -1,13 +0,0 @@
----
-title: Port forwarding
-template: docs
-taxonomy:
-    category: docs
-routes:
-  default: '/port_forwarding'
----
-
-The sketch below tries to briefly summarize the role and necessity of port
-forwarding when setting up a server at home.
-
-![](image://portForwarding_en.png)

pages/01.administrate/03.postinstall/postinstall.md

@@ -9,7 +9,7 @@ routes:
 
 The step called "**post-installation**" is actually the initial configuration of YunoHost. It has to be done just after the installation of the system itself.
 
-NB: if you are in the process of restoring a server from scratch **and** you have a yunohost-made backup, you can skip this process and follow through with the "restoring during the postinstall" step, in the [backup](/backup) page.
+! If you are in the process of restoring a server from scratch **and** you have a yunohost-made backup, you can skip this process and follow through with the "restoring during the postinstall" step, in the [backup](/backup) page.
 
 ### From the web interface
 
@@ -21,21 +21,16 @@ During the first visit, you will very likely encounter a security warning relate
 
 You should then land on this page :
 
-![](image://postinstall_web.png)
-
-<em><p class="text-muted">Preview of the Web post-installation</p></em>
+[figure caption="Preview of the Web post-installation"]![](image://postinstall_web.png)[/figure]
 
 ### From the command line
 
 You can also perform the postinstallation with the command `yunohost tools postinstall` directly on the server, or [via SSH](/ssh).
 
-![](image://postinstall_cli.png)
 
-<em><p class="text-muted">Preview of the command-line post-installation</p></em>
+[figure caption="Preview of the command-line post-installation"]![](image://postinstall_cli.png)[/figure]
 
-<br>
-
-## Informations asked
+## Asked information
 
 ### Main domain
 

pages/01.administrate/04.learn/12.security/security.md

@@ -15,16 +15,16 @@ Two things remain important to note:
 
 * The fact that YunoHost is a well-spread software increases the chances of an attack. If a flaw is discovered, it could potentially affect all the YunoHost instances at once. Keep your system **up-to-date** to remain safe.
 
-*If you need advice, do not hesitate to [ask us](/help).*
+!!!! If you need advice, do not hesitate to [ask us](/help).
 
-*To discuss security flaws, contact the [YunoHost security team](/security_team).*
+!! [fa=shield /] To discuss security flaws, contact the [YunoHost security team](/security_team).
 
 ---
 
 ## Improve security
 If your YunoHost server is used in a critical production environment, or if you want to improve its safety, you may want to follow those good practices.
 
-**Attention:** *Following those instructions requires advanced knowledge of system administration.*
+! **Attention:** Following those instructions requires advanced knowledge of system administration.
 
 ### SSH authentication via key
 By default, the SSH authentication uses the administration password. Deactivating this kind of authentication and replacing it by a key mechanism is advised.

pages/01.administrate/04.learn/13.permissions/groups_and_permissions.md

@@ -176,7 +176,7 @@ $ yunohost user permission update mail --remove all_users --add bob
 
 Note that some permissions may be "protected", meaning that you won't be able to add/remove the visitor group to this permission. Generally, this is because it would make no sense (or is a security risk) to do so.
 
-The webadmin will issue a warning if you set a permission that is superseeded by a wider permission.
+The webadmin will issue a warning if you set a permission that is superseded by a wider permission.
 
 ![](image://groups_alerte-permission.png)
 

pages/01.administrate/05.specific_use_cases/01.domains/01.dns_nohost_me/dns_nohost_me.md

@@ -4,7 +4,7 @@ template: docs
 taxonomy:
     category: docs
 routes:
-  default: '/dns_nohost'
+  default: '/dns_nohost_me'
 ---
 
 In order to make self-hosting as accessible as possible, the YunoHost Project provides a *free* and *automatically configured* domain name service. By using this service, you won't have to [configure DNS records](/dns_config) yourself, which can be tedious and technical.
@@ -16,7 +16,7 @@ The following (sub)domains are proposed:
 
 To use this service, you simply have to choose such a domain during the post-installation. It will then be automatically configured by YunoHost!
 
-N.B.: As a fairness measure, each instance may only have **one such domain** setup at any given time.
+!!! As a fairness measure, each instance may only have **one such domain** setup at any given time.
 
 ### Subdomains
 
@@ -56,8 +56,7 @@ If you reinstall your server and want to use a domain already used previously, y
 
 If you wish to use a different automatic domain, you first have to remove your present domain registration. This is done in 3 steps:
 
-1. Remove the domain from your instance (via webadmin or the `yunohost domain remove` CLI). 
-**/!\ Caution: this will remove any app installed on this domain, along with its data.**
+1. Remove the domain from your instance (via webadmin or the `yunohost domain remove` in the CLI). 
 2. Ask for registration removal [in the dedicated forum thread](https://forum.yunohost.org/t/nohost-domain-recovery/442).
 3. Remove automatic domain configuration files on your server, via CLI only: `sudo rm /etc/cron.d/yunohost-dyndns && sudo rm -r /etc/yunohost/dyndns`
 

pages/01.administrate/05.specific_use_cases/01.domains/02.dns_dynamic_ip/dns_dynamicip.md

@@ -13,6 +13,13 @@ This tutorial aim to get around dynamic IP issue which is: when the IP public ad
 
 The method proposed here consists of automatizing the fact the box annonces its global IP adress change to the dynamic DNS, so that the DNS zone will automatically be updated.
 
+Here are some examples of registrars, companies where you can buy domain names:
+* [OVH](http://ovh.com/)
+* [GoDaddy](https://godaddy.com/)
+* [Gandi](http://gandi.net/)
+* [Namecheap](https://www.namecheap.com/)
+* [BookMyName](https://www.bookmyname.com/)
+
 If you own a domain name at **OVH**, you may go to step 4 and follow this [tutorial](/OVH), given that OVH proposes a DynDNS service.
 
 #### 1. Create an account to a Dynamic DNS service
@@ -34,7 +41,12 @@ This step consists in declaring to your [registrar](/registrar) that the DNS ser
 
 For this, fisrt declare in the NS field(s) the IP address provided by the DynDNS service.
 
-Then, remove any other item in the [DNS zones](/dns_config) (except the previous NS fields), from the [registrar](/registrar).
+Then, remove any other item in the [DNS zones](/dns_config) (except the previous NS fields), from the registrar. Here are from examples of registrars:
+* [OVH](http://ovh.com/)
+* [GoDaddy](https://godaddy.com/)
+* [Gandi](http://gandi.net/)
+* [Namecheap](https://www.namecheap.com/)
+* [BookMyName](https://www.bookmyname.com/)
 
 #### 4. Configure the client
 This client could be your ISP-box, or a package installed on your server, such as `ddclient`.

pages/01.administrate/05.specific_use_cases/05.external_storage/external_storage.md

@@ -62,7 +62,7 @@ Check with `lsblk` that your disk really does contain a single partition.
 
 Before you can use your disk it has to be formatted.
 
-You should be aware that **formating a drive implies to erasing every data on it !** If your disk is already "clean", you may ignore this step.
+! You should be aware that **formating a drive implies to erasing every data on it!** If your disk is already "clean", you may ignore this step.
 
 To format the partition :
 

pages/01.administrate/05.specific_use_cases/09.certificate_custom/certificate_custom.md

@@ -7,7 +7,7 @@ routes:
   default: '/certificate_custom'
 ---
 
-**Note:** since version 2.5, YunoHost integrates Let's Encrypt certificates automated management. You can easily and freely [install a Let's Encrypt certificate](/certificate). The following document describes the steps for installing a paid certificate from a certification authority (**Gandi**, **RapidSSL**, **StartSSL**, **Cacert**).
+! **Note:** since version 2.5, YunoHost integrates Let's Encrypt certificates automated management. You can easily and freely [install a Let's Encrypt certificate](/certificate). The following document describes the steps for installing a paid certificate from a certification authority (**Gandi**, **RapidSSL**, **StartSSL**, **Cacert**).
 
 Some changes have taken place which impact the procedures indicated below:
 

pages/01.administrate/05.specific_use_cases/11.moving_app_folder/moving_app_folder.md

@@ -9,9 +9,7 @@ routes:
 
 Applications folder are (*usually*) located in `/var/www/$appname`
 
-If an application folder is expected to get bigger because of the amount of data
-it contains, it might be relevant to move it to another storage (like an
-external hard drive).
+If an application folder is expected to get bigger because of the amount of data it contains, it might be relevant to move it to another storage (like an external hard drive).
 
 Here's a summary of how to do this the application wordpress. Here, is is assumed that
 [you already mounted the external hard-drive](/external_storage).

pages/01.administrate/05.specific_use_cases/specific_use_cases.md

@@ -0,0 +1,10 @@
+---
+title: Specific use cases
+template: docs
+taxonomy:
+    category: docs
+routes:
+  default: '/specific_use_cases'
+---
+
+In the following pages you will find tutorials for specific use cases.

themes/learn2-git-sync/CHANGELOG.md

@@ -1,8 +1,26 @@
+# v1.6.2
+## 01/26/2021
+
+1. [](#improved)
+    * Updated theme blueprints for Grav 1.7
+
+# v1.6.1
+## 01/15/2021
+
+1. [](#new)
+    * GoogleSlides shortcode updated to handle double `_` characters in URL (thanks @GeorgesPapas)
+
+# v1.6.0
+## 01/05/2021
+
+1. [](#new)
+    * Initial NextGen Editor support for GoogleSlides, H5P and PDF shortcodes
+
 # v1.5.9
 ## 05/19/2020
 
 1. [](#improved)
-    * Updated inherited theme file paths for multisite compatibility (thanks to @tituspijean for the PR!)
+    * Updated inherited theme file paths for multisite compatibility (thanks to @tituspijean for the PR and @mahagr for the debugging!)
 
 # v1.5.8
 ## 12/05/2019

themes/learn2-git-sync/blueprints.yaml

@@ -1,5 +1,7 @@
 name: Learn2 Git Sync
-version: 1.5.9
+type: theme
+slug: learn2-git-sync
+version: 1.6.2
 description: "A customized version of the Learn2 theme for use with the Learn2 with Git Sync skeleton package. Includes selectable visual styles."
 icon: git
 author:

themes/learn2-git-sync/learn2-git-sync.php

@@ -17,11 +17,29 @@ class Learn2GitSync extends Learn2
         return [
             'onTwigInitialized' => ['onTwigInitialized', 0],
             'onThemeInitialized' => ['onThemeInitialized', 0],
+            'onShortcodeHandlers' => ['onShortcodeHandlers', 0],
             'onTwigSiteVariables' => ['onTwigSiteVariables', 0],
-            'onTNTSearchIndex' => ['onTNTSearchIndex', 0]
+            'onTNTSearchIndex' => ['onTNTSearchIndex', 0],
+            'registerNextGenEditorPlugin' => ['registerNextGenEditorPluginShortcodes', 0]
         ];
     }
 
+    public function onShortcodeHandlers()
+    {
+        $this->grav['shortcode']->registerAllShortcodes('user://themes/learn2-git-sync/shortcodes');
+    }
+
+    public function registerNextGenEditorPluginShortcodes($event) {
+        $plugins = $event['plugins'];
+
+        $plugins['js'][] = 'user://themes/learn2-git-sync/nextgen-editor/shortcodes/googleslides.js';
+        $plugins['js'][] = 'user://themes/learn2-git-sync/nextgen-editor/shortcodes/h5p.js';
+        $plugins['js'][] = 'user://themes/learn2-git-sync/nextgen-editor/shortcodes/pdf.js';
+
+        $event['plugins']  = $plugins;
+        return $event;
+    }
+
     public function onTwigSiteVariables()
     {
         if ($this->isAdmin() && ($this->grav['config']->get('plugins.shortcode-core.enabled'))) {

themes/learn2-git-sync/templates/partials/search.html.twig

@@ -8,6 +8,6 @@
 {% endif %}
 {% if config.plugins.tntsearch.enabled %}
   <div class="adv-search">
-    <i class="fa fa-sliders"></i> <a href="{{ base_url_absolute }}/search">{{ 'THEME_LEARN2_ADVANCED_SEARCH'|t }}</a>
+    <i class="fa fa-sliders"></i> <a href="{{ base_url_absolute }}/tntsearch">{{ 'THEME_LEARN2_ADVANCED_SEARCH'|t }}</a>
   </div>
 {% endif %}

themes/learn2/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v1.8.1
+## 01/15/2021
+
+1. [](#improved)
+    * Fixed autoescaping in preparation for Grav 1.7
+
 # v1.8.0
 ## 03/21/2019
 

themes/learn2/blueprints.yaml

@@ -1,5 +1,7 @@
 name: Learn2
-version: 1.8.0
+slug: learn2
+type: theme
+version: 1.8.1
 description: "Learn2 is a new modern documentation theme for Grav"
 icon: book
 author:

themes/learn2/templates/chapter.html.twig

@@ -3,7 +3,7 @@
 {% block content %}
 	<div id="chapter">
     	<div id="body-inner">
-			{{ page.content }}
+			{{ page.content|raw }}
 		</div>
     </div>
 {% endblock %}

themes/learn2/templates/error.html.twig

@@ -8,7 +8,7 @@
     	<div id="body-inner">
     		<h1>{{ 'PLUGIN_ERROR.ERROR'|t }} {{ header.http_response_code }}</h1>
 
-            {{ page.content }}
+            {{ page.content|raw }}
 
 		</div>
     </div>

themes/learn2/templates/partials/page.html.twig

@@ -1,6 +1,6 @@
 <div id="body-inner">
     <h1>{{ page.title }}</h1>
     <p>
-    	{{ page.content }}
+    	{{ page.content|raw }}
     </p>
 </div>

themes/learn2/templates/partials/sidebar.html.twig

@@ -62,7 +62,7 @@
                     class="fa fa-fw fa-history"></i> {{ 'THEME_LEARN2_CLEAR_HISTORY'|t }}</a><br/>
 
         <section id="footer">
-            <p>{{ 'THEME_LEARN2_BUILT_WITH_GRAV'|t }}</p>
+            <p>{{ 'THEME_LEARN2_BUILT_WITH_GRAV'|t|raw }}</p>
         </section>
     </div>
 </div>

themes/learn2/templates/search.html.twig

@@ -1,7 +1,7 @@
 {% embed 'partials/base.html.twig' with { github_link_position: false } %}
 
     {% block content %}
-        {{ page.content }}
+        {{ page.content|raw }}
 
         {% include 'partials/tntsearch.html.twig' with { in_page: true, placeholder: "Search the Grav documentation..." }%}
     {% endblock %}

themes/yunohost-docs/css/custom.css

@@ -28,6 +28,14 @@ img.center {
  margin-right: auto;
 }
 
+figure img {
+ margin: auto;
+}
+
+figure figcaption {
+ font-style: italic;
+}
+
 .flex-container {
  display: flex;
  justify-content: space-around;
@@ -36,7 +44,7 @@ img.center {
 .flex-child {
  display: inline-flex;
  text-align: center;
-}  
+}
 
 .nomargin * {
  margin: 0px auto;
@@ -74,3 +82,8 @@ h1, h2, h3, h4, h5, h6 {
     font-weight: 700;
     font-style: normal;
 }
+
+img#whitelogo {
+    background-color: gray;
+    padding: 10px;
+}