Skip to content
Snippets Groups Projects
Commit c2a334f5 authored by Boris's avatar Boris
Browse files

DOC: update readmes

parent ff0137f8
Branches
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
LISEZ-MOI.md
+ 43
− 69
View file @ c2a334f5
Cesium website Cesium website
=== ===
## Le pourquoi du comment
Cet ensemble de scripts a pour but de rendre la modification du site cesium.app accessible à tout un chacun.
Ce qui était autrefois fait avec un CMS est maintenant fait avec ce script maison, ce qui présente les avantages suivants :
* Le site est installable par n'importe qui n'importe où, ce qui :
* nous rend plus résilient en cas de problème
* diminue le bus factor
* Mise à jour facilitée :
* au changement de version de l'appli Cesium, chaque contributeur du GitLab peut dorénavant faire un commit pour modifier le fichier cesiumVersions.php
* chacun peut participer à l'amélioration du tutoriel (ou même du site en général)
* Traductions facilitée :
* alors que la traduction avec le CMS générait des pertes d'informations lors d'une mise à jour, le script maison résoud ce problème en utilisant des fichiers .po
* pour le tutoriel, les traductions sont indépendantes ; on n'est donc pas obligé de faire de la traduction phrase par phrase ; on peut avoir des tutoriels organisés totalement différemment d'une langue à l'autre
* Les captures d'écran sont aussi adaptées en fonction de la langue du visiteur
* Chargement plus rapide
* Personnalisation du style facilitée par un code complètement sémantique (pas de classes à la Twitter-boostrap).
* Edition facilitée : adieu le WYSIWYG laborieux de l'ancien CMS
* Chargement plus rapide, grâce à un code plus léger et optimisé à nos besoins.
Il est possible que courant 2020 ces scripts PHP soient remplacés par un générateur de site statiques (SSG) type Pelican.
## Comment contribuer ## Comment contribuer
### Comment mettre à jour les liens de téléchargement ### Comment mettre à jour les liens de téléchargement
...@@ -34,7 +11,7 @@ Si ceux-ci étaient amenés à changer d'emplacement, veuillez mettre à jour [l ...@@ -34,7 +11,7 @@ Si ceux-ci étaient amenés à changer d'emplacement, veuillez mettre à jour [l
### Comment traduire le tutoriel ### Comment traduire le tutoriel
Pour le tutoriel, vous trouverez les fichiers .html dans les dossiers type `i18n/es_ES/contents/tuto/` Pour le tutoriel, vous trouverez les fichiers .html dans les dossiers type `i18n/es_ES/contents/tuto/` (où `es_ES` est la langue qui vous intéresse).
#### Comment formatter les URLs dans le menu #### Comment formatter les URLs dans le menu
...@@ -76,29 +53,9 @@ Aussi : utiliser 4 espaces consécutifs en guise d'indentation est une déviance ...@@ -76,29 +53,9 @@ Aussi : utiliser 4 espaces consécutifs en guise d'indentation est une déviance
J'ai remarqué que pour les instructions dans un tuto, souvent une liste ordonnée <ol></ol> rend mieux J'ai remarqué que pour les instructions dans un tuto, souvent une liste ordonnée <ol></ol> rend mieux
qu'une liste non-ordonnée <ul></ul> qu'une liste non-ordonnée <ul></ul>
#### Soyons sémantiques !
Écrivons à la mode XHTML :
* un slash à la fin de nos balises <img />
* un slash à la fin de nos balises <br />
Des éditeurs comme Notepadqq (Linux) nous permettent de répérer facilement la
présence de balises non fermées (votre code est coloré diféremment).
Niveau HTML :
* [C'est pas interdit](https://developer.mozilla.org/fr/docs/Web/HTML/Element/li#R%C3%A9sum%C3%A9_technique)
de mettre des <p> (contenu de flux) dans des <li>, mais c'est rare que ce soit vraiment nécessaire.
Généralement le résultat que vous cherchez s'obtient mieux en CSS.
Si un truc rend moche, bidouillez les fichiers .css ou demandez-moi de le faire plutôt
que de rajouter des balises surnuméraires (genre plutôt que de mettre des >p> ou des >br/> pour créer des marges,
utilisons la propriété CSS dédiée, *margin*).
### Comment modifier les images ### Comment modifier les images
C'est dans `i18n/es_ES/contents/tuto/` C'est dans `i18n/es_ES/contents/tuto/` (où `es_ES` est la langue qui vous intéresse).
Pour des questions de SEO, les noms des fichiers sont traduits, via les fichiers .po Pour des questions de SEO, les noms des fichiers sont traduits, via les fichiers .po
...@@ -116,22 +73,6 @@ les modifications sont à faire dans les fichiers .po que vous trouverez dans le ...@@ -116,22 +73,6 @@ les modifications sont à faire dans les fichiers .po que vous trouverez dans le
Ces fichiers sont éditables avec des logiciels type PoEdit. Ces fichiers sont éditables avec des logiciels type PoEdit.
## Licences
Ce logiciel est pour sa majeure partie sous licence GNU GPL 3.0.
Aux exceptions suivantes :
- Le script Funding.class.php est basé sur la [barre de financement intégrable](https://git.duniter.org/paidge/barre-de-financement-int-grable), elle-même sous licence GNUL GPL 3.
- [Composer](https://getcomposer.org/) est sous licence MIT.
- [GeoIP2](https://maxmind.github.io/GeoIP2-php/) est la création de by MaxMind est distribué sous licence Apache
- Les [bases de données GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) sont la création de MaxMind et sont sous licence Creative Commons Attribution-ShareAlike 4.0 International.
- Le script [LazyImg](https://github.com/colas31/lazyImg), dont la licence est inconnue.
- [Font-Awesome](https://fontawesome.com/license/free) est sous licence libre ([voir détail](https://fontawesome.com/license/free))
- Les photos, qui sont la propriété de leurs auteurs
- Le logo Cesium est la création de DiG
## Instructions d'installation ## Instructions d'installation
### .htaccess ### .htaccess
...@@ -141,7 +82,11 @@ Votre fichier .htaccess doit contenir les infos suivantes : ...@@ -141,7 +82,11 @@ Votre fichier .htaccess doit contenir les infos suivantes :
``` ```
<IfModule mod_rewrite.c> <IfModule mod_rewrite.c>
RewriteEngine On RewriteEngine On
RewriteBase /www/cesium-website/
# Adaptez la ligne suivante à votre configuration (avec un slash à la fin)
RewriteBase /cesium-website-project/cesium_website/
RewriteOptions InheritDown
RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-d
...@@ -150,20 +95,49 @@ RewriteRule .*\.php - [L] ...@@ -150,20 +95,49 @@ RewriteRule .*\.php - [L]
RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^([^/]+)/(.*)$ index.php?lang=$1&page=/$2 [L] RewriteRule ^([^/]+)/(.*)$ index.php?lang=$1&page=/$2 [L]
# Redirections pour gérer l'ancienne structure de liens sans perdre en SEO
# (ex : /telechargement au lieu de /fr/telechargement)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^([^/]+)$ fr/$1 [R=301]
</IfModule> </IfModule>
``` ```
Modifiez l'instruction RewriteBase du .htaccess pour qu'elle s'accorde à votre propre configuration Modifiez l'instruction RewriteBase du .htaccess pour qu'elle s'accorde à votre propre configuration
(tapez l'endroit où CesiumWebsite est installé, typiquement /) (tapez l'endroit où CesiumWebsite est installé, typiquement /)
Si lorsque vous essayez d'accéder au site, vous avez une erreur "404 Not Found", c'est que votre fichier `.htaccess` n'est pas pris en considération par Apache.
Il vous faudra alors éditer votre fichier `/etc/apache2/apache2.conf` (anciennement `/etc/apache2/httpd.conf`) pour y remplacer :
```
<Directory /var/www/>
Options Indexes FollowSymLinks
AllowOverride None
Require all granted
</Directory>
```
par :
```
<Directory /var/www/>
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
</Directory>
```
### config.php ### config.php
Modifiez la variable $rootURL de la même façon. Modifiez la variable $rootURL de la même façon.
## Licences
Ce logiciel est pour sa majeure partie sous licence GNU GPL 3.0.
Aux exceptions suivantes :
- Le script Funding.class.php est basé sur la [barre de financement intégrable](https://git.duniter.org/paidge/barre-de-financement-int-grable), elle-même sous licence GNUL GPL 3.
- [Composer](https://getcomposer.org/) est sous licence MIT.
- [GeoIP2](https://maxmind.github.io/GeoIP2-php/) est la création de by MaxMind est distribué sous licence Apache
- Les [bases de données GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) sont la création de MaxMind et sont sous licence Creative Commons Attribution-ShareAlike 4.0 International.
- Le script [LazyImg](https://github.com/colas31/lazyImg), dont la licence est inconnue.
- [Font-Awesome](https://fontawesome.com/license/free) est sous licence libre ([voir détail](https://fontawesome.com/license/free))
- Les photos, qui sont la propriété de leurs auteurs
- Le logo Cesium est la création de DiG
\ No newline at end of file
README.en.md
+ 50
− 1
View file @ c2a334f5
...@@ -3,5 +3,54 @@ Cesium website ...@@ -3,5 +3,54 @@ Cesium website
## Install notes ## Install notes
Modify RewriteBase directive in .htaccess according to your own configuration (set RewriteBase to be the URI where CesiumWebsite is installed, typically /). ### .htaccess
Create a .htaccess in cesium_website directory, with the following text :
```
<IfModule mod_rewrite.c>
RewriteEngine On
# Adaptez la ligne suivante à votre configuration (avec un slash à la fin)
RewriteBase /cesium-website-project/cesium_website/
RewriteOptions InheritDown
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule .*\.php - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^([^/]+)/(.*)$ index.php?lang=$1&page=/$2 [L]
</IfModule>
```
Edit RewriteBase directive to match your own setup.
If, when trying to access the site, you get a "404 Not Found" error, this means your `.htaccess` file is not taken into account by Apache.
You will then need to edit `/etc/apache2/apache2.conf` file and replace :
```
<Directory /var/www/>
Options Indexes FollowSymLinks
AllowOverride None
Require all granted
</Directory>
```
with :
```
<Directory /var/www/>
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
</Directory>
```
### config.php
In ̀`config.php`, edit $rootURL var according to your setup.
config.php
+ 2
− 1
View file @ c2a334f5
...@@ -17,7 +17,8 @@ $legalNotice = ...@@ -17,7 +17,8 @@ $legalNotice =
// Trouver une façon de définir $rootURL sans faire ça : // Trouver une façon de définir $rootURL sans faire ça :
if ($_SERVER['SERVER_NAME'] == 'localhost') { if ($_SERVER['SERVER_NAME'] == 'localhost') {
$rootURL = '/www/cesium_website'; // Adaptez la ligne suivante à votre configuration (sans slash à la fin)
$rootURL = '/cesium-website-project/cesium_website';
} else { } else {
$rootURL = ''; $rootURL = '';
} }
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment