Compare revisions

.htaccess

.idea

robots.txt

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 mettre à jour les liens de téléchargement

Lors d'une mise à jour de Cesium, il suffit de mettre à jour [le fichier cesiumVersions.php](cesiumVersions.php) pour que les liens de téléchargement soient automatiquement mis à jour.

Si ceux-ci étaient amenés à changer d'emplacement, veuillez mettre à jour [le fichier cesiumDownloads.php](cesiumDownloads.php)

### Comment traduire le tutoriel

Pour le tutoriel, vous trouverez les fichiers .html dans les dossiers type `i18n/es_ES/contents/tuto/`

#### Comment formatter les URLs dans le menu

Il vous faudra aussi modifier le fichier `menu.html`

Dans le menu, les URLs doivent avoir la forme suivante : 

```html

<ul>

	<li>

		<a href="item">Item</a>

	</li>

	<li>

		<a href="item/">Item</a>

		<!-- Ira chercher le index.html du dossier -->

		<ul>

			<li><a href="item/sous-item">Sous-item</a></li>

		</ul>

	</li>

</ul>

````

Ici, slash ou pas slash, ça compte : 

* **un slash** de fin pour un **dossier** (va chercher le index.html à la racine du dossier)

* **pas de slash** de fin pour un **fichier** (va chercher le .html correspondant)

#### Comment formatter les URLs dans les fichiers

Chaque URLs est relative au fichier dans lequel on l'écrit.

#### Comment rendre notre code clair pour les autres

Efforçons-nous d'aérer au maximum votre code HTML, afin qu'il soit facilement lisible par tous et donc rapidement modifiable.

Aussi : utiliser 4 espaces consécutifs en guise d'indentation est une déviance ainsi qu'une perversion.

#### Comment faire en sorte que le contenu soit lisible pour le visiteur

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>

#### 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

C'est dans `i18n/es_ES/contents/tuto/`

Pour des questions de SEO, les noms des fichiers sont traduits, via les fichiers .po

### Comment traduire le reste

Pour les pages :

- Accueil

- Fonctionnalités

- Téléchargement

- ...et les menu de l'entête et du pied de page

les modifications sont à faire dans les fichiers .po que vous trouverez dans les dossiers type `i18n/es_ES/LC_MESSAGES/` (ici : l'espagnol)

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

### .htaccess

Votre fichier .htaccess doit contenir les infos suivantes :

```

<IfModule mod_rewrite.c>

RewriteEngine On

RewriteBase /www/cesium-website/

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]

# 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>

```

Modifiez l'instruction RewriteBase du .htaccess pour qu'elle s'accorde à votre propre configuration 

(tapez l'endroit où CesiumWebsite est installé, typiquement /)

### config.php

Modifiez la variable $rootURL de la même façon.

Cesium website

===

## Install notes

Modify RewriteBase directive in .htaccess according to your own configuration (set RewriteBase to be the URI where CesiumWebsite is installed, typically /).

# CesiumWebsite

- français : [LISEZ-MOI.md](LISEZ-MOI.md)

- english : [READ-ME.md](READ-ME.md)

| français                                                                        | English                                                                |

| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |

| [Comment tester installer le site sur son ordinateur](doc/fr/installation.md)   | [How to install Cesium website on your computer](doc/en/install.md)    |

| [Comment traduire le site](doc/fr/comment-traduire-le-site.md)                  | [How to translate the website](doc/en/how-to-translate-the-website.md) |

| [Licences](doc/fr/licences.md)                                                  | [Licences](doc/en/licences.md)                                         |

	'android' => [

		'title' => 'Android',

		'url' => 'https://play.google.com/store/apps/details?id=fr.duniter.cesium',

		'img' => 'android.png', 

		'desc' => _('Disponible directement sur le Play Store'), 

		'img' => 'android.svg',

		'desc' => _('Disponible directement sur le Play Store') . '. ' .  _('Si votre version d\'Android est récente, préférez le fichier .apk téléchargeable via le lien un peu plus bas.'),

		'extra' => sprintf(_('(ou <a href="%s">télécharger le fichier .apk</a>)'), 'https://github.com/duniter/cesium/releases/download/v'. $cesiumVersions['android'] .'/cesium-v'. $cesiumVersions['android'] .'-android.apk')

	],

	'iphone' => [

		'title' => 'iPhone',

		'url' => 'https://apps.apple.com/app/cesium-%C4%9F1/id1471028018',

		'img' => 'apple.png', 

		'img' => 'apple.svg',

		'desc' => _('Disponible sur l\'App Store'),

		'extra' => ''

	],

	'linux' => [

		'title' => 'Linux', 

		'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-desktop-v%s-linux-x64.deb', $cesiumVersions['linux'], $cesiumVersions['linux']), 

		'img' => 'tux.png', 

		'desc' => _('Paquet .deb pour Debian ou Ubuntu'), 

	'firefox' => [

		'title' => _('Firefox'),

		//'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-v%s-extension-firefox.xpi', $cesiumVersions['firefox'], $cesiumVersions['firefox']),

		'url' => 'https://addons.mozilla.org/fr/firefox/addon/cesium/',

		'img' => 'firefox2019.png',

		'desc' => _('Module complémentaire pour Firefox'),

		'extra' => ''

	],

	'chromium' => [

		'title' => _('Chromium / Chrome'),

		'url' => 'https://chrome.google.com/webstore/detail/cesium/ocbhjemiokgibfojkkjapfealnbmgoek',

		'img' => 'chrome.svg',

		'desc' => _('Extension pour Chromium / Chrome'),

		'extra' => ''

	],

	'safari' => [

		'title' => _('Safari'),

		'url' => 'https://apps.apple.com/us/app/cesium-%C4%9F1-for-safari/id1551461335',

		'img' => 'safari.png',

		'desc' => _('Extension pour Safari'),

		'extra' => ''

	],

	'brave' => [

		'title' => _('Brave'),

		'url' => 'https://chrome.google.com/webstore/detail/cesium/ocbhjemiokgibfojkkjapfealnbmgoek',

		'img' => 'brave_lion.svg',

		'desc' => _('Extension pour Brave'),

		'extra' => ''

	],

	'debian' => [

		'title' => 'Ubuntu / Debian',

		'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-desktop-v%s-linux-x64.deb', $cesiumVersions['debian'], $cesiumVersions['debian']),

		'img' => 'cof_orange_hex.svg',

		'desc' => _('Paquet .deb pour Debian et ses dérivés (Ubuntu, Linux Mint, etc.)'),

		'extra' => _('En cas de problème&nbsp;:') . '<br /><code>sudo apt-get install -y libgconf-2-4</code>'

	],

	'arch' => [

		'title' => 'Arch Linux (et dérivés)',

		'url' => sprintf('https://aur.archlinux.org/packages/cesium-desktop-deb'),

		'img' => 'arch.svg',

		'desc' => _('A installer via AUR'),

		'extra' => _('<code>yay -S cesium-desktop-deb</code>')

	],

	'windows' => [

		'title' => 'Windows',

		'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-desktop-v%s-windows-x64.exe', $cesiumVersions['windows'], $cesiumVersions['windows']),

		'img' => 'windows.png', 

		'img' => 'windows.svg',

		'desc' => _('Installateur .exe pour Windows'),

		'extra' => _('Lancez le .exe et suivez les instructions à l\'écran')

	],

	'mac' => [

		'title' => 'Mac', 

		'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-v%s-web.zip', $cesiumVersions['mac'], $cesiumVersions['mac']), 

		'img' => 'apple.png', 

		'desc' => _('Version web fonctionnant sous Mac'), 

		'extra' => _('Décompressez le fichier .zip et ouvrez le fichier index.html')

	], 

	'Firefox_Add-on' => [

		'title' => _('Firefox Add-on'), 

		'url' => sprintf('https://glibre.org/cesium/cesium-%s-an+fx.xpi', $cesiumVersions['firefox']), 

		'img' => 'firefox2019.png', 

		'desc' => _('Expérimental Firefox Add-on'), 

		'extra' => ''

	], 

	'web' => [

		'title' => 'Web',

		'url' => sprintf('https://github.com/duniter/cesium/releases/download/v%s/cesium-v%s-web.zip', $cesiumVersions['web'], $cesiumVersions['web']),

	'yunohost' => [

		'title' => 'Yunohost',

		'url' => 'https://github.com/duniter/cesium_ynh',

		'img' => 'yunohost.png', 

		'img' => 'yunohost.svg',

		'desc' => _('Paquet pour Yunohost'),

		'extra' => ''

	],

	'livrables' => [

		'title' => _('Livrables'),

		'url' => 'https://github.com/duniter/cesium/releases',

		'img' => '1200px-Octicons-mark-github.png', 

		'img' => 'github.svg',

		'desc' => _('Toutes versions disponibles sur GitHub'),

		'extra' => ''

	],

];

<?php

$cesiumVersions = [

	   'home' => '1.3.11', 

	'android' => '1.3.11', 

	  'linux' => '1.3.11', 

	'windows' => '1.3.11', 

	'firefox' => '1.3.11', 

	    'mac' => '1.3.11', 

	    'web' => '1.3.11', 

	   'home' => '1.7.16',

	'android' => '1.7.16',

	 'debian' => '1.7.16',

 	   'arch' => '1.6.1', 

	'windows' => '1.7.16',

	    'web' => '1.7.16'

];

#!/bin/bash

lessc lib/style.less lib/style.css

include('cesiumVersions.php');

define('FUNDING_PUBKEY', 'CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX');

define('FUNDING_TARGET', '100');

define('FUNDING_PUBKEY',  '78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8');

// Duniter : 78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8

// Cesium : CitdnuQgZ45tNFCagay7Wh12gwwHM8VLej1sWmfHWnQX

define('FUNDING_TARGET', 20*60+230);

define('CESIUM_PLUS_NODE', 'https://g1.data.e-is.pro'); // for avatars serving

$legalNotice =

	[

	];

if ($_SERVER['SERVER_NAME'] == 'localhost') {

	ini_set('display_errors', 1);

	ini_set('display_startup_errors', 1);

	error_reporting(E_ALL);

}

// Trouver une façon de définir $rootURL sans faire ça :

if ($_SERVER['SERVER_NAME'] == 'localhost') {

	$rootURL = '/www/cesium_website';

	// Adaptez la ligne suivante à votre configuration (sans slash à la fin)

	$rootURL = '/cesium_website';

} else {

	$rootURL = '';

}

	return $langList;

}

$availableLanguages =

$languagesList =

	[

	 'fr' => [

		 'name' => 'français',

		 'name' => 'español',

		 'folder' => 'es_ES'

		 ],

	 'va' => [

		 'name' => 'valyrio',

		 'folder' => 'en_US'

	 'eo' => [

		 'name' => 'esperanto',

		 'folder' => 'eo'

		 ],

	/*

	 'it' => [

	*/

	];

$availableLanguages = checkAvailableLanguages($availableLanguages);

$availableLanguages = checkAvailableLanguages($languagesList);

//echo '<pre>'; print_r($availableLanguages); echo '</pre>';

define('DEFAULT_LANG', 'fr');

define('WEBSITE_GIT_URL', 'https://git.duniter.org/websites/cesium_website');

include('inc/lang.php');

define('MOD_REWRITE', 'on');

define('FUNDING_ALT', false);

define('FUNDING_ALT', (date('d/m') == '01/04'));

How to translate the website

===

## How to translate the main contents

For pages such as:

- Home

- Features

- Download

..and header and footer menus, 

the changes take place in *.po files. 

You will find those files in folders such as `i18n/fr_FR/LC_MESSAGES/` .